Module: interfaces#

Classes#

SolidClientError

Type Aliases#

AccessModes#

Ƭ AccessModes: Object

Note

The ACP specification is a draft. As such, this function is experimental and subject to change, even in a non-major release. See also: https://solid.github.io/authorization-panel/acp-specification/

Type declaration#

Name	Type
`append`	`boolean`
`controlRead`	`boolean`
`controlWrite`	`boolean`
`read`	`boolean`
`write`	`boolean`

Defined in#

src/interfaces.ts:269

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?`	{ `append`: `boolean` ; `read`: `boolean` ; `write`: `boolean` }
`public.append`	`boolean`
`public.read`	`boolean`
`public.write`	`boolean`
`user`	{ `append`: `boolean` ; `read`: `boolean` ; `write`: `boolean` }
`user.append`	`boolean`
`user.read`	`boolean`
`user.write`	`boolean`

Defined in#

src/interfaces.ts:125

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.

Defined in#

src/interfaces.ts:51

Jwk#

Ƭ Jwk: Record<string, string>

A JSON data structure that represents a set of public keys as a JSON object. See https://datatracker.ietf.org/doc/html/rfc7517 for details.

Defined in#

src/interfaces.ts:57

Jwks#

Ƭ Jwks: Object

A JSON data structure holding a list of JWK.

Type declaration#

Name	Type
`keys`	`Jwk`[]

Defined in#

src/interfaces.ts:62

LinkedResourceUrlAll#

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

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

Since

1.7.0

Defined in#

src/interfaces.ts:143

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]].

Defined in#

src/interfaces.ts:69

SolidDataset#

Ƭ SolidDataset: ImmutableDataset

A SolidDataset represents all Quads from a single Resource.

Defined in#

src/interfaces.ts:46

Thing#

Ƭ Thing: Subject

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

Defined in#

src/interfaces.ts:75

ThingLocal#

Ƭ ThingLocal: Thing & { url: LocalNodeIri }

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

Defined in#

src/interfaces.ts:84

ThingPersisted#

Ƭ ThingPersisted: Thing & { url: UrlString }

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

Defined in#

src/interfaces.ts:80

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.

Defined in#

src/interfaces.ts:253

Url#

Ƭ Url: NamedNode

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

Defined in#

src/interfaces.ts:29

UrlString#

Ƭ UrlString: string

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

Defined in#

src/interfaces.ts:35

WebId#

Ƭ WebId: UrlString

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

Defined in#

src/interfaces.ts:41

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]].

Defined in#

src/interfaces.ts:102

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]].

Defined in#

src/interfaces.ts:151

Functions#

hasResourceInfo#

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

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

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.

Since

0.2.0

Defined in#

src/interfaces.ts:207

hasServerResourceInfo#

▸ hasServerResourceInfo<T>(resource): resource is T & WithResourceInfo & Object

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

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.

Since

0.6.0

Defined in#

src/interfaces.ts:224