Permalink
Cannot retrieve contributors at this time
60 lines (38 sloc)
1.58 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/run-applescript/node_modules/is-stream/readme.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# is-stream | |
> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html) | |
## Install | |
``` | |
$ npm install is-stream | |
``` | |
## Usage | |
```js | |
const fs = require('fs'); | |
const isStream = require('is-stream'); | |
isStream(fs.createReadStream('unicorn.png')); | |
//=> true | |
isStream({}); | |
//=> false | |
``` | |
## API | |
### isStream(stream) | |
Returns a `boolean` for whether it's a [`Stream`](https://nodejs.org/api/stream.html#stream_stream). | |
#### isStream.writable(stream) | |
Returns a `boolean` for whether it's a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable). | |
#### isStream.readable(stream) | |
Returns a `boolean` for whether it's a [`stream.Readable`](https://nodejs.org/api/stream.html#stream_class_stream_readable). | |
#### isStream.duplex(stream) | |
Returns a `boolean` for whether it's a [`stream.Duplex`](https://nodejs.org/api/stream.html#stream_class_stream_duplex). | |
#### isStream.transform(stream) | |
Returns a `boolean` for whether it's a [`stream.Transform`](https://nodejs.org/api/stream.html#stream_class_stream_transform). | |
## Related | |
- [is-file-stream](https://github.com/jamestalmage/is-file-stream) - Detect if a stream is a file stream | |
--- | |
<div align="center"> | |
<b> | |
<a href="https://tidelift.com/subscription/pkg/npm-is-stream?utm_source=npm-is-stream&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> | |
</b> | |
<br> | |
<sub> | |
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. | |
</sub> | |
</div> |