@inrupt/solid-client / thing/thing
Module: thing/thing¶
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 |
|---|---|---|
|
|
The name that should be used for this Thing when constructing its URL. If not provided, a random one will be generated. |
Defined in¶
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¶
CreateThingPersistedOptions¶
Ƭ CreateThingPersistedOptions: Object
Pass these options to createThing to initialise a new Thing whose URL is already known.
Defined in¶
Functions¶
asUrl¶
▸ asUrl(thing, baseUrl): UrlString
Get the URL to a given Thing.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
The Thing you want to obtain the URL from. |
|
|
If |
Type parameters¶
Name |
Type |
|---|---|
|
extends |
Parameters¶
Name |
Type |
|---|---|
|
|
Defined in¶
createThing¶
▸ createThing(options): ThingPersisted
Initialise a new Thing in memory with a given URL.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
See CreateThingPersistedOptions for how to specify the new Thing’s URL. |
Returns¶
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
Optional parameters that affect the final URL of this Thing when saved. |
Returns¶
Parameters¶
Name |
Type |
|---|---|
|
Defined in¶
getThing¶
▸ getThing(solidDataset, thingUrl, options?): ThingPersisted | null
Parameters¶
Name |
Type |
|---|---|
|
|
|
|
|
|
Returns¶
ThingPersisted | null
Parameters¶
Name |
Type |
|---|---|
|
|
|
|
|
|
Returns¶
ThingLocal | null
Parameters¶
Name |
Type |
|---|---|
|
|
|
|
|
|
Defined in¶
getThingAll¶
▸ getThingAll(solidDataset, options?): Thing[]
Get all Things about which a SolidDataset contains Quads.
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
The SolidDataset to extract the Things from. |
|
|
|
Not yet implemented. |
Defined in¶
isThing¶
▸ isThing<X>(input): input is Readonly<object>
since 0.2.0
Type parameters¶
Name |
|---|
|
Defined in¶
isThingLocal¶
▸ isThingLocal(thing): thing is ThingLocal
since 1.7.0
Defined in¶
removeThing¶
▸ removeThing<Dataset>(solidDataset, thing): Dataset & WithChangeLog
Remove a Thing from a SolidDataset.
Type parameters¶
Name |
Type |
|---|---|
|
extends |
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The SolidDataset to remove a Thing from. |
|
The Thing to remove from |
Returns¶
Dataset & WithChangeLog
A new SolidDataset equal to the input SolidDataset, excluding the given Thing.
Defined in¶
setThing¶
▸ setThing<Dataset>(solidDataset, thing): Dataset & WithChangeLog
Insert a Thing into a SolidDataset, replacing previous instances of that Thing.
Type parameters¶
Name |
Type |
|---|---|
|
extends |
Parameters¶
Name |
Type |
Description |
|---|---|---|
|
|
The SolidDataset to insert a Thing into. |
|
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¶
thingAsMarkdown¶
▸ thingAsMarkdown(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
Returns¶
string