IsCredentials
IsCredentials( value )Description
The IsCredentials function returns true only if value is a
credentials document, otherwise it returns false.
Parameters
| Argument | Type | Definition and Requirements |
|---|---|---|
|
Any |
Any value, which is to be tested to determine whether it is 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:
client.query(
q.Map(
[
['array'],
true,
false,
new Uint8Array([1, 2, 3, 4]),
[0x1, 0x2, 0x3, 0x4],
q.Collection('Letters'),
q.Ref('credentials/self'),
q.Database('child_db'),
q.Date('2019-11-12'),
q.Ref(q.Collection('Letters'), 123),
10.1,
q.Function('double'),
q.Index('all_letters'),
10,
q.Ref(q.Keys(), '248967241620521472'),
q.Query(q.Lambda('x', q.Var('x'))),
null,
{ x: 10 },
q.Role('employees'),
q.Match(q.Index('all_letters')),
'ten',
'10',
q.Now(),
q.Ref(q.Tokens(), '249062079147803136'),
],
q.Lambda('x', {
value: q.Var('x'),
IsCredentials: q.IsCredentials(q.Var('x')),
})
)
)
.then((ret) => console.log(ret))[ { value: [ 'array' ], IsCredentials: false },
{ value: true, IsCredentials: false },
{ value: false, IsCredentials: false },
{ value: Bytes("AQIDBA=="), IsCredentials: false },
{ value: [ 1, 2, 3, 4 ], IsCredentials: false },
{ value: Collection("Letters"), IsCredentials: false },
{ value: Ref(Credentials(), "248967019900174848"),
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("all_letters"), IsCredentials: false },
{ value: 10, IsCredentials: false },
{ value: Ref(Keys(), "248967241620521472"),
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("all_letters")), IsCredentials: false },
{ value: 'ten', IsCredentials: false },
{ value: '10', IsCredentials: false },
{ value: Time("2019-11-12T13:15:16.789Z"),
IsCredentials: false },
{ value: Ref(Tokens(), "249062079147803136"),
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
|
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!