listEvery

This function calls a given callback function for every element in a given string list and returns true, if all of the calls returns true.

listEvery(list, closure [, delimiter] [, includeEmptyFields] [, multiCharacterDelimiter] [, parallel] [, maxThreads]) → returns boolean

Member Function Syntax

list.listEvery(closure [, delimiter] [, includeEmptyFields] [, multiCharacterDelimiter] [, parallel] [, maxThreads])

  1. CFDocs
  2. Functions
  3. String Functions
  4. listEvery
  5. Lucee
  6. BoxLang 1.0.0+
  7. 0 Issue
  8. Edit
See Also:   arrayEvery   structEvery   queryEvery

Argument Reference

list string
Required

List to iterate.

closure function
Required

Callback function that is called for every item of the list and returns a boolean value. The arguments passed to the callback are

value: Current list item
index: Index of the list item within the list
list: List as defined in the 'list' parameter
delimiter: Delimiter as defined in the 'delimiter' parameter

delimiter string
Default: ,

Delimiter used to separate the string list.

includeEmptyFields boolean
Default: false

Specifies whether to include empty fields or not.

multiCharacterDelimiter boolean
Default: true

Specifies whether the 'delimiter' parameter specifies a multi-character delimiter. If it is set to true, all characters are considered as one delimiter; otherwise each character is a delimiter on its own.

parallel boolean
Default: false

Specifies whether to execute closures in parallel.

maxThreads numeric
Default: 20

Maximum number of threads executed, ignored when argument 'parallel' is set to false.

Links more information about listEvery

Examples
Sample code invoking the listEvery function

Checks whether all items in a list are greater than 2 and outputs true because all of them fulfill the requirement.

list = '4,5,6,7';
writeOutput(listEvery(list, function(value) { return value gt 2; }));

Expected Result: true

Checks whether all items in a list are greater than 2 and outputs false because some of them do not fulfill the requirement.

list = '1,2,3,4';
writeOutput(listEvery(list, function(value) { return value gt 2; }));

Expected Result: false

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub