Class RedisDataProvider

A DataProvider implemented with a Redis backend.

Hierarchy

  • DataProvider
    • RedisDataProvider

Implements

  • ClearableDataProvider

Constructors

constructor

Properties

client redis

Methods

_clear _delete _get _set clear clearGlobal delete deleteGlobal destroy get getGlobal init resolveKey set setGlobal

Constructors

constructor

  • Parameters

    • client: ExtendedClient

      The client that this data provider will be used by.

    • options: RedisClientOptions<any, any, RedisScripts>

      The options passed to the Redis client.

    Returns RedisDataProvider

Properties

Readonly client

client: ExtendedClient

The client that this data provider will be used by.

Memberof

DataProvider

Private redis

redis: RedisClientType<any, any, RedisScripts>

The Redis client for this data provider.

Memberof

RedisDataProvider

Methods

Private _clear

  • _clear(startsWith): Promise<void>
  • Private

    Clear all data that start with the given pattern.

    Parameters

    • startsWith: string

      The pattern to look for the keys to delete.

    Returns Promise<void>

    A promise that resolves once all data has been deleted.

Private _delete

  • _delete<T>(key): Promise<undefined | T>
  • Private

    Delete a value stored for a given absolute key.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be set.

    Returns Promise<undefined | T>

    A promise that resolves once the data has been deleted.

Private _get

  • _get<T>(key): Promise<undefined | T>
  • Private

    Get a value for a given absolute key.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be queried.

    Returns Promise<undefined | T>

    A promise that resolves the queried data.

  • _get<T>(key, defaultValue): Promise<T>
  • Private

    Get a value for a given absolute key.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be queried.

    • defaultValue: T

      The default value in case there is no entry found.

    Returns Promise<T>

    A promise that resolves the queried data.

Private _set

  • _set<T>(key, value): Promise<void>
  • Private

    Set a value for an absolute key.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be set.

    • value: T

      The value to set.

    Returns Promise<void>

    A promise that resolves once the data is saved.

clear

  • Clear all data in a guild.

    Parameters

    • guild: Guild

      The guild to clear the data from.

    Returns Promise<void>

    A promise that resolves once all data has been deleted.

    Emits

    client#dataProviderClear

clearGlobal

  • Clear all data in a global scope.

    Returns Promise<void>

    A promise that resolves once all data has been deleted.

    Emits

    client#dataProviderClear

delete

  • Delete a key-value pair in a guild.

    Type Parameters

    • T = any

    Parameters

    • guild: Guild

      The guild for which the key-value pair will be deleted.

    • key: string

      The key to delete.

    Returns Promise<undefined | T>

    A promise that resolves the data that has been deleted.

deleteGlobal

  • Delete a key-value pair in a global scope.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key to delete.

    Returns Promise<undefined | T>

    A promise that resolves the data that has been deleted.

destroy

  • Gracefully destroy this Redis data provider. This closes the connection to the Redis service after queued up operations have ended.

    Returns Promise<void>

    Emits

    client#dataProviderDestroy

get

  • Get a value for a key in a guild.

    Type Parameters

    • T = any

    Parameters

    • guild: Guild

      The guild for which the data will be queried.

    • key: string

      The key of the data to be queried.

    Returns Promise<undefined | T>

    A promise that resolves the queried data.

  • Get a value for a key in a guild.

    Type Parameters

    • T = any

    Parameters

    • guild: Guild

      The guild for which the data will be queried.

    • key: string

      The key of the data to be queried.

    • defaultValue: T

      The default value in case there is no entry found.

    Returns Promise<T>

    A promise that resolves the queried data.

getGlobal

  • Get a value for a key in a global scope.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be queried.

    Returns Promise<undefined | T>

    A promise that resolves the queried data.

  • Get a value for a key in a global scope.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be queried.

    • defaultValue: T

      The default value in case there is no entry found.

    Returns Promise<T>

    A promise that resolves the queried data.

init

  • Initialize this Redis data provider. This connects the data provider to the Redis service. It also delegates the Redis client error handling to the client's error event handler.

    Returns Promise<RedisDataProvider>

    A promise that resolves this Redis data provider once it's ready.

    Emits

    client#dataProviderInit

Private resolveKey

  • Private

    Resolve the key for the provided guild or for the global scope if not provided.

    Parameters

    • key: string

      The key to resolve.

    • Optional guild: Guild

      The guild for which the key will be resolved.

    Returns string

    The resolved key.

set

  • Set a value for a key in a guild.

    Type Parameters

    • T = any

    Parameters

    • guild: Guild

      The guild for which the data will be set.

    • key: string

      The key of the data to be set.

    • value: T

      The value to set.

    Returns Promise<void>

    A promise that resolves once the data is saved.

setGlobal

  • Set a value for a key in a global scope.

    Type Parameters

    • T = any

    Parameters

    • key: string

      The key of the data to be set.

    • value: T

      The value to set.

    Returns Promise<void>

    A promise that resolves once the data is saved.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc