string.listFilter()

edit

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

string.listFilter( filter=function, delimiter=string, includeEmptyFields=boolean, multiCharacterDelimiter=boolean, parallel=boolean, maxThreads=number )

Returns: String

Argument Description
filter
function, required
edit

A function/closure that implements the following constructor

function(any value, numeric index, string list, string delimiter) { return true/false; }

Alias: closure, function, callback

delimiter
string, optional
edit

delimiter used to separate the string list

includeEmptyFields
boolean, optional
edit

include empty fields or not

multiCharacterDelimiter
boolean, optional
edit

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
edit

execute closures parallel

maxThreads
number, optional
edit

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

Alias: maxThreadCount

Examples

edit
	listVal = "one,two,three,four,five";
	res = listVal.listFilter(
	function(elem,ind){
		if(elem != "three"){
			return true;
		}
		return false;
	});
	writeDump(res);

See also