Class RedisMap<UseBuffer, R>

Redis implementation of an async queryable map.

Type Parameters

UseBuffer extends boolean = false
R extends RedisClientType = RedisClientType

Hierarchy

AsyncDisposableCloseable
- RedisMap

Implements

AsyncIterable<[string, RedisValueType<UseBuffer>]>
MaybeAsyncMap<string, RedisValueType<UseBuffer>>
MaybeAsyncMapBatch<string, RedisValueType<UseBuffer>>
RangeQueryable<string, RedisValueType<UseBuffer>>
Startable
AsyncDisposable

Index

Constructors

constructor

new RedisMap<UseBuffer, R>(client, hashKey, rangeKey, useBuffer?): RedisMap<UseBuffer, R>
Type Parameters
- UseBuffer extends boolean = false
- R extends RedisClientType = RedisClientType
Parameters
- client: R
  Redis client to use.
- hashKey: string
  Key used to store the hash map.
- rangeKey: string
  Key used to store the sorted set index.
- Optional useBuffer: UseBuffer
  Whether to use buffers or strings as values.
Returns RedisMap<UseBuffer, R>
Overrides AsyncDisposableCloseable.constructor
- Defined in plugins/redis/src/map.ts:13

Properties

`Protected` `Readonly` client

client: R

Redis client to use.

`Protected` `Readonly` hashKey

hashKey: string

Key used to store the hash map.

`Protected` `Readonly` rangeKey

rangeKey: string

Key used to store the sorted set index.

`Protected` `Optional` `Readonly` useBuffer

useBuffer?: UseBuffer

Whether to use buffers or strings as values.

Accessors

[rangeQueryable]

get [rangeQueryable](): true
Marker to indicate that this object is a RangeQueryable.

Returns true
Implementation of RangeQueryable.[rangeQueryable]
- Defined in plugins/redis/src/map.ts:184

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in plugins/redis/src/map.ts:180

started

get started(): boolean
Returns if this has started.

Returns boolean
Implementation of Startable.started
- Defined in plugins/redis/src/map.ts:26

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
Inherited from AsyncDisposableCloseable.[asyncDispose]
- Defined in commons/dist/lifecycle/closeable.d.ts:15

[asyncIterator]

[asyncIterator](): AsyncIterator<[string, RedisValueType<UseBuffer>], any, undefined>
Returns AsyncIterator<[string, RedisValueType<UseBuffer>], any, undefined>
Implementation of AsyncIterable.[asyncIterator]
- Defined in plugins/redis/src/map.ts:176

close

close(): Promise<void>
Closes this object and releases any system resource associated with it.

Returns Promise<void>
Implementation of Startable.close
Overrides AsyncDisposableCloseable.close
- Defined in plugins/redis/src/map.ts:34

delete

delete(key): Promise<boolean>
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: string
Returns Promise<boolean>
Implementation of MaybeAsyncMap.delete
- Defined in plugins/redis/src/map.ts:56

deleteMany

deleteMany(keys): AsyncIterableIterator<undefined | CodedError<string, unknown>>
Deletes the values with given keys.
Parameters
- keys: Iterable<string>
Returns AsyncIterableIterator<undefined | CodedError<string, unknown>>
Implementation of MaybeAsyncMapBatch.deleteMany
- Defined in plugins/redis/src/map.ts:101

entries

entries(options?): AsyncIterableIterator<[string, RedisValueType<UseBuffer>]>
Queries key-value pairs by given criteria.
Parameters
- Optional options: RangeQueryOptions<string>
Returns AsyncIterableIterator<[string, RedisValueType<UseBuffer>]>
Implementation of RangeQueryable.entries
- Defined in plugins/redis/src/map.ts:154

get

get(key, options?): Promise<undefined | RedisValueType<UseBuffer>>
Gets a value by key from the map.
Parameters
- key: string
- Optional options: AbortOptions
Returns Promise<undefined | RedisValueType<UseBuffer>>
Implementation of MaybeAsyncMap.get
- Defined in plugins/redis/src/map.ts:38

getMany

getMany(keys, options?): AsyncIterableIterator<undefined | RedisValueType<UseBuffer>>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<string>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | RedisValueType<UseBuffer>>
Implementation of MaybeAsyncMapBatch.getMany
- Defined in plugins/redis/src/map.ts:64

has

has(key, options?): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- key: string
- options: AbortOptions = {}
Returns Promise<boolean>
Implementation of MaybeAsyncMap.has
- Defined in plugins/redis/src/map.ts:45

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<string>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of MaybeAsyncMapBatch.hasMany
- Defined in plugins/redis/src/map.ts:73

keys

keys(options?): AsyncIterableIterator<string>
Queries keys by given criteria.
Parameters
- Optional options: RangeQueryOptions<string>
Returns AsyncIterableIterator<string>
Implementation of RangeQueryable.keys
- Defined in plugins/redis/src/map.ts:165

`Protected` query

query(options?): Promise<string[]>
Parameters
- Optional options: RangeQueryOptions<string>
Returns Promise<string[]>
- Defined in plugins/redis/src/map.ts:188

set

set(key, value): Promise<void>
Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: string
- value: RedisValueType<UseBuffer>
Returns Promise<void>
Implementation of MaybeAsyncMap.set
- Defined in plugins/redis/src/map.ts:49

setMany

setMany(entries): AsyncIterableIterator<undefined | CodedError<string, unknown>>
Sets given list of entries.
Parameters
- entries: Iterable<[string, RedisValueType<UseBuffer>]>
Returns AsyncIterableIterator<undefined | CodedError<string, unknown>>
Implementation of MaybeAsyncMapBatch.setMany
- Defined in plugins/redis/src/map.ts:79

start

start(): Promise<void>
Starts this component.

Returns Promise<void>
Implementation of Startable.start
- Defined in plugins/redis/src/map.ts:30

updateMany

updateMany(entries): AsyncIterableIterator<undefined | Error>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<[string, RedisValueType<UseBuffer>?]>
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.updateMany
- Defined in plugins/redis/src/map.ts:121

values

values(options?): AsyncIterableIterator<RedisValueType<UseBuffer>>
Queries values by given criteria.
Parameters
- Optional options: RangeQueryOptions<string>
Returns AsyncIterableIterator<RedisValueType<UseBuffer>>
Implementation of RangeQueryable.values
- Defined in plugins/redis/src/map.ts:169

Class RedisMap<UseBuffer, R>

Type Parameters

UseBuffer extends boolean = false

R extends RedisClientType = RedisClientType

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

UseBuffer extends boolean = false

R extends RedisClientType = RedisClientType

Parameters

client: R

hashKey: string

rangeKey: string

Optional useBuffer: UseBuffer

Returns RedisMap<UseBuffer, R>

Properties

Protected Readonly client

Protected Readonly hashKey

Protected Readonly rangeKey

Protected Optional Readonly useBuffer

Accessors

[rangeQueryable]

Returns true

[toStringTag]

Returns string

started

Returns boolean

Methods

[asyncDispose]

Returns Promise<void>

[asyncIterator]

Returns AsyncIterator<[string, RedisValueType<UseBuffer>], any, undefined>

close

Returns Promise<void>

delete

Parameters

key: string

Returns Promise<boolean>

deleteMany

Parameters

keys: Iterable<string>

Returns AsyncIterableIterator<undefined | CodedError<string, unknown>>

entries

Parameters

Optional options: RangeQueryOptions<string>

Returns AsyncIterableIterator<[string, RedisValueType<UseBuffer>]>

get

Parameters

key: string

Optional options: AbortOptions

Returns Promise<undefined | RedisValueType<UseBuffer>>

getMany

Parameters

keys: Iterable<string>

Optional options: AbortOptions

Returns AsyncIterableIterator<undefined | RedisValueType<UseBuffer>>

has

Parameters

key: string

options: AbortOptions = {}

Returns Promise<boolean>

hasMany

Parameters

keys: Iterable<string>

Optional options: AbortOptions

Returns AsyncIterableIterator<boolean>

keys

Parameters

Optional options: RangeQueryOptions<string>

Returns AsyncIterableIterator<string>

Protected query

Parameters

Optional options: RangeQueryOptions<string>

`Optional` useBuffer: UseBuffer

`Protected` `Readonly` client

`Protected` `Readonly` hashKey

`Protected` `Readonly` rangeKey

`Protected` `Optional` `Readonly` useBuffer

`Optional` options: RangeQueryOptions<string>

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: RangeQueryOptions<string>

`Protected` query

`Optional` options: RangeQueryOptions<string>

`Optional` options: RangeQueryOptions<string>