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 optsObject options
Properties
Name Type Argument Description fromNumber <optional>
start value to generate
toNumber <optional>
end value to generate
throttleNumber <optional>
number of milliseconds to take to generate each number
- Source:
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 optsObject options
Properties
Name Type Argument Description fromNumber <optional>
start value to generate
toNumber <optional>
end value to generate
throttleNumber <optional>
number of milliseconds to take to generate each number
- Source:
Returns:
readable
- Type
- ReadableStream
-
PowerTransform(opts) → {TransformStream}
-
Transforms numbers into the power of each number.
Parameters:
Name Type Description optsObject options
Properties
Name Type Argument Description throttleNumber <optional>
number of milliseconds to take to transform each number into its power
- Source:
Returns:
transform
- Type
- TransformStream
-
RandomNumberReadable(opts) → {ReadableStream}
-
Generates random numbers between the given min and max values.
Parameters:
Name Type Description optsObject options
Properties
Name Type Argument Description minNumber <optional>
minimum value to generate
maxNumber <optional>
maximum value to generate
throttleNumber <optional>
number of milliseconds to take to generate each number
- Source:
Returns:
readable
- Type
- ReadableStream
-
TarpitWritable(opts) → {WritableStream}
-
Just drops the values written to it. Simulates processing time via throttle value
Parameters:
Name Type Description optsObject options
Properties
Name Type Argument Description debugBoolean <optional>
if true written values are logged to the console
throttleNumber <optional>
number of milliseconds to delay each written chunk
- Source:
Returns:
writable
- Type
- WritableStream
generated with docme
License
MIT