@inrupt/solid-client

Globals / “interfaces”

Module: “interfaces”

Type aliases

Access

Ƭ Access: { append: boolean ; control: boolean ; read: boolean ; write: boolean }

Defined in src/interfaces.ts:100

An object with the boolean properties read, append, write and control, representing the respective Access Modes defined by the Web Access Control specification.

Since that specification is not finalised yet, this interface is still experimental.

Type declaration:

Name

Type

append

boolean

control

boolean

read

boolean

write

boolean


AclDataset

Ƭ AclDataset: SolidDataset & WithResourceInfo & { internal_accessTo: UrlString }

Defined in src/interfaces.ts:86

A SolidDataset containing Access Control rules for another SolidDataset.

Please note that the Web Access Control specification is not yet finalised, and hence, this function is still experimental and can change in a non-major release.


File

Ƭ File: Blob

Defined in src/interfaces.ts:49

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.


Resource

Ƭ Resource: SolidDataset | File

Defined in src/interfaces.ts:54

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


SolidDataset

Ƭ SolidDataset: DatasetCore

Defined in src/interfaces.ts:44

A SolidDataset represents all Quads from a single Resource.


Thing

Ƭ Thing: DatasetCore & { internal_url: UrlString } | { internal_localSubject: LocalNode }

Defined in src/interfaces.ts:60

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


ThingLocal

Ƭ ThingLocal: Thing & { internal_localSubject: LocalNode }

Defined in src/interfaces.ts:69

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


ThingPersisted

Ƭ ThingPersisted: Thing & { internal_url: UrlString }

Defined in src/interfaces.ts:65

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


UploadRequestInit

Ƭ UploadRequestInit: Omit<RequestInit, “method”>

Defined in src/interfaces.ts:310

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

Defined in src/interfaces.ts:27

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


UrlString

Ƭ UrlString: string

Defined in src/interfaces.ts:33

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


WebId

Ƭ WebId: UrlString

Defined in src/interfaces.ts:39

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


WithAccessibleAcl

Ƭ WithAccessibleAcl<ResourceExt>: ResourceExt & { internal_resourceInfo: { aclUrl: Exclude<WithServerResourceInfo[“internal_resourceInfo”][“aclUrl”], undefined> } }

Defined in src/interfaces.ts:276

If this type applies to a Resource, its Access Control List, if it exists, is accessible to the currently authenticated user.

Please note that the Web Access Control specification is not yet finalised, and hence, this function is still experimental and can change in a non-major release.

Type parameters:

Name

Type

Default

ResourceExt

WithServerResourceInfo

WithServerResourceInfo


WithFallbackAcl

Ƭ WithFallbackAcl<ResourceExt>: ResourceExt & { internal_acl: { fallbackAcl: Exclude<WithAcl[“internal_acl”][“fallbackAcl”], null> } }

Defined in src/interfaces.ts:214

If this type applies to a Resource, the Access Control List that applies to its nearest Container with an ACL is accessible to the currently authenticated user.

Please note that the Web Access Control specification is not yet finalised, and hence, this function is still experimental and can change in a non-major release.

Type parameters:

Name

Type

Default

ResourceExt

WithAcl

WithAcl


WithResourceAcl

Ƭ WithResourceAcl<ResourceExt>: ResourceExt & { internal_acl: { resourceAcl: Exclude<WithAcl[“internal_acl”][“resourceAcl”], null> } }

Defined in src/interfaces.ts:200

If this type applies to a Resource, an Access Control List that applies to it exists and is accessible to the currently authenticated user.

Please note that the Web Access Control specification is not yet finalised, and hence, this function is still experimental and can change in a non-major release.

Type parameters:

Name

Type

Default

ResourceExt

WithAcl

WithAcl


WithResourceInfo

Ƭ WithResourceInfo: { }

Defined in src/interfaces.ts:120

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 & { }

Defined in src/interfaces.ts:135

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

hasAccessibleAcl

hasAccessibleAcl<ResourceExt>(dataset: ResourceExt): dataset is WithAccessibleAcl<ResourceExt>

Defined in src/interfaces.ts:299

Given a SolidDataset, verify whether its Access Control List is accessible to the current user.

This should generally only be true for SolidDatasets fetched by getSolidDatasetWithAcl.

Please note that the Web Access Control specification is not yet finalised, and hence, this function is still experimental and can change in a non-major release.

Type parameters:

Name

Type

ResourceExt

WithServerResourceInfo

Parameters:

Name

Type

Description

dataset

ResourceExt

A SolidDataset.

Returns: dataset is WithAccessibleAcl<ResourceExt>

Whether the given dataset has a an ACL that is accessible to the current user.


hasResourceInfo

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

Defined in src/interfaces.ts:229

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: T): resource is T & WithServerResourceInfo

Defined in src/interfaces.ts:246

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 & WithServerResourceInfo

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