From a6093bf949ad367f91ff014fd3ec8c540e8588bc Mon Sep 17 00:00:00 2001 From: Nick Jennings Date: Fri, 26 Aug 2022 16:23:58 +0200 Subject: [PATCH] release 4.0.0 doc --- docs/classes/RedisConnectionPool.html | 56 +++++++++---------- docs/functions/default.html | 2 +- .../interfaces/RedisConnectionPoolConfig.html | 10 ++-- 3 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/classes/RedisConnectionPool.html b/docs/classes/RedisConnectionPool.html index 4ffe245..56cdab5 100644 --- a/docs/classes/RedisConnectionPool.html +++ b/docs/classes/RedisConnectionPool.html @@ -21,7 +21,7 @@

Hierarchy

+
  • Defined in src/index.ts:91
    • @@ -75,29 +75,29 @@

    Parameters

    cfg: RedisConnectionPoolConfig = {}

    Returns RedisConnectionPool

    +
  • Defined in src/index.ts:97

    • Properties

    Private initializing

    initializing: boolean = false
    +
  • Defined in src/index.ts:95

    • max_clients

    max_clients: number = 5
    +
  • Defined in src/index.ts:92

    • pool

    -
    pool: Pool<RedisClientType<RedisModules, Record<string, never>>>
    +
  • Defined in src/index.ts:94

    • redis

    -
    redis: RedisClientOptions<Record<string, never>, Record<string, never>>
    +
  • Defined in src/index.ts:93

    • Methods

    @@ -116,7 +116,7 @@
    key: string

    Returns Promise<{ element: SingleCommandResult; key: string }>

    +
  • Defined in src/index.ts:107

    • brpop

    Returns Promise<{ element: SingleCommandResult; key: string }>

    +
  • Defined in src/index.ts:116

    • del

    Returns Promise<number>

    +
  • Defined in src/index.ts:125

    • expire

    Returns Promise<number>

    +
  • Defined in src/index.ts:135

    • get

    Returns Promise<string>

    +
  • Defined in src/index.ts:144

    • Private getFuncs

    Returns Promise<T>

    +
  • Defined in src/index.ts:331

    • hdel

    +
  • Defined in src/index.ts:154

    • hget

    Returns Promise<string>

    +
  • Defined in src/index.ts:164

    • hgetall

    Returns Promise<{ [index: string]: string }>

    +
  • Defined in src/index.ts:173

    • hset

    Returns Promise<number>

    +
  • Defined in src/index.ts:184

    • incr

    Returns Promise<number>

    +
  • Defined in src/index.ts:196

    • init

    +
  • Defined in src/index.ts:203

    • keys

    Returns Promise<string[]>

    +
  • Defined in src/index.ts:244

    • lpush

    Returns Promise<number>

    +
  • Defined in src/index.ts:254

    • rpush

    Returns Promise<number>

    +
  • Defined in src/index.ts:267

    • sendCommand

    +
  • Defined in src/index.ts:286

    • set

    +
  • Defined in src/index.ts:297

    • shutdown

    +
  • Defined in src/index.ts:307

    • Private singleCommand

    Returns Promise<SingleCommandResult>

    +
  • Defined in src/index.ts:321

    • ttl

    Returns Promise<number>

    +
  • Defined in src/index.ts:317
    • diff --git a/docs/functions/default.html b/docs/functions/default.html index 641b18e..fc7cf7c 100644 --- a/docs/functions/default.html +++ b/docs/functions/default.html @@ -44,7 +44,7 @@
    uid: string
    cfg: RedisConnectionPoolConfig = {}

    Returns Promise<RedisConnectionPool>

    +
  • Defined in src/index.ts:73
    • diff --git a/docs/interfaces/RedisConnectionPoolConfig.html b/docs/interfaces/RedisConnectionPoolConfig.html index 606849c..4ccc2bf 100644 --- a/docs/interfaces/RedisConnectionPoolConfig.html +++ b/docs/interfaces/RedisConnectionPoolConfig.html @@ -18,7 +18,7 @@

    Hierarchy

    • RedisConnectionPoolConfig
    +
  • Defined in src/index.ts:27
    • @@ -36,17 +36,17 @@

    Properties

    Optional max_clients

    max_clients?: number
    +
  • Defined in src/index.ts:28

    • Optional perform_checks

    perform_checks?: boolean
    +
  • Defined in src/index.ts:29

    • Optional redis

    -
    redis?: RedisClientOptions<Record<string, never>, Record<string, never>>
    +
  • Defined in src/index.ts:30