Skip to content

Home / node / Commands / interfaces / StreamGroupOptions @valkey/valkey-glide


@valkey/valkey-glide / Commands / StreamGroupOptions

Interface: StreamGroupOptions

Optional arguments for xgroupCreate.

See https://valkey.io/commands/xgroup-create/ for more details.

Properties

entriesRead?

optional entriesRead: string

An arbitrary ID (that isn't the first ID, last ID, or the zero "0-0". Use it to find out how many entries are between the arbitrary ID (excluding it) and the stream's last entry.

since Valkey version 7.0.0.


mkStream?

optional mkStream: boolean

If trueand the stream doesn't exist, creates a new stream with a length of 0.