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 |
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(opens new window)