Skip to content

Commit 7d8a4d2

Browse files
committed
docs: generate api reference
1 parent 29d83ce commit 7d8a4d2

46 files changed

Lines changed: 318 additions & 318 deletions

Some content is hidden

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

docs/api/classes/AppServer.md

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

77
# Class: `AppServer`
88

9-
Defined in: [src/server/server.ts:60](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L60)
9+
Defined in: [server/server.ts:60](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L60)
1010

1111
Main application server.
1212

@@ -21,7 +21,7 @@ of the server, including database, file storage, configuration, and logging.
2121
new AppServer(params?: AppServerParams): AppServer;
2222
```
2323

24-
Defined in: [src/server/server.ts:80](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L80)
24+
Defined in: [server/server.ts:80](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L80)
2525

2626
Create a new application server instance.
2727

@@ -42,17 +42,17 @@ Optional initialization parameters used to configure
4242

4343
| Property | Modifier | Type | Defined in |
4444
| :------ | :------ | :------ | :------ |
45-
| <a id="chatmanager"></a> `chatManager` | `protected` | `ChatManager` | [src/server/server.ts:65](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L65) |
46-
| <a id="config"></a> `config` | `protected` | [`ServerConfig`](../interfaces/ServerConfig.md) | [src/server/server.ts:61](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L61) |
47-
| <a id="connections"></a> `connections` | `protected` | `Map`\<`string`, `ServerResponse`\<`IncomingMessage`\>\> | [src/server/server.ts:72](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L72) |
48-
| <a id="database"></a> `database` | `protected` | [`Database`](../interfaces/Database.md) | [src/server/server.ts:62](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L62) |
49-
| <a id="engine"></a> `engine` | `protected` | `SceneEngine` | [src/server/server.ts:70](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L70) |
50-
| <a id="eventbus"></a> `eventBus` | `protected` | `EventBusClass` | [src/server/server.ts:71](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L71) |
51-
| <a id="filemanager"></a> `fileManager` | `protected` | [`FileManager`](../interfaces/FileManager.md) | [src/server/server.ts:64](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L64) |
52-
| <a id="filestorage"></a> `fileStorage` | `protected` | [`FileStorage`](../interfaces/FileStorage.md) | [src/server/server.ts:63](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L63) |
53-
| <a id="logger"></a> `logger` | `protected` | [`Logger`](../interfaces/Logger.md) | [src/server/server.ts:68](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L68) |
54-
| <a id="messagemanager"></a> `messageManager` | `protected` | `MessageManager` | [src/server/server.ts:66](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L66) |
55-
| <a id="stepmanager"></a> `stepManager` | `protected` | `StepManager` | [src/server/server.ts:67](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L67) |
45+
| <a id="chatmanager"></a> `chatManager` | `protected` | `ChatManager` | [server/server.ts:65](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L65) |
46+
| <a id="config"></a> `config` | `protected` | [`ServerConfig`](../interfaces/ServerConfig.md) | [server/server.ts:61](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L61) |
47+
| <a id="connections"></a> `connections` | `protected` | `Map`\<`string`, `ServerResponse`\<`IncomingMessage`\>\> | [server/server.ts:72](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L72) |
48+
| <a id="database"></a> `database` | `protected` | [`Database`](../interfaces/Database.md) | [server/server.ts:62](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L62) |
49+
| <a id="engine"></a> `engine` | `protected` | `SceneEngine` | [server/server.ts:70](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L70) |
50+
| <a id="eventbus"></a> `eventBus` | `protected` | `EventBusClass` | [server/server.ts:71](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L71) |
51+
| <a id="filemanager"></a> `fileManager` | `protected` | [`FileManager`](../interfaces/FileManager.md) | [server/server.ts:64](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L64) |
52+
| <a id="filestorage"></a> `fileStorage` | `protected` | [`FileStorage`](../interfaces/FileStorage.md) | [server/server.ts:63](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L63) |
53+
| <a id="logger"></a> `logger` | `protected` | [`Logger`](../interfaces/Logger.md) | [server/server.ts:68](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L68) |
54+
| <a id="messagemanager"></a> `messageManager` | `protected` | `MessageManager` | [server/server.ts:66](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L66) |
55+
| <a id="stepmanager"></a> `stepManager` | `protected` | `StepManager` | [server/server.ts:67](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L67) |
5656

5757
## Methods
5858

@@ -67,7 +67,7 @@ addScene<Steps>(command: Command, scene: {
6767
}): void;
6868
```
6969

70-
Defined in: [src/server/server.ts:222](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L222)
70+
Defined in: [server/server.ts:222](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L222)
7171

7272
Add a new scene to the application.
7373

@@ -117,7 +117,7 @@ The actual scene.
117117
getFileManager(): Promise<FileManager>;
118118
```
119119

120-
Defined in: [src/server/server.ts:237](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L237)
120+
Defined in: [server/server.ts:237](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L237)
121121

122122
Get the `FileManager` instance for managing files.
123123

@@ -132,15 +132,15 @@ A promise that resolves to the `FileManager` instance.
132132
### start()
133133

134134
```ts
135-
start(): Promise<(callback?: (err?: Error) => void) => this>;
135+
start(): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>;
136136
```
137137

138-
Defined in: [src/server/server.ts:182](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/server/server.ts#L182)
138+
Defined in: [server/server.ts:182](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/server/server.ts#L182)
139139

140-
Start the application server.
140+
Start the HTTP server.
141141

142142
#### Returns
143143

144-
`Promise`\<(`callback?`: (`err?`: `Error`) => `void`) => `this`\>
144+
`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\>
145145

146-
A function that, when called, closes the server and triggers cleanup.
146+
A new instance of the HTTP server.

docs/api/classes/DiskFileStorage.md

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

77
# Class: `DiskFileStorage`
88

9-
Defined in: [src/file/storage/disk.ts:9](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L9)
9+
Defined in: [file/storage/disk.ts:9](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L9)
1010

1111
File storage implementation that saves files to the local disk.
1212

@@ -22,7 +22,7 @@ File storage implementation that saves files to the local disk.
2222
new DiskFileStorage(storagePath?: string): DiskFileStorage;
2323
```
2424

25-
Defined in: [src/file/storage/disk.ts:17](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L17)
25+
Defined in: [file/storage/disk.ts:17](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L17)
2626

2727
Create a new disk-based file storage.
2828

@@ -42,7 +42,7 @@ Optional root directory path (defaults to `"files"`).
4242

4343
| Property | Type | Default value | Description | Defined in |
4444
| :------ | :------ | :------ | :------ | :------ |
45-
| <a id="isopen"></a> `isOpen` | `boolean` | `false` | Indicates whether the storage connection is open. | [src/file/storage/disk.ts:10](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L10) |
45+
| <a id="isopen"></a> `isOpen` | `boolean` | `false` | Indicates whether the storage connection is open. | [file/storage/disk.ts:10](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L10) |
4646

4747
## Methods
4848

@@ -52,7 +52,7 @@ Optional root directory path (defaults to `"files"`).
5252
close(): Promise<void>;
5353
```
5454

55-
Defined in: [src/file/storage/disk.ts:36](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L36)
55+
Defined in: [file/storage/disk.ts:36](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L36)
5656

5757
Close the storage connection.
5858

@@ -72,7 +72,7 @@ Close the storage connection.
7272
deleteByID(id: string): Promise<boolean>;
7373
```
7474

75-
Defined in: [src/file/storage/disk.ts:72](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L72)
75+
Defined in: [file/storage/disk.ts:72](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L72)
7676

7777
Delete a file from storage by its ID.
7878

@@ -102,7 +102,7 @@ True if deletion succeeded.
102102
download(metadata: FileMeta): Promise<ReadableStream>;
103103
```
104104

105-
Defined in: [src/file/storage/disk.ts:60](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L60)
105+
Defined in: [file/storage/disk.ts:60](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L60)
106106

107107
Download a file from storage.
108108

@@ -132,7 +132,7 @@ File content as a readable stream.
132132
open(): Promise<void>;
133133
```
134134

135-
Defined in: [src/file/storage/disk.ts:32](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L32)
135+
Defined in: [file/storage/disk.ts:32](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L32)
136136

137137
Open the storage connection.
138138

@@ -152,7 +152,7 @@ Open the storage connection.
152152
upload(bytes: ReadableStream | Buffer<ArrayBufferLike>, metadata: FileMeta): Promise<boolean>;
153153
```
154154

155-
Defined in: [src/file/storage/disk.ts:40](https://github.com/waylis/core/blob/ec4e52cc907d26692651cc5868e974b2792624f2/src/file/storage/disk.ts#L40)
155+
Defined in: [file/storage/disk.ts:40](https://github.com/waylis/core/blob/29d83ce405b1852dcce37021d7e0f727d8d40cae/src/file/storage/disk.ts#L40)
156156

157157
Upload a file into storage.
158158

0 commit comments

Comments
 (0)