@pod-os/core / TypeIndex

Class: TypeIndex

Defined in: type-index/TypeIndex.ts:12

Represents a private or public type index document

Since

0.24.0

Extends

Thing

Constructors

Constructor

new TypeIndex(uri, store, editable?): TypeIndex

Defined in: type-index/TypeIndex.ts:13

Parameters

uri

string

store

Store

editable?

boolean = false

Returns

TypeIndex

Overrides

Thing.constructor

Properties

editable

readonly editable: boolean = false

Defined in: type-index/TypeIndex.ts:16

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

Inherited from

Thing.editable

store

readonly store: Store

Defined in: type-index/TypeIndex.ts:15

Inherited from

Thing.store

uri

readonly uri: string

Defined in: type-index/TypeIndex.ts:14

Inherited from

Thing.uri

Methods

anyValue()

anyValue(...predicateUris): undefined

Defined in: thing/Thing.ts:183

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

Parameters

predicateUris

...string[]

Returns

undefined

Inherited from

Thing.anyValue

assume()

assume\<T>(SpecificThing): T

Defined in: thing/Thing.ts:319

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

Inherited from

Thing.assume

attachments()

attachments(): Attachment[]

Defined in: thing/Thing.ts:300

Returns all attachments linked to this thing

Returns

Attachment[]

Inherited from

Thing.attachments

container()

container(): object

Defined in: thing/Thing.ts:329

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

Returns

object

uri

uri: string

Inherited from

Thing.container

description()

description(): undefined

Defined in: thing/Thing.ts:196

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

Inherited from

Thing.description

label()

label(): string

Defined in: thing/Thing.ts:57

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

Inherited from

Thing.label

listAll()

listAll(): TypeRegistration[]

Defined in: type-index/TypeIndex.ts:21

Returns

TypeRegistration[]

literals()

literals(): Literal[]

Defined in: thing/Thing.ts:80

Returns all the literal values that are linked to this thing

Returns

Literal[]

Inherited from

Thing.literals

observeRelations()

observeRelations(predicate?): Observable\<Relation[]>

Defined in: thing/Thing.ts:117

Observe changes in links from this thing to other resources

Parameters

predicate?

string

Returns

Observable\<Relation[]>

Inherited from

Thing.observeRelations

observeReverseRelations()

observeReverseRelations(predicate?): Observable\<Relation[]>

Defined in: thing/Thing.ts:159

Observe changes in links from other resources to this thing

Parameters

predicate?

string

Returns

Observable\<Relation[]>

Inherited from

Thing.observeReverseRelations

observeTypes()

observeTypes(): Observable\<RdfType[]>

Defined in: thing/Thing.ts:281

Observe changes to the list of RDF types for this thing

Returns

Observable\<RdfType[]>

Inherited from

Thing.observeTypes

picture()

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

Defined in: thing/Thing.ts:217

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