spop #

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

Arguments #

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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolve #

Resolves to the list of removed elements.

Usage #

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);
}

Edit this page on Github