"Fossies" - the Fresh Open Source Software Archive

Member "Atom/resources/app/apm/node_modules/isstream/README.md" (17 Oct 2016, 2424 Bytes) of archive /windows/misc/atom-windows.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.


Build Status

Test if an object is a Stream


The missing Stream.isStream(obj): determine if an object is standard Node.js Stream. Works for Node-core Stream objects (for 0.8, 0.10, 0.11, and in theory, older and newer versions) and all versions of readable-stream.


```js var isStream = require(‘isstream’) var Stream = require(‘stream’)

isStream(new Stream()) // true

isStream({}) // false

isStream(new Stream.Readable()) // true isStream(new Stream.Writable()) // true isStream(new Stream.Duplex()) // true isStream(new Stream.Transform()) // true isStream(new Stream.PassThrough()) // true ```

But wait! There’s more!

You can also test for isReadable(obj), isWritable(obj) and isDuplex(obj) to test for implementations of Streams2 (and Streams3) base classes.

```js var isReadable = require(‘isstream’).isReadable var isWritable = require(‘isstream’).isWritable var isDuplex = require(‘isstream’).isDuplex var Stream = require(‘stream’)

isReadable(new Stream()) // false isWritable(new Stream()) // false isDuplex(new Stream()) // false

isReadable(new Stream.Readable()) // true isReadable(new Stream.Writable()) // false isReadable(new Stream.Duplex()) // true isReadable(new Stream.Transform()) // true isReadable(new Stream.PassThrough()) // true

isWritable(new Stream.Readable()) // false isWritable(new Stream.Writable()) // true isWritable(new Stream.Duplex()) // true isWritable(new Stream.Transform()) // true isWritable(new Stream.PassThrough()) // true

isDuplex(new Stream.Readable()) // false isDuplex(new Stream.Writable()) // false isDuplex(new Stream.Duplex()) // true isDuplex(new Stream.Transform()) // true isDuplex(new Stream.PassThrough()) // true ```

Reminder: when implementing your own streams, please use readable-stream rather than core streams.


isStream is Copyright © 2015 Rod Vagg @rvagg and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.