List
LPOP
Remove and return the first element(s) of a list
Arguments
keybodystringrequired
The key of the list.
countbodyinteger
How many elements to pop. If not specified, a single element is popped.
Response
TValue | TValue[] | nullrequired
The popped element(s). If count was specified, an array of elements is
returned, otherwise a single element is returned. If the list is empty, null
is returned.
Single
await redis.rpush("key", "a", "b", "c"); const element = await redis.lpop("key");console.log(element); // "a"Multiple
await redis.rpush("key", "a", "b", "c"); const element = await redis.lpop("key", 2);console.log(element); // ["a", "b"]