Connecting

A runtime layer opens the connection and provides Redis and the services next to it. Pick the layer for the runtime your code runs on.

Example (Reading Connection Settings From Config)

import { Config } from "effect";

import { RedisNode } from "@effect-kit/redis/node";

const settings = Config.all({ url: Config.String("REDIS_URL") });

export const RedisLive = RedisNode.layerConfig(settings);

layer takes the settings directly and layerConfig takes an Effect Config of them. The Upstash layer includes Effect's FetchHttpClient. To use your own HttpClient, call RedisUpstash.layerWithHttpClient.

Choosing a URL or an endpointCopy Anchor Link

Pass exactly one of url or endpoint. Passing both or neither fails with a RedisConfigError.

• url is a redis:// or rediss:// string. The path can hold a database number, as in redis://localhost:6379/2. The URL cannot have a query string or hash.
• endpoint is { host, port?, tls? } for TCP, { path } for a Unix socket, or { url, tls? }. The port defaults to 6379.

Example (Connecting With TLS or a Unix Socket)

import { RedisNode } from "@effect-kit/redis/node";

// Verified TLS: rediss:// verifies the server certificate
export const Tls = RedisNode.layer({ url: "rediss://cache.example.com:6380" });

// TLS options on an endpoint
export const TlsEndpoint = RedisNode.layer({
  endpoint: { host: "cache.example.com", port: 6380, tls: { serverName: "cache.example.com" } },
});

// Unix socket
export const Socket = RedisNode.layer({ endpoint: { path: "/var/run/redis/redis.sock" } });

A redis: URL combined with tls is a configuration error. Use rediss: for TLS URLs. A rediss: URL verifies the server certificate. To turn that off, pass endpoint: { url, tls: { rejectUnauthorized: false } }.

Common optionsCopy Anchor Link

These options sit next to url or endpoint on RedisNode.layer and RedisBun.layer. The full list is in Configuration.

Passing credentialsCopy Anchor Link

credentials takes Redacted values. A plain string is a type error. Credentials can also be part of the URL, but not both.

Example (Reading a Password From Config)

import { Config } from "effect";

import { RedisNode } from "@effect-kit/redis/node";

export const RedisLive = RedisNode.layerConfig(
  Config.all({
    url: Config.String("REDIS_URL"),
    credentials: Config.all({ password: Config.Redacted("REDIS_PASSWORD") }),
  }),
);