Skip to content

Commit 4192f44

Browse files
committed
Update docs build
1 parent b33d632 commit 4192f44

File tree

9 files changed

+66
-65
lines changed

9 files changed

+66
-65
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ cache
99
node_modules
1010
tags
1111
docs/api/index.md
12+
docs/.vitepress/dist/

docs/api/access/classes/Access.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ remoteStorage.access.claim('*', 'rw');
4040

4141
#### Defined in
4242

43-
[access.ts:73](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/access.ts#L73)
43+
[access.ts:73](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/access.ts#L73)

docs/api/baseclient/classes/BaseClient.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ corresponding `publicClient` it is `/public/<moduleName>/`.
223223

224224
#### Defined in
225225

226-
[baseclient.ts:239](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L239)
226+
[baseclient.ts:239](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L239)
227227

228228
## Methods
229229

@@ -247,7 +247,7 @@ Usually called via [`on()`](#on)
247247

248248
#### Defined in
249249

250-
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L29)
250+
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L29)
251251

252252
***
253253

@@ -286,7 +286,7 @@ client.cache('lists/', 'SEEN');
286286

287287
#### Defined in
288288

289-
[baseclient.ts:683](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L683)
289+
[baseclient.ts:683](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L683)
290290

291291
***
292292

@@ -344,21 +344,21 @@ client.declareType('todo-item', {
344344

345345
#### Defined in
346346

347-
[baseclient.ts:733](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L733)
347+
[baseclient.ts:733](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L733)
348348

349349
***
350350

351351
### getAll()
352352

353-
> **getAll**(`path`, `maxAge`?): `Promise`\<`unknown`\>
353+
> **getAll**(`path`?, `maxAge`?): `Promise`\<`unknown`\>
354354
355355
Get all objects directly below a given path.
356356

357357
#### Parameters
358358

359-
**path**: `string`
359+
**path?**: `string`
360360

361-
Path to the folder. Must end in a forward slash.
361+
(optional) Path to the folder. Must end in a forward slash.
362362

363363
**maxAge?**: `number` \| `false`
364364

@@ -420,7 +420,7 @@ Example response:
420420
421421
#### Defined in
422422

423-
[baseclient.ts:395](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L395)
423+
[baseclient.ts:395](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L395)
424424

425425
***
426426

@@ -468,7 +468,7 @@ client.getFile('path/to/some/image').then(file => {
468468

469469
#### Defined in
470470

471-
[baseclient.ts:456](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L456)
471+
[baseclient.ts:456](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L456)
472472

473473
***
474474

@@ -499,7 +499,7 @@ The full URL of the item, including the storage origin, or `undefined`
499499
500500
#### Defined in
501501

502-
[baseclient.ts:655](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L655)
502+
[baseclient.ts:655](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L655)
503503

504504
***
505505

@@ -569,7 +569,7 @@ Example of a listing object:
569569
570570
#### Defined in
571571

572-
[baseclient.ts:326](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L326)
572+
[baseclient.ts:326](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L326)
573573

574574
***
575575

@@ -605,7 +605,7 @@ client.getObject('/path/to/object').then(obj => console.log(obj));
605605

606606
#### Defined in
607607

608-
[baseclient.ts:540](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L540)
608+
[baseclient.ts:540](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L540)
609609

610610
***
611611

@@ -641,7 +641,7 @@ remoteStorage.on('connected', function() {
641641

642642
#### Defined in
643643

644-
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L55)
644+
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L55)
645645

646646
***
647647

@@ -669,7 +669,7 @@ client.remove('path/to/object').then(() => console.log('item deleted'));
669669

670670
#### Defined in
671671

672-
[baseclient.ts:629](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L629)
672+
[baseclient.ts:629](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L629)
673673

674674
***
675675

@@ -691,7 +691,7 @@ Remove a previously installed event handler
691691

692692
#### Defined in
693693

694-
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L62)
694+
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L62)
695695

696696
***
697697

@@ -716,7 +716,7 @@ A new `BaseClient` operating on a subpath of the current base path
716716

717717
#### Defined in
718718

719-
[baseclient.ts:272](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L272)
719+
[baseclient.ts:272](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L272)
720720

721721
***
722722

@@ -772,7 +772,7 @@ fileReader.readAsArrayBuffer(file);
772772

773773
#### Defined in
774774

775-
[baseclient.ts:502](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L502)
775+
[baseclient.ts:502](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L502)
776776

777777
***
778778

@@ -825,7 +825,7 @@ client.storeObject('bookmark', path, bookmark)
825825

826826
#### Defined in
827827

828-
[baseclient.ts:588](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L588)
828+
[baseclient.ts:588](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L588)
829829

830830
***
831831

@@ -862,4 +862,4 @@ var result = client.validate(document);
862862

863863
#### Defined in
864864

865-
[baseclient.ts:765](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/baseclient.ts#L765)
865+
[baseclient.ts:765](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/baseclient.ts#L765)

docs/api/caching/classes/Caching.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ remoteStorage.caching.checkPath('documents/').then(strategy => {
6868

6969
#### Defined in
7070

71-
[caching.ts:157](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/caching.ts#L157)
71+
[caching.ts:157](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/caching.ts#L157)
7272

7373
***
7474

@@ -99,7 +99,7 @@ remoteStorage.caching.disable('/bookmarks/');
9999

100100
#### Defined in
101101

102-
[caching.ts:124](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/caching.ts#L124)
102+
[caching.ts:124](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/caching.ts#L124)
103103

104104
***
105105

@@ -129,7 +129,7 @@ remoteStorage.caching.enable('/bookmarks/');
129129

130130
#### Defined in
131131

132-
[caching.ts:107](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/caching.ts#L107)
132+
[caching.ts:107](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/caching.ts#L107)
133133

134134
***
135135

@@ -151,7 +151,7 @@ Callback function
151151

152152
#### Defined in
153153

154-
[caching.ts:133](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/caching.ts#L133)
154+
[caching.ts:133](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/caching.ts#L133)
155155

156156
***
157157

@@ -173,7 +173,7 @@ remoteStorage.caching.reset();
173173

174174
#### Defined in
175175

176-
[caching.ts:175](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/caching.ts#L175)
176+
[caching.ts:175](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/caching.ts#L175)
177177

178178
***
179179

@@ -207,4 +207,4 @@ remoteStorage.caching.set('/bookmarks/archive/', 'SEEN');
207207

208208
#### Defined in
209209

210-
[caching.ts:67](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/caching.ts#L67)
210+
[caching.ts:67](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/caching.ts#L67)

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212

1313
## Defined in
1414

15-
[eventhandling.ts:5](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L5)
15+
[eventhandling.ts:5](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L5)

docs/api/remote/classes/RemoteBase.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Usually called via [`on()`](#on)
3232

3333
#### Defined in
3434

35-
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L29)
35+
[eventhandling.ts:29](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L29)
3636

3737
***
3838

@@ -72,7 +72,7 @@ remoteStorage.on('connected', function() {
7272

7373
#### Defined in
7474

75-
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L55)
75+
[eventhandling.ts:55](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L55)
7676

7777
***
7878

@@ -98,4 +98,4 @@ Remove a previously installed event handler
9898

9999
#### Defined in
100100

101-
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/eventhandling.ts#L62)
101+
[eventhandling.ts:62](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/eventhandling.ts#L62)

docs/api/remote/interfaces/Remote.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Whether or not a remote store is connected
1212

1313
#### Defined in
1414

15-
[remote.ts:82](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/remote.ts#L82)
15+
[remote.ts:82](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/remote.ts#L82)
1616

1717
***
1818

@@ -24,7 +24,7 @@ Whether last sync action was successful or not
2424

2525
#### Defined in
2626

27-
[remote.ts:87](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/remote.ts#L87)
27+
[remote.ts:87](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/remote.ts#L87)
2828

2929
***
3030

@@ -36,7 +36,7 @@ The JSON-parsed properties object from the user's WebFinger record
3636

3737
#### Defined in
3838

39-
[remote.ts:123](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/remote.ts#L123)
39+
[remote.ts:123](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/remote.ts#L123)
4040

4141
***
4242

@@ -48,4 +48,4 @@ The user address of the connected user
4848

4949
#### Defined in
5050

51-
[remote.ts:92](https://github.com/remotestorage/remotestorage.js/blob/6f00c54cc7f590233dcd3504f048d1df775bc754/src/remote.ts#L92)
51+
[remote.ts:92](https://github.com/remotestorage/remotestorage.js/blob/a199c15fb409a17fd444aa7fba846e7fecc5981d/src/remote.ts#L92)

0 commit comments

Comments
 (0)