forked from https://github.com/Borewit/strtok3 in order to be published in npm

!Node.js CI

strtok3

A promise based streaming tokenizer for Node.js and browsers.
This node module is a successor of strtok2.

The strtok3 contains a few methods to turn different input into a tokenizer. Designed to
* Support a streaming environment
* Decoding of binary data, strings and numbers in mind
* Read predefined or custom tokens.
Optimized tokenizers* for reading from file, stream or buffer.

It can read from:
* A file (taking a file path as an input)
* A Node.js stream.
* A Buffer or Uint8Array
* HTTP chunked transfer provided by @tokenizer/http.
* Chunked Amazon S3 access provided by @tokenizer/s3.

Installation

``sh
npm install strtok3
`

$3

Module: version 7 migrated from CommonJS to pure ECMAScript Module (ESM).
JavaScript is compliant with ECMAScript 2019 (ES10).
Requires Node.js ≥ 14.16 engine.

API

Use one of the methods to instantiate an abstract tokenizer:
* strtok3.fromFile
* strtok3.fromStream
* strtok3.fromBuffer
* strtok3.fromUint8Array

$3

All of the strtok3 methods return a tokenizer, either directly or via a promise.

#### Method strtok3.fromFile()

| Parameter | Type | Description |
|-----------|-----------------------|----------------------------|
| path | Path to file (string) | Path to file to read from |

> __Note__: that file-information is automatically added.

Returns, via a promise, a tokenizer which can be used to parse a file.

`js
import * as strtok3 from 'strtok3';
import * as Token from 'token-types';

(async () => {

const tokenizer = await strtok3.fromFile("somefile.bin");
try {
const myNumber = await tokenizer.readToken(Token.UINT8);
console.log(My number: ${myNumber});
} finally {
tokenizer.close(); // Close the file
}
})();

`

#### Method strtok3.fromStream()

Create tokenizer from a node.js readable stream.

| Parameter | Optional | Type | Description |
|-----------|-----------|-----------------------------------------------------------------------------|--------------------------|
| stream | no | Readable | Stream to read from |
| fileInfo | yes | IFileInfo | Provide file information |

Returns a tokenizer, via a Promise, which can be used to parse a buffer.

`js
import strtok3 from 'strtok3';
import * as Token from 'token-types';

strtok3.fromStream(stream).then(tokenizer => {
return tokenizer.readToken(Token.UINT8).then(myUint8Number => {
console.log(My number: ${myUint8Number});
});
});
`

#### Method strtok3.fromBuffer()

| Parameter | Optional | Type | Description |
|------------|----------|--------------------------------------------------|----------------------------------------|
| uint8Array | no | Uint8Array | Uint8Array or Buffer to read from |
| fileInfo | yes | IFileInfo | Provide file information |

Returns a tokenizer which can be used to parse the provided buffer.

`js
import * as strtok3 from 'strtok3';

const tokenizer = strtok3.fromBuffer(buffer);

tokenizer.readToken(Token.UINT8).then(myUint8Number => {
console.log(My number: ${myUint8Number});
});
`

Tokenizer

What is the difference with Nodejs.js stream?
The tokenizer-stream supports jumping / seeking in a the tokenizer-stream* using tokenizer.ignore()
In addition to read methods, it has peek* methods, to read a ahead and check what is coming.

The tokenizer.position keeps tracks of the read position.

$3

#### Attribute tokenizer.fileInfo
Optional attribute describing the file information, see IFileInfo

#### Attribute tokenizer.position
Pointer to the current position in the tokenizer stream.
If a position is provided to a read or peek method, is should be, at least, equal or greater than this value.

$3

There are two kind of methods:
1. read methods: used to read a token of Buffer from the tokenizer. The position of the tokenizer-stream will advance with the size of the token.
2. peek methods: same as the read, but it will not advance the pointer. It allows to read (peek) ahead.

#### Method tokenizer.readBuffer()

Read buffer from stream.
readBuffer(buffer, options?)

| Parameter | Type | Description |
|------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| buffer | Buffer | Uint8Array | Target buffer to write the data read to |
| options | IReadChunkOptions | An integer specifying the number of bytes to read |

Return value Promise Promise with number of bytes read. The number of bytes read maybe if less, mayBeLess flag was set.

#### Method tokenizer.peekBuffer()

Peek (read ahead) buffer from tokenizer
peekBuffer(buffer, options?)

| Parameter | Type | Description |
|------------|-----------------------------------------|-----------------------------------------------------|
| buffer | Buffer | Uint8Array | Target buffer to write the data read (peeked) to. |
| options | IReadChunkOptions | An integer specifying the number of bytes to read. | |

Return value Promise Promise with number of bytes read. The number of bytes read maybe if less, mayBeLess flag was set.

#### Method tokenizer.readToken()

Read a token from the tokenizer-stream.
readToken(token, position?)

| Parameter | Type | Description |
|------------|-------------------------|---------------------------------------------------------------------------------------------------------------------- |
| token | IGetToken | Token to read from the tokenizer-stream. |
| position? | number | Offset where to begin reading within the file. If position is null, data will be read from the current file position. |

Return value Promise. Promise with number of bytes read. The number of bytes read maybe if less, mayBeLess flag was set.

#### Method tokenizer.peekToken()

Peek a token from the tokenizer.
peekToken(token, position?)

| Parameter | Type | Description |
|------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------|
| token | IGetToken | Token to read from the tokenizer-stream. |
| position? | number | Offset where to begin reading within the file. If position is null, data will be read from the current file position. |

Return value Promise Promise with token value peeked from the tokenizer.

#### Method tokenizer.readNumber()

Peek a numeric token from the tokenizer.
readNumber(token)

| Parameter | Type | Description |
|------------|---------------------------------|----------------------------------------------------|
| token | IGetToken | Numeric token to read from the tokenizer-stream. |

Return value Promise Promise with number peeked from the tokenizer-stream.

#### Method tokenizer.ignore()

Advanse the offset pointer with the number of bytes provided.
ignore(length)

| Parameter | Type | Description |
|------------|--------|----------------------------------------------------------------------|
| ignore | number | Numeric of bytes to ignore. Will advance the tokenizer.position |

Return value Promise Promise with number peeked from the tokenizer-stream.

#### Method tokenizer.close()
Clean up resources, such as closing a file pointer if applicable.

$3

Each attribute is optional:

| Attribute | Type | Description |
|-----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| offset | number | The offset in the buffer to start writing at; if not provided, start at 0 |
| length | number | Requested number of bytes to read. |
| position | number | Position where to peek from the file. If position is null, data will be read from the current file position. Position may not be less then tokenizer.position |
| mayBeLess | boolean | If and only if set, will not throw an EOF error if less then the requested mayBeLess could be read. |

Example:
`js
tokenizer.peekBuffer(buffer, {mayBeLess: true});
`

IFileInfo

File information interface which describes the underlying file, each attribute is optional.

| Attribute | Type | Description |
|-----------|---------|---------------------------------------------------------------------------------------------------|
| size | number | File size in bytes |
| mimeType | number | MIME-type of file. |
| path | number | File path |
| url | boolean | File URL |

Token

The token is basically a description what to read form the tokenizer-stream.
A basic set of token types can be found here: token-types.

A token is something which implements the following interface:
`ts
export interface IGetToken {

/**
* Length in bytes of encoded value
*/
len: number;

/**
* Decode value from buffer at offset
* @param buf Buffer to read the decoded value from
* @param off Decode offset
*/
get(buf: Buffer, off: number): T;
}
`
The tokenizer reads token.len bytes from the tokenizer-stream into a Buffer.
The token.get will be called with the Buffer. token.get is responsible for conversion from the buffer to the desired output type.

Browser compatibility

| function | 'strtok3' | 'strtok3/lib/core' |
| ----------------------| --------------------|---------------------|
| parseBuffer | ✓ | ✓ |
| parseStream | ✓ | ✓ |
| fromFile | ✓ | |

$3

Example submodule-import:
`js
import * as strtok3core from 'strtok3/core'; // Submodule-import to prevent Node.js specific dependencies
import { ReadableWebToNodeStream } from 'readable-web-to-node-stream';

(async () => {

const response = await fetch(url);
const readableWebStream = response.body; // Web-API readable stream
const nodeStream = new ReadableWebToNodeStream(readableWebStream); // convert to Node.js readable stream

const tokenizer = strtok3core.fromStream(nodeStream); // And we now have tokenizer in a web environment
})();
``

Licence

(The MIT License)

Copyright (c) 2020 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 in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.