Node.js  v8.x
Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine
node_api.h File Reference
#include <stddef.h>
#include <stdbool.h>
#include "node_api_types.h"
Include dependency graph for node_api.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  napi_module
 

Macros

#define NAPI_EXTERN   /* nothing */
 
#define NAPI_MODULE_EXPORT   __attribute__((visibility("default")))
 
#define NAPI_NO_RETURN
 
#define NAPI_MODULE_VERSION   1
 
#define NAPI_C_CTOR(fn)
 
#define EXTERN_C_START
 
#define EXTERN_C_END
 
#define NAPI_MODULE_X(modname, regfunc, priv, flags)
 
#define NAPI_MODULE(modname, regfunc)   NAPI_MODULE_X(modname, regfunc, NULL, 0)
 

Typedefs

typedef void(* napi_addon_register_func) (napi_env env, napi_value exports, napi_value module, void *priv)
 

Functions

EXTERN_C_START NAPI_EXTERN void napi_module_register (napi_module *mod)
 
NAPI_EXTERN napi_status napi_get_last_error_info (napi_env env, const napi_extended_error_info **result)
 
NAPI_EXTERN NAPI_NO_RETURN void napi_fatal_error (const char *location, const char *message)
 
NAPI_EXTERN napi_status napi_get_undefined (napi_env env, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_null (napi_env env, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_global (napi_env env, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_boolean (napi_env env, bool value, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_object (napi_env env, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_array (napi_env env, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_array_with_length (napi_env env, size_t length, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_double (napi_env env, double value, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_int32 (napi_env env, int32_t value, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_uint32 (napi_env env, uint32_t value, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_int64 (napi_env env, int64_t value, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_string_latin1 (napi_env env, const char *str, size_t length, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_string_utf8 (napi_env env, const char *str, size_t length, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_string_utf16 (napi_env env, const char16_t *str, size_t length, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_symbol (napi_env env, napi_value description, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_function (napi_env env, const char *utf8name, napi_callback cb, void *data, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_error (napi_env env, napi_value code, napi_value msg, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_type_error (napi_env env, napi_value code, napi_value msg, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_range_error (napi_env env, napi_value code, napi_value msg, napi_value *result)
 
NAPI_EXTERN napi_status napi_typeof (napi_env env, napi_value value, napi_valuetype *result)
 
NAPI_EXTERN napi_status napi_get_value_double (napi_env env, napi_value value, double *result)
 
NAPI_EXTERN napi_status napi_get_value_int32 (napi_env env, napi_value value, int32_t *result)
 
NAPI_EXTERN napi_status napi_get_value_uint32 (napi_env env, napi_value value, uint32_t *result)
 
NAPI_EXTERN napi_status napi_get_value_int64 (napi_env env, napi_value value, int64_t *result)
 
NAPI_EXTERN napi_status napi_get_value_bool (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_get_value_string_latin1 (napi_env env, napi_value value, char *buf, size_t bufsize, size_t *result)
 
NAPI_EXTERN napi_status napi_get_value_string_utf8 (napi_env env, napi_value value, char *buf, size_t bufsize, size_t *result)
 
NAPI_EXTERN napi_status napi_get_value_string_utf16 (napi_env env, napi_value value, char16_t *buf, size_t bufsize, size_t *result)
 
NAPI_EXTERN napi_status napi_coerce_to_bool (napi_env env, napi_value value, napi_value *result)
 
NAPI_EXTERN napi_status napi_coerce_to_number (napi_env env, napi_value value, napi_value *result)
 
NAPI_EXTERN napi_status napi_coerce_to_object (napi_env env, napi_value value, napi_value *result)
 
NAPI_EXTERN napi_status napi_coerce_to_string (napi_env env, napi_value value, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_prototype (napi_env env, napi_value object, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_property_names (napi_env env, napi_value object, napi_value *result)
 
NAPI_EXTERN napi_status napi_set_property (napi_env env, napi_value object, napi_value key, napi_value value)
 
NAPI_EXTERN napi_status napi_has_property (napi_env env, napi_value object, napi_value key, bool *result)
 
NAPI_EXTERN napi_status napi_get_property (napi_env env, napi_value object, napi_value key, napi_value *result)
 
NAPI_EXTERN napi_status napi_delete_property (napi_env env, napi_value object, napi_value key, bool *result)
 
NAPI_EXTERN napi_status napi_has_own_property (napi_env env, napi_value object, napi_value key, bool *result)
 
NAPI_EXTERN napi_status napi_set_named_property (napi_env env, napi_value object, const char *utf8name, napi_value value)
 
NAPI_EXTERN napi_status napi_has_named_property (napi_env env, napi_value object, const char *utf8name, bool *result)
 
NAPI_EXTERN napi_status napi_get_named_property (napi_env env, napi_value object, const char *utf8name, napi_value *result)
 
NAPI_EXTERN napi_status napi_set_element (napi_env env, napi_value object, uint32_t index, napi_value value)
 
NAPI_EXTERN napi_status napi_has_element (napi_env env, napi_value object, uint32_t index, bool *result)
 
NAPI_EXTERN napi_status napi_get_element (napi_env env, napi_value object, uint32_t index, napi_value *result)
 
NAPI_EXTERN napi_status napi_delete_element (napi_env env, napi_value object, uint32_t index, bool *result)
 
NAPI_EXTERN napi_status napi_define_properties (napi_env env, napi_value object, size_t property_count, const napi_property_descriptor *properties)
 
NAPI_EXTERN napi_status napi_is_array (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_get_array_length (napi_env env, napi_value value, uint32_t *result)
 
NAPI_EXTERN napi_status napi_strict_equals (napi_env env, napi_value lhs, napi_value rhs, bool *result)
 
NAPI_EXTERN napi_status napi_call_function (napi_env env, napi_value recv, napi_value func, size_t argc, const napi_value *argv, napi_value *result)
 
NAPI_EXTERN napi_status napi_new_instance (napi_env env, napi_value constructor, size_t argc, const napi_value *argv, napi_value *result)
 
NAPI_EXTERN napi_status napi_instanceof (napi_env env, napi_value object, napi_value constructor, bool *result)
 
NAPI_EXTERN napi_status napi_make_callback (napi_env env, napi_value recv, napi_value func, size_t argc, const napi_value *argv, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_cb_info (napi_env env, napi_callback_info cbinfo, size_t *argc, napi_value *argv, napi_value *this_arg, void **data)
 
NAPI_EXTERN napi_status napi_is_construct_call (napi_env env, napi_callback_info cbinfo, bool *result)
 
NAPI_EXTERN napi_status napi_define_class (napi_env env, const char *utf8name, napi_callback constructor, void *data, size_t property_count, const napi_property_descriptor *properties, napi_value *result)
 
NAPI_EXTERN napi_status napi_wrap (napi_env env, napi_value js_object, void *native_object, napi_finalize finalize_cb, void *finalize_hint, napi_ref *result)
 
NAPI_EXTERN napi_status napi_unwrap (napi_env env, napi_value js_object, void **result)
 
NAPI_EXTERN napi_status napi_remove_wrap (napi_env env, napi_value js_object, void **result)
 
NAPI_EXTERN napi_status napi_create_external (napi_env env, void *data, napi_finalize finalize_cb, void *finalize_hint, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_value_external (napi_env env, napi_value value, void **result)
 
NAPI_EXTERN napi_status napi_create_reference (napi_env env, napi_value value, uint32_t initial_refcount, napi_ref *result)
 
NAPI_EXTERN napi_status napi_delete_reference (napi_env env, napi_ref ref)
 
NAPI_EXTERN napi_status napi_reference_ref (napi_env env, napi_ref ref, uint32_t *result)
 
NAPI_EXTERN napi_status napi_reference_unref (napi_env env, napi_ref ref, uint32_t *result)
 
NAPI_EXTERN napi_status napi_get_reference_value (napi_env env, napi_ref ref, napi_value *result)
 
NAPI_EXTERN napi_status napi_open_handle_scope (napi_env env, napi_handle_scope *result)
 
NAPI_EXTERN napi_status napi_close_handle_scope (napi_env env, napi_handle_scope scope)
 
NAPI_EXTERN napi_status napi_open_escapable_handle_scope (napi_env env, napi_escapable_handle_scope *result)
 
NAPI_EXTERN napi_status napi_close_escapable_handle_scope (napi_env env, napi_escapable_handle_scope scope)
 
NAPI_EXTERN napi_status napi_escape_handle (napi_env env, napi_escapable_handle_scope scope, napi_value escapee, napi_value *result)
 
NAPI_EXTERN napi_status napi_throw (napi_env env, napi_value error)
 
NAPI_EXTERN napi_status napi_throw_error (napi_env env, const char *code, const char *msg)
 
NAPI_EXTERN napi_status napi_throw_type_error (napi_env env, const char *code, const char *msg)
 
NAPI_EXTERN napi_status napi_throw_range_error (napi_env env, const char *code, const char *msg)
 
NAPI_EXTERN napi_status napi_is_error (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_is_exception_pending (napi_env env, bool *result)
 
NAPI_EXTERN napi_status napi_get_and_clear_last_exception (napi_env env, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_buffer (napi_env env, size_t length, void **data, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_external_buffer (napi_env env, size_t length, void *data, napi_finalize finalize_cb, void *finalize_hint, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_buffer_copy (napi_env env, size_t length, const void *data, void **result_data, napi_value *result)
 
NAPI_EXTERN napi_status napi_is_buffer (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_get_buffer_info (napi_env env, napi_value value, void **data, size_t *length)
 
NAPI_EXTERN napi_status napi_is_arraybuffer (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_create_arraybuffer (napi_env env, size_t byte_length, void **data, napi_value *result)
 
NAPI_EXTERN napi_status napi_create_external_arraybuffer (napi_env env, void *external_data, size_t byte_length, napi_finalize finalize_cb, void *finalize_hint, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_arraybuffer_info (napi_env env, napi_value arraybuffer, void **data, size_t *byte_length)
 
NAPI_EXTERN napi_status napi_is_typedarray (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_create_typedarray (napi_env env, napi_typedarray_type type, size_t length, napi_value arraybuffer, size_t byte_offset, napi_value *result)
 
NAPI_EXTERN napi_status napi_get_typedarray_info (napi_env env, napi_value typedarray, napi_typedarray_type *type, size_t *length, void **data, napi_value *arraybuffer, size_t *byte_offset)
 
NAPI_EXTERN napi_status napi_create_dataview (napi_env env, size_t length, napi_value arraybuffer, size_t byte_offset, napi_value *result)
 
NAPI_EXTERN napi_status napi_is_dataview (napi_env env, napi_value value, bool *result)
 
NAPI_EXTERN napi_status napi_get_dataview_info (napi_env env, napi_value dataview, size_t *bytelength, void **data, napi_value *arraybuffer, size_t *byte_offset)
 
NAPI_EXTERN napi_status napi_create_async_work (napi_env env, napi_async_execute_callback execute, napi_async_complete_callback complete, void *data, napi_async_work *result)
 
NAPI_EXTERN napi_status napi_delete_async_work (napi_env env, napi_async_work work)
 
NAPI_EXTERN napi_status napi_queue_async_work (napi_env env, napi_async_work work)
 
NAPI_EXTERN napi_status napi_cancel_async_work (napi_env env, napi_async_work work)
 
NAPI_EXTERN napi_status napi_get_version (napi_env env, uint32_t *result)
 
NAPI_EXTERN napi_status napi_get_node_version (napi_env env, const napi_node_version **version)
 
NAPI_EXTERN napi_status napi_create_promise (napi_env env, napi_deferred *deferred, napi_value *promise)
 
NAPI_EXTERN napi_status napi_resolve_deferred (napi_env env, napi_deferred deferred, napi_value resolution)
 
NAPI_EXTERN napi_status napi_reject_deferred (napi_env env, napi_deferred deferred, napi_value rejection)
 
NAPI_EXTERN napi_status napi_is_promise (napi_env env, napi_value promise, bool *is_promise)
 
NAPI_EXTERN napi_status napi_adjust_external_memory (napi_env env, int64_t change_in_bytes, int64_t *adjusted_value)
 
NAPI_EXTERN napi_status napi_run_script (napi_env env, napi_value script, napi_value *result)
 

Macro Definition Documentation

◆ EXTERN_C_END

#define EXTERN_C_END

Definition at line 82 of file node_api.h.

◆ EXTERN_C_START

#define EXTERN_C_START

Definition at line 81 of file node_api.h.

◆ NAPI_C_CTOR

#define NAPI_C_CTOR (   fn)
Value:
static void fn(void) __attribute__((constructor)); \
static void fn(void)

Definition at line 72 of file node_api.h.

◆ NAPI_EXTERN

#define NAPI_EXTERN   /* nothing */

Definition at line 31 of file node_api.h.

◆ NAPI_MODULE

#define NAPI_MODULE (   modname,
  regfunc 
)    NAPI_MODULE_X(modname, regfunc, NULL, 0)

Definition at line 102 of file node_api.h.

◆ NAPI_MODULE_EXPORT

#define NAPI_MODULE_EXPORT   __attribute__((visibility("default")))

Definition at line 37 of file node_api.h.

◆ NAPI_MODULE_VERSION

#define NAPI_MODULE_VERSION   1

Definition at line 62 of file node_api.h.

◆ NAPI_MODULE_X

#define NAPI_MODULE_X (   modname,
  regfunc,
  priv,
  flags 
)
Value:
EXTERN_C_START \
static napi_module _module = \
{ \
NAPI_MODULE_VERSION, \
flags, \
__FILE__, \
regfunc, \
#modname, \
priv, \
{0}, \
}; \
NAPI_C_CTOR(_register_ ## modname) { \
napi_module_register(&_module); \
} \
EXTERN_C_END

Definition at line 85 of file node_api.h.

◆ NAPI_NO_RETURN

#define NAPI_NO_RETURN

Definition at line 43 of file node_api.h.

Typedef Documentation

◆ napi_addon_register_func

typedef void(* napi_addon_register_func) (napi_env env, napi_value exports, napi_value module, void *priv)

Definition at line 47 of file node_api.h.

Function Documentation

◆ napi_adjust_external_memory()

NAPI_EXTERN napi_status napi_adjust_external_memory ( napi_env  env,
int64_t  change_in_bytes,
int64_t *  adjusted_value 
)

Definition at line 3216 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_call_function()

NAPI_EXTERN napi_status napi_call_function ( napi_env  env,
napi_value  recv,
napi_value  func,
size_t  argc,
const napi_value argv,
napi_value result 
)

Definition at line 1892 of file node_api.cc.

References CHECK_ARG, CHECK_TO_FUNCTION, napi_env__::isolate, and NAPI_PREAMBLE.

◆ napi_cancel_async_work()

NAPI_EXTERN napi_status napi_cancel_async_work ( napi_env  env,
napi_async_work  work 
)

Definition at line 3373 of file node_api.cc.

References CALL_UV, CHECK_ARG, CHECK_ENV, and Work::Request().

◆ napi_close_escapable_handle_scope()

NAPI_EXTERN napi_status napi_close_escapable_handle_scope ( napi_env  env,
napi_escapable_handle_scope  scope 
)

Definition at line 2579 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_close_handle_scope()

NAPI_EXTERN napi_status napi_close_handle_scope ( napi_env  env,
napi_handle_scope  scope 
)

Definition at line 2556 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_coerce_to_bool()

NAPI_EXTERN napi_status napi_coerce_to_bool ( napi_env  env,
napi_value  value,
napi_value result 
)

◆ napi_coerce_to_number()

NAPI_EXTERN napi_status napi_coerce_to_number ( napi_env  env,
napi_value  value,
napi_value result 
)

◆ napi_coerce_to_object()

NAPI_EXTERN napi_status napi_coerce_to_object ( napi_env  env,
napi_value  value,
napi_value result 
)

◆ napi_coerce_to_string()

NAPI_EXTERN napi_status napi_coerce_to_string ( napi_env  env,
napi_value  value,
napi_value result 
)

◆ napi_create_array()

NAPI_EXTERN napi_status napi_create_array ( napi_env  env,
napi_value result 
)

Definition at line 1510 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_env__::isolate, and node::Buffer::New().

◆ napi_create_array_with_length()

NAPI_EXTERN napi_status napi_create_array_with_length ( napi_env  env,
size_t  length,
napi_value result 
)

Definition at line 1520 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_env__::isolate, and node::Buffer::New().

◆ napi_create_arraybuffer()

NAPI_EXTERN napi_status napi_create_arraybuffer ( napi_env  env,
size_t  byte_length,
void **  data,
napi_value result 
)

◆ napi_create_async_work()

NAPI_EXTERN napi_status napi_create_async_work ( napi_env  env,
napi_async_execute_callback  execute,
napi_async_complete_callback  complete,
void *  data,
napi_async_work result 
)

Definition at line 3328 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and Work::New().

◆ napi_create_buffer()

NAPI_EXTERN napi_status napi_create_buffer ( napi_env  env,
size_t  length,
void **  data,
napi_value result 
)

◆ napi_create_buffer_copy()

NAPI_EXTERN napi_status napi_create_buffer_copy ( napi_env  env,
size_t  length,
const void *  data,
void **  result_data,
napi_value result 
)

◆ napi_create_dataview()

NAPI_EXTERN napi_status napi_create_dataview ( napi_env  env,
size_t  length,
napi_value  arraybuffer,
size_t  byte_offset,
napi_value result 
)

◆ napi_create_double()

NAPI_EXTERN napi_status napi_create_double ( napi_env  env,
double  value,
napi_value result 
)

Definition at line 1584 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_env__::isolate, and node::Buffer::New().

◆ napi_create_error()

NAPI_EXTERN napi_status napi_create_error ( napi_env  env,
napi_value  code,
napi_value  msg,
napi_value result 
)

Definition at line 1721 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_string_expected, RETURN_STATUS_IF_FALSE, and status.

◆ napi_create_external()

NAPI_EXTERN napi_status napi_create_external ( napi_env  env,
void *  data,
napi_finalize  finalize_cb,
void *  finalize_hint,
napi_value result 
)

Definition at line 2407 of file node_api.cc.

References CHECK_ARG, napi_env__::isolate, NAPI_PREAMBLE, and node::Buffer::New().

◆ napi_create_external_arraybuffer()

NAPI_EXTERN napi_status napi_create_external_arraybuffer ( napi_env  env,
void *  external_data,
size_t  byte_length,
napi_finalize  finalize_cb,
void *  finalize_hint,
napi_value result 
)

◆ napi_create_external_buffer()

NAPI_EXTERN napi_status napi_create_external_buffer ( napi_env  env,
size_t  length,
void *  data,
napi_finalize  finalize_cb,
void *  finalize_hint,
napi_value result 
)

◆ napi_create_function()

NAPI_EXTERN napi_status napi_create_function ( napi_env  env,
const char *  utf8name,
napi_callback  cb,
void *  data,
napi_value result 
)

◆ napi_create_int32()

NAPI_EXTERN napi_status napi_create_int32 ( napi_env  env,
int32_t  value,
napi_value result 
)

Definition at line 1596 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_env__::isolate, and node::Buffer::New().

◆ napi_create_int64()

NAPI_EXTERN napi_status napi_create_int64 ( napi_env  env,
int64_t  value,
napi_value result 
)

Definition at line 1620 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_env__::isolate, and node::Buffer::New().

◆ napi_create_object()

NAPI_EXTERN napi_status napi_create_object ( napi_env  env,
napi_value result 
)

Definition at line 1500 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_env__::isolate, and node::Buffer::New().

◆ napi_create_promise()

NAPI_EXTERN napi_status napi_create_promise ( napi_env  env,
napi_deferred deferred,
napi_value promise 
)

◆ napi_create_range_error()

NAPI_EXTERN napi_status napi_create_range_error ( napi_env  env,
napi_value  code,
napi_value  msg,
napi_value result 
)

Definition at line 1763 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_string_expected, RETURN_STATUS_IF_FALSE, and status.

◆ napi_create_reference()

NAPI_EXTERN napi_status napi_create_reference ( napi_env  env,
napi_value  value,
uint32_t  initial_refcount,
napi_ref result 
)

Definition at line 2451 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and node::Buffer::New().

◆ napi_create_string_latin1()

NAPI_EXTERN napi_status napi_create_string_latin1 ( napi_env  env,
const char *  str,
size_t  length,
napi_value result 
)

◆ napi_create_string_utf16()

NAPI_EXTERN napi_status napi_create_string_utf16 ( napi_env  env,
const char16_t str,
size_t  length,
napi_value result 
)

◆ napi_create_string_utf8()

NAPI_EXTERN napi_status napi_create_string_utf8 ( napi_env  env,
const char *  str,
size_t  length,
napi_value result 
)

Definition at line 1551 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, CHECK_NEW_FROM_UTF8_LEN, and s.

◆ napi_create_symbol()

NAPI_EXTERN napi_status napi_create_symbol ( napi_env  env,
napi_value  description,
napi_value result 
)

◆ napi_create_type_error()

NAPI_EXTERN napi_status napi_create_type_error ( napi_env  env,
napi_value  code,
napi_value  msg,
napi_value result 
)

Definition at line 1742 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_string_expected, RETURN_STATUS_IF_FALSE, and status.

◆ napi_create_typedarray()

◆ napi_create_uint32()

NAPI_EXTERN napi_status napi_create_uint32 ( napi_env  env,
uint32_t  value,
napi_value result 
)

Definition at line 1608 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_define_class()

NAPI_EXTERN napi_status napi_define_class ( napi_env  env,
const char *  utf8name,
napi_callback  constructor,
void *  data,
size_t  property_count,
const napi_property_descriptor properties,
napi_value result 
)

◆ napi_define_properties()

NAPI_EXTERN napi_status napi_define_properties ( napi_env  env,
napi_value  object,
size_t  property_count,
const napi_property_descriptor properties 
)

Definition at line 1362 of file node_api.cc.

References CHECK_ARG, CHECK_TO_OBJECT, napi_env__::isolate, napi_ok, NAPI_PREAMBLE, p, and status.

◆ napi_delete_async_work()

NAPI_EXTERN napi_status napi_delete_async_work ( napi_env  env,
napi_async_work  work 
)

Definition at line 3344 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and Work::Delete().

◆ napi_delete_element()

NAPI_EXTERN napi_status napi_delete_element ( napi_env  env,
napi_value  object,
uint32_t  index,
bool *  result 
)

◆ napi_delete_property()

NAPI_EXTERN napi_status napi_delete_property ( napi_env  env,
napi_value  object,
napi_value  key,
bool *  result 
)

◆ napi_delete_reference()

NAPI_EXTERN napi_status napi_delete_reference ( napi_env  env,
napi_ref  ref 
)

Definition at line 2470 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_escape_handle()

NAPI_EXTERN napi_status napi_escape_handle ( napi_env  env,
napi_escapable_handle_scope  scope,
napi_value  escapee,
napi_value result 
)

Definition at line 2591 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and s.

◆ napi_fatal_error()

NAPI_EXTERN NAPI_NO_RETURN void napi_fatal_error ( const char *  location,
const char *  message 
)

Definition at line 927 of file node_api.cc.

References node::FatalError().

◆ napi_get_and_clear_last_exception()

NAPI_EXTERN napi_status napi_get_and_clear_last_exception ( napi_env  env,
napi_value result 
)

◆ napi_get_array_length()

NAPI_EXTERN napi_status napi_get_array_length ( napi_env  env,
napi_value  value,
uint32_t *  result 
)

◆ napi_get_arraybuffer_info()

NAPI_EXTERN napi_status napi_get_arraybuffer_info ( napi_env  env,
napi_value  arraybuffer,
void **  data,
size_t *  byte_length 
)

Definition at line 2984 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_invalid_arg, and RETURN_STATUS_IF_FALSE.

◆ napi_get_boolean()

NAPI_EXTERN napi_status napi_get_boolean ( napi_env  env,
bool  value,
napi_value result 
)

Definition at line 1632 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_get_buffer_info()

NAPI_EXTERN napi_status napi_get_buffer_info ( napi_env  env,
napi_value  value,
void **  data,
size_t *  length 
)

Definition at line 2904 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, node::Buffer::Data(), and node::Buffer::Length().

◆ napi_get_cb_info()

NAPI_EXTERN napi_status napi_get_cb_info ( napi_env  env,
napi_callback_info  cbinfo,
size_t *  argc,
napi_value argv,
napi_value this_arg,
void **  data 
)

Definition at line 1846 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_get_dataview_info()

NAPI_EXTERN napi_status napi_get_dataview_info ( napi_env  env,
napi_value  dataview,
size_t *  bytelength,
void **  data,
napi_value arraybuffer,
size_t *  byte_offset 
)

Definition at line 3160 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_invalid_arg, and RETURN_STATUS_IF_FALSE.

◆ napi_get_element()

NAPI_EXTERN napi_status napi_get_element ( napi_env  env,
napi_value  object,
uint32_t  index,
napi_value result 
)

◆ napi_get_global()

NAPI_EXTERN napi_status napi_get_global ( napi_env  env,
napi_value result 
)

Definition at line 1926 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_get_last_error_info()

◆ napi_get_named_property()

NAPI_EXTERN napi_status napi_get_named_property ( napi_env  env,
napi_value  object,
const char *  utf8name,
napi_value result 
)

◆ napi_get_node_version()

NAPI_EXTERN napi_status napi_get_node_version ( napi_env  env,
const napi_node_version **  version 
)

◆ napi_get_null()

NAPI_EXTERN napi_status napi_get_null ( napi_env  env,
napi_value result 
)

Definition at line 1835 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_get_property()

NAPI_EXTERN napi_status napi_get_property ( napi_env  env,
napi_value  object,
napi_value  key,
napi_value result 
)

◆ napi_get_property_names()

NAPI_EXTERN napi_status napi_get_property_names ( napi_env  env,
napi_value  object,
napi_value result 
)

◆ napi_get_prototype()

NAPI_EXTERN napi_status napi_get_prototype ( napi_env  env,
napi_value  object,
napi_value result 
)

◆ napi_get_reference_value()

NAPI_EXTERN napi_status napi_get_reference_value ( napi_env  env,
napi_ref  ref,
napi_value result 
)

Definition at line 2530 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_get_typedarray_info()

NAPI_EXTERN napi_status napi_get_typedarray_info ( napi_env  env,
napi_value  typedarray,
napi_typedarray_type type,
size_t *  length,
void **  data,
napi_value arraybuffer,
size_t *  byte_offset 
)

◆ napi_get_undefined()

NAPI_EXTERN napi_status napi_get_undefined ( napi_env  env,
napi_value result 
)

Definition at line 1825 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

Referenced by napi_get_and_clear_last_exception().

◆ napi_get_value_bool()

NAPI_EXTERN napi_status napi_get_value_bool ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 2120 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_boolean_expected, and RETURN_STATUS_IF_FALSE.

◆ napi_get_value_double()

NAPI_EXTERN napi_status napi_get_value_double ( napi_env  env,
napi_value  value,
double *  result 
)

Definition at line 2022 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_number_expected, and RETURN_STATUS_IF_FALSE.

◆ napi_get_value_external()

NAPI_EXTERN napi_status napi_get_value_external ( napi_env  env,
napi_value  value,
void **  result 
)

Definition at line 2434 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_invalid_arg, and RETURN_STATUS_IF_FALSE.

◆ napi_get_value_int32()

NAPI_EXTERN napi_status napi_get_value_int32 ( napi_env  env,
napi_value  value,
int32_t *  result 
)

Definition at line 2039 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_number_expected, and RETURN_STATUS_IF_FALSE.

◆ napi_get_value_int64()

NAPI_EXTERN napi_status napi_get_value_int64 ( napi_env  env,
napi_value  value,
int64_t *  result 
)

Definition at line 2087 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_get_value_string_latin1()

NAPI_EXTERN napi_status napi_get_value_string_latin1 ( napi_env  env,
napi_value  value,
char *  buf,
size_t  bufsize,
size_t *  result 
)

◆ napi_get_value_string_utf16()

NAPI_EXTERN napi_status napi_get_value_string_utf16 ( napi_env  env,
napi_value  value,
char16_t buf,
size_t  bufsize,
size_t *  result 
)

◆ napi_get_value_string_utf8()

NAPI_EXTERN napi_status napi_get_value_string_utf8 ( napi_env  env,
napi_value  value,
char *  buf,
size_t  bufsize,
size_t *  result 
)

Definition at line 2179 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_string_expected, and RETURN_STATUS_IF_FALSE.

◆ napi_get_value_uint32()

NAPI_EXTERN napi_status napi_get_value_uint32 ( napi_env  env,
napi_value  value,
uint32_t *  result 
)

Definition at line 2063 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, napi_number_expected, and RETURN_STATUS_IF_FALSE.

◆ napi_get_version()

NAPI_EXTERN napi_status napi_get_version ( napi_env  env,
uint32_t *  result 
)

Definition at line 3195 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and NAPI_VERSION.

◆ napi_has_element()

NAPI_EXTERN napi_status napi_has_element ( napi_env  env,
napi_value  object,
uint32_t  index,
bool *  result 
)

◆ napi_has_named_property()

NAPI_EXTERN napi_status napi_has_named_property ( napi_env  env,
napi_value  object,
const char *  utf8name,
bool *  result 
)

◆ napi_has_own_property()

◆ napi_has_property()

NAPI_EXTERN napi_status napi_has_property ( napi_env  env,
napi_value  object,
napi_value  key,
bool *  result 
)

◆ napi_instanceof()

NAPI_EXTERN napi_status napi_instanceof ( napi_env  env,
napi_value  object,
napi_value  constructor,
bool *  result 
)

◆ napi_is_array()

NAPI_EXTERN napi_status napi_is_array ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 1440 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_is_arraybuffer()

NAPI_EXTERN napi_status napi_is_arraybuffer ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 2923 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_is_buffer()

NAPI_EXTERN napi_status napi_is_buffer ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 2895 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and node::Buffer::HasInstance().

◆ napi_is_construct_call()

NAPI_EXTERN napi_status napi_is_construct_call ( napi_env  env,
napi_callback_info  cbinfo,
bool *  result 
)

Definition at line 1877 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_is_dataview()

NAPI_EXTERN napi_status napi_is_dataview ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 3149 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_is_error()

NAPI_EXTERN napi_status napi_is_error ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 2009 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_is_exception_pending()

NAPI_EXTERN napi_status napi_is_exception_pending ( napi_env  env,
bool *  result 
)

Definition at line 2791 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::last_exception.

◆ napi_is_promise()

NAPI_EXTERN napi_status napi_is_promise ( napi_env  env,
napi_value  promise,
bool *  is_promise 
)

Definition at line 3415 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_is_typedarray()

NAPI_EXTERN napi_status napi_is_typedarray ( napi_env  env,
napi_value  value,
bool *  result 
)

Definition at line 3008 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_make_callback()

NAPI_EXTERN napi_status napi_make_callback ( napi_env  env,
napi_value  recv,
napi_value  func,
size_t  argc,
const napi_value argv,
napi_value result 
)

◆ napi_module_register()

◆ napi_new_instance()

NAPI_EXTERN napi_status napi_new_instance ( napi_env  env,
napi_value  constructor,
size_t  argc,
const napi_value argv,
napi_value result 
)

◆ napi_open_escapable_handle_scope()

NAPI_EXTERN napi_status napi_open_escapable_handle_scope ( napi_env  env,
napi_escapable_handle_scope result 
)

Definition at line 2566 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_open_handle_scope()

NAPI_EXTERN napi_status napi_open_handle_scope ( napi_env  env,
napi_handle_scope result 
)

Definition at line 2545 of file node_api.cc.

References CHECK_ARG, CHECK_ENV, and napi_env__::isolate.

◆ napi_queue_async_work()

NAPI_EXTERN napi_status napi_queue_async_work ( napi_env  env,
napi_async_work  work 
)

◆ napi_reference_ref()

NAPI_EXTERN napi_status napi_reference_ref ( napi_env  env,
napi_ref  ref,
uint32_t *  result 
)

Definition at line 2486 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_reference_unref()

NAPI_EXTERN napi_status napi_reference_unref ( napi_env  env,
napi_ref  ref,
uint32_t *  result 
)

Definition at line 2506 of file node_api.cc.

References CHECK_ARG, and CHECK_ENV.

◆ napi_reject_deferred()

NAPI_EXTERN napi_status napi_reject_deferred ( napi_env  env,
napi_deferred  deferred,
napi_value  rejection 
)

Definition at line 3409 of file node_api.cc.

◆ napi_remove_wrap()

NAPI_EXTERN napi_status napi_remove_wrap ( napi_env  env,
napi_value  js_object,
void **  result 
)

Definition at line 2380 of file node_api.cc.

References napi_ok, NAPI_PREAMBLE, and status.

◆ napi_resolve_deferred()

NAPI_EXTERN napi_status napi_resolve_deferred ( napi_env  env,
napi_deferred  deferred,
napi_value  resolution 
)

Definition at line 3403 of file node_api.cc.

◆ napi_run_script()

NAPI_EXTERN napi_status napi_run_script ( napi_env  env,
napi_value  script,
napi_value result 
)

Definition at line 3427 of file node_api.cc.

References CHECK_ARG, and NAPI_PREAMBLE.

◆ napi_set_element()

NAPI_EXTERN napi_status napi_set_element ( napi_env  env,
napi_value  object,
uint32_t  index,
napi_value  value 
)

◆ napi_set_named_property()

NAPI_EXTERN napi_status napi_set_named_property ( napi_env  env,
napi_value  object,
const char *  utf8name,
napi_value  value 
)

◆ napi_set_property()

◆ napi_strict_equals()

NAPI_EXTERN napi_status napi_strict_equals ( napi_env  env,
napi_value  lhs,
napi_value  rhs,
bool *  result 
)

Definition at line 1467 of file node_api.cc.

References a, CHECK_ARG, GET_RETURN_STATUS, and NAPI_PREAMBLE.

◆ napi_throw()

NAPI_EXTERN napi_status napi_throw ( napi_env  env,
napi_value  error 
)

Definition at line 1940 of file node_api.cc.

References CHECK_ARG, napi_env__::isolate, and NAPI_PREAMBLE.

◆ napi_throw_error()

NAPI_EXTERN napi_status napi_throw_error ( napi_env  env,
const char *  code,
const char *  msg 
)

Definition at line 1952 of file node_api.cc.

References CHECK_NEW_FROM_UTF8, napi_env__::isolate, NAPI_PREAMBLE, and status.

◆ napi_throw_range_error()

NAPI_EXTERN napi_status napi_throw_range_error ( napi_env  env,
const char *  code,
const char *  msg 
)

Definition at line 1990 of file node_api.cc.

References CHECK_NEW_FROM_UTF8, napi_env__::isolate, NAPI_PREAMBLE, and status.

◆ napi_throw_type_error()

NAPI_EXTERN napi_status napi_throw_type_error ( napi_env  env,
const char *  code,
const char *  msg 
)

Definition at line 1971 of file node_api.cc.

References CHECK_NEW_FROM_UTF8, napi_env__::isolate, NAPI_PREAMBLE, and status.

Referenced by napi_instanceof().

◆ napi_typeof()

◆ napi_unwrap()

NAPI_EXTERN napi_status napi_unwrap ( napi_env  env,
napi_value  js_object,
void **  result 
)

Definition at line 2372 of file node_api.cc.

References CHECK_ENV.

◆ napi_wrap()

NAPI_EXTERN napi_status napi_wrap ( napi_env  env,
napi_value  js_object,
void *  native_object,
napi_finalize  finalize_cb,
void *  finalize_hint,
napi_ref result 
)