Core 2.x

expireat

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

[Redis documentation]

Arguments

Copied to clipboard!
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

Resolve

Resolves to a boolean telling whether the operation was successful or not.

Usage

Copied to clipboard!
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);
}