Skip to content

Thing.md

Latest commit

 

History

History
269 lines (139 loc) · 5.61 KB

Thing.md

File metadata and controls

269 lines (139 loc) · 5.61 KB

@pod-os/core

@pod-os/core / Thing

Class: Thing

Defined in: thing/Thing.ts:37

Extended by

Constructors

Constructor

new Thing(uri, store, editable): Thing

Defined in: thing/Thing.ts:38

Parameters

uri

string

store

IndexedFormula

editable

boolean = false

Whether the Thing can be edited according to its access control settings

Returns

Thing

Properties

editable

readonly editable: boolean = false

Defined in: thing/Thing.ts:44

Whether the Thing can be edited according to its access control settings

store

readonly store: IndexedFormula

Defined in: thing/Thing.ts:40

uri

readonly uri: string

Defined in: thing/Thing.ts:39

Methods

anyValue()

anyValue(...predicateUris): undefined

Defined in: thing/Thing.ts:133

Returns any value linked from this thing via one of the given predicates

Parameters

predicateUris

...string[]

Returns

undefined

assume()

assume<T>(SpecificThing): T

Defined in: thing/Thing.ts:250

Call this method to switch to a more specific subclass of Thing.

Type Parameters

T

T

Parameters

SpecificThing

(uri, store, editable) => T

a subclass of Thing to assume

Returns

T

attachments()

attachments(): Attachment[]

Defined in: thing/Thing.ts:231

Returns all attachments linked to this thing

Returns

Attachment[]

container()

container(): object

Defined in: thing/Thing.ts:264

Returns the container that contains this thing's document The container URI is derived from the thing's URI.

Returns

object

uri

uri: string

description()

description(): undefined

Defined in: thing/Thing.ts:146

Returns a literal value that describes this thing. Tries to match common RDF terms used for descriptions, like dct:description, schema:description or rdfs:comment

Returns

undefined

label()

label(): string

Defined in: thing/Thing.ts:53

Returns a human-readable label for this thing. Tries to match common RDF terms used for labels, such as rdfs:label, schema:name and others.

If no such term is present, it will derive a label from the URI.

Returns

string

literals()

literals(): Literal[]

Defined in: thing/Thing.ts:76

Returns all the literal values that are linked to this thing

Returns

Literal[]

picture()

picture(): { url: string; } | null

Defined in: thing/Thing.ts:167

Returns the url of a picture or logo associated with this thing Tries to match common RDF terms used for pictures like schema:image, vcard:photo or foaf:img

Returns

{ url: string; } | null

An object containing the url of the picture

relations()

relations(predicate?): Relation[]

Defined in: thing/Thing.ts:93

Returns all the links from this thing to other resources

Parameters

predicate?

string

Returns

Relation[]

reverseRelations()

reverseRelations(predicate?): Relation[]

Defined in: thing/Thing.ts:113

Returns all the links from other resources to this thing

Parameters

predicate?

string

Returns

Relation[]

types()

types(): RdfType[]

Defined in: thing/Thing.ts:220

Retrieves a list of RDF types for this thing.

Returns

RdfType[]