summaryrefslogtreecommitdiffstats
path: root/src/commands/lpop.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/lpop.json')
-rw-r--r--src/commands/lpop.json77
1 files changed, 77 insertions, 0 deletions
diff --git a/src/commands/lpop.json b/src/commands/lpop.json
new file mode 100644
index 0000000..b1d6cd1
--- /dev/null
+++ b/src/commands/lpop.json
@@ -0,0 +1,77 @@
+{
+ "LPOP": {
+ "summary": "Returns the first elements in a list after removing it. Deletes the list if the last element was popped.",
+ "complexity": "O(N) where N is the number of elements returned",
+ "group": "list",
+ "since": "1.0.0",
+ "arity": -2,
+ "function": "lpopCommand",
+ "history": [
+ [
+ "6.2.0",
+ "Added the `count` argument."
+ ]
+ ],
+ "command_flags": [
+ "WRITE",
+ "FAST"
+ ],
+ "acl_categories": [
+ "LIST"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RW",
+ "ACCESS",
+ "DELETE"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 1
+ }
+ },
+ "find_keys": {
+ "range": {
+ "lastkey": 0,
+ "step": 1,
+ "limit": 0
+ }
+ }
+ }
+ ],
+ "reply_schema": {
+ "oneOf": [
+ {
+ "description": "Key does not exist.",
+ "type": "null"
+ },
+ {
+ "description": "In case `count` argument was not given, the value of the first element.",
+ "type": "string"
+ },
+ {
+ "description": "In case `count` argument was given, a list of popped elements",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+
+ "arguments": [
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0
+ },
+ {
+ "name": "count",
+ "type": "integer",
+ "optional": true,
+ "since": "6.2.0"
+ }
+ ]
+ }
+}