Types - Table#

API reference for ./evaluate/table on @huukhanhnguyen/types.

See the Guide for the package's role.

API reference#

Signatures are generated from the live package .d.ts - not hand-written.

ColumnMeta#

type

Evaluated table — what evaluateTableChain produces. The authoring tables[] lane (TableChain) stays in the model document schema.

type ColumnMeta
// = {
    key: string;
    label?: string;
    type?: string;
    format?: string;
    /** True when header `value` expression is set (computed column). */
    computed?: boolean;
}

TableValue#

type

type TableValue
// = {
    columns: ColumnMeta[];
    rows: Record<string, unknown>[];
}

Worksheet#

type

One named worksheet of string cells — the interchange shape the xlsx/csv writers take, in the writer's own vocabulary (OOXML stores these under xl/worksheets/, and the Rust writer's own emitter is worksheet_xml, crates/io/src/table.rs). Distinct from TableValue (typed columns + object rows). Not a file-format option record.

Named Worksheet, not TableSheet: a drawing SHEET is a different concept living in evaluate/sheets.ts, and one word for two unrelated things is the mirror image of two names for one thing.

type Worksheet
// = {
    name: string;
    columns: string[];
    rows: string[][];
}