The Fauna service will be ending on May 30, 2025.

For more information on the service wind down, see our announcement and the Fauna Service End-of-Life FAQ.

IsObject

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.
Copied!
IsObject( value )

Description

The IsObject function returns true only if value is an Object, otherwise it returns false.

Parameters

Parameter Type Definition and Requirements

value

Any

Any value, which is to be tested to determine whether it is an Object or not.

Returns

Returns a Boolean, indicating whether value was an Object 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 IsObject with that value:

Copied!
Map(
  [
    ['array'],
    true,
    false,
    new Uint8Array([1, 2, 3, 4]),
    [0x1, 0x2, 0x3, 0x4],
    Collection('Letters'),
    Ref('credentials/self'),
    Database('child_db'),
    Date('2019-11-12'),
    Ref(Collection('Letters'), 123),
    10.1,
    Function('double'),
    Index('letters'),
    10,
    Ref(Keys(), '1'),
    Query(Lambda('x', Var('x'))),
    null,
    { x: 10 },
    Role('employees'),
    Match(Index('letters')),
    'ten',
    '10',
    Time('2020-07-06T12:34:56.789Z'),
    Ref(Tokens(), '1'),
  ],
  Lambda('x', {
    value: Var('x'),
    IsObject: IsObject(Var('x')),
  })
)
[
  { value: [ 'array' ], IsObject: false },
  { value: true, IsObject: false },
  { value: false, IsObject: false },
  { value: { '0': 1, '1': 2, '2': 3, '3': 4 }, IsObject: true },
  { value: [ 1, 2, 3, 4 ], IsObject: false },
  { value: Collection("Letters"), IsObject: false },
  { value: Ref(Credentials(), "302043979982045696"), IsObject: false },
  { value: Database("child_db"), IsObject: false },
  { value: Date("2019-11-12"), IsObject: false },
  { value: Ref(Collection("Letters"), "123"), IsObject: false },
  { value: 10.1, IsObject: false },
  { value: Function("double"), IsObject: false },
  { value: Index("letters"), IsObject: false },
  { value: 10, IsObject: false },
  { value: Ref(Keys(), "1"), IsObject: false },
  { value: Query(Lambda("x", Var("x"))), IsObject: false },
  { value: null, IsObject: false },
  { value: { x: 10 }, IsObject: true },
  { value: Role("employees"), IsObject: false },
  { value: Match(Index("letters")), IsObject: false },
  { value: 'ten', IsObject: false },
  { value: '10', IsObject: false },
  { value: Time("2020-07-06T12:34:56.789Z"), IsObject: false },
  { value: Ref(Tokens(), "1"), IsObject: false }
]
Query metrics:

  •    bytesIn:   600

  •   bytesOut: 1,583

  • computeOps:     2

  •    readOps:     0

  •   writeOps:     0

  •  readBytes:   373

  • writeBytes:     0

  •  queryTime:  27ms

  •    retries:     0

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 Login function (not shown here), so that Ref("credentials/self") returns a valid value.
\