Core 2.x

spop

Removes and returns one or more elements at random from a set of unique values.

[Redis documentation]

Arguments

Copied to clipboard!
spop(key, [options]);

Arguments Type Description
key
string
Set key
options
object
Optional query arguments

options

The options arguments can contain the following option properties:

Property Type (default) Description
count
integer (1)
The number of elements to pop
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolve

Resolves to the list of removed elements.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.sadd('setfoo', ['a', 'b', 'c', 'd', 'e', 'f']);
  // Prints one of the elements of setfoo, at random
  console.log(await kuzzle.ms.spop('setfoo'));
  // Prints three of the remaining elements of setfoo, at random
  console.log(await kuzzle.ms.spop('setfoo', {count: 3}));
  // Prints: 2
  console.log(await kuzzle.ms.scard('setfoo'));
} catch (error) {
  console.error(error.message);
}