ResolvedDataset

A dataset as the host resolved it: its rows filled in and, for a URL, when they were fetched.

@internote/canvas-sdkInterface
On this page
import { ResolvedDataset } from '@internote/canvas-sdk';

#Fields

columns
Column names, in header order. Present on inline datasets.
string[]
fetchedAt
When a URL dataset's response was fetched, as an ISO timestamp.
string
format
How the attachment is read. A file entry carries it only when it is geojson, its extension settling the rest; a URL entry always carries it, CSV included, which is how a URL entry is told from a file entry. geojson marks an OPAQUE dataset: boundary geometry, which has no columns at all — #islands.name is a compile error, and the whole dataset is bound instead (in: #islands). Turning a feature collection into anything table-shaped is the renderer's contract, never the compiler's.
csvjsongeojson
key
The label of a secret the host sends with the request. Opaque to the compiler: the host resolves it.
string
next
A URL's dotted path to the field leading to the next page. Opaque to the compiler: the host follows it.
string
path
A JSON URL's dotted path to its rows, stepping into every array on the way (D74).
string
pending
Whether a URL dataset's response is on its way and has not arrived.
boolean
rows
Rows of string cells, parallel to columns. Present on inline datasets.
string[][]
src
Attached datasets: the attachment's file name, or an https:// URL verbatim (D74). Rows are not inlined (§2.3); a URL's response reaches the host's files map keyed by this exact string.
string

Declared in packages/canvas-sdk/src/data/fetched.ts:22.

Last updated