Type Alias: GlideClientConfiguration

GlideClientConfiguration = BaseClientConfiguration & object

Configuration options for creating a GlideClient.

Extends BaseClientConfiguration with properties specific to GlideClient, such as database selection, reconnection strategies, and Pub/Sub subscription settings.

Type declaration

advancedConfiguration?

optional advancedConfiguration: AdvancedGlideClientConfiguration

Advanced configuration settings for the client.

databaseId?

optional databaseId: number

index of the logical database to connect to.

pubsubSubscriptions?

optional pubsubSubscriptions: PubSubSubscriptions

PubSub subscriptions to be used for the client. Will be applied via SUBSCRIBE/PSUBSCRIBE commands during connection establishment.

Remarks

This configuration allows you to tailor the client's behavior when connecting to a standalone Valkey Glide server.

Database Selection: Use databaseId to specify which logical database to connect to.
Pub/Sub Subscriptions: Predefine Pub/Sub channels and patterns to subscribe to upon connection establishment.

Example

const config: GlideClientConfiguration = {
  databaseId: 1,
  pubsubSubscriptions: {
    channelsAndPatterns: {
      [GlideClientConfiguration.PubSubChannelModes.Pattern]: new Set(['news.*']),
    },
    callback: (msg) => {
      console.log(`Received message on ${msg.channel}:`, msg.payload);
    },
  },
};