Skip to content

Commit

Permalink
docs: update documentation and API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
weyoss committed Mar 24, 2024
1 parent 2c5edbd commit 3baaee6
Show file tree
Hide file tree
Showing 85 changed files with 5,414 additions and 1,198 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Expand Up @@ -19,6 +19,7 @@ See [API Reference](api/README.md) for more details.
- [Exchanges and Delivery Models](exchanges-and-delivery-models.md)
- [Scheduling Messages](scheduling-messages.md)
- [Message Handler Worker Threads](message-handler-worker-threads.md)
- [EventBus](event-bus.md)
- [Multiplexing](multiplexing.md)
- [Performance](performance.md)
- [RedisSMQ Architecture](redis-smq-architecture.md)
Expand Down
286 changes: 173 additions & 113 deletions docs/api/README.md

Large diffs are not rendered by default.

192 changes: 155 additions & 37 deletions docs/api/classes/Consumer.md
Expand Up @@ -4,7 +4,7 @@

## Hierarchy

- `Base`
- `Runnable`\<[`TConsumerEvent`](../README.md#tconsumerevent)\>

**`Consumer`**

Expand All @@ -18,36 +18,40 @@

- [cancel](Consumer.md#cancel)
- [consume](Consumer.md#consume)
- [emit](Consumer.md#emit)
- [getId](Consumer.md#getid)
- [getQueues](Consumer.md#getqueues)
- [handleError](Consumer.md#handleerror)
- [isDown](Consumer.md#isdown)
- [isGoingDown](Consumer.md#isgoingdown)
- [isGoingUp](Consumer.md#isgoingup)
- [isRunning](Consumer.md#isrunning)
- [isUp](Consumer.md#isup)
- [on](Consumer.md#on)
- [once](Consumer.md#once)
- [removeAllListeners](Consumer.md#removealllisteners)
- [removeListener](Consumer.md#removelistener)
- [run](Consumer.md#run)
- [shutdown](Consumer.md#shutdown)

## Constructors

### constructor

**new Consumer**(`useMultiplexing?`): [`Consumer`](Consumer.md)
**new Consumer**(`enableMultiplexing?`): [`Consumer`](Consumer.md)

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `useMultiplexing` | `boolean` | `false` |
| Name | Type |
| :------ | :------ |
| `enableMultiplexing?` | `boolean` |

#### Returns

[`Consumer`](Consumer.md)

#### Overrides

Base.constructor
Runnable\&lt;TConsumerEvent\&gt;.constructor

## Methods

Expand Down Expand Up @@ -86,47 +90,54 @@ ___

___

### getId
### emit

**getId**(): `string`
**emit**\<`E`\>(`event`, `...args`): `boolean`

#### Type parameters

| Name | Type |
| :------ | :------ |
| `E` | extends keyof [`TConsumerEvent`](../README.md#tconsumerevent) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `event` | `E` |
| `...args` | `Parameters`\<[`TConsumerEvent`](../README.md#tconsumerevent)[`E`]\> |

#### Returns

`string`
`boolean`

#### Inherited from

Base.getId
Runnable.emit

___

### getQueues
### getId

**getQueues**(): [`IQueueParsedParams`](../interfaces/IQueueParsedParams.md)[]
**getId**(): `string`

#### Returns

[`IQueueParsedParams`](../interfaces/IQueueParsedParams.md)[]
`string`

___
#### Inherited from

### handleError
Runnable.getId

**handleError**(`err`): `void`
___

#### Parameters
### getQueues

| Name | Type |
| :------ | :------ |
| `err` | `Error` |
**getQueues**(): [`IQueueParsedParams`](../interfaces/IQueueParsedParams.md)[]

#### Returns

`void`

#### Inherited from

Base.handleError
[`IQueueParsedParams`](../interfaces/IQueueParsedParams.md)[]

___

Expand All @@ -140,7 +151,7 @@ ___

#### Inherited from

Base.isDown
Runnable.isDown

___

Expand All @@ -154,7 +165,7 @@ ___

#### Inherited from

Base.isGoingDown
Runnable.isGoingDown

___

Expand All @@ -168,7 +179,7 @@ ___

#### Inherited from

Base.isGoingUp
Runnable.isGoingUp

___

Expand All @@ -182,7 +193,7 @@ ___

#### Inherited from

Base.isRunning
Runnable.isRunning

___

Expand All @@ -196,44 +207,151 @@ ___

#### Inherited from

Base.isUp
Runnable.isUp

___

### on

**on**\<`E`\>(`event`, `listener`): [`Consumer`](Consumer.md)

#### Type parameters

| Name | Type |
| :------ | :------ |
| `E` | extends keyof [`TConsumerEvent`](../README.md#tconsumerevent) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `event` | `E` |
| `listener` | [`TConsumerEvent`](../README.md#tconsumerevent)[`E`] |

#### Returns

[`Consumer`](Consumer.md)

#### Inherited from

Runnable.on

___

### once

**once**\<`E`\>(`event`, `listener`): [`Consumer`](Consumer.md)

#### Type parameters

| Name | Type |
| :------ | :------ |
| `E` | extends keyof [`TConsumerEvent`](../README.md#tconsumerevent) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `event` | `E` |
| `listener` | [`TConsumerEvent`](../README.md#tconsumerevent)[`E`] |

#### Returns

[`Consumer`](Consumer.md)

#### Inherited from

Runnable.once

___

### removeAllListeners

**removeAllListeners**\<`E`\>(`event?`): [`Consumer`](Consumer.md)

#### Type parameters

| Name | Type |
| :------ | :------ |
| `E` | extends keyof [`TConsumerEvent`](../README.md#tconsumerevent) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `event?` | `Extract`\<`E`, `string`\> |

#### Returns

[`Consumer`](Consumer.md)

#### Inherited from

Runnable.removeAllListeners

___

### removeListener

**removeListener**\<`E`\>(`event`, `listener`): [`Consumer`](Consumer.md)

#### Type parameters

| Name | Type |
| :------ | :------ |
| `E` | extends keyof [`TConsumerEvent`](../README.md#tconsumerevent) |

#### Parameters

| Name | Type |
| :------ | :------ |
| `event` | `E` |
| `listener` | [`TConsumerEvent`](../README.md#tconsumerevent)[`E`] |

#### Returns

[`Consumer`](Consumer.md)

#### Inherited from

Runnable.removeListener

___

### run

**run**(`cb?`): `void`
**run**(`cb`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `cb?` | `ICallback`\<`boolean`\> |
| `cb` | `ICallback`\<`boolean`\> |

#### Returns

`void`

#### Inherited from

Base.run
Runnable.run

___

### shutdown

**shutdown**(`cb?`): `void`
**shutdown**(`cb`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `cb?` | `ICallback`\<`boolean`\> |
| `cb` | `ICallback`\<`void`\> |

#### Returns

`void`

#### Inherited from

Base.shutdown
Runnable.shutdown

0 comments on commit 3baaee6

Please sign in to comment.