diff --git a/.github/funding.yml b/.github/funding.yml deleted file mode 100644 index 07fcd36..0000000 --- a/.github/funding.yml +++ /dev/null @@ -1,4 +0,0 @@ -github: sindresorhus -open_collective: sindresorhus -tidelift: npm/is-stream -custom: https://sindresorhus.com/donate diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 441975c..346585c 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -10,10 +10,11 @@ jobs: fail-fast: false matrix: node-version: - - 16 + - 20 + - 18 steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - run: npm install diff --git a/index.d.ts b/index.d.ts index a7398cf..065c444 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,9 +1,9 @@ import { - Stream, - Writable as WritableStream, - Readable as ReadableStream, - Duplex as DuplexStream, - Transform as TransformStream, + type Stream, + type Writable as WritableStream, + type Readable as ReadableStream, + type Duplex as DuplexStream, + type Transform as TransformStream, } from 'node:stream'; export type Options = { diff --git a/index.test-d.ts b/index.test-d.ts index a0990be..a0b9a3f 100644 --- a/index.test-d.ts +++ b/index.test-d.ts @@ -1,9 +1,9 @@ import { - Stream, - Writable as WritableStream, - Readable as ReadableStream, + type Stream, + type Writable as WritableStream, + type Readable as ReadableStream, Duplex as DuplexStream, - Transform as TransformStream, + type Transform as TransformStream, } from 'node:stream'; import {expectType, expectAssignable} from 'tsd'; import { @@ -12,7 +12,7 @@ import { isReadableStream, isDuplexStream, isTransformStream, - Options, + type Options, } from './index.js'; const foo = ''; diff --git a/package.json b/package.json index 47d5761..0db352f 100644 --- a/package.json +++ b/package.json @@ -11,9 +11,13 @@ "url": "https://sindresorhus.com" }, "type": "module", - "exports": "./index.js", + "exports": { + "types": "./index.d.ts", + "default": "./index.js" + }, + "sideEffects": false, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=18" }, "scripts": { "test": "xo && ava && tsd" @@ -35,10 +39,10 @@ "is" ], "devDependencies": { - "@types/node": "^16.4.13", - "ava": "^3.15.0", - "tempy": "^1.0.1", - "tsd": "^0.17.0", - "xo": "^0.44.0" + "@types/node": "^20.11.19", + "ava": "^5.3.1", + "tempy": "^3.1.0", + "tsd": "^0.30.5", + "xo": "^0.57.0" } } diff --git a/readme.md b/readme.md index ecdf94d..2efdb0a 100644 --- a/readme.md +++ b/readme.md @@ -4,8 +4,8 @@ ## Install -``` -$ npm install is-stream +```sh +npm install is-stream ``` ## Usage @@ -55,15 +55,3 @@ When this option is `true`, the method returns `false` if the stream has already ## Related - [is-file-stream](https://github.com/jamestalmage/is-file-stream) - Detect if a stream is a file stream - ---- - -
- - Get professional support for this package with a Tidelift subscription - -
- - Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies. - -
diff --git a/test.js b/test.js index e7b1a60..cb5dc3c 100644 --- a/test.js +++ b/test.js @@ -3,7 +3,7 @@ import Stream from 'node:stream'; import http from 'node:http'; import net from 'node:net'; import test from 'ava'; -import tempy from 'tempy'; +import {temporaryFile} from 'tempy'; import { isStream, isWritableStream, @@ -20,7 +20,7 @@ test('isStream()', t => { t.true(isStream(new Stream.Transform())); t.true(isStream(new Stream.PassThrough())); t.true(isStream(fs.createReadStream('test.js'))); - t.true(isStream(fs.createWriteStream(tempy.file()))); + t.true(isStream(fs.createWriteStream(temporaryFile()))); t.true(isStream(new http.OutgoingMessage())); t.true(isStream(new http.IncomingMessage())); t.true(isStream(new http.ServerResponse({}))); @@ -37,7 +37,7 @@ test('isWritableStream()', t => { t.true(isWritableStream(new Stream.Duplex())); t.true(isWritableStream(new Stream.Transform())); t.true(isWritableStream(new Stream.PassThrough())); - t.true(isWritableStream(fs.createWriteStream(tempy.file()))); + t.true(isWritableStream(fs.createWriteStream(temporaryFile()))); t.true(isWritableStream(new http.OutgoingMessage())); t.true(isWritableStream(new http.ServerResponse({}))); t.true(isWritableStream(new http.ClientRequest('http://example.com'))); @@ -62,7 +62,7 @@ test('isReadableStream()', t => { t.true(isReadableStream(new net.Socket())); t.false(isReadableStream(new Stream.Stream())); t.false(isReadableStream(new Stream.Writable())); - t.false(isReadableStream(fs.createWriteStream(tempy.file()))); + t.false(isReadableStream(fs.createWriteStream(temporaryFile()))); t.false(isReadableStream(new http.OutgoingMessage())); t.false(isReadableStream(new http.ServerResponse({}))); t.false(isReadableStream(new http.ClientRequest('http://example.com'))); @@ -81,7 +81,7 @@ test('isDuplexStream()', t => { t.false(isDuplexStream(new Stream.Readable())); t.false(isDuplexStream(new Stream.Writable())); t.false(isDuplexStream(fs.createReadStream('test.js'))); - t.false(isDuplexStream(fs.createWriteStream(tempy.file()))); + t.false(isDuplexStream(fs.createWriteStream(temporaryFile()))); t.false(isDuplexStream(new http.OutgoingMessage())); t.false(isDuplexStream(new http.IncomingMessage())); t.false(isDuplexStream(new http.ServerResponse({}))); @@ -100,7 +100,7 @@ test('isTransformStream()', t => { t.false(isTransformStream(new Stream.Writable())); t.false(isTransformStream(new Stream.Duplex())); t.false(isTransformStream(fs.createReadStream('test.js'))); - t.false(isTransformStream(fs.createWriteStream(tempy.file()))); + t.false(isTransformStream(fs.createWriteStream(temporaryFile()))); t.false(isTransformStream(new http.OutgoingMessage())); t.false(isTransformStream(new http.IncomingMessage())); t.false(isTransformStream(new http.ServerResponse({})));