expire #

Sets a timeout (in seconds) on a key. After the timeout has expired, the key is automatically deleted.

Arguments #

expire(key, seconds, [options]);

Arguments	Type	Description
`key`	string	Key
`seconds`	integer	Number of seconds before the key expires
`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 a boolean telling whether the operation was successful or not.

Usage #

try {
  await kuzzle.ms.set('foo', 'bar');
  // Prints: -1
  console.log(await kuzzle.ms.ttl('foo'));
  await kuzzle.ms.expire('foo', 10);
  // Prints: 10
  console.log(await kuzzle.ms.ttl('foo'));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github