Home Manual Reference Source Repository

Typedef

Static Public Summary
public	EdgeResult: Object
public	NodeResult: Object
public	Sample: Object
public	WalkCallbacks: Object
public	parseSnapshotStreamCallbacks: Object

Static Public

public EdgeResult: Object source

Properties:

Name	Type	Attribute	Description
fields	Edge
edge_index	number		Index that can be used with getEdge to get this Edge.
node_index	number		Index that can be used with getNode to get the owner of this Edge.
getNode	function(): NodeResult		Helper for getting the Node this Edge points to.

public NodeResult: Object source

Properties:

Name	Type	Attribute	Description
fields	Node
node_index	number		Index that can be used with getNode to get this Node.
edge_index	number		Index that can be used to get the first Edge of this Node.
getEdge	function(index: Number): EdgeResult		Get the specified Edge of this node.
walkEdges	function(): EdgeIterator		Helper for iterating the edges of a Node.

public Sample: Object source

Properties:

Name	Type	Attribute	Description
timestamp	number		Timestamp of this sample in nanoseconds. The first sample will generally have a timestamp of 0 and you must compute the time differences accordingly.
lastAssignedId	number		The largest `node.fields.id` visible when this sample was taken. Since `id`s only increment, all `id`s less than this were allocated prior to this sample.

public WalkCallbacks: Object source

Properties:

Name	Type	Attribute	Description
onNodeOpen	function(node: NodeResult)		callback called when a Node is first encountered
onEdge	function(edge: EdgeResult)		callback called when traversing an Edge
onNodeSkipped	function(node: NodeResult)		callback called when a Node is skipped because it has already been encountered
onNodeClose	function(node: NodeResult)		callback called when all children of a Node are guaranteed to have been encountered

public parseSnapshotStreamCallbacks: Object source

Properties:

Name	Type	Attribute	Description
onsnapshot_info	function(snapshot_info: {meta: Object})
onnode	function(node_buffer: Buffer)
onedge	function(edge_buffer: Buffer)
onsample	function(sample_buffer: Buffer)
onstring	function(str: string)