ListReduce()

Iterates over every entry of the given list and calls the closure with every element.

This function will reduce the list to a single value and will return the value.

ListReduce( list=string, closure=function, initialValue=object, delimiter=string, includeEmptyFields=boolean, multiCharacterDelimiter=boolean );

Returns: any

Argument Description Default
list
string, required

string list to iterate

Alias: string
closure
function, required

function/closure that implements the following constructor

function(any result, object value, numeric index, string list, string delimiter){ return result; }

Alias: function, callback, udf
initialValue
object, optional

initial value passed as part of the first closure call

Alias: initial, initalValue
delimiter
string, optional

delimiter used to separate the string list

,
includeEmptyFields
boolean, optional

include empty fields or not

false
multiCharacterDelimiter
boolean, optional

specifying whether the delimiters parameter specifies a multi-character delimiter.

If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters.

This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

true

Examples

numbers = "1,3,5,7";
reducedVal = listReduce(numbers, function(previousValue, value)
{
return previousValue + value;
},0);
writeOutput("The sum of the digits #numbers# is #reducedVal#");

See also