#Env

#Contents

• Allocation
• Conversion
• Primitives
• Singletons
• Containers
• Buffers
• External handles
• Functions and references
• Promises and async
• Errors
• Version info

The N-API environment plus the per-call arena allocator.

const napi = @import("napi");

pub fn handler(env: napi.Env) !napi.Val {
    const obj = try env.createObject();
    try obj.setNamedProperty(env, "ok", try env.toJs(true));
    return obj;
}

Env is recognized by type. As the first parameter of a top-level function, the second parameter of an init, or the second parameter of a class method, it does not consume a JS argument.

#Allocation

See Memory model.

#Conversion

#Primitives

#Singletons

#Containers

#Buffers

pub const ArrayBuffer = struct {
    val: napi.Val,
    data: []u8,
};

#External handles

Pair with Val.getExternalData(env) to unwrap.

#Functions and references

#Promises and async

pub const Promise = struct {
    promise: napi.Val,
    deferred: napi.Deferred,
};

See Workers and Promises.

#Errors

After throw*, return any error from your function to abort. See Errors.

#Version info