Skip to content

Commit c221224

Browse files
angelo-vangelo-v
committed
doc(core): update typedoc
1 parent be25ecd commit c221224

File tree

10 files changed

+482
-98
lines changed

10 files changed

+482
-98
lines changed

‎homepage/docs/reference/core/classes/LabelIndex.md‎

Lines changed: 79 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Defined in: [search/LabelIndex.ts:12](https://github.com/pod-os/PodOS/blob/main/
8989

9090
> **anyValue**(...`predicateUris`): `undefined`
9191
92-
Defined in: [thing/Thing.ts:128](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L128)
92+
Defined in: [thing/Thing.ts:183](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L183)
9393

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

@@ -113,7 +113,7 @@ Returns any value linked from this thing via one of the given predicates
113113

114114
> **assume**\<`T`\>(`SpecificThing`): `T`
115115
116-
Defined in: [thing/Thing.ts:245](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L245)
116+
Defined in: [thing/Thing.ts:319](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L319)
117117

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

@@ -145,7 +145,7 @@ a subclass of Thing to assume
145145

146146
> **attachments**(): [`Attachment`](../interfaces/Attachment.md)[]
147147
148-
Defined in: [thing/Thing.ts:226](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L226)
148+
Defined in: [thing/Thing.ts:300](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L300)
149149

150150
Returns all attachments linked to this thing
151151

@@ -163,7 +163,7 @@ Returns all attachments linked to this thing
163163

164164
> **container**(): `object`
165165
166-
Defined in: [thing/Thing.ts:255](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L255)
166+
Defined in: [thing/Thing.ts:329](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L329)
167167

168168
Returns the container that contains this thing's document
169169
The container URI is derived from the thing's URI.
@@ -204,7 +204,7 @@ Defined in: [search/LabelIndex.ts:38](https://github.com/pod-os/PodOS/blob/main/
204204

205205
> **description**(): `undefined`
206206
207-
Defined in: [thing/Thing.ts:141](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L141)
207+
Defined in: [thing/Thing.ts:196](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L196)
208208

209209
Returns a literal value that describes this thing. Tries to match common RDF terms
210210
used for descriptions, like `dct:description`, `schema:description` or `rdfs:comment`
@@ -237,7 +237,7 @@ Returns the URIs and labels for all the things listed in the document.
237237

238238
> **label**(): `string`
239239
240-
Defined in: [thing/Thing.ts:48](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L48)
240+
Defined in: [thing/Thing.ts:57](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L57)
241241

242242
Returns a human-readable label for this thing. Tries to match common RDF terms
243243
used for labels, such as `rdfs:label`, `schema:name` and others.
@@ -258,7 +258,7 @@ If no such term is present, it will derive a label from the URI.
258258

259259
> **literals**(): [`Literal`](../interfaces/Literal.md)[]
260260
261-
Defined in: [thing/Thing.ts:71](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L71)
261+
Defined in: [thing/Thing.ts:80](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L80)
262262

263263
Returns all the literal values that are linked to this thing
264264

@@ -272,11 +272,77 @@ Returns all the literal values that are linked to this thing
272272

273273
***
274274

275+
### observeRelations()
276+
277+
> **observeRelations**(`predicate?`): `Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
278+
279+
Defined in: [thing/Thing.ts:117](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L117)
280+
281+
Observe changes in links from this thing to other resources
282+
283+
#### Parameters
284+
285+
##### predicate?
286+
287+
`string`
288+
289+
#### Returns
290+
291+
`Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
292+
293+
#### Inherited from
294+
295+
[`RdfDocument`](RdfDocument.md).[`observeRelations`](RdfDocument.md#observerelations)
296+
297+
***
298+
299+
### observeReverseRelations()
300+
301+
> **observeReverseRelations**(`predicate?`): `Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
302+
303+
Defined in: [thing/Thing.ts:159](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L159)
304+
305+
Observe changes in links from other resources to this thing
306+
307+
#### Parameters
308+
309+
##### predicate?
310+
311+
`string`
312+
313+
#### Returns
314+
315+
`Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
316+
317+
#### Inherited from
318+
319+
[`RdfDocument`](RdfDocument.md).[`observeReverseRelations`](RdfDocument.md#observereverserelations)
320+
321+
***
322+
323+
### observeTypes()
324+
325+
> **observeTypes**(): `Observable`\<[`RdfType`](../interfaces/RdfType.md)[]\>
326+
327+
Defined in: [thing/Thing.ts:281](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L281)
328+
329+
Observe changes to the list of RDF types for this thing
330+
331+
#### Returns
332+
333+
`Observable`\<[`RdfType`](../interfaces/RdfType.md)[]\>
334+
335+
#### Inherited from
336+
337+
[`RdfDocument`](RdfDocument.md).[`observeTypes`](RdfDocument.md#observetypes)
338+
339+
***
340+
275341
### picture()
276342

277343
> **picture**(): \{ `url`: `string`; \} \| `null`
278344
279-
Defined in: [thing/Thing.ts:162](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L162)
345+
Defined in: [thing/Thing.ts:217](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L217)
280346

281347
Returns the url of a picture or logo associated with this thing
282348
Tries to match common RDF terms used for pictures like `schema:image`,
@@ -298,9 +364,9 @@ An object containing the `url` of the picture
298364

299365
> **relations**(`predicate?`): [`Relation`](../interfaces/Relation.md)[]
300366
301-
Defined in: [thing/Thing.ts:88](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L88)
367+
Defined in: [thing/Thing.ts:97](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L97)
302368

303-
Returns all the links from this thing to other resources
369+
Returns all the unique links from this thing to other resources. This only includes named nodes and excludes rdf:type relations.
304370

305371
#### Parameters
306372

@@ -322,9 +388,9 @@ Returns all the links from this thing to other resources
322388

323389
> **reverseRelations**(`predicate?`): [`Relation`](../interfaces/Relation.md)[]
324390
325-
Defined in: [thing/Thing.ts:108](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L108)
391+
Defined in: [thing/Thing.ts:140](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L140)
326392

327-
Returns all the links from other resources to this thing
393+
Returns all the unique links from other resources to this thing
328394

329395
#### Parameters
330396

@@ -362,7 +428,7 @@ Defined in: [rdf-document/RdfDocument.ts:18](https://github.com/pod-os/PodOS/blo
362428

363429
> **types**(): [`RdfType`](../interfaces/RdfType.md)[]
364430
365-
Defined in: [thing/Thing.ts:215](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L215)
431+
Defined in: [thing/Thing.ts:270](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L270)
366432

367433
Retrieves a list of RDF types for this thing.
368434

‎homepage/docs/reference/core/classes/LdpContainer.md‎

Lines changed: 79 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Defined in: [ldp-container/LdpContainer.ts:12](https://github.com/pod-os/PodOS/b
8686

8787
> **anyValue**(...`predicateUris`): `undefined`
8888
89-
Defined in: [thing/Thing.ts:128](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L128)
89+
Defined in: [thing/Thing.ts:183](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L183)
9090

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

@@ -110,7 +110,7 @@ Returns any value linked from this thing via one of the given predicates
110110

111111
> **assume**\<`T`\>(`SpecificThing`): `T`
112112
113-
Defined in: [thing/Thing.ts:245](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L245)
113+
Defined in: [thing/Thing.ts:319](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L319)
114114

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

@@ -142,7 +142,7 @@ a subclass of Thing to assume
142142

143143
> **attachments**(): [`Attachment`](../interfaces/Attachment.md)[]
144144
145-
Defined in: [thing/Thing.ts:226](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L226)
145+
Defined in: [thing/Thing.ts:300](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L300)
146146

147147
Returns all attachments linked to this thing
148148

@@ -160,7 +160,7 @@ Returns all attachments linked to this thing
160160

161161
> **container**(): `object`
162162
163-
Defined in: [thing/Thing.ts:255](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L255)
163+
Defined in: [thing/Thing.ts:329](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L329)
164164

165165
Returns the container that contains this thing's document
166166
The container URI is derived from the thing's URI.
@@ -199,7 +199,7 @@ Array of objects with uri and name
199199

200200
> **description**(): `undefined`
201201
202-
Defined in: [thing/Thing.ts:141](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L141)
202+
Defined in: [thing/Thing.ts:196](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L196)
203203

204204
Returns a literal value that describes this thing. Tries to match common RDF terms
205205
used for descriptions, like `dct:description`, `schema:description` or `rdfs:comment`
@@ -218,7 +218,7 @@ used for descriptions, like `dct:description`, `schema:description` or `rdfs:com
218218

219219
> **label**(): `string`
220220
221-
Defined in: [thing/Thing.ts:48](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L48)
221+
Defined in: [thing/Thing.ts:57](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L57)
222222

223223
Returns a human-readable label for this thing. Tries to match common RDF terms
224224
used for labels, such as `rdfs:label`, `schema:name` and others.
@@ -239,7 +239,7 @@ If no such term is present, it will derive a label from the URI.
239239

240240
> **literals**(): [`Literal`](../interfaces/Literal.md)[]
241241
242-
Defined in: [thing/Thing.ts:71](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L71)
242+
Defined in: [thing/Thing.ts:80](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L80)
243243

244244
Returns all the literal values that are linked to this thing
245245

@@ -269,11 +269,77 @@ RxJS Observable that pushes a new contains() array when it changes
269269

270270
***
271271

272+
### observeRelations()
273+
274+
> **observeRelations**(`predicate?`): `Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
275+
276+
Defined in: [thing/Thing.ts:117](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L117)
277+
278+
Observe changes in links from this thing to other resources
279+
280+
#### Parameters
281+
282+
##### predicate?
283+
284+
`string`
285+
286+
#### Returns
287+
288+
`Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
289+
290+
#### Inherited from
291+
292+
[`Thing`](Thing.md).[`observeRelations`](Thing.md#observerelations)
293+
294+
***
295+
296+
### observeReverseRelations()
297+
298+
> **observeReverseRelations**(`predicate?`): `Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
299+
300+
Defined in: [thing/Thing.ts:159](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L159)
301+
302+
Observe changes in links from other resources to this thing
303+
304+
#### Parameters
305+
306+
##### predicate?
307+
308+
`string`
309+
310+
#### Returns
311+
312+
`Observable`\<[`Relation`](../interfaces/Relation.md)[]\>
313+
314+
#### Inherited from
315+
316+
[`Thing`](Thing.md).[`observeReverseRelations`](Thing.md#observereverserelations)
317+
318+
***
319+
320+
### observeTypes()
321+
322+
> **observeTypes**(): `Observable`\<[`RdfType`](../interfaces/RdfType.md)[]\>
323+
324+
Defined in: [thing/Thing.ts:281](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L281)
325+
326+
Observe changes to the list of RDF types for this thing
327+
328+
#### Returns
329+
330+
`Observable`\<[`RdfType`](../interfaces/RdfType.md)[]\>
331+
332+
#### Inherited from
333+
334+
[`Thing`](Thing.md).[`observeTypes`](Thing.md#observetypes)
335+
336+
***
337+
272338
### picture()
273339

274340
> **picture**(): \{ `url`: `string`; \} \| `null`
275341
276-
Defined in: [thing/Thing.ts:162](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L162)
342+
Defined in: [thing/Thing.ts:217](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L217)
277343

278344
Returns the url of a picture or logo associated with this thing
279345
Tries to match common RDF terms used for pictures like `schema:image`,
@@ -295,9 +361,9 @@ An object containing the `url` of the picture
295361

296362
> **relations**(`predicate?`): [`Relation`](../interfaces/Relation.md)[]
297363
298-
Defined in: [thing/Thing.ts:88](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L88)
364+
Defined in: [thing/Thing.ts:97](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L97)
299365

300-
Returns all the links from this thing to other resources
366+
Returns all the unique links from this thing to other resources. This only includes named nodes and excludes rdf:type relations.
301367

302368
#### Parameters
303369

@@ -319,9 +385,9 @@ Returns all the links from this thing to other resources
319385

320386
> **reverseRelations**(`predicate?`): [`Relation`](../interfaces/Relation.md)[]
321387
322-
Defined in: [thing/Thing.ts:108](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L108)
388+
Defined in: [thing/Thing.ts:140](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L140)
323389

324-
Returns all the links from other resources to this thing
390+
Returns all the unique links from other resources to this thing
325391

326392
#### Parameters
327393

@@ -343,7 +409,7 @@ Returns all the links from other resources to this thing
343409

344410
> **types**(): [`RdfType`](../interfaces/RdfType.md)[]
345411
346-
Defined in: [thing/Thing.ts:215](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L215)
412+
Defined in: [thing/Thing.ts:270](https://github.com/pod-os/PodOS/blob/main/core/src/thing/Thing.ts#L270)
347413

348414
Retrieves a list of RDF types for this thing.
349415

0 commit comments

Comments
 (0)