IsCredentials
IsCredentials( value )
Description
The IsCredentials
function returns true
only if value
is a
credentials document, otherwise it
returns false
.
Parameters
Parameter | Type | Definition and Requirements |
---|---|---|
|
Any value, which is to be tested to determine whether it is a credentials document or not. |
Returns
Returns a Boolean, indicating whether value
was a
credentials document or not.
Examples
The following query uses Map
to iterate over an array of all of
the types of values that can be tested by a type-check function, passing
each item into a Lambda
function that returns an object, which
contains the value and the result of calling IsCredentials
with that
value:
[
{ value: [ 'array' ], IsCredentials: false },
{ value: true, IsCredentials: false },
{ value: false, IsCredentials: false },
{ value: { '0': 1, '1': 2, '2': 3, '3': 4 }, IsCredentials: false },
{ value: [ 1, 2, 3, 4 ], IsCredentials: false },
{ value: Collection("Letters"), IsCredentials: false },
{
value: Ref(Credentials(), "302043979982045696"),
IsCredentials: true
},
{ value: Database("child_db"), IsCredentials: false },
{ value: Date("2019-11-12"), IsCredentials: false },
{ value: Ref(Collection("Letters"), "123"), IsCredentials: false },
{ value: 10.1, IsCredentials: false },
{ value: Function("double"), IsCredentials: false },
{ value: Index("letters"), IsCredentials: false },
{ value: 10, IsCredentials: false },
{ value: Ref(Keys(), "1"), IsCredentials: false },
{ value: Query(Lambda("x", Var("x"))), IsCredentials: false },
{ value: null, IsCredentials: false },
{ value: { x: 10 }, IsCredentials: false },
{ value: Role("employees"), IsCredentials: false },
{ value: Match(Index("letters")), IsCredentials: false },
{ value: 'ten', IsCredentials: false },
{ value: '10', IsCredentials: false },
{ value: Time("2020-07-06T12:34:56.789Z"), IsCredentials: false },
{ value: Ref(Tokens(), "1"), IsCredentials: false }
]
This query operates on a pre-existing schema, which is not provided here. Also, the query is executed via a client connection, that uses a secret
acquired by calling the |
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!