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

    Interface ConcatOptions

    Options for concatenating sequences from multiple sources

    Supports file paths and AsyncIterables with comprehensive ID conflict resolution. Maintains memory efficiency through streaming processing without loading entire datasets.

    interface ConcatOptions {
        sources: (string | AsyncIterable<AbstractSequence, any, any>)[];
        idConflictResolution?: "ignore" | "error" | "rename" | "suffix";
        renameSuffix?: string;
        validateFormats?: boolean;
        preserveOrder?: boolean;
        skipEmpty?: boolean;
        sourceLabels?: string[];
        maxMemory?: number;
        onProgress?: (
            processed: number,
            total?: number,
            currentSource?: string,
        ) => void;
    }
    Index

    Properties

    sources idConflictResolution? renameSuffix? validateFormats? preserveOrder? skipEmpty? sourceLabels? maxMemory? onProgress?

    Properties

    sources: (string | AsyncIterable<AbstractSequence, any, any>)[]

    Multiple source paths or AsyncIterables to concatenate

    idConflictResolution?: "ignore" | "error" | "rename" | "suffix"

    Strategy for handling ID conflicts between sources

    renameSuffix?: string

    Suffix to append when using 'suffix' conflict resolution (default: source index)

    validateFormats?: boolean

    Validate that all sources have compatible formats (default: true)

    preserveOrder?: boolean

    Preserve original source order in output (default: true)

    skipEmpty?: boolean

    Skip empty sequences during concatenation (default: false)

    sourceLabels?: string[]

    Human-readable labels for sources (used in error messages and suffixes)

    maxMemory?: number

    Maximum memory usage in bytes before switching to disk-based processing

    onProgress?: (processed: number, total?: number, currentSource?: string) => void

    Progress callback for tracking concatenation progress

    Settings

    Member Visibility

    On This Page

    Properties