Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

array.indexWhere()

Get the index of the first Array element that matches a provided predicate.

Signature

indexWhere(predicate: (A => Boolean | Null)) => Number | Null

indexWhere(predicate: A => Boolean | Null, start: Number) => Number | Null

Description

Searches, left-to-right, for the first element that matches a provided predicate function and returns the index of the element if a match is found.

If the optional start index is provided, the method searches left-to-right starting at index and returns the first matching index (inclusive).

Parameters

Parameter Type Required Description

predicate

Function

Yes

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.

If the predicate evaluates to true for an element, the element is considered a match.

start

Number

Starting index (inclusive) of the left-to-right search. Must be an Int.

Return value

One of:

Type Description

Number

Index of the element that matches the provided predicate.

Null

Returned if a match isn’t found.

Examples

['a', 'b', 'c', 'b'].indexWhere(v => v == 'c')
2

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!