expire #

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

expire(key, seconds, [options], [callback]) #

Arguments	Type	Description
`key`	string	Key identifier
`seconds`	int	Time to live, in seconds
`options`	JSON Object	Optional parameters
`callback`	function	Callback

Options #

Option	Type	Description	Default
`queuable`	boolean	Make this request queuable or not	`true`

Return Value #

Returns the MemoryStorage object to allow chaining.

Callback Response #

Returns a boolean specifying if the operation was successful or not.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.expire('key', 42, function (err, status) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.expirePromise('key', 42)
  .then(status => {
    // resolved once the action has completed
  });

Callback response:

true

Edit this page on Github