Class PairSyncError

constructor

• new PairSyncError(
      message: string,
      pairIndex: number,
      failedFile: "r1" | "r2" | "both",
  ): PairSyncError

  Create a new paired-end synchronization error

  Parameters

  • message: string

    Detailed error message

  • pairIndex: number

    Index of the pair where sync failed (0-based)

  • failedFile: "r1" | "r2" | "both"

    Which file(s) failed: 'r1', 'r2', or 'both'

  Returns PairSyncError

  Example

  try {
    for await (const pair of parser.parseFiles('R1.fq', 'R2.fq')) {
      // Process pairs
    }
  } catch (error) {
    if (error instanceof PairSyncError) {
      console.error(`Sync error at pair ${error.pairIndex}`);
      console.error(`Failed file: ${error.failedFile}`);
      console.error(error.message);
    }
  }
  Copy

StaticforIdMismatch

• forIdMismatch(
      r1Id: string,
      r2Id: string,
      pairIndex: number,
      baseR1?: string,
      baseR2?: string,
  ): PairSyncError

  Create error for read ID mismatch

  Parameters

  • r1Id: string
  • r2Id: string
  • pairIndex: number
  • OptionalbaseR1: string
  • OptionalbaseR2: string

  Returns PairSyncError

StaticforLengthMismatch

• forLengthMismatch(pairIndex: number, exhaustedFile: "r1" | "r2"): PairSyncError

  Create error for file length mismatch

  Parameters

  • pairIndex: number
  • exhaustedFile: "r1" | "r2"

  Returns PairSyncError

StaticforUnpairedRead

• forUnpairedRead(readId: string): PairSyncError

  Create error for unpaired read in strict mode

  Parameters

  • readId: string

  Returns PairSyncError

toString

• toString(): string

  Create a user-friendly error message with context

  Returns string

ReadonlypairIndex

ReadonlyfailedFile