mset #
Sets the provided keys to their respective values. If a key does not exist, it is created. Otherwise, the key's value is overwritten.
Arguments #
mset(entries, [options]);
Arguments | Type | Description |
---|---|---|
entries | object[] | List of key-value pairs to set |
options | object | Optional query arguments |
entries #
The entries
argument is an array of objects. Each object is a key-value pair, defined with the following properties:
Property | Type | Description |
---|---|---|
key | string | Key |
value | * | Value |
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 successfully once the keys are set.
Usage #
try {
// Prints: 0
console.log(await kuzzle.ms.exists(['key1', 'key2', 'key3']));
await kuzzle.ms.mset([
{ key: 'key1', value: 'val1' },
{ key: 'key2', value: 'val2' },
{ key: 'key3', value: 'val3' }
]);
// Prints: 3
console.log(await kuzzle.ms.exists(['key1', 'key2', 'key3']));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)