Skip to content

Commit

Permalink
Changelog and docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
alicja-gruzdz committed Sep 25, 2023
1 parent b78e317 commit 3598f4f
Show file tree
Hide file tree
Showing 13 changed files with 1,919 additions and 404 deletions.
363 changes: 26 additions & 337 deletions docs/cli/commands-description.md

Large diffs are not rendered by default.

110 changes: 55 additions & 55 deletions docs/host/classes/Host.md

Large diffs are not rendered by default.

743 changes: 743 additions & 0 deletions docs/module-loader/README.md

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions docs/module-loader/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[@scramjet/module-loader](README.md) / Exports

# @scramjet/module-loader

## Table of contents

### Functions

- [loadModule](modules.md#loadmodule)

### Variables

- [logger](modules.md#logger)

## Functions

### loadModule

**loadModule**<`T`\>(`opts`): `Promise`<`T`\>

#### Type parameters

| Name |
| :------ |
| `T` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `opts` | `ModuleLoaderOpts` |

#### Returns

`Promise`<`T`\>

#### Defined in

[index.ts:5](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/module-loader/src/index.ts#L5)

## Variables

### logger

`Const` **logger**: `ObjLogger`

#### Defined in

[index.ts:4](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/module-loader/src/index.ts#L4)
743 changes: 743 additions & 0 deletions docs/monitoring-server/README.md

Large diffs are not rendered by default.

66 changes: 66 additions & 0 deletions docs/monitoring-server/classes/MonitoringServer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
[@scramjet/monitoring-server](../README.md) / [Exports](../modules.md) / MonitoringServer

# Class: MonitoringServer

## Implements

- `IMonitoringServer`

## Table of contents

### Constructors

- [constructor](MonitoringServer.md#constructor)

### Methods

- [handleHealtzRequest](MonitoringServer.md#handlehealtzrequest)
- [start](MonitoringServer.md#start)

## Constructors

### constructor

**new MonitoringServer**(`options`)

#### Parameters

| Name | Type |
| :------ | :------ |
| `options` | `MonitoringServerOptions` |

#### Defined in

[monitoring-server.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L9)

## Methods

### handleHealtzRequest

**handleHealtzRequest**(): `Promise`<`boolean`\>

#### Returns

`Promise`<`boolean`\>

#### Defined in

[monitoring-server.ts:31](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L31)

___

### start

**start**(): `Promise`<`MonitoringServerConfig`\>

#### Returns

`Promise`<`MonitoringServerConfig`\>

#### Implementation of

IMonitoringServer.start

#### Defined in

[monitoring-server.ts:35](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/monitoring-server/src/monitoring-server.ts#L35)
9 changes: 9 additions & 0 deletions docs/monitoring-server/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[@scramjet/monitoring-server](README.md) / Exports

# @scramjet/monitoring-server

## Table of contents

### Classes

- [MonitoringServer](classes/MonitoringServer.md)
96 changes: 96 additions & 0 deletions docs/symbols/enums/DisconnectHubErrors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
[@scramjet/symbols](../README.md) / [Exports](../modules.md) / DisconnectHubErrors

# Enumeration: DisconnectHubErrors

## Table of contents

### Enumeration Members

- [ALREADY\_DISCONNECTED](DisconnectHubErrors.md#already_disconnected)
- [BAD\_REQUEST](DisconnectHubErrors.md#bad_request)
- [CONFLICT](DisconnectHubErrors.md#conflict)
- [CONNECTED](DisconnectHubErrors.md#connected)
- [ID\_NOT\_PROVIDED](DisconnectHubErrors.md#id_not_provided)
- [KEY\_NOT\_FOUND](DisconnectHubErrors.md#key_not_found)
- [NATIVE\_HUB](DisconnectHubErrors.md#native_hub)
- [STH\_NOT\_FOUND](DisconnectHubErrors.md#sth_not_found)

## Enumeration Members

### ALREADY\_DISCONNECTED

**ALREADY\_DISCONNECTED** = ``7``

#### Defined in

[disconnect-error-codes.ts:9](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L9)

___

### BAD\_REQUEST

**BAD\_REQUEST** = ``2``

#### Defined in

[disconnect-error-codes.ts:4](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L4)

___

### CONFLICT

**CONFLICT** = ``3``

#### Defined in

[disconnect-error-codes.ts:5](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L5)

___

### CONNECTED

**CONNECTED** = ``6``

#### Defined in

[disconnect-error-codes.ts:8](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L8)

___

### ID\_NOT\_PROVIDED

**ID\_NOT\_PROVIDED** = ``4``

#### Defined in

[disconnect-error-codes.ts:6](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L6)

___

### KEY\_NOT\_FOUND

**KEY\_NOT\_FOUND** = ``1``

#### Defined in

[disconnect-error-codes.ts:3](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L3)

___

### NATIVE\_HUB

**NATIVE\_HUB** = ``5``

#### Defined in

[disconnect-error-codes.ts:7](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L7)

___

### STH\_NOT\_FOUND

**STH\_NOT\_FOUND** = ``0``

#### Defined in

[disconnect-error-codes.ts:2](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/symbols/src/disconnect-error-codes.ts#L2)
1 change: 1 addition & 0 deletions docs/symbols/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- [APIErrorCode](enums/APIErrorCode.md)
- [CPMMessageCode](enums/CPMMessageCode.md)
- [CommunicationChannel](enums/CommunicationChannel.md)
- [DisconnectHubErrors](enums/DisconnectHubErrors.md)
- [HostHeaders](enums/HostHeaders.md)
- [InstanceMessageCode](enums/InstanceMessageCode.md)
- [OpRecordCode](enums/OpRecordCode.md)
Expand Down
23 changes: 23 additions & 0 deletions docs/types/interfaces/IMonitoringServer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[@scramjet/types](../README.md) / [Exports](../modules.md) / IMonitoringServer

# Interface: IMonitoringServer

## Table of contents

### Methods

- [start](IMonitoringServer.md#start)

## Methods

### start

**start**(): `Promise`<[`MonitoringServerConfig`](../modules.md#monitoringserverconfig)\>

#### Returns

`Promise`<[`MonitoringServerConfig`](../modules.md#monitoringserverconfig)\>

#### Defined in

[packages/types/src/monitoring-server.ts:16](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L16)
25 changes: 25 additions & 0 deletions docs/types/interfaces/IMonitoringServerConstructor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[@scramjet/types](../README.md) / [Exports](../modules.md) / IMonitoringServerConstructor

# Interface: IMonitoringServerConstructor

## Table of contents

### Constructors

- [constructor](IMonitoringServerConstructor.md#constructor)

## Constructors

### constructor

**new IMonitoringServerConstructor**(`opts`)

#### Parameters

| Name | Type |
| :------ | :------ |
| `opts` | [`MonitoringServerOptions`](../modules.md#monitoringserveroptions) |

#### Defined in

[packages/types/src/monitoring-server.ts:20](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/types/src/monitoring-server.ts#L20)
Loading

0 comments on commit 3598f4f

Please sign in to comment.