SDK
SDK Javascript v7.x
2

setex #

Sets a value and a time to live (in seconds) on a key. If the key already exists, it is overwritten.

[Redis documentation]

Arguments #

setex(key, value, seconds, [options]);

ArgumentsTypeDescription
key
string
Key
value
string
Value
seconds
integer
Number of seconds after which the key is deleted
options
object
Optional query arguments

options #

The options arguments can contain the following option properties:

PropertyType (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 operation succeeds.

Usage #

try {
  await kuzzle.ms.setex('foo', 'bar', 60);
  // Prints: 60
  console.log(await kuzzle.ms.ttl('foo'));
  // Prints: bar
  console.log(await kuzzle.ms.get('foo'));
} catch (error) {
  console.error(error.message);
}