Node.js v25.0.0 ドキュメンテーション

node-gyp#

node-gyp は、Google の GYP ツールの gyp-next フォークに基づいたビルドシステムで、npm にバンドルされています。GYP、したがって node-gyp は、Python のインストールを必要とします。

歴史的に、node-gyp はネイティブアドオンをビルドするためのツールとして選ばれてきました。広く採用され、ドキュメントも豊富です。しかし、一部の開発者は node-gyp の制限に直面しています。

CMake.js#

CMake.js は、CMake に基づく代替のビルドシステムです。

CMake.js は、既に CMake を使用しているプロジェクトや、node-gyp の制限に影響を受ける開発者にとって良い選択です。build_with_cmake は、CMake ベースのネイティブアドオンプロジェクトの例です。

node-pre-gyp#

node-pre-gyp は、node-gyp をベースにしたツールで、開発者が選択したサーバーにバイナリをアップロードする機能を追加します。node-pre-gyp は、特に Amazon S3 へのバイナリのアップロードを強力にサポートしています。

prebuild#

prebuild は、node-gyp または CMake.js を使用したビルドをサポートするツールです。さまざまなサーバーをサポートする node-pre-gyp とは異なり、prebuild は GitHub releases にのみバイナリをアップロードします。prebuild は、CMake.js を使用する GitHub プロジェクトに適しています。

prebuildify#

prebuildify は、node-gyp をベースにしたツールです。prebuildify の利点は、ビルドされたバイナリが npm にアップロードされる際にネイティブアドオンにバンドルされることです。バイナリは npm からダウンロードされ、ネイティブアドオンがインストールされるとすぐにモジュールユーザーが利用できるようになります。

napi_handle_scope#

これは、特定のスコープ内で作成されたオブジェクトの寿命を制御および変更するために使用される抽象化です。一般的に、Node-API の値はハンドルスコープのコンテキスト内で作成されます。ネイティブメソッドが JavaScript から呼び出されると、デフォルトのハンドルスコープが存在します。ユーザーが明示的に新しいハンドルスコープを作成しない場合、Node-API の値はデフォルトのハンドルスコープで作成されます。ネイティブメソッドの実行外のコードの呼び出し（たとえば、libuv コールバックの呼び出し中）では、モジュールは JavaScript の値の作成につながる可能性のある関数を呼び出す前にスコープを作成する必要があります。

ハンドルスコープは napi_open_handle_scope を使用して作成され、napi_close_handle_scope を使用して破棄されます。スコープを閉じると、ハンドルスコープの存続期間中に作成されたすべての napi_value が現在のスタックフレームから参照されなくなったことを GC に示すことができます。

詳細については、オブジェクトのライフタイム管理を確認してください。

napi_escapable_handle_scope#

エスケープ可能なハンドルスコープは、特定のハンドルスコープ内で作成された値を親スコープに返すための特殊なタイプのハンドルスコープです。

napi_ref#

これは、napi_value を参照するために使用する抽象化です。これにより、ユーザーは JavaScript の値の寿命を管理でき、最小寿命を明示的に定義することも含みます。

詳細については、オブジェクトのライフタイム管理を確認してください。

napi_type_tag#

2つの符号なし64ビット整数として格納される128ビットの値。JavaScript オブジェクトまたは externals を「タグ付け」するための UUID として機能し、それらが特定の型であることを保証します。これは napi_instanceof よりも強力なチェックです。後者は、オブジェクトのプロトタイプが操作されている場合に偽陽性を報告する可能性があるためです。型タグ付けは napi_wrap と組み合わせて使用すると最も便利です。なぜなら、ラップされたオブジェクトから取得されたポインタが、以前に JavaScript オブジェクトに適用された型タグに対応するネイティブ型に安全にキャストできることを保証するからです。

typedef struct {
  uint64_t lower;
  uint64_t upper;
} napi_type_tag; copy

napi_async_cleanup_hook_handle#

napi_add_async_cleanup_hook によって返される不透明な値。非同期クリーンアップイベントの連鎖が完了したときに napi_remove_async_cleanup_hook に渡される必要があります。

napi_callback_info#

コールバック関数に渡される不透明なデータ型。コールバックが呼び出されたコンテキストに関する追加情報を取得するために使用できます。

napi_callback#

Node-API を介して JavaScript に公開される、ユーザー提供のネイティブ関数の関数ポインタ型。コールバック関数は、次のシグネチャを満たす必要があります。

typedef napi_value (*napi_callback)(napi_env, napi_callback_info); copy

オブジェクトのライフタイム管理で議論されている理由がない限り、napi_callback 内でハンドルやコールバックスコープを作成する必要はありません。

node_api_basic_finalize#

外部で所有されているデータが、関連付けられていたオブジェクトがガベージコレクションされたためにクリーンアップの準備ができたときにユーザーに通知できるようにする、アドオン提供の関数の関数ポインタ型。ユーザーは、オブジェクトのコレクション時に呼び出される、次のシグネチャを満たす関数を提供する必要があります。現在、node_api_basic_finalize は、外部データを持つオブジェクトがいつ収集されるかを知るために使用できます。

typedef void (*node_api_basic_finalize)(node_api_basic_env env,
                                      void* finalize_data,
                                      void* finalize_hint); copy

オブジェクトのライフタイム管理で議論されている理由がない限り、関数本体内でハンドルやコールバックスコープを作成する必要はありません。

これらの関数は、JavaScript エンジンが JavaScript コードを実行できない状態にあるときに呼び出される可能性があるため、最初のパラメータとして node_api_basic_env を受け入れる Node-API のみが呼び出される可能性があります。node_api_post_finalizer を使用して、現在のガベージコレクションサイクルが完了した後に実行される、JavaScript エンジンの状態へのアクセスを必要とする Node-API 呼び出しをスケジュールできます。

node_api_create_external_string_latin1 と node_api_create_external_string_utf16 の場合、env パラメータは null である可能性があります。なぜなら、外部文字列は環境のシャットダウンの後半で収集される可能性があるからです。

変更履歴

• experimental (NAPI_EXPERIMENTAL)

  最初のパラメータとして node_api_basic_env を受け入れる Node-API 呼び出しのみが呼び出される可能性があります。そうでない場合、アプリケーションは適切なエラーメッセージで終了します。この機能は NODE_API_EXPERIMENTAL_BASIC_ENV_OPT_OUT を定義することでオフにすることができます。

napi_finalize#

ガベージコレクションイベントに応答して、ガベージコレクションサイクルが完了した後に、Node-APIへの呼び出しのグループをスケジュールすることをユーザーに許可するアドオン提供の関数の関数ポインタ型。これらの関数ポインタは、node_api_post_finalizerで使用できます。

typedef void (*napi_finalize)(napi_env env,
                              void* finalize_data,
                              void* finalize_hint); copy

変更履歴

• experimental (NAPI_EXPERIMENTAL が定義されている)

  この型の関数は、node_api_post_finalizer を除き、ファイナライザとして使用できなくなりました。代わりに node_api_basic_finalize を使用する必要があります。この機能は NODE_API_EXPERIMENTAL_BASIC_ENV_OPT_OUT を定義することでオフにすることができます。

napi_async_execute_callback#

非同期操作をサポートする関数で使用される関数ポインタ。コールバック関数は、次のシグネチャを満たす必要があります。

typedef void (*napi_async_execute_callback)(napi_env env, void* data); copy

この関数の実装では、JavaScript を実行したり、JavaScript オブジェクトと対話したりする Node-API 呼び出しを避ける必要があります。Node-API 呼び出しは、代わりに napi_async_complete_callback で行うべきです。napi_env パラメータを使用しないでください。JavaScript の実行につながる可能性が高いためです。

napi_async_complete_callback#

非同期操作をサポートする関数で使用される関数ポインタ。コールバック関数は、次のシグネチャを満たす必要があります。

typedef void (*napi_async_complete_callback)(napi_env env,
                                             napi_status status,
                                             void* data); copy

オブジェクトのライフタイム管理で議論されている理由がない限り、関数本体内でハンドルやコールバックスコープを作成する必要はありません。

napi_threadsafe_function_call_js#

非同期スレッドセーフな関数呼び出しで使用される関数ポインタ。コールバックはメインスレッドで呼び出されます。その目的は、セカンダリスレッドのいずれかからキューを介して到着するデータアイテムを使用して、通常は napi_call_function を介した JavaScript への呼び出しに必要なパラメータを構築し、その後 JavaScript への呼び出しを行うことです。

キューを介してセカンダリスレッドから到着するデータは data パラメータで与えられ、呼び出す JavaScript 関数は js_callback パラメータで与えられます。

Node-API はこのコールバックを呼び出す前に環境を設定するため、napi_make_callback ではなく napi_call_function を介して JavaScript 関数を呼び出すだけで十分です。

コールバック関数は、次のシグネチャを満たす必要があります。

typedef void (*napi_threadsafe_function_call_js)(napi_env env,
                                                 napi_value js_callback,
                                                 void* context,
                                                 void* data); copy

• [in] env: API 呼び出しに使用する環境、またはスレッドセーフ関数が破棄され、data を解放する必要がある場合は NULL。
• [in] js_callback: 呼び出す JavaScript 関数、またはスレッドセーフ関数が破棄され、data を解放する必要がある場合は NULL。スレッドセーフ関数が js_callback なしで作成された場合も NULL である可能性があります。
• [in] context: スレッドセーフ関数が作成されたときのオプションのデータ。
• [in] data: セカンダリスレッドによって作成されたデータ。このネイティブデータを、js_callback が呼び出されたときにパラメータとして渡すことができる JavaScript の値 (Node-API 関数を使用) に変換するのは、コールバックの責任です。このポインタは、スレッドとこのコールバックによって完全に管理されます。したがって、このコールバックはデータを解放する必要があります。

オブジェクトのライフタイム管理で議論されている理由がない限り、関数本体内でハンドルやコールバックスコープを作成する必要はありません。

napi_cleanup_hook#

napi_add_env_cleanup_hook で使用される関数ポインタ。環境が破棄されるときに呼び出されます。

コールバック関数は、次のシグネチャを満たす必要があります。

typedef void (*napi_cleanup_hook)(void* data); copy

• [in] data: napi_add_env_cleanup_hook に渡されたデータ。

napi_async_cleanup_hook#

napi_add_async_cleanup_hook で使用される関数ポインタ。環境が破棄されるときに呼び出されます。

コールバック関数は、次のシグネチャを満たす必要があります。

typedef void (*napi_async_cleanup_hook)(napi_async_cleanup_hook_handle handle,
                                        void* data); copy

• [in] handle: 非同期クリーンアップの完了後に napi_remove_async_cleanup_hook に渡さなければならないハンドル。
• [in] data: napi_add_async_cleanup_hook に渡されたデータ。

この関数の本体は、非同期クリーンアップアクションを開始する必要があり、その最後に handle を napi_remove_async_cleanup_hook の呼び出しで渡さなければなりません。

napi_get_last_error_info#

napi_status
napi_get_last_error_info(node_api_basic_env env,
                         const napi_extended_error_info** result); copy

• [in] env: API が呼び出される環境。
• [out] result: エラーに関する詳細情報を含む napi_extended_error_info 構造体。

API が成功した場合は napi_ok を返します。

この API は、最後に発生したエラーに関する情報を持つ napi_extended_error_info 構造体を取得します。

返される napi_extended_error_info の内容は、同じ env で Node-API 関数が呼び出されるまでのみ有効です。これには napi_is_exception_pending の呼び出しも含まれるため、後で使用できるように情報をコピーする必要があることがよくあります。error_message で返されるポインタは静的に定義された文字列を指しているため、別の Node-API 関数が呼び出される前に error_message フィールド（上書きされる）からコピーしておけば、そのポインタを使用するのは安全です。

拡張情報のどの内容や形式にも依存しないでください。SemVer の対象ではなく、いつでも変更される可能性があります。これはログ記録目的のみを意図しています。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_throw#

NAPI_EXTERN napi_status napi_throw(napi_env env, napi_value error); copy

• [in] env: API が呼び出される環境。
• [in] error: スローする JavaScript の値。

API が成功した場合は napi_ok を返します。

このAPIは、提供された JavaScript の値をスローします。

napi_throw_error#

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

• [in] env: API が呼び出される環境。
• [in] code: エラーに設定するオプションのエラーコード。
• [in] msg: エラーに関連付けるテキストを表す C 文字列。

API が成功した場合は napi_ok を返します。

このAPIは、提供されたテキストを持つ JavaScript Error をスローします。

napi_throw_type_error#

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

• [in] env: API が呼び出される環境。
• [in] code: エラーに設定するオプションのエラーコード。
• [in] msg: エラーに関連付けるテキストを表す C 文字列。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript TypeError をスローします。

napi_throw_range_error#

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

• [in] env: API が呼び出される環境。
• [in] code: エラーに設定するオプションのエラーコード。
• [in] msg: エラーに関連付けるテキストを表す C 文字列。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript RangeError をスローします。

node_api_throw_syntax_error#

NAPI_EXTERN napi_status node_api_throw_syntax_error(napi_env env,
                                                    const char* code,
                                                    const char* msg); copy

• [in] env: API が呼び出される環境。
• [in] code: エラーに設定するオプションのエラーコード。
• [in] msg: エラーに関連付けるテキストを表す C 文字列。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript SyntaxError をスローします。

napi_is_error#

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

• [in] env: API が呼び出される環境。
• [in] value: チェックする napi_value。
• [out] result: napi_value がエラーを表す場合は true、それ以外は false に設定されるブール値。

API が成功した場合は napi_ok を返します。

この API は、napi_value がエラーオブジェクトを表すかどうかを確認するためにクエリします。

napi_create_error#

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

• [in] env: API が呼び出される環境。
• [in] code: エラーに関連付けるエラーコードの文字列を持つオプションの napi_value。
• [in] msg: Error のメッセージとして使用される JavaScript string を参照する napi_value。
• [out] result: 作成されたエラーを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript Error を返します。

napi_create_type_error#

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

• [in] env: API が呼び出される環境。
• [in] code: エラーに関連付けるエラーコードの文字列を持つオプションの napi_value。
• [in] msg: Error のメッセージとして使用される JavaScript string を参照する napi_value。
• [out] result: 作成されたエラーを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript TypeError を返します。

napi_create_range_error#

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

• [in] env: API が呼び出される環境。
• [in] code: エラーに関連付けるエラーコードの文字列を持つオプションの napi_value。
• [in] msg: Error のメッセージとして使用される JavaScript string を参照する napi_value。
• [out] result: 作成されたエラーを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript RangeError を返します。

node_api_create_syntax_error#

NAPI_EXTERN napi_status node_api_create_syntax_error(napi_env env,
                                                     napi_value code,
                                                     napi_value msg,
                                                     napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] code: エラーに関連付けるエラーコードの文字列を持つオプションの napi_value。
• [in] msg: Error のメッセージとして使用される JavaScript string を参照する napi_value。
• [out] result: 作成されたエラーを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、提供されたテキストを持つ JavaScript SyntaxError を返します。

napi_get_and_clear_last_exception#

napi_status napi_get_and_clear_last_exception(napi_env env,
                                              napi_value* result); copy

• [in] env: API が呼び出される環境。
• [out] result: 保留中の例外がある場合はその例外、それ以外の場合は NULL。

API が成功した場合は napi_ok を返します。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_is_exception_pending#

napi_status napi_is_exception_pending(napi_env env, bool* result); copy

• [in] env: API が呼び出される環境。
• [out] result: 例外が保留中の場合に true に設定されるブール値。

API が成功した場合は napi_ok を返します。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_fatal_exception#

napi_status napi_fatal_exception(napi_env env, napi_value err); copy

• [in] env: API が呼び出される環境。
• [in] err: 'uncaughtException' に渡されるエラー。

JavaScript で 'uncaughtException' をトリガーします。非同期コールバックが回復不能な例外をスローした場合に便利です。

napi_fatal_error#

NAPI_NO_RETURN void napi_fatal_error(const char* location,
                                     size_t location_len,
                                     const char* message,
                                     size_t message_len); copy

• [in] location: エラーが発生したオプションの場所。
• [in] location_len: location の長さ (バイト単位)、または null 終端の場合は NAPI_AUTO_LENGTH。
• [in] message: エラーに関連付けられたメッセージ。
• [in] message_len: message の長さ (バイト単位)、または null 終端の場合は NAPI_AUTO_LENGTH。

この関数呼び出しは戻りません。プロセスは終了します。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_open_handle_scope#

NAPI_EXTERN napi_status napi_open_handle_scope(napi_env env,
                                               napi_handle_scope* result); copy

• [in] env: API が呼び出される環境。
• [out] result: 新しいスコープを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は新しいスコープを開きます。

napi_close_handle_scope#

NAPI_EXTERN napi_status napi_close_handle_scope(napi_env env,
                                                napi_handle_scope scope); copy

• [in] env: API が呼び出される環境。
• [in] scope: 閉じるスコープを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、渡されたスコープを閉じます。スコープは、作成された順序と逆の順序で閉じなければなりません。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_open_escapable_handle_scope#

NAPI_EXTERN napi_status
    napi_open_escapable_handle_scope(napi_env env,
                                     napi_handle_scope* result); copy

• [in] env: API が呼び出される環境。
• [out] result: 新しいスコープを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、1つのオブジェクトを外部スコープに昇格させることができる新しいスコープを開きます。

napi_close_escapable_handle_scope#

NAPI_EXTERN napi_status
    napi_close_escapable_handle_scope(napi_env env,
                                      napi_handle_scope scope); copy

• [in] env: API が呼び出される環境。
• [in] scope: 閉じるスコープを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、渡されたスコープを閉じます。スコープは、作成された順序と逆の順序で閉じなければなりません。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_escape_handle#

napi_status napi_escape_handle(napi_env env,
                               napi_escapable_handle_scope scope,
                               napi_value escapee,
                               napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] scope: 現在のスコープを表す napi_value。
• [in] escapee: エスケープする JavaScript Object を表す napi_value。
• [out] result: 外部スコープでエスケープされた Object へのハンドルを表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、JavaScript オブジェクトへのハンドルを昇格させ、外部スコープの寿命の間有効になるようにします。スコープごとに一度しか呼び出せません。複数回呼び出すとエラーが返されます。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_create_reference#

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

• [in] env: API が呼び出される環境。
• [in] value: 参照が作成される napi_value。
• [in] initial_refcount: 新しい参照の初期参照カウント。
• [out] result: 新しい参照を指す napi_ref。

API が成功した場合は napi_ok を返します。

このAPIは、渡された値に対して指定された参照カウントで新しい参照を作成します。

napi_delete_reference#

NAPI_EXTERN napi_status napi_delete_reference(napi_env env, napi_ref ref); copy

• [in] env: API が呼び出される環境。
• [in] ref: 削除される napi_ref。

API が成功した場合は napi_ok を返します。

このAPIは、渡された参照を削除します。

このAPIは、保留中のJavaScript例外がある場合でも呼び出すことができます。

napi_reference_ref#

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

• [in] env: API が呼び出される環境。
• [in] ref: 参照カウントがインクリメントされる napi_ref。
• [out] result: 新しい参照カウント。

API が成功した場合は napi_ok を返します。

このAPIは、渡された参照の参照カウントをインクリメントし、結果の参照カウントを返します。

napi_reference_unref#

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

• [in] env: API が呼び出される環境。
• [in] ref: 参照カウントがデクリメントされる napi_ref。
• [out] result: 新しい参照カウント。

API が成功した場合は napi_ok を返します。

このAPIは、渡された参照の参照カウントをデクリメントし、結果の参照カウントを返します。

napi_get_reference_value#

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

• [in] env: API が呼び出される環境。
• [in] ref: 対応する値が要求されている napi_ref。
• [out] result: napi_ref によって参照される napi_value。

API が成功した場合は napi_ok を返します。

まだ有効な場合、このAPIは napi_ref に関連付けられたJavaScript値を表す napi_value を返します。それ以外の場合、result は NULL になります。

napi_add_env_cleanup_hook#

NODE_EXTERN napi_status napi_add_env_cleanup_hook(node_api_basic_env env,
                                                  napi_cleanup_hook fun,
                                                  void* arg); copy

現在のNode.js環境が終了したときに、arg パラメータを付けて実行される関数として fun を登録します。

関数は、異なる arg 値で複数回安全に指定できます。その場合、関数も複数回呼び出されます。同じ fun と arg の値を複数回提供することは許可されておらず、プロセスが異常終了する原因となります。

フックは逆の順序で呼び出されます。つまり、最も最近追加されたものが最初に呼び出されます。

このフックの削除は napi_remove_env_cleanup_hook を使用して行うことができます。通常、これはこのフックが追加されたリソースがとにかく破棄されるときに行われます。

非同期クリーンアップについては、napi_add_async_cleanup_hook が利用可能です。

napi_remove_env_cleanup_hook#

NAPI_EXTERN napi_status napi_remove_env_cleanup_hook(node_api_basic_env env,
                                                     void (*fun)(void* arg),
                                                     void* arg); copy

現在のNode.js環境が終了したときに arg パラメータで実行される関数として fun の登録を解除します。引数と関数値の両方が完全に一致する必要があります。

この関数は元々 napi_add_env_cleanup_hook で登録されている必要があります。そうでない場合、プロセスは異常終了します。

napi_add_async_cleanup_hook#

NAPI_EXTERN napi_status napi_add_async_cleanup_hook(
    node_api_basic_env env,
    napi_async_cleanup_hook hook,
    void* arg,
    napi_async_cleanup_hook_handle* remove_handle); copy

• [in] env: API が呼び出される環境。
• [in] hook: 環境の破棄時に呼び出す関数ポインタ。
• [in] arg: hook が呼び出されるときに渡されるポインタ。
• [out] remove_handle: 非同期クリーンアップフックを参照するオプションのハンドル。

現在のNode.js環境が終了したときに remove_handle と arg パラメータで実行される関数として、napi_async_cleanup_hook 型の関数である hook を登録します。

napi_add_env_cleanup_hook とは異なり、フックは非同期であることが許可されます。

それ以外の動作は、一般的に napi_add_env_cleanup_hook の動作と一致します。

remove_handle が NULL でない場合、不透明な値が格納されます。この値は、フックがすでに呼び出されたかどうかに関わらず、後で napi_remove_async_cleanup_hook に渡す必要があります。通常、これはフックが追加されたリソースがとにかく破棄されるときに発生します。

napi_remove_async_cleanup_hook#

NAPI_EXTERN napi_status napi_remove_async_cleanup_hook(
    napi_async_cleanup_hook_handle remove_handle); copy

• [in] remove_handle: napi_add_async_cleanup_hook で作成された非同期クリーンアップフックへのハンドル。

remove_handle に対応するクリーンアップフックの登録を解除します。これにより、フックの実行がすでに開始されていない限り、その実行が妨げられます。これは、napi_add_async_cleanup_hook から取得されたすべての napi_async_cleanup_hook_handle 値に対して呼び出す必要があります。

napi_key_collection_mode#

typedef enum {
  napi_key_include_prototypes,
  napi_key_own_only
} napi_key_collection_mode; copy

Keys/Properties フィルター列挙体を記述します

napi_key_collection_mode は収集されるプロパティの範囲を制限します。

napi_key_own_only は収集されるプロパティを特定のオブジェクトのみに制限します。napi_key_include_prototypes はオブジェクトのプロトタイプチェーンのすべてのキーも同様に含めます。

napi_key_filter#

typedef enum {
  napi_key_all_properties = 0,
  napi_key_writable = 1,
  napi_key_enumerable = 1 << 1,
  napi_key_configurable = 1 << 2,
  napi_key_skip_strings = 1 << 3,
  napi_key_skip_symbols = 1 << 4
} napi_key_filter; copy

プロパティフィルタのビットフラグ。ビット演算子と共に使用して複合フィルタを構築します。

napi_key_conversion#

typedef enum {
  napi_key_keep_numbers,
  napi_key_numbers_to_strings
} napi_key_conversion; copy

napi_key_numbers_to_strings は整数のインデックスを文字列に変換します。napi_key_keep_numbers は整数のインデックスに対して数値を返します。

napi_valuetype#

typedef enum {
  // ES6 types (corresponds to typeof)
  napi_undefined,
  napi_null,
  napi_boolean,
  napi_number,
  napi_string,
  napi_symbol,
  napi_object,
  napi_function,
  napi_external,
  napi_bigint,
} napi_valuetype; copy

napi_value の型を記述します。これは一般的に、ECMAScript言語仕様の セクション 言語の型 で記述されている型に対応します。そのセクションの型に加えて、napi_valuetype は外部データを持つ Function や Object も表現できます。

napi_external 型のJavaScript値は、JavaScriptではプレーンなオブジェクトとして現れ、プロパティを設定できず、プロトタイプもありません。

napi_typedarray_type#

typedef enum {
  napi_int8_array,
  napi_uint8_array,
  napi_uint8_clamped_array,
  napi_int16_array,
  napi_uint16_array,
  napi_int32_array,
  napi_uint32_array,
  napi_float32_array,
  napi_float64_array,
  napi_bigint64_array,
  napi_biguint64_array,
} napi_typedarray_type; copy

これは、TypedArray の基底となるバイナリスカラデータ型を表します。この列挙体の要素は、ECMAScript言語仕様のセクション TypedArray オブジェクトに対応します。

napi_create_array#

napi_status napi_create_array(napi_env env, napi_value* result) copy

• [in] env: Node-API 呼び出しが実行される環境。
• [out] result: JavaScriptの Array を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、JavaScriptの Array 型に対応するNode-APIの値を返します。JavaScriptの配列は、ECMAScript言語仕様のセクション 配列オブジェクトに記述されています。

napi_create_array_with_length#

napi_status napi_create_array_with_length(napi_env env,
                                          size_t length,
                                          napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] length: Array の初期長。
• [out] result: JavaScriptの Array を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、JavaScriptの Array 型に対応するNode-APIの値を返します。Array の length プロパティは、渡された length パラメータに設定されます。ただし、配列が作成されたときに基底となるバッファがVMによって事前に割り当てられることは保証されていません。その動作は、基底となるVMの実装に任されています。バッファがCを介して直接読み書きできる連続したメモリブロックである必要がある場合は、napi_create_external_arraybuffer の使用を検討してください。

JavaScriptの配列は、ECMAScript言語仕様のセクション 配列オブジェクトに記載されています。

napi_create_arraybuffer#

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

• [in] env: API が呼び出される環境。
• [in] length: 作成する配列バッファの長さ（バイト単位）。
• [out] data: ArrayBuffer の基底となるバイトバッファへのポインタ。data は NULL を渡すことで任意に無視できます。
• [out] result: JavaScriptの ArrayBuffer を表す napi_value。

API が成功した場合は napi_ok を返します。

この API は、JavaScript の ArrayBuffer に対応する Node-API の値を返します。ArrayBuffer は、固定長のバイナリデータバッファを表すために使用されます。通常、TypedArray オブジェクトのバッキングバッファとして使用されます。割り当てられる ArrayBuffer は、渡された length パラメータによってサイズが決定される基底のバイトバッファを持ちます。呼び出し元がバッファを直接操作したい場合に備えて、この基底バッファはオプションで呼び出し元に返されます。このバッファは、ネイティブコードからのみ直接書き込むことができます。JavaScript からこのバッファに書き込むには、型付き配列または DataView オブジェクトを作成する必要があります。

JavaScriptの ArrayBuffer オブジェクトは、ECMAScript言語仕様のセクション ArrayBuffer オブジェクトに記載されています。

napi_create_buffer#

napi_status napi_create_buffer(napi_env env,
                               size_t size,
                               void** data,
                               napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] size: 基底となるバッファのサイズ（バイト単位）。
• [out] data: 基底となるバッファへの生のポインタ。data は NULL を渡すことで任意に無視できます。
• [out] result: node::Buffer を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは node::Buffer オブジェクトを割り当てます。これはまだ完全にサポートされているデータ構造ですが、ほとんどの場合、TypedArray を使用すれば十分です。

napi_create_buffer_copy#

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

• [in] env: API が呼び出される環境。
• [in] size: 入力バッファのサイズ（バイト単位）（新しいバッファのサイズと同じであるべきです）。
• [in] data: コピー元の基底となるバッファへの生のポインタ。
• [out] result_data: 新しい Buffer の基底となるデータバッファへのポインタ。result_data は NULL を渡すことで任意に無視できます。
• [out] result: node::Buffer を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは node::Buffer オブジェクトを割り当て、渡されたバッファからコピーしたデータで初期化します。これはまだ完全にサポートされているデータ構造ですが、ほとんどの場合、TypedArray を使用すれば十分です。

napi_create_date#

napi_status napi_create_date(napi_env env,
                             double time,
                             napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] time: 1970年1月1日UTCからのECMAScript時間値（ミリ秒）。
• [out] result: JavaScriptの Date を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIはうるう秒を考慮しません。ECMAScriptはPOSIX時間仕様に準拠しているため、それらは無視されます。

このAPIはJavaScriptの Date オブジェクトを割り当てます。

JavaScriptの Date オブジェクトは、ECMAScript言語仕様のセクション Dateオブジェクトに記載されています。

napi_create_external#

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

• [in] env: API が呼び出される環境。
• [in] data: 外部データへの生のポインタ。
• [in] finalize_cb: 外部値が収集されるときに呼び出すオプションのコールバック。napi_finalize に詳細が記載されています。
• [in] finalize_hint: コレクション中にファイナライズコールバックに渡すオプションのヒント。
• [out] result: 外部値を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、外部データが添付されたJavaScript値を割り当てます。これは、外部データをJavaScriptコードを介して渡し、後でネイティブコードが napi_get_value_external を使用して取得するために使用されます。

このAPIは、作成されたJavaScriptオブジェクトがガベージコレクションされたときに呼び出される napi_finalize コールバックを追加します。

作成された値はオブジェクトではないため、追加のプロパティをサポートしません。これは別個の値の型と見なされます：外部値で napi_typeof() を呼び出すと napi_external が返されます。

napi_create_external_arraybuffer#

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) copy

• [in] env: API が呼び出される環境。
• [in] external_data: ArrayBuffer の基底となるバイトバッファへのポインタ。
• [in] byte_length: 基底となるバッファの長さ（バイト単位）。
• [in] finalize_cb: ArrayBuffer が収集されるときに呼び出すオプションのコールバック。napi_finalize に詳細が記載されています。
• [in] finalize_hint: コレクション中にファイナライズコールバックに渡すオプションのヒント。
• [out] result: JavaScriptの ArrayBuffer を表す napi_value。

API が成功した場合は napi_ok を返します。

Node.js以外のいくつかのランタイムは、外部バッファのサポートを廃止しました。Node.js以外のランタイムでは、このメソッドは外部バッファがサポートされていないことを示すために napi_no_external_buffers_allowed を返すことがあります。そのようなランタイムの1つは、このイシュー electron/issues/35801 で説明されているElectronです。

すべてのランタイムとの最大限の互換性を維持するために、アドオンでnode-apiヘッダをインクルードする前に NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED を定義することができます。そうすることで、外部バッファを作成する2つの関数が非表示になります。これにより、誤ってこれらのメソッドのいずれかを使用した場合にコンパイルエラーが発生することが保証されます。

このAPIは、JavaScriptの ArrayBuffer に対応するNode-APIの値を返します。ArrayBuffer の基底となるバイトバッファは外部で割り当てられ、管理されます。呼び出し元は、ファイナライズコールバックが呼ばれるまでバイトバッファが有効であることを保証しなければなりません。

このAPIは、作成されたJavaScriptオブジェクトがガベージコレクションされたときに呼び出される napi_finalize コールバックを追加します。

JavaScriptの ArrayBuffer は、ECMAScript言語仕様のセクション ArrayBufferオブジェクトに記載されています。

napi_create_external_buffer#

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

• [in] env: API が呼び出される環境。
• [in] length: 入力バッファのサイズ（バイト単位）（新しいバッファのサイズと同じであるべきです）。
• [in] data: JavaScriptに公開する基底となるバッファへの生のポインタ。
• [in] finalize_cb: ArrayBuffer が収集されるときに呼び出すオプションのコールバック。napi_finalize に詳細が記載されています。
• [in] finalize_hint: コレクション中にファイナライズコールバックに渡すオプションのヒント。
• [out] result: node::Buffer を表す napi_value。

API が成功した場合は napi_ok を返します。

Node.js以外のいくつかのランタイムは、外部バッファのサポートを廃止しました。Node.js以外のランタイムでは、このメソッドは外部バッファがサポートされていないことを示すために napi_no_external_buffers_allowed を返すことがあります。そのようなランタイムの1つは、このイシュー electron/issues/35801 で説明されているElectronです。

すべてのランタイムとの最大限の互換性を維持するために、アドオンでnode-apiヘッダをインクルードする前に NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED を定義することができます。そうすることで、外部バッファを作成する2つの関数が非表示になります。これにより、誤ってこれらのメソッドのいずれかを使用した場合にコンパイルエラーが発生することが保証されます。

このAPIは、node::Bufferオブジェクトを割り当て、渡されたバッファに裏打ちされたデータで初期化します。これはまだ完全にサポートされたデータ構造ですが、ほとんどの場合、TypedArrayを使用すれば十分です。

このAPIは、作成されたJavaScriptオブジェクトがガベージコレクションされたときに呼び出される napi_finalize コールバックを追加します。

Node.js >=4 では、Buffer は Uint8Array です。

napi_create_object#

napi_status napi_create_object(napi_env env, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [out] result: JavaScriptの Object を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、デフォルトのJavaScript Object を割り当てます。これは、JavaScriptで new Object() を実行するのと同等です。

JavaScriptの Object 型は、ECMAScript言語仕様のセクション オブジェクト型に記載されています。

napi_create_symbol#

napi_status napi_create_symbol(napi_env env,
                               napi_value description,
                               napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] description: シンボルの説明として設定されるJavaScriptの string を参照するオプションの napi_value。
• [out] result: JavaScriptの symbol を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、UTF8エンコードされたC文字列からJavaScriptの symbol 値を作成します。

JavaScriptの symbol 型は、ECMAScript言語仕様のセクション シンボル型に記載されています。

node_api_symbol_for#

napi_status node_api_symbol_for(napi_env env,
                                const char* utf8description,
                                size_t length,
                                napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] utf8description: シンボルの説明として使用されるテキストを表すUTF-8 C文字列。
• [in] length: 説明文字列の長さ（バイト単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: JavaScriptの symbol を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、グローバルレジストリで特定の説明を持つ既存のシンボルを検索します。シンボルが既に存在する場合はそれが返され、そうでない場合はレジストリに新しいシンボルが作成されます。

JavaScriptの symbol 型は、ECMAScript言語仕様のセクション シンボル型に記載されています。

napi_create_typedarray#

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) copy

• [in] env: API が呼び出される環境。
• [in] type: TypedArray 内の要素のスカラーデータ型。
• [in] length: TypedArray 内の要素数。
• [in] arraybuffer: 型付き配列の基底となる ArrayBuffer。
• [in] byte_offset: TypedArray の射影を開始する ArrayBuffer 内のバイトオフセット。
• [out] result: JavaScriptの TypedArray を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、既存の ArrayBuffer 上にJavaScriptの TypedArray オブジェクトを作成します。TypedArray オブジェクトは、各要素が同じ基底のバイナリスカラデータ型を持つ、基底となるデータバッファに対する配列のようなビューを提供します。

(length * size_of_element) + byte_offset は、渡された配列のバイトサイズ以下である必要があります。そうでない場合、RangeError 例外が発生します。

JavaScriptの TypedArray オブジェクトは、ECMAScript言語仕様のセクション TypedArrayオブジェクトに記載されています。

node_api_create_buffer_from_arraybuffer#

napi_status NAPI_CDECL node_api_create_buffer_from_arraybuffer(napi_env env,
                                                              napi_value arraybuffer,
                                                              size_t byte_offset,
                                                              size_t byte_length,
                                                              napi_value* result) copy

• [in] env: APIが呼び出される環境。
• [in] arraybuffer: バッファが作成される元の ArrayBuffer。
• [in] byte_offset: ArrayBuffer 内でバッファの作成を開始するバイトオフセット。
• [in] byte_length: ArrayBuffer から作成されるバッファの長さ（バイト単位）。
• [out] result: 作成されたJavaScript Buffer オブジェクトを表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、既存の ArrayBuffer からJavaScriptの Buffer オブジェクトを作成します。Buffer オブジェクトはNode.js固有のクラスで、JavaScriptで直接バイナリデータを扱う方法を提供します。

バイト範囲 [byte_offset, byte_offset + byte_length) は ArrayBuffer の範囲内にある必要があります。byte_offset + byte_length が ArrayBuffer のサイズを超える場合、RangeError 例外が発生します。

napi_create_dataview#

napi_status napi_create_dataview(napi_env env,
                                 size_t byte_length,
                                 napi_value arraybuffer,
                                 size_t byte_offset,
                                 napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] length: DataView の要素数。
• [in] arraybuffer: DataView の基底となる ArrayBuffer。
• [in] byte_offset: DataView の射影を開始する ArrayBuffer 内のバイトオフセット。
• [out] result: JavaScriptの DataView を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、既存の ArrayBuffer 上にJavaScriptの DataView オブジェクトを作成します。DataView オブジェクトは、基底となるデータバッファに対して配列のようなビューを提供しますが、ArrayBuffer 内で異なるサイズと型の項目を許可するものです。

byte_length + byte_offset が渡された配列のバイトサイズ以下であることが必要です。そうでない場合、RangeError 例外が発生します。

JavaScriptの DataView オブジェクトは、ECMAScript言語仕様のセクション DataViewオブジェクトに記載されています。

napi_create_int32#

napi_status napi_create_int32(napi_env env, int32_t value, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptで表現される整数値。
• [out] result: JavaScriptの number を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、Cの int32_t 型からJavaScriptの number 型に変換するために使用されます。

JavaScriptの number 型は、ECMAScript言語仕様のセクション number型に記載されています。

napi_create_uint32#

napi_status napi_create_uint32(napi_env env, uint32_t value, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptで表現される符号なし整数値。
• [out] result: JavaScriptの number を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、Cの uint32_t 型からJavaScriptの number 型へ変換するために使用されます。

JavaScriptの number 型は、ECMAScript言語仕様のセクション number型に記載されています。

napi_create_int64#

napi_status napi_create_int64(napi_env env, int64_t value, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptで表現される整数値。
• [out] result: JavaScriptの number を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、Cの int64_t 型からJavaScriptの number 型へ変換するために使用されます。

JavaScriptの number 型は、ECMAScript言語仕様のセクション number型に記載されています。int64_t の全範囲をJavaScriptで完全な精度で表現することはできないことに注意してください。Number.MIN_SAFE_INTEGER -(2**53 - 1) から Number.MAX_SAFE_INTEGER (2**53 - 1) の範囲外の整数値は精度を失います。

napi_create_double#

napi_status napi_create_double(napi_env env, double value, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptで表現される倍精度値。
• [out] result: JavaScriptの number を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、Cの double 型からJavaScriptの number 型へ変換するために使用されます。

JavaScriptの number 型は、ECMAScript言語仕様のセクション number型に記載されています。

napi_create_bigint_int64#

napi_status napi_create_bigint_int64(napi_env env,
                                     int64_t value,
                                     napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptで表現される整数値。
• [out] result: JavaScriptの BigInt を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、Cの int64_t 型をJavaScriptの BigInt 型に変換します。

napi_create_bigint_uint64#

napi_status napi_create_bigint_uint64(napi_env env,
                                      uint64_t value,
                                      napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptで表現される符号なし整数値。
• [out] result: JavaScriptの BigInt を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、Cの uint64_t 型をJavaScriptの BigInt 型に変換します。

napi_create_bigint_words#

napi_status napi_create_bigint_words(napi_env env,
                                     int sign_bit,
                                     size_t word_count,
                                     const uint64_t* words,
                                     napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] sign_bit: 結果の BigInt が正か負かを決定します。
• [in] word_count: words 配列の長さ。
• [in] words: uint64_t のリトルエンディアン64ビットワードの配列。
• [out] result: JavaScriptの BigInt を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、符号なし64ビットワードの配列を単一の BigInt 値に変換します。

結果の BigInt は次のように計算されます: (–1)^sign_bit (words[0] × (2⁶⁴)⁰ + words[1] × (2⁶⁴)¹ + …)

napi_create_string_latin1#

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

• [in] env: API が呼び出される環境。
• [in] str: ISO-8859-1でエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（バイト単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: JavaScriptの string を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、ISO-8859-1でエンコードされたC文字列からJavaScriptの string 値を作成します。ネイティブ文字列はコピーされます。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

node_api_create_external_string_latin1#

napi_status
node_api_create_external_string_latin1(napi_env env,
                                       char* str,
                                       size_t length,
                                       napi_finalize finalize_callback,
                                       void* finalize_hint,
                                       napi_value* result,
                                       bool* copied); copy

• [in] env: API が呼び出される環境。
• [in] str: ISO-8859-1でエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（バイト単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [in] finalize_callback: 文字列が収集されるときに呼び出す関数。この関数は以下のパラメータで呼び出されます。
  • [in] env: アドオンが実行されている環境。ワーカーまたはメインのNode.jsインスタンスの終了の一部として文字列が収集される場合、この値はnullになることがあります。
  • [in] data: これは void* ポインタとしての str の値です。
  • [in] finalize_hint: これはAPIに与えられた finalize_hint の値です。napi_finalize に詳細が記載されています。このパラメータはオプションです。null値を渡すと、対応するJavaScript文字列が収集されたときにアドオンに通知する必要がないことを意味します。
• [in] finalize_hint: コレクション中にファイナライズコールバックに渡すオプションのヒント。
• [out] result: JavaScriptの string を表す napi_value。
• [out] copied: 文字列がコピーされたかどうか。コピーされた場合、ファイナライザはすでに str を破棄するために呼び出されています。

API が成功した場合は napi_ok を返します。

このAPIは、ISO-8859-1エンコードのC文字列からJavaScriptの string 値を作成します。ネイティブ文字列はコピーされない場合があり、そのためJavaScript値のライフサイクル全体にわたって存在しなければなりません。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

napi_create_string_utf16#

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

• [in] env: API が呼び出される環境。
• [in] str: UTF16-LEでエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（2バイトコード単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: JavaScriptの string を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、UTF16-LEでエンコードされたC文字列からJavaScriptの string 値を作成します。ネイティブ文字列はコピーされます。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

node_api_create_external_string_utf16#

napi_status
node_api_create_external_string_utf16(napi_env env,
                                      char16_t* str,
                                      size_t length,
                                      napi_finalize finalize_callback,
                                      void* finalize_hint,
                                      napi_value* result,
                                      bool* copied); copy

• [in] env: API が呼び出される環境。
• [in] str: UTF16-LEでエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（2バイトコード単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [in] finalize_callback: 文字列が収集されるときに呼び出す関数。この関数は以下のパラメータで呼び出されます。
  • [in] env: アドオンが実行されている環境。ワーカーまたはメインのNode.jsインスタンスの終了の一部として文字列が収集される場合、この値はnullになることがあります。
  • [in] data: これは void* ポインタとしての str の値です。
  • [in] finalize_hint: これはAPIに与えられた finalize_hint の値です。napi_finalize に詳細が記載されています。このパラメータはオプションです。null値を渡すと、対応するJavaScript文字列が収集されたときにアドオンに通知する必要がないことを意味します。
• [in] finalize_hint: コレクション中にファイナライズコールバックに渡すオプションのヒント。
• [out] result: JavaScriptの string を表す napi_value。
• [out] copied: 文字列がコピーされたかどうか。コピーされた場合、ファイナライザはすでに str を破棄するために呼び出されています。

API が成功した場合は napi_ok を返します。

このAPIは、UTF16-LEエンコードされたC文字列からJavaScriptの `string` 値を作成します。ネイティブ文字列はコピーされない場合があるため、JavaScript値のライフサイクル全体にわたって存在しなければなりません。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

napi_create_string_utf8#

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

• [in] env: API が呼び出される環境。
• [in] str: UTF8でエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（バイト単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: JavaScriptの string を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、UTF8でエンコードされたC文字列からJavaScriptの string 値を作成します。ネイティブ文字列はコピーされます。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

node_api_create_property_key_latin1#

napi_status NAPI_CDECL node_api_create_property_key_latin1(napi_env env,
                                                           const char* str,
                                                           size_t length,
                                                           napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] str: ISO-8859-1でエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（バイト単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: オブジェクトのプロパティキーとして使用される、最適化されたJavaScriptの string を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、オブジェクトのプロパティキーとして使用するために、ISO-8859-1でエンコードされたC文字列から最適化されたJavaScriptの string 値を作成します。ネイティブ文字列はコピーされます。napi_create_string_latin1 とは対照的に、同じ str ポインタでこの関数を後続で呼び出すと、エンジンによっては要求された napi_value の作成が高速化される場合があります。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

node_api_create_property_key_utf16#

napi_status NAPI_CDECL node_api_create_property_key_utf16(napi_env env,
                                                          const char16_t* str,
                                                          size_t length,
                                                          napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] str: UTF16-LEでエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（2バイトコード単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: オブジェクトのプロパティキーとして使用される、最適化されたJavaScriptの string を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、オブジェクトのプロパティキーとして使用するために、UTF16-LEでエンコードされたC文字列から最適化されたJavaScriptの `string` 値を作成します。ネイティブ文字列はコピーされます。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

node_api_create_property_key_utf8#

napi_status NAPI_CDECL node_api_create_property_key_utf8(napi_env env,
                                                         const char* str,
                                                         size_t length,
                                                         napi_value* result); copy

• [in] env: API が呼び出される環境。
• [in] str: UTF8でエンコードされた文字列を表す文字バッファ。
• [in] length: 文字列の長さ（2バイトコード単位）、またはヌル終端の場合は NAPI_AUTO_LENGTH。
• [out] result: オブジェクトのプロパティキーとして使用される、最適化されたJavaScriptの string を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、オブジェクトのプロパティキーとして使用するために、UTF8でエンコードされたC文字列から最適化されたJavaScriptの string 値を作成します。ネイティブ文字列はコピーされます。

JavaScriptの string 型は、ECMAScript言語仕様のセクション string型に記載されています。

napi_get_array_length#

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

• [in] env: API が呼び出される環境。
• [in] value: 長さがクエリされるJavaScript Array を表す napi_value。
• [out] result: 配列の長さを表す uint32。

API が成功した場合は napi_ok を返します。

このAPIは配列の長さを返します。

Array の長さは、ECMAScript言語仕様のセクション 配列インスタンスの長さに記載されています。

napi_get_arraybuffer_info#

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

• [in] env: API が呼び出される環境。
• [in] arraybuffer: クエリ対象の ArrayBuffer または SharedArrayBuffer を表す napi_value。
• [out] data: ArrayBuffer または SharedArrayBuffer の基底データバッファが 0 の場合、これは NULL または他の任意のポインタ値になる可能性があります。
• [out] byte_length: 基底データバッファの長さ（バイト単位）。

API が成功した場合は napi_ok を返します。

このAPIは、ArrayBuffer または SharedArrayBuffer の基底となるデータバッファとその長さを取得するために使用されます。

警告：このAPIを使用する際には注意してください。基底となるデータバッファのライフタイムは、返された後も ArrayBuffer または SharedArrayBuffer によって管理されます。このAPIを安全に使用する可能性のある方法は、ArrayBuffer または SharedArrayBuffer のライフタイムの制御を保証するために使用できる napi_create_reference と組み合わせて使用することです。GCをトリガーする可能性のある他のAPIへの呼び出しがない限り、同じコールバック内で返されたデータバッファを使用することも安全です。

napi_get_buffer_info#

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

• [in] env: API が呼び出される環境。
• [in] value: 問い合わせ対象の node::Buffer または Uint8Array を表す napi_value。
• [out] data: node::Buffer または Uint8Array の基底データバッファ。長さが 0 の場合、これは NULL またはその他のポインタ値になることがあります。
• [out] length: 基底データバッファの長さ（バイト単位）。

API が成功した場合は napi_ok を返します。

このメソッドは、napi_get_typedarray_info と同じ data と byte_length を返します。また、napi_get_typedarray_info は値として node::Buffer (Uint8Array) も受け付けます。

このAPIは、node::Buffer の基底となるデータバッファとその長さを取得するために使用されます。

警告：このAPIを使用する際は注意してください。基底となるデータバッファがVMによって管理されている場合、そのライフタイムは保証されません。

napi_get_prototype#

napi_status napi_get_prototype(napi_env env,
                               napi_value object,
                               napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] object: プロトタイプを返すJavaScript Object を表す napi_value。これは Object.getPrototypeOf と同等のものを返します（関数の prototype プロパティとは異なります）。
• [out] result: 与えられたオブジェクトのプロトタイプを表す napi_value。

API が成功した場合は napi_ok を返します。

napi_get_typedarray_info#

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) copy

• [in] env: API が呼び出される環境。
• [in] typedarray: プロパティを問い合わせる TypedArray を表す napi_value。
• [out] type: TypedArray 内の要素のスカラーデータ型。
• [out] length: TypedArray 内の要素数。
• [out] data: TypedArray の基底となるデータバッファで、byte_offset 値によって調整され、TypedArray の最初の要素を指すようにします。配列の長さが 0 の場合、これは NULL または他のポインタ値になることがあります。
• [out] arraybuffer: TypedArray の基底となる ArrayBuffer。
• [out] byte_offset: 基底となるネイティブ配列内で、配列の最初の要素が配置されているバイトオフセット。data パラメータの値は、data が配列の最初の要素を指すようにすでに調整されています。したがって、ネイティブ配列の最初のバイトは data - byte_offset になります。

API が成功した場合は napi_ok を返します。

このAPIは、型付き配列の様々なプロパティを返します。

そのプロパティが不要な場合、いずれの出力パラメータも NULL にすることができます。

警告：このAPIを使用する際には注意してください。基底となるデータバッファはVMによって管理されています。

napi_get_dataview_info#

napi_status napi_get_dataview_info(napi_env env,
                                   napi_value dataview,
                                   size_t* byte_length,
                                   void** data,
                                   napi_value* arraybuffer,
                                   size_t* byte_offset) copy

• [in] env: API が呼び出される環境。
• [in] dataview: プロパティを問い合わせる DataView を表す napi_value。
• [out] byte_length: DataView のバイト数。
• [out] data: DataView の基底となるデータバッファ。byte_length が 0 の場合、これは NULL または他のポインタ値になることがあります。
• [out] arraybuffer: DataView の基底となる ArrayBuffer。
• [out] byte_offset: DataView の射影を開始するデータバッファ内のバイトオフセット。

API が成功した場合は napi_ok を返します。

そのプロパティが不要な場合、いずれの出力パラメータも NULL にすることができます。

このAPIは、DataView の様々なプロパティを返します。

napi_get_date_value#

napi_status napi_get_date_value(napi_env env,
                                napi_value value,
                                double* result) copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの Date を表す napi_value。
• [out] result: 1970年1月1日UTCの午前0時からのミリ秒として表される double 型の時間値。

このAPIはうるう秒を考慮しません。ECMAScriptはPOSIX時間仕様に準拠しているため、それらは無視されます。

APIが成功した場合 napi_ok を返します。日付ではない napi_value が渡された場合、napi_date_expected を返します。

このAPIは、与えられたJavaScriptの Date に対して、Cのdoubleプリミティブの時間値を返します。

napi_get_value_bool#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの Boolean を表す napi_value。
• [out] result: 与えられたJavaScriptの Boolean と同等のCのブールプリミティブ。

APIが成功した場合 napi_ok を返します。ブール値でない napi_value が渡された場合、napi_boolean_expected を返します。

このAPIは、与えられたJavaScriptの Boolean に対応するCのブールプリミティブ値を返します。

napi_get_value_double#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの number を表す napi_value。
• [out] result: 与えられたJavaScriptの number と同等のCのdoubleプリミティブ。

APIが成功した場合は napi_ok を返します。数値でない napi_value が渡された場合は napi_number_expected を返します。

このAPIは、与えられたJavaScriptの number に対応するCのdoubleプリミティブ値を返します。

napi_get_value_bigint_int64#

napi_status napi_get_value_bigint_int64(napi_env env,
                                        napi_value value,
                                        int64_t* result,
                                        bool* lossless); copy

• [in] env: APIが呼び出される環境
• [in] value: JavaScriptの BigInt を表す napi_value。
• [out] result: 与えられたJavaScriptの BigInt に対応するCの int64_t プリミティブ。
• [out] lossless: BigInt の値が損失なく変換されたかどうかを示します。

APIが成功した場合は napi_ok を返します。BigInt でない値が渡された場合は napi_bigint_expected を返します。

このAPIは、与えられたJavaScriptの BigInt に対応するCの int64_t プリミティブ値を返します。必要に応じて値を切り捨て、lossless を false に設定します。

napi_get_value_bigint_uint64#

napi_status napi_get_value_bigint_uint64(napi_env env,
                                        napi_value value,
                                        uint64_t* result,
                                        bool* lossless); copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの BigInt を表す napi_value。
• [out] result: 指定されたJavaScript BigInt に対応するC uint64_t プリミティブ。
• [out] lossless: BigInt の値が損失なく変換されたかどうかを示します。

APIが成功した場合は napi_ok を返します。BigInt でない値が渡された場合は napi_bigint_expected を返します。

このAPIは、与えられたJavaScriptの BigInt に対応するCの uint64_t プリミティブ値を返します。必要に応じて値を切り捨て、lossless を false に設定します。

napi_get_value_bigint_words#

napi_status napi_get_value_bigint_words(napi_env env,
                                        napi_value value,
                                        int* sign_bit,
                                        size_t* word_count,
                                        uint64_t* words); copy

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの BigInt を表す napi_value。
• [out] sign_bit: JavaScriptの BigInt が正か負かを表す整数。
• [in/out] word_count: words 配列の長さに初期化する必要があります。返却時には、この BigInt を格納するために必要な実際のワード数に設定されます。
• [out] words: 事前に割り当てられた64ビットワード配列へのポインタ。

API が成功した場合は napi_ok を返します。

このAPIは、単一の BigInt 値を符号ビット、64ビットリトルエンディアン配列、および配列の要素数に変換します。sign_bit と words は、word_count のみを取得するために両方とも NULL に設定できます。

napi_get_value_external#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの外部値を表す napi_value。
• [out] result: JavaScriptの外部値によってラップされたデータへのポインタ。

APIが成功した場合 napi_ok を返します。外部値ではない napi_value が渡された場合、napi_invalid_arg を返します。

このAPIは、以前に napi_create_external() に渡された外部データポインタを取得します。

napi_get_value_int32#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの number を表す napi_value。
• [out] result: 与えられたJavaScript number に対応するCの int32 プリミティブ。

APIが成功した場合は napi_ok を返します。数値でない napi_value が渡された場合は napi_number_expected を返します。

このAPIは、与えられたJavaScriptの number に対応するCの int32 プリミティブ値を返します。

数値が32ビット整数の範囲を超える場合、結果は下位32ビットに相当するように切り捨てられます。これにより、値が 2³¹ - 1 より大きい場合、大きな正の数が負の数になる可能性があります。

非有限数（NaN、+Infinity、または -Infinity）は、結果をゼロに設定します。

napi_get_value_int64#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの number を表す napi_value。
• [out] result: 指定されたJavaScriptの number に対応するCの int64 プリミティブ。

APIが成功した場合は napi_ok を返します。数値でない napi_value が渡された場合は napi_number_expected を返します。

このAPIは、与えられたJavaScriptの number に対応するCの int64 プリミティブ値を返します。

Number.MIN_SAFE_INTEGER -(2**53 - 1) から Number.MAX_SAFE_INTEGER (2**53 - 1) の範囲外の number 値は精度を失います。

非有限数（NaN、+Infinity、または -Infinity）は、結果をゼロに設定します。

napi_get_value_string_latin1#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの文字列を表す napi_value。
• [in] buf: ISO-8859-1でエンコードされた文字列を書き込むバッファ。NULL が渡された場合、文字列の長さ（バイト単位、ヌル終端文字を除く）が result に返されます。
• [in] bufsize: 宛先バッファのサイズ。この値が不十分な場合、返される文字列は切り詰められ、ヌル終端されます。この値がゼロの場合、文字列は返されず、バッファに変更は加えられません。
• [out] result: バッファにコピーされたバイト数（ヌル終端文字を除く）。

APIが成功した場合は napi_ok を返します。string でない napi_value が渡された場合は napi_string_expected を返します。

このAPIは、渡された値に対応するISO-8859-1エンコードの文字列を返します。

napi_get_value_string_utf8#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの文字列を表す napi_value。
• [in] buf: UTF8でエンコードされた文字列を書き込むバッファ。NULL が渡された場合、文字列の長さ（バイト単位、ヌル終端文字を除く）が result に返されます。
• [in] bufsize: 宛先バッファのサイズ。この値が不十分な場合、返される文字列は切り詰められ、ヌル終端されます。この値がゼロの場合、文字列は返されず、バッファに変更は加えられません。
• [out] result: バッファにコピーされたバイト数（ヌル終端文字を除く）。

APIが成功した場合は napi_ok を返します。string でない napi_value が渡された場合は napi_string_expected を返します。

このAPIは、渡された値に対応するUTF8エンコードされた文字列を返します。

napi_get_value_string_utf16#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの文字列を表す napi_value。
• [in] buf: UTF16-LEでエンコードされた文字列を書き込むバッファ。NULL が渡された場合、文字列の長さ（2バイトコード単位、ヌル終端文字を除く）が返されます。
• [in] bufsize: 宛先バッファのサイズ。この値が不十分な場合、返される文字列は切り詰められ、ヌル終端されます。この値がゼロの場合、文字列は返されず、バッファに変更は加えられません。
• [out] result: バッファにコピーされた2バイトコード単位の数（ヌル終端文字を除く）。

APIが成功した場合は napi_ok を返します。string でない napi_value が渡された場合は napi_string_expected を返します。

このAPIは、渡された値に対応するUTF16エンコードされた文字列を返します。

napi_get_value_uint32#

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

• [in] env: API が呼び出される環境。
• [in] value: JavaScriptの number を表す napi_value。
• [out] result: 与えられた napi_value に対応するCプリミティブ uint32_t。

APIが成功した場合は napi_ok を返します。数値でない napi_value が渡された場合は napi_number_expected を返します。

このAPIは、与えられた napi_value に対応するCプリミティブの uint32_t を返します。

napi_get_boolean#

napi_status napi_get_boolean(napi_env env, bool value, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [in] value: 取得するブール値。
• [out] result: 取得するJavaScript Boolean シングルトンを表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは、与えられたブール値を表すために使用されるJavaScriptのシングルトンオブジェクトを返すために使用されます。

napi_get_global#

napi_status napi_get_global(napi_env env, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [out] result: JavaScriptの global オブジェクトを表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは global オブジェクトを返します。

napi_get_null#

napi_status napi_get_null(napi_env env, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [out] result: JavaScriptの null オブジェクトを表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIは null オブジェクトを返します。

napi_get_undefined#

napi_status napi_get_undefined(napi_env env, napi_value* result) copy

• [in] env: API が呼び出される環境。
• [out] result: JavaScriptのUndefined値を表す napi_value。

API が成功した場合は napi_ok を返します。

このAPIはUndefinedオブジェクトを返します。

napi_property_attributes#

typedef enum {
  napi_default = 0,
  napi_writable = 1 << 0,
  napi_enumerable = 1 << 1,
  napi_configurable = 1 << 2,

  // Used with napi_define_class to distinguish static properties
  // from instance properties. Ignored by napi_define_properties.
  napi_static = 1 << 10,

  // Default for class methods.
  napi_default_method = napi_writable | napi_configurable,

  // Default for object properties, like in JS obj[prop].
  napi_default_jsproperty = napi_writable |
                          napi_enumerable |
                          napi_configurable,
} napi_property_attributes; copy

napi_property_attributes は、JavaScriptオブジェクトに設定されたプロパティの動作を制御するために使用されるビットフラグです。napi_static を除き、これらはECMAScript言語仕様のセクション プロパティ属性にリストされている属性に対応します。これらは、以下のビットフラグの1つまたは複数です。

• napi_default: プロパティに明示的な属性は設定されません。デフォルトでは、プロパティは読み取り専用で、列挙不可、設定不可です。
• napi_writable: プロパティは書き込み可能です。
• napi_enumerable: プロパティは列挙可能です。
• napi_configurable: ECMAScript言語仕様のセクション プロパティ属性で定義されているように、プロパティは設定可能です。
• napi_static: プロパティは、デフォルトのインスタンスプロパティとは対照的に、クラスの静的プロパティとして定義されます。これは napi_define_class によってのみ使用されます。napi_define_properties では無視されます。
• napi_default_method: JSクラスのメソッドのように、プロパティは設定可能で書き込み可能ですが、列挙不可です。
• napi_default_jsproperty: JavaScriptでの代入によって設定されたプロパティのように、プロパティは書き込み可能、列挙可能、設定可能です。

napi_property_descriptor#

typedef struct {
  // One of utf8name or name should be NULL.
  const char* utf8name;
  napi_value name;

  napi_callback method;
  napi_callback getter;
  napi_callback setter;
  napi_value value;

  napi_property_attributes attributes;
  void* data;
} napi_property_descriptor; copy

• utf8name: プロパティのキーを記述するオプションの文字列で、UTF8でエンコードされます。プロパティには utf8name または name のいずれかを提供する必要があります。
• name: プロパティのキーとして使用されるJavaScriptの文字列またはシンボルを指すオプションの napi_value。プロパティには utf8name または name のいずれかを提供する必要があります。
• value: プロパティがデータプロパティの場合に、プロパティのgetアクセスによって取得される値。これが渡された場合、getter、setter、method、および data を NULL に設定します（これらのメンバーは使用されないため）。
• getter: プロパティのgetアクセスが実行されたときに呼び出される関数。これを渡す場合は、value と method を NULL に設定してください（これらのメンバーは使用されないため）。指定された関数は、プロパティがJavaScriptコードからアクセスされたとき（またはNode-API呼び出しを使用してプロパティのgetが実行されたとき）にランタイムによって暗黙的に呼び出されます。napi_callback で詳細を説明します。
• setter: プロパティのsetアクセスが実行されたときに呼び出される関数。これを渡す場合は、value と method を NULL に設定してください（これらのメンバーは使用されないため）。指定された関数は、プロパティがJavaScriptコードから設定されたとき（またはNode-API呼び出しを使用してプロパティのsetが実行されたとき）にランタイムによって暗黙的に呼び出されます。napi_callback で詳細を説明します。
• method: これを設定して、プロパティ記述子オブジェクトの value プロパティを method で表されるJavaScript関数にします。これを渡す場合は、value、getter、setter を NULL に設定してください（これらのメンバーは使用されないため）。napi_callback で詳細を説明します。
• attributes: 特定のプロパティに関連付けられた属性です。napi_property_attributes を参照してください。
• data: この関数が呼び出された場合に method、getter、setter に渡されるコールバックデータです。

napi_get_property_names#

napi_status napi_get_property_names(napi_env env,
                                    napi_value object,
                                    napi_value* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを取得するオブジェクトです。
• [out] result: オブジェクトのプロパティ名を表す JavaScript 値の配列を表す napi_value です。napi_get_array_length と napi_get_element を使用して result を反復処理できます。

API が成功した場合は napi_ok を返します。

この API は object の列挙可能なプロパティの名前を文字列の配列として返します。object のキーがシンボルであるプロパティは含まれません。

napi_get_all_property_names#

napi_get_all_property_names(napi_env env,
                            napi_value object,
                            napi_key_collection_mode key_mode,
                            napi_key_filter key_filter,
                            napi_key_conversion key_conversion,
                            napi_value* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを取得するオブジェクトです。
• [in] key_mode: プロトタイプのプロパティも取得するかどうか。
• [in] key_filter: どのプロパティを取得するか (列挙可能/読み取り可能/書き込み可能)。
• [in] key_conversion: 番号付きプロパティキーを文字列に変換するかどうか。
• [out] result: オブジェクトのプロパティ名を表す JavaScript 値の配列を表す napi_value です。napi_get_array_length と napi_get_element を使用して result を反復処理できます。

API が成功した場合は napi_ok を返します。

この API はこのオブジェクトの利用可能なプロパティの名前を含む配列を返します。

napi_set_property#

napi_status napi_set_property(napi_env env,
                              napi_value object,
                              napi_value key,
                              napi_value value); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを設定するオブジェクトです。
• [in] key: 設定するプロパティの名前です。
• [in] value: プロパティの値です。

API が成功した場合は napi_ok を返します。

この API は渡された Object にプロパティを設定します。

napi_get_property#

napi_status napi_get_property(napi_env env,
                              napi_value object,
                              napi_value key,
                              napi_value* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを取得するオブジェクトです。
• [in] key: 取得するプロパティの名前です。
• [out] result: プロパティの値です。

API が成功した場合は napi_ok を返します。

この API は渡された Object から要求されたプロパティを取得します。

napi_has_property#

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

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: クエリ対象のオブジェクトです。
• [in] key: 存在を確認するプロパティの名前です。
• [out] result: プロパティがオブジェクトに存在するかどうか。

API が成功した場合は napi_ok を返します。

この API は渡された Object に指定された名前のプロパティがあるかどうかをチェックします。

napi_delete_property#

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

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: クエリ対象のオブジェクトです。
• [in] key: 削除するプロパティの名前です。
• [out] result: プロパティの削除が成功したかどうか。result は NULL を渡すことで任意に無視できます。

API が成功した場合は napi_ok を返します。

この API は object から key の自身のプロパティを削除しようとします。

napi_has_own_property#

napi_status napi_has_own_property(napi_env env,
                                  napi_value object,
                                  napi_value key,
                                  bool* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: クエリ対象のオブジェクトです。
• [in] key: 存在を確認する自身のプロパティの名前です。
• [out] result: 自身のプロパティがオブジェクトに存在するかどうか。

API が成功した場合は napi_ok を返します。

この API は渡された Object に指定された名前の自身のプロパティがあるかどうかをチェックします。key は string または symbol でなければならず、そうでなければエラーがスローされます。Node-API はデータ型間の変換を行いません。

napi_set_named_property#

napi_status napi_set_named_property(napi_env env,
                                    napi_value object,
                                    const char* utf8Name,
                                    napi_value value); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを設定するオブジェクトです。
• [in] utf8Name: 設定するプロパティの名前です。
• [in] value: プロパティの値です。

API が成功した場合は napi_ok を返します。

このメソッドは、utf8Name として渡された文字列から作成された napi_value を使用して napi_set_property を呼び出すことと等価です。

napi_get_named_property#

napi_status napi_get_named_property(napi_env env,
                                    napi_value object,
                                    const char* utf8Name,
                                    napi_value* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを取得するオブジェクトです。
• [in] utf8Name: 取得するプロパティの名前です。
• [out] result: プロパティの値です。

API が成功した場合は napi_ok を返します。

このメソッドは、utf8Name として渡された文字列から作成された napi_value を使用して napi_get_property を呼び出すことと等価です。

napi_has_named_property#

napi_status napi_has_named_property(napi_env env,
                                    napi_value object,
                                    const char* utf8Name,
                                    bool* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: クエリ対象のオブジェクトです。
• [in] utf8Name: 存在を確認するプロパティの名前です。
• [out] result: プロパティがオブジェクトに存在するかどうか。

API が成功した場合は napi_ok を返します。

このメソッドは、utf8Name として渡された文字列から作成された napi_value を使用して napi_has_property を呼び出すことと等価です。

napi_set_element#

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

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを設定するオブジェクトです。
• [in] index: 設定するプロパティのインデックスです。
• [in] value: プロパティの値です。

API が成功した場合は napi_ok を返します。

この API は渡された Object に要素を設定します。

napi_get_element#

napi_status napi_get_element(napi_env env,
                             napi_value object,
                             uint32_t index,
                             napi_value* result); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを取得するオブジェクトです。
• [in] index: 取得するプロパティのインデックスです。
• [out] result: プロパティの値です。

API が成功した場合は napi_ok を返します。

この API は要求されたインデックスの要素を取得します。

napi_has_element#

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

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: クエリ対象のオブジェクトです。
• [in] index: 存在を確認するプロパティのインデックスです。
• [out] result: プロパティがオブジェクトに存在するかどうか。

API が成功した場合は napi_ok を返します。

この API は渡された Object が要求されたインデックスに要素を持つかどうかを返します。

napi_delete_element#

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

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: クエリ対象のオブジェクトです。
• [in] index: 削除するプロパティのインデックスです。
• [out] result: 要素の削除が成功したかどうか。result は NULL を渡すことで任意に無視できます。

API が成功した場合は napi_ok を返します。

この API は object から指定された index を削除しようとします。

napi_define_properties#

napi_status napi_define_properties(napi_env env,
                                   napi_value object,
                                   size_t property_count,
                                   const napi_property_descriptor* properties); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: プロパティを取得するオブジェクトです。
• [in] property_count: properties 配列内の要素の数です。
• [in] properties: プロパティ記述子の配列です。

API が成功した場合は napi_ok を返します。

このメソッドは、指定されたオブジェクトに複数のプロパティを効率的に定義することができます。プロパティはプロパティ記述子を使用して定義されます ( napi_property_descriptor を参照してください)。このようなプロパティ記述子の配列が与えられると、この API は DefineOwnProperty() (ECMA-262 仕様の セクション DefineOwnProperty で説明) によって定義されるように、オブジェクトにプロパティを 1 つずつ設定します。

napi_object_freeze#

napi_status napi_object_freeze(napi_env env,
                               napi_value object); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: 凍結するオブジェクトです。

API が成功した場合は napi_ok を返します。

このメソッドは指定されたオブジェクトを凍結します。これにより、新しいプロパティの追加、既存のプロパティの削除、既存のプロパティの列挙可能性、設定可能性、または書き込み可能性の変更が防止され、既存のプロパティの値の変更も防止されます。また、オブジェクトのプロトタイプが変更されることも防ぎます。これは ECMA-262 仕様の セクション 19.1.2.6 で説明されています。

napi_object_seal#

napi_status napi_object_seal(napi_env env,
                             napi_value object); copy

• [in] env: Node-API 呼び出しが実行される環境。
• [in] object: シールするオブジェクトです。

API が成功した場合は napi_ok を返します。

このメソッドは指定されたオブジェクトをシールします。これにより、新しいプロパティの追加が防止され、既存のすべてのプロパティが設定不可能としてマークされます。これは ECMA-262 仕様の セクション 19.1.2.20 で説明されています。

node_api_post_finalizer#

napi_status node_api_post_finalizer(node_api_basic_env env,
                                    napi_finalize finalize_cb,
                                    void* finalize_data,
                                    void* finalize_hint); copy

• [in] env: API が呼び出される環境。
• [in] finalize_cb: JavaScript オブジェクトがガベージコレクションされたときにネイティブデータを解放するために使用されるネイティブコールバックです。napi_finalize は詳細を提供します。
• [in] finalize_data: finalize_cb に渡されるオプションのデータです。
• [in] finalize_hint: ファイナライズコールバックに渡されるオプションのコンテキストヒントです。

API が成功した場合は napi_ok を返します。

イベントループで非同期に呼び出される napi_finalize コールバックをスケジュールします。

通常、ファイナライザは GC（ガベージコレクタ）がオブジェクトを収集する間に呼び出されます。その時点で、GC の状態に変更を引き起こす可能性のある Node-API を呼び出すことは無効になり、Node.js がクラッシュします。

node_api_post_finalizer は、アドオンがそのような Node-API の呼び出しを GC のファイナライズ以外の時点まで延期できるようにすることで、この制限を回避するのに役立ちます。