@inrupt/solid-client / thing/thing

Module: thing/thing¶

Table of contents¶

Classes¶

Type aliases¶

Functions¶

Type aliases¶

CreateThingLocalOptions¶

Ƭ CreateThingLocalOptions: object

Pass these options to createThing to initialise a new Thing whose URL will be determined when it is saved.

Type declaration:¶

Name	Type	Description
`name`?	string	The name that should be used for this Thing when constructing its URL. If not provided, a random one will be generated.

Defined in: src/thing/thing.ts:272

CreateThingOptions¶

Ƭ CreateThingOptions: CreateThingLocalOptions | CreateThingPersistedOptions

The options you pass to createThing.

To specify the URL for the initialised Thing, pass CreateThingPersistedOptions.
To have the URL determined during the save, pass CreateThingLocalOptions.

Defined in: src/thing/thing.ts:291

CreateThingPersistedOptions¶

Ƭ CreateThingPersistedOptions: object

Pass these options to createThing to initialise a new Thing whose URL is already known.

Type declaration:¶

Name	Type	Description
`url`	UrlString	The URL of the newly created Thing.

Defined in: src/thing/thing.ts:281

Functions¶

asUrl¶

▸ asUrl(thing: ThingLocal, baseUrl: UrlString): UrlString

Get the URL to a given Thing.

Parameters:¶

Name	Type	Description
`thing`	ThingLocal	The Thing you want to obtain the URL from.
`baseUrl`	UrlString	If `thing` is not persisted yet, the base URL that should be used to construct this Thing’s URL.

Returns: UrlString

Defined in: src/thing/thing.ts:347

▸ asUrl(thing: ThingPersisted): UrlString

Parameters:¶

Name	Type
`thing`	ThingPersisted

Returns: UrlString

Defined in: src/thing/thing.ts:348

▸ asUrl(thing: Thing, baseUrl: UrlString): UrlString

Parameters:¶

Name	Type
`thing`	Thing
`baseUrl`	UrlString

Returns: UrlString

Defined in: src/thing/thing.ts:349

createThing¶

▸ createThing(options: CreateThingPersistedOptions): ThingPersisted

Initialise a new Thing in memory with a given URL.

Parameters:¶

Name	Type	Description
`options`	CreateThingPersistedOptions	See CreateThingPersistedOptions for how to specify the new Thing’s URL.

Returns: ThingPersisted

Defined in: src/thing/thing.ts:299

▸ createThing(options?: CreateThingLocalOptions): ThingLocal

Initialise a new Thing in memory.

Parameters:¶

Name	Type	Description
`options?`	CreateThingLocalOptions	Optional parameters that affect the final URL of this Thing when saved.

Returns: ThingLocal

Defined in: src/thing/thing.ts:307

▸ createThing(options?: CreateThingOptions): Thing

Parameters:¶

Name	Type
`options?`	CreateThingOptions

Returns: Thing

Defined in: src/thing/thing.ts:308

getThing¶

▸ getThing(solidDataset: SolidDataset, thingUrl: UrlString | Url, options?: GetThingOptions): ThingPersisted | null

Parameters:¶

Name	Type
`solidDataset`	SolidDataset
`thingUrl`	UrlString \| Url
`options?`	GetThingOptions

Returns: ThingPersisted | null

Defined in: src/thing/thing.ts:68

▸ getThing(solidDataset: SolidDataset, thingUrl: LocalNode, options?: GetThingOptions): ThingLocal | null

Parameters:¶

Name	Type
`solidDataset`	SolidDataset
`thingUrl`	LocalNode
`options?`	GetThingOptions

Returns: ThingLocal | null

Defined in: src/thing/thing.ts:73

▸ getThing(solidDataset: SolidDataset, thingUrl: UrlString | Url | LocalNode, options?: GetThingOptions): Thing | null

Parameters:¶

Name	Type
`solidDataset`	SolidDataset
`thingUrl`	UrlString \| Url \| LocalNode
`options?`	GetThingOptions

Returns: Thing | null

Defined in: src/thing/thing.ts:78

getThingAll¶

▸ getThingAll(solidDataset: SolidDataset, options?: GetThingOptions): Thing[]

Get all Things about which a SolidDataset contains Quads.

Parameters:¶

Name	Type	Default value	Description
`solidDataset`	SolidDataset	-	The SolidDataset to extract the Things from.
`options`	GetThingOptions	{}	Not yet implemented.

Returns: Thing[]

Defined in: src/thing/thing.ts:129

isThing¶

▸ isThing<X>(input: X | Thing): input is Thing

since 0.2.0

Type parameters:¶

Name
`X`

Parameters:¶

Name	Type	Description
`input`	X \| Thing	An value that might be a Thing.

Returns: input is Thing

Whether input is a Thing.

Defined in: src/thing/thing.ts:333

isThingLocal¶

▸ isThingLocal(thing: ThingPersisted | ThingLocal): thing is ThingLocal

Parameters:¶

Name	Type	Description
`thing`	ThingPersisted \| ThingLocal	The Thing of which a URL might or might not be known.

Returns: thing is ThingLocal

true if thing has no known URL yet.

Defined in: src/thing/thing.ts:404

removeThing¶

▸ removeThing<Dataset>(solidDataset: Dataset, thing: UrlString | Url | LocalNode | Thing): Dataset & WithChangeLog

Remove a Thing from a SolidDataset.

Type parameters:¶

Name	Type
`Dataset`	DatasetCore<Quad, Quad, Dataset>

Parameters:¶

Name	Type	Description
`solidDataset`	Dataset	The SolidDataset to remove a Thing from.
`thing`	UrlString \| Url \| LocalNode \| Thing	The Thing to remove from `solidDataset`.

Returns: Dataset & WithChangeLog

A new SolidDataset equal to the input SolidDataset, excluding the given Thing.

Defined in: src/thing/thing.ts:235

setThing¶

▸ setThing<Dataset>(solidDataset: Dataset, thing: Thing): Dataset & WithChangeLog

Insert a Thing into a SolidDataset, replacing previous instances of that Thing.

Type parameters:¶

Name	Type
`Dataset`	DatasetCore<Quad, Quad, Dataset>

Parameters:¶

Name	Type	Description
`solidDataset`	Dataset	The SolidDataset to insert a Thing into.
`thing`	Thing	The Thing to insert into the given SolidDataset.

Returns: Dataset & WithChangeLog

A new SolidDataset equal to the given SolidDataset, but with the given Thing.

Defined in: src/thing/thing.ts:170

thingAsMarkdown¶

▸ thingAsMarkdown(thing: Thing): string

Gets a human-readable representation of the given Thing to aid debugging.

Note that changes to the exact format of the return value are not considered a breaking change; it is intended to aid in debugging, not as a serialisation method that can be reliably parsed.

since 0.3.0

Parameters:¶

Name	Type	Description
`thing`	Thing	The Thing to get a human-readable representation of.

Returns: string

Defined in: src/thing/thing.ts:374

Module: thing/set Interface: Access