doc(core): document public methods of Thing class

Author: angelo-v

core/src/thing/Thing.ts

@@ -38,6 +38,12 @@ export class Thing {
     readonly editable: boolean = false,
   ) {}
 
+  /**
+   * 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.
+   */
   label() {
     const value = this.anyValue(
       "http://www.w3.org/2006/vcard/ns#fn",
@@ -58,6 +64,9 @@ export class Thing {
     return labelFromUri(this.uri);
   }
 
+  /**
+   * Returns all the literal values that are linked to this thing
+   */
   literals(): Literal[] {
     const statements = this.store.statementsMatching(sym(this.uri));
 
@@ -72,6 +81,9 @@ export class Thing {
     }));
   }
 
+  /**
+   * Returns all the links from this thing to other resources
+   */
   relations(predicate?: string): Relation[] {
     const statements = this.store.statementsMatching(
       sym(this.uri),
@@ -89,6 +101,9 @@ export class Thing {
     }));
   }
 
+  /**
+   * Returns all the links from other resources to this thing
+   */
   reverseRelations(predicate?: string): Relation[] {
     const statements = this.store.statementsMatching(
       undefined,
@@ -105,6 +120,10 @@ export class Thing {
     }));
   }
 
+  /**
+   * Returns any value linked from this thing via one of the given predicates
+   * @param predicateUris
+   */
   anyValue(...predicateUris: string[]) {
     let value;
     predicateUris.some((it) => {
@@ -114,6 +133,10 @@ export class Thing {
     return value;
   }
 
+  /**
+   * 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`
+   */
   description() {
     return this.anyValue(
       "http://purl.org/dc/terms/description",
@@ -128,6 +151,13 @@ export class Thing {
     );
   }
 
+  /**
+   * 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`
+   *
+   * @return {Object} An object containing the `url` of the picture
+   */
   picture() {
     const directUrl = this.anyValue(
       "http://schema.org/image",
@@ -178,6 +208,9 @@ export class Thing {
       : null;
   }
 
+  /**
+   * Retrieves a list of RDF types for this thing.
+   */
   types(): RdfType[] {
     const uriMap = this.store.findTypeURIs(sym(this.uri));
     return Object.keys(uriMap).map((uri) => ({
@@ -186,6 +219,11 @@ export class Thing {
     }));
   }
 
+  /**
+   * Call this method to switch to a more specific subclass of Thing.
+   *
+   * @param SpecificThing - a subclass of Thing to assume
+   */
   assume<T>(
     SpecificThing: new (
       uri: string,

homepage/docs/reference/core/classes/AnonymousSession.md

@@ -6,7 +6,7 @@
 
 # Class: AnonymousSession
 
-Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L20)
+Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/authentication/index.ts#L20)
 
 ## Implements
 
@@ -30,7 +30,7 @@ Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/1a
 
 > **get** **authenticatedFetch**(): (`url`, `init?`) => `Promise`\<`Response`\>
 
-Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L27)
+Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/authentication/index.ts#L27)
 
 ##### Returns
 
@@ -60,7 +60,7 @@ Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/1a
 
 > **login**(): `Promise`\<`void`\>
 
-Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L38)
+Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/authentication/index.ts#L38)
 
 #### Returns
 
@@ -76,7 +76,7 @@ Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/1a
 
 > **logout**(): `Promise`\<`void`\>
 
-Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L42)
+Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/authentication/index.ts#L42)
 
 #### Returns
 
@@ -92,7 +92,7 @@ Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/1a
 
 > **observeSession**(): `BehaviorSubject`\<[`SessionInfo`](../type-aliases/SessionInfo.md)\>
 
-Defined in: [authentication/index.ts:34](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/authentication/index.ts#L34)
+Defined in: [authentication/index.ts:34](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/authentication/index.ts#L34)
 
 #### Returns
 

homepage/docs/reference/core/classes/AssumeAlwaysOnline.md

@@ -6,7 +6,7 @@
 
 # Class: AssumeAlwaysOnline
 
-Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/offline-cache/OnlineStatus.ts#L5)
+Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/offline-cache/OnlineStatus.ts#L5)
 
 ## Implements
 
@@ -28,7 +28,7 @@ Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/bl
 
 > **isOnline**(): `boolean`
 
-Defined in: [offline-cache/OnlineStatus.ts:6](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/offline-cache/OnlineStatus.ts#L6)
+Defined in: [offline-cache/OnlineStatus.ts:6](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/offline-cache/OnlineStatus.ts#L6)
 
 #### Returns
 

homepage/docs/reference/core/classes/BinaryFile.md

@@ -6,7 +6,7 @@
 
 # Class: BinaryFile
 
-Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L3)
+Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BinaryFile.ts#L3)
 
 ## Implements
 
@@ -18,7 +18,7 @@ Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > **new BinaryFile**(`url`, `data`): `BinaryFile`
 
-Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L4)
+Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BinaryFile.ts#L4)
 
 #### Parameters
 
@@ -40,7 +40,7 @@ Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > `readonly` **url**: `string`
 
-Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L5)
+Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BinaryFile.ts#L5)
 
 #### Implementation of
 
@@ -52,7 +52,7 @@ Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > **blob**(): `Blob`
 
-Defined in: [files/BinaryFile.ts:9](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BinaryFile.ts#L9)
+Defined in: [files/BinaryFile.ts:9](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BinaryFile.ts#L9)
 
 #### Returns
 

homepage/docs/reference/core/classes/BrokenFile.md

@@ -6,7 +6,7 @@
 
 # Class: BrokenFile
 
-Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L4)
+Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BrokenFile.ts#L4)
 
 ## Implements
 
@@ -18,7 +18,7 @@ Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > **new BrokenFile**(`url`, `status`): `BrokenFile`
 
-Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L5)
+Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BrokenFile.ts#L5)
 
 #### Parameters
 
@@ -40,15 +40,15 @@ Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > `readonly` **status**: [`HttpStatus`](HttpStatus.md)
 
-Defined in: [files/BrokenFile.ts:7](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L7)
+Defined in: [files/BrokenFile.ts:7](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BrokenFile.ts#L7)
 
 ***
 
 ### url
 
 > `readonly` **url**: `string`
 
-Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L6)
+Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BrokenFile.ts#L6)
 
 #### Implementation of
 
@@ -60,7 +60,7 @@ Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > **blob**(): `null` \| `Blob`
 
-Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L14)
+Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BrokenFile.ts#L14)
 
 #### Returns
 
@@ -76,7 +76,7 @@ Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/1aecf6
 
 > **toString**(): `string`
 
-Defined in: [files/BrokenFile.ts:10](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/BrokenFile.ts#L10)
+Defined in: [files/BrokenFile.ts:10](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/BrokenFile.ts#L10)
 
 Returns a string representation of an object.
 

homepage/docs/reference/core/classes/HttpStatus.md

@@ -6,15 +6,15 @@
 
 # Class: HttpStatus
 
-Defined in: [files/HttpStatus.ts:1](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L1)
+Defined in: [files/HttpStatus.ts:1](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/HttpStatus.ts#L1)
 
 ## Constructors
 
 ### Constructor
 
 > **new HttpStatus**(`code`, `text?`): `HttpStatus`
 
-Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L2)
+Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/HttpStatus.ts#L2)
 
 #### Parameters
 
@@ -36,23 +36,23 @@ Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/1aecf6d
 
 > `readonly` **code**: `number`
 
-Defined in: [files/HttpStatus.ts:3](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L3)
+Defined in: [files/HttpStatus.ts:3](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/HttpStatus.ts#L3)
 
 ***
 
 ### text?
 
 > `readonly` `optional` **text**: `string`
 
-Defined in: [files/HttpStatus.ts:4](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L4)
+Defined in: [files/HttpStatus.ts:4](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/HttpStatus.ts#L4)
 
 ## Methods
 
 ### toString()
 
 > **toString**(): `string`
 
-Defined in: [files/HttpStatus.ts:7](https://github.com/pod-os/PodOS/blob/1aecf6de76fa668e7779c8aad7b604e498d41244/core/src/files/HttpStatus.ts#L7)
+Defined in: [files/HttpStatus.ts:7](https://github.com/pod-os/PodOS/blob/05359ae5a5ec21be7fe13c91bc776d19e0a5d007/core/src/files/HttpStatus.ts#L7)
 
 #### Returns