-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Require Node.js 8, add TypeScript definition (#10)
- Loading branch information
1 parent
0342990
commit c918e37
Showing
11 changed files
with
203 additions
and
107 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1 @@ | ||
| * text=auto | ||
| *.js text eol=lf | ||
| * text=auto eol=lf |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| node_modules | ||
| yarn.lock |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| package-lock=false |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| sudo: false | ||
| language: node_js | ||
| node_js: | ||
| - '6' | ||
| - '4' | ||
| - '10' | ||
| - '8' |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /// <reference types="node"/> | ||
| import * as stream from 'stream'; | ||
|
|
||
| declare const isStream: { | ||
| /** | ||
| @returns Whether `stream` is a [`Stream`](https://nodejs.org/api/stream.html#stream_stream). | ||
| @example | ||
| ``` | ||
| import * as fs from 'fs'; | ||
| import isStream = require('is-stream'); | ||
| isStream(fs.createReadStream('unicorn.png')); | ||
| //=> true | ||
| isStream({}); | ||
| //=> false | ||
| ``` | ||
| */ | ||
| (stream: unknown): stream is stream.Stream; | ||
|
|
||
| /** | ||
| @returns Whether `stream` is a [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable). | ||
| @example | ||
| ``` | ||
| import * as fs from 'fs'; | ||
| import isStream = require('is-stream'); | ||
| isStream.writable(fs.createWriteStrem('unicorn.txt')); | ||
| //=> true | ||
| ``` | ||
| */ | ||
| writable(stream: unknown): stream is stream.Writable; | ||
|
|
||
| /** | ||
| @returns Whether `stream` is a [`stream.Readable`](https://nodejs.org/api/stream.html#stream_class_stream_readable). | ||
| @example | ||
| ``` | ||
| import * as fs from 'fs'; | ||
| import isStream = require('is-stream'); | ||
| isStream.readable(fs.createReadStream('unicorn.png')); | ||
| //=> true | ||
| ``` | ||
| */ | ||
| readable(stream: unknown): stream is stream.Readable; | ||
|
|
||
| /** | ||
| @returns Whether `stream` is a [`stream.Duplex`](https://nodejs.org/api/stream.html#stream_class_stream_duplex). | ||
| @example | ||
| ``` | ||
| import {Duplex} from 'stream'; | ||
| import isStream = require('is-stream'); | ||
| isStream.duplex(new Duplex()); | ||
| //=> true | ||
| ``` | ||
| */ | ||
| duplex(stream: unknown): stream is stream.Duplex; | ||
|
|
||
| /** | ||
| @returns Whether `stream` is a [`stream.Transform`](https://nodejs.org/api/stream.html#stream_class_stream_transform). | ||
| @example | ||
| ``` | ||
| import * as fs from 'fs'; | ||
| import Stringify = require('streaming-json-stringify'); | ||
| import isStream = require('is-stream'); | ||
| isStream.transform(Stringify()); | ||
| //=> true | ||
| ``` | ||
| */ | ||
| transform(input: unknown): input is stream.Transform; | ||
| }; | ||
|
|
||
| export = isStream; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import {expectType} from 'tsd'; | ||
| import * as stream from 'stream'; | ||
| import isStream = require('.'); | ||
|
|
||
| const foo = ''; | ||
|
|
||
| if (isStream(foo)) { | ||
| expectType<stream.Stream>(foo); | ||
| } | ||
|
|
||
| if (isStream.writable(foo)) { | ||
| expectType<stream.Writable>(foo); | ||
| } | ||
|
|
||
| if (isStream.readable(foo)) { | ||
| expectType<stream.Readable>(foo); | ||
| } | ||
|
|
||
| if (isStream.duplex(foo)) { | ||
| expectType<stream.Duplex>(new stream.Duplex()); | ||
| } | ||
|
|
||
| if (isStream.transform(foo)) { | ||
| expectType<stream.Transform>(foo); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,9 @@ | ||
| The MIT License (MIT) | ||
| MIT License | ||
|
|
||
| Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com) | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in | ||
| all copies or substantial portions of the Software. | ||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| THE SOFTWARE. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,41 @@ | ||
| { | ||
| "name": "is-stream", | ||
| "version": "1.1.0", | ||
| "description": "Check if something is a Node.js stream", | ||
| "license": "MIT", | ||
| "repository": "sindresorhus/is-stream", | ||
| "author": { | ||
| "name": "Sindre Sorhus", | ||
| "email": "sindresorhus@gmail.com", | ||
| "url": "sindresorhus.com" | ||
| }, | ||
| "engines": { | ||
| "node": ">=4" | ||
| }, | ||
| "scripts": { | ||
| "test": "xo && ava" | ||
| }, | ||
| "files": [ | ||
| "index.js" | ||
| ], | ||
| "keywords": [ | ||
| "stream", | ||
| "type", | ||
| "streams", | ||
| "writable", | ||
| "readable", | ||
| "duplex", | ||
| "transform", | ||
| "check", | ||
| "detect", | ||
| "is" | ||
| ], | ||
| "devDependencies": { | ||
| "ava": "*", | ||
| "tempy": "^0.1.0", | ||
| "xo": "*" | ||
| } | ||
| "name": "is-stream", | ||
| "version": "1.1.0", | ||
| "description": "Check if something is a Node.js stream", | ||
| "license": "MIT", | ||
| "repository": "sindresorhus/is-stream", | ||
| "author": { | ||
| "name": "Sindre Sorhus", | ||
| "email": "sindresorhus@gmail.com", | ||
| "url": "sindresorhus.com" | ||
| }, | ||
| "engines": { | ||
| "node": ">=8" | ||
| }, | ||
| "scripts": { | ||
| "test": "xo && ava && tsd" | ||
| }, | ||
| "files": [ | ||
| "index.js", | ||
| "index.d.ts" | ||
| ], | ||
| "keywords": [ | ||
| "stream", | ||
| "type", | ||
| "streams", | ||
| "writable", | ||
| "readable", | ||
| "duplex", | ||
| "transform", | ||
| "check", | ||
| "detect", | ||
| "is" | ||
| ], | ||
| "devDependencies": { | ||
| "@types/node": "^11.13.6", | ||
| "ava": "^1.4.1", | ||
| "tempy": "^0.3.0", | ||
| "tsd": "^0.7.2", | ||
| "xo": "^0.24.0" | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ | |
| ## Install | ||
|
|
||
| ``` | ||
| $ npm install --save is-stream | ||
| $ npm install is-stream | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
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