diff options
| author | 8cy <[email protected]> | 2020-04-03 02:37:42 -0700 |
|---|---|---|
| committer | 8cy <[email protected]> | 2020-04-03 02:37:42 -0700 |
| commit | 60867fb030bae582082340ead7dbc7efdc2f5398 (patch) | |
| tree | 4c6a7356351be2e4914e15c4703172597c45656e /node_modules/node-addon-api/doc/env.md | |
| parent | commenting (diff) | |
| download | s5nical-60867fb030bae582082340ead7dbc7efdc2f5398.tar.xz s5nical-60867fb030bae582082340ead7dbc7efdc2f5398.zip | |
2020/04/03, 02:34, v1.2.0
Diffstat (limited to 'node_modules/node-addon-api/doc/env.md')
| -rw-r--r-- | node_modules/node-addon-api/doc/env.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/node-addon-api/doc/env.md b/node_modules/node-addon-api/doc/env.md new file mode 100644 index 0000000..9bde741 --- /dev/null +++ b/node_modules/node-addon-api/doc/env.md @@ -0,0 +1,63 @@ +# Env + +The opaque data structure containing the environment in which the request is being run. + +The Env object is usually created and passed by the Node.js runtime or node-addon-api infrastructure. + +## Methods + +### Constructor + +```cpp +Napi::Env::Env(napi_env env); +``` + +- `[in] env`: The `napi_env` environment from which to construct the `Napi::Env` object. + +### napi_env + +```cpp +operator napi_env() const; +``` + +Returns the `napi_env` opaque data structure representing the environment. + +### Global + +```cpp +Napi::Object Napi::Env::Global() const; +``` + +Returns the `Napi::Object` representing the environment's JavaScript Global Object. + +### Undefined + +```cpp +Napi::Value Napi::Env::Undefined() const; +``` + +Returns the `Napi::Value` representing the environment's JavaScript Undefined Object. + +### Null + +```cpp +Napi::Value Napi::Env::Null() const; +``` + +Returns the `Napi::Value` representing the environment's JavaScript Null Object. + +### IsExceptionPending + +```cpp +bool Napi::Env::IsExceptionPending() const; +``` + +Returns a `bool` indicating if an exception is pending in the environment. + +### GetAndClearPendingException + +```cpp +Napi::Error Napi::Env::GetAndClearPendingException(); +``` + +Returns an `Napi::Error` object representing the environment's pending exception, if any. |