Resource

Defined in: resource/Resource.ts:12

Data Resource interface built on top of the Data Package standard and Polars DataFrames

See

https://datapackage.org/standard/data-resource/

Extends

• Metadata

Indexable

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

Properties

$schema?

optional $schema: string

Defined in: resource/Resource.ts:16

JSON schema profile URL for validation

---

bytes?

optional bytes: number

Defined in: resource/Resource.ts:73

Size of the file in bytes

---

data?

optional data: unknown

Defined in: resource/Resource.ts:34

Inline data content instead of referencing an external file Either path or data must be provided

---

description?

optional description: string

Defined in: resource/Resource.ts:68

A description of the resource

---

dialect?

optional dialect: string | Dialect

Defined in: resource/Resource.ts:95

Table dialect specification Describes delimiters, quote characters, etc.

See

https://datapackage.org/standard/table-dialect/

---

encoding?

optional encoding: string

Defined in: resource/Resource.ts:58

Character encoding of the resource

Default

"utf-8"

---

format?

optional format: string

Defined in: resource/Resource.ts:46

The file format

Example

"csv", "json", "xlsx"

---

hash?

optional hash: string

Defined in: resource/Resource.ts:78

Hash of the resource data

---

jsonSchema?

optional jsonSchema: string | Descriptor

Defined in: resource/Resource.ts:109

Schema for the json data Describes fields in the json, constraints, etc.

See

https://json-schema.org/

---

licenses?

optional licenses: License[]

Defined in: resource/Resource.ts:88

License information

---

mediatype?

optional mediatype: string

Defined in: resource/Resource.ts:52

The media type of the resource

Example

"text/csv", "application/json"

---

name

name: string

Defined in: resource/Resource.ts:22

Unique resource identifier Should use lowercase alphanumeric characters, periods, hyphens, and underscores

---

path?

optional path: string | string[]

Defined in: resource/Resource.ts:28

A reference to the data itself, can be a path URL or array of paths Either path or data must be provided

---

schema?

optional schema: string | Schema

Defined in: resource/Resource.ts:102

Schema for the tabular data Describes fields in the table, constraints, etc.

See

https://datapackage.org/standard/table-schema/

---

sources?

optional sources: Source[]

Defined in: resource/Resource.ts:83

Data sources

---

title?

optional title: string

Defined in: resource/Resource.ts:63

Human-readable title

---

type?

optional type: "table"

Defined in: resource/Resource.ts:40

The resource type

Example

"table"