XTRIM

Trims the stream by removing entries to keep it at a reasonable size.

Arguments

key · string · required

The key of the stream.

options · object · required

Show properties

strategy · 'MAXLEN' | 'MINID' · required

The trimming strategy:

• MAXLEN: Trim based on the maximum number of entries
• MINID: Trim based on the minimum ID

threshold · number | string · required

The threshold value for trimming:

• For MAXLEN: The maximum number of entries to keep (number)
• For MINID: The minimum ID to keep (string). Entries with IDs lower than this will be removed

exactness · '~' | '='

Use ~ for approximate trimming (more efficient, default) or = for exact trimming.

limit · number

Limit how many entries will be trimmed at most (only valid with approximate trimming ~).

Response

The number of entries removed from the stream.

Approximate trim by max length

const result = await redis.xtrim("mystream", {
  strategy: "MAXLEN",
  threshold: 100,
  exactness: "~"
});