Module: resource#

createContainerInContainer#

▸ createContainerInContainer(containerUrl, accessGrant, options?): Promise<Readonly<{}> & 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. In particular, the Access Grant being used should at least append access to the target Container.

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.

deleteFile#

▸ deleteFile(fileUrl, accessGrant, options?): Promise<void>

Delete a File from a Solid Pod using an Access Grant to prove the caller is authorized to overwrite the target file.

deleteSolidDataset#

▸ deleteSolidDataset(datasetUrl, accessGrant, options?): Promise<void>

Delete a Dataset from a Solid Pod using an Access Grant to prove the caller is authorized to overwrite the target dataset.

getFile#

▸ getFile(resourceUrl, accessGrant, options?): Promise<Blob & WithResourceInfo & {}>

Retrieve a File from a Solid Pod using an Access Grant to prove the caller is authorized to access the target resource.

getSolidDataset#

▸ getSolidDataset(datasetUrl, accessGrant, options?): Promise<Readonly<{}> & WithResourceInfo & {}>

Retrieve a Dataset from a Solid Pod using an Access Grant to prove the caller is authorized to access the target dataset.

overwriteFile#

▸ overwriteFile<T>(resourceUrl, file, accessGrant, options?): Promise<T & WithResourceInfo>

Overwrites the file using an Access Grant to prove the caller is authorized to write to the given resource URL.

saveFileInContainer#

▸ saveFileInContainer<T>(containerUrl, file, accessGrant, options?): Promise<T & WithResourceInfo>

Saves a file in the given container URL using an Access Grant to prove the caller is authorized to save a file in the given container.

saveSolidDatasetAt#

▸ saveSolidDatasetAt<Dataset>(datasetUrl, solidDataset, accessGrant, options?): Promise<Dataset & WithResourceInfo & {} & Readonly<{}> & {}>

Saves a Dataset in a Solid Pod using an Access Grant to prove the caller is authorized to write or append to the dataset at the given dataset URL.

saveSolidDatasetInContainer#

▸ saveSolidDatasetInContainer(containerUrl, solidDataset, accessGrant, options): Promise<Readonly<{}> & WithResourceInfo>

Given a SolidDataset, store it in a Solid Pod as 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 resource.saveSolidDatasetAt.

This function is primarily useful if the current user has not been granted access to change existing files in a Container, but is allowed to add new files; in other words, they have been granted 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, resource.saveSolidDatasetAt will do the job just fine, and does not require the parent Container to exist in advance.