SDK
SDK Javascript v7.x
2

pfadd #

Adds elements to a HyperLogLog data structure.

[Redis documentation]

Arguments #

pfadd(key, elements, [options]);

ArgumentsTypeDescription
key
string
HyperLogLog key
options
object
Optional query arguments

options #

The options arguments can contain the following option properties:

PropertyType (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 #

Returns a boolean telling whether the addition altered the HyperLogLog structure or not.

Usage #

try {
  await kuzzle.ms.pfadd('hllfoo', ['foo', 'bar', 'baz', 'qux']);
  // Prints: 4
  console.log(await kuzzle.ms.pfcount('hllfoo'));
} catch (error) {
  console.error(error.message);
}