Blame view

node_modules/is-stream/readme.md 664 Bytes
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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)