`role.exists()`

Signature

exists() => Boolean

Description

Tests if a UDF, represented as an Role document, exists.

Role documents are FQL versions of a database’s FSL role schema. See Roles.

Staged schema

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

`exists()` vs. null comparisons

You can use either exists() or a null comparison (== null or != null) to check the existence or validity of a value. For example:

Role.byName("manager").exists()  // true
Role.byName("manager") != null   // true

Key differences:

exists() returns an error if called on an unsupported value.
Null comparisons do not throw errors and work safely on any value.

For example:

// Declare an object. Objects don't support
// an `exists()` method.
let object = { a: "Foo", b: "Bar" }

object.exists()  // Returns `invalid_query` error

object != null   // Returns true

Parameters

None

Return value

Type Description

Type	Description
Boolean	If `true`, the `Role` document exists. If `false`, the `Role` document doesn’t exist.

Boolean

If true, the Role document exists. If false, the Role document doesn’t exist.

Examples

Role.byName("manager").exists()

true

role.exists()