SDK
SDK Javascript v5.x
1

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.

touch #

Alters the last access time of one or multiple keys. A key is ignored if it does not exist.

[Redis documentation]


touch(keys, [options], [callback]) #

ArgumentsTypeDescription
keysarrayList of keys to alter
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns an integer containing the number of altered keys.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.touch(['key1', 'key2', '...'], function (err, count) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.touchPromise(['key1', 'key2', '...'])
  .then(count => {
    // resolved once the action has completed
  });

Callback response:

3