Resource
Defined in: core/resource/Resource.ts:11
Data Resource interface built on top of the Data Package standard and Polars DataFrames
https://datapackage.org/standard/data-resource/
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `${string}:${string}`]: any
Properties
Section titled “Properties”bytes?
Section titled “bytes?”
optionalbytes:number
Defined in: core/resource/Resource.ts:67
Size of the file in bytes
optionaldata:unknown
Defined in: core/resource/Resource.ts:28
Inline data content instead of referencing an external file Either path or data must be provided
description?
Section titled “description?”
optionaldescription:string
Defined in: core/resource/Resource.ts:62
A description of the resource
dialect?
Section titled “dialect?”
optionaldialect:string|Dialect
Defined in: core/resource/Resource.ts:89
Table dialect specification Describes delimiters, quote characters, etc.
https://datapackage.org/standard/table-dialect/
encoding?
Section titled “encoding?”
optionalencoding:string
Defined in: core/resource/Resource.ts:52
Character encoding of the resource
Default
Section titled “Default”"utf-8"format?
Section titled “format?”
optionalformat:string
Defined in: core/resource/Resource.ts:40
The file format
Example
Section titled “Example”"csv", "json", "xlsx"
optionalhash:string
Defined in: core/resource/Resource.ts:72
Hash of the resource data
licenses?
Section titled “licenses?”
optionallicenses:License[]
Defined in: core/resource/Resource.ts:82
License information
mediatype?
Section titled “mediatype?”
optionalmediatype:string
Defined in: core/resource/Resource.ts:46
The media type of the resource
Example
Section titled “Example”"text/csv", "application/json"name:
string
Defined in: core/resource/Resource.ts:16
Unique resource identifier Should use lowercase alphanumeric characters, periods, hyphens, and underscores
optionalpath:string|string[]
Defined in: core/resource/Resource.ts:22
A reference to the data itself, can be a path URL or array of paths Either path or data must be provided
schema?
Section titled “schema?”
optionalschema:string|Schema
Defined in: core/resource/Resource.ts:96
Schema for the tabular data Describes fields in the table, constraints, etc.
https://datapackage.org/standard/table-schema/
sources?
Section titled “sources?”
optionalsources:Source[]
Defined in: core/resource/Resource.ts:77
Data sources
title?
Section titled “title?”
optionaltitle:string
Defined in: core/resource/Resource.ts:57
Human-readable title
optionaltype:"table"
Defined in: core/resource/Resource.ts:34
The resource type
Example
Section titled “Example”"table"