diff options
author | NateN1222 <nathannichols454@gmail.com> | 2017-09-03 17:38:26 -0500 |
---|---|---|
committer | NateN1222 <nathannichols454@gmail.com> | 2017-09-03 17:38:26 -0500 |
commit | d324474467727fa31c76c206acb027acd8925fa1 (patch) | |
tree | 85093616781ce3705568153c1a09d0e2b7ec5a4e /hash_script/node_modules/is-stream/readme.md | |
parent | 7ea4ef16ca69ea37b87ca9a9306d2fd9c136539d (diff) |
Implemented a default whitelist
Diffstat (limited to 'hash_script/node_modules/is-stream/readme.md')
-rw-r--r-- | hash_script/node_modules/is-stream/readme.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/hash_script/node_modules/is-stream/readme.md b/hash_script/node_modules/is-stream/readme.md new file mode 100644 index 0000000..d8afce8 --- /dev/null +++ b/hash_script/node_modules/is-stream/readme.md @@ -0,0 +1,42 @@ +# is-stream [![Build Status](https://travis-ci.org/sindresorhus/is-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/is-stream) + +> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html) + + +## Install + +``` +$ npm install --save is-stream +``` + + +## Usage + +```js +const fs = require('fs'); +const isStream = require('is-stream'); + +isStream(fs.createReadStream('unicorn.png')); +//=> true + +isStream({}); +//=> false +``` + + +## API + +### isStream(stream) + +#### isStream.writable(stream) + +#### isStream.readable(stream) + +#### isStream.duplex(stream) + +#### isStream.transform(stream) + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |