string.listReduce()

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

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

string.listReduce( list, closure [, initalValue [, delimiter [, includeEmptyFields [, multiCharacterDelimiter ] ] ] ] )

Returns: any

Argument Description
list
string, required

string list to iterate

closure
function, required

function/closure that implements the following constructor

[function(any result, object value, numeric index , string list, string delimiter):any].

initalValue
object, optional

inital value passed as part of the first closure call

delimiter
string, optional

delimiter used to separate the string list

includeEmptyFields
boolean, optional

include empty fields or not

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.

Examples

There are currently no examples for this function

See also