Interface Dialect

Options for tabular data output. Default output is annotated CSV with headers.

For more information about tabular data dialect, see W3 metadata vocabulary for tabular data.

interface Dialect {
    annotations?: ("default" | "group" | "datatype")[];
    commentPrefix?: string;
    dateTimeFormat?: "RFC3339" | "RFC3339Nano";
    delimiter?: string;
    header?: boolean;
}

Properties

annotations? commentPrefix? dateTimeFormat? delimiter? header?

Properties

Optionalannotations

annotations?: ("default" | "group" | "datatype")[]

Annotation rows to include in the results. An annotation is metadata associated with an object (column) in the data model.

Related guides

For more information about annotations in tabular data, see W3 metadata vocabulary for tabular data.

OptionalcommentPrefix

commentPrefix?: string

The character prefixed to comment strings. Default is a number sign (#).

OptionaldateTimeFormat

dateTimeFormat?: "RFC3339" | "RFC3339Nano"

The format for timestamps in results. Default is RFC3339 date/time format. To include nanoseconds in timestamps, use RFC3339Nano.

Example formatted date/time values

Format Value
RFC3339 "2006-01-02T15:04:05Z07:00"
RFC3339Nano "2006-01-02T15:04:05.999999999Z07:00"

Optionaldelimiter

delimiter?: string

The separator used between cells. Default is a comma (,).

Optionalheader

header?: boolean

If true, the results contain a header row.

Settings

Member Visibility

On This Page

Properties