`Key.firstWhere()`

Get the first matching accessible Key.

Signature

Key.firstWhere(predicate: () => Boolean)): Key | NullKey

Key.firstWhere(predicate: (val: Key) => Boolean)): Key | NullKey

Each key in a Fauna database is represented by a Key object. This method returns the first accessible key that matches the predicate function.

Parameter Type Required Description

Parameter	Type	Required	Description
predicate	Function		An anonymous function that compares values in each `Key` document and returns `true` for matches or `false` for mismatches.

predicate

An anonymous function that compares values in each Key document and returns true for matches or false for mismatches.

Parameter Type Required Description

Parameter	Type	Required	Description
val	Key		Key object to compare. If omitted, use dot notation to access `Key` properties.

val

Key object to compare. If omitted, use dot notation to access Key properties.

One of:

Type	Description
Key	First accessible key matching the predicate function.
NullKey	When no keys match the predicate function or all matching keys are inaccessible. See NullDoc.

Type

Description

First accessible key matching the predicate function.

NullKey

When no keys match the predicate function or all matching keys are inaccessible. See NullDoc.

Key.firstWhere(.role == "admin")

{
  id: "370714759876575266",
  coll: Key,
  ts: Time("2023-07-19T20:53:15.250Z"),
  data: {
    name: "coffee-admin"
  },
  role: "admin"
}

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!