@inrupt/solid-client / interfaces
Module: interfaces¶
Type aliases¶
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:50
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:55
SolidDataset¶
Ƭ SolidDataset: DatasetCore
A SolidDataset represents all Quads from a single Resource.
Defined in: src/interfaces.ts:45
Thing¶
Ƭ Thing: DatasetCore & { internal_url: UrlString } | { internal_localSubject: LocalNode }
A Thing represents all Quads with a given Subject URL and a given Named Graph, from a single Resource.
Defined in: src/interfaces.ts:61
ThingLocal¶
Ƭ ThingLocal: Thing & { internal_localSubject: LocalNode }
A Thing whose full Subject URL will be determined when it is persisted.
Defined in: src/interfaces.ts:70
ThingPersisted¶
Ƭ ThingPersisted: Thing & { internal_url: UrlString }
A Thing for which we know what the full Subject URL is.
Defined in: src/interfaces.ts:66
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:201
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:28
UrlString¶
Ƭ UrlString: string
Alias to indicate where we expect to be given a URL.
Defined in: src/interfaces.ts:34
WebId¶
Ƭ WebId: UrlString
Alias to indicate where we expect to be given a WebId.
Defined in: src/interfaces.ts:40
WithResourceInfo¶
Ƭ WithResourceInfo: { }
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:87
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:107
Functions¶
hasResourceInfo¶
▸ hasResourceInfo<T>(resource: T): resource is T & WithResourceInfo
Verify whether a given SolidDataset includes metadata about where it was sent to.
since 0.2.0
Type parameters:¶
Name |
|---|
|
Parameters:¶
Name |
Type |
|---|---|
|
T |
Returns: resource is T & WithResourceInfo
True if dataset includes metadata about the Resource it was sent to, false if not.
Defined in: src/interfaces.ts:155
hasServerResourceInfo¶
▸ hasServerResourceInfo<T>(resource: T): 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 |
|---|
|
Parameters:¶
Name |
Type |
|---|---|
|
T |
Returns: resource is T & WithResourceInfo & object
True if dataset includes metadata about the Resource it was retrieved from, false if not.
Defined in: src/interfaces.ts:172