pexpire #

Sets a timeout (in milliseconds) on a key. After the timeout has expired, the key will automatically be deleted.

Arguments #

pexpire(key, milliseconds, [options]);

Arguments	Type	Description
`key`	string	Key
`milliseconds`	integer	Number of milliseconds after which the key is deleted
`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 succeeded or not.

Usage #

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

Edit this page on Github