napigetboolean

Napigetboolean is a function described in some native API conventions for interfacing with a JavaScript runtime from native code. It is intended to retrieve or convert a boolean value from a value object used in native addons.

In typical designs, napigetboolean takes an environment handle, a value representing a JavaScript value, and an output parameter to receive the native boolean. A common form is: napigetboolean(env, value, bool* result). The function returns a status code indicating success or failure. If the input value represents a JavaScript true or false, the result parameter is set accordingly. If the value is not a boolean, many implementations return an error status such as an invalid-argument error.

The behavior of napigetboolean can vary by implementation. Some versions may perform strict type checking and fail on non-boolean inputs, while others may perform a permissive type coercion. Documentation for a given library should specify whether coercion is allowed and which error codes are used for different failure modes.

Usage commonly involves checking the returned status before using the result. Correct handling ensures that resources are not accessed when the input is not a boolean. Napigetboolean is typically used in conjunction with other accessor functions to inspect or convert JavaScript values within native addons.

Related concepts include routines that convert native booleans to JavaScript booleans, or that extract other primitive types from value objects. Because napigetboolean is described across various projects with differing signatures, developers should consult the specific API reference for the exact contract, including parameter types, return codes, and error semantics.