SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

pexpireat #

Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted.
The timestamp parameter accepts an Epoch time (opens new window) value, in milliseconds.

[Redis documentation] (opens new window)

pexpireat(key, timestamp, [options], [callback]) #

Arguments Type Description
key string Key identifier
timestamp int Key's expiration timestamp, in milliseconds
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 #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.pexpireat('key', 1488540242465, function (err, status) {
  // callback called once the action has completed
// Using promises (NodeJS only)
kuzzle.memoryStorage.pexpireatPromise('key', 1488540242465)
  .then(status => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!