Skip to content

Commit 6f00c54

Browse files
raucaoraucao
committed
Update docs build
1 parent 34c4a31 commit 6f00c54

File tree

8 files changed

+137
-127
lines changed

8 files changed

+137
-127
lines changed

‎docs/api/access/classes/Access.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ Claiming root access, meaning complete access to all files and folders of a stor
3838
remoteStorage.access.claim('*', 'rw');
3939
```
4040

41-
#### Source
41+
#### Defined in
4242

43-
[access.ts:73](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/access.ts#L73)
43+
[access.ts:73](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/access.ts#L73)

‎docs/api/baseclient/classes/BaseClient.md‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,9 @@ Base path, which this [BaseClient](BaseClient.md) operates on.
221221
For the module's `privateClient` this would be the module name, and for the
222222
corresponding `publicClient` it is `/public/<moduleName>/`.
223223

224-
#### Source
224+
#### Defined in
225225

226-
[baseclient.ts:239](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L239)
226+
[baseclient.ts:239](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L239)
227227

228228
## Methods
229229

@@ -245,9 +245,9 @@ Usually called via [`on()`](#on)
245245

246246
`void`
247247

248-
#### Source
248+
#### Defined in
249249

250-
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L29)
250+
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L29)
251251

252252
***
253253

@@ -266,7 +266,7 @@ for a detailed description of the available strategies.
266266

267267
Path to cache
268268

269-
• **strategy**: `"ALL"` \| `"SEEN"` \| `"FLUSH"`= `'ALL'`
269+
• **strategy**: `"ALL"` \| `"SEEN"` \| `"FLUSH"` = `'ALL'`
270270

271271
Caching strategy. One of 'ALL', 'SEEN', or FLUSH'.
272272
Defaults to 'ALL'.
@@ -284,9 +284,9 @@ The same `BaseClient` instance this method is called on to allow
284284
client.cache('lists/', 'SEEN');
285285
```
286286

287-
#### Source
287+
#### Defined in
288288

289-
[baseclient.ts:683](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L683)
289+
[baseclient.ts:683](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L683)
290290

291291
***
292292

@@ -342,9 +342,9 @@ client.declareType('todo-item', {
342342
})
343343
```
344344

345-
#### Source
345+
#### Defined in
346346

347-
[baseclient.ts:733](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L733)
347+
[baseclient.ts:733](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L733)
348348

349349
***
350350

@@ -418,9 +418,9 @@ Example response:
418418
> [storeFile](BaseClient.md#storefile) instead of [storeObject](BaseClient.md#storeobject)), the object's value is
419419
> filled in with `true`.
420420
421-
#### Source
421+
#### Defined in
422422

423-
[baseclient.ts:395](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L395)
423+
[baseclient.ts:395](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L395)
424424

425425
***
426426

@@ -466,9 +466,9 @@ client.getFile('path/to/some/image').then(file => {
466466
});
467467
```
468468

469-
#### Source
469+
#### Defined in
470470

471-
[baseclient.ts:456](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L456)
471+
[baseclient.ts:456](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L456)
472472

473473
***
474474

@@ -497,9 +497,9 @@ The full URL of the item, including the storage origin, or `undefined`
497497
> backends. The GitHub issues for implementing it for Dropbox and Google
498498
> are 1052 and 1054.
499499
500-
#### Source
500+
#### Defined in
501501

502-
[baseclient.ts:655](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L655)
502+
[baseclient.ts:655](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L655)
503503

504504
***
505505

@@ -567,9 +567,9 @@ Example of a listing object:
567567
> item names as properties with `true` as value. See issues 721 and 1108 —
568568
> contributions welcome!
569569
570-
#### Source
570+
#### Defined in
571571

572-
[baseclient.ts:326](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L326)
572+
[baseclient.ts:326](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L326)
573573

574574
***
575575

@@ -603,9 +603,9 @@ A promise, resolving with the requested object, or `null` if non-existent
603603
client.getObject('/path/to/object').then(obj => console.log(obj));
604604
```
605605

606-
#### Source
606+
#### Defined in
607607

608-
[baseclient.ts:540](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L540)
608+
[baseclient.ts:540](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L540)
609609

610610
***
611611

@@ -639,9 +639,9 @@ remoteStorage.on('connected', function() {
639639
});
640640
```
641641

642-
#### Source
642+
#### Defined in
643643

644-
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L55)
644+
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L55)
645645

646646
***
647647

@@ -667,9 +667,9 @@ Path relative to the module root.
667667
client.remove('path/to/object').then(() => console.log('item deleted'));
668668
```
669669

670-
#### Source
670+
#### Defined in
671671

672-
[baseclient.ts:629](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L629)
672+
[baseclient.ts:629](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L629)
673673

674674
***
675675

@@ -689,9 +689,9 @@ Remove a previously installed event handler
689689

690690
`void`
691691

692-
#### Source
692+
#### Defined in
693693

694-
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L62)
694+
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L62)
695695

696696
***
697697

@@ -714,9 +714,9 @@ The path to scope the new client to
714714

715715
A new `BaseClient` operating on a subpath of the current base path
716716

717-
#### Source
717+
#### Defined in
718718

719-
[baseclient.ts:272](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L272)
719+
[baseclient.ts:272](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L272)
720720

721721
***
722722

@@ -770,9 +770,9 @@ fileReader.onload = function () {
770770
fileReader.readAsArrayBuffer(file);
771771
```
772772

773-
#### Source
773+
#### Defined in
774774

775-
[baseclient.ts:502](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L502)
775+
[baseclient.ts:502](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L502)
776776

777777
***
778778

@@ -823,9 +823,9 @@ client.storeObject('bookmark', path, bookmark)
823823
.catch((err) => console.log(err));
824824
```
825825

826-
#### Source
826+
#### Defined in
827827

828-
[baseclient.ts:588](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L588)
828+
[baseclient.ts:588](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L588)
829829

830830
***
831831

@@ -860,6 +860,6 @@ var result = client.validate(document);
860860
// }
861861
```
862862

863-
#### Source
863+
#### Defined in
864864

865-
[baseclient.ts:765](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/baseclient.ts#L765)
865+
[baseclient.ts:765](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/baseclient.ts#L765)

‎docs/api/caching/classes/Caching.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ remoteStorage.caching.checkPath('documents/').then(strategy => {
6666
});
6767
```
6868

69-
#### Source
69+
#### Defined in
7070

71-
[caching.ts:157](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L157)
71+
[caching.ts:157](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L157)
7272

7373
***
7474

@@ -97,9 +97,9 @@ Path to disable caching for
9797
remoteStorage.caching.disable('/bookmarks/');
9898
```
9999

100-
#### Source
100+
#### Defined in
101101

102-
[caching.ts:124](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L124)
102+
[caching.ts:124](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L124)
103103

104104
***
105105

@@ -127,9 +127,9 @@ Path to enable caching for
127127
remoteStorage.caching.enable('/bookmarks/');
128128
```
129129

130-
#### Source
130+
#### Defined in
131131

132-
[caching.ts:107](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L107)
132+
[caching.ts:107](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L107)
133133

134134
***
135135

@@ -149,9 +149,9 @@ Callback function
149149

150150
`void`
151151

152-
#### Source
152+
#### Defined in
153153

154-
[caching.ts:133](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L133)
154+
[caching.ts:133](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L133)
155155

156156
***
157157

@@ -171,9 +171,9 @@ Reset the state of caching by deleting all caching information.
171171
remoteStorage.caching.reset();
172172
```
173173

174-
#### Source
174+
#### Defined in
175175

176-
[caching.ts:175](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L175)
176+
[caching.ts:175](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L175)
177177

178178
***
179179

@@ -205,6 +205,6 @@ Caching strategy. One of 'ALL', 'SEEN', or 'FLUSH'.
205205
remoteStorage.caching.set('/bookmarks/archive/', 'SEEN');
206206
```
207207

208-
#### Source
208+
#### Defined in
209209

210-
[caching.ts:67](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/caching.ts#L67)
210+
[caching.ts:67](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/caching.ts#L67)

‎docs/api/eventhandling/type-aliases/EventHandler.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Type alias: EventHandler()
1+
# Type Alias: EventHandler()
22

33
> **EventHandler**: (`event`?) => `void`
44
@@ -10,6 +10,6 @@
1010

1111
`void`
1212

13-
## Source
13+
## Defined in
1414

15-
[eventhandling.ts:5](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L5)
15+
[eventhandling.ts:5](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L5)

‎docs/api/remote/classes/RemoteBase.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ Usually called via [`on()`](#on)
3030

3131
`EventHandling.addEventListener`
3232

33-
#### Source
33+
#### Defined in
3434

35-
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L29)
35+
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L29)
3636

3737
***
3838

@@ -58,10 +58,6 @@ Function to handle the event
5858

5959
`void`
6060

61-
#### Inherited from
62-
63-
`EventHandling.on`
64-
6561
#### Example
6662

6763
```ts
@@ -70,9 +66,13 @@ remoteStorage.on('connected', function() {
7066
});
7167
```
7268

73-
#### Source
69+
#### Inherited from
70+
71+
`EventHandling.on`
72+
73+
#### Defined in
7474

75-
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L55)
75+
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L55)
7676

7777
***
7878

@@ -96,6 +96,6 @@ Remove a previously installed event handler
9696

9797
`EventHandling.removeEventListener`
9898

99-
#### Source
99+
#### Defined in
100100

101-
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/eventhandling.ts#L62)
101+
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/eventhandling.ts#L62)

‎docs/api/remote/interfaces/Remote.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ The public interface for WireClient, GoogleDrive & Dropbox
1010
1111
Whether or not a remote store is connected
1212

13-
#### Source
13+
#### Defined in
1414

15-
[remote.ts:82](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L82)
15+
[remote.ts:82](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L82)
1616

1717
***
1818

@@ -22,9 +22,9 @@ Whether or not a remote store is connected
2222
2323
Whether last sync action was successful or not
2424

25-
#### Source
25+
#### Defined in
2626

27-
[remote.ts:87](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L87)
27+
[remote.ts:87](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L87)
2828

2929
***
3030

@@ -34,9 +34,9 @@ Whether last sync action was successful or not
3434
3535
The JSON-parsed properties object from the user's WebFinger record
3636

37-
#### Source
37+
#### Defined in
3838

39-
[remote.ts:123](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L123)
39+
[remote.ts:123](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L123)
4040

4141
***
4242

@@ -46,6 +46,6 @@ The JSON-parsed properties object from the user's WebFinger record
4646
4747
The user address of the connected user
4848

49-
#### Source
49+
#### Defined in
5050

51-
[remote.ts:92](https://github.com/remotestorage/remotestorage.js/blob/65f5343823175e12058c01e23219a8cc9d34932b/src/remote.ts#L92)
51+
[remote.ts:92](https://github.com/remotestorage/remotestorage.js/blob/9625dcb362d5fe51be7b7fbdbb04492cfbf19644/src/remote.ts#L92)

0 commit comments

Comments
 (0)