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

    Interface KmerRecordInput<K>

    Input fields for creating a k-mer record.

    The sequence field accepts either a plain string or an existing GenotypeString. The generic parameter K tracks k-mer size at compile time.

    interface KmerRecordInput<K extends number> {
        id: string;
        sequence: string | GenotypeString;
        kmerSize: K;
        stepSize: number;
        originalId: string;
        startPosition: number;
        endPosition: number;
        coordinateSystem: "0-based" | "1-based";
        suffix: string;
        isWrapped: boolean;
        windowIndex: number;
        description?: string;
        lineNumber?: number;
    }

    Type Parameters

    • K extends number
    Index

    Properties

    id: string
    sequence: string | GenotypeString
    kmerSize: K
    stepSize: number
    originalId: string
    startPosition: number
    endPosition: number
    coordinateSystem: "0-based" | "1-based"
    suffix: string
    isWrapped: boolean
    windowIndex: number
    description?: string
    lineNumber?: number