@stdlib/streams-node-from-iterator

Create a readable stream from an iterator.

https://github.com/stdlib-js/streams-node-from-iterator

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.4%) to scientific vocabulary

Keywords

convert iter iterate iterator javascript node node-js nodejs readable stdlib stream streams to util utilities utility utils

Last synced: 6 months ago · JSON representation

Repository

Create a readable stream from an iterator.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.73 MB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

convert iter iterate iterator javascript node node-js nodejs readable stdlib stream streams to util utilities utility utils

Created over 4 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Iterator Stream

Create a readable stream from an iterator.

## Installation ```bash npm install @stdlib/streams-node-from-iterator ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var iteratorStream = require( '@stdlib/streams-node-from-iterator' ); ``` #### iteratorStream( iterator\[, options] ) Returns a [readable stream][readable-stream] from an [iterator][mdn-iterator-protocol]. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var randu = require( '@stdlib/random-iter-randu' ); var iStream; var stream; function log( chunk, idx ) { console.log( chunk.toString() ); if ( idx === 10 ) { stream.destroy(); } } stream = iteratorStream( randu() ); iStream = inspectStream( log ); stream.pipe( iStream ); ``` The function accepts the following `options`: - **objectMode**: specifies whether a [stream][stream] should operate in [objectMode][object-mode]. Default: `false`. - **encoding**: specifies how `Buffer` objects should be decoded to `strings`. Default: `null`. - **highWaterMark**: specifies the maximum number of bytes to store in an internal buffer before pausing iteration. - **sep**: separator used to join streamed data. This option is only applicable when a stream is **not** in [objectMode][object-mode]. Default: `'\n'`. - **serialize**: custom serialization function. This option is only applicable when a stream is **not** in [objectMode][object-mode]. To set [stream][stream] `options`, ```javascript var randu = require( '@stdlib/random-iter-randu' ); var opts = { 'objectMode': true, 'encoding': 'utf8', 'highWaterMark': 64 }; var stream = iteratorStream( randu(), opts ); ``` By default, when not operating in [objectMode][object-mode], a returned [stream][stream] delineates iterated values using a newline character. To specify an alternative separator, set the `sep` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var randu = require( '@stdlib/random-iter-randu' ); function log( chunk ) { console.log( chunk.toString() ); } var it = randu({ 'iter': 10 }); var stream = iteratorStream( it, { 'sep': ',' }); var iStream = inspectStream( log ); stream.pipe( iStream ); ``` By default, when not operating in [objectMode][object-mode], a returned [stream][stream] serializes iterated values as JSON strings. To specify custom serialization behavior (either to a `string` or `Buffer`), set the `serialize` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var randu = require( '@stdlib/random-iter-randu' ); function serialize( v ) { return 'r::' + v.toString(); } function log( chunk ) { console.log( chunk.toString() ); } var it = randu({ 'iter': 10 }); var stream = iteratorStream( it, { 'serialize': serialize }); var iStream = inspectStream( log ); stream.pipe( iStream ); ``` * * * #### iteratorStream.factory( \[options] ) Returns a `function` for creating [readable streams][readable-stream] from [iterators][mdn-iterator-protocol]. ```javascript var randu = require( '@stdlib/random-iter-randu' ); var opts = { 'objectMode': true, 'encoding': 'utf8', 'highWaterMark': 64 }; var createStream = iteratorStream.factory( opts ); var stream1 = createStream( randu() ); var stream2 = createStream( randu() ); // ... ``` The method accepts the same `options` as [`iteratorStream()`](#iterator-stream). * * * #### iteratorStream.objectMode( iterator\[, options] ) This method is a convenience function to create [streams][stream] which **always** operate in [objectMode][object-mode]. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var randu = require( '@stdlib/random-iter-randu' ); function log( v ) { console.log( v ); } var opts = { 'iter': 10 }; var stream = iteratorStream.objectMode( randu( opts ) ); opts = { 'objectMode': true }; var iStream = inspectStream( opts, log ); stream.pipe( iStream ); ``` This method accepts the same `options` as [`iteratorStream()`](#iterator-stream); however, the method will **always** override the [`objectMode`][object-mode] option in `options`.

## Notes - In [`objectMode`][object-mode], `null` is a reserved value. If an [iterator][mdn-iterator-protocol] generates `null` values (e.g., as a means to encode missing values), the stream will prematurely end. Consider an alternative encoding or explicitly map `null` values to a different value by wrapping the provided [iterator][mdn-iterator-protocol] with another [iterator][mdn-iterator-protocol]. - In binary mode, if an [iterator][mdn-iterator-protocol] generates `undefined` values, the stream will emit an error. Consider providing a custom serialization function or explicitly map `undefined` values to a different value by wrapping the provided [iterator][mdn-iterator-protocol] with another [iterator][mdn-iterator-protocol].

## Examples ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var randu = require( '@stdlib/random-iter-randu' ); var iteratorStream = require( '@stdlib/streams-node-from-iterator' ); function log( v ) { console.log( v.toString() ); } // Create an iterator which generates uniformly distributed pseudorandom numbers: var opts = { 'iter': 10 }; var it = randu( opts ); // Convert the iterator to a stream: opts = { 'objectMode': true }; var stream = iteratorStream( it, opts ); // Create a writable stream for inspecting stream data: opts = { 'objectMode': true }; var iStream = inspectStream( opts, log ); // Begin data flow: stream.pipe( iStream ); ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

GitHub Events

Total

Push event: 19

Last Year

Push event: 19

Committers

Last synced: 8 months ago

All Time

Total Commits: 61
Total Committers: 1
Avg Commits per committer: 61.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 12
Committers: 1
Avg Commits per committer: 12.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	61

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 6 last-month

Total dependent packages: 3
Total dependent repositories: 1
Total versions: 10
Total maintainers: 4

npmjs.org: @stdlib/streams-node-from-iterator

Create a readable stream from an iterator.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 10
Dependent Packages: 3
Dependent Repositories: 1
Downloads: 6 Last month

Rankings

Dependent packages count: 5.9%

Dependent repos count: 10.3%

Average: 13.6%

Forks count: 15.4%

Stargazers count: 16.7%

Downloads: 19.8%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 7 months ago

Dependencies

package.json npm

@stdlib/array-to-iterator ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/random-iter-randu ^0.0.x development
@stdlib/streams-node-inspect-sink ^0.0.x development
@stdlib/utils-parse-json ^0.0.x development
istanbul ^0.4.1 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-has-own-property ^0.0.x
@stdlib/assert-is-boolean ^0.0.x
@stdlib/assert-is-buffer ^0.0.x
@stdlib/assert-is-error ^0.0.x
@stdlib/assert-is-function ^0.0.x
@stdlib/assert-is-iterator-like ^0.0.x
@stdlib/assert-is-nonnegative-number ^0.0.x
@stdlib/assert-is-plain-object ^0.0.x
@stdlib/assert-is-string ^0.0.x
@stdlib/buffer-ctor ^0.0.x
@stdlib/buffer-from-string ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/types ^0.0.x
@stdlib/utils-copy ^0.0.x
@stdlib/utils-define-nonenumerable-property ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
@stdlib/utils-inherit ^0.0.x
@stdlib/utils-next-tick ^0.0.x
debug ^2.6.9
readable-stream ^2.1.4

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/streams-node-from-iterator

Science Score: 26.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Iterator Stream

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/streams-node-from-iterator

Rankings

Maintainers (4)

Funding

Dependencies