append #
Appends a value to a key. If the key does not exist, it is created.
Arguments #
append(key, value, [options]);
Arguments | Type | Description |
---|---|---|
key | string | Key |
value | string | Value to append |
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 #
Returns the updated value length.
Usage #
try {
await kuzzle.ms.set('hw', 'Hello');
await kuzzle.ms.append('hw', ' World');
// Prints: Hello World
console.log(await kuzzle.ms.get('hw'));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)