peek-readable - npm Package Compare versions

Comparing version 5.0.0 to 5.1.0

lib/index.d.ts

@@ -0,2 +1,7 @@
+export interface IStreamReader {
+    peek(uint8Array: Uint8Array, offset: number, length: number): Promise<number>;
+    read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
+}
 export { EndOfStreamError } from './EndOfFileStream.js';
 export { StreamReader } from './StreamReader.js';
+export { WebStreamReader } from './WebStreamReader.js';

lib/index.js

 export { EndOfStreamError } from './EndOfFileStream.js';
 export { StreamReader } from './StreamReader.js';
+export { WebStreamReader } from './WebStreamReader.js';

lib/StreamReader.d.ts

@@ -1,5 +0,5 @@
-/// <reference types="node" resolution-mode="require"/>
 import { Readable } from 'node:stream';
+import { IStreamReader } from "./index.js";
 export { EndOfStreamError } from './EndOfFileStream.js';
-export declare class StreamReader {
+export declare class StreamReader implements IStreamReader {
     private s;
@@ -6,0 +6,0 @@ /**

package.json

 {
   "name": "peek-readable",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Read and peek from a readable stream",
@@ -19,3 +19,3 @@ "author": {
     "compile": "npm run compile-src && yarn run compile-test",
-    "eslint": "eslint lib test --ext .ts --ignore-pattern *.d.ts",
+    "eslint": "eslint lib/**/*.ts --ignore-pattern lib/**/*.d.ts test/**/*.ts",
     "lint-md": "remark -u preset-lint-recommended .",
@@ -46,23 +46,23 @@ "lint": "npm run lint-md && npm run eslint",
   "devDependencies": {
-    "@types/chai": "^4.3.1",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^18.6.3",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "c8": "^7.12.0",
-    "chai": "^4.3.6",
-    "coveralls": "^3.1.1",
-    "del-cli": "^5.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-typescript": "^3.4.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.4",
+    "@types/chai": "^4.3.16",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^20.14.9",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
+    "c8": "^10.1.2",
+    "chai": "^5.1.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.5.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^40.1.0",
-    "mocha": "^10.0.0",
-    "remark-cli": "^11.0.0",
-    "remark-preset-lint-recommended": "^6.1.2",
+    "eslint-plugin-unicorn": "^54.0.0",
+    "mocha": "^10.5.2",
+    "remark-cli": "^12.0.1",
+    "remark-preset-lint-recommended": "^7.0.0",
+    "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.5.2"
   },
@@ -69,0 +69,0 @@ "keywords": [

README.md

@@ -1,2 +0,2 @@
-![Node.js CI](https://github.com/Borewit/peek-readable/workflows/Node.js%20CI/badge.svg)
+[![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)
 [![NPM version](https://badge.fury.io/js/peek-readable.svg)](https://npmjs.org/package/peek-readable)
@@ -6,5 +6,4 @@ [![npm downloads](http://img.shields.io/npm/dm/peek-readable.svg)](https://npmcharts.com/compare/peek-readable?start=600&interval=30)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d4b511481b3a4634b6ca5c0724407eb9)](https://www.codacy.com/gh/Borewit/peek-readable/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Borewit/peek-readable&utm_campaign=Badge_Grade)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/Borewit/peek-readable.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/peek-readable/alerts/)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Borewit/peek-readable.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/peek-readable/context:javascript)
 [![Known Vulnerabilities](https://snyk.io/test/github/Borewit/peek-readable/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Borewit/peek-readable?targetFile=package.json)
+[![CodeQL](https://github.com/Borewit/peek-readable/actions/workflows/codeql.yml/badge.svg)](https://github.com/Borewit/peek-readable/actions/workflows/codeql.yml)
 
@@ -11,0 +10,0 @@ # peek-readable

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

Total package byte prevSize

17201

increased by17.71%

Number of package files

13

increased by18.18%

Lines of code

276

increased by30.19%

Worsened metrics

Number of lines in readme file

95

decreased by-1.04%

No dependency changes