Expand description
Low level bindings to nodejs’ N-API
§Features
Different API versions may be selected via feature-flag. See the N-API Version Matrix for details.
napi_v5
supported by all actively maintained NodeJS releasesnapi_v6
supported by all actively maintained NodeJS releasesnapi_v7
supported by all actively maintained NodeJS releasesnapi_v8
requires at least15.12.0
, this is the default (if no flag is given)- the experimental N-API features may be enabled via feature flag
experimental
(off by default)
Structs§
- napi_
async_ cleanup_ hook_ handle__ - napi_
async_ context__ - napi_
async_ work__ - napi_
callback_ info__ - napi_
callback_ scope__ - napi_
deferred__ - napi_
env__ - napi_
escapable_ handle_ scope__ - napi_
extended_ error_ info - napi_
handle_ scope__ - napi_
key_ filter - napi_
module - napi_
node_ version - napi_
property_ attributes - napi_
property_ descriptor - napi_
ref__ - napi_
threadsafe_ function__ - napi_
type_ tag - napi_
value__ - uv_
loop_ s
Enums§
- napi_
key_ collection_ mode - napi_
key_ conversion - napi_
status - napi_
threadsafe_ function_ call_ mode - napi_
threadsafe_ function_ release_ mode - napi_
typedarray_ type - napi_
valuetype
Functions§
- napi_
acquire_ ⚠threadsafe_ function - napi_
add_ ⚠async_ cleanup_ hook - napi_
add_ ⚠env_ cleanup_ hook - napi_
add_ ⚠finalizer - napi_
adjust_ ⚠external_ memory - napi_
async_ ⚠destroy - napi_
async_ ⚠init - napi_
call_ ⚠function - napi_
call_ ⚠threadsafe_ function - napi_
cancel_ ⚠async_ work - napi_
check_ ⚠object_ type_ tag - napi_
close_ ⚠callback_ scope - napi_
close_ ⚠escapable_ handle_ scope - napi_
close_ ⚠handle_ scope - napi_
coerce_ ⚠to_ bool - napi_
coerce_ ⚠to_ number - napi_
coerce_ ⚠to_ object - napi_
coerce_ ⚠to_ string - napi_
create_ ⚠array - napi_
create_ ⚠array_ with_ length - napi_
create_ ⚠arraybuffer - napi_
create_ ⚠async_ work - napi_
create_ ⚠bigint_ int64 - napi_
create_ ⚠bigint_ uint64 - napi_
create_ ⚠bigint_ words - napi_
create_ ⚠buffer - napi_
create_ ⚠buffer_ copy - napi_
create_ ⚠dataview - napi_
create_ ⚠date - napi_
create_ ⚠double - napi_
create_ ⚠error - napi_
create_ ⚠external - napi_
create_ ⚠external_ arraybuffer - napi_
create_ ⚠external_ buffer - napi_
create_ ⚠function - napi_
create_ ⚠int32 - napi_
create_ ⚠int64 - napi_
create_ ⚠object - napi_
create_ ⚠promise - napi_
create_ ⚠range_ error - napi_
create_ ⚠reference - napi_
create_ ⚠string_ latin1 - napi_
create_ ⚠string_ utf8 - napi_
create_ ⚠string_ utf16 - napi_
create_ ⚠symbol - napi_
create_ ⚠threadsafe_ function - napi_
create_ ⚠type_ error - napi_
create_ ⚠typedarray - napi_
create_ ⚠uint32 - napi_
define_ ⚠class - napi_
define_ ⚠properties - napi_
delete_ ⚠async_ work - napi_
delete_ ⚠element - napi_
delete_ ⚠property - napi_
delete_ ⚠reference - napi_
detach_ ⚠arraybuffer - napi_
escape_ ⚠handle - napi_
fatal_ ⚠error - napi_
fatal_ ⚠exception - napi_
get_ ⚠all_ property_ names - napi_
get_ ⚠and_ clear_ last_ exception - napi_
get_ ⚠array_ length - napi_
get_ ⚠arraybuffer_ info - napi_
get_ ⚠boolean - napi_
get_ ⚠buffer_ info - napi_
get_ ⚠cb_ info - napi_
get_ ⚠dataview_ info - napi_
get_ ⚠date_ value - napi_
get_ ⚠element - napi_
get_ ⚠global - napi_
get_ ⚠instance_ data - napi_
get_ ⚠last_ error_ info - napi_
get_ ⚠named_ property - napi_
get_ ⚠new_ target - napi_
get_ ⚠node_ version - napi_
get_ ⚠null - napi_
get_ ⚠property - napi_
get_ ⚠property_ names - napi_
get_ ⚠prototype - napi_
get_ ⚠reference_ value - napi_
get_ ⚠threadsafe_ function_ context - napi_
get_ ⚠typedarray_ info - napi_
get_ ⚠undefined - napi_
get_ ⚠uv_ event_ loop - napi_
get_ ⚠value_ bigint_ int64 - napi_
get_ ⚠value_ bigint_ uint64 - napi_
get_ ⚠value_ bigint_ words - napi_
get_ ⚠value_ bool - napi_
get_ ⚠value_ double - napi_
get_ ⚠value_ external - napi_
get_ ⚠value_ int32 - napi_
get_ ⚠value_ int64 - napi_
get_ ⚠value_ string_ latin1 - napi_
get_ ⚠value_ string_ utf8 - napi_
get_ ⚠value_ string_ utf16 - napi_
get_ ⚠value_ uint32 - napi_
get_ ⚠version - napi_
has_ ⚠element - napi_
has_ ⚠named_ property - napi_
has_ ⚠own_ property - napi_
has_ ⚠property - napi_
instanceof ⚠ - napi_
is_ ⚠array - napi_
is_ ⚠arraybuffer - napi_
is_ ⚠buffer - napi_
is_ ⚠dataview - napi_
is_ ⚠date - napi_
is_ ⚠detached_ arraybuffer - napi_
is_ ⚠error - napi_
is_ ⚠exception_ pending - napi_
is_ ⚠promise - napi_
is_ ⚠typedarray - napi_
make_ ⚠callback - napi_
module_ ⚠register - napi_
new_ ⚠instance - napi_
object_ ⚠freeze - napi_
object_ ⚠seal - napi_
open_ ⚠callback_ scope - napi_
open_ ⚠escapable_ handle_ scope - napi_
open_ ⚠handle_ scope - napi_
queue_ ⚠async_ work - napi_
ref_ ⚠threadsafe_ function - napi_
reference_ ⚠ref - napi_
reference_ ⚠unref - napi_
reject_ ⚠deferred - napi_
release_ ⚠threadsafe_ function - napi_
remove_ ⚠async_ cleanup_ hook - napi_
remove_ ⚠env_ cleanup_ hook - napi_
remove_ ⚠wrap - napi_
resolve_ ⚠deferred - napi_
run_ ⚠script - napi_
set_ ⚠element - napi_
set_ ⚠instance_ data - napi_
set_ ⚠named_ property - napi_
set_ ⚠property - napi_
strict_ ⚠equals - napi_
throw ⚠ - napi_
throw_ ⚠error - napi_
throw_ ⚠range_ error - napi_
throw_ ⚠type_ error - napi_
type_ ⚠tag_ object - napi_
typeof ⚠ - napi_
unref_ ⚠threadsafe_ function - napi_
unwrap ⚠ - napi_
wrap ⚠
Type Aliases§
- char16_
t - napi_
addon_ register_ func - napi_
async_ cleanup_ hook - napi_
async_ cleanup_ hook_ handle - napi_
async_ complete_ callback - napi_
async_ context - napi_
async_ execute_ callback - napi_
async_ work - napi_
callback - napi_
callback_ info - napi_
callback_ scope - napi_
cleanup_ hook - napi_
deferred - napi_
env - napi_
escapable_ handle_ scope - napi_
finalize - napi_
handle_ scope - napi_
ref - napi_
threadsafe_ function - napi_
threadsafe_ function_ call_ js - napi_
value