dw-core-functions-maxby.adoc

maxBy

partial$eol-warning.adoc

maxBy(Array<T>, (item: T) -> Comparable): T | Null

Returns the highest value of comparable elements in the given list (an array).

Returns null when the list is empty. Returns an error if the items in the list are not comparable.

Parameters

Name	Description
item	Element in the given array (of type Number, Boolean, DateTime, LocalDateTime, Date, LocalTime, Time, or TimeZone). Can be referenced with $.

Example

This example returns the highest value within objects (key-value pairs) in an array. Notice that it uses item.a to access the value of the object. You can also write the expression in the source like this: [ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy $.a

Source

%dw 2.0
output  application/json
---
[ { "a" : 1 }, { "a" : 3 }, { "a" : 2 } ] maxBy ((item) -> item.a)

Output

{ "a" : 3 }