sadd #
Adds members to a set of unique values stored at key
.
If the destination set does not exist, it is created beforehand.
Arguments #
sadd(key, values, [options]);
Arguments | Type | Description |
---|---|---|
key | string | Set key |
values | string[] | Values to add |
options | object | Optional query arguments |
options #
The options
arguments can contain the following option properties:
Property | Type (default) | Description |
---|---|---|
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 number of successfully added members.
Usage #
try {
// Prints: 2
console.log(await kuzzle.ms.sadd('setfoo', ['foo', 'bar']));
// Prints: 1
console.log(await kuzzle.ms.sadd('setfoo', ['foo', 'bar', 'baz']));
// Prints: [ 'foo', 'bar', 'baz' ]
console.log(await kuzzle.ms.smembers('setfoo'));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)