expireat #

Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted.

Arguments #

expireat(key, timestamp, [options]);

Arguments	Type	Description
`key`	string	Key
`timestamp`	integer	Expiration timestamp (Epoch format)
`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.exists(['foo']));
  // Oct. 12, 2011
  await kuzzle.ms.expireat('foo', 1318425955);
  // Prints: 0
  console.log(await kuzzle.ms.exists(['foo']));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github