@valkey/valkey-glide
    Preparing search index...

    Type Alias GlideClientConfiguration

    GlideClientConfiguration: BaseClientConfiguration & {
        advancedConfiguration?: AdvancedGlideClientConfiguration;
        pubsubSubscriptions?: GlideClientConfiguration.PubSubSubscriptions;
        readOnly?: boolean;
    }

    Configuration options for creating a GlideClient.

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

    Type Declaration

    • OptionaladvancedConfiguration?: AdvancedGlideClientConfiguration

      Advanced configuration settings for the client.

    • OptionalpubsubSubscriptions?: GlideClientConfiguration.PubSubSubscriptions

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

    • OptionalreadOnly?: boolean

      When true, enables read-only mode for the standalone client.

      In read-only mode:

      • The client skips primary node detection (INFO REPLICATION command)
      • All connected nodes are treated as valid read targets
      • Write commands are blocked and will return an error
      • The default ReadFrom strategy becomes PreferReplica if not explicitly set

      This is useful for connecting to replica-only deployments or when you want to prevent accidental write operations.

      Note: read-only mode is not compatible with AZAffinity or AZAffinityReplicasAndPrimary read strategies.

      Defaults to false.

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

    • Database Selection: Use databaseId (inherited from BaseClientConfiguration) to specify which logical database to connect to.
    • Pub/Sub Subscriptions: Predefine Pub/Sub channels and patterns to subscribe to upon connection establishment.
    const config: GlideClientConfiguration = {
      databaseId: 1, // Inherited from BaseClientConfiguration
      pubsubSubscriptions: {
        channelsAndPatterns: {
          [GlideClientConfiguration.PubSubChannelModes.Pattern]: new Set(['news.*']),
        },
        callback: (msg) => {
          console.log(`Received message on ${msg.channel}:`, msg.payload);
        },
      },
    };

    Settings

    Member Visibility