Class FastqWriter

FASTQ writer for outputting sequences

Index

Constructors

Methods

formatSequence formatSequences writeToStream

Constructors

constructor

new FastqWriter(
    options?: {
        qualityEncoding?: QualityEncoding;
        includeDescription?: boolean;
    },
): FastqWriter
Parameters
- options: { qualityEncoding?: QualityEncoding; includeDescription?: boolean } = {}
Returns FastqWriter
- Defined in src/formats/fastq.ts:676

Methods

formatSequence

formatSequence(sequence: FastqSequence): string
Format a single FASTQ sequence as string
Parameters
- sequence: FastqSequence
Returns string
- Defined in src/formats/fastq.ts:689

formatSequences

formatSequences(sequences: FastqSequence[]): string
Format multiple sequences as string
Parameters
- sequences: FastqSequence[]
Returns string
- Defined in src/formats/fastq.ts:714

writeToStream

writeToStream(
sequences: AsyncIterable<FastqSequence>,
stream: WritableStream<Uint8Array<ArrayBufferLike>>,
): Promise<void>
Write sequences to a WritableStream
Parameters
- sequences: AsyncIterable<FastqSequence>
- stream: WritableStream<Uint8Array<ArrayBufferLike>>
Returns Promise<void>
- Defined in src/formats/fastq.ts:721