strtok3 10.3.2 → 10.3.5

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2025 Borewit
+Copyright © 2026 Borewit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -229,7 +229,7 @@ readBuffer(buffer: Uint8Array, options?: IReadChunkOptions): Promise<number>;
 | Parameter  | Type                                                           | Description                                                                                                                                                                                                                            |
 |------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | buffer     | [Buffer](https://nodejs.org/api/buffer.html) &#124; Uint8Array | Target buffer to write the data read to                                                                                                                                                                                                |
-| options    | [IReadChunkOptions](#ireadchunkoptions)                        | An integer specifying the number of bytes to read                                                                                                                                                                                      |
+| options    | [IReadChunkOptions](#ireadchunkoptions-interface)                        | An integer specifying the number of bytes to read                                                                                                                                                                                      |
 
 Return promise with number of bytes read.
 The number of bytes read may be less than requested if the `mayBeLess` flag is set.
@@ -245,7 +245,7 @@ peekBuffer(uint8Array: Uint8Array, options?: IReadChunkOptions): Promise<number>
 | Parameter  | Type                                    | Description                                         |
 |------------|-----------------------------------------|-----------------------------------------------------|
 | buffer     | Buffer &#124; Uint8Array                | Target buffer to write the data read (peeked) to.   |
-| options    | [IReadChunkOptions](#ireadchunkoptions) | An integer specifying the number of bytes to read.  |                                                                                                                           |
+| options    | [IReadChunkOptions](#ireadchunkoptions-interface) | An integer specifying the number of bytes to read.  |                                                                                                                           |
 
 Return value `Promise<number>` Promise with number of bytes read. The number of bytes read may be less if the `mayBeLess` flag was set.
 

package/lib/AbstractTokenizer.d.ts

@@ -65,7 +65,7 @@ export declare abstract class AbstractTokenizer implements ITokenizer {
     peekNumber(token: IToken<number>): Promise<number>;
     /**
      * Ignore number of bytes, advances the pointer in under tokenizer-stream.
-     * @param length - Number of bytes to ignore
+     * @param length - Number of bytes to ignore.  Must be ≥ 0.
      * @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available
      */
     ignore(length: number): Promise<number>;

package/lib/AbstractTokenizer.js

@@ -71,10 +71,13 @@ export class AbstractTokenizer {
     }
     /**
      * Ignore number of bytes, advances the pointer in under tokenizer-stream.
-     * @param length - Number of bytes to ignore
+     * @param length - Number of bytes to ignore.  Must be ≥ 0.
      * @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available
      */
     async ignore(length) {
+        if (length < 0) {
+            throw new RangeError('ignore length must be ≥ 0 bytes');
+        }
         if (this.fileInfo.size !== undefined) {
             const bytesLeft = this.fileInfo.size - this.position;
             if (length > bytesLeft) {

package/lib/ReadStreamTokenizer.d.ts

@@ -24,6 +24,9 @@ export declare class ReadStreamTokenizer extends AbstractTokenizer {
      * @returns Promise with number of bytes peeked
      */
     peekBuffer(uint8Array: Uint8Array, options?: IReadChunkOptions): Promise<number>;
+    /**
+     * @param length Number of bytes to ignore. Must be ≥ 0.
+     */
     ignore(length: number): Promise<number>;
     abort(): Promise<void>;
     close(): Promise<void>;

package/lib/ReadStreamTokenizer.js

@@ -75,8 +75,13 @@ export class ReadStreamTokenizer extends AbstractTokenizer {
         }
         return bytesRead;
     }
+    /**
+     * @param length Number of bytes to ignore. Must be ≥ 0.
+     */
     async ignore(length) {
-        // debug(`ignore ${this.position}...${this.position + length - 1}`);
+        if (length < 0) {
+            throw new RangeError('ignore length must be ≥ 0 bytes');
+        }
         const bufSize = Math.min(maxBufferSize, length);
         const buf = new Uint8Array(bufSize);
         let totBytesRead = 0;

package/lib/stream/WebStreamByobReader.js

@@ -13,7 +13,7 @@ export class WebStreamByobReader extends WebStreamReader {
     async readFromStream(buffer, mayBeLess) {
         if (buffer.length === 0)
             return 0;
-        // @ts-ignore
+        // @ts-expect-error
         const result = await this.reader.read(new Uint8Array(buffer.length), { min: mayBeLess ? undefined : buffer.length });
         if (result.done) {
             this.endOfStream = result.done;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strtok3",
-  "version": "10.3.2",
+  "version": "10.3.5",
   "description": "A promise based streaming tokenizer",
   "author": {
     "name": "Borewit",
@@ -12,10 +12,11 @@
   },
   "scripts": {
     "clean": "del-cli 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'test/**/*.js' 'test/**/*.js.map'",
-    "compile-src": "tsc -p lib",
+    "compile-src": "tsc -p lib  --sourceMap false",
     "compile-test": "tsc -p test",
     "compile": "yarn run compile-src && yarn run compile-test",
     "build": "yarn run clean && yarn run compile",
+    "prepublishOnly": "yarn run build",
     "eslint": "eslint lib test",
     "lint:md": "remark -u preset-lint-recommended .",
     "lint:ts": "biome check",
@@ -25,14 +26,15 @@
     "bun:test": "bun run --bun test",
     "test-coverage": "c8 yarn run test",
     "send-codacy": "c8 report --reporter=text-lcov | codacy-coverage",
-    "start": "yarn run compile && yarn run lint && yarn run cover-test"
+    "start": "yarn run compile && yarn run lint && yarn run cover-test",
+    "update-biome": "yarn add -D --exact @biomejs/biome && npx @biomejs/biome migrate --write"
   },
   "engines": {
     "node": ">=18"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Borewit/strtok3.git"
+    "url": "git+https://github.com/Borewit/strtok3.git"
   },
   "license": "MIT",
   "type": "module",
@@ -55,21 +57,21 @@
     "@tokenizer/token": "^0.3.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.1.1",
+    "@biomejs/biome": "2.4.8",
     "@types/chai": "^5.2.2",
     "@types/chai-as-promised": "^8.0.2",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^24.0.7",
-    "c8": "^10.1.3",
+    "@types/node": "^24.1.0",
+    "c8": "^11.0.0",
     "chai": "^5.2.1",
-    "chai-as-promised": "^8.0.1",
-    "del-cli": "^6.0.0",
-    "mocha": "^11.7.1",
+    "chai-as-promised": "^8.0.2",
+    "del-cli": "^7.0.0",
+    "mocha": "^11.7.5",
     "node-readable-to-web-readable-stream": "^0.4.2",
     "remark-cli": "^12.0.1",
     "remark-preset-lint-recommended": "^7.0.1",
-    "token-types": "^6.0.3",
+    "token-types": "^6.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
     "uint8array-extras": "^1.4.0"