diff --git a/docs/README.md b/docs/README.md index 7b4bfcf..aa2f473 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## API -See for [API](api/README.md) reference for more details. +See for [API reference](api/README.md) for more details. ## Misc diff --git a/docs/api/README.md b/docs/api/README.md index 9d22dd3..c2f637a 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -6,64 +6,95 @@ ### Enumerations +- [ELuaScriptName](enums/ELuaScriptName.md) - [ERedisConfigClient](enums/ERedisConfigClient.md) +- [EWorkerThreadExecutionCode](enums/EWorkerThreadExecutionCode.md) +- [EWorkerThreadExitCode](enums/EWorkerThreadExitCode.md) +- [EWorkerType](enums/EWorkerType.md) ### Classes +- [AbortError](classes/AbortError.md) - [CallbackEmptyReplyError](classes/CallbackEmptyReplyError.md) - [CallbackInvalidReplyError](classes/CallbackInvalidReplyError.md) +- [EventBus](classes/EventBus.md) +- [EventBusError](classes/EventBusError.md) +- [EventBusNotConnectedError](classes/EventBusNotConnectedError.md) +- [EventBusRedis](classes/EventBusRedis.md) - [EventEmitter](classes/EventEmitter.md) -- [Lock](classes/Lock.md) -- [LockAbortError](classes/LockAbortError.md) +- [IoredisClient](classes/IoredisClient.md) +- [IoredisClientMulti](classes/IoredisClientMulti.md) - [LockAcquireError](classes/LockAcquireError.md) - [LockError](classes/LockError.md) - [LockExtendError](classes/LockExtendError.md) - [LockMethodNotAllowedError](classes/LockMethodNotAllowedError.md) - [LockNotAcquiredError](classes/LockNotAcquiredError.md) -- [LockNotReleasedError](classes/LockNotReleasedError.md) +- [Locker](classes/Locker.md) - [LoggerError](classes/LoggerError.md) +- [LuaScript](classes/LuaScript.md) +- [NodeRedisClient](classes/NodeRedisClient.md) +- [NodeRedisClientMulti](classes/NodeRedisClientMulti.md) - [PanicError](classes/PanicError.md) - [PowerSwitch](classes/PowerSwitch.md) -- [RedisClient](classes/RedisClient.md) +- [RedisClientAbstract](classes/RedisClientAbstract.md) - [RedisClientError](classes/RedisClientError.md) - [RedisSMQError](classes/RedisSMQError.md) -- [Ticker](classes/Ticker.md) -- [TickerError](classes/TickerError.md) +- [Runnable](classes/Runnable.md) +- [Timer](classes/Timer.md) +- [TimerError](classes/TimerError.md) - [WatchedKeysChangedError](classes/WatchedKeysChangedError.md) -- [Worker](classes/Worker.md) +- [WorkerAlreadyDownError](classes/WorkerAlreadyDownError.md) +- [WorkerAlreadyRunningError](classes/WorkerAlreadyRunningError.md) +- [WorkerCallable](classes/WorkerCallable.md) - [WorkerError](classes/WorkerError.md) -- [WorkerPool](classes/WorkerPool.md) -- [WorkerRunner](classes/WorkerRunner.md) +- [WorkerPayloadRequiredError](classes/WorkerPayloadRequiredError.md) +- [WorkerResourceGroup](classes/WorkerResourceGroup.md) +- [WorkerRunnable](classes/WorkerRunnable.md) +- [WorkerThreadError](classes/WorkerThreadError.md) ### Interfaces - [ICallback](interfaces/ICallback.md) +- [IEventBus](interfaces/IEventBus.md) +- [IEventEmitter](interfaces/IEventEmitter.md) - [ILogger](interfaces/ILogger.md) - [ILoggerConfig](interfaces/ILoggerConfig.md) - [IRedisClient](interfaces/IRedisClient.md) - [IRedisConfigIORedis](interfaces/IRedisConfigIORedis.md) - [IRedisConfigNodeRedis](interfaces/IRedisConfigNodeRedis.md) - [IRedisTransaction](interfaces/IRedisTransaction.md) +- [IWorkerCallable](interfaces/IWorkerCallable.md) +- [IWorkerData](interfaces/IWorkerData.md) +- [IWorkerRunnable](interfaces/IWorkerRunnable.md) ### Type Aliases - [IRedisConfig](README.md#iredisconfig) -- [TEvent](README.md#tevent) +- [TEventBusEvent](README.md#teventbusevent) - [TEventEmitterEvent](README.md#teventemitterevent) - [TFunction](README.md#tfunction) +- [TLockerEvent](README.md#tlockerevent) +- [TRedisClientEvent](README.md#tredisclientevent) - [TRedisClientNodeRedis](README.md#tredisclientnoderedis) - [TRedisTransactionNodeRedis](README.md#tredistransactionnoderedis) +- [TTimer](README.md#ttimer) +- [TTimerEvent](README.md#ttimerevent) - [TUnaryFunction](README.md#tunaryfunction) +- [TWorkerFn](README.md#tworkerfn) +- [TWorkerResourceGroupEvent](README.md#tworkerresourcegroupevent) +- [TWorkerThreadError](README.md#tworkerthreaderror) +- [TWorkerThreadMessage](README.md#tworkerthreadmessage) +- [TWorkerThreadMessageCode](README.md#tworkerthreadmessagecode) ### Variables - [async](README.md#async) - [logger](README.md#logger) -- [redis](README.md#redis) ### Functions -- [getEventBusInstance](README.md#geteventbusinstance) +- [createRedisClient](README.md#createredisclient) +- [getDirname](README.md#getdirname) ## Type Aliases @@ -73,27 +104,15 @@ ___ -### TEvent +### TEventBusEvent -Ƭ **TEvent**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `down` | () => `void` | -| `error` | (`err`: `Error`) => `void` | -| `goingDown` | () => `void` | -| `goingUp` | () => `void` | -| `next` | () => `void` | -| `tick` | () => `void` | -| `up` | () => `void` | +Ƭ **TEventBusEvent**: [`TEventEmitterEvent`](README.md#teventemitterevent) & \{ `error`: (`err`: `Error`) => `void` } ___ ### TEventEmitterEvent -Ƭ **TEventEmitterEvent**: `Record`\<`string` \| `symbol`, (...`args`: `any`) => `any`\> +Ƭ **TEventEmitterEvent**: `Record`\<`string`, (...`args`: `any`[]) => `void`\> ___ @@ -124,6 +143,38 @@ ___ ___ +### TLockerEvent + +Ƭ **TLockerEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `locker.down` | (`id`: `string`) => `void` | +| `locker.error` | (`error`: `Error`, `id`: `string`) => `void` | +| `locker.goingDown` | (`id`: `string`) => `void` | +| `locker.goingUp` | (`id`: `string`) => `void` | +| `locker.up` | (`id`: `string`) => `void` | + +___ + +### TRedisClientEvent + +Ƭ **TRedisClientEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `end` | () => `void` | +| `error` | (`err`: `Error`) => `void` | +| `message` | (`channel`: `string`, `message`: `string`) => `void` | +| `pmessage` | (`pattern`: `string`, `channel`: `string`, `message`: `string`) => `void` | +| `ready` | () => `void` | + +___ + ### TRedisClientNodeRedis Ƭ **TRedisClientNodeRedis**: `RedisClientType`\<`RedisModules`, `RedisFunctions`, `RedisScripts`\> @@ -136,6 +187,32 @@ ___ ___ +### TTimer + +Ƭ **TTimer**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fn` | [`TFunction`](README.md#tfunction) | +| `periodic` | `boolean` | +| `timer` | `NodeJS.Timeout` | + +___ + +### TTimerEvent + +Ƭ **TTimerEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `error` | (`err`: `Error`) => `void` | + +___ + ### TUnaryFunction Ƭ **TUnaryFunction**\<`T`, `E`\>: (`reply`: `T`) => `E` @@ -161,6 +238,71 @@ ___ `E` +___ + +### TWorkerFn + +Ƭ **TWorkerFn**: (...`args`: [...any[], [`ICallback`](interfaces/ICallback.md)\<`any`\>]) => `void` + +#### Type declaration + +▸ (`...args`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [...any[], [`ICallback`](interfaces/ICallback.md)\<`any`\>] | + +##### Returns + +`void` + +___ + +### TWorkerResourceGroupEvent + +Ƭ **TWorkerResourceGroupEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `workerResourceGroup.error` | (`err`: `Error`) => `void` | + +___ + +### TWorkerThreadError + +Ƭ **TWorkerThreadError**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `name` | `string` | + +___ + +### TWorkerThreadMessage + +Ƭ **TWorkerThreadMessage**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | [`TWorkerThreadMessageCode`](README.md#tworkerthreadmessagecode) | +| `data?` | `unknown` | +| `error?` | [`TWorkerThreadError`](README.md#tworkerthreaderror) \| ``null`` | + +___ + +### TWorkerThreadMessageCode + +Ƭ **TWorkerThreadMessageCode**: [`EWorkerThreadExitCode`](enums/EWorkerThreadExitCode.md) \| [`EWorkerThreadExecutionCode`](enums/EWorkerThreadExecutionCode.md) + ## Variables ### async @@ -190,30 +332,29 @@ ___ | `getLogger` | (`cfg`: [`ILoggerConfig`](interfaces/ILoggerConfig.md), `ns?`: `string`) => [`ILogger`](interfaces/ILogger.md) | | `setLogger` | \(`logger`: `T`) => `void` | -___ +## Functions -### redis +### createRedisClient -• `Const` **redis**: `Object` +▸ **createRedisClient**(`config`, `cb`): `void` -#### Type declaration +#### Parameters | Name | Type | | :------ | :------ | -| `createInstance` | (`config`: [`IRedisConfig`](README.md#iredisconfig), `cb`: [`ICallback`](interfaces/ICallback.md)\<[`RedisClient`](classes/RedisClient.md)\>) => `void` | +| `config` | [`IRedisConfig`](README.md#iredisconfig) | +| `cb` | [`ICallback`](interfaces/ICallback.md)\<[`IRedisClient`](interfaces/IRedisClient.md)\> | -## Functions +#### Returns -### getEventBusInstance +`void` -▸ **getEventBusInstance**\<`T`\>(): [`EventEmitter`](classes/EventEmitter.md)\<[`TEvent`](README.md#tevent)\> +___ -#### Type parameters +### getDirname -| Name | Type | -| :------ | :------ | -| `T` | extends [`TEvent`](README.md#tevent) | +▸ **getDirname**(): `string` #### Returns -[`EventEmitter`](classes/EventEmitter.md)\<[`TEvent`](README.md#tevent)\> +`string` diff --git a/docs/api/classes/AbortError.md b/docs/api/classes/AbortError.md new file mode 100644 index 0000000..8adec04 --- /dev/null +++ b/docs/api/classes/AbortError.md @@ -0,0 +1,159 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / AbortError + +# Class: AbortError + +## Hierarchy + +- [`RedisSMQError`](RedisSMQError.md) + + ↳ **`AbortError`** + +## Table of contents + +### Constructors + +- [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 + +• **new AbortError**(`message?`): [`AbortError`](AbortError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`AbortError`](AbortError.md) + +#### Inherited from + +[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 + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### 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) diff --git a/docs/api/classes/CallbackEmptyReplyError.md b/docs/api/classes/CallbackEmptyReplyError.md index 491276a..550f2f6 100644 --- a/docs/api/classes/CallbackEmptyReplyError.md +++ b/docs/api/classes/CallbackEmptyReplyError.md @@ -4,7 +4,7 @@ ## Hierarchy -- [`RedisSMQError`](RedisSMQError.md) +- [`PanicError`](PanicError.md) ↳ **`CallbackEmptyReplyError`** @@ -14,10 +14,22 @@ - [constructor](CallbackEmptyReplyError.md#constructor) +### Properties + +- [cause](CallbackEmptyReplyError.md#cause) +- [message](CallbackEmptyReplyError.md#message) +- [stack](CallbackEmptyReplyError.md#stack) +- [prepareStackTrace](CallbackEmptyReplyError.md#preparestacktrace) +- [stackTraceLimit](CallbackEmptyReplyError.md#stacktracelimit) + ### Accessors - [name](CallbackEmptyReplyError.md#name) +### Methods + +- [captureStackTrace](CallbackEmptyReplyError.md#capturestacktrace) + ## Constructors ### constructor @@ -30,7 +42,78 @@ #### Overrides -[RedisSMQError](RedisSMQError.md).[constructor](RedisSMQError.md#constructor) +[PanicError](PanicError.md).[constructor](PanicError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[PanicError](PanicError.md).[cause](PanicError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[PanicError](PanicError.md).[message](PanicError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[PanicError](PanicError.md).[stack](PanicError.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 + +[PanicError](PanicError.md).[prepareStackTrace](PanicError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[PanicError](PanicError.md).[stackTraceLimit](PanicError.md#stacktracelimit) ## Accessors @@ -44,4 +127,27 @@ #### Inherited from -RedisSMQError.name +PanicError.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 + +[PanicError](PanicError.md).[captureStackTrace](PanicError.md#capturestacktrace) diff --git a/docs/api/classes/CallbackInvalidReplyError.md b/docs/api/classes/CallbackInvalidReplyError.md index 097d4b3..8aab18a 100644 --- a/docs/api/classes/CallbackInvalidReplyError.md +++ b/docs/api/classes/CallbackInvalidReplyError.md @@ -4,7 +4,7 @@ ## Hierarchy -- [`RedisSMQError`](RedisSMQError.md) +- [`PanicError`](PanicError.md) ↳ **`CallbackInvalidReplyError`** @@ -14,10 +14,22 @@ - [constructor](CallbackInvalidReplyError.md#constructor) +### Properties + +- [cause](CallbackInvalidReplyError.md#cause) +- [message](CallbackInvalidReplyError.md#message) +- [stack](CallbackInvalidReplyError.md#stack) +- [prepareStackTrace](CallbackInvalidReplyError.md#preparestacktrace) +- [stackTraceLimit](CallbackInvalidReplyError.md#stacktracelimit) + ### Accessors - [name](CallbackInvalidReplyError.md#name) +### Methods + +- [captureStackTrace](CallbackInvalidReplyError.md#capturestacktrace) + ## Constructors ### constructor @@ -30,7 +42,78 @@ #### Overrides -[RedisSMQError](RedisSMQError.md).[constructor](RedisSMQError.md#constructor) +[PanicError](PanicError.md).[constructor](PanicError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[PanicError](PanicError.md).[cause](PanicError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[PanicError](PanicError.md).[message](PanicError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[PanicError](PanicError.md).[stack](PanicError.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 + +[PanicError](PanicError.md).[prepareStackTrace](PanicError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[PanicError](PanicError.md).[stackTraceLimit](PanicError.md#stacktracelimit) ## Accessors @@ -44,4 +127,27 @@ #### Inherited from -RedisSMQError.name +PanicError.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 + +[PanicError](PanicError.md).[captureStackTrace](PanicError.md#capturestacktrace) diff --git a/docs/api/classes/EventBus.md b/docs/api/classes/EventBus.md new file mode 100644 index 0000000..2858d98 --- /dev/null +++ b/docs/api/classes/EventBus.md @@ -0,0 +1,227 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EventBus + +# Class: EventBus\ + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Events` | extends [`TEventBusEvent`](../README.md#teventbusevent) | + +## Hierarchy + +- [`EventEmitter`](EventEmitter.md)\<`Events`\> + + ↳ **`EventBus`** + +## Implements + +- [`IEventBus`](../interfaces/IEventBus.md)\<`Events`\> + +## Table of contents + +### Methods + +- [emit](EventBus.md#emit) +- [on](EventBus.md#on) +- [once](EventBus.md#once) +- [removeAllListeners](EventBus.md#removealllisteners) +- [removeListener](EventBus.md#removelistener) +- [shutDown](EventBus.md#shutdown) +- [createInstance](EventBus.md#createinstance) + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`Events`[`E`]\> | + +#### Returns + +`boolean` + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[emit](../interfaces/IEventBus.md#emit) + +#### Overrides + +[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`EventBus`](EventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`EventBus`](EventBus.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[on](../interfaces/IEventBus.md#on) + +#### Overrides + +[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`EventBus`](EventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`EventBus`](EventBus.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[once](../interfaces/IEventBus.md#once) + +#### Overrides + +[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`EventBus`](EventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`EventBus`](EventBus.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[removeAllListeners](../interfaces/IEventBus.md#removealllisteners) + +#### Overrides + +[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`EventBus`](EventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`EventBus`](EventBus.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[removeListener](../interfaces/IEventBus.md#removelistener) + +#### Overrides + +[EventEmitter](EventEmitter.md).[removeListener](EventEmitter.md#removelistener) + +___ + +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[shutDown](../interfaces/IEventBus.md#shutdown) + +___ + +### createInstance + +▸ **createInstance**\<`T`\>(`cb`): `void` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`TEventBusEvent`](../README.md#teventbusevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<[`IEventBus`](../interfaces/IEventBus.md)\<`T`\>\> | + +#### Returns + +`void` diff --git a/docs/api/classes/EventBusError.md b/docs/api/classes/EventBusError.md new file mode 100644 index 0000000..a29aaa5 --- /dev/null +++ b/docs/api/classes/EventBusError.md @@ -0,0 +1,161 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EventBusError + +# Class: EventBusError + +## Hierarchy + +- [`RedisSMQError`](RedisSMQError.md) + + ↳ **`EventBusError`** + + ↳↳ [`EventBusNotConnectedError`](EventBusNotConnectedError.md) + +## Table of contents + +### Constructors + +- [constructor](EventBusError.md#constructor) + +### Properties + +- [cause](EventBusError.md#cause) +- [message](EventBusError.md#message) +- [stack](EventBusError.md#stack) +- [prepareStackTrace](EventBusError.md#preparestacktrace) +- [stackTraceLimit](EventBusError.md#stacktracelimit) + +### Accessors + +- [name](EventBusError.md#name) + +### Methods + +- [captureStackTrace](EventBusError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new EventBusError**(`message?`): [`EventBusError`](EventBusError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`EventBusError`](EventBusError.md) + +#### Inherited from + +[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 + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### 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) diff --git a/docs/api/classes/EventBusNotConnectedError.md b/docs/api/classes/EventBusNotConnectedError.md new file mode 100644 index 0000000..388ffdb --- /dev/null +++ b/docs/api/classes/EventBusNotConnectedError.md @@ -0,0 +1,159 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EventBusNotConnectedError + +# Class: EventBusNotConnectedError + +## Hierarchy + +- [`EventBusError`](EventBusError.md) + + ↳ **`EventBusNotConnectedError`** + +## Table of contents + +### Constructors + +- [constructor](EventBusNotConnectedError.md#constructor) + +### Properties + +- [cause](EventBusNotConnectedError.md#cause) +- [message](EventBusNotConnectedError.md#message) +- [stack](EventBusNotConnectedError.md#stack) +- [prepareStackTrace](EventBusNotConnectedError.md#preparestacktrace) +- [stackTraceLimit](EventBusNotConnectedError.md#stacktracelimit) + +### Accessors + +- [name](EventBusNotConnectedError.md#name) + +### Methods + +- [captureStackTrace](EventBusNotConnectedError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new EventBusNotConnectedError**(`message?`): [`EventBusNotConnectedError`](EventBusNotConnectedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`EventBusNotConnectedError`](EventBusNotConnectedError.md) + +#### Inherited from + +[EventBusError](EventBusError.md).[constructor](EventBusError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[EventBusError](EventBusError.md).[cause](EventBusError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[EventBusError](EventBusError.md).[message](EventBusError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[EventBusError](EventBusError.md).[stack](EventBusError.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 + +[EventBusError](EventBusError.md).[prepareStackTrace](EventBusError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[EventBusError](EventBusError.md).[stackTraceLimit](EventBusError.md#stacktracelimit) + +## Accessors + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Inherited from + +EventBusError.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 + +[EventBusError](EventBusError.md).[captureStackTrace](EventBusError.md#capturestacktrace) diff --git a/docs/api/classes/EventBusRedis.md b/docs/api/classes/EventBusRedis.md new file mode 100644 index 0000000..38cf6f5 --- /dev/null +++ b/docs/api/classes/EventBusRedis.md @@ -0,0 +1,228 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EventBusRedis + +# Class: EventBusRedis\ + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Events` | extends [`TEventBusEvent`](../README.md#teventbusevent) | + +## Hierarchy + +- [`EventEmitter`](EventEmitter.md)\<`Events`\> + + ↳ **`EventBusRedis`** + +## Implements + +- [`IEventBus`](../interfaces/IEventBus.md)\<`Events`\> + +## Table of contents + +### Methods + +- [emit](EventBusRedis.md#emit) +- [on](EventBusRedis.md#on) +- [once](EventBusRedis.md#once) +- [removeAllListeners](EventBusRedis.md#removealllisteners) +- [removeListener](EventBusRedis.md#removelistener) +- [shutDown](EventBusRedis.md#shutdown) +- [createInstance](EventBusRedis.md#createinstance) + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`Events`[`E`]\> | + +#### Returns + +`boolean` + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[emit](../interfaces/IEventBus.md#emit) + +#### Overrides + +[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[on](../interfaces/IEventBus.md#on) + +#### Overrides + +[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[once](../interfaces/IEventBus.md#once) + +#### Overrides + +[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[removeAllListeners](../interfaces/IEventBus.md#removealllisteners) + +#### Overrides + +[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`EventBusRedis`](EventBusRedis.md)\<`Events`\> + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[removeListener](../interfaces/IEventBus.md#removelistener) + +#### Overrides + +[EventEmitter](EventEmitter.md).[removeListener](EventEmitter.md#removelistener) + +___ + +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Implementation of + +[IEventBus](../interfaces/IEventBus.md).[shutDown](../interfaces/IEventBus.md#shutdown) + +___ + +### createInstance + +▸ **createInstance**\<`T`\>(`config`, `cb`): `void` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`TEventBusEvent`](../README.md#teventbusevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`IRedisConfig`](../README.md#iredisconfig) | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<[`IEventBus`](../interfaces/IEventBus.md)\<`T`\>\> | + +#### Returns + +`void` diff --git a/docs/api/classes/EventEmitter.md b/docs/api/classes/EventEmitter.md index 0b43e76..c279d3b 100644 --- a/docs/api/classes/EventEmitter.md +++ b/docs/api/classes/EventEmitter.md @@ -10,13 +10,23 @@ ## Hierarchy -- `EventEmitter` +- **`EventEmitter`** - ↳ **`EventEmitter`** + ↳ [`EventBus`](EventBus.md) - ↳↳ [`Ticker`](Ticker.md) + ↳ [`EventBusRedis`](EventBusRedis.md) - ↳↳ [`WorkerRunner`](WorkerRunner.md) + ↳ [`IRedisClient`](../interfaces/IRedisClient.md) + + ↳ [`RedisClientAbstract`](RedisClientAbstract.md) + + ↳ [`Runnable`](Runnable.md) + + ↳ [`Timer`](Timer.md) + +## Implements + +- [`IEventEmitter`](../interfaces/IEventEmitter.md)\<`Events`\> ## Table of contents @@ -30,12 +40,13 @@ - [on](EventEmitter.md#on) - [once](EventEmitter.md#once) - [removeAllListeners](EventEmitter.md#removealllisteners) +- [removeListener](EventEmitter.md#removelistener) ## Constructors ### constructor -• **new EventEmitter**\<`Events`\>(`options?`): [`EventEmitter`](EventEmitter.md)\<`Events`\> +• **new EventEmitter**\<`Events`\>(): [`EventEmitter`](EventEmitter.md)\<`Events`\> #### Type parameters @@ -43,20 +54,10 @@ | :------ | :------ | | `Events` | extends [`TEventEmitterEvent`](../README.md#teventemitterevent) | -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `EventEmitterOptions` | - #### Returns [`EventEmitter`](EventEmitter.md)\<`Events`\> -#### Inherited from - -Base.constructor - ## Methods ### emit @@ -80,9 +81,9 @@ Base.constructor `boolean` -#### Overrides +#### Implementation of -Base.emit +[IEventEmitter](../interfaces/IEventEmitter.md).[emit](../interfaces/IEventEmitter.md#emit) ___ @@ -107,9 +108,9 @@ ___ [`EventEmitter`](EventEmitter.md)\<`Events`\> -#### Overrides +#### Implementation of -Base.on +[IEventEmitter](../interfaces/IEventEmitter.md).[on](../interfaces/IEventEmitter.md#on) ___ @@ -134,9 +135,9 @@ ___ [`EventEmitter`](EventEmitter.md)\<`Events`\> -#### Overrides +#### Implementation of -Base.once +[IEventEmitter](../interfaces/IEventEmitter.md).[once](../interfaces/IEventEmitter.md#once) ___ @@ -154,12 +155,39 @@ ___ | Name | Type | | :------ | :------ | -| `event?` | `E` | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`EventEmitter`](EventEmitter.md)\<`Events`\> + +#### Implementation of + +[IEventEmitter](../interfaces/IEventEmitter.md).[removeAllListeners](../interfaces/IEventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`EventEmitter`](EventEmitter.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | #### Returns [`EventEmitter`](EventEmitter.md)\<`Events`\> -#### Overrides +#### Implementation of -Base.removeAllListeners +[IEventEmitter](../interfaces/IEventEmitter.md).[removeListener](../interfaces/IEventEmitter.md#removelistener) diff --git a/docs/api/classes/IoredisClient.md b/docs/api/classes/IoredisClient.md new file mode 100644 index 0000000..de164c1 --- /dev/null +++ b/docs/api/classes/IoredisClient.md @@ -0,0 +1,1463 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IoredisClient + +# Class: IoredisClient + +## Hierarchy + +- [`RedisClientAbstract`](RedisClientAbstract.md) + + ↳ **`IoredisClient`** + +## Table of contents + +### Constructors + +- [constructor](IoredisClient.md#constructor) + +### Methods + +- [brpoplpush](IoredisClient.md#brpoplpush) +- [del](IoredisClient.md#del) +- [emit](IoredisClient.md#emit) +- [end](IoredisClient.md#end) +- [evalsha](IoredisClient.md#evalsha) +- [flushall](IoredisClient.md#flushall) +- [get](IoredisClient.md#get) +- [getInfo](IoredisClient.md#getinfo) +- [halt](IoredisClient.md#halt) +- [hdel](IoredisClient.md#hdel) +- [hget](IoredisClient.md#hget) +- [hgetall](IoredisClient.md#hgetall) +- [hkeys](IoredisClient.md#hkeys) +- [hlen](IoredisClient.md#hlen) +- [hmget](IoredisClient.md#hmget) +- [hscan](IoredisClient.md#hscan) +- [hscanAll](IoredisClient.md#hscanall) +- [hset](IoredisClient.md#hset) +- [llen](IoredisClient.md#llen) +- [lmove](IoredisClient.md#lmove) +- [loadScript](IoredisClient.md#loadscript) +- [loadScripts](IoredisClient.md#loadscripts) +- [lpoprpush](IoredisClient.md#lpoprpush) +- [lrange](IoredisClient.md#lrange) +- [lrem](IoredisClient.md#lrem) +- [multi](IoredisClient.md#multi) +- [on](IoredisClient.md#on) +- [once](IoredisClient.md#once) +- [psubscribe](IoredisClient.md#psubscribe) +- [publish](IoredisClient.md#publish) +- [punsubscribe](IoredisClient.md#punsubscribe) +- [removeAllListeners](IoredisClient.md#removealllisteners) +- [removeListener](IoredisClient.md#removelistener) +- [rpop](IoredisClient.md#rpop) +- [rpoplpush](IoredisClient.md#rpoplpush) +- [runScript](IoredisClient.md#runscript) +- [sadd](IoredisClient.md#sadd) +- [set](IoredisClient.md#set) +- [shutDown](IoredisClient.md#shutdown) +- [sismember](IoredisClient.md#sismember) +- [smembers](IoredisClient.md#smembers) +- [srem](IoredisClient.md#srem) +- [sscan](IoredisClient.md#sscan) +- [sscanAll](IoredisClient.md#sscanall) +- [subscribe](IoredisClient.md#subscribe) +- [unsubscribe](IoredisClient.md#unsubscribe) +- [unwatch](IoredisClient.md#unwatch) +- [updateServerVersion](IoredisClient.md#updateserverversion) +- [validateRedisServerSupport](IoredisClient.md#validateredisserversupport) +- [validateRedisVersion](IoredisClient.md#validateredisversion) +- [watch](IoredisClient.md#watch) +- [zadd](IoredisClient.md#zadd) +- [zcard](IoredisClient.md#zcard) +- [zpoprpush](IoredisClient.md#zpoprpush) +- [zrange](IoredisClient.md#zrange) +- [zrangebyscore](IoredisClient.md#zrangebyscore) +- [zrangebyscorewithscores](IoredisClient.md#zrangebyscorewithscores) +- [zrem](IoredisClient.md#zrem) +- [zremrangebyscore](IoredisClient.md#zremrangebyscore) +- [zrevrange](IoredisClient.md#zrevrange) +- [zscan](IoredisClient.md#zscan) +- [addScript](IoredisClient.md#addscript) + +## Constructors + +### constructor + +• **new IoredisClient**(`config?`): [`IoredisClient`](IoredisClient.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `RedisOptions` | + +#### Returns + +[`IoredisClient`](IoredisClient.md) + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[constructor](RedisClientAbstract.md#constructor) + +## Methods + +### brpoplpush + +▸ **brpoplpush**(`source`, `destination`, `timeout`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `timeout` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[brpoplpush](RedisClientAbstract.md#brpoplpush) + +___ + +### del + +▸ **del**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` \| `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[del](RedisClientAbstract.md#del) + +___ + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TRedisClientEvent`](../README.md#tredisclientevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[emit](RedisClientAbstract.md#emit) + +___ + +### end + +▸ **end**(): `void` + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[end](RedisClientAbstract.md#end) + +___ + +### evalsha + +▸ **evalsha**(`hash`, `args`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hash` | `string` | +| `args` | `string` \| `number` \| (`string` \| `number`)[] | +| `cb` | (`err?`: ``null`` \| `Error`, `res?`: `unknown`) => `void` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[evalsha](RedisClientAbstract.md#evalsha) + +___ + +### flushall + +▸ **flushall**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[flushall](RedisClientAbstract.md#flushall) + +___ + +### get + +▸ **get**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[get](RedisClientAbstract.md#get) + +___ + +### getInfo + +▸ **getInfo**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[getInfo](RedisClientAbstract.md#getinfo) + +___ + +### halt + +▸ **halt**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[halt](RedisClientAbstract.md#halt) + +___ + +### hdel + +▸ **hdel**(`key`, `fields`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `fields` | `string` \| `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hdel](RedisClientAbstract.md#hdel) + +___ + +### hget + +▸ **hget**(`key`, `field`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hget](RedisClientAbstract.md#hget) + +___ + +### hgetall + +▸ **hgetall**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hgetall](RedisClientAbstract.md#hgetall) + +___ + +### hkeys + +▸ **hkeys**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hkeys](RedisClientAbstract.md#hkeys) + +___ + +### hlen + +▸ **hlen**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hlen](RedisClientAbstract.md#hlen) + +___ + +### hmget + +▸ **hmget**(`source`, `keys`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `keys` | `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<(``null`` \| `string`)[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hmget](RedisClientAbstract.md#hmget) + +___ + +### hscan + +▸ **hscan**(`key`, `cursor`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cursor` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<\{ `cursor`: `string` ; `result`: `Record`\<`string`, `string`\> }\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hscan](RedisClientAbstract.md#hscan) + +___ + +### hscanAll + +▸ **hscanAll**(`key`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[hscanAll](RedisClientAbstract.md#hscanall) + +___ + +### hset + +▸ **hset**(`key`, `field`, `value`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `value` | `string` \| `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hset](RedisClientAbstract.md#hset) + +___ + +### llen + +▸ **llen**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[llen](RedisClientAbstract.md#llen) + +___ + +### lmove + +▸ **lmove**(`source`, `destination`, `from`, `to`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `from` | ``"LEFT"`` \| ``"RIGHT"`` | +| `to` | ``"LEFT"`` \| ``"RIGHT"`` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[lmove](RedisClientAbstract.md#lmove) + +___ + +### loadScript + +▸ **loadScript**(`script`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `script` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[loadScript](RedisClientAbstract.md#loadscript) + +___ + +### loadScripts + +▸ **loadScripts**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[loadScripts](RedisClientAbstract.md#loadscripts) + +___ + +### lpoprpush + +▸ **lpoprpush**(`source`, `destination`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[lpoprpush](RedisClientAbstract.md#lpoprpush) + +___ + +### lrange + +▸ **lrange**(`key`, `start`, `stop`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `start` | `number` | +| `stop` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[lrange](RedisClientAbstract.md#lrange) + +___ + +### lrem + +▸ **lrem**(`key`, `count`, `element`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `count` | `number` | +| `element` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[lrem](RedisClientAbstract.md#lrem) + +___ + +### multi + +▸ **multi**(): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[multi](RedisClientAbstract.md#multi) + +___ + +### on + +▸ **on**(`event`, `listener`): [`IoredisClient`](IoredisClient.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` | +| `listener` | (...`args`: `unknown`[]) => `unknown` | + +#### Returns + +[`IoredisClient`](IoredisClient.md) + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[on](RedisClientAbstract.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`IoredisClient`](IoredisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`IoredisClient`](IoredisClient.md) + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[once](RedisClientAbstract.md#once) + +___ + +### psubscribe + +▸ **psubscribe**(`pattern`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pattern` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[psubscribe](RedisClientAbstract.md#psubscribe) + +___ + +### publish + +▸ **publish**(`channel`, `message`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel` | `string` | +| `message` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[publish](RedisClientAbstract.md#publish) + +___ + +### punsubscribe + +▸ **punsubscribe**(`channel?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel?` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[punsubscribe](RedisClientAbstract.md#punsubscribe) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`IoredisClient`](IoredisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`IoredisClient`](IoredisClient.md) + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[removeAllListeners](RedisClientAbstract.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`IoredisClient`](IoredisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`IoredisClient`](IoredisClient.md) + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[removeListener](RedisClientAbstract.md#removelistener) + +___ + +### rpop + +▸ **rpop**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[rpop](RedisClientAbstract.md#rpop) + +___ + +### rpoplpush + +▸ **rpoplpush**(`source`, `destination`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[rpoplpush](RedisClientAbstract.md#rpoplpush) + +___ + +### runScript + +▸ **runScript**(`scriptName`, `keys`, `args`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scriptName` | `string` | +| `keys` | (`string` \| `number`)[] | +| `args` | (`string` \| `number`)[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`unknown`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[runScript](RedisClientAbstract.md#runscript) + +___ + +### sadd + +▸ **sadd**(`key`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[sadd](RedisClientAbstract.md#sadd) + +___ + +### set + +▸ **set**(`key`, `value`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `string` | +| `options` | `Object` | +| `options.exists?` | ``"NX"`` \| ``"XX"`` | +| `options.expire?` | `Object` | +| `options.expire.mode` | ``"EX"`` \| ``"PX"`` | +| `options.expire.value` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[set](RedisClientAbstract.md#set) + +___ + +### shutDown + +▸ **shutDown**(`cb?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[shutDown](RedisClientAbstract.md#shutdown) + +___ + +### sismember + +▸ **sismember**(`key`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[sismember](RedisClientAbstract.md#sismember) + +___ + +### smembers + +▸ **smembers**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[smembers](RedisClientAbstract.md#smembers) + +___ + +### srem + +▸ **srem**(`key`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[srem](RedisClientAbstract.md#srem) + +___ + +### sscan + +▸ **sscan**(`key`, `cursor`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cursor` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<\{ `cursor`: `string` ; `items`: `string`[] }\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[sscan](RedisClientAbstract.md#sscan) + +___ + +### sscanAll + +▸ **sscanAll**(`key`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[sscanAll](RedisClientAbstract.md#sscanall) + +___ + +### subscribe + +▸ **subscribe**(`channel`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[subscribe](RedisClientAbstract.md#subscribe) + +___ + +### unsubscribe + +▸ **unsubscribe**(`channel?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel?` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[unsubscribe](RedisClientAbstract.md#unsubscribe) + +___ + +### unwatch + +▸ **unwatch**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[unwatch](RedisClientAbstract.md#unwatch) + +___ + +### updateServerVersion + +▸ **updateServerVersion**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[updateServerVersion](RedisClientAbstract.md#updateserverversion) + +___ + +### validateRedisServerSupport + +▸ **validateRedisServerSupport**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[validateRedisServerSupport](RedisClientAbstract.md#validateredisserversupport) + +___ + +### validateRedisVersion + +▸ **validateRedisVersion**(`major`, `feature?`, `minor?`): `boolean` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `major` | `number` | `undefined` | +| `feature` | `number` | `0` | +| `minor` | `number` | `0` | + +#### Returns + +`boolean` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[validateRedisVersion](RedisClientAbstract.md#validateredisversion) + +___ + +### watch + +▸ **watch**(`args`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `args` | `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[watch](RedisClientAbstract.md#watch) + +___ + +### zadd + +▸ **zadd**(`key`, `score`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `score` | `number` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string` \| `number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zadd](RedisClientAbstract.md#zadd) + +___ + +### zcard + +▸ **zcard**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zcard](RedisClientAbstract.md#zcard) + +___ + +### zpoprpush + +▸ **zpoprpush**(`source`, `destination`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[zpoprpush](RedisClientAbstract.md#zpoprpush) + +___ + +### zrange + +▸ **zrange**(`key`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `min` | `number` | +| `max` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrange](RedisClientAbstract.md#zrange) + +___ + +### zrangebyscore + +▸ **zrangebyscore**(`key`, `min`, `max`, `offset`, `count`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `min` | `string` \| `number` | +| `max` | `string` \| `number` | +| `offset` | `number` | +| `count` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrangebyscore](RedisClientAbstract.md#zrangebyscore) + +___ + +### zrangebyscorewithscores + +▸ **zrangebyscorewithscores**(`source`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `min` | `number` | +| `max` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrangebyscorewithscores](RedisClientAbstract.md#zrangebyscorewithscores) + +___ + +### zrem + +▸ **zrem**(`source`, `id`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `id` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrem](RedisClientAbstract.md#zrem) + +___ + +### zremrangebyscore + +▸ **zremrangebyscore**(`source`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `min` | `string` \| `number` | +| `max` | `string` \| `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zremrangebyscore](RedisClientAbstract.md#zremrangebyscore) + +___ + +### zrevrange + +▸ **zrevrange**(`key`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `min` | `number` | +| `max` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrevrange](RedisClientAbstract.md#zrevrange) + +___ + +### zscan + +▸ **zscan**(`key`, `cursor`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cursor` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<\{ `cursor`: `string` ; `items`: `string`[] }\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zscan](RedisClientAbstract.md#zscan) + +___ + +### addScript + +▸ **addScript**(`name`, `content`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `content` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[addScript](RedisClientAbstract.md#addscript) diff --git a/docs/api/classes/IoredisClientMulti.md b/docs/api/classes/IoredisClientMulti.md new file mode 100644 index 0000000..8142ea1 --- /dev/null +++ b/docs/api/classes/IoredisClientMulti.md @@ -0,0 +1,429 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IoredisClientMulti + +# Class: IoredisClientMulti + +## Implements + +- [`IRedisTransaction`](../interfaces/IRedisTransaction.md) + +## Table of contents + +### Constructors + +- [constructor](IoredisClientMulti.md#constructor) + +### Methods + +- [del](IoredisClientMulti.md#del) +- [exec](IoredisClientMulti.md#exec) +- [expire](IoredisClientMulti.md#expire) +- [hdel](IoredisClientMulti.md#hdel) +- [hincrby](IoredisClientMulti.md#hincrby) +- [hset](IoredisClientMulti.md#hset) +- [lpop](IoredisClientMulti.md#lpop) +- [lpush](IoredisClientMulti.md#lpush) +- [lrem](IoredisClientMulti.md#lrem) +- [ltrim](IoredisClientMulti.md#ltrim) +- [pexpire](IoredisClientMulti.md#pexpire) +- [rpop](IoredisClientMulti.md#rpop) +- [rpoplpush](IoredisClientMulti.md#rpoplpush) +- [rpush](IoredisClientMulti.md#rpush) +- [sadd](IoredisClientMulti.md#sadd) +- [srem](IoredisClientMulti.md#srem) +- [zadd](IoredisClientMulti.md#zadd) +- [zrem](IoredisClientMulti.md#zrem) + +## Constructors + +### constructor + +• **new IoredisClientMulti**(`client`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `client` | `Redis` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +## Methods + +### del + +▸ **del**(`key`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` \| `string`[] | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[del](../interfaces/IRedisTransaction.md#del) + +___ + +### exec + +▸ **exec**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`unknown`[]\> | + +#### Returns + +`void` + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[exec](../interfaces/IRedisTransaction.md#exec) + +___ + +### expire + +▸ **expire**(`key`, `secs`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `secs` | `number` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[expire](../interfaces/IRedisTransaction.md#expire) + +___ + +### hdel + +▸ **hdel**(`key`, `field`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` \| `string`[] | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[hdel](../interfaces/IRedisTransaction.md#hdel) + +___ + +### hincrby + +▸ **hincrby**(`key`, `field`, `by`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `by` | `number` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[hincrby](../interfaces/IRedisTransaction.md#hincrby) + +___ + +### hset + +▸ **hset**(`key`, `field`, `value`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `value` | `string` \| `number` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[hset](../interfaces/IRedisTransaction.md#hset) + +___ + +### lpop + +▸ **lpop**(`key`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[lpop](../interfaces/IRedisTransaction.md#lpop) + +___ + +### lpush + +▸ **lpush**(`key`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[lpush](../interfaces/IRedisTransaction.md#lpush) + +___ + +### lrem + +▸ **lrem**(`key`, `count`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `count` | `number` | +| `element` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[lrem](../interfaces/IRedisTransaction.md#lrem) + +___ + +### ltrim + +▸ **ltrim**(`key`, `start`, `stop`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `start` | `number` | +| `stop` | `number` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[ltrim](../interfaces/IRedisTransaction.md#ltrim) + +___ + +### pexpire + +▸ **pexpire**(`key`, `millis`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `millis` | `number` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[pexpire](../interfaces/IRedisTransaction.md#pexpire) + +___ + +### rpop + +▸ **rpop**(`key`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[rpop](../interfaces/IRedisTransaction.md#rpop) + +___ + +### rpoplpush + +▸ **rpoplpush**(`source`, `destination`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[rpoplpush](../interfaces/IRedisTransaction.md#rpoplpush) + +___ + +### rpush + +▸ **rpush**(`key`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[rpush](../interfaces/IRedisTransaction.md#rpush) + +___ + +### sadd + +▸ **sadd**(`key`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[sadd](../interfaces/IRedisTransaction.md#sadd) + +___ + +### srem + +▸ **srem**(`key`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` \| `string`[] | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[srem](../interfaces/IRedisTransaction.md#srem) + +___ + +### zadd + +▸ **zadd**(`key`, `score`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `score` | `number` | +| `element` | `string` | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[zadd](../interfaces/IRedisTransaction.md#zadd) + +___ + +### zrem + +▸ **zrem**(`key`, `element`): [`IoredisClientMulti`](IoredisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` \| `string`[] | + +#### Returns + +[`IoredisClientMulti`](IoredisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[zrem](../interfaces/IRedisTransaction.md#zrem) diff --git a/docs/api/classes/Lock.md b/docs/api/classes/Lock.md deleted file mode 100644 index 061f4d4..0000000 --- a/docs/api/classes/Lock.md +++ /dev/null @@ -1,133 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / Lock - -# Class: Lock - -## Table of contents - -### Constructors - -- [constructor](Lock.md#constructor) - -### Methods - -- [acquireLock](Lock.md#acquirelock) -- [acquireOrExtend](Lock.md#acquireorextend) -- [extendLock](Lock.md#extendlock) -- [getId](Lock.md#getid) -- [isLocked](Lock.md#islocked) -- [isReleased](Lock.md#isreleased) -- [releaseLock](Lock.md#releaselock) - -## Constructors - -### constructor - -• **new Lock**(`redisClient`, `lockKey`, `ttl`, `retryOnFail?`, `autoExtend?`): [`Lock`](Lock.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `redisClient` | [`RedisClient`](RedisClient.md) | `undefined` | -| `lockKey` | `string` | `undefined` | -| `ttl` | `number` | `undefined` | -| `retryOnFail` | `boolean` | `false` | -| `autoExtend` | `boolean` | `false` | - -#### Returns - -[`Lock`](Lock.md) - -## Methods - -### acquireLock - -▸ **acquireLock**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` - -___ - -### acquireOrExtend - -▸ **acquireOrExtend**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`ELockStatus`\> | - -#### Returns - -`void` - -___ - -### extendLock - -▸ **extendLock**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` - -___ - -### getId - -▸ **getId**(): `string` - -#### Returns - -`string` - -___ - -### isLocked - -▸ **isLocked**(): `boolean` - -#### Returns - -`boolean` - -___ - -### isReleased - -▸ **isReleased**(): `boolean` - -#### Returns - -`boolean` - -___ - -### releaseLock - -▸ **releaseLock**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` diff --git a/docs/api/classes/LockAbortError.md b/docs/api/classes/LockAbortError.md deleted file mode 100644 index 4496bdd..0000000 --- a/docs/api/classes/LockAbortError.md +++ /dev/null @@ -1,53 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / LockAbortError - -# Class: LockAbortError - -## Hierarchy - -- [`LockError`](LockError.md) - - ↳ **`LockAbortError`** - -## Table of contents - -### Constructors - -- [constructor](LockAbortError.md#constructor) - -### Accessors - -- [name](LockAbortError.md#name) - -## Constructors - -### constructor - -• **new LockAbortError**(`message?`): [`LockAbortError`](LockAbortError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -[`LockAbortError`](LockAbortError.md) - -#### Overrides - -[LockError](LockError.md).[constructor](LockError.md#constructor) - -## Accessors - -### name - -• `get` **name**(): `string` - -#### Returns - -`string` - -#### Inherited from - -LockError.name diff --git a/docs/api/classes/LockAcquireError.md b/docs/api/classes/LockAcquireError.md index 929df3d..9c5e4e0 100644 --- a/docs/api/classes/LockAcquireError.md +++ b/docs/api/classes/LockAcquireError.md @@ -14,10 +14,22 @@ - [constructor](LockAcquireError.md#constructor) +### Properties + +- [cause](LockAcquireError.md#cause) +- [message](LockAcquireError.md#message) +- [stack](LockAcquireError.md#stack) +- [prepareStackTrace](LockAcquireError.md#preparestacktrace) +- [stackTraceLimit](LockAcquireError.md#stacktracelimit) + ### Accessors - [name](LockAcquireError.md#name) +### Methods + +- [captureStackTrace](LockAcquireError.md#capturestacktrace) + ## Constructors ### constructor @@ -38,6 +50,77 @@ [LockError](LockError.md).[constructor](LockError.md#constructor) +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[LockError](LockError.md).[cause](LockError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[LockError](LockError.md).[message](LockError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[LockError](LockError.md).[stack](LockError.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 + +[LockError](LockError.md).[prepareStackTrace](LockError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[LockError](LockError.md).[stackTraceLimit](LockError.md#stacktracelimit) + ## Accessors ### name @@ -51,3 +134,26 @@ #### Inherited from LockError.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 + +[LockError](LockError.md).[captureStackTrace](LockError.md#capturestacktrace) diff --git a/docs/api/classes/LockError.md b/docs/api/classes/LockError.md index 3d629f2..3f27886 100644 --- a/docs/api/classes/LockError.md +++ b/docs/api/classes/LockError.md @@ -8,8 +8,6 @@ ↳ **`LockError`** - ↳↳ [`LockAbortError`](LockAbortError.md) - ↳↳ [`LockAcquireError`](LockAcquireError.md) ↳↳ [`LockExtendError`](LockExtendError.md) @@ -18,18 +16,28 @@ ↳↳ [`LockNotAcquiredError`](LockNotAcquiredError.md) - ↳↳ [`LockNotReleasedError`](LockNotReleasedError.md) - ## Table of contents ### Constructors - [constructor](LockError.md#constructor) +### Properties + +- [cause](LockError.md#cause) +- [message](LockError.md#message) +- [stack](LockError.md#stack) +- [prepareStackTrace](LockError.md#preparestacktrace) +- [stackTraceLimit](LockError.md#stacktracelimit) + ### Accessors - [name](LockError.md#name) +### Methods + +- [captureStackTrace](LockError.md#capturestacktrace) + ## Constructors ### constructor @@ -50,6 +58,77 @@ [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 @@ -63,3 +142,26 @@ #### 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) diff --git a/docs/api/classes/LockExtendError.md b/docs/api/classes/LockExtendError.md index d1e9805..411eb54 100644 --- a/docs/api/classes/LockExtendError.md +++ b/docs/api/classes/LockExtendError.md @@ -14,10 +14,22 @@ - [constructor](LockExtendError.md#constructor) +### Properties + +- [cause](LockExtendError.md#cause) +- [message](LockExtendError.md#message) +- [stack](LockExtendError.md#stack) +- [prepareStackTrace](LockExtendError.md#preparestacktrace) +- [stackTraceLimit](LockExtendError.md#stacktracelimit) + ### Accessors - [name](LockExtendError.md#name) +### Methods + +- [captureStackTrace](LockExtendError.md#capturestacktrace) + ## Constructors ### constructor @@ -38,6 +50,77 @@ [LockError](LockError.md).[constructor](LockError.md#constructor) +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[LockError](LockError.md).[cause](LockError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[LockError](LockError.md).[message](LockError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[LockError](LockError.md).[stack](LockError.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 + +[LockError](LockError.md).[prepareStackTrace](LockError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[LockError](LockError.md).[stackTraceLimit](LockError.md#stacktracelimit) + ## Accessors ### name @@ -51,3 +134,26 @@ #### Inherited from LockError.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 + +[LockError](LockError.md).[captureStackTrace](LockError.md#capturestacktrace) diff --git a/docs/api/classes/LockMethodNotAllowedError.md b/docs/api/classes/LockMethodNotAllowedError.md index 975a44c..be6a445 100644 --- a/docs/api/classes/LockMethodNotAllowedError.md +++ b/docs/api/classes/LockMethodNotAllowedError.md @@ -14,10 +14,22 @@ - [constructor](LockMethodNotAllowedError.md#constructor) +### Properties + +- [cause](LockMethodNotAllowedError.md#cause) +- [message](LockMethodNotAllowedError.md#message) +- [stack](LockMethodNotAllowedError.md#stack) +- [prepareStackTrace](LockMethodNotAllowedError.md#preparestacktrace) +- [stackTraceLimit](LockMethodNotAllowedError.md#stacktracelimit) + ### Accessors - [name](LockMethodNotAllowedError.md#name) +### Methods + +- [captureStackTrace](LockMethodNotAllowedError.md#capturestacktrace) + ## Constructors ### constructor @@ -38,6 +50,77 @@ [LockError](LockError.md).[constructor](LockError.md#constructor) +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[LockError](LockError.md).[cause](LockError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[LockError](LockError.md).[message](LockError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[LockError](LockError.md).[stack](LockError.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 + +[LockError](LockError.md).[prepareStackTrace](LockError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[LockError](LockError.md).[stackTraceLimit](LockError.md#stacktracelimit) + ## Accessors ### name @@ -51,3 +134,26 @@ #### Inherited from LockError.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 + +[LockError](LockError.md).[captureStackTrace](LockError.md#capturestacktrace) diff --git a/docs/api/classes/LockNotAcquiredError.md b/docs/api/classes/LockNotAcquiredError.md index f35cbc7..ddd3631 100644 --- a/docs/api/classes/LockNotAcquiredError.md +++ b/docs/api/classes/LockNotAcquiredError.md @@ -14,10 +14,22 @@ - [constructor](LockNotAcquiredError.md#constructor) +### Properties + +- [cause](LockNotAcquiredError.md#cause) +- [message](LockNotAcquiredError.md#message) +- [stack](LockNotAcquiredError.md#stack) +- [prepareStackTrace](LockNotAcquiredError.md#preparestacktrace) +- [stackTraceLimit](LockNotAcquiredError.md#stacktracelimit) + ### Accessors - [name](LockNotAcquiredError.md#name) +### Methods + +- [captureStackTrace](LockNotAcquiredError.md#capturestacktrace) + ## Constructors ### constructor @@ -38,6 +50,77 @@ [LockError](LockError.md).[constructor](LockError.md#constructor) +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[LockError](LockError.md).[cause](LockError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[LockError](LockError.md).[message](LockError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[LockError](LockError.md).[stack](LockError.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 + +[LockError](LockError.md).[prepareStackTrace](LockError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[LockError](LockError.md).[stackTraceLimit](LockError.md#stacktracelimit) + ## Accessors ### name @@ -51,3 +134,26 @@ #### Inherited from LockError.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 + +[LockError](LockError.md).[captureStackTrace](LockError.md#capturestacktrace) diff --git a/docs/api/classes/LockNotReleasedError.md b/docs/api/classes/LockNotReleasedError.md deleted file mode 100644 index 080a33a..0000000 --- a/docs/api/classes/LockNotReleasedError.md +++ /dev/null @@ -1,53 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / LockNotReleasedError - -# Class: LockNotReleasedError - -## Hierarchy - -- [`LockError`](LockError.md) - - ↳ **`LockNotReleasedError`** - -## Table of contents - -### Constructors - -- [constructor](LockNotReleasedError.md#constructor) - -### Accessors - -- [name](LockNotReleasedError.md#name) - -## Constructors - -### constructor - -• **new LockNotReleasedError**(`message?`): [`LockNotReleasedError`](LockNotReleasedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | - -#### Returns - -[`LockNotReleasedError`](LockNotReleasedError.md) - -#### Overrides - -[LockError](LockError.md).[constructor](LockError.md#constructor) - -## Accessors - -### name - -• `get` **name**(): `string` - -#### Returns - -`string` - -#### Inherited from - -LockError.name diff --git a/docs/api/classes/Locker.md b/docs/api/classes/Locker.md new file mode 100644 index 0000000..3a83849 --- /dev/null +++ b/docs/api/classes/Locker.md @@ -0,0 +1,387 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / Locker + +# Class: Locker + +## Hierarchy + +- [`Runnable`](Runnable.md)\<[`TLockerEvent`](../README.md#tlockerevent)\> + + ↳ **`Locker`** + +## Table of contents + +### Constructors + +- [constructor](Locker.md#constructor) + +### Methods + +- [acquireLock](Locker.md#acquirelock) +- [emit](Locker.md#emit) +- [extendLock](Locker.md#extendlock) +- [getId](Locker.md#getid) +- [isDown](Locker.md#isdown) +- [isGoingDown](Locker.md#isgoingdown) +- [isGoingUp](Locker.md#isgoingup) +- [isLocked](Locker.md#islocked) +- [isReleased](Locker.md#isreleased) +- [isRunning](Locker.md#isrunning) +- [isUp](Locker.md#isup) +- [on](Locker.md#on) +- [once](Locker.md#once) +- [releaseLock](Locker.md#releaselock) +- [removeAllListeners](Locker.md#removealllisteners) +- [removeListener](Locker.md#removelistener) +- [run](Locker.md#run) +- [shutdown](Locker.md#shutdown) + +## Constructors + +### constructor + +• **new Locker**(`redisClient`, `logger`, `lockKey`, `ttl`, `retryOnFail?`, `autoExtendInterval?`): [`Locker`](Locker.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `redisClient` | [`IRedisClient`](../interfaces/IRedisClient.md) | `undefined` | +| `logger` | [`ILogger`](../interfaces/ILogger.md) | `undefined` | +| `lockKey` | `string` | `undefined` | +| `ttl` | `number` | `undefined` | +| `retryOnFail` | `boolean` | `false` | +| `autoExtendInterval` | `number` | `0` | + +#### Returns + +[`Locker`](Locker.md) + +#### Overrides + +Runnable\<TLockerEvent\>.constructor + +## Methods + +### acquireLock + +▸ **acquireLock**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`boolean`\> | + +#### Returns + +`void` + +___ + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TLockerEvent`](../README.md#tlockerevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TLockerEvent`](../README.md#tlockerevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[emit](Runnable.md#emit) + +___ + +### extendLock + +▸ **extendLock**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +___ + +### getId + +▸ **getId**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[Runnable](Runnable.md).[getId](Runnable.md#getid) + +___ + +### isDown + +▸ **isDown**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isDown](Runnable.md#isdown) + +___ + +### isGoingDown + +▸ **isGoingDown**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isGoingDown](Runnable.md#isgoingdown) + +___ + +### isGoingUp + +▸ **isGoingUp**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isGoingUp](Runnable.md#isgoingup) + +___ + +### isLocked + +▸ **isLocked**(): `boolean` + +#### Returns + +`boolean` + +___ + +### isReleased + +▸ **isReleased**(): `boolean` + +#### Returns + +`boolean` + +___ + +### isRunning + +▸ **isRunning**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isRunning](Runnable.md#isrunning) + +___ + +### isUp + +▸ **isUp**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isUp](Runnable.md#isup) + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`Locker`](Locker.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TLockerEvent`](../README.md#tlockerevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TLockerEvent`](../README.md#tlockerevent)[`E`] | + +#### Returns + +[`Locker`](Locker.md) + +#### Inherited from + +[Runnable](Runnable.md).[on](Runnable.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`Locker`](Locker.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TLockerEvent`](../README.md#tlockerevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TLockerEvent`](../README.md#tlockerevent)[`E`] | + +#### Returns + +[`Locker`](Locker.md) + +#### Inherited from + +[Runnable](Runnable.md).[once](Runnable.md#once) + +___ + +### releaseLock + +▸ **releaseLock**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`Locker`](Locker.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TLockerEvent`](../README.md#tlockerevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`Locker`](Locker.md) + +#### Inherited from + +[Runnable](Runnable.md).[removeAllListeners](Runnable.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`Locker`](Locker.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TLockerEvent`](../README.md#tlockerevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TLockerEvent`](../README.md#tlockerevent)[`E`] | + +#### Returns + +[`Locker`](Locker.md) + +#### Inherited from + +[Runnable](Runnable.md).[removeListener](Runnable.md#removelistener) + +___ + +### run + +▸ **run**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`boolean`\> | + +#### Returns + +`void` + +#### Overrides + +[Runnable](Runnable.md).[run](Runnable.md#run) + +___ + +### shutdown + +▸ **shutdown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[Runnable](Runnable.md).[shutdown](Runnable.md#shutdown) diff --git a/docs/api/classes/LoggerError.md b/docs/api/classes/LoggerError.md index 43a3c0b..b738c5b 100644 --- a/docs/api/classes/LoggerError.md +++ b/docs/api/classes/LoggerError.md @@ -14,10 +14,22 @@ - [constructor](LoggerError.md#constructor) +### Properties + +- [cause](LoggerError.md#cause) +- [message](LoggerError.md#message) +- [stack](LoggerError.md#stack) +- [prepareStackTrace](LoggerError.md#preparestacktrace) +- [stackTraceLimit](LoggerError.md#stacktracelimit) + ### Accessors - [name](LoggerError.md#name) +### Methods + +- [captureStackTrace](LoggerError.md#capturestacktrace) + ## Constructors ### constructor @@ -38,6 +50,77 @@ [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 @@ -51,3 +134,26 @@ #### 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) diff --git a/docs/api/classes/LuaScript.md b/docs/api/classes/LuaScript.md new file mode 100644 index 0000000..37f2785 --- /dev/null +++ b/docs/api/classes/LuaScript.md @@ -0,0 +1,89 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / LuaScript + +# Class: LuaScript + +## Table of contents + +### Methods + +- [addScript](LuaScript.md#addscript) +- [getScriptId](LuaScript.md#getscriptid) +- [hasScript](LuaScript.md#hasscript) +- [loadScripts](LuaScript.md#loadscripts) +- [getInstance](LuaScript.md#getinstance) + +## Methods + +### addScript + +▸ **addScript**(`name`, `content`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `content` | `string` | + +#### Returns + +`boolean` + +___ + +### getScriptId + +▸ **getScriptId**(`name`): `string` \| [`RedisClientError`](RedisClientError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`string` \| [`RedisClientError`](RedisClientError.md) + +___ + +### hasScript + +▸ **hasScript**(`name`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +`boolean` + +___ + +### loadScripts + +▸ **loadScripts**(`redisClient`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `redisClient` | [`IRedisClient`](../interfaces/IRedisClient.md) | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +___ + +### getInstance + +▸ **getInstance**(): [`LuaScript`](LuaScript.md) + +#### Returns + +[`LuaScript`](LuaScript.md) diff --git a/docs/api/classes/NodeRedisClient.md b/docs/api/classes/NodeRedisClient.md new file mode 100644 index 0000000..d2daca8 --- /dev/null +++ b/docs/api/classes/NodeRedisClient.md @@ -0,0 +1,1463 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / NodeRedisClient + +# Class: NodeRedisClient + +## Hierarchy + +- [`RedisClientAbstract`](RedisClientAbstract.md) + + ↳ **`NodeRedisClient`** + +## Table of contents + +### Constructors + +- [constructor](NodeRedisClient.md#constructor) + +### Methods + +- [brpoplpush](NodeRedisClient.md#brpoplpush) +- [del](NodeRedisClient.md#del) +- [emit](NodeRedisClient.md#emit) +- [end](NodeRedisClient.md#end) +- [evalsha](NodeRedisClient.md#evalsha) +- [flushall](NodeRedisClient.md#flushall) +- [get](NodeRedisClient.md#get) +- [getInfo](NodeRedisClient.md#getinfo) +- [halt](NodeRedisClient.md#halt) +- [hdel](NodeRedisClient.md#hdel) +- [hget](NodeRedisClient.md#hget) +- [hgetall](NodeRedisClient.md#hgetall) +- [hkeys](NodeRedisClient.md#hkeys) +- [hlen](NodeRedisClient.md#hlen) +- [hmget](NodeRedisClient.md#hmget) +- [hscan](NodeRedisClient.md#hscan) +- [hscanAll](NodeRedisClient.md#hscanall) +- [hset](NodeRedisClient.md#hset) +- [llen](NodeRedisClient.md#llen) +- [lmove](NodeRedisClient.md#lmove) +- [loadScript](NodeRedisClient.md#loadscript) +- [loadScripts](NodeRedisClient.md#loadscripts) +- [lpoprpush](NodeRedisClient.md#lpoprpush) +- [lrange](NodeRedisClient.md#lrange) +- [lrem](NodeRedisClient.md#lrem) +- [multi](NodeRedisClient.md#multi) +- [on](NodeRedisClient.md#on) +- [once](NodeRedisClient.md#once) +- [psubscribe](NodeRedisClient.md#psubscribe) +- [publish](NodeRedisClient.md#publish) +- [punsubscribe](NodeRedisClient.md#punsubscribe) +- [removeAllListeners](NodeRedisClient.md#removealllisteners) +- [removeListener](NodeRedisClient.md#removelistener) +- [rpop](NodeRedisClient.md#rpop) +- [rpoplpush](NodeRedisClient.md#rpoplpush) +- [runScript](NodeRedisClient.md#runscript) +- [sadd](NodeRedisClient.md#sadd) +- [set](NodeRedisClient.md#set) +- [shutDown](NodeRedisClient.md#shutdown) +- [sismember](NodeRedisClient.md#sismember) +- [smembers](NodeRedisClient.md#smembers) +- [srem](NodeRedisClient.md#srem) +- [sscan](NodeRedisClient.md#sscan) +- [sscanAll](NodeRedisClient.md#sscanall) +- [subscribe](NodeRedisClient.md#subscribe) +- [unsubscribe](NodeRedisClient.md#unsubscribe) +- [unwatch](NodeRedisClient.md#unwatch) +- [updateServerVersion](NodeRedisClient.md#updateserverversion) +- [validateRedisServerSupport](NodeRedisClient.md#validateredisserversupport) +- [validateRedisVersion](NodeRedisClient.md#validateredisversion) +- [watch](NodeRedisClient.md#watch) +- [zadd](NodeRedisClient.md#zadd) +- [zcard](NodeRedisClient.md#zcard) +- [zpoprpush](NodeRedisClient.md#zpoprpush) +- [zrange](NodeRedisClient.md#zrange) +- [zrangebyscore](NodeRedisClient.md#zrangebyscore) +- [zrangebyscorewithscores](NodeRedisClient.md#zrangebyscorewithscores) +- [zrem](NodeRedisClient.md#zrem) +- [zremrangebyscore](NodeRedisClient.md#zremrangebyscore) +- [zrevrange](NodeRedisClient.md#zrevrange) +- [zscan](NodeRedisClient.md#zscan) +- [addScript](NodeRedisClient.md#addscript) + +## Constructors + +### constructor + +• **new NodeRedisClient**(`config?`): [`NodeRedisClient`](NodeRedisClient.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `RedisClientOptions`\<`RedisModules`, `RedisFunctions`, `RedisScripts`\> | + +#### Returns + +[`NodeRedisClient`](NodeRedisClient.md) + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[constructor](RedisClientAbstract.md#constructor) + +## Methods + +### brpoplpush + +▸ **brpoplpush**(`source`, `destination`, `timeout`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `timeout` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[brpoplpush](RedisClientAbstract.md#brpoplpush) + +___ + +### del + +▸ **del**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` \| `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[del](RedisClientAbstract.md#del) + +___ + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TRedisClientEvent`](../README.md#tredisclientevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[emit](RedisClientAbstract.md#emit) + +___ + +### end + +▸ **end**(): `void` + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[end](RedisClientAbstract.md#end) + +___ + +### evalsha + +▸ **evalsha**(`hash`, `args`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hash` | `string` | +| `args` | `string` \| `number` \| (`string` \| `number`)[] | +| `cb` | (`err?`: ``null`` \| `Error`, `res?`: `unknown`) => `void` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[evalsha](RedisClientAbstract.md#evalsha) + +___ + +### flushall + +▸ **flushall**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[flushall](RedisClientAbstract.md#flushall) + +___ + +### get + +▸ **get**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[get](RedisClientAbstract.md#get) + +___ + +### getInfo + +▸ **getInfo**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[getInfo](RedisClientAbstract.md#getinfo) + +___ + +### halt + +▸ **halt**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[halt](RedisClientAbstract.md#halt) + +___ + +### hdel + +▸ **hdel**(`key`, `fields`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `fields` | `string` \| `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hdel](RedisClientAbstract.md#hdel) + +___ + +### hget + +▸ **hget**(`key`, `field`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hget](RedisClientAbstract.md#hget) + +___ + +### hgetall + +▸ **hgetall**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hgetall](RedisClientAbstract.md#hgetall) + +___ + +### hkeys + +▸ **hkeys**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hkeys](RedisClientAbstract.md#hkeys) + +___ + +### hlen + +▸ **hlen**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hlen](RedisClientAbstract.md#hlen) + +___ + +### hmget + +▸ **hmget**(`source`, `keys`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `keys` | `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<(``null`` \| `string`)[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hmget](RedisClientAbstract.md#hmget) + +___ + +### hscan + +▸ **hscan**(`key`, `cursor`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cursor` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<\{ `cursor`: `string` ; `result`: `Record`\<`string`, `string`\> }\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hscan](RedisClientAbstract.md#hscan) + +___ + +### hscanAll + +▸ **hscanAll**(`key`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[hscanAll](RedisClientAbstract.md#hscanall) + +___ + +### hset + +▸ **hset**(`key`, `field`, `value`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `value` | `string` \| `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[hset](RedisClientAbstract.md#hset) + +___ + +### llen + +▸ **llen**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[llen](RedisClientAbstract.md#llen) + +___ + +### lmove + +▸ **lmove**(`source`, `destination`, `from`, `to`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `from` | ``"LEFT"`` \| ``"RIGHT"`` | +| `to` | ``"LEFT"`` \| ``"RIGHT"`` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[lmove](RedisClientAbstract.md#lmove) + +___ + +### loadScript + +▸ **loadScript**(`script`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `script` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[loadScript](RedisClientAbstract.md#loadscript) + +___ + +### loadScripts + +▸ **loadScripts**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[loadScripts](RedisClientAbstract.md#loadscripts) + +___ + +### lpoprpush + +▸ **lpoprpush**(`source`, `destination`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[lpoprpush](RedisClientAbstract.md#lpoprpush) + +___ + +### lrange + +▸ **lrange**(`key`, `start`, `stop`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `start` | `number` | +| `stop` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[lrange](RedisClientAbstract.md#lrange) + +___ + +### lrem + +▸ **lrem**(`key`, `count`, `element`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `count` | `number` | +| `element` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[lrem](RedisClientAbstract.md#lrem) + +___ + +### multi + +▸ **multi**(): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[multi](RedisClientAbstract.md#multi) + +___ + +### on + +▸ **on**(`event`, `listener`): [`NodeRedisClient`](NodeRedisClient.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` | +| `listener` | (...`args`: `unknown`[]) => `unknown` | + +#### Returns + +[`NodeRedisClient`](NodeRedisClient.md) + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[on](RedisClientAbstract.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`NodeRedisClient`](NodeRedisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`NodeRedisClient`](NodeRedisClient.md) + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[once](RedisClientAbstract.md#once) + +___ + +### psubscribe + +▸ **psubscribe**(`pattern`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pattern` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[psubscribe](RedisClientAbstract.md#psubscribe) + +___ + +### publish + +▸ **publish**(`channel`, `message`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel` | `string` | +| `message` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[publish](RedisClientAbstract.md#publish) + +___ + +### punsubscribe + +▸ **punsubscribe**(`channel?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel?` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[punsubscribe](RedisClientAbstract.md#punsubscribe) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`NodeRedisClient`](NodeRedisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`NodeRedisClient`](NodeRedisClient.md) + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[removeAllListeners](RedisClientAbstract.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`NodeRedisClient`](NodeRedisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`NodeRedisClient`](NodeRedisClient.md) + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[removeListener](RedisClientAbstract.md#removelistener) + +___ + +### rpop + +▸ **rpop**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[rpop](RedisClientAbstract.md#rpop) + +___ + +### rpoplpush + +▸ **rpoplpush**(`source`, `destination`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[rpoplpush](RedisClientAbstract.md#rpoplpush) + +___ + +### runScript + +▸ **runScript**(`scriptName`, `keys`, `args`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scriptName` | `string` | +| `keys` | (`string` \| `number`)[] | +| `args` | (`string` \| `number`)[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`unknown`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[runScript](RedisClientAbstract.md#runscript) + +___ + +### sadd + +▸ **sadd**(`key`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[sadd](RedisClientAbstract.md#sadd) + +___ + +### set + +▸ **set**(`key`, `value`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `value` | `string` | +| `options` | `Object` | +| `options.exists?` | ``"NX"`` \| ``"XX"`` | +| `options.expire?` | `Object` | +| `options.expire.mode` | ``"EX"`` \| ``"PX"`` | +| `options.expire.value` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[set](RedisClientAbstract.md#set) + +___ + +### shutDown + +▸ **shutDown**(`cb?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[shutDown](RedisClientAbstract.md#shutdown) + +___ + +### sismember + +▸ **sismember**(`key`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[sismember](RedisClientAbstract.md#sismember) + +___ + +### smembers + +▸ **smembers**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[smembers](RedisClientAbstract.md#smembers) + +___ + +### srem + +▸ **srem**(`key`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[srem](RedisClientAbstract.md#srem) + +___ + +### sscan + +▸ **sscan**(`key`, `cursor`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cursor` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<\{ `cursor`: `string` ; `items`: `string`[] }\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[sscan](RedisClientAbstract.md#sscan) + +___ + +### sscanAll + +▸ **sscanAll**(`key`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[sscanAll](RedisClientAbstract.md#sscanall) + +___ + +### subscribe + +▸ **subscribe**(`channel`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[subscribe](RedisClientAbstract.md#subscribe) + +___ + +### unsubscribe + +▸ **unsubscribe**(`channel?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `channel?` | `string` | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[unsubscribe](RedisClientAbstract.md#unsubscribe) + +___ + +### unwatch + +▸ **unwatch**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[unwatch](RedisClientAbstract.md#unwatch) + +___ + +### updateServerVersion + +▸ **updateServerVersion**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[updateServerVersion](RedisClientAbstract.md#updateserverversion) + +___ + +### validateRedisServerSupport + +▸ **validateRedisServerSupport**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[validateRedisServerSupport](RedisClientAbstract.md#validateredisserversupport) + +___ + +### validateRedisVersion + +▸ **validateRedisVersion**(`major`, `feature?`, `minor?`): `boolean` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `major` | `number` | `undefined` | +| `feature` | `number` | `0` | +| `minor` | `number` | `0` | + +#### Returns + +`boolean` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[validateRedisVersion](RedisClientAbstract.md#validateredisversion) + +___ + +### watch + +▸ **watch**(`args`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `args` | `string`[] | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[watch](RedisClientAbstract.md#watch) + +___ + +### zadd + +▸ **zadd**(`key`, `score`, `member`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `score` | `number` | +| `member` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string` \| `number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zadd](RedisClientAbstract.md#zadd) + +___ + +### zcard + +▸ **zcard**(`key`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zcard](RedisClientAbstract.md#zcard) + +___ + +### zpoprpush + +▸ **zpoprpush**(`source`, `destination`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<``null`` \| `string`\> | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[zpoprpush](RedisClientAbstract.md#zpoprpush) + +___ + +### zrange + +▸ **zrange**(`key`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `min` | `number` | +| `max` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrange](RedisClientAbstract.md#zrange) + +___ + +### zrangebyscore + +▸ **zrangebyscore**(`key`, `min`, `max`, `offset`, `count`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `min` | `string` \| `number` | +| `max` | `string` \| `number` | +| `offset` | `number` | +| `count` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrangebyscore](RedisClientAbstract.md#zrangebyscore) + +___ + +### zrangebyscorewithscores + +▸ **zrangebyscorewithscores**(`source`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `min` | `number` | +| `max` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Record`\<`string`, `string`\>\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrangebyscorewithscores](RedisClientAbstract.md#zrangebyscorewithscores) + +___ + +### zrem + +▸ **zrem**(`source`, `id`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `id` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrem](RedisClientAbstract.md#zrem) + +___ + +### zremrangebyscore + +▸ **zremrangebyscore**(`source`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `min` | `string` \| `number` | +| `max` | `string` \| `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`number`\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zremrangebyscore](RedisClientAbstract.md#zremrangebyscore) + +___ + +### zrevrange + +▸ **zrevrange**(`key`, `min`, `max`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `min` | `number` | +| `max` | `number` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`string`[]\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zrevrange](RedisClientAbstract.md#zrevrange) + +___ + +### zscan + +▸ **zscan**(`key`, `cursor`, `options`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `cursor` | `string` | +| `options` | `Object` | +| `options.COUNT?` | `number` | +| `options.MATCH?` | `string` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<\{ `cursor`: `string` ; `items`: `string`[] }\> | + +#### Returns + +`void` + +#### Overrides + +[RedisClientAbstract](RedisClientAbstract.md).[zscan](RedisClientAbstract.md#zscan) + +___ + +### addScript + +▸ **addScript**(`name`, `content`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `content` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[RedisClientAbstract](RedisClientAbstract.md).[addScript](RedisClientAbstract.md#addscript) diff --git a/docs/api/classes/NodeRedisClientMulti.md b/docs/api/classes/NodeRedisClientMulti.md new file mode 100644 index 0000000..f4c2dd4 --- /dev/null +++ b/docs/api/classes/NodeRedisClientMulti.md @@ -0,0 +1,429 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / NodeRedisClientMulti + +# Class: NodeRedisClientMulti + +## Implements + +- [`IRedisTransaction`](../interfaces/IRedisTransaction.md) + +## Table of contents + +### Constructors + +- [constructor](NodeRedisClientMulti.md#constructor) + +### Methods + +- [del](NodeRedisClientMulti.md#del) +- [exec](NodeRedisClientMulti.md#exec) +- [expire](NodeRedisClientMulti.md#expire) +- [hdel](NodeRedisClientMulti.md#hdel) +- [hincrby](NodeRedisClientMulti.md#hincrby) +- [hset](NodeRedisClientMulti.md#hset) +- [lpop](NodeRedisClientMulti.md#lpop) +- [lpush](NodeRedisClientMulti.md#lpush) +- [lrem](NodeRedisClientMulti.md#lrem) +- [ltrim](NodeRedisClientMulti.md#ltrim) +- [pexpire](NodeRedisClientMulti.md#pexpire) +- [rpop](NodeRedisClientMulti.md#rpop) +- [rpoplpush](NodeRedisClientMulti.md#rpoplpush) +- [rpush](NodeRedisClientMulti.md#rpush) +- [sadd](NodeRedisClientMulti.md#sadd) +- [srem](NodeRedisClientMulti.md#srem) +- [zadd](NodeRedisClientMulti.md#zadd) +- [zrem](NodeRedisClientMulti.md#zrem) + +## Constructors + +### constructor + +• **new NodeRedisClientMulti**(`client`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `client` | [`TRedisClientNodeRedis`](../README.md#tredisclientnoderedis) | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +## Methods + +### del + +▸ **del**(`key`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` \| `string`[] | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[del](../interfaces/IRedisTransaction.md#del) + +___ + +### exec + +▸ **exec**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`unknown`[]\> | + +#### Returns + +`void` + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[exec](../interfaces/IRedisTransaction.md#exec) + +___ + +### expire + +▸ **expire**(`key`, `secs`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `secs` | `number` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[expire](../interfaces/IRedisTransaction.md#expire) + +___ + +### hdel + +▸ **hdel**(`key`, `field`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` \| `string`[] | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[hdel](../interfaces/IRedisTransaction.md#hdel) + +___ + +### hincrby + +▸ **hincrby**(`key`, `field`, `by`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `by` | `number` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[hincrby](../interfaces/IRedisTransaction.md#hincrby) + +___ + +### hset + +▸ **hset**(`key`, `field`, `value`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `field` | `string` | +| `value` | `string` \| `number` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[hset](../interfaces/IRedisTransaction.md#hset) + +___ + +### lpop + +▸ **lpop**(`key`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[lpop](../interfaces/IRedisTransaction.md#lpop) + +___ + +### lpush + +▸ **lpush**(`key`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[lpush](../interfaces/IRedisTransaction.md#lpush) + +___ + +### lrem + +▸ **lrem**(`key`, `count`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `count` | `number` | +| `element` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[lrem](../interfaces/IRedisTransaction.md#lrem) + +___ + +### ltrim + +▸ **ltrim**(`key`, `start`, `stop`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `start` | `number` | +| `stop` | `number` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[ltrim](../interfaces/IRedisTransaction.md#ltrim) + +___ + +### pexpire + +▸ **pexpire**(`key`, `millis`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `millis` | `number` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[pexpire](../interfaces/IRedisTransaction.md#pexpire) + +___ + +### rpop + +▸ **rpop**(`key`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[rpop](../interfaces/IRedisTransaction.md#rpop) + +___ + +### rpoplpush + +▸ **rpoplpush**(`source`, `destination`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `string` | +| `destination` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[rpoplpush](../interfaces/IRedisTransaction.md#rpoplpush) + +___ + +### rpush + +▸ **rpush**(`key`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[rpush](../interfaces/IRedisTransaction.md#rpush) + +___ + +### sadd + +▸ **sadd**(`key`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[sadd](../interfaces/IRedisTransaction.md#sadd) + +___ + +### srem + +▸ **srem**(`key`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` \| `string`[] | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[srem](../interfaces/IRedisTransaction.md#srem) + +___ + +### zadd + +▸ **zadd**(`key`, `score`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `score` | `number` | +| `element` | `string` | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[zadd](../interfaces/IRedisTransaction.md#zadd) + +___ + +### zrem + +▸ **zrem**(`key`, `element`): [`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `element` | `string` \| `string`[] | + +#### Returns + +[`NodeRedisClientMulti`](NodeRedisClientMulti.md) + +#### Implementation of + +[IRedisTransaction](../interfaces/IRedisTransaction.md).[zrem](../interfaces/IRedisTransaction.md#zrem) diff --git a/docs/api/classes/PanicError.md b/docs/api/classes/PanicError.md index 1eb2fe2..3bcc523 100644 --- a/docs/api/classes/PanicError.md +++ b/docs/api/classes/PanicError.md @@ -8,7 +8,9 @@ ↳ **`PanicError`** - ↳↳ [`WorkerError`](WorkerError.md) + ↳↳ [`CallbackEmptyReplyError`](CallbackEmptyReplyError.md) + + ↳↳ [`CallbackInvalidReplyError`](CallbackInvalidReplyError.md) ## Table of contents @@ -16,10 +18,22 @@ - [constructor](PanicError.md#constructor) +### Properties + +- [cause](PanicError.md#cause) +- [message](PanicError.md#message) +- [stack](PanicError.md#stack) +- [prepareStackTrace](PanicError.md#preparestacktrace) +- [stackTraceLimit](PanicError.md#stacktracelimit) + ### Accessors - [name](PanicError.md#name) +### Methods + +- [captureStackTrace](PanicError.md#capturestacktrace) + ## Constructors ### constructor @@ -40,6 +54,77 @@ [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 @@ -53,3 +138,26 @@ #### 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) diff --git a/docs/api/classes/RedisClient.md b/docs/api/classes/RedisClientAbstract.md similarity index 75% rename from docs/api/classes/RedisClient.md rename to docs/api/classes/RedisClientAbstract.md index 4d7eb03..1eb6c01 100644 --- a/docs/api/classes/RedisClient.md +++ b/docs/api/classes/RedisClientAbstract.md @@ -1,12 +1,16 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / RedisClient +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / RedisClientAbstract -# Class: RedisClient +# Class: RedisClientAbstract ## Hierarchy -- `EventEmitter` +- [`EventEmitter`](EventEmitter.md)\<[`TRedisClientEvent`](../README.md#tredisclientevent)\> - ↳ **`RedisClient`** + ↳ **`RedisClientAbstract`** + + ↳↳ [`IoredisClient`](IoredisClient.md) + + ↳↳ [`NodeRedisClient`](NodeRedisClient.md) ## Implements @@ -16,87 +20,86 @@ ### Constructors -- [constructor](RedisClient.md#constructor) +- [constructor](RedisClientAbstract.md#constructor) ### Methods -- [brpoplpush](RedisClient.md#brpoplpush) -- [del](RedisClient.md#del) -- [end](RedisClient.md#end) -- [evalsha](RedisClient.md#evalsha) -- [flushall](RedisClient.md#flushall) -- [get](RedisClient.md#get) -- [getInfo](RedisClient.md#getinfo) -- [halt](RedisClient.md#halt) -- [hdel](RedisClient.md#hdel) -- [hget](RedisClient.md#hget) -- [hgetall](RedisClient.md#hgetall) -- [hkeys](RedisClient.md#hkeys) -- [hlen](RedisClient.md#hlen) -- [hmget](RedisClient.md#hmget) -- [hscan](RedisClient.md#hscan) -- [hscanAll](RedisClient.md#hscanall) -- [hset](RedisClient.md#hset) -- [llen](RedisClient.md#llen) -- [lmove](RedisClient.md#lmove) -- [loadScript](RedisClient.md#loadscript) -- [loadScripts](RedisClient.md#loadscripts) -- [lpoprpush](RedisClient.md#lpoprpush) -- [lrange](RedisClient.md#lrange) -- [lrem](RedisClient.md#lrem) -- [multi](RedisClient.md#multi) -- [psubscribe](RedisClient.md#psubscribe) -- [publish](RedisClient.md#publish) -- [punsubscribe](RedisClient.md#punsubscribe) -- [quit](RedisClient.md#quit) -- [rpop](RedisClient.md#rpop) -- [rpoplpush](RedisClient.md#rpoplpush) -- [runScript](RedisClient.md#runscript) -- [sadd](RedisClient.md#sadd) -- [set](RedisClient.md#set) -- [sismember](RedisClient.md#sismember) -- [smembers](RedisClient.md#smembers) -- [srem](RedisClient.md#srem) -- [sscan](RedisClient.md#sscan) -- [sscanAll](RedisClient.md#sscanall) -- [subscribe](RedisClient.md#subscribe) -- [unsubscribe](RedisClient.md#unsubscribe) -- [unwatch](RedisClient.md#unwatch) -- [updateServerVersion](RedisClient.md#updateserverversion) -- [validateRedisServerSupport](RedisClient.md#validateredisserversupport) -- [validateRedisVersion](RedisClient.md#validateredisversion) -- [watch](RedisClient.md#watch) -- [zadd](RedisClient.md#zadd) -- [zcard](RedisClient.md#zcard) -- [zpoprpush](RedisClient.md#zpoprpush) -- [zrange](RedisClient.md#zrange) -- [zrangebyscore](RedisClient.md#zrangebyscore) -- [zrangebyscorewithscores](RedisClient.md#zrangebyscorewithscores) -- [zrem](RedisClient.md#zrem) -- [zremrangebyscore](RedisClient.md#zremrangebyscore) -- [zrevrange](RedisClient.md#zrevrange) -- [zscan](RedisClient.md#zscan) -- [addScript](RedisClient.md#addscript) +- [brpoplpush](RedisClientAbstract.md#brpoplpush) +- [del](RedisClientAbstract.md#del) +- [emit](RedisClientAbstract.md#emit) +- [end](RedisClientAbstract.md#end) +- [evalsha](RedisClientAbstract.md#evalsha) +- [flushall](RedisClientAbstract.md#flushall) +- [get](RedisClientAbstract.md#get) +- [getInfo](RedisClientAbstract.md#getinfo) +- [halt](RedisClientAbstract.md#halt) +- [hdel](RedisClientAbstract.md#hdel) +- [hget](RedisClientAbstract.md#hget) +- [hgetall](RedisClientAbstract.md#hgetall) +- [hkeys](RedisClientAbstract.md#hkeys) +- [hlen](RedisClientAbstract.md#hlen) +- [hmget](RedisClientAbstract.md#hmget) +- [hscan](RedisClientAbstract.md#hscan) +- [hscanAll](RedisClientAbstract.md#hscanall) +- [hset](RedisClientAbstract.md#hset) +- [llen](RedisClientAbstract.md#llen) +- [lmove](RedisClientAbstract.md#lmove) +- [loadScript](RedisClientAbstract.md#loadscript) +- [loadScripts](RedisClientAbstract.md#loadscripts) +- [lpoprpush](RedisClientAbstract.md#lpoprpush) +- [lrange](RedisClientAbstract.md#lrange) +- [lrem](RedisClientAbstract.md#lrem) +- [multi](RedisClientAbstract.md#multi) +- [on](RedisClientAbstract.md#on) +- [once](RedisClientAbstract.md#once) +- [psubscribe](RedisClientAbstract.md#psubscribe) +- [publish](RedisClientAbstract.md#publish) +- [punsubscribe](RedisClientAbstract.md#punsubscribe) +- [removeAllListeners](RedisClientAbstract.md#removealllisteners) +- [removeListener](RedisClientAbstract.md#removelistener) +- [rpop](RedisClientAbstract.md#rpop) +- [rpoplpush](RedisClientAbstract.md#rpoplpush) +- [runScript](RedisClientAbstract.md#runscript) +- [sadd](RedisClientAbstract.md#sadd) +- [set](RedisClientAbstract.md#set) +- [shutDown](RedisClientAbstract.md#shutdown) +- [sismember](RedisClientAbstract.md#sismember) +- [smembers](RedisClientAbstract.md#smembers) +- [srem](RedisClientAbstract.md#srem) +- [sscan](RedisClientAbstract.md#sscan) +- [sscanAll](RedisClientAbstract.md#sscanall) +- [subscribe](RedisClientAbstract.md#subscribe) +- [unsubscribe](RedisClientAbstract.md#unsubscribe) +- [unwatch](RedisClientAbstract.md#unwatch) +- [updateServerVersion](RedisClientAbstract.md#updateserverversion) +- [validateRedisServerSupport](RedisClientAbstract.md#validateredisserversupport) +- [validateRedisVersion](RedisClientAbstract.md#validateredisversion) +- [watch](RedisClientAbstract.md#watch) +- [zadd](RedisClientAbstract.md#zadd) +- [zcard](RedisClientAbstract.md#zcard) +- [zpoprpush](RedisClientAbstract.md#zpoprpush) +- [zrange](RedisClientAbstract.md#zrange) +- [zrangebyscore](RedisClientAbstract.md#zrangebyscore) +- [zrangebyscorewithscores](RedisClientAbstract.md#zrangebyscorewithscores) +- [zrem](RedisClientAbstract.md#zrem) +- [zremrangebyscore](RedisClientAbstract.md#zremrangebyscore) +- [zrevrange](RedisClientAbstract.md#zrevrange) +- [zscan](RedisClientAbstract.md#zscan) +- [addScript](RedisClientAbstract.md#addscript) ## Constructors ### constructor -• **new RedisClient**(`options?`): [`RedisClient`](RedisClient.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `EventEmitterOptions` | +• **new RedisClientAbstract**(): [`RedisClientAbstract`](RedisClientAbstract.md) #### Returns -[`RedisClient`](RedisClient.md) +[`RedisClientAbstract`](RedisClientAbstract.md) #### Inherited from -EventEmitter.constructor +[EventEmitter](EventEmitter.md).[constructor](EventEmitter.md#constructor) ## Methods @@ -144,6 +147,37 @@ ___ ___ +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TRedisClientEvent`](../README.md#tredisclientevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Implementation of + +[IRedisClient](../interfaces/IRedisClient.md).[emit](../interfaces/IRedisClient.md#emit) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) + +___ + ### end ▸ **end**(`flush`): `void` @@ -636,6 +670,68 @@ ___ ___ +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`RedisClientAbstract`](RedisClientAbstract.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`RedisClientAbstract`](RedisClientAbstract.md) + +#### Implementation of + +[IRedisClient](../interfaces/IRedisClient.md).[on](../interfaces/IRedisClient.md#on) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`RedisClientAbstract`](RedisClientAbstract.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`RedisClientAbstract`](RedisClientAbstract.md) + +#### Implementation of + +[IRedisClient](../interfaces/IRedisClient.md).[once](../interfaces/IRedisClient.md#once) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) + +___ + ### psubscribe ▸ **psubscribe**(`pattern`): `void` @@ -680,13 +776,13 @@ ___ ### punsubscribe -▸ **punsubscribe**(`channel`): `void` +▸ **punsubscribe**(`channel?`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `channel` | `string` | +| `channel?` | `string` | #### Returns @@ -698,23 +794,64 @@ ___ ___ -### quit +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`RedisClientAbstract`](RedisClientAbstract.md) -▸ **quit**(`cb`): `void` +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | #### Parameters | Name | Type | | :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | +| `event?` | `Extract`\<`E`, `string`\> | #### Returns -`void` +[`RedisClientAbstract`](RedisClientAbstract.md) + +#### Implementation of + +[IRedisClient](../interfaces/IRedisClient.md).[removeAllListeners](../interfaces/IRedisClient.md#removealllisteners) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`RedisClientAbstract`](RedisClientAbstract.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`RedisClientAbstract`](RedisClientAbstract.md) #### Implementation of -[IRedisClient](../interfaces/IRedisClient.md).[quit](../interfaces/IRedisClient.md#quit) +[IRedisClient](../interfaces/IRedisClient.md).[removeListener](../interfaces/IRedisClient.md#removelistener) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[removeListener](EventEmitter.md#removelistener) ___ @@ -833,6 +970,26 @@ ___ ___ +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Implementation of + +[IRedisClient](../interfaces/IRedisClient.md).[shutDown](../interfaces/IRedisClient.md#shutdown) + +___ + ### sismember ▸ **sismember**(`key`, `member`, `cb`): `void` @@ -969,13 +1126,13 @@ ___ ### unsubscribe -▸ **unsubscribe**(`channel`): `void` +▸ **unsubscribe**(`channel?`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `channel` | `string` | +| `channel?` | `string` | #### Returns diff --git a/docs/api/classes/RedisClientError.md b/docs/api/classes/RedisClientError.md index b4325ba..2b19df1 100644 --- a/docs/api/classes/RedisClientError.md +++ b/docs/api/classes/RedisClientError.md @@ -16,10 +16,22 @@ - [constructor](RedisClientError.md#constructor) +### Properties + +- [cause](RedisClientError.md#cause) +- [message](RedisClientError.md#message) +- [stack](RedisClientError.md#stack) +- [prepareStackTrace](RedisClientError.md#preparestacktrace) +- [stackTraceLimit](RedisClientError.md#stacktracelimit) + ### Accessors - [name](RedisClientError.md#name) +### Methods + +- [captureStackTrace](RedisClientError.md#capturestacktrace) + ## Constructors ### constructor @@ -40,6 +52,77 @@ [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 @@ -53,3 +136,26 @@ #### 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) diff --git a/docs/api/classes/RedisSMQError.md b/docs/api/classes/RedisSMQError.md index 3410af9..21e4c0f 100644 --- a/docs/api/classes/RedisSMQError.md +++ b/docs/api/classes/RedisSMQError.md @@ -8,30 +8,44 @@ ↳ **`RedisSMQError`** - ↳↳ [`CallbackEmptyReplyError`](CallbackEmptyReplyError.md) - - ↳↳ [`CallbackInvalidReplyError`](CallbackInvalidReplyError.md) - ↳↳ [`PanicError`](PanicError.md) - ↳↳ [`LoggerError`](LoggerError.md) + ↳↳ [`AbortError`](AbortError.md) - ↳↳ [`TickerError`](TickerError.md) + ↳↳ [`EventBusError`](EventBusError.md) ↳↳ [`LockError`](LockError.md) + ↳↳ [`LoggerError`](LoggerError.md) + ↳↳ [`RedisClientError`](RedisClientError.md) + ↳↳ [`TimerError`](TimerError.md) + + ↳↳ [`WorkerError`](WorkerError.md) + ## Table of contents ### Constructors - [constructor](RedisSMQError.md#constructor) +### Properties + +- [cause](RedisSMQError.md#cause) +- [message](RedisSMQError.md#message) +- [stack](RedisSMQError.md#stack) +- [prepareStackTrace](RedisSMQError.md#preparestacktrace) +- [stackTraceLimit](RedisSMQError.md#stacktracelimit) + ### Accessors - [name](RedisSMQError.md#name) +### Methods + +- [captureStackTrace](RedisSMQError.md#capturestacktrace) + ## Constructors ### constructor @@ -52,6 +66,77 @@ Error.constructor +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.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 + +Error.prepareStackTrace + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + ## Accessors ### name @@ -65,3 +150,26 @@ Error.constructor #### Overrides Error.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 + +Error.captureStackTrace diff --git a/docs/api/classes/Runnable.md b/docs/api/classes/Runnable.md new file mode 100644 index 0000000..105f962 --- /dev/null +++ b/docs/api/classes/Runnable.md @@ -0,0 +1,263 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / Runnable + +# Class: Runnable\ + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Event` | extends [`TEventEmitterEvent`](../README.md#teventemitterevent) | + +## Hierarchy + +- [`EventEmitter`](EventEmitter.md)\<`Event`\> + + ↳ **`Runnable`** + + ↳↳ [`Locker`](Locker.md) + + ↳↳ [`WorkerResourceGroup`](WorkerResourceGroup.md) + +## Table of contents + +### Methods + +- [emit](Runnable.md#emit) +- [getId](Runnable.md#getid) +- [isDown](Runnable.md#isdown) +- [isGoingDown](Runnable.md#isgoingdown) +- [isGoingUp](Runnable.md#isgoingup) +- [isRunning](Runnable.md#isrunning) +- [isUp](Runnable.md#isup) +- [on](Runnable.md#on) +- [once](Runnable.md#once) +- [removeAllListeners](Runnable.md#removealllisteners) +- [removeListener](Runnable.md#removelistener) +- [run](Runnable.md#run) +- [shutdown](Runnable.md#shutdown) + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`Event`[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) + +___ + +### getId + +▸ **getId**(): `string` + +#### Returns + +`string` + +___ + +### isDown + +▸ **isDown**(): `boolean` + +#### Returns + +`boolean` + +___ + +### isGoingDown + +▸ **isGoingDown**(): `boolean` + +#### Returns + +`boolean` + +___ + +### isGoingUp + +▸ **isGoingUp**(): `boolean` + +#### Returns + +`boolean` + +___ + +### isRunning + +▸ **isRunning**(): `boolean` + +#### Returns + +`boolean` + +___ + +### isUp + +▸ **isUp**(): `boolean` + +#### Returns + +`boolean` + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`Runnable`](Runnable.md)\<`Event`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Event`[`E`] | + +#### Returns + +[`Runnable`](Runnable.md)\<`Event`\> + +#### Inherited from + +[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`Runnable`](Runnable.md)\<`Event`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Event`[`E`] | + +#### Returns + +[`Runnable`](Runnable.md)\<`Event`\> + +#### Inherited from + +[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`Runnable`](Runnable.md)\<`Event`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`Runnable`](Runnable.md)\<`Event`\> + +#### Inherited from + +[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`Runnable`](Runnable.md)\<`Event`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Event`[`E`] | + +#### Returns + +[`Runnable`](Runnable.md)\<`Event`\> + +#### Inherited from + +[EventEmitter](EventEmitter.md).[removeListener](EventEmitter.md#removelistener) + +___ + +### run + +▸ **run**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`boolean`\> | + +#### Returns + +`void` + +___ + +### shutdown + +▸ **shutdown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` diff --git a/docs/api/classes/Ticker.md b/docs/api/classes/Ticker.md deleted file mode 100644 index 3abe368..0000000 --- a/docs/api/classes/Ticker.md +++ /dev/null @@ -1,222 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / Ticker - -# Class: Ticker - -## Hierarchy - -- [`EventEmitter`](EventEmitter.md)\<[`TEvent`](../README.md#tevent)\> - - ↳ **`Ticker`** - -## Table of contents - -### Constructors - -- [constructor](Ticker.md#constructor) - -### Methods - -- [abort](Ticker.md#abort) -- [emit](Ticker.md#emit) -- [isTicking](Ticker.md#isticking) -- [nextTick](Ticker.md#nexttick) -- [nextTickFn](Ticker.md#nexttickfn) -- [on](Ticker.md#on) -- [once](Ticker.md#once) -- [quit](Ticker.md#quit) -- [removeAllListeners](Ticker.md#removealllisteners) -- [runTimer](Ticker.md#runtimer) - -## Constructors - -### constructor - -• **new Ticker**(`onTickFn?`, `time?`): [`Ticker`](Ticker.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `onTickFn` | [`TFunction`](../README.md#tfunction) | `undefined` | -| `time` | `number` | `1000` | - -#### Returns - -[`Ticker`](Ticker.md) - -#### Overrides - -[EventEmitter](EventEmitter.md).[constructor](EventEmitter.md#constructor) - -## Methods - -### abort - -▸ **abort**(): `void` - -#### Returns - -`void` - -___ - -### emit - -▸ **emit**\<`E`\>(`event`, `...args`): `boolean` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `E` | -| `...args` | `Parameters`\<[`TEvent`](../README.md#tevent)[`E`]\> | - -#### Returns - -`boolean` - -#### Inherited from - -[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) - -___ - -### isTicking - -▸ **isTicking**(): `boolean` - -#### Returns - -`boolean` - -___ - -### nextTick - -▸ **nextTick**(): `void` - -#### Returns - -`void` - -___ - -### nextTickFn - -▸ **nextTickFn**(`fn`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fn` | [`TFunction`](../README.md#tfunction) | - -#### Returns - -`void` - -___ - -### on - -▸ **on**\<`E`\>(`event`, `listener`): [`Ticker`](Ticker.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `E` | -| `listener` | [`TEvent`](../README.md#tevent)[`E`] | - -#### Returns - -[`Ticker`](Ticker.md) - -#### Inherited from - -[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) - -___ - -### once - -▸ **once**\<`E`\>(`event`, `listener`): [`Ticker`](Ticker.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `E` | -| `listener` | [`TEvent`](../README.md#tevent)[`E`] | - -#### Returns - -[`Ticker`](Ticker.md) - -#### Inherited from - -[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) - -___ - -### quit - -▸ **quit**(): `void` - -#### Returns - -`void` - -___ - -### removeAllListeners - -▸ **removeAllListeners**\<`E`\>(`event?`): [`Ticker`](Ticker.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `E` | - -#### Returns - -[`Ticker`](Ticker.md) - -#### Inherited from - -[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) - -___ - -### runTimer - -▸ **runTimer**(): `void` - -#### Returns - -`void` diff --git a/docs/api/classes/TickerError.md b/docs/api/classes/TickerError.md deleted file mode 100644 index 26e3dd6..0000000 --- a/docs/api/classes/TickerError.md +++ /dev/null @@ -1,53 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / TickerError - -# Class: TickerError - -## Hierarchy - -- [`RedisSMQError`](RedisSMQError.md) - - ↳ **`TickerError`** - -## Table of contents - -### Constructors - -- [constructor](TickerError.md#constructor) - -### Accessors - -- [name](TickerError.md#name) - -## Constructors - -### constructor - -• **new TickerError**(`message?`): [`TickerError`](TickerError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`TickerError`](TickerError.md) - -#### Inherited from - -[RedisSMQError](RedisSMQError.md).[constructor](RedisSMQError.md#constructor) - -## Accessors - -### name - -• `get` **name**(): `string` - -#### Returns - -`string` - -#### Inherited from - -RedisSMQError.name diff --git a/docs/api/classes/Timer.md b/docs/api/classes/Timer.md new file mode 100644 index 0000000..d2a24ef --- /dev/null +++ b/docs/api/classes/Timer.md @@ -0,0 +1,218 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / Timer + +# Class: Timer + +## Hierarchy + +- [`EventEmitter`](EventEmitter.md)\<[`TTimerEvent`](../README.md#ttimerevent)\> + + ↳ **`Timer`** + +## Table of contents + +### Constructors + +- [constructor](Timer.md#constructor) + +### Methods + +- [emit](Timer.md#emit) +- [on](Timer.md#on) +- [once](Timer.md#once) +- [removeAllListeners](Timer.md#removealllisteners) +- [removeListener](Timer.md#removelistener) +- [reset](Timer.md#reset) +- [setInterval](Timer.md#setinterval) +- [setTimeout](Timer.md#settimeout) + +## Constructors + +### constructor + +• **new Timer**(): [`Timer`](Timer.md) + +#### Returns + +[`Timer`](Timer.md) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[constructor](EventEmitter.md#constructor) + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TTimerEvent`](../README.md#ttimerevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`Timer`](Timer.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TTimerEvent`](../README.md#ttimerevent)[`E`] | + +#### Returns + +[`Timer`](Timer.md) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`Timer`](Timer.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TTimerEvent`](../README.md#ttimerevent)[`E`] | + +#### Returns + +[`Timer`](Timer.md) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`Timer`](Timer.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`Timer`](Timer.md) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`Timer`](Timer.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TTimerEvent`](../README.md#ttimerevent)[`E`] | + +#### Returns + +[`Timer`](Timer.md) + +#### Inherited from + +[EventEmitter](EventEmitter.md).[removeListener](EventEmitter.md#removelistener) + +___ + +### reset + +▸ **reset**(): `void` + +#### Returns + +`void` + +___ + +### setInterval + +▸ **setInterval**(`fn`, `interval?`): `boolean` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `fn` | [`TFunction`](../README.md#tfunction) | `undefined` | +| `interval` | `number` | `1000` | + +#### Returns + +`boolean` + +___ + +### setTimeout + +▸ **setTimeout**(`fn`, `timeout`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fn` | [`TFunction`](../README.md#tfunction) | +| `timeout` | `number` | + +#### Returns + +`boolean` diff --git a/docs/api/classes/TimerError.md b/docs/api/classes/TimerError.md new file mode 100644 index 0000000..2fbc0b6 --- /dev/null +++ b/docs/api/classes/TimerError.md @@ -0,0 +1,159 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / TimerError + +# Class: TimerError + +## Hierarchy + +- [`RedisSMQError`](RedisSMQError.md) + + ↳ **`TimerError`** + +## Table of contents + +### Constructors + +- [constructor](TimerError.md#constructor) + +### Properties + +- [cause](TimerError.md#cause) +- [message](TimerError.md#message) +- [stack](TimerError.md#stack) +- [prepareStackTrace](TimerError.md#preparestacktrace) +- [stackTraceLimit](TimerError.md#stacktracelimit) + +### Accessors + +- [name](TimerError.md#name) + +### Methods + +- [captureStackTrace](TimerError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new TimerError**(`message?`): [`TimerError`](TimerError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`TimerError`](TimerError.md) + +#### Inherited from + +[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 + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### 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) diff --git a/docs/api/classes/WatchedKeysChangedError.md b/docs/api/classes/WatchedKeysChangedError.md index 2a24b91..02adafd 100644 --- a/docs/api/classes/WatchedKeysChangedError.md +++ b/docs/api/classes/WatchedKeysChangedError.md @@ -14,10 +14,22 @@ - [constructor](WatchedKeysChangedError.md#constructor) +### Properties + +- [cause](WatchedKeysChangedError.md#cause) +- [message](WatchedKeysChangedError.md#message) +- [stack](WatchedKeysChangedError.md#stack) +- [prepareStackTrace](WatchedKeysChangedError.md#preparestacktrace) +- [stackTraceLimit](WatchedKeysChangedError.md#stacktracelimit) + ### Accessors - [name](WatchedKeysChangedError.md#name) +### Methods + +- [captureStackTrace](WatchedKeysChangedError.md#capturestacktrace) + ## Constructors ### constructor @@ -38,6 +50,77 @@ [RedisClientError](RedisClientError.md).[constructor](RedisClientError.md#constructor) +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[RedisClientError](RedisClientError.md).[cause](RedisClientError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[RedisClientError](RedisClientError.md).[message](RedisClientError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[RedisClientError](RedisClientError.md).[stack](RedisClientError.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 + +[RedisClientError](RedisClientError.md).[prepareStackTrace](RedisClientError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[RedisClientError](RedisClientError.md).[stackTraceLimit](RedisClientError.md#stacktracelimit) + ## Accessors ### name @@ -51,3 +134,26 @@ #### Inherited from RedisClientError.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 + +[RedisClientError](RedisClientError.md).[captureStackTrace](RedisClientError.md#capturestacktrace) diff --git a/docs/api/classes/Worker.md b/docs/api/classes/Worker.md deleted file mode 100644 index bf2e246..0000000 --- a/docs/api/classes/Worker.md +++ /dev/null @@ -1,80 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / Worker - -# Class: Worker - -## Table of contents - -### Constructors - -- [constructor](Worker.md#constructor) - -### Methods - -- [quit](Worker.md#quit) -- [run](Worker.md#run) -- [work](Worker.md#work) - -## Constructors - -### constructor - -• **new Worker**(`managed`, `timeout?`): [`Worker`](Worker.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `managed` | `boolean` | `undefined` | -| `timeout` | `number` | `1000` | - -#### Returns - -[`Worker`](Worker.md) - -## Methods - -### quit - -▸ **quit**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` - -___ - -### run - -▸ **run**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` - -___ - -### work - -▸ **work**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` diff --git a/docs/api/classes/WorkerAlreadyDownError.md b/docs/api/classes/WorkerAlreadyDownError.md new file mode 100644 index 0000000..5ce7d34 --- /dev/null +++ b/docs/api/classes/WorkerAlreadyDownError.md @@ -0,0 +1,153 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerAlreadyDownError + +# Class: WorkerAlreadyDownError + +## Hierarchy + +- [`WorkerError`](WorkerError.md) + + ↳ **`WorkerAlreadyDownError`** + +## Table of contents + +### Constructors + +- [constructor](WorkerAlreadyDownError.md#constructor) + +### Properties + +- [cause](WorkerAlreadyDownError.md#cause) +- [message](WorkerAlreadyDownError.md#message) +- [stack](WorkerAlreadyDownError.md#stack) +- [prepareStackTrace](WorkerAlreadyDownError.md#preparestacktrace) +- [stackTraceLimit](WorkerAlreadyDownError.md#stacktracelimit) + +### Accessors + +- [name](WorkerAlreadyDownError.md#name) + +### Methods + +- [captureStackTrace](WorkerAlreadyDownError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new WorkerAlreadyDownError**(): [`WorkerAlreadyDownError`](WorkerAlreadyDownError.md) + +#### Returns + +[`WorkerAlreadyDownError`](WorkerAlreadyDownError.md) + +#### Overrides + +[WorkerError](WorkerError.md).[constructor](WorkerError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[WorkerError](WorkerError.md).[cause](WorkerError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[message](WorkerError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[stack](WorkerError.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 + +[WorkerError](WorkerError.md).[prepareStackTrace](WorkerError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[WorkerError](WorkerError.md).[stackTraceLimit](WorkerError.md#stacktracelimit) + +## Accessors + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Inherited from + +WorkerError.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 + +[WorkerError](WorkerError.md).[captureStackTrace](WorkerError.md#capturestacktrace) diff --git a/docs/api/classes/WorkerAlreadyRunningError.md b/docs/api/classes/WorkerAlreadyRunningError.md new file mode 100644 index 0000000..d936b50 --- /dev/null +++ b/docs/api/classes/WorkerAlreadyRunningError.md @@ -0,0 +1,153 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerAlreadyRunningError + +# Class: WorkerAlreadyRunningError + +## Hierarchy + +- [`WorkerError`](WorkerError.md) + + ↳ **`WorkerAlreadyRunningError`** + +## Table of contents + +### Constructors + +- [constructor](WorkerAlreadyRunningError.md#constructor) + +### Properties + +- [cause](WorkerAlreadyRunningError.md#cause) +- [message](WorkerAlreadyRunningError.md#message) +- [stack](WorkerAlreadyRunningError.md#stack) +- [prepareStackTrace](WorkerAlreadyRunningError.md#preparestacktrace) +- [stackTraceLimit](WorkerAlreadyRunningError.md#stacktracelimit) + +### Accessors + +- [name](WorkerAlreadyRunningError.md#name) + +### Methods + +- [captureStackTrace](WorkerAlreadyRunningError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new WorkerAlreadyRunningError**(): [`WorkerAlreadyRunningError`](WorkerAlreadyRunningError.md) + +#### Returns + +[`WorkerAlreadyRunningError`](WorkerAlreadyRunningError.md) + +#### Overrides + +[WorkerError](WorkerError.md).[constructor](WorkerError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[WorkerError](WorkerError.md).[cause](WorkerError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[message](WorkerError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[stack](WorkerError.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 + +[WorkerError](WorkerError.md).[prepareStackTrace](WorkerError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[WorkerError](WorkerError.md).[stackTraceLimit](WorkerError.md#stacktracelimit) + +## Accessors + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Inherited from + +WorkerError.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 + +[WorkerError](WorkerError.md).[captureStackTrace](WorkerError.md#capturestacktrace) diff --git a/docs/api/classes/WorkerCallable.md b/docs/api/classes/WorkerCallable.md new file mode 100644 index 0000000..78eb5f8 --- /dev/null +++ b/docs/api/classes/WorkerCallable.md @@ -0,0 +1,238 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerCallable + +# Class: WorkerCallable\ + +## Type parameters + +| Name | +| :------ | +| `Payload` | +| `Reply` | + +## Hierarchy + +- `Worker` + + ↳ **`WorkerCallable`** + +## Implements + +- [`IWorkerCallable`](../interfaces/IWorkerCallable.md)\<`Payload`, `Reply`\> + +## Table of contents + +### Constructors + +- [constructor](WorkerCallable.md#constructor) + +### Methods + +- [call](WorkerCallable.md#call) +- [emit](WorkerCallable.md#emit) +- [on](WorkerCallable.md#on) +- [once](WorkerCallable.md#once) +- [removeAllListeners](WorkerCallable.md#removealllisteners) +- [removeListener](WorkerCallable.md#removelistener) +- [shutDown](WorkerCallable.md#shutdown) + +## Constructors + +### constructor + +• **new WorkerCallable**\<`Payload`, `Reply`\>(`workerFilename`): [`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Type parameters + +| Name | +| :------ | +| `Payload` | +| `Reply` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `workerFilename` | `string` | + +#### Returns + +[`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Inherited from + +Worker.constructor + +## Methods + +### call + +▸ **call**(`payload`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | `Payload` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`Reply`\> | + +#### Returns + +`void` + +#### Implementation of + +[IWorkerCallable](../interfaces/IWorkerCallable.md).[call](../interfaces/IWorkerCallable.md#call) + +___ + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`TWorkerEvent`[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +Worker.emit + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `TWorkerEvent`[`E`] | + +#### Returns + +[`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Inherited from + +Worker.on + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `TWorkerEvent`[`E`] | + +#### Returns + +[`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Inherited from + +Worker.once + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Inherited from + +Worker.removeAllListeners + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `TWorkerEvent`[`E`] | + +#### Returns + +[`WorkerCallable`](WorkerCallable.md)\<`Payload`, `Reply`\> + +#### Inherited from + +Worker.removeListener + +___ + +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +Worker.shutDown diff --git a/docs/api/classes/WorkerError.md b/docs/api/classes/WorkerError.md index 48c0d22..ff6cedc 100644 --- a/docs/api/classes/WorkerError.md +++ b/docs/api/classes/WorkerError.md @@ -4,20 +4,40 @@ ## Hierarchy -- [`PanicError`](PanicError.md) +- [`RedisSMQError`](RedisSMQError.md) ↳ **`WorkerError`** + ↳↳ [`WorkerThreadError`](WorkerThreadError.md) + + ↳↳ [`WorkerPayloadRequiredError`](WorkerPayloadRequiredError.md) + + ↳↳ [`WorkerAlreadyRunningError`](WorkerAlreadyRunningError.md) + + ↳↳ [`WorkerAlreadyDownError`](WorkerAlreadyDownError.md) + ## Table of contents ### Constructors - [constructor](WorkerError.md#constructor) +### Properties + +- [cause](WorkerError.md#cause) +- [message](WorkerError.md#message) +- [stack](WorkerError.md#stack) +- [prepareStackTrace](WorkerError.md#preparestacktrace) +- [stackTraceLimit](WorkerError.md#stacktracelimit) + ### Accessors - [name](WorkerError.md#name) +### Methods + +- [captureStackTrace](WorkerError.md#capturestacktrace) + ## Constructors ### constructor @@ -36,7 +56,78 @@ #### Inherited from -[PanicError](PanicError.md).[constructor](PanicError.md#constructor) +[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 @@ -50,4 +141,27 @@ #### Inherited from -PanicError.name +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) diff --git a/docs/api/classes/WorkerPayloadRequiredError.md b/docs/api/classes/WorkerPayloadRequiredError.md new file mode 100644 index 0000000..2d93f3f --- /dev/null +++ b/docs/api/classes/WorkerPayloadRequiredError.md @@ -0,0 +1,153 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerPayloadRequiredError + +# Class: WorkerPayloadRequiredError + +## Hierarchy + +- [`WorkerError`](WorkerError.md) + + ↳ **`WorkerPayloadRequiredError`** + +## Table of contents + +### Constructors + +- [constructor](WorkerPayloadRequiredError.md#constructor) + +### Properties + +- [cause](WorkerPayloadRequiredError.md#cause) +- [message](WorkerPayloadRequiredError.md#message) +- [stack](WorkerPayloadRequiredError.md#stack) +- [prepareStackTrace](WorkerPayloadRequiredError.md#preparestacktrace) +- [stackTraceLimit](WorkerPayloadRequiredError.md#stacktracelimit) + +### Accessors + +- [name](WorkerPayloadRequiredError.md#name) + +### Methods + +- [captureStackTrace](WorkerPayloadRequiredError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new WorkerPayloadRequiredError**(): [`WorkerPayloadRequiredError`](WorkerPayloadRequiredError.md) + +#### Returns + +[`WorkerPayloadRequiredError`](WorkerPayloadRequiredError.md) + +#### Overrides + +[WorkerError](WorkerError.md).[constructor](WorkerError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[WorkerError](WorkerError.md).[cause](WorkerError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[message](WorkerError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[stack](WorkerError.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 + +[WorkerError](WorkerError.md).[prepareStackTrace](WorkerError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[WorkerError](WorkerError.md).[stackTraceLimit](WorkerError.md#stacktracelimit) + +## Accessors + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Inherited from + +WorkerError.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 + +[WorkerError](WorkerError.md).[captureStackTrace](WorkerError.md#capturestacktrace) diff --git a/docs/api/classes/WorkerPool.md b/docs/api/classes/WorkerPool.md deleted file mode 100644 index c73b2f6..0000000 --- a/docs/api/classes/WorkerPool.md +++ /dev/null @@ -1,73 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerPool - -# Class: WorkerPool - -## Table of contents - -### Constructors - -- [constructor](WorkerPool.md#constructor) - -### Methods - -- [add](WorkerPool.md#add) -- [clear](WorkerPool.md#clear) -- [work](WorkerPool.md#work) - -## Constructors - -### constructor - -• **new WorkerPool**(): [`WorkerPool`](WorkerPool.md) - -#### Returns - -[`WorkerPool`](WorkerPool.md) - -## Methods - -### add - -▸ **add**(`worker`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `worker` | [`Worker`](Worker.md) | - -#### Returns - -`number` - -___ - -### clear - -▸ **clear**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` - -___ - -### work - -▸ **work**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` diff --git a/docs/api/classes/WorkerResourceGroup.md b/docs/api/classes/WorkerResourceGroup.md new file mode 100644 index 0000000..5122a25 --- /dev/null +++ b/docs/api/classes/WorkerResourceGroup.md @@ -0,0 +1,348 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerResourceGroup + +# Class: WorkerResourceGroup + +## Hierarchy + +- [`Runnable`](Runnable.md)\<[`TWorkerResourceGroupEvent`](../README.md#tworkerresourcegroupevent)\> + + ↳ **`WorkerResourceGroup`** + +## Table of contents + +### Constructors + +- [constructor](WorkerResourceGroup.md#constructor) + +### Methods + +- [addWorker](WorkerResourceGroup.md#addworker) +- [emit](WorkerResourceGroup.md#emit) +- [getId](WorkerResourceGroup.md#getid) +- [isDown](WorkerResourceGroup.md#isdown) +- [isGoingDown](WorkerResourceGroup.md#isgoingdown) +- [isGoingUp](WorkerResourceGroup.md#isgoingup) +- [isRunning](WorkerResourceGroup.md#isrunning) +- [isUp](WorkerResourceGroup.md#isup) +- [loadFromDir](WorkerResourceGroup.md#loadfromdir) +- [on](WorkerResourceGroup.md#on) +- [once](WorkerResourceGroup.md#once) +- [removeAllListeners](WorkerResourceGroup.md#removealllisteners) +- [removeListener](WorkerResourceGroup.md#removelistener) +- [run](WorkerResourceGroup.md#run) +- [shutdown](WorkerResourceGroup.md#shutdown) + +## Constructors + +### constructor + +• **new WorkerResourceGroup**(`redisClient`, `logger`, `resourceGroupId`): [`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `redisClient` | [`IRedisClient`](../interfaces/IRedisClient.md) | +| `logger` | [`ILogger`](../interfaces/ILogger.md) | +| `resourceGroupId` | `string` | + +#### Returns + +[`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Overrides + +Runnable\<TWorkerResourceGroupEvent\>.constructor + +## Methods + +### addWorker + +▸ **addWorker**(`filename`, `payload`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filename` | `string` | +| `payload` | `unknown` | + +#### Returns + +`void` + +___ + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"workerResourceGroup.error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TWorkerResourceGroupEvent`](../README.md#tworkerresourcegroupevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[emit](Runnable.md#emit) + +___ + +### getId + +▸ **getId**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[Runnable](Runnable.md).[getId](Runnable.md#getid) + +___ + +### isDown + +▸ **isDown**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isDown](Runnable.md#isdown) + +___ + +### isGoingDown + +▸ **isGoingDown**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isGoingDown](Runnable.md#isgoingdown) + +___ + +### isGoingUp + +▸ **isGoingUp**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isGoingUp](Runnable.md#isgoingup) + +___ + +### isRunning + +▸ **isRunning**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isRunning](Runnable.md#isrunning) + +___ + +### isUp + +▸ **isUp**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[Runnable](Runnable.md).[isUp](Runnable.md#isup) + +___ + +### loadFromDir + +▸ **loadFromDir**(`workersDir`, `payload`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `workersDir` | `string` | +| `payload` | `unknown` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"workerResourceGroup.error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TWorkerResourceGroupEvent`](../README.md#tworkerresourcegroupevent)[`E`] | + +#### Returns + +[`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Inherited from + +[Runnable](Runnable.md).[on](Runnable.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"workerResourceGroup.error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TWorkerResourceGroupEvent`](../README.md#tworkerresourcegroupevent)[`E`] | + +#### Returns + +[`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Inherited from + +[Runnable](Runnable.md).[once](Runnable.md#once) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"workerResourceGroup.error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Inherited from + +[Runnable](Runnable.md).[removeAllListeners](Runnable.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends ``"workerResourceGroup.error"`` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TWorkerResourceGroupEvent`](../README.md#tworkerresourcegroupevent)[`E`] | + +#### Returns + +[`WorkerResourceGroup`](WorkerResourceGroup.md) + +#### Inherited from + +[Runnable](Runnable.md).[removeListener](Runnable.md#removelistener) + +___ + +### run + +▸ **run**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`boolean`\> | + +#### Returns + +`void` + +#### Inherited from + +[Runnable](Runnable.md).[run](Runnable.md#run) + +___ + +### shutdown + +▸ **shutdown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Inherited from + +[Runnable](Runnable.md).[shutdown](Runnable.md#shutdown) diff --git a/docs/api/classes/WorkerRunnable.md b/docs/api/classes/WorkerRunnable.md new file mode 100644 index 0000000..31f2bf8 --- /dev/null +++ b/docs/api/classes/WorkerRunnable.md @@ -0,0 +1,236 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerRunnable + +# Class: WorkerRunnable\ + +## Type parameters + +| Name | +| :------ | +| `Payload` | + +## Hierarchy + +- `Worker` + + ↳ **`WorkerRunnable`** + +## Implements + +- [`IWorkerRunnable`](../interfaces/IWorkerRunnable.md)\<`Payload`\> + +## Table of contents + +### Constructors + +- [constructor](WorkerRunnable.md#constructor) + +### Methods + +- [emit](WorkerRunnable.md#emit) +- [on](WorkerRunnable.md#on) +- [once](WorkerRunnable.md#once) +- [removeAllListeners](WorkerRunnable.md#removealllisteners) +- [removeListener](WorkerRunnable.md#removelistener) +- [run](WorkerRunnable.md#run) +- [shutDown](WorkerRunnable.md#shutdown) + +## Constructors + +### constructor + +• **new WorkerRunnable**\<`Payload`\>(`workerFilename`): [`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Type parameters + +| Name | +| :------ | +| `Payload` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `workerFilename` | `string` | + +#### Returns + +[`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Overrides + +Worker.constructor + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`TWorkerEvent`[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +Worker.emit + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `TWorkerEvent`[`E`] | + +#### Returns + +[`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Inherited from + +Worker.on + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `TWorkerEvent`[`E`] | + +#### Returns + +[`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Inherited from + +Worker.once + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Extract`\<`E`, `string`\> | + +#### Returns + +[`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Inherited from + +Worker.removeAllListeners + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof `TWorkerEvent` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `TWorkerEvent`[`E`] | + +#### Returns + +[`WorkerRunnable`](WorkerRunnable.md)\<`Payload`\> + +#### Inherited from + +Worker.removeListener + +___ + +### run + +▸ **run**(`initialPayload`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `initialPayload` | `Payload` | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Implementation of + +[IWorkerRunnable](../interfaces/IWorkerRunnable.md).[run](../interfaces/IWorkerRunnable.md#run) + +___ + +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | + +#### Returns + +`void` + +#### Overrides + +Worker.shutDown diff --git a/docs/api/classes/WorkerRunner.md b/docs/api/classes/WorkerRunner.md deleted file mode 100644 index 480ec1b..0000000 --- a/docs/api/classes/WorkerRunner.md +++ /dev/null @@ -1,203 +0,0 @@ -[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerRunner - -# Class: WorkerRunner - -## Hierarchy - -- [`EventEmitter`](EventEmitter.md)\<[`TEvent`](../README.md#tevent)\> - - ↳ **`WorkerRunner`** - -## Table of contents - -### Constructors - -- [constructor](WorkerRunner.md#constructor) - -### Methods - -- [addWorker](WorkerRunner.md#addworker) -- [emit](WorkerRunner.md#emit) -- [on](WorkerRunner.md#on) -- [once](WorkerRunner.md#once) -- [quit](WorkerRunner.md#quit) -- [removeAllListeners](WorkerRunner.md#removealllisteners) -- [run](WorkerRunner.md#run) - -## Constructors - -### constructor - -• **new WorkerRunner**(`redisClient`, `keyLock`, `workerPool`, `logger`): [`WorkerRunner`](WorkerRunner.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `redisClient` | [`RedisClient`](RedisClient.md) | -| `keyLock` | `string` | -| `workerPool` | [`WorkerPool`](WorkerPool.md) | -| `logger` | [`ILogger`](../interfaces/ILogger.md) | - -#### Returns - -[`WorkerRunner`](WorkerRunner.md) - -#### Overrides - -[EventEmitter](EventEmitter.md).[constructor](EventEmitter.md#constructor) - -## Methods - -### addWorker - -▸ **addWorker**(`instance`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | [`Worker`](Worker.md) | - -#### Returns - -`void` - -___ - -### emit - -▸ **emit**\<`E`\>(`event`, `...args`): `boolean` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `E` | -| `...args` | `Parameters`\<[`TEvent`](../README.md#tevent)[`E`]\> | - -#### Returns - -`boolean` - -#### Inherited from - -[EventEmitter](EventEmitter.md).[emit](EventEmitter.md#emit) - -___ - -### on - -▸ **on**\<`E`\>(`event`, `listener`): [`WorkerRunner`](WorkerRunner.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `E` | -| `listener` | [`TEvent`](../README.md#tevent)[`E`] | - -#### Returns - -[`WorkerRunner`](WorkerRunner.md) - -#### Inherited from - -[EventEmitter](EventEmitter.md).[on](EventEmitter.md#on) - -___ - -### once - -▸ **once**\<`E`\>(`event`, `listener`): [`WorkerRunner`](WorkerRunner.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `E` | -| `listener` | [`TEvent`](../README.md#tevent)[`E`] | - -#### Returns - -[`WorkerRunner`](WorkerRunner.md) - -#### Inherited from - -[EventEmitter](EventEmitter.md).[once](EventEmitter.md#once) - -___ - -### quit - -▸ **quit**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` - -___ - -### removeAllListeners - -▸ **removeAllListeners**\<`E`\>(`event?`): [`WorkerRunner`](WorkerRunner.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `E` | extends keyof [`TEvent`](../README.md#tevent) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event?` | `E` | - -#### Returns - -[`WorkerRunner`](WorkerRunner.md) - -#### Inherited from - -[EventEmitter](EventEmitter.md).[removeAllListeners](EventEmitter.md#removealllisteners) - -___ - -### run - -▸ **run**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`ICallback`](../interfaces/ICallback.md)\<`void`\> | - -#### Returns - -`void` diff --git a/docs/api/classes/WorkerThreadError.md b/docs/api/classes/WorkerThreadError.md new file mode 100644 index 0000000..df16fff --- /dev/null +++ b/docs/api/classes/WorkerThreadError.md @@ -0,0 +1,159 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / WorkerThreadError + +# Class: WorkerThreadError + +## Hierarchy + +- [`WorkerError`](WorkerError.md) + + ↳ **`WorkerThreadError`** + +## Table of contents + +### Constructors + +- [constructor](WorkerThreadError.md#constructor) + +### Properties + +- [cause](WorkerThreadError.md#cause) +- [message](WorkerThreadError.md#message) +- [stack](WorkerThreadError.md#stack) +- [prepareStackTrace](WorkerThreadError.md#preparestacktrace) +- [stackTraceLimit](WorkerThreadError.md#stacktracelimit) + +### Accessors + +- [name](WorkerThreadError.md#name) + +### Methods + +- [captureStackTrace](WorkerThreadError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new WorkerThreadError**(`msg`): [`WorkerThreadError`](WorkerThreadError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | [`TWorkerThreadMessage`](../README.md#tworkerthreadmessage) | + +#### Returns + +[`WorkerThreadError`](WorkerThreadError.md) + +#### Overrides + +[WorkerError](WorkerError.md).[constructor](WorkerError.md#constructor) + +## Properties + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +[WorkerError](WorkerError.md).[cause](WorkerError.md#cause) + +___ + +### message + +• **message**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[message](WorkerError.md#message) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[WorkerError](WorkerError.md).[stack](WorkerError.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 + +[WorkerError](WorkerError.md).[prepareStackTrace](WorkerError.md#preparestacktrace) + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[WorkerError](WorkerError.md).[stackTraceLimit](WorkerError.md#stacktracelimit) + +## Accessors + +### name + +• `get` **name**(): `string` + +#### Returns + +`string` + +#### Inherited from + +WorkerError.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 + +[WorkerError](WorkerError.md).[captureStackTrace](WorkerError.md#capturestacktrace) diff --git a/docs/api/enums/ELuaScriptName.md b/docs/api/enums/ELuaScriptName.md new file mode 100644 index 0000000..5fee626 --- /dev/null +++ b/docs/api/enums/ELuaScriptName.md @@ -0,0 +1,22 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / ELuaScriptName + +# Enumeration: ELuaScriptName + +## Table of contents + +### Enumeration Members + +- [LPOPRPUSH](ELuaScriptName.md#lpoprpush) +- [ZPOPRPUSH](ELuaScriptName.md#zpoprpush) + +## Enumeration Members + +### LPOPRPUSH + +• **LPOPRPUSH** = ``"LPOPRPUSH"`` + +___ + +### ZPOPRPUSH + +• **ZPOPRPUSH** = ``"ZPOPRPUSH"`` diff --git a/docs/api/enums/EWorkerThreadExecutionCode.md b/docs/api/enums/EWorkerThreadExecutionCode.md new file mode 100644 index 0000000..f9d84c1 --- /dev/null +++ b/docs/api/enums/EWorkerThreadExecutionCode.md @@ -0,0 +1,29 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EWorkerThreadExecutionCode + +# Enumeration: EWorkerThreadExecutionCode + +## Table of contents + +### Enumeration Members + +- [OK](EWorkerThreadExecutionCode.md#ok) +- [PROCESSING\_CAUGHT\_ERROR](EWorkerThreadExecutionCode.md#processing_caught_error) +- [PROCESSING\_ERROR](EWorkerThreadExecutionCode.md#processing_error) + +## Enumeration Members + +### OK + +• **OK** = ``200`` + +___ + +### PROCESSING\_CAUGHT\_ERROR + +• **PROCESSING\_CAUGHT\_ERROR** = ``202`` + +___ + +### PROCESSING\_ERROR + +• **PROCESSING\_ERROR** = ``201`` diff --git a/docs/api/enums/EWorkerThreadExitCode.md b/docs/api/enums/EWorkerThreadExitCode.md new file mode 100644 index 0000000..b284276 --- /dev/null +++ b/docs/api/enums/EWorkerThreadExitCode.md @@ -0,0 +1,57 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EWorkerThreadExitCode + +# Enumeration: EWorkerThreadExitCode + +## Table of contents + +### Enumeration Members + +- [FILE\_EXTENSION\_ERROR](EWorkerThreadExitCode.md#file_extension_error) +- [FILE\_IMPORT\_ERROR](EWorkerThreadExitCode.md#file_import_error) +- [FILE\_READ\_ERROR](EWorkerThreadExitCode.md#file_read_error) +- [INVALID\_WORKER\_TYPE](EWorkerThreadExitCode.md#invalid_worker_type) +- [TERMINATED](EWorkerThreadExitCode.md#terminated) +- [UNCAUGHT\_EXCEPTION](EWorkerThreadExitCode.md#uncaught_exception) +- [WORKER\_DATA\_REQUIRED](EWorkerThreadExitCode.md#worker_data_required) + +## Enumeration Members + +### FILE\_EXTENSION\_ERROR + +• **FILE\_EXTENSION\_ERROR** = ``104`` + +___ + +### FILE\_IMPORT\_ERROR + +• **FILE\_IMPORT\_ERROR** = ``102`` + +___ + +### FILE\_READ\_ERROR + +• **FILE\_READ\_ERROR** = ``105`` + +___ + +### INVALID\_WORKER\_TYPE + +• **INVALID\_WORKER\_TYPE** = ``101`` + +___ + +### TERMINATED + +• **TERMINATED** = ``106`` + +___ + +### UNCAUGHT\_EXCEPTION + +• **UNCAUGHT\_EXCEPTION** = ``103`` + +___ + +### WORKER\_DATA\_REQUIRED + +• **WORKER\_DATA\_REQUIRED** = ``100`` diff --git a/docs/api/enums/EWorkerType.md b/docs/api/enums/EWorkerType.md new file mode 100644 index 0000000..5970fa6 --- /dev/null +++ b/docs/api/enums/EWorkerType.md @@ -0,0 +1,22 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / EWorkerType + +# Enumeration: EWorkerType + +## Table of contents + +### Enumeration Members + +- [CALLABLE](EWorkerType.md#callable) +- [RUNNABLE](EWorkerType.md#runnable) + +## Enumeration Members + +### CALLABLE + +• **CALLABLE** = ``0`` + +___ + +### RUNNABLE + +• **RUNNABLE** = ``1`` diff --git a/docs/api/interfaces/IEventBus.md b/docs/api/interfaces/IEventBus.md new file mode 100644 index 0000000..c445493 --- /dev/null +++ b/docs/api/interfaces/IEventBus.md @@ -0,0 +1,181 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IEventBus + +# Interface: IEventBus\ + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Events` | extends [`TEventBusEvent`](../README.md#teventbusevent) | + +## Hierarchy + +- [`IEventEmitter`](IEventEmitter.md)\<`Events`\> + + ↳ **`IEventBus`** + +## Implemented by + +- [`EventBus`](../classes/EventBus.md) +- [`EventBusRedis`](../classes/EventBusRedis.md) + +## Table of contents + +### Methods + +- [emit](IEventBus.md#emit) +- [on](IEventBus.md#on) +- [once](IEventBus.md#once) +- [removeAllListeners](IEventBus.md#removealllisteners) +- [removeListener](IEventBus.md#removelistener) +- [shutDown](IEventBus.md#shutdown) + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`Events`[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[IEventEmitter](IEventEmitter.md).[emit](IEventEmitter.md#emit) + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`IEventBus`](IEventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`IEventBus`](IEventBus.md)\<`Events`\> + +#### Inherited from + +[IEventEmitter](IEventEmitter.md).[on](IEventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`IEventBus`](IEventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`IEventBus`](IEventBus.md)\<`Events`\> + +#### Inherited from + +[IEventEmitter](IEventEmitter.md).[once](IEventEmitter.md#once) + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`IEventBus`](IEventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `E` | + +#### Returns + +[`IEventBus`](IEventBus.md)\<`Events`\> + +#### Inherited from + +[IEventEmitter](IEventEmitter.md).[removeAllListeners](IEventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`IEventBus`](IEventBus.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`IEventBus`](IEventBus.md)\<`Events`\> + +#### Inherited from + +[IEventEmitter](IEventEmitter.md).[removeListener](IEventEmitter.md#removelistener) + +___ + +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](ICallback.md)\<`void`\> | + +#### Returns + +`void` diff --git a/docs/api/interfaces/IEventEmitter.md b/docs/api/interfaces/IEventEmitter.md new file mode 100644 index 0000000..a530998 --- /dev/null +++ b/docs/api/interfaces/IEventEmitter.md @@ -0,0 +1,143 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IEventEmitter + +# Interface: IEventEmitter\ + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Events` | extends [`TEventEmitterEvent`](../README.md#teventemitterevent) | + +## Hierarchy + +- **`IEventEmitter`** + + ↳ [`IEventBus`](IEventBus.md) + +## Implemented by + +- [`EventEmitter`](../classes/EventEmitter.md) + +## Table of contents + +### Methods + +- [emit](IEventEmitter.md#emit) +- [on](IEventEmitter.md#on) +- [once](IEventEmitter.md#once) +- [removeAllListeners](IEventEmitter.md#removealllisteners) +- [removeListener](IEventEmitter.md#removelistener) + +## Methods + +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<`Events`[`E`]\> | + +#### Returns + +`boolean` + +___ + +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +___ + +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `E` | + +#### Returns + +[`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`IEventEmitter`](IEventEmitter.md)\<`Events`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | `Events`[`E`] | + +#### Returns + +[`IEventEmitter`](IEventEmitter.md)\<`Events`\> diff --git a/docs/api/interfaces/IRedisClient.md b/docs/api/interfaces/IRedisClient.md index 5bbcd99..a2ba170 100644 --- a/docs/api/interfaces/IRedisClient.md +++ b/docs/api/interfaces/IRedisClient.md @@ -2,9 +2,15 @@ # Interface: IRedisClient +## Hierarchy + +- [`EventEmitter`](../classes/EventEmitter.md)\<[`TRedisClientEvent`](../README.md#tredisclientevent)\> + + ↳ **`IRedisClient`** + ## Implemented by -- [`RedisClient`](../classes/RedisClient.md) +- [`RedisClientAbstract`](../classes/RedisClientAbstract.md) ## Table of contents @@ -12,6 +18,7 @@ - [brpoplpush](IRedisClient.md#brpoplpush) - [del](IRedisClient.md#del) +- [emit](IRedisClient.md#emit) - [end](IRedisClient.md#end) - [evalsha](IRedisClient.md#evalsha) - [flushall](IRedisClient.md#flushall) @@ -35,15 +42,19 @@ - [lrange](IRedisClient.md#lrange) - [lrem](IRedisClient.md#lrem) - [multi](IRedisClient.md#multi) +- [on](IRedisClient.md#on) +- [once](IRedisClient.md#once) - [psubscribe](IRedisClient.md#psubscribe) - [publish](IRedisClient.md#publish) - [punsubscribe](IRedisClient.md#punsubscribe) -- [quit](IRedisClient.md#quit) +- [removeAllListeners](IRedisClient.md#removealllisteners) +- [removeListener](IRedisClient.md#removelistener) - [rpop](IRedisClient.md#rpop) - [rpoplpush](IRedisClient.md#rpoplpush) - [runScript](IRedisClient.md#runscript) - [sadd](IRedisClient.md#sadd) - [set](IRedisClient.md#set) +- [shutDown](IRedisClient.md#shutdown) - [sismember](IRedisClient.md#sismember) - [smembers](IRedisClient.md#smembers) - [srem](IRedisClient.md#srem) @@ -105,6 +116,33 @@ ___ ___ +### emit + +▸ **emit**\<`E`\>(`event`, `...args`): `boolean` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `...args` | `Parameters`\<[`TRedisClientEvent`](../README.md#tredisclientevent)[`E`]\> | + +#### Returns + +`boolean` + +#### Inherited from + +[EventEmitter](../classes/EventEmitter.md).[emit](../classes/EventEmitter.md#emit) + +___ + ### end ▸ **end**(`flush`): `void` @@ -505,6 +543,60 @@ ___ ___ +### on + +▸ **on**\<`E`\>(`event`, `listener`): [`IRedisClient`](IRedisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`IRedisClient`](IRedisClient.md) + +#### Inherited from + +[EventEmitter](../classes/EventEmitter.md).[on](../classes/EventEmitter.md#on) + +___ + +### once + +▸ **once**\<`E`\>(`event`, `listener`): [`IRedisClient`](IRedisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`IRedisClient`](IRedisClient.md) + +#### Inherited from + +[EventEmitter](../classes/EventEmitter.md).[once](../classes/EventEmitter.md#once) + +___ + ### psubscribe ▸ **psubscribe**(`pattern`): `void` @@ -541,13 +633,13 @@ ___ ### punsubscribe -▸ **punsubscribe**(`channel`): `void` +▸ **punsubscribe**(`channel?`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `channel` | `string` | +| `channel?` | `string` | #### Returns @@ -555,19 +647,56 @@ ___ ___ -### quit +### removeAllListeners + +▸ **removeAllListeners**\<`E`\>(`event?`): [`IRedisClient`](IRedisClient.md) -▸ **quit**(`cb`): `void` +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | #### Parameters | Name | Type | | :------ | :------ | -| `cb` | [`ICallback`](ICallback.md)\<`void`\> | +| `event?` | `Extract`\<`E`, `string`\> | #### Returns -`void` +[`IRedisClient`](IRedisClient.md) + +#### Inherited from + +[EventEmitter](../classes/EventEmitter.md).[removeAllListeners](../classes/EventEmitter.md#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**\<`E`\>(`event`, `listener`): [`IRedisClient`](IRedisClient.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `E` | extends keyof [`TRedisClientEvent`](../README.md#tredisclientevent) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `E` | +| `listener` | [`TRedisClientEvent`](../README.md#tredisclientevent)[`E`] | + +#### Returns + +[`IRedisClient`](IRedisClient.md) + +#### Inherited from + +[EventEmitter](../classes/EventEmitter.md).[removeListener](../classes/EventEmitter.md#removelistener) ___ @@ -666,6 +795,22 @@ ___ ___ +### shutDown + +▸ **shutDown**(`cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb` | [`ICallback`](ICallback.md)\<`void`\> | + +#### Returns + +`void` + +___ + ### sismember ▸ **sismember**(`key`, `member`, `cb`): `void` @@ -778,13 +923,13 @@ ___ ### unsubscribe -▸ **unsubscribe**(`channel`): `void` +▸ **unsubscribe**(`channel?`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `channel` | `string` | +| `channel?` | `string` | #### Returns diff --git a/docs/api/interfaces/IRedisTransaction.md b/docs/api/interfaces/IRedisTransaction.md index 430248a..ccee042 100644 --- a/docs/api/interfaces/IRedisTransaction.md +++ b/docs/api/interfaces/IRedisTransaction.md @@ -2,6 +2,11 @@ # Interface: IRedisTransaction +## Implemented by + +- [`IoredisClientMulti`](../classes/IoredisClientMulti.md) +- [`NodeRedisClientMulti`](../classes/NodeRedisClientMulti.md) + ## Table of contents ### Methods diff --git a/docs/api/interfaces/IWorkerCallable.md b/docs/api/interfaces/IWorkerCallable.md new file mode 100644 index 0000000..c7340a6 --- /dev/null +++ b/docs/api/interfaces/IWorkerCallable.md @@ -0,0 +1,37 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IWorkerCallable + +# Interface: IWorkerCallable\ + +## Type parameters + +| Name | +| :------ | +| `Payload` | +| `Reply` | + +## Implemented by + +- [`WorkerCallable`](../classes/WorkerCallable.md) + +## Table of contents + +### Methods + +- [call](IWorkerCallable.md#call) + +## Methods + +### call + +▸ **call**(`payload`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | `Payload` | +| `cb` | [`ICallback`](ICallback.md)\<`Reply`\> | + +#### Returns + +`void` diff --git a/docs/api/interfaces/IWorkerData.md b/docs/api/interfaces/IWorkerData.md new file mode 100644 index 0000000..c99b6f1 --- /dev/null +++ b/docs/api/interfaces/IWorkerData.md @@ -0,0 +1,22 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IWorkerData + +# Interface: IWorkerData + +## Table of contents + +### Properties + +- [filename](IWorkerData.md#filename) +- [type](IWorkerData.md#type) + +## Properties + +### filename + +• **filename**: `string` + +___ + +### type + +• **type**: [`EWorkerType`](../enums/EWorkerType.md) diff --git a/docs/api/interfaces/IWorkerRunnable.md b/docs/api/interfaces/IWorkerRunnable.md new file mode 100644 index 0000000..dcfd4f7 --- /dev/null +++ b/docs/api/interfaces/IWorkerRunnable.md @@ -0,0 +1,36 @@ +[RedisSMQ Common Library](../../../README.md) / [Docs](../../README.md) / [API](../README.md) / IWorkerRunnable + +# Interface: IWorkerRunnable\ + +## Type parameters + +| Name | +| :------ | +| `Payload` | + +## Implemented by + +- [`WorkerRunnable`](../classes/WorkerRunnable.md) + +## Table of contents + +### Methods + +- [run](IWorkerRunnable.md#run) + +## Methods + +### run + +▸ **run**(`initialPayload`, `cb`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `initialPayload` | `Payload` | +| `cb` | [`ICallback`](ICallback.md)\<`void`\> | + +#### Returns + +`void`