`Collection.firstWhere()`

Get the first collection definition that matches a provided predicate.

Signature

Collection.firstWhere(pred: (CollectionDef => Boolean)) => CollectionDef | Null

Gets the first collection definition, represented as a Collection document, that matches a provided predicate function.

Collection documents are FQL versions of a database’s FSL collection schema. Collection documents have the CollectionDef type. See Collections.

If a database has staged schema, this method interacts with the database’s staged schema, not the active schema.

Parameter Type Required Description

Parameter	Type	Required	Description
pred	Predicate function	Yes	Anonymous predicate function that: Accepts a `Collection` document as its only argument. Supports shorthand-syntax. Returns a Boolean value. The method returns the first `Collection` document for which the predicate returns true.

pred

Yes

Accepts a Collection document as its only argument. Supports shorthand-syntax.
Returns a Boolean value.

The method returns the first Collection document for which the predicate returns true.

One of:

Type Description

Type	Description
CollectionDef	First `Collection` document that matches the predicate.
Null	No `Collection` document matches the predicate.

First Collection document that matches the predicate.

Null

No Collection document matches the predicate.

Collection.firstWhere(.name.includes('Prod'))

{
  name: "Product",
  coll: Collection,
  ts: Time("2099-04-10T14:13:05.740Z"),
  ...
}