summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/lpop.md
blob: f8701127c8ce2a7cc537147656674378103ceef6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Removes and returns the first elements of the list stored at `key`.

By default, the command pops a single element from the beginning of the list.
When provided with the optional `count` argument, the reply will consist of up
to `count` elements, depending on the list's length.

@return

When called without the `count` argument:

@bulk-string-reply: the value of the first element, or `nil` when `key` does not
exist.

When called with the `count` argument:

@array-reply: list of popped elements, or `nil` when `key` does not exist.

@history

- `>= 6.2`: Added the `count` argument.

@examples

```cli
RPUSH mylist "one" "two" "three" "four" "five"
LPOP mylist
LPOP mylist 2
LRANGE mylist 0 -1
```