Interface Resource

Processed resource type

Hierarchy

  • Resource

Properties

access additionalData cache created? dataset description? format? hash? id languages metadata mimeType modified? name size? state? url

Properties

access

access: {
    active?: boolean;
    urlType?: string;
}

Information about the resource's accessibility

Type declaration

  • Optional active?: boolean
  • Optional urlType?: string

additionalData

additionalData: StringIndexedObject

Non-standard additional data provided by the API.

cache

cache: {
    updated?: Date;
    url?: string;
}

Information about the document's cached version

Type declaration

  • Optional updated?: Date
  • Optional url?: string

Optional created

created?: Date

When the resource was created

dataset

dataset: {
    id?: string;
    position?: number;
}

The dataset the resource belongs to

Type declaration

  • Optional id?: string

    The dataset's ID

  • Optional position?: number

    The resource's position within the dataset

Optional description

description?: string

The resource's long-form description

Optional format

format?: string

The resource's file format

Optional hash

hash?: string

The resource's hash

id

id: string

The resource's ID

languages

languages: string[]

Which languages the resource was published in

metadata

metadata: Metadata

Meta-metadata

mimeType

mimeType: {
    inner?: string;
    resource?: string;
}

Information about the document's MIME type

Type declaration

  • Optional inner?: string

    The MIME type of resources contained within archives

  • Optional resource?: string

    The resource's direct MIME type

Optional modified

modified?: Date

When the resource was last modified

name

name: string

The resource's short name, may not be human-readable

Optional size

size?: number

The resource's size

Optional state

state?: string

The resource's state

url

url: string

The resource's url

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc