Class RedisCache

Hierarchy

RedisCache

Index

Constructors

Properties

client extendExpiryOnTouch groupKeyPrefix ttl url

Methods

connect delete deleteBulk determineDataType disconnect get getBulk isOpen keys quit set setBulk unwrapValue wrapKey wrapValue

Constructors

constructor

new RedisCache(url: string, options?: {
    extendExpiryOnTouch?: boolean;
    groupKeyPrefix?: string;
    ttl?: number;
}): RedisCache
Parameters
- url: string
- Optional options: {
      extendExpiryOnTouch?: boolean;
      groupKeyPrefix?: string;
      ttl?: number;
  }
  - Optional extendExpiryOnTouch?: boolean
  - Optional groupKeyPrefix?: string
  - Optional ttl?: number
Returns RedisCache
- Defined in src/lib/RedisCache.ts:11

Properties

`Private` `Readonly` client

client: RedisClientType<{
    bf: {
        ADD: __module;
        CARD: __module;
        EXISTS: __module;
        INFO: __module;
        INSERT: __module;
        LOADCHUNK: __module;
        MADD: __module;
        MEXISTS: __module;
        RESERVE: __module;
        SCANDUMP: __module;
        add: __module;
        card: __module;
        exists: __module;
        info: __module;
        insert: __module;
        loadChunk: __module;
        mAdd: __module;
        mExists: __module;
        reserve: __module;
        scanDump: __module;
    };
    cf: {
        ADD: __module;
        ADDNX: __module;
        COUNT: __module;
        DEL: __module;
        EXISTS: __module;
        INFO: __module;
        INSERT: __module;
        INSERTNX: __module;
        LOADCHUNK: __module;
        RESERVE: __module;
        SCANDUMP: __module;
        add: __module;
        addNX: __module;
        count: __module;
        del: __module;
        exists: __module;
        info: __module;
        insert: __module;
        insertNX: __module;
        loadChunk: __module;
        reserve: __module;
        scanDump: __module;
    };
    cms: {
        INCRBY: __module;
        INFO: __module;
        INITBYDIM: __module;
        INITBYPROB: __module;
        MERGE: __module;
        QUERY: __module;
        incrBy: __module;
        info: __module;
        initByDim: __module;
        initByProb: __module;
        merge: __module;
        query: __module;
    };
    ft: {
        AGGREGATE: __module;
        AGGREGATE_WITHCURSOR: __module;
        ALIASADD: __module;
        ALIASDEL: __module;
        ALIASUPDATE: __module;
        ALTER: __module;
        CONFIG_GET: __module;
        CONFIG_SET: __module;
        CREATE: __module;
        CURSOR_DEL: __module;
        CURSOR_READ: __module;
        DICTADD: __module;
        DICTDEL: __module;
        DICTDUMP: __module;
        DROPINDEX: __module;
        EXPLAIN: __module;
        EXPLAINCLI: __module;
        INFO: __module;
        PROFILEAGGREGATE: __module;
        PROFILESEARCH: __module;
        SEARCH: __module;
        SPELLCHECK: __module;
        SUGADD: __module;
        SUGDEL: __module;
        SUGGET: __module;
        SUGGET_WITHPAYLOADS: __module;
        SUGGET_WITHSCORES: __module;
        SUGGET_WITHSCORES_WITHPAYLOADS: __module;
        SUGLEN: __module;
        SYNDUMP: __module;
        SYNUPDATE: __module;
        TAGVALS: __module;
        _LIST: __module;
        _list: __module;
        aggregate: __module;
        aggregateWithCursor: __module;
        aliasAdd: __module;
        aliasDel: __module;
        aliasUpdate: __module;
        alter: __module;
        configGet: __module;
        configSet: __module;
        create: __module;
        cursorDel: __module;
        cursorRead: __module;
        dictAdd: __module;
        dictDel: __module;
        dictDump: __module;
        dropIndex: __module;
        explain: __module;
        explainCli: __module;
        info: __module;
        profileAggregate: __module;
        profileSearch: __module;
        search: __module;
        spellCheck: __module;
        sugAdd: __module;
        sugDel: __module;
        sugGet: __module;
        sugGetWithPayloads: __module;
        sugGetWithScores: __module;
        sugGetWithScoresWithPayloads: __module;
        sugLen: __module;
        synDump: __module;
        synUpdate: __module;
        tagVals: __module;
    };
    graph: {
        CONFIG_GET: __module;
        CONFIG_SET: __module;
        DELETE: __module;
        EXPLAIN: __module;
        LIST: __module;
        PROFILE: __module;
        QUERY: __module;
        RO_QUERY: __module;
        SLOWLOG: __module;
        configGet: __module;
        configSet: __module;
        delete: __module;
        explain: __module;
        list: __module;
        profile: __module;
        query: __module;
        roQuery: __module;
        slowLog: __module;
    };
    json: {
        ARRAPPEND: __module;
        ARRINDEX: __module;
        ARRINSERT: __module;
        ARRLEN: __module;
        ARRPOP: __module;
        ARRTRIM: __module;
        DEBUG_MEMORY: __module;
        DEL: __module;
        FORGET: __module;
        GET: __module;
        MGET: __module;
        NUMINCRBY: __module;
        NUMMULTBY: __module;
        OBJKEYS: __module;
        OBJLEN: __module;
        RESP: __module;
        SET: __module;
        STRAPPEND: __module;
        STRLEN: __module;
        TYPE: __module;
        arrAppend: __module;
        arrIndex: __module;
        arrInsert: __module;
        arrLen: __module;
        arrPop: __module;
        arrTrim: __module;
        debugMemory: __module;
        del: __module;
        forget: __module;
        get: __module;
        mGet: __module;
        numIncrBy: __module;
        numMultBy: __module;
        objKeys: __module;
        objLen: __module;
        resp: __module;
        set: __module;
        strAppend: __module;
        strLen: __module;
        type: __module;
    };
    tDigest: {
        ADD: __module;
        BYRANK: __module;
        BYREVRANK: __module;
        CDF: __module;
        CREATE: __module;
        INFO: __module;
        MAX: __module;
        MERGE: __module;
        MIN: __module;
        QUANTILE: __module;
        RANK: __module;
        RESET: __module;
        REVRANK: __module;
        TRIMMED_MEAN: __module;
        add: __module;
        byRank: __module;
        byRevRank: __module;
        cdf: __module;
        create: __module;
        info: __module;
        max: __module;
        merge: __module;
        min: __module;
        quantile: __module;
        rank: __module;
        reset: __module;
        revRank: __module;
        trimmedMean: __module;
    };
    topK: {
        ADD: __module;
        COUNT: __module;
        INCRBY: __module;
        INFO: __module;
        LIST: __module;
        LIST_WITHCOUNT: __module;
        QUERY: __module;
        RESERVE: __module;
        add: __module;
        count: __module;
        incrBy: __module;
        info: __module;
        list: __module;
        listWithCount: __module;
        query: __module;
        reserve: __module;
    };
    ts: {
        ADD: __module;
        ALTER: __module;
        CREATE: __module;
        CREATERULE: __module;
        DECRBY: __module;
        DEL: __module;
        DELETERULE: __module;
        GET: __module;
        INCRBY: __module;
        INFO: __module;
        INFO_DEBUG: __module;
        MADD: __module;
        MGET: __module;
        MGET_WITHLABELS: __module;
        MRANGE: __module;
        MRANGE_WITHLABELS: __module;
        MREVRANGE: __module;
        MREVRANGE_WITHLABELS: __module;
        QUERYINDEX: __module;
        RANGE: __module;
        REVRANGE: __module;
        add: __module;
        alter: __module;
        create: __module;
        createRule: __module;
        decrBy: __module;
        del: __module;
        deleteRule: __module;
        get: __module;
        incrBy: __module;
        info: __module;
        infoDebug: __module;
        mAdd: __module;
        mGet: __module;
        mGetWithLabels: __module;
        mRange: __module;
        mRangeWithLabels: __module;
        mRevRange: __module;
        mRevRangeWithLabels: __module;
        queryIndex: __module;
        range: __module;
        revRange: __module;
    };
}, Record<string, never>, Record<string, never>>

`Private` `Readonly` extendExpiryOnTouch

extendExpiryOnTouch: boolean

`Private` `Readonly` groupKeyPrefix

groupKeyPrefix: string

`Private` `Readonly` ttl

ttl: number

`Private` `Readonly` url

url: string

Methods

connect

connect(): Promise<void>
disconnect from Redis server

Returns Promise<void>
- Defined in src/lib/RedisCache.ts:26

delete

delete(key: string, subGroupPrefix?: string): Promise<void>
deletes a single cache key
Parameters
- key: string
- Optional subGroupPrefix: string
Returns Promise<void>
- Defined in src/lib/RedisCache.ts:136

deleteBulk

deleteBulk(keys: string[], subGroupPrefix?: string): Promise<void>
deletes a set of cache keys in one Redis transaction
Parameters
- keys: string[]
- Optional subGroupPrefix: string
Returns Promise<void>
- Defined in src/lib/RedisCache.ts:147

`Private` determineDataType

determineDataType(value: string | number | boolean | object | string[] | number[] | object[]): string
Parameters
- value: string | number | boolean | object | string[] | number[] | object[]
Returns string
- Defined in src/lib/RedisCache.ts:160

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in src/lib/RedisCache.ts:30

get

get(key: string, subGroupPrefix?: string): Promise<CacheValueType>
tries to get a single value from the cache if not found, null will be returned
Parameters
- key: string
- Optional subGroupPrefix: string
Returns Promise<CacheValueType>
- Defined in src/lib/RedisCache.ts:79

getBulk

getBulk(keys: string[], subGroupPrefix?: string): Promise<Record<string, CacheValueType>>
tries to retrieve a list of keys from cache and associates them as a hash map. Keys which could not be found will have a null value
Parameters
- keys: string[]
- Optional subGroupPrefix: string
Returns Promise<Record<string, CacheValueType>>
- Defined in src/lib/RedisCache.ts:62

isOpen

isOpen(): boolean
Returns boolean
- Defined in src/lib/RedisCache.ts:19

keys

keys(pattern?: string): Promise<string[]>
returns a list of keys with a given pattern (optional)
Parameters
- pattern: string = '*'
Returns Promise<string[]>
- Defined in src/lib/RedisCache.ts:49

quit

quit(): Promise<void>
quit from Redis server

Returns Promise<void>
- Defined in src/lib/RedisCache.ts:38

set

set(key: string, value: CacheValueType, options?: ICacheSetOptions): Promise<void>
persists a single key-value pair in Redis
Parameters
- key: string
- value: CacheValueType
- Optional options: ICacheSetOptions
Returns Promise<void>
- Defined in src/lib/RedisCache.ts:117

setBulk

setBulk(keyVals: Record<string, CacheValueType>, options?: ICacheSetOptions): Promise<void>
keyVals are expected as a hash map and are persisted in one Redis transaction
Parameters
- keyVals: Record<string, CacheValueType>
- Optional options: ICacheSetOptions
Returns Promise<void>
- Defined in src/lib/RedisCache.ts:91

`Private` unwrapValue

unwrapValue(wrappedValue: string): CacheValueType
Parameters
- wrappedValue: string
Returns CacheValueType
- Defined in src/lib/RedisCache.ts:167

`Private` wrapKey

wrapKey(key: string, subGroupPrefix: string): string
Parameters
- key: string
- subGroupPrefix: string
Returns string
- Defined in src/lib/RedisCache.ts:182

`Private` wrapValue

wrapValue(value: CacheValueType): {
dataType: string;
wrappedValue: string | number | boolean | object;
}
Parameters
- value: CacheValueType
Returns {
dataType: string;
wrappedValue: string | number | boolean | object;
}
- dataType: string
- wrappedValue: string | number | boolean | object
- Defined in src/lib/RedisCache.ts:188

Class RedisCache

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

Optional options: { extendExpiryOnTouch?: boolean; groupKeyPrefix?: string; ttl?: number; }

Optional extendExpiryOnTouch?: boolean

Optional groupKeyPrefix?: string

Optional ttl?: number

Returns RedisCache

Properties

Private Readonly client

Private Readonly extendExpiryOnTouch

Private Readonly groupKeyPrefix

Private Readonly ttl

Private Readonly url

Methods

connect

Returns Promise<void>

delete

Parameters

key: string

Optional subGroupPrefix: string

Returns Promise<void>

deleteBulk

Parameters

keys: string[]

Optional subGroupPrefix: string

Returns Promise<void>

Private determineDataType

Parameters

value: string | number | boolean | object | string[] | number[] | object[]

Returns string

disconnect

Returns Promise<void>

get

Parameters

key: string

Optional subGroupPrefix: string

Returns Promise<CacheValueType>

getBulk

Parameters

keys: string[]

Optional subGroupPrefix: string

Returns Promise<Record<string, CacheValueType>>

isOpen

Returns boolean

keys

Parameters

pattern: string = '*'

Returns Promise<string[]>

quit

Returns Promise<void>

set

Parameters

key: string

value: CacheValueType

Optional options: ICacheSetOptions

Returns Promise<void>

setBulk

Parameters

keyVals: Record<string, CacheValueType>

Optional options: ICacheSetOptions

Returns Promise<void>

Private unwrapValue

Parameters

wrappedValue: string

Returns CacheValueType

Private wrapKey

Parameters

key: string

subGroupPrefix: string

Returns string

Private wrapValue

Parameters

`Optional` options: {
extendExpiryOnTouch?: boolean;
groupKeyPrefix?: string;
ttl?: number;
}

`Optional` extendExpiryOnTouch?: boolean

`Optional` groupKeyPrefix?: string

`Optional` ttl?: number

`Private` `Readonly` client

`Private` `Readonly` extendExpiryOnTouch

`Private` `Readonly` groupKeyPrefix

`Private` `Readonly` ttl

`Private` `Readonly` url

`Optional` subGroupPrefix: string

`Optional` subGroupPrefix: string

`Private` determineDataType

`Optional` subGroupPrefix: string

`Optional` subGroupPrefix: string

`Optional` options: ICacheSetOptions

`Optional` options: ICacheSetOptions

`Private` unwrapValue

`Private` wrapKey

`Private` wrapValue

Returns {
dataType: string;
wrappedValue: string | number | boolean | object;
}