getrange #

Returns a substring of a key's value.

Arguments #

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

Arguments	Type	Description
`key`	string	Key
`start`	integer	Range start
`end`	integer	Range end
`options`	object	Optional query arguments

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:

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 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);
}

Edit this page on Github