arraySlice

arraySlice(array array, any start, [any end], [integer stride]) → array slice

Returns a sublist of array containing all the elements from position start up to position end (excluded).

If the increment parameter stride is given, the function only selects one element every stride elements.

Example: new list containing the elements from position 10 to 20 (excluded).

arraySlice(values, 10, 20)

values.slice(10, 20)

values[10:20]

Parameters

• array: The source list.
• start: The start position.
• end: The end position (excluded).
• stride: The increment (1 by default).

Return

• slice: The resulting sublist.

Examples

• Range access: returns a new list containing the elements from position 10 (included) to 20 (excluded).

arraySlice(values, 10, 20)

values.slice(10, 20)

values[10:20]

• Range access with an increment: returns the elements at positions 10, 13, 16, 19.

arraySlice(values, 10, 20, 3)

// slice has no increment: keep one element out of 3
values.slice(10, 20).filter((_, i) => i % 3 === 0)

values[10:20:3]

• Negative increment: returns the elements at positions 20, 17, 14, 11

arraySlice(values, 20, 10, -3)

// positions 11 to 20 reversed, then one element out of 3
values.slice(11, 21).reverse().filter((_, i) => i % 3 === 0)

values[20:10:-3]

Note

• Available from LeekScript 4 onward.