Array functions

Reference documentation for Expressif functions in the array scope.

Name	Overview
adjacent	Evaluates an operation against every consecutive pair of input values. Returns null when the input cannot be evaluated.
array	Constructs a new array by evaluating zero or more positional expressions from left to right against the same input. Spread arguments expand array values in place. This is the runtime-expression counterpart of array literal syntax.
broadcast	Executes an accumulator once over the full input enumerable, then returns the final accumulated value repeated once for each input element. Returns null when the input is not an enumerable or is a string.
cardinality	Returns the number of elements in the input array.
chunk	Splits an array into consecutive, non-overlapping chunks of at most the specified size, preserving a final partial chunk. It resembles a count-based tumbling window but, unlike general sliding or hopping windows, has no separate step and always keeps the final partial chunk. It does not group items by inactivity or time. Returns null when the input cannot be evaluated.
complement	Returns the distinct values from the specified array that do not appear in the pipeline input, preserving the specified array order. Returns null when the input cannot be evaluated.
difference	Returns the distinct values from the pipeline input that do not appear in the specified array, preserving the pipeline input order. Returns null when the input cannot be evaluated.
distinct	Returns the unique values from the input array in the order of their first occurrence. Returns null when the input cannot be evaluated.
filter	Applies a predicate expression to each input item and returns only items for which the predicate evaluates to true. Returns null when the input is not an enumerable or is a string.
first-elements	Returns up to the requested number of elements from the start of the input enumerable. Returns null when the input is not an enumerable, is a string, or the count is negative.
fold	Executes an accumulator once over the full input enumerable and returns the final accumulated value. Returns null when the input is not an enumerable or is a string.
intersection	Returns the distinct values found in both the pipeline input and the specified array, preserving the pipeline input order. Returns null when the input cannot be evaluated.
lag	Returns the previous value for each input element. The first output value is null because there is no previous element. Preserves input cardinality (one output item per input item). Returns null when the input is not an enumerable or is a string.
last-elements	Returns up to the requested number of elements from the end of the input enumerable, preserving their order. Returns null when the input is not an enumerable, is a string, or the count is negative.
lead	Returns the next value for each input element. The last output value is null because there is no next element. Preserves input cardinality (one output item per input item). Returns null when the input is not an enumerable or is a string.
map	Applies a transformation expression to each input item and returns the transformed values. Preserves input cardinality (one output item per input item). Returns null when the input is not an enumerable or is a string.
pairwise	Returns each consecutive pair of input values as a tuple. Returns null when the input cannot be evaluated.
reverse	Returns the input enumerable with elements emitted in the opposite order. Preserves input cardinality (one output item per input item). Returns null when the input is not an enumerable or is a string.
scan	Executes an accumulator progressively over the input enumerable and returns the intermediate accumulated value after each input element. Preserves input cardinality (one output item per input item). This differs from fold (final value only) and broadcast (final value repeated). Returns null when the input is not an enumerable or is a string.
skip-first-elements	Omits the requested number of elements from the start of the input enumerable and returns the remainder. Returns null when the input is not an enumerable, is a string, or the count is negative.
skip-last-elements	Omits the requested number of elements from the end of the input enumerable and returns the remainder. Returns null when the input is not an enumerable, is a string, or the count is negative.
slice-elements	Returns the elements in the zero-based half-open range from start, inclusive, to end, exclusive. Returns null when the input is not an enumerable, is a string, or either bound is negative.
symmetric-difference	Returns the distinct values that appear in exactly one of the two arrays, listing pipeline-input exclusives first and parameter-array exclusives second while preserving order within each source. Returns null when the input cannot be evaluated.
union	Returns the distinct values appearing in either the pipeline input or the specified array, listing pipeline-input values first and argument-only values second while preserving order within each source. Returns null when the input cannot be evaluated.
zip	Combines corresponding values from the input array and a second array into two-element tuples, stopping when either array is exhausted. Returns null when either value cannot be evaluated as an array.
zip-padded	Combines corresponding values from the input array and a second array into two-element tuples until both arrays are exhausted, using null for a missing value. Returns null when either value cannot be evaluated as an array.
zip-strict	Combines corresponding values from equally sized input and parameter arrays into two-element tuples. Returns null when the arrays have different lengths or either value cannot be evaluated as an array.