ngraph.frombinary

Deserialize an ngraph.graph from binary format.

Install

Install with npm:

$ npm install --save ngraph.frombinary

Usage

var load = require('ngraph.frombinary');

API

load

Load a ngraph.graph that was previously saved using ngraph.tobinary. This expects that the meta.json file created with ngraph.tobinary is in the folder. See the parse method below when labels and links are already in memory.

Example

var graph = load(new Graph({uniqueLinkIds: false}), {cwd: '.'});
console.log(graph.getNodesCount());
//=> 4
console.log(graph.getLinksCount());
//=> 3

Params

• graph {Object}: ngraph.graph instance to load the binary files into.
• options {Object}: Options to determine where the graph is loaded from.
• options.cwd {String}: Directory where the files are located. Defaults to ..
• options.labels {String}: Name of the labels file. Defaults to labels.json.
• options.links {String}: Name of the links file. Defaults to meta.json.
• options.meta {String}: Name of the meta file. Defaults to links.bin.
• returns {Object}: graph instance that was passed in after loading the binary files.

parse

Parse function that can be used directly to parse a links buffer and populate a ngraph.graph graph with nodes and links. This is useful when the labels (node names) array and the links buffer have already been loaded into memory.

Example

var labels = ['a', 'b', 'c', 'd'];
var links = fs.readFileSync('links.bin');
// links contains a binary buffer that looks like: `-1 2 3 -4 2`
var graph = load.parse(new Graph({uniqueLinkIds: false}), labels, links);
console.log(graph.getNodesCount());
//=> 4
console.log(graph.getLinksCount());
//=> 3

Params

• graph {Object}: ngraph.graph instance to load nodes and links onto.
• labels {Array}: Array of labels used to lookup node names for the graph.
• links {Buffer}: Binary buffer represented links to deserialize onto the graph.
• returns {Object}: graph instance populated with nodes and links.

About

Related projects

• ngraph.graph: Base graph structure in ngraph.* | homepage
• ngraph.tobinary: Serialize ngraph.graph to binary format | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.0, on November 05, 2016.