1
0
Fork 0
mirror of https://github.com/shimataro/ssh-key-action.git synced 2025-06-19 22:52:10 +10:00
ssh-key-action/node_modules/to-readable-stream/readme.md
2019-09-18 20:39:54 +09:00

42 lines
861 B
Markdown

# to-readable-stream [![Build Status](https://travis-ci.org/sindresorhus/to-readable-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/to-readable-stream)
> Convert a string/Buffer/Uint8Array to a [readable stream](https://nodejs.org/api/stream.html#stream_readable_streams)
## Install
```
$ npm install to-readable-stream
```
## Usage
```js
const toReadableStream = require('to-readable-stream');
toReadableStream('🦄🌈').pipe(process.stdout);
```
## API
### toReadableStream(input)
Returns a [`stream.Readable`](https://nodejs.org/api/stream.html#stream_readable_streams).
#### input
Type: `string` `Buffer` `Uint8Array`
Value to convert to a stream.
## Related
- [into-stream](https://github.com/sindresorhus/into-stream) - More advanced version of this module
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)