Skip to content
DPkit Logo DPkit Logo dpkit

Dialect

Defined in: core/dialect/Dialect.ts:8

Descriptor that describes the structure of tabular data, such as delimiters, headers, and other features. Following the Data Package standard: https://datapackage.org/standard/table-dialect/

Extends

Section titled “Extends”

Indexable

Section titled “Indexable”

[key: `${string}:${string}`]: any

Properties

Section titled “Properties”

$schema?

Section titled “$schema?”

optional $schema: string

Defined in: core/dialect/Dialect.ts:17

JSON schema profile URL for validation

commentChar?

Section titled “commentChar?”

optional commentChar: string

Defined in: core/dialect/Dialect.ts:42

Character sequence denoting the start of a comment line

commentRows?

Section titled “commentRows?”

optional commentRows: number[]

Defined in: core/dialect/Dialect.ts:37

Specific rows to be excluded from the data (zero-based)

delimiter?

Section titled “delimiter?”

optional delimiter: string

Defined in: core/dialect/Dialect.ts:47

The character used to separate fields in the data

doubleQuote?

Section titled “doubleQuote?”

optional doubleQuote: boolean

Defined in: core/dialect/Dialect.ts:62

Controls whether a sequence of two quote characters represents a single quote

escapeChar?

Section titled “escapeChar?”

optional escapeChar: string

Defined in: core/dialect/Dialect.ts:67

Character used to escape the delimiter or quote characters

Section titled “header?”

optional header: boolean

Defined in: core/dialect/Dialect.ts:22

Whether the file includes a header row with field names

headerJoin?

Section titled “headerJoin?”

optional headerJoin: string

Defined in: core/dialect/Dialect.ts:32

The character used to join multi-line headers

headerRows?

Section titled “headerRows?”

optional headerRows: number[]

Defined in: core/dialect/Dialect.ts:27

Row numbers (zero-based) that are considered header rows

itemKeys?

Section titled “itemKeys?”

optional itemKeys: string[]

Defined in: core/dialect/Dialect.ts:93

For object-based data items, specifies which object properties to extract as values

itemType?

Section titled “itemType?”

optional itemType: "object" | "array"

Defined in: core/dialect/Dialect.ts:88

The type of data item in the source: ‘array’ for rows represented as arrays, or ‘object’ for rows represented as objects

lineTerminator?

Section titled “lineTerminator?”

optional lineTerminator: string

Defined in: core/dialect/Dialect.ts:52

Character sequence used to terminate rows

name?

Section titled “name?”

optional name: string

Defined in: core/dialect/Dialect.ts:12

The name of this dialect

nullSequence?

Section titled “nullSequence?”

optional nullSequence: string

Defined in: core/dialect/Dialect.ts:72

Character sequence representing null or missing values in the data

property?

Section titled “property?”

optional property: string

Defined in: core/dialect/Dialect.ts:82

For JSON data, the property name containing the data array

quoteChar?

Section titled “quoteChar?”

optional quoteChar: string

Defined in: core/dialect/Dialect.ts:57

Character used to quote fields

sheetName?

Section titled “sheetName?”

optional sheetName: string

Defined in: core/dialect/Dialect.ts:103

For spreadsheet data, the sheet name to read

sheetNumber?

Section titled “sheetNumber?”

optional sheetNumber: number

Defined in: core/dialect/Dialect.ts:98

For spreadsheet data, the sheet number to read (zero-based)

skipInitialSpace?

Section titled “skipInitialSpace?”

optional skipInitialSpace: boolean

Defined in: core/dialect/Dialect.ts:77

Whether to ignore whitespace immediately following the delimiter

table?

Section titled “table?”

optional table: string

Defined in: core/dialect/Dialect.ts:108

For database sources, the table name to read