Skip to content

Commit

Permalink
docs: drop support for node-redis v3
Browse files Browse the repository at this point in the history
  • Loading branch information
@weyoss
weyoss committed Jan 25, 2024
1 parent 0b89843 commit 3481d53
Show file tree
Hide file tree
Showing 36 changed files with 834 additions and 5,785 deletions.
7 changes: 3 additions & 4 deletions docs/README.md
View file
Expand Up @@ -4,7 +4,7 @@

## API

See for [API](./api/README.md) reference for more details.
See for [API](api/README.md) reference for more details.

## Misc

Expand Down Expand Up @@ -35,12 +35,11 @@ module.exports = {
###### Parameters

- `redis` *(object): Optional.* Redis client parameters. If not provided the `redis` client would be used by default.
- `redis.client` *(string): Optional.* Redis client name. Can be either `ERedisConfigClient.IOREDIS`,`ERedisConfigClient.REDIS`, or `ERedisConfigClient.REDIS_V4`.
- `redis.client` *(string): Optional.* Redis client name. Can be either `ERedisConfigClient.IOREDIS` or `ERedisConfigClient.REDIS`.
- `redis.options` *(object): Optional.* Redis client options.

- See https://github.com/luin/ioredis/blob/v4/API.md#new-redisport-host-options for `ioredis` options.
- See https://github.com/redis/node-redis/tree/v3.1.2#options-object-properties for `redis` options.
- See https://github.com/redis/node-redis/blob/master/docs/client-configuration.md for `redis_v4` options.
- See https://github.com/redis/node-redis/blob/master/docs/client-configuration.md for `node-redis` options.

### Logs

Expand Down
197 changes: 94 additions & 103 deletions docs/api/README.md
View file
@@ -1,164 +1,158 @@
> [RedisSMQ Common Library](../../README.md) / [Docs](../README.md) / API
[RedisSMQ Common Library](../../README.md) / [Docs](README.md) / API

# API

## Table of contents

### Enumerations

- [ERedisConfigClient](./enums/ERedisConfigClient.md)
- [ERedisConfigClient](docs/api/enums/ERedisConfigClient.md)

### Classes

- [CallbackEmptyReplyError](./classes/CallbackEmptyReplyError.md)
- [CallbackInvalidReplyError](./classes/CallbackInvalidReplyError.md)
- [EventEmitter](./classes/EventEmitter.md)
- [Lock](./classes/Lock.md)
- [LockAbortError](./classes/LockAbortError.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)
- [LoggerError](./classes/LoggerError.md)
- [PanicError](./classes/PanicError.md)
- [PowerSwitch](./classes/PowerSwitch.md)
- [PowerSwitchError](./classes/PowerSwitchError.md)
- [RedisClient](./classes/RedisClient.md)
- [RedisClientError](./classes/RedisClientError.md)
- [RedisSMQError](./classes/RedisSMQError.md)
- [Ticker](./classes/Ticker.md)
- [TickerError](./classes/TickerError.md)
- [WatchedKeysChangedError](./classes/WatchedKeysChangedError.md)
- [Worker](./classes/Worker.md)
- [WorkerError](./classes/WorkerError.md)
- [WorkerPool](./classes/WorkerPool.md)
- [WorkerRunner](./classes/WorkerRunner.md)
- [CallbackEmptyReplyError](docs/api/classes/CallbackEmptyReplyError.md)
- [CallbackInvalidReplyError](docs/api/classes/CallbackInvalidReplyError.md)
- [EventEmitter](docs/api/classes/EventEmitter.md)
- [Lock](docs/api/classes/Lock.md)
- [LockAbortError](docs/api/classes/LockAbortError.md)
- [LockAcquireError](docs/api/classes/LockAcquireError.md)
- [LockError](docs/api/classes/LockError.md)
- [LockExtendError](docs/api/classes/LockExtendError.md)
- [LockMethodNotAllowedError](docs/api/classes/LockMethodNotAllowedError.md)
- [LockNotAcquiredError](docs/api/classes/LockNotAcquiredError.md)
- [LockNotReleasedError](docs/api/classes/LockNotReleasedError.md)
- [LoggerError](docs/api/classes/LoggerError.md)
- [PanicError](docs/api/classes/PanicError.md)
- [PowerSwitch](docs/api/classes/PowerSwitch.md)
- [PowerSwitchError](docs/api/classes/PowerSwitchError.md)
- [RedisClient](docs/api/classes/RedisClient.md)
- [RedisClientError](docs/api/classes/RedisClientError.md)
- [RedisSMQError](docs/api/classes/RedisSMQError.md)
- [Ticker](docs/api/classes/Ticker.md)
- [TickerError](docs/api/classes/TickerError.md)
- [WatchedKeysChangedError](docs/api/classes/WatchedKeysChangedError.md)
- [Worker](docs/api/classes/Worker.md)
- [WorkerError](docs/api/classes/WorkerError.md)
- [WorkerPool](docs/api/classes/WorkerPool.md)
- [WorkerRunner](docs/api/classes/WorkerRunner.md)

### Interfaces

- [ICallback](./interfaces/ICallback.md)
- [ILogger](./interfaces/ILogger.md)
- [ILoggerConfig](./interfaces/ILoggerConfig.md)
- [IRedisClient](./interfaces/IRedisClient.md)
- [IRedisConfigIORedis](./interfaces/IRedisConfigIORedis.md)
- [IRedisConfigNodeRedis](./interfaces/IRedisConfigNodeRedis.md)
- [IRedisConfigNodeRedisV4](./interfaces/IRedisConfigNodeRedisV4.md)
- [IRedisTransaction](./interfaces/IRedisTransaction.md)
- [ICallback](docs/api/interfaces/ICallback.md)
- [ILogger](docs/api/interfaces/ILogger.md)
- [ILoggerConfig](docs/api/interfaces/ILoggerConfig.md)
- [IRedisClient](docs/api/interfaces/IRedisClient.md)
- [IRedisConfigIORedis](docs/api/interfaces/IRedisConfigIORedis.md)
- [IRedisConfigNodeRedis](docs/api/interfaces/IRedisConfigNodeRedis.md)
- [IRedisTransaction](docs/api/interfaces/IRedisTransaction.md)

### Type Aliases

- [IRedisConfig](./README.md#iredisconfig)
- [TEvent](./README.md#tevent)
- [TEventEmitterEvent](./README.md#teventemitterevent)
- [TFunction](./README.md#tfunction)
- [TRedisClientNodeRedisV4](./README.md#tredisclientnoderedisv4)
- [TRedisTransactionNodeRedisV4](./README.md#tredistransactionnoderedisv4)
- [TUnaryFunction](./README.md#tunaryfunction)
- [IRedisConfig](docs/api/README.md#iredisconfig)
- [TEvent](docs/api/README.md#tevent)
- [TEventEmitterEvent](docs/api/README.md#teventemitterevent)
- [TFunction](docs/api/README.md#tfunction)
- [TRedisClientNodeRedis](docs/api/README.md#tredisclientnoderedis)
- [TRedisTransactionNodeRedis](docs/api/README.md#tredistransactionnoderedis)
- [TUnaryFunction](docs/api/README.md#tunaryfunction)

### Variables

- [async](./README.md#async)
- [logger](./README.md#logger)
- [redis](./README.md#redis)
- [async](docs/api/README.md#async)
- [logger](docs/api/README.md#logger)
- [redis](docs/api/README.md#redis)

## Type Aliases

### IRedisConfig

Ƭ **IRedisConfig**: [`IRedisConfigIORedis`](./interfaces/IRedisConfigIORedis.md) \| [`IRedisConfigNodeRedis`](interfaces/IRedisConfigNodeRedis.md) \| [`IRedisConfigNodeRedisV4`](interfaces/IRedisConfigNodeRedisV4.md)
Ƭ **IRedisConfig**: [`IRedisConfigIORedis`](docs/api/interfaces/IRedisConfigIORedis.md) \| [`IRedisConfigNodeRedis`](docs/api/interfaces/IRedisConfigNodeRedis.md)

---
___

### TEvent

Ƭ **TEvent**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `down` | () => `void` |
| `error` | (`err`: `Error`) => `void` |
| `goingDown` | () => `void` |
| `goingUp` | () => `void` |
| `next` | () => `void` |
| `tick` | () => `void` |
| `up` | () => `void` |

| Name | Type |
| :------------ | :--------------------------- |
| `down` | () =>`void` |
| `error` | (`err`: `Error`) => `void` |
| `goingDown` | () =>`void` |
| `goingUp` | () =>`void` |
| `next` | () =>`void` |
| `tick` | () =>`void` |
| `up` | () =>`void` |

---
___

### TEventEmitterEvent

Ƭ **TEventEmitterEvent**: `Record`\<`string` \| `symbol`, (...`args`: `any`) => `any`\>

---
___

### TFunction

Ƭ **TFunction**<`TReturn`, `TArgs`>: (...`args`: `TArgs`[]) => `TReturn`
Ƭ **TFunction**\<`TReturn`, `TArgs`\>: (...`args`: `TArgs`[]) => `TReturn`

#### Type parameters


| Name | Type |
| :---------- | :------- |
| Name | Type |
| :------ | :------ |
| `TReturn` | `void` |
| `TArgs` | `any` |
| `TArgs` | `any` |

#### Type declaration

▸ (`...args`): `TReturn`

##### Parameters


| Name | Type |
| :---------- | :---------- |
| Name | Type |
| :------ | :------ |
| `...args` | `TArgs`[] |

##### Returns

`TReturn`

---
___

### TRedisClientNodeRedisV4
### TRedisClientNodeRedis

Ƭ **TRedisClientNodeRedisV4**: `RedisClientType`<`RedisModules`, `RedisFunctions`, `RedisScripts`>
Ƭ **TRedisClientNodeRedis**: `RedisClientType`\<`RedisModules`, `RedisFunctions`, `RedisScripts`\>

---
___

### TRedisTransactionNodeRedisV4
### TRedisTransactionNodeRedis

Ƭ **TRedisTransactionNodeRedisV4**: `RedisClientMultiCommandType`<`RedisModules`, `RedisFunctions`, `RedisScripts`>
Ƭ **TRedisTransactionNodeRedis**: `RedisClientMultiCommandType`\<`RedisModules`, `RedisFunctions`, `RedisScripts`\>

---
___

### TUnaryFunction

Ƭ **TUnaryFunction**<`T`, `E`>: (`reply`: `T`) => `E`
Ƭ **TUnaryFunction**\<`T`, `E`\>: (`reply`: `T`) => `E`

#### Type parameters


| Name | Type |
| :----- | :------- |
| `T` | `T` |
| `E` | `void` |
| Name | Type |
| :------ | :------ |
| `T` | `T` |
| `E` | `void` |

#### Type declaration

▸ (`reply`): `E`

##### Parameters


| Name | Type |
| :-------- | :----- |
| `reply` | `T` |
| Name | Type |
| :------ | :------ |
| `reply` | `T` |

##### Returns

Expand All @@ -172,38 +166,35 @@

#### Type declaration

| Name | Type |
| :------ | :------ |
| `each` | \<T\>(`collection`: `Record`\<`string`, `T`\> \| `T`[], `iteratee`: (`item`: `T`, `key`: `string` \| `number`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void` |
| `eachIn` | \<T\>(`collection`: `Record`\<`string`, `T`\>, `iteratee`: (`item`: `T`, `key`: `string`, `callback`: [`ICallback`](docs/api/interfaces/ICallback.md)\<`void`\>) => `void`, `callback`: [`ICallback`](docs/api/interfaces/ICallback.md)\<`void`\>) => `void` |
| `eachOf` | \<T\>(`collection`: `T`[], `iteratee`: (`item`: `T`, `key`: `number`, `callback`: [`ICallback`](docs/api/interfaces/ICallback.md)\<`void`\>) => `void`, `callback`: [`ICallback`](docs/api/interfaces/ICallback.md)\<`void`\>) => `void` |
| `waterfall` | \<T\>(`tasks`: [`TFunction`](docs/api/README.md#tfunction)[], `callback`: [`ICallback`](docs/api/interfaces/ICallback.md)\<`T`\>) => `void` |

| Name | Type |
| :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `each` | \<T\>(`collection`: `Record`\<`string`, `T`\> \| `T`[], `iteratee`: (`item`: `T`, `key`: `string` \| `number`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void` |
| `eachIn` | \<T\>(`collection`: `Record`\<`string`, `T`\>, `iteratee`: (`item`: `T`, `key`: `string`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void` |
| `eachOf` | \<T\>(`collection`: `T`[], `iteratee`: (`item`: `T`, `key`: `number`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void`, `callback`: [`ICallback`](interfaces/ICallback.md)\<`void`\>) => `void` |
| `waterfall` | \<T\>(`tasks`: [`TFunction`](./README.md#tfunction)[], `callback`: [`ICallback`](interfaces/ICallback.md)\<`T`\>) => `void` |

---
___

### logger

• `Const` **logger**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `destroy` | () => `void` |
| `getLogger` | (`cfg`: [`ILoggerConfig`](docs/api/interfaces/ILoggerConfig.md), `ns?`: `string`) => [`ILogger`](docs/api/interfaces/ILogger.md) |
| `setLogger` | \<T\>(`logger`: `T`) => `void` |

| Name | Type |
| :------------ | :--------------------------------------------------------------------------------------------------------------------------------- |
| `destroy` | () =>`void` |
| `getLogger` | (`cfg`: [`ILoggerConfig`](./interfaces/ILoggerConfig.md), `ns?`: `string`) => [`ILogger`](./interfaces/ILogger.md) |
| `setLogger` | <T>(`logger`: `T`) => `void` |

---
___

### redis

• `Const` **redis**: `Object`

#### Type declaration


| Name | Type |
| :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `createInstance` | (`config`: [`IRedisConfig`](./README.md#iredisconfig), `cb`: [`ICallback`](./interfaces/ICallback.md)<[`RedisClient`](./classes/RedisClient.md)>) => `void` |
| Name | Type |
| :------ | :------ |
| `createInstance` | (`config`: [`IRedisConfig`](docs/api/README.md#iredisconfig), `cb`: [`ICallback`](docs/api/interfaces/ICallback.md)\<[`RedisClient`](docs/api/classes/RedisClient.md)\>) => `void` |

0 comments on commit 3481d53

Please sign in to comment.