npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cxmate

v0.1.0

Published

SDK for creating cxMate services

Downloads

6

Readme

cxmate-js


cxmate-js provides a Javascript SDK for interacting with cxMate, an adapter that allows Cytoscape to talk to network services. It can also convert Cytoscape's network interchange format to and from the Cytoscape.js data model. This SDK enables quick and painless development of a cxMate service, follow the Getting Started guide to learn more about the process.


cxMate is an official Cytoscape project written by the Cytoscape team.

Installation

Install the cxMate SDK via npm.

npm install --save cxmate

Getting Started

Import the cxmate package:

let cxmate = require('cxmate');

Create a subclass of the cxMate.Service class from the package:

class MyService extends cxmate.Service

Implement a single method in the class called process. It takes two arguments, a dictionary of parameters, and an element stream:

class MyService extends cxmate.Service {

  process(params, elementStream) {
    cxmate.Adapter.toCyJS(elementStream, (model) => {
      cxmate.Adapter.fromCyJS(model, (element) => {
        elementStream.write(element);
      });
      elementStream.end();
    });
  }

}

Whenever your service is called, cxMate will call your process method for you. you must extract networks from the element stream to create your input networks. cxMate comes with an adapter class to make conversion to popular network formats simple. To send networks back to cxMate, you must write network elements back to the stream. cxMate's adapter class can handle this also for various popular network formats.

Finally, setup your service to run when envoked. the cxmate.Service superclass implements a run method for you that takes an optional 'address:port' string.

let service = new MyService();
service.run();

Contributors

We welcome all contributions via Github pull requests. We also encourage the filing of bugs and features requests via the Github issue tracker. For general questions please send us an email.

License

cxmate-js is MIT licensed and a product of the Cytoscape Consortium.

Please see the License file for details.