Lucee object methods reference

Object Method String.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.
String.listReduce(function closure,[object initialValue,[string delimiter,[boolean includeEmptyFields,[boolean multiCharacterDelimiter]]]]):any

Category

list,iterator

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
closure function  Yes   function/closure that implements the following constructor [function(any result, object value, numeric index , string list, string delimiter):any].
initialValue object  No   inital value passed as part of the first closure call
delimiter string  No , delimiter used to separate the string list
includeEmptyFields boolean  No false include empty fields or not
multiCharacterDelimiter boolean  No true 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.