array.any()

This method operates on an array. You typically fetch documents from a collection as a set, not an Array. For the equivalent Set method, see set instance methods.

For differences between Sets and Arrays, see Sets vs. Arrays.

Test if any element of an Array matches a provided predicate.

Signature

any(predicate: (A => Boolean | Null)) => Boolean

Description

Tests if any element of the calling Array matches a provided predicate function.

Parameters

Parameter Type Required Description

predicate

Predicate function

true

Anonymous predicate function that:

  • Accepts an Array element as its only argument. You can pass in this argument using arrow function syntax.

  • Returns Boolean or Null.

The method returns true if the predicate is true for any element in the Array.

Return value

Type Description

Boolean

If true, the predicate is true for one or more elements in the Array. Otherwise, false.

Examples

let iter = [1, 2, 3]
iter.any(v => v == 2)
true
\