XADD

await redis.xadd(key, "*", { name: "John Doe", age: 30 });

await redis.xadd(key, "*", { name: "John Doe", age: 30 }, {
  trim: {
    type: "MAXLEN",
    threshold: 1000,
    comparison: "=",
  },
});

Arguments

string

required

The key to of the stream.

string | *

required

The stream entry ID. If * is passed, a new ID will be generated automatically.

Record<string, unknown>

required

Key-value data to be appended to the stream.

boolean

Prevent creating the stream if it does not exist.

'MAXLEN' | 'MINID'

required

The trim mode.

number | string

required

The threshold value for the trim mode.

~ | =

required

The comparison operator for the trim mode.

number

Limit how many entries will be trimmed at most.

The ID of the newly added entry.

await redis.xadd(key, "*", { name: "John Doe", age: 30 });

await redis.xadd(key, "*", { name: "John Doe", age: 30 }, {
  trim: {
    type: "MAXLEN",
    threshold: 1000,
    comparison: "=",
  },
});

⌘I