string.listFilter()

This function creates a new string list that returns all entries from an string list that match the given filter.

string.listFilter( list, filter [, delimiter [, includeEmptyFields [, multiCharacterDelimiter [, parallel [, maxThreads ] ] ] ] ] )

Returns: String

Argument Description
list
string, required

list to filter entries from

filter
function, required

function/closure that implements the following constructor [function(any value, numeric index,string list, string delimiter):boolean].

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.

parallel
boolean, optional

execute closures parallel

maxThreads
number, optional

maximum number of threads executed, ignored when argument "parallel" is set to false

Examples

There are currently no examples for this function

See also