ArrayFilter

Used to filter an array to items for which the closure function returns true.

Method Signature

ArrayFilter(array=[array], callback=[function:Predicate], parallel=[boolean], maxThreads=[integer], initialValue=[any])

Arguments

Argument	Type	Required	Description	Default
array	array	true	The array to reduce
callback	function:Predicate	true	The function to invoke for each item. The function will be passed 3 arguments: the value, the index, the array. You can alternatively pass a Java Predicate which will only receive the 1st arg.
parallel	boolean	false	Specifies whether the items can be executed in parallel	false
maxThreads	integer	false	The maximum number of threads to use when parallel = true
initialValue	any	false

Examples

Simple numeric comparison

Take an array of struct items and use arrayFilter to return ones of a rating 3 and higher.

Run Example

fruitArray = [ 
	{
		"fruit" : "apple",
		"rating" : 4
	},
	{
		"fruit" : "banana",
		"rating" : 1
	},
	{
		"fruit" : "orange",
		"rating" : 5
	},
	{
		"fruit" : "mango",
		"rating" : 2
	},
	{
		"fruit" : "kiwi",
		"rating" : 3
	}
];
favoriteFruits = arrayFilter( fruitArray, ( Any item ) => {
	return item.RATING >= 3;
} );
writedump( JSONSerialize( favoriteFruits ) );

Result: [{"fruit":"apple","rating":4},{"fruit":"orange","rating":5},{"fruit":"kiwi","rating":3}]

Using a member function

This is the same example as above, but using a member function on the array instead of a standalone function.

Run Example

fruitArray = [ 
	{
		"fruit" : "apple",
		"rating" : 4
	},
	{
		"fruit" : "banana",
		"rating" : 1
	},
	{
		"fruit" : "orange",
		"rating" : 5
	},
	{
		"fruit" : "mango",
		"rating" : 2
	},
	{
		"fruit" : "kiwi",
		"rating" : 3
	}
];
favoriteFruits = fruitArray.filter( ( Any item ) => {
	return item.RATING >= 3;
} );
writedump( JSONSerialize( favoriteFruits ) );

Result: [{"fruit":"apple","rating":4},{"fruit":"orange","rating":5},{"fruit":"kiwi","rating":3}]

Additional Examples

Run Example

fruitArray = [ 
	{
		FRUIT : "apple",
		RATING : 4
	},
	{
		FRUIT : "banana",
		RATING : 1
	},
	{
		FRUIT : "orange",
		RATING : 5
	},
	{
		FRUIT : "mango",
		RATING : 2
	},
	{
		FRUIT : "kiwi",
		RATING : 3
	}
];
favoriteFruits = arrayFilter( fruitArray, ( Any item ) => {
	return item.RATING >= 3;
} );
dump( favoriteFruits );

Run Example

fruitArray = [ 
	{
		FRUIT : "apple",
		RATING : 4
	},
	{
		FRUIT : "banana",
		RATING : 1
	},
	{
		FRUIT : "orange",
		RATING : 5
	},
	{
		FRUIT : "mango",
		RATING : 2
	},
	{
		FRUIT : "kiwi",
		RATING : 3
	}
];
favoriteFruits = fruitArray.filter( ( Any item ) => {
	return item.RATING >= 3;
} );
dump( favoriteFruits );

Related

• ArrayPrepend
• ArrayResize
• ArrayReduce
• ArrayMerge
• ArrayIndexExists
• ArrayIsDefined
• ArrayFindAll
• ArrayFindAllNoCase
• ArraySum
• ArraySplice
• ArrayReduceRight
• ArrayReverse
• ArrayFind
• ArrayFindNoCase
• ArrayContains
• ArrayContainsNoCase
• ArrayPush
• ArrayGetMetadata
• ArrayMap
• ArrayPop
• ArraySome
• ArrayDelete
• ArrayDeleteNoCase
• ArrayMedian
• ArrayAvg
• ArrayToList
• ArrayClear
• ArrayRange
• ArraySwap
• ArrayShift
• ArrayToStruct
• ArrayUnshift
• ArraySlice
• ArrayMid
• ArrayInsertAt
• ArrayNew
• ArraySet
• ArrayMax
• ArrayFirst
• ArrayDeleteAt
• ArraySort
• ArrayEach
• ArrayAppend
• ArrayEvery
• ArrayLast
• ArrayMin