Documentation Index
Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Arguments
The XGROUP subcommand and its parameters. Can be one of:
Create a new consumer group.
The stream entry ID to start consuming from. Use ’$’ to start from the end.
Create the stream if it doesn’t exist.
Set the number of entries read by the group.
Create a new consumer in the group.
The consumer name to create.
Delete a consumer from the group.
The consumer name to delete.
Delete the entire consumer group.
The consumer group name to destroy.
Set the last delivered ID for the group.
The stream entry ID to set as the last delivered ID.
Set the number of entries read by the group.
Response
The return type depends on the subcommand:
- CREATE: Returns “OK” string
- CREATECONSUMER: Returns 1 if created, 0 if already exists
- DELCONSUMER: Returns the number of pending messages the consumer had
- DESTROY: Returns 1 if destroyed, 0 if group didn’t exist
- SETID: Returns “OK” string
const result = await redis.xgroup("mystream", {
type: "CREATE",
group: "mygroup",
id: "$",
options: { MKSTREAM: true }
});
