Overview

This reference lists the commands that ship with @effect-kit/redis: the method on its service, the Redis command it sends and the success type it returns. Each family page also has the option types that family uses. The tables are written by hand for now and list only methods that exist in the published types.

Commands for JSON, Search, TimeSeries, probabilistic structures and vector sets are also methods on Redis. They are covered in Modules.

How a method maps to a commandCopy Anchor Link

A method name is the Redis command in lowercase, so redis.zadd sends ZADD. Subcommands are joined in camel case: objectEncoding sends OBJECT ENCODING, xgroupCreate sends XGROUP CREATE, and scriptLoad sends SCRIPT LOAD.

A suffix means the same command with a different reply shape or form:

• WithScores, WithValues and With add the details to each element: zrange and zrangeWithScores.
• Count returns several elements where the plain method returns one: lpop and lpopCount.
• Bytes and Text choose the representation: get returns text and getBytes returns bytes.
• Ro is the read-only form: sortRo, georadiusRo.
• Store writes the result to a key instead of returning it.

Each command method has a pure Commands.* value with the same name. Pass it to redis.execute, redis.pipeline or redis.transaction. See Commands.

Example (One Command Written Two Ways)

import { Effect } from "effect";

import { Commands, Redis } from "@effect-kit/redis";

const program = Effect.gen(function* () {
  const redis = yield* Redis;

  const viaMethod = yield* redis.zcard("scores");
          
const viaMethod: bigint
  const viaValue = yield* redis.execute(Commands.zcard("scores"));
          
const viaValue: bigint

  return [viaMethod, viaValue] as const;
});

How a reply maps to a typeCopy Anchor Link

The success type depends on what the command returns. Errors are in the error channel, and a missing key is a value, not an error.

Stored values come back as Uint8Array, except get, hgetText and typed keys, which decode UTF-8 text. Nothing is JSON-encoded unless you ask. See Typed values.

Some Redis methods run commands rather than being one command:

Blocking commands, WATCH, subscriptions and MONITOR are not on Redis because they hold a connection. They are on RedisSessions, RedisPubSub and RedisMonitor. See Sessions.