rename #

Renames a key.

If the new key name is already used, then it is overwritten.

Arguments #

rename(src, dest, [options]);

Arguments	Type	Description
`src`	string	Key to rename
`dest`	string	New key name
`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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolve #

Resolves once the operation succeeds.

Usage #

try {
  await kuzzle.ms.set('foo', 'World');
  await kuzzle.ms.rename('foo', 'Hello');
  // Prints: World
  console.log(await kuzzle.ms.get('Hello'));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github