@inrupt/solid-client / resource/solidDataset

Module: resource/solidDataset

Functions

changeLogAsMarkdown

changeLogAsMarkdown(solidDataset: SolidDataset & WithChangeLog): string

Gets a human-readable representation of the local changes to a Resource to aid debugging.

Note that changes to the exact format of the return value are not considered a breaking change; it is intended to aid in debugging, not as a serialisation method that can be reliably parsed.

since 0.3.0

Parameters:

Name

Type

Description

solidDataset

SolidDataset & WithChangeLog

The Resource of which to get a human-readable representation of the changes applied to it locally.

Returns: string

Defined in: src/resource/solidDataset.ts:712


createContainerAt

createContainerAt(url: UrlString | Url, options?: Partial<typeof internal_defaultFetchOptions>): Promise<SolidDataset & WithServerResourceInfo>

Create an empty Container at the given URL.

Throws an error if creating the Container failed, e.g. because the current user does not have permissions to, or because the Container already exists.

Note that a Solid server will automatically create the necessary Containers when storing a Resource; i.e. there is no need to call this function if it is immediately followed by saveSolidDatasetAt or overwriteFile.

since 0.2.0

Parameters:

Name

Type

Default value

Description

url

UrlString | Url

-

URL of the empty Container that is to be created.

options

Partial<typeof internal_defaultFetchOptions>

Optional parameter options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API.

Returns: Promise<SolidDataset & WithServerResourceInfo>

Defined in: src/resource/solidDataset.ts:304


createContainerInContainer

createContainerInContainer(containerUrl: UrlString | Url, options?: SaveInContainerOptions): Promise<SolidDataset & WithResourceInfo>

Create an empty Container inside the Container at the given URL.

Throws an error if creating the Container failed, e.g. because the current user does not have permissions to.

The Container in which to create the new Container should itself already exist.

This function is primarily useful if the current user does not have access to change existing files in a Container, but is allowed to add new files; in other words, they have Append, but not Write access to a Container. This is useful in situations where someone wants to allow others to, for example, send notifications to their Pod, but not to view or delete existing notifications. You can pass a suggestion for the new Resource’s name, but the server may decide to give it another name — for example, if a Resource with that name already exists inside the given Container. If the user does have access to write directly to a given location, createContainerAt will do the job just fine, and does not require the parent Container to exist in advance.

since 0.2.0

Parameters:

Name

Type

Default value

Description

containerUrl

UrlString | Url

-

URL of the Container in which the empty Container is to be created.

options

SaveInContainerOptions

Optional parameter options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API.

Returns: Promise<SolidDataset & WithResourceInfo>

Defined in: src/resource/solidDataset.ts:563


createSolidDataset

createSolidDataset(): SolidDataset

Initialise a new SolidDataset in memory.

Returns: SolidDataset

An empty SolidDataset.

Defined in: src/resource/solidDataset.ts:70


deleteContainer

deleteContainer(container: Url | UrlString | WithResourceInfo, options?: Partial<typeof internal_defaultFetchOptions>): Promise<void>

Deletes the Container at a given URL.

since 0.6.0

Parameters:

Name

Type

Default value

container

Url | UrlString | WithResourceInfo

-

options

Partial<typeof internal_defaultFetchOptions>

Returns: Promise<void>

Defined in: src/resource/solidDataset.ts:620


deleteSolidDataset

deleteSolidDataset(solidDataset: Url | UrlString | WithResourceInfo, options?: Partial<typeof internal_defaultFetchOptions>): Promise<void>

Deletes the SolidDataset at a given URL.

since 0.6.0

Parameters:

Name

Type

Default value

solidDataset

Url | UrlString | WithResourceInfo

-

options

Partial<typeof internal_defaultFetchOptions>

Returns: Promise<void>

Defined in: src/resource/solidDataset.ts:267


getContainedResourceUrlAll

getContainedResourceUrlAll(solidDataset: SolidDataset & WithResourceInfo): UrlString[]

Given a SolidDataset representing a Container (see isContainer), fetch the URLs of all contained resources. If the solidDataset given is not a container, or is missing resourceInfo, throw an error.

since 1.3.0

Parameters:

Name

Type

Description

solidDataset

SolidDataset & WithResourceInfo

The container from which to fetch all contained Resource URLs.

Returns: UrlString[]

A list of URLs, each of which points to a contained Resource of the given SolidDataset.

Defined in: src/resource/solidDataset.ts:659


getSolidDataset

getSolidDataset(url: UrlString | Url, options?: Partial<typeof internal_defaultFetchOptions>): Promise<SolidDataset & WithServerResourceInfo>

Fetch a SolidDataset from the given URL. Currently requires the SolidDataset to be available as Turtle.

Parameters:

Name

Type

Default value

Description

url

UrlString | Url

-

URL to fetch a SolidDataset from.

options

Partial<typeof internal_defaultFetchOptions>

Optional parameter options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API.

Returns: Promise<SolidDataset & WithServerResourceInfo>

Promise resolving to a SolidDataset containing the data at the given Resource, or rejecting if fetching it failed.

Defined in: src/resource/solidDataset.ts:81


saveSolidDatasetAt

saveSolidDatasetAt<Dataset>(url: UrlString | Url, solidDataset: Dataset, options?: Partial<typeof internal_defaultFetchOptions>): Promise<Dataset & WithServerResourceInfo & WithChangeLog>

Given a SolidDataset, store it in a Solid Pod (overwriting the existing data at the given URL).

A SolidDataset keeps track of the data changes compared to the data in the Pod; i.e., the changelog tracks both the old value and new values of the property being modified. This function applies the changes to the current SolidDataset. If the old value specified in the changelog does not correspond to the value currently in the Pod, this function will throw an error. The SolidDataset returned by this function will contain the data sent to the Pod, and a ChangeLog up-to-date with the saved data. Note that if the data on the server was modified in between the first fetch and saving it, the updated data will not be reflected in the returned SolidDataset. To make sure you have the latest data, call getSolidDataset again after saving the data.

The Solid server will create any intermediary Containers that do not exist yet, so they do not need to be created in advance. For example, if the target URL is https://example.pod/container/resource and https://example.pod/container/ does not exist yet, it will exist after this function resolves successfully.

Type parameters:

Name

Type

Dataset

DatasetCore<Quad, Quad, Dataset>

Parameters:

Name

Type

Default value

Description

url

UrlString | Url

-

URL to save solidDataset to.

solidDataset

Dataset

-

The SolidDataset to save.

options

Partial<typeof internal_defaultFetchOptions>

Optional parameter options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API.

Returns: Promise<Dataset & WithServerResourceInfo & WithChangeLog>

A Promise resolving to a SolidDataset containing the stored data, or rejecting if saving it failed.

Defined in: src/resource/solidDataset.ts:207


saveSolidDatasetInContainer

saveSolidDatasetInContainer(containerUrl: UrlString | Url, solidDataset: SolidDataset, options?: SaveInContainerOptions): Promise<SolidDataset & WithResourceInfo>

Given a SolidDataset, store it in a Solid Pod in a new Resource inside a Container.

The Container at the given URL should already exist; if it does not, you can initialise it first using createContainerAt, or directly save the SolidDataset at the desired location using saveSolidDatasetAt.

This function is primarily useful if the current user does not have access to change existing files in a Container, but is allowed to add new files; in other words, they have Append, but not Write access to a Container. This is useful in situations where someone wants to allow others to, for example, send notifications to their Pod, but not to view or delete existing notifications. You can pass a suggestion for the new Resource’s name, but the server may decide to give it another name — for example, if a Resource with that name already exists inside the given Container. If the user does have access to write directly to a given location, saveSolidDatasetAt will do the job just fine, and does not require the parent Container to exist in advance.

Parameters:

Name

Type

Default value

Description

containerUrl

UrlString | Url

-

URL of the Container in which to create a new Resource.

solidDataset

SolidDataset

-

The SolidDataset to save to a new Resource in the given Container.

options

SaveInContainerOptions

Optional parameter options.fetch: An alternative fetch function to make the HTTP request, compatible with the browser-native fetch API.

Returns: Promise<SolidDataset & WithResourceInfo>

A Promise resolving to a SolidDataset containing the saved data. The Promise rejects if the save failed.

Defined in: src/resource/solidDataset.ts:475


solidDatasetAsMarkdown

solidDatasetAsMarkdown(solidDataset: SolidDataset): string

Gets a human-readable representation of the given SolidDataset to aid debugging.

Note that changes to the exact format of the return value are not considered a breaking change; it is intended to aid in debugging, not as a serialisation method that can be reliably parsed.

since 0.3.0

Parameters:

Name

Type

Description

solidDataset

SolidDataset

The SolidDataset to get a human-readable representation of.

Returns: string

Defined in: src/resource/solidDataset.ts:678