SDK
SDK Javascript v6.x
1

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.

getbit #

Returns the bit value at the provided offset, in the string value stored in a key.

[Redis documentation]

Arguments #

Copied to clipboard!
getbit(key, offset, options])


Arguments Type Description
key
string
Key
offset
integer
Bit offset
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 bit at the provided offset (0 or 1).

Usage #

Copied to clipboard!
try {
  await kuzzle.ms.set('foo', '\x01');
  // Prints: 0
  console.log(await kuzzle.ms.getbit('foo', 2));
  // Prints: 1
  console.log(await kuzzle.ms.getbit('foo', 7));
} catch (error) {
  console.error(error.message);
}