Skip to content

Home / node / Commands / type-aliases / StreamTrimOptions @valkey/valkey-glide

@valkey/valkey-glide / Commands / StreamTrimOptions

Type Alias: StreamTrimOptions

StreamTrimOptions = { method: "minid"; threshold: GlideString; } | { method: "maxlen"; threshold: number; } & object

Type declaration

exact

exact: boolean

If true, the stream will be trimmed exactly. Equivalent to = in the Valkey API. Otherwise the stream will be trimmed in a near-exact manner, which is more efficient, equivalent to ~ in the Valkey API.

limit?

optional limit: number

If set, sets the maximal amount of entries that will be deleted.