import NodeStream from 'atscm/src/lib/server/NodeStream.js'

public class | source

NodeStream

stream~Readable → NodeStream

A stream of server nodes.

Constructor Summary

Public Constructor
public	constructor(nodesToBrowse: NodeId[], options: Object) Creates new node stream.

Public Members
public get	isDestroyed: boolean If the stream is destoyed.
public get	opsPerSecond: number The number of processed chunks per second.
public get	processed: number The number of processed nodes.
public	recursive: Boolean If the discovered nodes should be browsed as well.

Private Members
private	_browser: NodeBrowser The stream's browser
private	_isDestroyed: boolean If the stream is destroyed.
private	_start: number The timestamp when the stream started.

Private Methods
private	_destroy(err: Error, callback: function(err: ?Error): void) Destroys the stream.
private	_read() Starts the browser.

Creates new node stream.

Name	Type	Attribute	Description
nodesToBrowse	NodeId[]		The nodes to browse.
options	Object	optional	The options to use.
options.recursive	boolean	optional	If the stream should recurse child nodes.
options.ignoreNodes	NodeId[]	optional	The nodes to ignore.

If the stream is destoyed.

The number of processed chunks per second.

The number of processed nodes.

If the discovered nodes should be browsed as well.

The stream's browser

If the stream is destroyed.

The timestamp when the stream started.

Destroys the stream.

Name	Type	Attribute	Description
err	Error	nullable: true	The error that caused the destroy.
callback	function(err: ?Error): void		Called once finished.

Starts the browser.