BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / is-stream / readme.md

readme.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
readme.md 664 B Download Raw

is-stream Build Status

> Check if something is a Node.js stream

Install

$ npm install --save is-stream

Usage

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

Source
1# is-stream [![Build Status](https://travis-ci.org/sindresorhus/is-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/is-stream)
2
3> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html)
4
5
6## Install
7
8```
9$ npm install --save is-stream
10```
11
12
13## Usage
14
15```js
16const fs = require('fs');
17const isStream = require('is-stream');
18
19isStream(fs.createReadStream('unicorn.png'));
20//=> true
21
22isStream({});
23//=> false
24```
25
26
27## API
28
29### isStream(stream)
30
31#### isStream.writable(stream)
32
33#### isStream.readable(stream)
34
35#### isStream.duplex(stream)
36
37#### isStream.transform(stream)
38
39
40## License
41
42MIT © [Sindre Sorhus](https://sindresorhus.com)