strtok3 6.2.4 → 6.3.0

package/lib/core.js

@@ -1,29 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromBuffer = exports.fromStream = exports.EndOfStreamError = void 0;
-const ReadStreamTokenizer_1 = require("./ReadStreamTokenizer");
-const BufferTokenizer_1 = require("./BufferTokenizer");
-var peek_readable_1 = require("peek-readable");
-Object.defineProperty(exports, "EndOfStreamError", { enumerable: true, get: function () { return peek_readable_1.EndOfStreamError; } });
-/**
- * Construct ReadStreamTokenizer from given Stream.
- * Will set fileSize, if provided given Stream has set the .path property/
- * @param stream - Read from Node.js Stream.Readable
- * @param fileInfo - Pass the file information, like size and MIME-type of the correspnding stream.
- * @returns ReadStreamTokenizer
- */
-function fromStream(stream, fileInfo) {
-    fileInfo = fileInfo ? fileInfo : {};
-    return new ReadStreamTokenizer_1.ReadStreamTokenizer(stream, fileInfo);
-}
-exports.fromStream = fromStream;
-/**
- * Construct ReadStreamTokenizer from given Buffer.
- * @param uint8Array - Uint8Array to tokenize
- * @param fileInfo - Pass additional file information to the tokenizer
- * @returns BufferTokenizer
- */
-function fromBuffer(uint8Array, fileInfo) {
-    return new BufferTokenizer_1.BufferTokenizer(uint8Array, fileInfo);
-}
-exports.fromBuffer = fromBuffer;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromBuffer = exports.fromStream = exports.EndOfStreamError = void 0;
+const ReadStreamTokenizer_1 = require("./ReadStreamTokenizer");
+const BufferTokenizer_1 = require("./BufferTokenizer");
+var peek_readable_1 = require("peek-readable");
+Object.defineProperty(exports, "EndOfStreamError", { enumerable: true, get: function () { return peek_readable_1.EndOfStreamError; } });
+/**
+ * Construct ReadStreamTokenizer from given Stream.
+ * Will set fileSize, if provided given Stream has set the .path property/
+ * @param stream - Read from Node.js Stream.Readable
+ * @param fileInfo - Pass the file information, like size and MIME-type of the corresponding stream.
+ * @returns ReadStreamTokenizer
+ */
+function fromStream(stream, fileInfo) {
+    fileInfo = fileInfo ? fileInfo : {};
+    return new ReadStreamTokenizer_1.ReadStreamTokenizer(stream, fileInfo);
+}
+exports.fromStream = fromStream;
+/**
+ * Construct ReadStreamTokenizer from given Buffer.
+ * @param uint8Array - Uint8Array to tokenize
+ * @param fileInfo - Pass additional file information to the tokenizer
+ * @returns BufferTokenizer
+ */
+function fromBuffer(uint8Array, fileInfo) {
+    return new BufferTokenizer_1.BufferTokenizer(uint8Array, fileInfo);
+}
+exports.fromBuffer = fromBuffer;

package/lib/index.d.ts

@@ -1,15 +1,15 @@
-/// <reference types="node" />
-import { Readable } from 'stream';
-import { ReadStreamTokenizer } from './ReadStreamTokenizer';
-import * as core from './core';
-export { fromFile } from './FileTokenizer';
-export { ITokenizer, EndOfStreamError, fromBuffer, IFileInfo } from './core';
-export { IToken, IGetToken } from '@tokenizer/token';
-/**
- * Construct ReadStreamTokenizer from given Stream.
- * Will set fileSize, if provided given Stream has set the .path property.
- * @param stream - Node.js Stream.Readable
- * @param fileInfo - Pass additional file information to the tokenizer
- * @returns Tokenizer
- */
-export declare function fromStream(stream: Readable, fileInfo?: core.IFileInfo): Promise<ReadStreamTokenizer>;
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { ReadStreamTokenizer } from './ReadStreamTokenizer';
+import * as core from './core';
+export { fromFile } from './FileTokenizer';
+export { ITokenizer, EndOfStreamError, fromBuffer, IFileInfo } from './core';
+export { IToken, IGetToken } from '@tokenizer/token';
+/**
+ * Construct ReadStreamTokenizer from given Stream.
+ * Will set fileSize, if provided given Stream has set the .path property.
+ * @param stream - Node.js Stream.Readable
+ * @param fileInfo - Pass additional file information to the tokenizer
+ * @returns Tokenizer
+ */
+export declare function fromStream(stream: Readable, fileInfo?: core.IFileInfo): Promise<ReadStreamTokenizer>;

package/lib/index.js

@@ -1,27 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromStream = exports.fromBuffer = exports.EndOfStreamError = exports.fromFile = void 0;
-const fs = require("./FsPromise");
-const core = require("./core");
-var FileTokenizer_1 = require("./FileTokenizer");
-Object.defineProperty(exports, "fromFile", { enumerable: true, get: function () { return FileTokenizer_1.fromFile; } });
-var core_1 = require("./core");
-Object.defineProperty(exports, "EndOfStreamError", { enumerable: true, get: function () { return core_1.EndOfStreamError; } });
-Object.defineProperty(exports, "fromBuffer", { enumerable: true, get: function () { return core_1.fromBuffer; } });
-/**
- * Construct ReadStreamTokenizer from given Stream.
- * Will set fileSize, if provided given Stream has set the .path property.
- * @param stream - Node.js Stream.Readable
- * @param fileInfo - Pass additional file information to the tokenizer
- * @returns Tokenizer
- */
-async function fromStream(stream, fileInfo) {
-    fileInfo = fileInfo ? fileInfo : {};
-    if (stream.path) {
-        const stat = await fs.stat(stream.path);
-        fileInfo.path = stream.path;
-        fileInfo.size = stat.size;
-    }
-    return core.fromStream(stream, fileInfo);
-}
-exports.fromStream = fromStream;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromStream = exports.fromBuffer = exports.EndOfStreamError = exports.fromFile = void 0;
+const fs = require("./FsPromise");
+const core = require("./core");
+var FileTokenizer_1 = require("./FileTokenizer");
+Object.defineProperty(exports, "fromFile", { enumerable: true, get: function () { return FileTokenizer_1.fromFile; } });
+var core_1 = require("./core");
+Object.defineProperty(exports, "EndOfStreamError", { enumerable: true, get: function () { return core_1.EndOfStreamError; } });
+Object.defineProperty(exports, "fromBuffer", { enumerable: true, get: function () { return core_1.fromBuffer; } });
+/**
+ * Construct ReadStreamTokenizer from given Stream.
+ * Will set fileSize, if provided given Stream has set the .path property.
+ * @param stream - Node.js Stream.Readable
+ * @param fileInfo - Pass additional file information to the tokenizer
+ * @returns Tokenizer
+ */
+async function fromStream(stream, fileInfo) {
+    fileInfo = fileInfo ? fileInfo : {};
+    if (stream.path) {
+        const stat = await fs.stat(stream.path);
+        fileInfo.path = stream.path;
+        fileInfo.size = stat.size;
+    }
+    return core.fromStream(stream, fileInfo);
+}
+exports.fromStream = fromStream;

package/lib/types.d.ts

@@ -1,103 +1,103 @@
-/// <reference types="node" />
-import { IGetToken } from '@tokenizer/token';
-export interface IFileInfo {
-    /**
-     * File size in bytes
-     */
-    size?: number;
-    /**
-     * MIME-type of file
-     */
-    mimeType?: string;
-    /**
-     * File path
-     */
-    path?: string;
-    /**
-     * File URL
-     */
-    url?: string;
-}
-export interface IReadChunkOptions {
-    /**
-     * The offset in the buffer to start writing at; default is 0
-     */
-    offset?: number;
-    /**
-     * Number of bytes to read.
-     */
-    length?: number;
-    /**
-     * Position where to begin reading from the file.
-     * Default it is `tokenizer.position`.
-     * Position may not be less then `tokenizer.position`.
-     */
-    position?: number;
-    /**
-     * If set, will not throw an EOF error if not all of the requested data could be read
-     */
-    mayBeLess?: boolean;
-}
-/**
- * The tokenizer allows us to read or peek from the tokenizer-stream.
- * The tokenizer-stream is an abstraction of a stream, file or Buffer.
- */
-export interface ITokenizer {
-    /**
-     * Provide access to information of the underlying information stream or file.
-     */
-    fileInfo: IFileInfo;
-    /**
-     * Offset in bytes (= number of bytes read) since beginning of file or stream
-     */
-    position: number;
-    /**
-     * Peek (read ahead) buffer from tokenizer
-     * @param buffer - Target buffer to fill with data peek from the tokenizer-stream
-     * @param options - Read behaviour options
-     * @returns Promise with number of bytes read
-     */
-    peekBuffer(buffer: Buffer, options?: IReadChunkOptions): Promise<number>;
-    /**
-     * Peek (read ahead) buffer from tokenizer
-     * @param buffer - Target buffer to fill with data peeked from the tokenizer-stream
-     * @param options - Additional read options
-     * @returns Promise with number of bytes read
-     */
-    readBuffer(buffer: Buffer, options?: IReadChunkOptions): Promise<number>;
-    /**
-     * Peek a token from the tokenizer-stream.
-     * @param token - Token to peek from the tokenizer-stream.
-     * @param position - Offset where to begin reading within the file. If position is null, data will be read from the current file position.
-     * @param maybeless - If set, will not throw an EOF error if the less then the requested length could be read.
-     */
-    peekToken<T>(token: IGetToken<T>, position?: number | null, maybeless?: boolean): Promise<T>;
-    /**
-     * Read a token from the tokenizer-stream.
-     * @param token - Token to peek from the tokenizer-stream.
-     * @param position - Offset where to begin reading within the file. If position is null, data will be read from the current file position.
-     */
-    readToken<T>(token: IGetToken<T>, position?: number): Promise<T>;
-    /**
-     * Peek a numeric token from the stream
-     * @param token - Numeric token
-     * @returns Promise with number
-     */
-    peekNumber(token: IGetToken<number>): Promise<number>;
-    /**
-     * Read a numeric token from the stream
-     * @param token - Numeric token
-     * @returns Promise with number
-     */
-    readNumber(token: IGetToken<number>): Promise<number>;
-    /**
-     * Ignore given number of bytes
-     * @param length - Number of bytes ignored
-     */
-    ignore(length: number): Promise<number>;
-    /**
-     * Clean up resources.
-     * It does not close the stream for StreamReader, but is does close the file-descriptor.
-     */
-    close(): Promise<void>;
-}
+/// <reference types="node" />
+import { IGetToken } from '@tokenizer/token';
+export interface IFileInfo {
+    /**
+     * File size in bytes
+     */
+    size?: number;
+    /**
+     * MIME-type of file
+     */
+    mimeType?: string;
+    /**
+     * File path
+     */
+    path?: string;
+    /**
+     * File URL
+     */
+    url?: string;
+}
+export interface IReadChunkOptions {
+    /**
+     * The offset in the buffer to start writing at; default is 0
+     */
+    offset?: number;
+    /**
+     * Number of bytes to read.
+     */
+    length?: number;
+    /**
+     * Position where to begin reading from the file.
+     * Default it is `tokenizer.position`.
+     * Position may not be less then `tokenizer.position`.
+     */
+    position?: number;
+    /**
+     * If set, will not throw an EOF error if not all of the requested data could be read
+     */
+    mayBeLess?: boolean;
+}
+/**
+ * The tokenizer allows us to read or peek from the tokenizer-stream.
+ * The tokenizer-stream is an abstraction of a stream, file or Buffer.
+ */
+export interface ITokenizer {
+    /**
+     * Provide access to information of the underlying information stream or file.
+     */
+    fileInfo: IFileInfo;
+    /**
+     * Offset in bytes (= number of bytes read) since beginning of file or stream
+     */
+    position: number;
+    /**
+     * Peek (read ahead) buffer from tokenizer
+     * @param buffer - Target buffer to fill with data peek from the tokenizer-stream
+     * @param options - Read behaviour options
+     * @returns Promise with number of bytes read
+     */
+    peekBuffer(buffer: Buffer, options?: IReadChunkOptions): Promise<number>;
+    /**
+     * Peek (read ahead) buffer from tokenizer
+     * @param buffer - Target buffer to fill with data peeked from the tokenizer-stream
+     * @param options - Additional read options
+     * @returns Promise with number of bytes read
+     */
+    readBuffer(buffer: Buffer, options?: IReadChunkOptions): Promise<number>;
+    /**
+     * Peek a token from the tokenizer-stream.
+     * @param token - Token to peek from the tokenizer-stream.
+     * @param position - Offset where to begin reading within the file. If position is null, data will be read from the current file position.
+     * @param maybeless - If set, will not throw an EOF error if the less then the requested length could be read.
+     */
+    peekToken<T>(token: IGetToken<T>, position?: number | null, maybeless?: boolean): Promise<T>;
+    /**
+     * Read a token from the tokenizer-stream.
+     * @param token - Token to peek from the tokenizer-stream.
+     * @param position - Offset where to begin reading within the file. If position is null, data will be read from the current file position.
+     */
+    readToken<T>(token: IGetToken<T>, position?: number): Promise<T>;
+    /**
+     * Peek a numeric token from the stream
+     * @param token - Numeric token
+     * @returns Promise with number
+     */
+    peekNumber(token: IGetToken<number>): Promise<number>;
+    /**
+     * Read a numeric token from the stream
+     * @param token - Numeric token
+     * @returns Promise with number
+     */
+    readNumber(token: IGetToken<number>): Promise<number>;
+    /**
+     * Ignore given number of bytes
+     * @param length - Number of bytes ignored
+     */
+    ignore(length: number): Promise<number>;
+    /**
+     * Clean up resources.
+     * It does not close the stream for StreamReader, but is does close the file-descriptor.
+     */
+    close(): Promise<void>;
+}

package/lib/types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,101 +1,103 @@
-{
-  "name": "strtok3",
-  "version": "6.2.4",
-  "description": "A promise based streaming tokenizer",
-  "author": {
-    "name": "Borewit",
-    "url": "https://github.com/Borewit"
-  },
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/Borewit"
-  },
-  "scripts": {
-    "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.js test/**/*.js.map",
-    "compile-src": "tsc -p lib",
-    "compile-test": "tsc -p test",
-    "compile": "npm run compile-src && npm run compile-test",
-    "build": "npm run clean && npm run compile",
-    "eslint": "eslint lib test --ext .ts --ignore-pattern *.d.ts",
-    "lint-md": "remark -u preset-lint-recommended .",
-    "lint": "npm run lint-md && npm run eslint",
-    "fix": "eslint lib test --ext .ts --ignore-pattern *.d.ts --fix",
-    "test": "mocha --require ts-node/register --require source-map-support/register --full-trace test/test.ts",
-    "test-coverage": "nyc npm run test",
-    "send-coveralls": "nyc report --reporter=text-lcov | coveralls",
-    "send-codacy": "nyc report --reporter=text-lcov | codacy-coverage",
-    "start": "npm run compile && npm run lint && npm run cover-test"
-  },
-  "engines": {
-    "node": ">=10"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Borewit/strtok3.git"
-  },
-  "license": "MIT",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/**/*.js",
-    "lib/**/*.d.ts"
-  ],
-  "bugs": {
-    "url": "https://github.com/Borewit/strtok3/issues"
-  },
-  "devDependencies": {
-    "@types/chai": "^4.2.21",
-    "@types/debug": "^4.1.7",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.4.7",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/eslint-plugin-tslint": "^4.28.5",
-    "@typescript-eslint/parser": "^2.34.0",
-    "chai": "^4.3.4",
-    "coveralls": "^3.1.1",
-    "del-cli": "^4.0.1",
-    "eslint": "^6.8.0",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "mocha": "^9.0.3",
-    "nyc": "^15.1.0",
-    "remark-cli": "^9.0.0",
-    "remark-preset-lint-recommended": "^5.0.0",
-    "source-map-support": "^0.5.16",
-    "token-types": "^4.1.0",
-    "ts-node": "^10.1.0",
-    "tslint": "^6.1.3",
-    "typescript": "^4.3.5"
-  },
-  "dependencies": {
-    "@tokenizer/token": "^0.3.0",
-    "peek-readable": "^4.0.1"
-  },
-  "keywords": [
-    "tokenizer",
-    "reader",
-    "token",
-    "async",
-    "promise",
-    "parser",
-    "decoder",
-    "binary",
-    "endian",
-    "uint",
-    "stream",
-    "streaming"
-  ],
-  "nyc": {
-    "check-coverage": false,
-    "extension": [
-      ".ts"
-    ],
-    "sourceMap": true,
-    "instrument": true,
-    "reporter": [
-      "lcov",
-      "text"
-    ],
-    "report-dir": "coverage"
-  }
-}
+{
+  "name": "strtok3",
+  "version": "6.3.0",
+  "description": "A promise based streaming tokenizer",
+  "author": {
+    "name": "Borewit",
+    "url": "https://github.com/Borewit"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/Borewit"
+  },
+  "scripts": {
+    "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.js test/**/*.js.map",
+    "compile-src": "tsc -p lib",
+    "compile-test": "tsc -p test",
+    "compile": "npm run compile-src && npm run compile-test",
+    "build": "npm run clean && npm run compile",
+    "eslint": "eslint lib test --ext .ts --ignore-pattern *.d.ts",
+    "lint-md": "remark -u preset-lint-recommended .",
+    "lint": "npm run lint-md && npm run eslint",
+    "fix": "eslint lib test --ext .ts --ignore-pattern *.d.ts --fix",
+    "test": "mocha --require ts-node/register --require source-map-support/register --full-trace test/test.ts",
+    "test-coverage": "nyc npm run test",
+    "send-coveralls": "nyc report --reporter=text-lcov | coveralls",
+    "send-codacy": "nyc report --reporter=text-lcov | codacy-coverage",
+    "start": "npm run compile && npm run lint && npm run cover-test"
+  },
+  "engines": {
+    "node": ">=10"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Borewit/strtok3.git"
+  },
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts"
+  ],
+  "bugs": {
+    "url": "https://github.com/Borewit/strtok3/issues"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.0",
+    "@types/debug": "^4.1.7",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^17.0.14",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "chai": "^4.3.6",
+    "coveralls": "^3.1.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.8.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^37.7.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^40.1.0",
+    "mocha": "^9.2.0",
+    "nyc": "^15.1.0",
+    "remark-cli": "^10.0.1",
+    "remark-preset-lint-recommended": "^6.1.2",
+    "source-map-support": "^0.5.21",
+    "token-types": "^4.1.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.5"
+  },
+  "dependencies": {
+    "@tokenizer/token": "^0.3.0",
+    "peek-readable": "^4.1.0"
+  },
+  "keywords": [
+    "tokenizer",
+    "reader",
+    "token",
+    "async",
+    "promise",
+    "parser",
+    "decoder",
+    "binary",
+    "endian",
+    "uint",
+    "stream",
+    "streaming"
+  ],
+  "nyc": {
+    "check-coverage": false,
+    "extension": [
+      ".ts"
+    ],
+    "sourceMap": true,
+    "instrument": true,
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "report-dir": "coverage"
+  }
+}