peek-readable - npm Package Compare versions

Comparing version 5.1.3 to 5.1.4

lib/AbstractStreamReader.d.ts

@@ -33,4 +33,4 @@ export interface IStreamReader {
     protected readFromPeekBuffer(buffer: Uint8Array, offset: number, length: number): number;
-    readRemainderFromStream(buffer: Uint8Array, offset: number, remaining: number): Promise<number>;
+    readRemainderFromStream(buffer: Uint8Array, offset: number, initialRemaining: number): Promise<number>;
     protected abstract readFromStream(buffer: Uint8Array, offset: number, length: number): Promise<number>;
 }

lib/AbstractStreamReader.js

@@ -64,3 +64,4 @@ import { EndOfStreamError } from "./EndOfStreamError.js";
     }
-    async readRemainderFromStream(buffer, offset, remaining) {
+    async readRemainderFromStream(buffer, offset, initialRemaining) {
+        let remaining = initialRemaining;
         let bytesRead = 0;
@@ -67,0 +68,0 @@ // Continue reading from stream if required

lib/Deferred.d.ts

 export declare class Deferred<T> {
     promise: Promise<T>;
     resolve: (value: T) => void;
-    reject: (reason: any) => void;
+    reject: (reason: unknown) => void;
     constructor();
 }

lib/index.d.ts

 export { EndOfStreamError } from './EndOfStreamError.js';
 export { StreamReader } from './StreamReader.js';
-export { WebStreamReader } from './WebStreamReader.js';
-export { IStreamReader } from './AbstractStreamReader.js';
+export { WebStreamReader, type AnyWebByteStream } from './WebStreamReader.js';
+export type { IStreamReader } from './AbstractStreamReader.js';

lib/StreamReader.d.ts

@@ -1,2 +0,2 @@
-import { Readable } from 'node:stream';
+import type { Readable } from 'node:stream';
 import { AbstractStreamReader } from "./AbstractStreamReader.js";
@@ -3,0 +3,0 @@ export { EndOfStreamError } from './EndOfStreamError.js';

lib/StreamReader.js

@@ -40,15 +40,13 @@ import { EndOfStreamError } from './EndOfStreamError.js';
         }
-        else {
-            const request = {
-                buffer,
-                offset,
-                length,
-                deferred: new Deferred()
-            };
-            this.deferred = request.deferred;
-            this.s.once('readable', () => {
-                this.readDeferred(request);
-            });
-            return request.deferred.promise;
-        }
+        const request = {
+            buffer,
+            offset,
+            length,
+            deferred: new Deferred()
+        };
+        this.deferred = request.deferred;
+        this.s.once('readable', () => {
+            this.readDeferred(request);
+        });
+        return request.deferred.promise;
     }
@@ -55,0 +53,0 @@ /**

lib/WebStreamReader.d.ts

@@ -1,4 +0,5 @@
-import { ReadableStream } from 'node:stream/web';
+import type { ReadableStream as NodeReadableStream } from 'node:stream/web';
 export { EndOfStreamError } from './EndOfStreamError.js';
 import { AbstractStreamReader } from "./AbstractStreamReader.js";
+export type AnyWebByteStream = NodeReadableStream<Uint8Array> | ReadableStream<Uint8Array>;
 /**
@@ -10,4 +11,4 @@ * Read from a WebStream
     private reader;
-    constructor(stream: ReadableStream<Uint8Array>);
+    constructor(stream: AnyWebByteStream);
     protected readFromStream(buffer: Uint8Array, offset: number, length: number): Promise<number>;
 }

package.json

 {
   "name": "peek-readable",
-  "version": "5.1.3",
+  "version": "5.1.4",
   "description": "Read and peek from a readable stream",
@@ -14,13 +14,13 @@ "author": {
   "scripts": {
-    "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.js test/**/*.js.map coverage .nyc_output",
+    "clean": "'del-cli' 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'test/**/*.js' 'test/**/*.js.map' 'coverage' '.nyc_output'",
     "build": "npm run clean && npm run compile",
     "compile-src": "tsc -p lib",
     "compile-test": "tsc -p test",
-    "compile": "npm run compile-src && yarn run compile-test",
-    "eslint": "eslint lib/**/*.ts --ignore-pattern lib/**/*.d.ts test/**/*.ts",
+    "compile": "yarn run compile-src && yarn run compile-test",
+    "lint-ts": "biome check",
     "lint-md": "remark -u preset-lint-recommended .",
-    "lint": "npm run lint-md && npm run eslint",
+    "lint": "yarn run lint-md && yarn run lint-ts",
     "test": "mocha",
     "test-coverage": "c8 npm run test",
-    "start": "npm run compile && npm run lint && npm run cover-test"
+    "start": "yarn run compile && yarn run lint && yarn run cover-test"
   },
@@ -46,21 +46,10 @@ "engines": {
   "devDependencies": {
-    "@eslint/compat": "^1.1.1",
-    "@eslint/eslintrc": "^3.1.0",
-    "@types/chai": "^4.3.16",
+    "@biomejs/biome": "1.8.3",
+    "@types/chai": "^4.3.17",
     "@types/mocha": "^10.0.7",
-    "@types/node": "^20.14.10",
-    "@typescript-eslint/eslint-plugin": "^7.16.0",
-    "@typescript-eslint/parser": "^7.16.0",
+    "@types/node": "^22.1.0",
     "c8": "^10.1.2",
     "chai": "^5.1.1",
     "del-cli": "^5.1.0",
-    "eslint": "^9.7.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.7.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^54.0.0",
-    "globals": "^15.8.0",
-    "mocha": "^10.6.0",
+    "mocha": "^10.7.0",
     "remark-cli": "^12.0.1",
@@ -70,3 +59,3 @@ "remark-preset-lint-recommended": "^7.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.4"
   },
@@ -73,0 +62,0 @@ "keywords": [

README.md

@@ -1,4 +0,3 @@
-[![Node.js CI](https://github.com/Borewit/peek-readable/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/Borewit/peek-readable/actions/workflows/nodejs-ci.yml)
-[![CodeQL](https://github.com/Borewit/peek-readable/actions/workflows/codeql.yml/badge.svg)](https://github.com/Borewit/peek-readable/actions/workflows/codeql.yml)
-[![NPM version](https://badge.fury.io/js/peek-readable.svg)](https://npmjs.org/package/peek-readable)
+[![Node.js CI](https://github.com/Borewit/peek-readable/actions/workflows/nodejs-ci.yml/badge.svg?branch=master)](https://github.com/Borewit/peek-readable/actions/workflows/nodejs-ci.yml)
+[![CodeQL](https://github.com/Borewit/peek-readable/actions/workflows/github-code-scanning/codeql/badge.svg?branch=master)](https://github.com/Borewit/peek-readable/actions/workflows/github-code-scanning/codeql)[![NPM version](https://badge.fury.io/js/peek-readable.svg)](https://npmjs.org/package/peek-readable)
 [![npm downloads](http://img.shields.io/npm/dm/peek-readable.svg)](https://npmcharts.com/compare/peek-readable?start=600&interval=30)
@@ -5,0 +4,0 @@ [![Coverage Status](https://coveralls.io/repos/github/Borewit/peek-readable/badge.svg?branch=master)](https://coveralls.io/github/Borewit/peek-readable?branch=master)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

13

decreased by-45.83%

Worsened metrics

Total package byte prevSize

17728

decreased by-2.49%

Number of lines in readme file

94

decreased by-1.05%

No dependency changes