Class TSVWriter

TSVWriter - Convenience class for TSV files Sets delimiter to tab by default

Hierarchy (View Summary)

DSVWriter
- TSVWriter

Index

Constructors

Methods

formatRow formatRecord formatRecords writeToStream writeFile

Constructors

constructor

new TSVWriter(options?: Omit<DSVWriterOptions, "delimiter">): TSVWriter
Parameters
- options: Omit<DSVWriterOptions, "delimiter"> = {}
Returns TSVWriter
Overrides DSVWriter.constructor
- Defined in src/formats/dsv/writer.ts:252

Methods

formatRow

formatRow(fields: (string | number | boolean | null | undefined)[]): string
Format a row of fields
Parameters
- fields: (string | number | boolean | null | undefined)[]
Returns string
Inherited from DSVWriter.formatRow
- Defined in src/formats/dsv/writer.ts:121

formatRecord

formatRecord(record: DSVRecord, options?: DSVWriterOptions): string
Format a DSVRecord into a row
Parameters
- record: DSVRecord
- options: DSVWriterOptions = {}
Returns string
Inherited from DSVWriter.formatRecord
- Defined in src/formats/dsv/writer.ts:128

formatRecords

formatRecords(records: DSVRecord[], options?: DSVWriterOptions): string
Format multiple records with optional header
Parameters
- records: DSVRecord[]
- options: DSVWriterOptions = {}
Returns string
Inherited from DSVWriter.formatRecords
- Defined in src/formats/dsv/writer.ts:158

writeToStream

writeToStream(
    records: AsyncIterable<DSVRecord>,
    stream: WritableStream<Uint8Array<ArrayBufferLike>>,
    options?: DSVWriterOptions,
): Promise<void>
Write records to stream
Parameters
- records: AsyncIterable<DSVRecord>
- stream: WritableStream<Uint8Array<ArrayBufferLike>>
- options: DSVWriterOptions = {}
Returns Promise<void>
Inherited from DSVWriter.writeToStream
- Defined in src/formats/dsv/writer.ts:177

writeFile

writeFile(path: string, records: DSVRecord[]): Promise<void>
Write records to a file with optional compression

Compression is auto-detected from file extension (.gz, .zst) * or can be specified via constructor options.
Parameters
- path: string
  File path to write to
- records: DSVRecord[]
  Records to write
Returns Promise<void>
Inherited from DSVWriter.writeFile
- Defined in src/formats/dsv/writer.ts:211