Skip to content

Commit 3598f4f

Browse files
alicja-gruzdzalicja-gruzdz
committed
Changelog and docs update
1 parent b78e317 commit 3598f4f

File tree

13 files changed

+1919
-404
lines changed

13 files changed

+1919
-404
lines changed

‎docs/cli/commands-description.md‎

Lines changed: 26 additions & 337 deletions
Large diffs are not rendered by default.

‎docs/host/classes/Host.md‎

Lines changed: 55 additions & 55 deletions
Large diffs are not rendered by default.

‎docs/module-loader/README.md‎

Lines changed: 743 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/module-loader/modules.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[@scramjet/module-loader](README.md) / Exports
2+
3+
# @scramjet/module-loader
4+
5+
## Table of contents
6+
7+
### Functions
8+
9+
- [loadModule](modules.md#loadmodule)
10+
11+
### Variables
12+
13+
- [logger](modules.md#logger)
14+
15+
## Functions
16+
17+
### loadModule
18+
19+
▸ **loadModule**<`T`\>(`opts`): `Promise`<`T`\>
20+
21+
#### Type parameters
22+
23+
| Name |
24+
| :------ |
25+
| `T` |
26+
27+
#### Parameters
28+
29+
| Name | Type |
30+
| :------ | :------ |
31+
| `opts` | `ModuleLoaderOpts` |
32+
33+
#### Returns
34+
35+
`Promise`<`T`\>
36+
37+
#### Defined in
38+
39+
[index.ts:5](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/module-loader/src/index.ts#L5)
40+
41+
## Variables
42+
43+
### logger
44+
45+
• `Const` **logger**: `ObjLogger`
46+
47+
#### Defined in
48+
49+
[index.ts:4](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/module-loader/src/index.ts#L4)

‎docs/monitoring-server/README.md‎

Lines changed: 743 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/monitoring-server/classes/MonitoringServer.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
[@scramjet/monitoring-server](../README.md) / [Exports](../modules.md) / MonitoringServer
2+
3+
# Class: MonitoringServer
4+
5+
## Implements
6+
7+
- `IMonitoringServer`
8+
9+
## Table of contents
10+
11+
### Constructors
12+
13+
- [constructor](MonitoringServer.md#constructor)
14+
15+
### Methods
16+
17+
- [handleHealtzRequest](MonitoringServer.md#handlehealtzrequest)
18+
- [start](MonitoringServer.md#start)
19+
20+
## Constructors
21+
22+
### constructor
23+
24+
• **new MonitoringServer**(`options`)
25+
26+
#### Parameters
27+
28+
| Name | Type |
29+
| :------ | :------ |
30+
| `options` | `MonitoringServerOptions` |
31+
32+
#### Defined in
33+
34+
[monitoring-server.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L9)
35+
36+
## Methods
37+
38+
### handleHealtzRequest
39+
40+
▸ **handleHealtzRequest**(): `Promise`<`boolean`\>
41+
42+
#### Returns
43+
44+
`Promise`<`boolean`\>
45+
46+
#### Defined in
47+
48+
[monitoring-server.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L31)
49+
50+
___
51+
52+
### start
53+
54+
▸ **start**(): `Promise`<`MonitoringServerConfig`\>
55+
56+
#### Returns
57+
58+
`Promise`<`MonitoringServerConfig`\>
59+
60+
#### Implementation of
61+
62+
IMonitoringServer.start
63+
64+
#### Defined in
65+
66+
[monitoring-server.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L35)

‎docs/monitoring-server/modules.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[@scramjet/monitoring-server](README.md) / Exports
2+
3+
# @scramjet/monitoring-server
4+
5+
## Table of contents
6+
7+
### Classes
8+
9+
- [MonitoringServer](classes/MonitoringServer.md)

‎docs/symbols/enums/DisconnectHubErrors.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
[@scramjet/symbols](../README.md) / [Exports](../modules.md) / DisconnectHubErrors
2+
3+
# Enumeration: DisconnectHubErrors
4+
5+
## Table of contents
6+
7+
### Enumeration Members
8+
9+
- [ALREADY\_DISCONNECTED](DisconnectHubErrors.md#already_disconnected)
10+
- [BAD\_REQUEST](DisconnectHubErrors.md#bad_request)
11+
- [CONFLICT](DisconnectHubErrors.md#conflict)
12+
- [CONNECTED](DisconnectHubErrors.md#connected)
13+
- [ID\_NOT\_PROVIDED](DisconnectHubErrors.md#id_not_provided)
14+
- [KEY\_NOT\_FOUND](DisconnectHubErrors.md#key_not_found)
15+
- [NATIVE\_HUB](DisconnectHubErrors.md#native_hub)
16+
- [STH\_NOT\_FOUND](DisconnectHubErrors.md#sth_not_found)
17+
18+
## Enumeration Members
19+
20+
### ALREADY\_DISCONNECTED
21+
22+
• **ALREADY\_DISCONNECTED** = ``7``
23+
24+
#### Defined in
25+
26+
[disconnect-error-codes.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L9)
27+
28+
___
29+
30+
### BAD\_REQUEST
31+
32+
• **BAD\_REQUEST** = ``2``
33+
34+
#### Defined in
35+
36+
[disconnect-error-codes.ts:4](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L4)
37+
38+
___
39+
40+
### CONFLICT
41+
42+
• **CONFLICT** = ``3``
43+
44+
#### Defined in
45+
46+
[disconnect-error-codes.ts:5](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L5)
47+
48+
___
49+
50+
### CONNECTED
51+
52+
• **CONNECTED** = ``6``
53+
54+
#### Defined in
55+
56+
[disconnect-error-codes.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L8)
57+
58+
___
59+
60+
### ID\_NOT\_PROVIDED
61+
62+
• **ID\_NOT\_PROVIDED** = ``4``
63+
64+
#### Defined in
65+
66+
[disconnect-error-codes.ts:6](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L6)
67+
68+
___
69+
70+
### KEY\_NOT\_FOUND
71+
72+
• **KEY\_NOT\_FOUND** = ``1``
73+
74+
#### Defined in
75+
76+
[disconnect-error-codes.ts:3](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L3)
77+
78+
___
79+
80+
### NATIVE\_HUB
81+
82+
• **NATIVE\_HUB** = ``5``
83+
84+
#### Defined in
85+
86+
[disconnect-error-codes.ts:7](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L7)
87+
88+
___
89+
90+
### STH\_NOT\_FOUND
91+
92+
• **STH\_NOT\_FOUND** = ``0``
93+
94+
#### Defined in
95+
96+
[disconnect-error-codes.ts:2](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L2)

‎docs/symbols/modules.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [APIErrorCode](enums/APIErrorCode.md)
1010
- [CPMMessageCode](enums/CPMMessageCode.md)
1111
- [CommunicationChannel](enums/CommunicationChannel.md)
12+
- [DisconnectHubErrors](enums/DisconnectHubErrors.md)
1213
- [HostHeaders](enums/HostHeaders.md)
1314
- [InstanceMessageCode](enums/InstanceMessageCode.md)
1415
- [OpRecordCode](enums/OpRecordCode.md)

‎docs/types/interfaces/IMonitoringServer.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[@scramjet/types](../README.md) / [Exports](../modules.md) / IMonitoringServer
2+
3+
# Interface: IMonitoringServer
4+
5+
## Table of contents
6+
7+
### Methods
8+
9+
- [start](IMonitoringServer.md#start)
10+
11+
## Methods
12+
13+
### start
14+
15+
▸ **start**(): `Promise`<[`MonitoringServerConfig`](../modules.md#monitoringserverconfig)\>
16+
17+
#### Returns
18+
19+
`Promise`<[`MonitoringServerConfig`](../modules.md#monitoringserverconfig)\>
20+
21+
#### Defined in
22+
23+
[packages/types/src/monitoring-server.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L16)

0 commit comments

Comments
 (0)