Skip to main content

Filter component

Iterates over elements of collection, returning an array of all elements that match the values for specified key. Note: the comparison is not deep and only works for values of primitive types.

component image

In-ports

collection Array - The collection to iterate over.

values Array - The values to match to.

Out-ports

results Array - Returns the new filtered array, otherwise false

Overview

Filter component provides a basic filtering over elements of collection. You specify the key of the field you want to make a comparison by in the Settings. The field should be a primitive value and not an Object. All matched elements of the collection are returned as new array. If no match is found then boolean false is emitted.

Its useful to quickly filter out items of a collection by array of ID values.

Settings

Key name

The key name based on which filtering needs to be done.