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
38 lines
1.5 KiB
TypeScript
38 lines
1.5 KiB
TypeScript
import { AbstractTokenizer } from './AbstractTokenizer.js';
|
|
import type { IRandomAccessTokenizer, IRandomAccessFileInfo, IReadChunkOptions, ITokenizerOptions } from './types.js';
|
|
import { type FileHandle } from 'node:fs/promises';
|
|
interface IFileTokenizerOptions extends ITokenizerOptions {
|
|
/**
|
|
* Pass additional file information to the tokenizer
|
|
*/
|
|
fileInfo: IRandomAccessFileInfo;
|
|
}
|
|
export declare class FileTokenizer extends AbstractTokenizer implements IRandomAccessTokenizer {
|
|
private fileHandle;
|
|
fileInfo: IRandomAccessFileInfo;
|
|
/**
|
|
* Create tokenizer from provided file path
|
|
* @param sourceFilePath File path
|
|
*/
|
|
static fromFile(sourceFilePath: string): Promise<FileTokenizer>;
|
|
protected constructor(fileHandle: FileHandle, options: IFileTokenizerOptions);
|
|
/**
|
|
* Read buffer from file
|
|
* @param uint8Array - Uint8Array to write result to
|
|
* @param options - Read behaviour options
|
|
* @returns Promise number of bytes read
|
|
*/
|
|
readBuffer(uint8Array: Uint8Array, options?: IReadChunkOptions): Promise<number>;
|
|
/**
|
|
* Peek buffer from file
|
|
* @param uint8Array - Uint8Array (or Buffer) to write data to
|
|
* @param options - Read behaviour options
|
|
* @returns Promise number of bytes read
|
|
*/
|
|
peekBuffer(uint8Array: Uint8Array, options?: IReadChunkOptions): Promise<number>;
|
|
close(): Promise<void>;
|
|
setPosition(position: number): void;
|
|
supportsRandomAccess(): boolean;
|
|
}
|
|
export {};
|