duktape/website/api/duk_is_object.yaml

name: duk_is_object

proto: |
  duk_bool_t duk_is_object(duk_context *ctx, duk_idx_t idx);

stack: |
  [ ... val! ... ]

summary: |
  <p>Returns 1 if value at <code>idx</code> is an object, otherwise
  returns 0.  If <code>idx</code> is invalid, also returns 0.</p>

  <p>Note that many values are considered to be an object, e.g.:</p>

  <ul>
  <li>ECMAScript object</li>
  <li>ECMAScript array</li>
  <li>ECMAScript function</li>
  <li>Duktape thread (coroutine)</li>
  <li>Duktape internal objects</li>
  </ul>

  <p>Specific object types can be checked with separate API calls,
  e.g. <code><a href="#duk_is_array">duk_is_array()</a></code>.</p>

example: |
  if (duk_is_object(ctx, -3)) {
      /* ... */
  }

tags:
  - stack
  - object

introduced: 1.0.0