Update docs build

remotestorage · Jul 22, 2024 · 6f00c54 · 6f00c54
1 parent 34c4a31
commit 6f00c54
Show file tree

Hide file tree

Showing 8 changed files with 137 additions and 127 deletions.
diff --git a/docs/api/access/classes/Access.md b/docs/api/access/classes/Access.md
@@ -38,6 +38,6 @@ Claiming root access, meaning complete access to all files and folders of a stor
 remoteStorage.access.claim('*', 'rw');
 ```
 
-#### Source
+#### Defined in
 
-[access.ts:73](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/access.ts#L73)
+[access.ts:73](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/access.ts#L73)
diff --git a/docs/api/baseclient/classes/BaseClient.md b/docs/api/baseclient/classes/BaseClient.md
@@ -221,9 +221,9 @@ Base path, which this [BaseClient](BaseClient.md) operates on.
 For the module's `privateClient` this would be the module name, and for the
 corresponding `publicClient` it is `/public/<moduleName>/`.
 
-#### Source
+#### Defined in
 
-[baseclient.ts:239](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L239)
+[baseclient.ts:239](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L239)
 
 ## Methods
 
@@ -245,9 +245,9 @@ Usually called via [`on()`](#on)
 
 `void`
 
-#### Source
+#### Defined in
 
-[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L29)
+[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L29)
 
 ***
 
@@ -266,7 +266,7 @@ for a detailed description of the available strategies.
 
 Path to cache
 
-• **strategy**: `"ALL"` \| `"SEEN"` \| `"FLUSH"`= `'ALL'`
+• **strategy**: `"ALL"` \| `"SEEN"` \| `"FLUSH"` = `'ALL'`
 
 Caching strategy. One of 'ALL', 'SEEN', or FLUSH'.
                   Defaults to 'ALL'.
@@ -284,9 +284,9 @@ The same `BaseClient` instance this method is called on to allow
 client.cache('lists/', 'SEEN');
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:683](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L683)
+[baseclient.ts:683](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L683)
 
 ***
 
@@ -342,9 +342,9 @@ client.declareType('todo-item', {
 })
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:733](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L733)
+[baseclient.ts:733](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L733)
 
 ***
 
@@ -418,9 +418,9 @@ Example response:
 > [storeFile](BaseClient.md#storefile) instead of [storeObject](BaseClient.md#storeobject)), the object's value is
 > filled in with `true`.
 
-#### Source
+#### Defined in
 
-[baseclient.ts:395](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L395)
+[baseclient.ts:395](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L395)
 
 ***
 
@@ -466,9 +466,9 @@ client.getFile('path/to/some/image').then(file => {
 });
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:456](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L456)
+[baseclient.ts:456](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L456)
 
 ***
 
@@ -497,9 +497,9 @@ The full URL of the item, including the storage origin, or `undefined`
 > backends. The GitHub issues for implementing it for Dropbox and Google
 > are 1052 and 1054.
 
-#### Source
+#### Defined in
 
-[baseclient.ts:655](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L655)
+[baseclient.ts:655](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L655)
 
 ***
 
@@ -567,9 +567,9 @@ Example of a listing object:
 > item names as properties with `true` as value. See issues 721 and 1108 —
 > contributions welcome!
 
-#### Source
+#### Defined in
 
-[baseclient.ts:326](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L326)
+[baseclient.ts:326](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L326)
 
 ***
 
@@ -603,9 +603,9 @@ A promise, resolving with the requested object, or `null` if non-existent
 client.getObject('/path/to/object').then(obj => console.log(obj));
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:540](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L540)
+[baseclient.ts:540](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L540)
 
 ***
 
@@ -639,9 +639,9 @@ remoteStorage.on('connected', function() {
 });
 ```
 
-#### Source
+#### Defined in
 
-[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L55)
+[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L55)
 
 ***
 
@@ -667,9 +667,9 @@ Path relative to the module root.
 client.remove('path/to/object').then(() => console.log('item deleted'));
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:629](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L629)
+[baseclient.ts:629](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L629)
 
 ***
 
@@ -689,9 +689,9 @@ Remove a previously installed event handler
 
 `void`
 
-#### Source
+#### Defined in
 
-[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L62)
+[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L62)
 
 ***
 
@@ -714,9 +714,9 @@ The path to scope the new client to
 
 A new `BaseClient` operating on a subpath of the current base path
 
-#### Source
+#### Defined in
 
-[baseclient.ts:272](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L272)
+[baseclient.ts:272](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L272)
 
 ***
 
@@ -770,9 +770,9 @@ fileReader.onload = function () {
 fileReader.readAsArrayBuffer(file);
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:502](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L502)
+[baseclient.ts:502](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L502)
 
 ***
 
@@ -823,9 +823,9 @@ client.storeObject('bookmark', path, bookmark)
       .catch((err) => console.log(err));
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:588](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L588)
+[baseclient.ts:588](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L588)
 
 ***
 
@@ -860,6 +860,6 @@ var result = client.validate(document);
 // }
 ```
 
-#### Source
+#### Defined in
 
-[baseclient.ts:765](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L765)
+[baseclient.ts:765](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L765)
diff --git a/docs/api/caching/classes/Caching.md b/docs/api/caching/classes/Caching.md
@@ -66,9 +66,9 @@ remoteStorage.caching.checkPath('documents/').then(strategy => {
 });
 ```
 
-#### Source
+#### Defined in
 
-[caching.ts:157](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L157)
+[caching.ts:157](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L157)
 
 ***
 
@@ -97,9 +97,9 @@ Path to disable caching for
 remoteStorage.caching.disable('/bookmarks/');
 ```
 
-#### Source
+#### Defined in
 
-[caching.ts:124](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L124)
+[caching.ts:124](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L124)
 
 ***
 
@@ -127,9 +127,9 @@ Path to enable caching for
 remoteStorage.caching.enable('/bookmarks/');
 ```
 
-#### Source
+#### Defined in
 
-[caching.ts:107](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L107)
+[caching.ts:107](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L107)
 
 ***
 
@@ -149,9 +149,9 @@ Callback function
 
 `void`
 
-#### Source
+#### Defined in
 
-[caching.ts:133](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L133)
+[caching.ts:133](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L133)
 
 ***
 
@@ -171,9 +171,9 @@ Reset the state of caching by deleting all caching information.
 remoteStorage.caching.reset();
 ```
 
-#### Source
+#### Defined in
 
-[caching.ts:175](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L175)
+[caching.ts:175](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L175)
 
 ***
 
@@ -205,6 +205,6 @@ Caching strategy. One of 'ALL', 'SEEN', or 'FLUSH'.
 remoteStorage.caching.set('/bookmarks/archive/', 'SEEN');
 ```
 
-#### Source
+#### Defined in
 
-[caching.ts:67](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L67)
+[caching.ts:67](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L67)
diff --git a/docs/api/eventhandling/type-aliases/EventHandler.md b/docs/api/eventhandling/type-aliases/EventHandler.md
@@ -1,4 +1,4 @@
-# Type alias: EventHandler()
+# Type Alias: EventHandler()
 
 > **EventHandler**: (`event`?) => `void`
 
@@ -10,6 +10,6 @@
 
 `void`
 
-## Source
+## Defined in
 
-[eventhandling.ts:5](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L5)
+[eventhandling.ts:5](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L5)
diff --git a/docs/api/remote/classes/RemoteBase.md b/docs/api/remote/classes/RemoteBase.md
@@ -30,9 +30,9 @@ Usually called via [`on()`](#on)
 
 `EventHandling.addEventListener`
 
-#### Source
+#### Defined in
 
-[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L29)
+[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L29)
 
 ***
 
@@ -58,10 +58,6 @@ Function to handle the event
 
 `void`
 
-#### Inherited from
-
-`EventHandling.on`
-
 #### Example
 
 ```ts
@@ -70,9 +66,13 @@ remoteStorage.on('connected', function() {
 });
 ```
 
-#### Source
+#### Inherited from
+
+`EventHandling.on`
+
+#### Defined in
 
-[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L55)
+[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L55)
 
 ***
 
@@ -96,6 +96,6 @@ Remove a previously installed event handler
 
 `EventHandling.removeEventListener`
 
-#### Source
+#### Defined in
 
-[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L62)
+[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L62)
diff --git a/docs/api/remote/interfaces/Remote.md b/docs/api/remote/interfaces/Remote.md
@@ -10,9 +10,9 @@ The public interface for WireClient, GoogleDrive & Dropbox
 
 Whether or not a remote store is connected
 
-#### Source
+#### Defined in
 
-[remote.ts:82](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L82)
+[remote.ts:82](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L82)
 
 ***
 
@@ -22,9 +22,9 @@ Whether or not a remote store is connected
 
 Whether last sync action was successful or not
 
-#### Source
+#### Defined in
 
-[remote.ts:87](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L87)
+[remote.ts:87](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L87)
 
 ***
 
@@ -34,9 +34,9 @@ Whether last sync action was successful or not
 
 The JSON-parsed properties object from the user's WebFinger record
 
-#### Source
+#### Defined in
 
-[remote.ts:123](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L123)
+[remote.ts:123](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L123)
 
 ***
 
@@ -46,6 +46,6 @@ The JSON-parsed properties object from the user's WebFinger record
 
 The user address of the connected user
 
-#### Source
+#### Defined in
 
-[remote.ts:92](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L92)
+[remote.ts:92](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L92)