`Token.where()`

Get a Set of tokens that match a provided predicate.

Signature

Token.where(pred: (Token => Boolean)) => Set<Token>

Description

Gets a Set of tokens, represented as Token documents, that match a provided predicate function.

A token is a type of authentication secret used to provide identity-based access to a Fauna database. Fauna stores tokens as documents in the Token system collection.

If Token.where() is the last expression in a query, the first page of the Set is returned. See Pagination.

Parameters

Parameter Type Required Description

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

pred

Predicate function

Yes

Anonymous predicate function that:

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

The method returns a Set of Token documents for which the predicate returns true.

Return value

Type Description

Type	Description
Set<Token>	Set of `Token` documents that match the predicate. If there are no matching documents, the Set is empty.

Set<Token>

Set of Token documents that match the predicate. If there are no matching documents, the Set is empty.

Examples

Token.where(.document.id == "111")

{
  data: [
    {
      id: "401670938431586381",
      coll: Token,
      ts: Time("2099-08-14T23:54:00.750Z"),
      document: Customer("111")
    },
    ...
  ]
}