spop #

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

[Redis documentation]

---

spop(key, [options], [callback]) #

Arguments	Type	Description
key	string	Key identifier
options	JSON Object	Optional parameters
callback	function	Callback

---

Options #

Option	Type	Description	Default
count	int	Number of elements to remove	1
queuable	boolean	Make this request queuable or not	true

---

Return Value #

Returns the MemoryStorage object to allow chaining.

---

Callback Response #

Returns an array of removed elements.

Usage #

Copied to clipboard!

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.spop('key', function (err, elements) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.spopPromise('key')
  .then(elements => {
    // resolved once the action has completed
  });

Callback response:

Copied to clipboard!

["removed element"]