basalt / exports/src / DelimitedFormatter
Class: DelimitedFormatter
Defined in: exports/src/formatters.ts:40
CSV/TSV via a configurable delimiter, with RFC-4180 quoting.
Implements
Constructors
Constructor
> new DelimitedFormatter(format, delimiter, contentType, extension): DelimitedFormatter
Defined in: exports/src/formatters.ts:42
Parameters
format
string
delimiter
string
contentType
string
extension
string
Returns
DelimitedFormatter
Properties
contentType
> readonly contentType: string
Defined in: exports/src/formatters.ts:45
Implementation of
extension
> readonly extension: string
Defined in: exports/src/formatters.ts:46
Implementation of
format
> readonly format: string
Defined in: exports/src/formatters.ts:43
Implementation of
Methods
render()
> render(headers, rows): Buffer
Defined in: exports/src/formatters.ts:61
Parameters
headers
string[]
rows
unknown[][]
Returns
Buffer
Implementation of
renderStream()
> renderStream(headers, rows): AsyncIterable<string>
Defined in: exports/src/formatters.ts:65
Optional incremental rendering, used by Exports.stream(). Pulls rows one at a time and yields pieces of the file as it goes, so memory stays bounded by one chunk instead of the whole dataset. The concatenated output must be byte-identical to render(). Formats whose container needs the whole data up front (XLSX's ZIP, PDF) leave this out and are buffer-only.
Parameters
headers
string[]
rows
AsyncIterable<unknown[]>
Returns
AsyncIterable<string>