summaryrefslogtreecommitdiffstats
path: root/src/commands/brpop.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/brpop.json')
-rw-r--r--src/commands/brpop.json79
1 files changed, 79 insertions, 0 deletions
diff --git a/src/commands/brpop.json b/src/commands/brpop.json
new file mode 100644
index 0000000..129f74d
--- /dev/null
+++ b/src/commands/brpop.json
@@ -0,0 +1,79 @@
+{
+ "BRPOP": {
+ "summary": "Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
+ "complexity": "O(N) where N is the number of provided keys.",
+ "group": "list",
+ "since": "2.0.0",
+ "arity": -3,
+ "function": "brpopCommand",
+ "history": [
+ [
+ "6.0.0",
+ "`timeout` is interpreted as a double instead of an integer."
+ ]
+ ],
+ "command_flags": [
+ "WRITE",
+ "BLOCKING"
+ ],
+ "acl_categories": [
+ "LIST"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RW",
+ "ACCESS",
+ "DELETE"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 1
+ }
+ },
+ "find_keys": {
+ "range": {
+ "lastkey": -2,
+ "step": 1,
+ "limit": 0
+ }
+ }
+ }
+ ],
+ "arguments": [
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0,
+ "multiple": true
+ },
+ {
+ "name": "timeout",
+ "type": "double"
+ }
+ ],
+ "reply_schema": {
+ "oneOf": [
+ {
+ "description": "No element could be popped and the timeout expired.",
+ "type": "null"
+ },
+ {
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": [
+ {
+ "description": "The name of the key where an element was popped ",
+ "type": "string"
+ },
+ {
+ "description": "The value of the popped element",
+ "type": "string"
+ }
+ ]
+ }
+ ]
+ }
+ }
+}