Skip to content

Commit

Permalink
docs: update API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
weyoss committed Mar 23, 2024
1 parent f9120de commit e79899a
Show file tree
Hide file tree
Showing 39 changed files with 322 additions and 2,373 deletions.
123 changes: 103 additions & 20 deletions docs/api/README.md
Expand Up @@ -8,8 +8,9 @@

- [ELuaScriptName](enums/ELuaScriptName.md)
- [ERedisConfigClient](enums/ERedisConfigClient.md)
- [EWorkerThreadExecutionCode](enums/EWorkerThreadExecutionCode.md)
- [EWorkerThreadExitCode](enums/EWorkerThreadExitCode.md)
- [EWorkerThreadChildExecutionCode](enums/EWorkerThreadChildExecutionCode.md)
- [EWorkerThreadChildExitCode](enums/EWorkerThreadChildExitCode.md)
- [EWorkerThreadParentMessage](enums/EWorkerThreadParentMessage.md)
- [EWorkerType](enums/EWorkerType.md)

### Classes
Expand Down Expand Up @@ -64,8 +65,8 @@
- [IRedisConfigNodeRedis](interfaces/IRedisConfigNodeRedis.md)
- [IRedisTransaction](interfaces/IRedisTransaction.md)
- [IWorkerCallable](interfaces/IWorkerCallable.md)
- [IWorkerData](interfaces/IWorkerData.md)
- [IWorkerRunnable](interfaces/IWorkerRunnable.md)
- [IWorkerThreadData](interfaces/IWorkerThreadData.md)

### Type Aliases

Expand All @@ -80,11 +81,17 @@
- [TTimer](README.md#ttimer)
- [TTimerEvent](README.md#ttimerevent)
- [TUnaryFunction](README.md#tunaryfunction)
- [TWorkerFn](README.md#tworkerfn)
- [TWorkerCallableFunction](README.md#tworkercallablefunction)
- [TWorkerFunction](README.md#tworkerfunction)
- [TWorkerResourceGroupEvent](README.md#tworkerresourcegroupevent)
- [TWorkerThreadError](README.md#tworkerthreaderror)
- [TWorkerThreadMessage](README.md#tworkerthreadmessage)
- [TWorkerThreadMessageCode](README.md#tworkerthreadmessagecode)
- [TWorkerRunnableFunctionFactory](README.md#tworkerrunnablefunctionfactory)
- [TWorkerThreadChildError](README.md#tworkerthreadchilderror)
- [TWorkerThreadChildMessage](README.md#tworkerthreadchildmessage)
- [TWorkerThreadChildMessageCode](README.md#tworkerthreadchildmessagecode)
- [TWorkerThreadParentMessage](README.md#tworkerthreadparentmessage)
- [TWorkerThreadParentMessageCall](README.md#tworkerthreadparentmessagecall)
- [TWorkerThreadParentMessageRun](README.md#tworkerthreadparentmessagerun)
- [TWorkerThreadParentMessageShutdown](README.md#tworkerthreadparentmessageshutdown)

### Variables

Expand Down Expand Up @@ -240,26 +247,33 @@ ___

___

### TWorkerFn
### TWorkerCallableFunction

Ƭ **TWorkerFn**: (...`args`: [...any[], [`ICallback`](interfaces/ICallback.md)\<`any`\>]) => `void`
Ƭ **TWorkerCallableFunction**: (`args`: `unknown`, `cb`: [`ICallback`](interfaces/ICallback.md)\<`unknown`\>) => `void`

#### Type declaration

▸ (`...args`): `void`
▸ (`args`, `cb`): `void`

##### Parameters

| Name | Type |
| :------ | :------ |
| `...args` | [...any[], [`ICallback`](interfaces/ICallback.md)\<`any`\>] |
| `args` | `unknown` |
| `cb` | [`ICallback`](interfaces/ICallback.md)\<`unknown`\> |

##### Returns

`void`

___

### TWorkerFunction

Ƭ **TWorkerFunction**: [`TWorkerRunnableFunctionFactory`](README.md#tworkerrunnablefunctionfactory) \| [`TWorkerCallableFunction`](README.md#tworkercallablefunction)

___

### TWorkerResourceGroupEvent

Ƭ **TWorkerResourceGroupEvent**: `Object`
Expand All @@ -272,9 +286,29 @@ ___

___

### TWorkerThreadError
### TWorkerRunnableFunctionFactory

Ƭ **TWorkerRunnableFunctionFactory**: (`initialPayload`: `unknown`) => [`IWorkerRunnable`](interfaces/IWorkerRunnable.md)

#### Type declaration

▸ (`initialPayload`): [`IWorkerRunnable`](interfaces/IWorkerRunnable.md)

##### Parameters

| Name | Type |
| :------ | :------ |
| `initialPayload` | `unknown` |

##### Returns

[`IWorkerRunnable`](interfaces/IWorkerRunnable.md)

___

### TWorkerThreadChildError

Ƭ **TWorkerThreadError**: `Object`
Ƭ **TWorkerThreadChildError**: `Object`

#### Type declaration

Expand All @@ -285,23 +319,72 @@ ___

___

### TWorkerThreadMessage
### TWorkerThreadChildMessage

Ƭ **TWorkerThreadChildMessage**\<`Data`\>: `Object`

#### Type parameters

Ƭ **TWorkerThreadMessage**: `Object`
| Name | Type |
| :------ | :------ |
| `Data` | `unknown` |

#### Type declaration

| Name | Type |
| :------ | :------ |
| `code` | [`TWorkerThreadMessageCode`](README.md#tworkerthreadmessagecode) |
| `data?` | `unknown` |
| `error?` | [`TWorkerThreadError`](README.md#tworkerthreaderror) \| ``null`` |
| `code` | [`TWorkerThreadChildMessageCode`](README.md#tworkerthreadchildmessagecode) |
| `data?` | `Data` |
| `error?` | [`TWorkerThreadChildError`](README.md#tworkerthreadchilderror) \| ``null`` |

___

### TWorkerThreadChildMessageCode

Ƭ **TWorkerThreadChildMessageCode**: [`EWorkerThreadChildExitCode`](enums/EWorkerThreadChildExitCode.md) \| [`EWorkerThreadChildExecutionCode`](enums/EWorkerThreadChildExecutionCode.md)

___

### TWorkerThreadMessageCode
### TWorkerThreadParentMessage

Ƭ **TWorkerThreadMessageCode**: [`EWorkerThreadExitCode`](enums/EWorkerThreadExitCode.md) \| [`EWorkerThreadExecutionCode`](enums/EWorkerThreadExecutionCode.md)
Ƭ **TWorkerThreadParentMessage**: [`TWorkerThreadParentMessageCall`](README.md#tworkerthreadparentmessagecall) \| [`TWorkerThreadParentMessageRun`](README.md#tworkerthreadparentmessagerun) \| [`TWorkerThreadParentMessageShutdown`](README.md#tworkerthreadparentmessageshutdown)

___

### TWorkerThreadParentMessageCall

Ƭ **TWorkerThreadParentMessageCall**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `payload` | `unknown` |
| `type` | [`CALL`](enums/EWorkerThreadParentMessage.md#call) |

___

### TWorkerThreadParentMessageRun

Ƭ **TWorkerThreadParentMessageRun**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `type` | [`RUN`](enums/EWorkerThreadParentMessage.md#run) |

___

### TWorkerThreadParentMessageShutdown

Ƭ **TWorkerThreadParentMessageShutdown**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `type` | [`SHUTDOWN`](enums/EWorkerThreadParentMessage.md#shutdown) |

## Variables

Expand Down
106 changes: 0 additions & 106 deletions docs/api/classes/AbortError.md
Expand Up @@ -14,22 +14,10 @@

- [constructor](AbortError.md#constructor)

### Properties

- [cause](AbortError.md#cause)
- [message](AbortError.md#message)
- [stack](AbortError.md#stack)
- [prepareStackTrace](AbortError.md#preparestacktrace)
- [stackTraceLimit](AbortError.md#stacktracelimit)

### Accessors

- [name](AbortError.md#name)

### Methods

- [captureStackTrace](AbortError.md#capturestacktrace)

## Constructors

### constructor
Expand All @@ -50,77 +38,6 @@

[RedisSMQError](RedisSMQError.md).[constructor](RedisSMQError.md#constructor)

## Properties

### cause

`Optional` **cause**: `unknown`

#### Inherited from

[RedisSMQError](RedisSMQError.md).[cause](RedisSMQError.md#cause)

___

### message

**message**: `string`

#### Inherited from

[RedisSMQError](RedisSMQError.md).[message](RedisSMQError.md#message)

___

### stack

`Optional` **stack**: `string`

#### Inherited from

[RedisSMQError](RedisSMQError.md).[stack](RedisSMQError.md#stack)

___

### prepareStackTrace

`Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`

#### Type declaration

▸ (`err`, `stackTraces`): `any`

Optional override for formatting stack traces

##### Parameters

| Name | Type |
| :------ | :------ |
| `err` | `Error` |
| `stackTraces` | `CallSite`[] |

##### Returns

`any`

**`See`**

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

[RedisSMQError](RedisSMQError.md).[prepareStackTrace](RedisSMQError.md#preparestacktrace)

___

### stackTraceLimit

`Static` **stackTraceLimit**: `number`

#### Inherited from

[RedisSMQError](RedisSMQError.md).[stackTraceLimit](RedisSMQError.md#stacktracelimit)

## Accessors

### name
Expand All @@ -134,26 +51,3 @@ ___
#### Inherited from

RedisSMQError.name

## Methods

### captureStackTrace

**captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Create .stack property on a target object

#### Parameters

| Name | Type |
| :------ | :------ |
| `targetObject` | `object` |
| `constructorOpt?` | `Function` |

#### Returns

`void`

#### Inherited from

[RedisSMQError](RedisSMQError.md).[captureStackTrace](RedisSMQError.md#capturestacktrace)

0 comments on commit e79899a

Please sign in to comment.