@std/csv@1.0.6
Built and signed on GitHub Actions
Built and signed on GitHub Actions

latest

denoland/std

Works with

•JSR Score100%•

Downloads24,449/wk

•

Published10 months ago (1.0.6)

Reading and writing of comma-separated values (CSV) files

@std/csv

default

Classes

CsvParseStream<T extends CsvParseStreamOptions | undefined = undefined>(options?: T)

CsvParseStream transforms a stream of CSV-encoded text into a stream of parsed objects.

readable(): ReadableStream<RowType<T>>
The instance's ReadableStream.
writable(): WritableStream<string>
The instance's WritableStream.

CsvStringifyStream<TOptions extends CsvStringifyStreamOptions>(options?: TOptions)

Convert each chunk to a CSV record.

Functions

parse<T extends ParseOptions>(

input: string,

options?: T

): ParseResult<ParseOptions, T>

3 overloads

Parses CSV string into an array of arrays of strings.

stringify(

data: readonly DataItem[],

options?: StringifyOptions

): string

Converts an array of objects into a CSV string.

Interfaces

CsvParseStreamOptions

Options for CsvParseStream.

columns: readonly string[]
List of names used for header definition.
comment: string
Character to start a comment.
fieldsPerRecord: number
Enabling checking number of expected fields for each row.
lazyQuotes: boolean
Allow unquoted quote in a quoted field or non-double-quoted quotes in quoted field.
separator: string
Character which separates values.
skipFirstRow: boolean
If you provide skipFirstRow: true and columns, the first line will be skipped. If you provide skipFirstRow: true but not columns, the first line will be skipped and used as header definitions.
trimLeadingSpace: boolean
Flag to trim the leading space of the value.

CsvStringifyStreamOptions

Options for CsvStringifyStream.

columns: Array<string>
A list of columns to be included in the output.
separator: string
Delimiter used to separate values.

ParseOptions

Options for parse.

columns: readonly string[]
List of names used for header definition.
comment: string
Character to start a comment.
fieldsPerRecord: number
Enabling checking number of expected fields for each row.
lazyQuotes: boolean
Allow unquoted quote in a quoted field or non-double-quoted quotes in quoted field.
separator: string
Character which separates values.
skipFirstRow: boolean
If you provide skipFirstRow: true and columns, the first line will be skipped. If you provide skipFirstRow: true but not columns, the first line will be skipped and used as header definitions.
trimLeadingSpace: boolean
Flag to trim the leading space of the value.

Type Aliases

Column = ColumnDetails | PropertyAccessor | PropertyAccessor[]

The most essential aspect of a column is accessing the property holding the data for that column on each object in the data array. If that member is at the top level, Column can simply be a property accessor, which is either a string (if it's a plain object) or a number (if it's an array).

ColumnDetails = { header?: string; prop: PropertyAccessor | PropertyAccessor[]; }

Column information.

header: string
No documentation available
prop: PropertyAccessor | PropertyAccessor[]
No documentation available

DataItem = Readonly<Record<string, unknown> | unknown[]>

An object (plain or array)

ParseResult<ParseOptions, T> = T extends

ParseOptions
& { columns: readonly (infer C extends string)[]; }

? RecordWithColumn<C>[] : T extends ParseOptions & { skipFirstRow: true; } ? Record<string, string>[] : T extends

ParseOptions
& { columns?: undefined; skipFirstRow?: false | undefined; }

? string[][] : Record<string, string>[] | string[][]

Parse result type for parse and CsvParseStream.

PropertyAccessor = number | string

Array index or record key corresponding to a value for a data object.

RecordWithColumn<C extends string> = string extends C ? Record<string, string> : Record<C, string>

Record type with column type.

RowType<T> = T extends undefined ? string[] : ParseResult<CsvParseStreamOptions, T>[number]

Row return type.

StringifyOptions = { headers?: boolean; separator?: string; columns?: readonly Column[]; bom?: boolean; }

Options for stringify.

bom: boolean
Whether to add a byte-order mark to the beginning of the file content. Required by software such as MS Excel to properly display Unicode text.
columns: readonly Column[]
A list of instructions for how to target and transform the data for each column of output. This is also where you can provide an explicit header name for the column.
headers: boolean
Whether to include the row of headers or not.
separator: string
Delimiter used to separate values. Examples: