List.RemoveFirstN

Syntax

List.RemoveFirstN(list as list, optional countOrCondition as any) as list

About

Returns a list that removes the first element of list list. If list is an empty list an empty list is returned. This function takes an optional parameter, countOrCondition, to support removing multiple values as listed below.

  • If a number is specified, up to that many items are removed.
  • If a condition is specified, any consecutive matching items at the start of list are removed.
  • If this parameter is null, the default behavior is observed.

Example 1

Remove the first three numbers from the list.

Usage

List.RemoveFirstN({1, 2, 3, 4, 5}, 3)

Output

{4, 5}

Example 2

Remove the leading numbers from the list as long as they're greater than 3.

Usage

List.RemoveFirstN({5, 4, 2, 6, 1}, each _ > 3)

Output

{2, 6, 1}