hdel #

Removes fields from a hash.

Arguments #

hdel(key, fields, [options]);

Arguments	Type	Description
`key`	string	Hash key
`fields`	string[]	Field keys to delete
`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 to the number of deleted fields.

Usage #

try {
  await kuzzle.ms.hset('hashfoo', 'field1', 'val');
  await kuzzle.ms.hset('hashfoo', 'field2', 'val');
  // Prints: 2
  console.log(await kuzzle.ms.hlen('hashfoo'));
  await kuzzle.ms.hdel('hashfoo', ['field2']);
  // Prints: 1
  console.log(await kuzzle.ms.hlen('hashfoo'));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github