Skip to content

Commit 69dc352

Browse files
committed
doc(core): update typedoc
1 parent 749bb0d commit 69dc352

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+666
-322
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: AnonymousSession
88

9-
Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/authentication/index.ts#L20)
9+
Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/main/core/src/authentication/index.ts#L20)
1010

1111
## Implements
1212

@@ -30,7 +30,7 @@ Defined in: [authentication/index.ts:20](https://github.com/pod-os/PodOS/blob/e8
3030

3131
> **get** **authenticatedFetch**(): (`url`, `init?`) => `Promise`\<`Response`\>
3232
33-
Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/authentication/index.ts#L27)
33+
Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/main/core/src/authentication/index.ts#L27)
3434

3535
##### Returns
3636

@@ -60,7 +60,7 @@ Defined in: [authentication/index.ts:27](https://github.com/pod-os/PodOS/blob/e8
6060

6161
> **login**(): `Promise`\<`void`\>
6262
63-
Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/authentication/index.ts#L38)
63+
Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/main/core/src/authentication/index.ts#L38)
6464

6565
#### Returns
6666

@@ -76,7 +76,7 @@ Defined in: [authentication/index.ts:38](https://github.com/pod-os/PodOS/blob/e8
7676

7777
> **logout**(): `Promise`\<`void`\>
7878
79-
Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/authentication/index.ts#L42)
79+
Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/main/core/src/authentication/index.ts#L42)
8080

8181
#### Returns
8282

@@ -92,7 +92,7 @@ Defined in: [authentication/index.ts:42](https://github.com/pod-os/PodOS/blob/e8
9292

9393
> **observeSession**(): `BehaviorSubject`\<[`SessionInfo`](../type-aliases/SessionInfo.md)\>
9494
95-
Defined in: [authentication/index.ts:34](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/authentication/index.ts#L34)
95+
Defined in: [authentication/index.ts:34](https://github.com/pod-os/PodOS/blob/main/core/src/authentication/index.ts#L34)
9696

9797
#### Returns
9898

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: AssumeAlwaysOnline
88

9-
Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/offline-cache/OnlineStatus.ts#L5)
9+
Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/blob/main/core/src/offline-cache/OnlineStatus.ts#L5)
1010

1111
## Implements
1212

@@ -28,7 +28,7 @@ Defined in: [offline-cache/OnlineStatus.ts:5](https://github.com/pod-os/PodOS/bl
2828

2929
> **isOnline**(): `boolean`
3030
31-
Defined in: [offline-cache/OnlineStatus.ts:6](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/offline-cache/OnlineStatus.ts#L6)
31+
Defined in: [offline-cache/OnlineStatus.ts:6](https://github.com/pod-os/PodOS/blob/main/core/src/offline-cache/OnlineStatus.ts#L6)
3232

3333
#### Returns
3434

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: AttachmentGateway
88

9-
Defined in: [attachments/AttachmentGateway.ts:11](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/attachments/AttachmentGateway.ts#L11)
9+
Defined in: [attachments/AttachmentGateway.ts:11](https://github.com/pod-os/PodOS/blob/main/core/src/attachments/AttachmentGateway.ts#L11)
1010

1111
Gateway for attachment-related operations on Solid Pods and the store.
1212

@@ -20,7 +20,7 @@ Gateway for attachment-related operations on Solid Pods and the store.
2020

2121
> **new AttachmentGateway**(`fileGateway`): `AttachmentGateway`
2222
23-
Defined in: [attachments/AttachmentGateway.ts:12](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/attachments/AttachmentGateway.ts#L12)
23+
Defined in: [attachments/AttachmentGateway.ts:12](https://github.com/pod-os/PodOS/blob/main/core/src/attachments/AttachmentGateway.ts#L12)
2424

2525
#### Parameters
2626

@@ -38,7 +38,7 @@ Defined in: [attachments/AttachmentGateway.ts:12](https://github.com/pod-os/PodO
3838

3939
> **uploadAndAddAttachment**(`thing`, `attachmentFile`): `ResultAsync`\<[`NewFile`](../interfaces/NewFile.md), [`NetworkProblem`](../interfaces/NetworkProblem.md) \| [`HttpProblem`](../interfaces/HttpProblem.md)\>
4040
41-
Defined in: [attachments/AttachmentGateway.ts:23](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/attachments/AttachmentGateway.ts#L23)
41+
Defined in: [attachments/AttachmentGateway.ts:23](https://github.com/pod-os/PodOS/blob/main/core/src/attachments/AttachmentGateway.ts#L23)
4242

4343
Uploads an attachment file and associates it with a thing.
4444
The container is automatically derived from the thing's URI.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: BinaryFile
88

9-
Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BinaryFile.ts#L3)
9+
Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/main/core/src/files/BinaryFile.ts#L3)
1010

1111
## Implements
1212

@@ -18,7 +18,7 @@ Defined in: [files/BinaryFile.ts:3](https://github.com/pod-os/PodOS/blob/e80e47e
1818

1919
> **new BinaryFile**(`url`, `data`): `BinaryFile`
2020
21-
Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BinaryFile.ts#L4)
21+
Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/main/core/src/files/BinaryFile.ts#L4)
2222

2323
#### Parameters
2424

@@ -40,7 +40,7 @@ Defined in: [files/BinaryFile.ts:4](https://github.com/pod-os/PodOS/blob/e80e47e
4040

4141
> `readonly` **url**: `string`
4242
43-
Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BinaryFile.ts#L5)
43+
Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/main/core/src/files/BinaryFile.ts#L5)
4444

4545
#### Implementation of
4646

@@ -52,7 +52,7 @@ Defined in: [files/BinaryFile.ts:5](https://github.com/pod-os/PodOS/blob/e80e47e
5252

5353
> **blob**(): `Blob`
5454
55-
Defined in: [files/BinaryFile.ts:9](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BinaryFile.ts#L9)
55+
Defined in: [files/BinaryFile.ts:9](https://github.com/pod-os/PodOS/blob/main/core/src/files/BinaryFile.ts#L9)
5656

5757
#### Returns
5858

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: BrokenFile
88

9-
Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BrokenFile.ts#L4)
9+
Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/main/core/src/files/BrokenFile.ts#L4)
1010

1111
## Implements
1212

@@ -18,7 +18,7 @@ Defined in: [files/BrokenFile.ts:4](https://github.com/pod-os/PodOS/blob/e80e47e
1818

1919
> **new BrokenFile**(`url`, `status`): `BrokenFile`
2020
21-
Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BrokenFile.ts#L5)
21+
Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/main/core/src/files/BrokenFile.ts#L5)
2222

2323
#### Parameters
2424

@@ -40,15 +40,15 @@ Defined in: [files/BrokenFile.ts:5](https://github.com/pod-os/PodOS/blob/e80e47e
4040

4141
> `readonly` **status**: [`HttpStatus`](HttpStatus.md)
4242
43-
Defined in: [files/BrokenFile.ts:7](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BrokenFile.ts#L7)
43+
Defined in: [files/BrokenFile.ts:7](https://github.com/pod-os/PodOS/blob/main/core/src/files/BrokenFile.ts#L7)
4444

4545
***
4646

4747
### url
4848

4949
> `readonly` **url**: `string`
5050
51-
Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BrokenFile.ts#L6)
51+
Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/main/core/src/files/BrokenFile.ts#L6)
5252

5353
#### Implementation of
5454

@@ -60,7 +60,7 @@ Defined in: [files/BrokenFile.ts:6](https://github.com/pod-os/PodOS/blob/e80e47e
6060

6161
> **blob**(): `Blob` \| `null`
6262
63-
Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BrokenFile.ts#L14)
63+
Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/main/core/src/files/BrokenFile.ts#L14)
6464

6565
#### Returns
6666

@@ -76,7 +76,7 @@ Defined in: [files/BrokenFile.ts:14](https://github.com/pod-os/PodOS/blob/e80e47
7676

7777
> **toString**(): `string`
7878
79-
Defined in: [files/BrokenFile.ts:10](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/BrokenFile.ts#L10)
79+
Defined in: [files/BrokenFile.ts:10](https://github.com/pod-os/PodOS/blob/main/core/src/files/BrokenFile.ts#L10)
8080

8181
Returns a string representation of an object.
8282

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: FileFetcher
88

9-
Defined in: [files/FileFetcher.ts:20](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileFetcher.ts#L20)
9+
Defined in: [files/FileFetcher.ts:20](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileFetcher.ts#L20)
1010

1111
Handles HTTP operations for files, like fetching and updating file contents.
1212

@@ -16,7 +16,7 @@ Handles HTTP operations for files, like fetching and updating file contents.
1616

1717
> **new FileFetcher**(`session`): `FileFetcher`
1818
19-
Defined in: [files/FileFetcher.ts:21](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileFetcher.ts#L21)
19+
Defined in: [files/FileFetcher.ts:21](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileFetcher.ts#L21)
2020

2121
#### Parameters
2222

@@ -34,7 +34,7 @@ Defined in: [files/FileFetcher.ts:21](https://github.com/pod-os/PodOS/blob/e80e4
3434

3535
> **createNewFile**(`container`, `name`): `ResultAsync`\<[`NewFile`](../interfaces/NewFile.md), `NotCreated`\>
3636
37-
Defined in: [files/FileFetcher.ts:57](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileFetcher.ts#L57)
37+
Defined in: [files/FileFetcher.ts:57](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileFetcher.ts#L57)
3838

3939
#### Parameters
4040

@@ -56,7 +56,7 @@ Defined in: [files/FileFetcher.ts:57](https://github.com/pod-os/PodOS/blob/e80e4
5656

5757
> **createNewFolder**(`container`, `name`): `ResultAsync`\<[`NewFolder`](../interfaces/NewFolder.md), `NotCreated`\>
5858
59-
Defined in: [files/FileFetcher.ts:91](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileFetcher.ts#L91)
59+
Defined in: [files/FileFetcher.ts:91](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileFetcher.ts#L91)
6060

6161
#### Parameters
6262

@@ -78,7 +78,7 @@ Defined in: [files/FileFetcher.ts:91](https://github.com/pod-os/PodOS/blob/e80e4
7878

7979
> **fetchFile**(`url`): `Promise`\<[`SolidFile`](../interfaces/SolidFile.md)\>
8080
81-
Defined in: [files/FileFetcher.ts:28](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileFetcher.ts#L28)
81+
Defined in: [files/FileFetcher.ts:28](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileFetcher.ts#L28)
8282

8383
Fetch the contents of the given file
8484

@@ -102,7 +102,7 @@ An object representing the fetched file
102102

103103
> **putFile**(`file`, `newContent`): `Promise`\<`Response`\>
104104
105-
Defined in: [files/FileFetcher.ts:47](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileFetcher.ts#L47)
105+
Defined in: [files/FileFetcher.ts:47](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileFetcher.ts#L47)
106106

107107
Updates the contents of a file (overrides old content with the given one)
108108

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: FileGateway
88

9-
Defined in: [files/FileGateway.ts:13](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileGateway.ts#L13)
9+
Defined in: [files/FileGateway.ts:13](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileGateway.ts#L13)
1010

1111
Gateway for file-related operations on Solid Pods and the store.
1212

@@ -20,7 +20,7 @@ Gateway for file-related operations on Solid Pods and the store.
2020

2121
> **new FileGateway**(`store`, `fileFetcher`): `FileGateway`
2222
23-
Defined in: [files/FileGateway.ts:14](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileGateway.ts#L14)
23+
Defined in: [files/FileGateway.ts:14](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileGateway.ts#L14)
2424

2525
#### Parameters
2626

@@ -42,7 +42,7 @@ Defined in: [files/FileGateway.ts:14](https://github.com/pod-os/PodOS/blob/e80e4
4242

4343
> **uploadAndLinkFile**(`thing`, `predicateUri`, `fileToUpload`): `ResultAsync`\<[`NewFile`](../interfaces/NewFile.md), [`NetworkProblem`](../interfaces/NetworkProblem.md) \| [`HttpProblem`](../interfaces/HttpProblem.md)\>
4444
45-
Defined in: [files/FileGateway.ts:29](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/FileGateway.ts#L29)
45+
Defined in: [files/FileGateway.ts:29](https://github.com/pod-os/PodOS/blob/main/core/src/files/FileGateway.ts#L29)
4646

4747
Uploads a file and associates it with a thing.
4848
The container is automatically derived from the thing's URI.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
# Class: HttpStatus
88

9-
Defined in: [files/HttpStatus.ts:1](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/HttpStatus.ts#L1)
9+
Defined in: [files/HttpStatus.ts:1](https://github.com/pod-os/PodOS/blob/main/core/src/files/HttpStatus.ts#L1)
1010

1111
## Constructors
1212

1313
### Constructor
1414

1515
> **new HttpStatus**(`code`, `text?`): `HttpStatus`
1616
17-
Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/HttpStatus.ts#L2)
17+
Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/main/core/src/files/HttpStatus.ts#L2)
1818

1919
#### Parameters
2020

@@ -36,23 +36,23 @@ Defined in: [files/HttpStatus.ts:2](https://github.com/pod-os/PodOS/blob/e80e47e
3636

3737
> `readonly` **code**: `number`
3838
39-
Defined in: [files/HttpStatus.ts:3](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/HttpStatus.ts#L3)
39+
Defined in: [files/HttpStatus.ts:3](https://github.com/pod-os/PodOS/blob/main/core/src/files/HttpStatus.ts#L3)
4040

4141
***
4242

4343
### text?
4444

4545
> `readonly` `optional` **text**: `string`
4646
47-
Defined in: [files/HttpStatus.ts:4](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/HttpStatus.ts#L4)
47+
Defined in: [files/HttpStatus.ts:4](https://github.com/pod-os/PodOS/blob/main/core/src/files/HttpStatus.ts#L4)
4848

4949
## Methods
5050

5151
### toString()
5252

5353
> **toString**(): `string`
5454
55-
Defined in: [files/HttpStatus.ts:7](https://github.com/pod-os/PodOS/blob/e80e47e090ea2a3c5a790a9e1634789ca61341b8/core/src/files/HttpStatus.ts#L7)
55+
Defined in: [files/HttpStatus.ts:7](https://github.com/pod-os/PodOS/blob/main/core/src/files/HttpStatus.ts#L7)
5656

5757
#### Returns
5858

0 commit comments

Comments
 (0)