Skip to content

Convert a string/promise/array/iterable/asynciterable/buffer/typedarray/arraybuffer/object into a stream

License

Notifications You must be signed in to change notification settings

sindresorhus/into-stream

into-stream

Convert a string/promise/array/iterable/asynciterable/uint8array/typedarray/arraybuffer/object into a stream

Correctly handles backpressure.

Install

npm install into-stream

Usage

import intoStream from 'into-stream';

intoStream('unicorn').pipe(process.stdout);
//=> 'unicorn'

API

intoStream(input)

Type: Uint8Array | TypedArray | ArrayBuffer | string | Iterable<string | Uint8Array | TypedArray> | AsyncIterable<string | Uint8Array | TypedArray> | Promise
Returns: Readable stream

intoStream.object(input)

Type: object | Iterable<object> | AsyncIterable<object> | Promise
Returns: Readable object stream

Limitations

The streams returned by this package cannot be used with the stdio option of Node.js child_process methods. Use fs.createReadStream() instead.

Related

About

Convert a string/promise/array/iterable/asynciterable/buffer/typedarray/arraybuffer/object into a stream

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 9