valkey_client library

This library provides a Valkey-compatible interface.

It allows users to use the client with familiar class names (e.g., ValkeyClient, ValkeyException). This is a wrapper around typeredis to provide a seamless developer experience (DX) for those migrating from Valkey or preferring Valkey terminology.

Typedefs

ValkeyClient = TRClient
Alias for TRClient. Use this for Standalone/Sentinel connections.
ValkeyClientException = TRClientException
Alias for TRClientException. Thrown on invalid API usage.
ValkeyClusterClient = TRClusterClient
Alias for TRClusterClient. Use this for Cluster connections.
ValkeyConnectionException = TRConnectionException
Alias for TRConnectionException. Thrown on network/socket errors.
ValkeyConnectionSettings = TRConnectionSettings
Alias for TRConnectionSettings.
ValkeyException = TRException
Alias for TRException. The base class for all exceptions.
ValkeyLogLevel = TRLogLevel
Alias for TRLogLevel.
ValkeyMessage = TRMessage
Alias for TRMessage. Represents a Pub/Sub message.
ValkeyParsingException = TRParsingException
Alias for TRParsingException. Thrown on protocol parsing errors.
ValkeyPool = TRPool
Alias for TRPool. Use this for connection pooling.
ValkeyServerException = TRServerException
Alias for TRServerException. Thrown when the server responds with an error.