node-addon-api

What are node-addon-api's main functionalities?

Napi::ObjectReference MyClass::constructor;

MyClass::MyClass(const Napi::CallbackInfo& info) : Napi::ObjectWrap<MyClass>(info) {
  // constructor implementation
}

Napi::Object MyClass::Init(Napi::Env env, Napi::Object exports) {
  Napi::HandleScope scope(env);

  Napi::Function func = DefineClass(env, "MyClass", {
    InstanceMethod("myMethod", &MyClass::MyMethod)
  });

  constructor = Napi::Persistent(func);
  constructor.SuppressDestruct();

  exports.Set("MyClass", func);
  return exports;
}

Napi::Value MyFunction(const Napi::CallbackInfo& info) {
  Napi::Env env = info.Env();
  if (info.Length() < 2) {
    Napi::TypeError::New(env, "Expected at least two arguments").ThrowAsJavaScriptException();
  }

  Napi::String arg0 = info[0].As<Napi::String>();
  double arg1 = info[1].As<Napi::Number>().DoubleValue();

  // function implementation

  return Napi::String::New(env, "result");
}

class MyAsyncWorker : public Napi::AsyncWorker {
public:
  MyAsyncWorker(Napi::Function& callback) : AsyncWorker(callback) {}

  void Execute() override {
    // Do work in another thread
  }

  void OnOK() override {
    Napi::HandleScope scope(Env());
    Callback().Call({Env().Null(), Napi::String::New(Env(), "Success")});
  }
};

Napi::Value RunAsyncWork(const Napi::CallbackInfo& info) {
  Napi::Function callback = info[0].As<Napi::Function>();
  MyAsyncWorker* worker = new MyAsyncWorker(callback);
  worker->Queue();
  return info.Env().Undefined();
}

2018-10-03 Version 1.5.0, @NickNaso

Notable changes:

Documentation

• Completed the documentation to cover all the API surface.
• Numerous fixes to make documentation more consistent in all of its parts.

API

• Add Napi::AsyncContext class to handle asynchronous operation.
• Add Napi::BigInt class to work with BigInt type.
• Add Napi::VersionManagement class to retrieve the versions of Node.js and N-API.
• Fix potential memory leaks.
• DataView feature is enabled by default
• Add descriptor for Symbols
• Add new methods on Napi::FunctionReference.
• Add the possibility to retrieve the environment on Napi::Promise::Deferred

TOOL

• Add tool to check if a native add-on is built using N-API

TEST

• Start to increase the test coverage
• Fix in the test suite to better handle the experimental features that are not yet backported in the previous Node.js version.

Commits

• [2009c019af] - Merge pull request #292 from devsnek/feature/bigint (Gus Caplan)
• [e44aca985e] - add bigint class (Gus Caplan)
• [a3951ab973] - Add documentation for Env(). (Rolf Timmermans) #318
• [a6f7a6ad51] - Add Env() to Promise::Deferred. (Rolf Timmermans)
• [0097e96b92] - Fixed broken links for Symbol and String (NickNaso)
• [b0ecd38d76] - Fix Code of conduct link properly (#323) (Jake Yoon) #323
• [223474900f] - doc: update Version management (Dongjin Na) #360
• [4f76262a10] - doc: some fix on Napi::Boolean documentation (NickNaso) #354
• [78374f72d2] - doc: number documentation (NickNaso) #356
• [51ffe453f8] - doc: doc cleanup (NickNaso) #353
• [fc11c944b2] - doc: major doc cleanup (NickNaso) #335
• [100d0a7cb2] - doc: first pass on objectwrap documentation (NickNaso) #321
• [c7d54180ff] - doc: the Napi::ObjectWrap example does not compile (Arnaud Botella) #339
• [7cdd78726a] - doc: added cpp highlight for string.md (Jaeseok Yoon) #329
• [8ed29f547c] - doc: add blurb about ABI stability (Gabriel Schulhof) #326
• [757eb1f5a3] - doc: add function and function reference doc (NickNaso) #299
• [2885c18591] - doc: Create changelog for release 1.4.0 (Nicola Del Gobbo)
• [917bd60baa] - src: remove TODOs by fixing memory leaks (Gabriel Schulhof) #343
• [dfcb93945f] - src: implement AsyncContext class (Jinho Bang) #252
• [211ed38d0d] - src: make 'nothing' target a static library (Gabriel Schulhof) #348
• [97c4ab5cf2] - src: add Call and MakeCallback that accept cargs (NickNaso) #344
• [b6e2d92c09] - src: enable DataView feature by default (Jinho) #331
• [0a00e7c97b] - src: implement missing descriptor defs for symbols (Philipp Renoth) #280
• [38e01b7e3b] - src: first pass on adding version management apis (NickNaso) #325
• [79ee8381d2] - src: fix compile failure in test (Michael Dawson) #345
• [4d92a6066f] - src: Add ObjectReference test case (Anisha Rohra) #212
• [779560f397] - test: add operator overloading tests in Number (Your Name) #355
• [73fed84ceb] - test: add ability to control experimental tests (Michael Dawson) #350
• [14c69abd46] - test: write tests for Boolean class (Jaeseok Yoon) #328
• [2ad47a83b1] - test: explicitly cast to uint32_t in test (Gabriel Schulhof) #341
• [622ffaea76] - test: Tighten up compiler warnings (Mikhail Cheshkov) #315
• [fd3c37b0f2] - tools: add tool to check for N-API modules (Gabriel Schulhof) #346