Configuration
Look up every connection, limits, sessions, subscriptions and scripts option with its type and default.
RedisNode.layer and RedisBun.layer take one NativeClientInput: an address, connection settings, and optional groups for limits, connection, sessions, subscriptions and scripts. RedisUpstash.layer takes an UpstashClientInput. Every default below is the value in the package source. Sizes are bytes and times are milliseconds.
Example (Changing a Few Defaults)
import { } from "@effect-kit/redis/node";
export const = .({
: "redis://localhost:6379",
: 10_000,
: { : 64 },
: { : 4 },
});Connection
Give url or endpoint. Giving both or neither fails with a RedisConfigError for endpoint. Credentials can be in the URL or in credentials, not both.
Prop
Type
TLS
TlsOptions goes in endpoint.tls. A rediss: URL verifies the certificate unless you pass endpoint: { url, tls: { rejectUnauthorized: false } }. A redis: URL with tls is a RedisConfigError.
Prop
Type