Class FastaWriter

FASTA writer for outputting sequences

Index

Constructors

Methods

formatSequence formatSequences writeToStream

Constructors

constructor

new FastaWriter(
    options?: {
        lineWidth?: number;
        includeDescription?: boolean;
        lineEnding?: string;
    },
): FastaWriter
Parameters
- options: { lineWidth?: number; includeDescription?: boolean; lineEnding?: string } = {}
Returns FastaWriter
- Defined in src/formats/fasta.ts:634

Methods

formatSequence

formatSequence(sequence: FastaSequence): string
Format a single FASTA sequence as string
Parameters
- sequence: FastaSequence
Returns string
- Defined in src/formats/fasta.ts:649

formatSequences

formatSequences(sequences: FastaSequence[]): string
Format multiple sequences as string
Parameters
- sequences: FastaSequence[]
Returns string
- Defined in src/formats/fasta.ts:665

writeToStream

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