Role.firstWhere()

Get the first matching accessible role.

Signature

Role.firstWhere(predicate: () => Boolean)): Role | NullRole

Role.firstWhere(predicate: (val: Role) => Boolean)): Role | NullRole

Description

Each role in a Fauna is represented by a Role document. This method returns a Role for the first accessible role that matches the predicate function. If no matching roles exist or are accessible, the method returns null.

The predicate function must return a Boolean.

Parameters

Parameter Type Required Description

predicate

Function

Yes

An anonymous function that compares values in each Role and returns true for matches or false for mismatches. If no document matches exist or are accessible, this method returns null.

predicate parameters:

Parameter Type Required Description

val

Role

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

Return value

One of:

Type Description

Role

The Role for the first accessible role matching the predicate function.

NullRole

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

Examples

Role.firstWhere(.name.includes("Team"))
{
  name: "mgmtTeam",
  coll: Role,
  ts: Time("2023-07-27T22:40:32.735Z"),
  privileges: [
    {
      resource: "CoffeeBean",
      actions: {
        read: true
      }
    },
    {
      resource: "Customers",
      actions: {
        create: true
      }
    }
  ],
  membership: [
    {
      resource: "People"
    }
  ],
  data: {
    custom: "some data"
  }
}

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!