getrange #

Returns a substring of a key's value.

[Redis documentation]

Arguments #

getrange(key, start, end, [options]);

string

integer

integer

object

The arguments start and end can be negative. In that case, the offset is calculated from the end of the string, going backward. For instance, -3 is the third character from the end of the string.

options #

The options arguments can contain the following option properties:

boolean (true)

Resolve #

Resolves to the extracted substring.

Usage #

try {
  await kuzzle.ms.set('foo', 'foobar');
  // Prints: 'oba'
  console.log(await kuzzle.ms.getrange('foo', 2, 4));
  // Prints: 'bar'
  console.log(await kuzzle.ms.getrange('foo', -3, -1));
} catch (error) {
  console.error(error.message);
}