Genotype API Documentation - v0.1.0
    Preparing search index...

    Interface FileReaderOptions

    File reading configuration options with sensible defaults Provides control over streaming behavior and safety limits

    interface FileReaderOptions {
        bufferSize?: number;
        encoding?: "utf8" | "binary" | "ascii";
        maxFileSize?: number;
        timeout?: number;
        concurrent?: boolean;
        signal?: AbortSignal;
        autoDecompress?: boolean;
        compressionFormat?: CompressionFormat;
        decompressionOptions?: DecompressorOptions;
    }
    Index

    Properties

    bufferSize? encoding? maxFileSize? timeout? concurrent? signal? autoDecompress? compressionFormat? decompressionOptions?

    Properties

    bufferSize?: number

    Buffer size for streaming reads (default: runtime-optimized)

    encoding?: "utf8" | "binary" | "ascii"

    Text encoding for file content (default: 'utf8')

    maxFileSize?: number

    Maximum file size to prevent memory exhaustion (default: 100MB)

    timeout?: number

    Read timeout in milliseconds (default: 30000)

    concurrent?: boolean

    Allow concurrent reads from same file (default: false)

    signal?: AbortSignal

    AbortController signal for cancelling operations

    autoDecompress?: boolean

    Whether to automatically detect and decompress compressed files (default: true)

    compressionFormat?: CompressionFormat

    Override compression format detection (default: auto-detect)

    decompressionOptions?: DecompressorOptions

    Options for decompression when auto-decompression is enabled

    Settings

    Member Visibility

    On This Page

    Properties