58f8093689
- Updated all component headers and documentation
- Changed navbar and footer branding
- Updated homepage hero badge
- Modified page title in index.html
- Simplified footer text to 'Built with ❤️'
- Consistent V2 capitalization across all references
78 lines
2.9 KiB
TypeScript
78 lines
2.9 KiB
TypeScript
import type { ITokenizer, IFileInfo, IReadChunkOptions, ITokenizerOptions } from './types.js';
|
|
import type { IGetToken, IToken } from '@tokenizer/token';
|
|
interface INormalizedReadChunkOptions extends IReadChunkOptions {
|
|
offset: number;
|
|
length: number;
|
|
position: number;
|
|
mayBeLess?: boolean;
|
|
}
|
|
/**
|
|
* Core tokenizer
|
|
*/
|
|
export declare abstract class AbstractTokenizer implements ITokenizer {
|
|
private onClose?;
|
|
private numBuffer;
|
|
abstract fileInfo: IFileInfo;
|
|
/**
|
|
* Tokenizer-stream position
|
|
*/
|
|
position: number;
|
|
/**
|
|
* Constructor
|
|
* @param options Tokenizer options
|
|
* @protected
|
|
*/
|
|
protected constructor(options?: ITokenizerOptions);
|
|
abstract supportsRandomAccess(): boolean;
|
|
/**
|
|
* Read buffer from tokenizer
|
|
* @param buffer - Target buffer to fill with data read from the tokenizer-stream
|
|
* @param options - Additional read options
|
|
* @returns Promise with number of bytes read
|
|
*/
|
|
abstract readBuffer(buffer: Uint8Array, options?: IReadChunkOptions): Promise<number>;
|
|
/**
|
|
* Peek (read ahead) buffer from tokenizer
|
|
* @param uint8Array - Target buffer to fill with data peeked from the tokenizer-stream
|
|
* @param options - Peek behaviour options
|
|
* @returns Promise with number of bytes read
|
|
*/
|
|
abstract peekBuffer(uint8Array: Uint8Array, options?: IReadChunkOptions): Promise<number>;
|
|
/**
|
|
* Read a token from the tokenizer-stream
|
|
* @param token - The token to read
|
|
* @param position - If provided, the desired position in the tokenizer-stream
|
|
* @returns Promise with token data
|
|
*/
|
|
readToken<Value>(token: IGetToken<Value>, position?: number): Promise<Value>;
|
|
/**
|
|
* 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.
|
|
* @returns Promise with token data
|
|
*/
|
|
peekToken<Value>(token: IGetToken<Value>, position?: number): Promise<Value>;
|
|
/**
|
|
* Read a numeric token from the stream
|
|
* @param token - Numeric token
|
|
* @returns Promise with number
|
|
*/
|
|
readNumber(token: IToken<number>): Promise<number>;
|
|
/**
|
|
* Read a numeric token from the stream
|
|
* @param token - Numeric token
|
|
* @returns Promise with number
|
|
*/
|
|
peekNumber(token: IToken<number>): Promise<number>;
|
|
/**
|
|
* Ignore number of bytes, advances the pointer in under tokenizer-stream.
|
|
* @param length - Number of bytes to ignore
|
|
* @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available
|
|
*/
|
|
ignore(length: number): Promise<number>;
|
|
close(): Promise<void>;
|
|
protected normalizeOptions(uint8Array: Uint8Array, options?: IReadChunkOptions): INormalizedReadChunkOptions;
|
|
abort(): Promise<void>;
|
|
}
|
|
export {};
|