lset #
Sets the list element at index
with the provided value.
Arguments #
lset(key, index, value, [options]);
Arguments | Type | Description |
---|---|---|
key | string | List key |
index | integer | Index of the list (lists are 0-indexed). If negative, it goes backward from the end of the list |
value | string | Value to set |
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 once the new value is set.
Usage #
try {
await kuzzle.ms.rpush('listfoo', ['qux', 'bar', 'baz']);
await kuzzle.ms.lset('listfoo', 0, 'foo');
// Prints: [ 'foo', 'bar', 'baz' ]
console.log(await kuzzle.ms.lrange('listfoo', 0, -1));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)