ltrim #

Trims an existing list so that it will contain only the specified range of elements specified.

Arguments #

ltrim(key, start, stop, [options]);

Arguments	Type	Description
`key`	string	List key
`start`	integer	Starting index (inclusive)
`stop`	integer	Ending index (inclusive)
`options`	object	Optional query arguments

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

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 once the operation is finished.

Usage #

try {
  await kuzzle.ms.rpush('listfoo', ['a', 'b', 'c', 'd', 'e', 'f']);
  await kuzzle.ms.ltrim('listfoo', 3, -2);
  // Prints [ 'd', 'e' ]
  console.log(await kuzzle.ms.lrange('listfoo', 0, -1));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github