@inrupt/solid-client / interfaces

Module: interfaces

Type aliases

EffectiveAccess

Ƭ EffectiveAccess: Object

What access the current user has to a particular Resource, and what access everybody has.

Note that access for everybody is at the time of writing not returned by servers implementing Access Control Policies, so the public property is only available on servers that implement Web Access Control.

since 1.7.0

Type declaration

Name

Type

public?

Object

public.append

boolean

public.read

boolean

public.write

boolean

user

Object

user.append

boolean

user.read

boolean

user.write

boolean


File

Ƭ File: Blob

A File is anything stored on a Pod in a format that solid-client does not have special affordances for, e.g. an image, or a plain JSON file.


LinkedResourceUrlAll

Ƭ LinkedResourceUrlAll: Record<UrlString | string, UrlString[]>

URLs of Resources linked to a given Resource, indexed by relation.

since 1.7.0


Resource

Ƭ Resource: SolidDataset | File

A Resource is something that can be fetched from a Pod - either structured data in a SolidDataset, or any other File.


SolidDataset

Ƭ SolidDataset: ImmutableDataset

A SolidDataset represents all Quads from a single Resource.


Thing

Ƭ Thing: Subject

A Thing represents all Quads with a given Subject URL and a given Named Graph, from a single Resource.


ThingLocal

Ƭ ThingLocal: Thing & { url: LocalNodeIri }

A Thing whose full Subject URL will be determined when it is persisted.


ThingPersisted

Ƭ ThingPersisted: Thing & { url: UrlString }

A Thing for which we know what the full Subject URL is.


UploadRequestInit

Ƭ UploadRequestInit: Omit<RequestInit, "method">

A RequestInit restriction where the method is set by the library

Please note that this function is still experimental and can change in a non-major release.


Url

Ƭ Url: NamedNode

Alias to indicate where we expect to be given a URL represented as an RDF/JS NamedNode.


UrlString

Ƭ UrlString: string

Alias to indicate where we expect to be given a URL.


WebId

Ƭ WebId: UrlString

Alias to indicate where we expect to be given a WebId.


WithResourceInfo

Ƭ WithResourceInfo: Object

Data that was sent to a Pod includes this metadata describing its relation to the Pod Resource it was sent to.

Do not read these properties directly; their internal representation may change at any time. Instead, use functions such as getSourceUrl, isRawData and getContentType.


WithServerResourceInfo

Ƭ WithServerResourceInfo: WithResourceInfo & { }

Data that was fetched from a Pod includes this metadata describing its relation to the Pod Resource it was fetched from.

Do not read these properties directly; their internal representation may change at any time. Instead, use functions such as getSourceUrl, isRawData and getContentType.

Functions

hasResourceInfo

hasResourceInfo<T>(resource): resource is T & WithResourceInfo

Verify whether a given SolidDataset includes metadata about where it was sent to.

since 0.2.0

Type parameters

Name

T

Parameters

Name

Type

resource

T

Returns

resource is T & WithResourceInfo

True if dataset includes metadata about the Resource it was sent to, false if not.


hasServerResourceInfo

hasServerResourceInfo<T>(resource): resource is T & WithResourceInfo & object

Verify whether a given SolidDataset includes metadata about where it was retrieved from.

since 0.6.0

Type parameters

Name

T

Parameters

Name

Type

resource

T

Returns

resource is T & WithResourceInfo & object

True if dataset includes metadata about the Resource it was retrieved from, false if not.