SDK
SDK Javascript v6.x
1

# expire

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

[Redis documentation]

# Arguments

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

# 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.ttl('foo'));
  await kuzzle.ms.expire('foo', 10);
  // Prints: 10
  console.log(await kuzzle.ms.ttl('foo'));
} catch (error) {
  console.error(error.message);
}