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

    Variable FastqUtilsConst

    FastqUtils: {
        detectFormat: (data: string) => boolean;
        countSequences: (data: string) => number;
        extractIds: (data: string) => string[];
        parseHeader: (
            headerLine: string,
            lineNumber: number,
            options: {
                skipValidation?: boolean;
                onWarning?: (msg: string, line?: number) => void;
            },
        ) => { id: string; description?: string };
        validateQuality: (
            qualityLine: string,
            sequence: string,
            sequenceId: string,
            lineNumber: number,
        ) => string;
        validateSequence: (
            sequenceLine: string,
            lineNumber: number,
            options: { skipValidation?: boolean },
        ) => string;
        validateStructure: (data: string) => boolean;
        convertQuality(
            qualityString: string,
            fromEncoding: QualityEncoding,
            toEncoding: QualityEncoding,
        ): string;
        validateRecord(lines: string[]): { valid: boolean; error?: string };
    } = ...

    Utility functions for FASTQ format

    Type Declaration

    • ReadonlydetectFormat: (data: string) => boolean

      Detect if string contains FASTQ format data

    • ReadonlycountSequences: (data: string) => number

      Count sequences in FASTQ data without parsing

    • ReadonlyextractIds: (data: string) => string[]

      Extract sequence IDs from FASTQ data

    • ReadonlyparseHeader: (
          headerLine: string,
          lineNumber: number,
          options: {
              skipValidation?: boolean;
              onWarning?: (msg: string, line?: number) => void;
          },
      ) => { id: string; description?: string }

      Parse FASTQ header line

    • ReadonlyvalidateQuality: (
          qualityLine: string,
          sequence: string,
          sequenceId: string,
          lineNumber: number,
      ) => string

      Validate quality string length

    • ReadonlyvalidateSequence: (
          sequenceLine: string,
          lineNumber: number,
          options: { skipValidation?: boolean },
      ) => string

      Validate FASTQ sequence

    • ReadonlyvalidateStructure: (data: string) => boolean

      Perform quick validation of FASTQ structure

      Use validateFastqRecord from validation module

    • convertQuality: function
    • validateRecord: function
      • Validate FASTQ record structure

        Parameters

        • lines: string[]

        Returns { valid: boolean; error?: string }

        Use validateFastqRecord from validation module instead

    Use individual function imports for better tree-shaking