Env

September 3, 2024 ยท View on GitHub

Class Napi::Env inherits from class Napi::BasicEnv.

The data structure containing the environment in which the request is being run.

The Napi::Env object is usually created and passed by the Node.js runtime or node-addon-api infrastructure.

The Napi::Env object represents an environment that has a superset of APIs when compared to Napi::BasicEnv and therefore cannot be used in basic finalizers. See Finalization for more details.

Methods

Constructor

Napi::Env::Env(napi_env env);
  • [in] env: The napi_env environment from which to construct the Napi::Env object.

napi_env

operator napi_env() const;

Returns the napi_env opaque data structure representing the environment.

Global

Napi::Object Napi::Env::Global() const;

Returns the Napi::Object representing the environment's JavaScript Global Object.

Undefined

Napi::Value Napi::Env::Undefined() const;

Returns the Napi::Value representing the environment's JavaScript Undefined Object.

Null

Napi::Value Napi::Env::Null() const;

Returns the Napi::Value representing the environment's JavaScript Null Object.

IsExceptionPending

bool Napi::Env::IsExceptionPending() const;

Returns a bool indicating if an exception is pending in the environment.

GetAndClearPendingException

Napi::Error Napi::Env::GetAndClearPendingException() const;

Returns an Napi::Error object representing the environment's pending exception, if any.

RunScript

Napi::Value Napi::Env::RunScript(____ script) const;
  • [in] script: A string containing JavaScript code to execute.

Runs JavaScript code contained in a string and returns its result.

The script can be any of the following types: