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.

rename #

Renames a key to newkey. If newkey already exists, it is overwritten.

[Redis documentation] (opens new window)

rename(key, newkey, [options], [callback]) #

Arguments Type Description
key string Key identifier
newkey string New key identifier
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 null if successful.

Usage #

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