# stream-spectrum A variety of streams to be used in samples and/or tests. ## Installation npm install stream-spectrum ## API

NumberReadable(opts) → {ReadableStream}

Generates increasing numbers between the given from and to values.

Parameters:

Name Type Description

opts

Object

options

Properties

Name	Type	Argument	Description
`from`	Number	<optional>	start value to generate
`to`	Number	<optional>	end value to generate
`throttle`	Number	<optional>	number of milliseconds to take to generate each number

Source:

readable/number.js , lineno 11

Returns:

readable

Type: ReadableStream

ObjectReadable(opts) → {ReadableStream}

Generates objects with a count property that increases between the given from and to values.

Parameters:

Name Type Description

opts

Object

options

Properties

Name	Type	Argument	Description
`from`	Number	<optional>	start value to generate
`to`	Number	<optional>	end value to generate
`throttle`	Number	<optional>	number of milliseconds to take to generate each number

Source:

readable/object.js , lineno 12

Returns:

readable

Type: ReadableStream

PowerTransform(opts) → {TransformStream}

Transforms numbers into the power of each number.

Parameters:

Name Type Description

opts

Object

options

Properties

Name	Type	Argument	Description
`throttle`	Number	<optional>	number of milliseconds to take to transform each number into its power

Source:

transform/power.js , lineno 14

Returns:

transform

Type: TransformStream

RandomNumberReadable(opts) → {ReadableStream}

Generates random numbers between the given min and max values.

Parameters:

Name Type Description

opts

Object

options

Properties

Name	Type	Argument	Description
`min`	Number	<optional>	minimum value to generate
`max`	Number	<optional>	maximum value to generate
`throttle`	Number	<optional>	number of milliseconds to take to generate each number

Source:

readable/random-number.js , lineno 11

Returns:

readable

Type: ReadableStream

TarpitWritable(opts) → {WritableStream}

Just drops the values written to it. Simulates processing time via throttle value

Parameters:

Name Type Description

opts

Object

options

Properties

Name	Type	Argument	Description
`debug`	Boolean	<optional>	if true written values are logged to the console
`throttle`	Number	<optional>	number of milliseconds to delay each written chunk

Source:

writable/tarpit.js , lineno 11

Returns:

writable

Type: WritableStream

*generated with [docme](https://github.com/thlorenz/docme)*

## License MIT