Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

nan

nodejs55.2mMIT2.22.0

Native Abstractions for Node.js: C++ header for Node 0.8 -> 23 compatibility

readme

Native Abstractions for Node.js

A header file filled with macro and utility goodness for making add-on development for Node.js easier across versions 0.8, 0.10, 0.12, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22 and 23.

Current version: 2.22.0

(See CHANGELOG.md for complete ChangeLog)

NPM NPM

Build Status Build status

Thanks to the crazy changes in V8 (and some in Node core), keeping native addons compiling happily across versions, particularly 0.10 to 0.12 to 4.0, is a minor nightmare. The goal of this project is to store all logic necessary to develop native Node.js addons without having to inspect NODE_MODULE_VERSION and get yourself into a macro-tangle.

This project also contains some helper utilities that make addon development a bit more pleasant.

News & Updates

Usage

Simply add NAN as a dependency in the package.json of your Node addon:

$ npm install --save nan

Pull in the path to NAN in your binding.gyp so that you can use #include <nan.h> in your .cpp files:

"include_dirs" : [
    "<!(node -e \"require('nan')\")"
]

This works like a -I<path-to-NAN> when compiling your addon.

Example

Just getting started with Nan? Take a look at the Node Add-on Examples.

Refer to a quick-start Nan Boilerplate for a ready-to-go project that utilizes basic Nan functionality.

For a simpler example, see the async pi estimation example in the examples directory for full code and an explanation of what this Monte Carlo Pi estimation example does. Below are just some parts of the full example that illustrate the use of NAN.

Yet another example is nan-example-eol. It shows newline detection implemented as a native addon.

Also take a look at our comprehensive C++ test suite which has a plethora of code snippets for your pasting pleasure.

API

Additional to the NAN documentation below, please consult:

JavaScript-accessible methods

A template is a blueprint for JavaScript functions and objects in a context. You can use a template to wrap C++ functions and data structures within JavaScript objects so that they can be manipulated from JavaScript. See the V8 Embedders Guide section on Templates for further information.

In order to expose functionality to JavaScript via a template, you must provide it to V8 in a form that it understands. Across the versions of V8 supported by NAN, JavaScript-accessible method signatures vary widely, NAN fully abstracts method declaration and provides you with an interface that is similar to the most recent V8 API but is backward-compatible with older versions that still use the now-deceased v8::Argument type.

Scopes

A local handle is a pointer to an object. All V8 objects are accessed using handles, they are necessary because of the way the V8 garbage collector works.

A handle scope can be thought of as a container for any number of handles. When you've finished with your handles, instead of deleting each one individually you can simply delete their scope.

The creation of HandleScope objects is different across the supported versions of V8. Therefore, NAN provides its own implementations that can be used safely across these.

Also see the V8 Embedders Guide section on Handles and Garbage Collection.

Persistent references

An object reference that is independent of any HandleScope is a persistent reference. Where a Local handle only lives as long as the HandleScope in which it was allocated, a Persistent handle remains valid until it is explicitly disposed.

Due to the evolution of the V8 API, it is necessary for NAN to provide a wrapper implementation of the Persistent classes to supply compatibility across the V8 versions supported.

Also see the V8 Embedders Guide section on Handles and Garbage Collection.

New

NAN provides a Nan::New() helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.

Converters

NAN contains functions that convert v8::Values to other v8::Value types and native types. Since type conversion is not guaranteed to succeed, they return Nan::Maybe types. These converters can be used in place of value->ToX() and value->XValue() (where X is one of the types, e.g. Boolean) in a way that provides a consistent interface across V8 versions. Newer versions of V8 use the new v8::Maybe and v8::MaybeLocal types for these conversions, older versions don't have this functionality so it is provided by NAN.

Maybe Types

The Nan::MaybeLocal and Nan::Maybe types are monads that encapsulate v8::Local handles that may be empty.

Script

NAN provides v8::Script helpers as the API has changed over the supported versions of V8.

JSON

The JSON object provides the C++ versions of the methods offered by the JSON object in javascript. V8 exposes these methods via the v8::JSON object.

Refer to the V8 JSON object in the V8 documentation for more information about these methods and their arguments.

Errors

NAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.

Note that an Error object is simply a specialized form of v8::Value.

Also consult the V8 Embedders Guide section on Exceptions for more information.

Buffers

NAN's node::Buffer helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.

Nan::Callback

Nan::Callback makes it easier to use v8::Function handles as callbacks. A class that wraps a v8::Function handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.

Asynchronous work helpers

Nan::AsyncWorker, Nan::AsyncProgressWorker and Nan::AsyncProgressQueueWorker are helper classes that make working with asynchronous code easier.

Strings & Bytes

Miscellaneous string & byte encoding and decoding functionality provided for compatibility across supported versions of V8 and Node. Implemented by NAN to ensure that all encoding types are supported, even for older versions of Node where they are missing.

Object Wrappers

The ObjectWrap class can be used to make wrapped C++ objects and a factory of wrapped objects.

V8 internals

The hooks to access V8 internals—including GC and statistics—are different across the supported versions of V8, therefore NAN provides its own hooks that call the appropriate V8 methods.

Miscellaneous V8 Helpers

Miscellaneous Node Helpers

Tests

To run the NAN tests do:

npm install
npm run-script rebuild-tests
npm test

Or just:

npm install
make test

Known issues

Compiling against Node.js 0.12 on OSX

With new enough compilers available on OSX, the versions of V8 headers corresponding to Node.js 0.12 do not compile anymore. The error looks something like:

❯   CXX(target) Release/obj.target/accessors/cpp/accessors.o
In file included from ../cpp/accessors.cpp:9:
In file included from ../../nan.h:51:
In file included from /Users/ofrobots/.node-gyp/0.12.18/include/node/node.h:61:
/Users/ofrobots/.node-gyp/0.12.18/include/node/v8.h:5800:54: error: 'CreateHandle' is a protected member of 'v8::HandleScope'
  return Handle<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(
                                        ~~~~~~~~~~~~~^~~~~~~~~~~~

This can be worked around by patching your local versions of v8.h corresponding to Node 0.12 to make v8::Handle a friend of v8::HandleScope. Since neither Node.js not V8 support this release line anymore this patch cannot be released by either project in an official release.

For this reason, we do not test against Node.js 0.12 on OSX in this project's CI. If you need to support that configuration, you will need to either get an older compiler, or apply a source patch to the version of V8 headers as a workaround.

Governance & Contributing

NAN is governed by the Node.js Addon API Working Group

Addon API Working Group (WG)

The NAN project is jointly governed by a Working Group which is responsible for high-level guidance of the project.

Members of the WG are also known as Collaborators, there is no distinction between the two, unlike other Node.js projects.

The WG has final authority over this project including:

  • Technical direction
  • Project governance and process (including this policy)
  • Contribution policy
  • GitHub repository hosting
  • Maintaining the list of additional Collaborators

For the current list of WG members, see the project README.md.

Individuals making significant and valuable contributions are made members of the WG and given commit-access to the project. These individuals are identified by the WG and their addition to the WG is discussed via GitHub and requires unanimous consensus amongst those WG members participating in the discussion with a quorum of 50% of WG members required for acceptance of the vote.

Note: If you make a significant contribution and are not considered for commit-access log an issue or contact a WG member directly.

For the current list of WG members / Collaborators, see the project README.md.

Consensus Seeking Process

The WG follows a Consensus Seeking decision making model.

Modifications of the contents of the NAN repository are made on a collaborative basis. Anybody with a GitHub account may propose a modification via pull request and it will be considered by the WG. All pull requests must be reviewed and accepted by a WG member with sufficient expertise who is able to take full responsibility for the change. In the case of pull requests proposed by an existing WG member, an additional WG member is required for sign-off. Consensus should be sought if additional WG members participate and there is disagreement around a particular modification.

If a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

WG Members / Collaborators

Rod VaggGitHub/rvaggTwitter/@rvagg
Benjamin ByholmGitHub/kkoopa-
Trevor NorrisGitHub/trevnorrisTwitter/@trevnorris
Nathan RajlichGitHub/TooTallNateTwitter/@TooTallNate
Brett LawsonGitHub/brett19Twitter/@brett19x
Ben NoordhuisGitHub/bnoordhuisTwitter/@bnoordhuis
David SiegelGitHub/agnatTwitter/@agnat
Michael Ira KrufkyGitHub/mkrufkyTwitter/@mkrufky

Copyright (c) 2018 NAN WG Members / Collaborators (listed above).

Native Abstractions for Node.js is licensed under an MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

changelog

NAN ChangeLog

Version 2.22.0: current Node 22.9.0, Node 0.12: 0.12.18, Node 0.10: 0.10.48, iojs: 3.3.1

2.22.0 Oct 11 2024

  • Feature: replace SetAccessor -> SetNativeDataProperty (#977) 6bd62c9a0004339d5d1e18a945c84929d0f6b808

2.21.0 Oct 10 2024

  • Feature: Support for node version 20.17.0 (#976) a7df36eda8a7fe8581c00a18590f5e4faafca7ae

2.20.0 Jun 12 2024

  • Feature: fix removal of v8::CopyablePersistent (#970) 5805ca5c4c2eef9a65316b68741e29f4825c511f

2.19.0 Mar 6 2024

  • Feature: Fix builds for Electron 29 (#966) 1b630ddb3412cde35b64513662b440f9fd71e1ff

2.18.0 Sep 12 2023

  • Feature: Cast v8::Object::GetInternalField() return value to v8::Value (#956) bdfee1788239f735b67fe6b46b1439da755e9b62

2.17.0 Oct 10 2022

  • Feature: overload deprecated AccessorSignatures (#943) 7f9ceb80fbc45c9ba1a10e6591ccbef9e8dee6b4

2.16.0 May 25 2022

  • Feature: Add support for Node 18 (#937) 16fa32231e2ccd89d2804b3f765319128b20c4ac

2.15.0 Aug 4 2021

  • Feature: add ScriptOrigin (#918) d09debf9eeedcb7ca4073e84ffe5fbb455ecb709

2.14.2 Oct 13 2020

  • Bugfix: fix gcc 8 function cast warning (#899) 35f0fab205574b2cbda04e6347c8b2db755e124f

2.14.1 Apr 21 2020

  • Bugfix: use GetBackingStore() instead of GetContents() (#888) 2c023bd447661a61071da318b0ff4003c3858d39

2.14.0 May 16 2019

  • Feature: Add missing methods to Nan::Maybe<T> (#852) 4e962489fb84a184035b9fa74f245f650249aca6

2.13.2 Mar 24 2019

  • Bugfix: remove usage of deprecated IsNearDeath (#842) fbaf42252af279c3d867c6b193571f9711c39847

2.13.1 Mar 14 2019

  • Bugfix: check V8 version directly instead of inferring from NMV (#840) 12f9df9f393285de8fb4a8cd01478dc4fe3b089d

2.13.0 Mar 13 2019

  • Feature: add support for node master (#831) 113c0282072e7ff4f9dfc98b432fd894b798c2c

2.12.1 Dec 18 2018

  • Bugfix: Fix build breakage with Node.js 10.0.0-10.9.0. (#833) 625e90e8fef8d39ffa7247250a76a100b2487474

2.12.0 Dec 16 2018

  • Bugfix: Add scope.Escape() to Call() (#817) 2e5ed4fc3a8ac80a6ef1f2a55099ab3ac8800dc6
  • Bugfix: Fix Node.js v10.12.0 deprecation warnings. 509859cc23b1770376b56550a027840a2ce0f73d
  • Feature: Allow SetWeak() for non-object persistent handles. (#824) e6ef6a48e7e671fe3e4b7dddaa8912a3f8262ecd

2.11.1 Sep 29 2018

  • Fix: adapt to V8 7.0 24a22c3b25eeeec2016c6ec239bdd6169e985447

2.11.0 Aug 25 2018

  • Removal: remove FunctionCallbackInfo::Callee for nodejs >= 10 1a56c0a6efd4fac944cb46c30912a8e023bda7d4
  • Bugfix: Fix AsyncProgressWorkerBase::WorkProgress sends invalid data b0c764d1dab11e9f8b37ffb81e2560a4498aad5e
  • Feature: Introduce GetCurrentEventLoop b4911b0bb1f6d47d860e10ec014d941c51efac5e
  • Feature: Add NAN_MODULE_WORKER_ENABLED macro as a replacement for NAN_MODULE b058fb047d18a58250e66ae831444441c1f2ac7a

2.10.0 Mar 16 2018

  • Deprecation: Deprecate MakeCallback 5e92b19a59e194241d6a658bd6ff7bfbda372950
  • Feature: add Nan::Call overload 4482e1242fe124d166fc1a5b2be3c1cc849fe452
  • Feature: add more Nan::Call overloads 8584e63e6d04c7d2eb8c4a664e4ef57d70bf672b
  • Feature: Fix deprecation warnings for Node 10 1caf258243b0602ed56922bde74f1c91b0cbcb6a

2.9.2 Feb 22 2018

  • Bugfix: Bandaid for async hooks 212bd2f849be14ef1b02fc85010b053daa24252b

2.9.1 Feb 22 2018

  • Bugfix: Avoid deprecation warnings in deprecated Nan::Callback::operator() 372b14d91289df4604b0f81780709708c45a9aa4
  • Bugfix: Avoid deprecation warnings in Nan::JSON 3bc294bce0b7d0a3ee4559926303e5ed4866fda2

2.9.0 Feb 22 2018

  • Deprecation: Deprecate legacy Callback::Call 6dd5fa690af61ca3523004b433304c581b3ea309
  • Feature: introduce AsyncResource class 90c0a179c0d8cb5fd26f1a7d2b1d6231eb402d48o
  • Feature: Add context aware Nan::Callback::Call functions 7169e09fb088418b6e388222e88b4c13f07ebaee
  • Feature: Make AsyncWorker context aware 066ba21a6fb9e2b5230c9ed3a6fc51f1211736a4
  • Feature: add Callback overload to Nan::Call 5328daf66e202658c1dc0d916c3aaba99b3cc606
  • Bugfix: fix warning: suggest parentheses around && within || b2bb63d68b8ae623a526b542764e1ac82319cb2c
  • Bugfix: Fix compilation on io.js 3 d06114dba0a522fb436f0c5f47b994210968cd7b

2.8.0 Nov 15 2017

  • Deprecation: Deprecate Nan::ForceSet in favor of Nan::DefineOwnProperty() 95cbb976d6fbbba88ba0f86dd188223a8591b4e7
  • Feature: Add Nan::AsyncProgressQueueWorker a976636ecc2ef617d1b061ce4a6edf39923691cb
  • Feature: Add Nan::DefineOwnProperty() 95cbb976d6fbbba88ba0f86dd188223a8591b4e7
  • Bugfix: Fix compiling on io.js 1 & 2 82705a64503ce60c62e98df5bd02972bba090900
  • Bugfix: Use DefineOwnProperty instead of ForceSet 95cbb976d6fbbba88ba0f86dd188223a8591b4e7

2.7.0 Aug 30 2017

  • Feature: Add Nan::To<v8::Function>() overload. b93280670c9f6da42ed4cf6cbf085ffdd87bd65b
  • Bugfix: Fix ternary in Nan::MaybeLocal<T>::FromMaybe<S>(). 79a26f7d362e756a9524e672a82c3d603b542867

2.6.2 Apr 12 2017

  • Bugfix: Fix v8::JSON::Parse() deprecation warning. 87f6a3c65815fa062296a994cc863e2fa124867d

2.6.1 Apr 6 2017

  • Bugfix: nan_json.h: fix build breakage in Node 6 ac8d47dc3c10bfbf3f15a6b951633120c0ee6d51

2.6.0 Apr 6 2017

  • Feature: nan: add support for JSON::Parse & Stringify b533226c629cce70e1932a873bb6f849044a56c5

2.5.1 Jan 23 2017

  • Bugfix: Fix disappearing handle for private value 6a80995694f162ef63dbc9948fbefd45d4485aa0
  • Bugfix: Add missing scopes a93b8bae6bc7d32a170db6e89228b7f60ee57112
  • Bugfix: Use string::data instead of string::front in NewOneByteString d5f920371e67e1f3b268295daee6e83af86b6e50

2.5.0 Dec 21 2016

  • Feature: Support Private accessors a86255cb357e8ad8ccbf1f6a4a901c921e39a178
  • Bugfix: Abort in delete operators that shouldn't be called 0fe38215ff8581703967dfd26c12793feb960018

2.4.0 Jul 10 2016

  • Feature: Rewrite Callback to add Callback::Reset c4cf44d61f8275cd5f7b0c911d7a806d4004f649
  • Feature: AsyncProgressWorker: add template types for .send 1242c9a11a7ed481c8f08ec06316385cacc513d0
  • Bugfix: Add constness to old Persistent comparison operators bd43cb9982c7639605d60fd073efe8cae165d9b2

2.3.5 May 31 2016

  • Bugfix: Replace NAN_INLINE with 'inline' keyword. 71819d8725f822990f439479c9aba3b240804909

2.3.4 May 31 2016

  • Bugfix: Remove V8 deprecation warnings 0592fb0a47f3a1c7763087ebea8e1138829f24f9
  • Bugfix: Fix new versions not to use WeakCallbackInfo::IsFirstPass 615c19d9e03d4be2049c10db0151edbc3b229246
  • Bugfix: Make ObjectWrap::handle() const d19af99595587fe7a26bd850af6595c2a7145afc
  • Bugfix: Fix compilation errors related to 0592fb0a47f3a1c7763087ebea8e1138829f24f9 e9191c525b94f652718325e28610a1adcf90fed8

2.3.3 May 4 2016

  • Bugfix: Refactor SetMethod() to deal with v8::Templates (#566) b9083cf6d5de6ebe6bcb49c7502fbb7c0d9ddda8

2.3.2 Apr 27 2016

  • Bugfix: Fix compilation on outdated versions due to Handle removal f8b7c875d04d425a41dfd4f3f8345bc3a11e6c52

2.3.1 Apr 27 2016

  • Bugfix: Don't use deprecated v8::Template::Set() in SetMethod a90951e9ea70fa1b3836af4b925322919159100e

2.3.0 Apr 27 2016

  • Feature: added Signal() for invoking async callbacks without sending data from AsyncProgressWorker d8adba45f20e077d00561b20199133620c990b38
  • Bugfix: Don't use deprecated v8::Template::Set() 00dacf0a4b86027415867fa7f1059acc499dcece

2.2.1 Mar 29 2016

  • Bugfix: Use NewFromUnsigned in ReturnValue<T>::Set(uint32_t i) for pre_12 3a18f9bdce29826e0e4c217854bc476918241a58
  • Performance: Remove unneeeded nullptr checks b715ef44887931c94f0d1605b3b1a4156eebece9

2.2.0 Jan 9 2016

  • Feature: Add Function::Call wrapper 4c157474dacf284d125c324177b45aa5dabc08c6
  • Feature: Rename GC*logueCallback to GCCallback for > 4.0 3603435109f981606d300eb88004ca101283acec
  • Bugfix: Fix Global::Pass for old versions 367e82a60fbaa52716232cc89db1cc3f685d77d9
  • Bugfix: Remove weird MaybeLocal wrapping of what already is a MaybeLocal 23b4590db10c2ba66aee2338aebe9751c4cb190b

2.1.0 Oct 8 2015

  • Deprecation: Deprecate NanErrnoException in favor of ErrnoException 0af1ca4cf8b3f0f65ed31bc63a663ab3319da55c
  • Feature: added helper class for accessing contents of typedarrays 17b51294c801e534479d5463697a73462d0ca555
  • Feature: [Maybe types] Add MakeMaybe(...) 48d7b53d9702b0c7a060e69ea10fea8fb48d814d
  • Feature: new: allow utf16 string with length 66ac6e65c8ab9394ef588adfc59131b3b9d8347b
  • Feature: Introduce SetCallHandler and SetCallAsFunctionHandler 7764a9a115d60ba10dc24d86feb0fbc9b4f75537
  • Bugfix: Enable creating Locals from Globals under Node 0.10. 9bf9b8b190821af889790fdc18ace57257e4f9ff
  • Bugfix: Fix issue #462 where PropertyCallbackInfo data is not stored safely. 55f50adedd543098526c7b9f4fffd607d3f9861f

2.0.9 Sep 8 2015

  • Bugfix: EscapableHandleScope in Nan::NewBuffer for Node 0.8 and 0.10 b1654d7

2.0.8 Aug 28 2015

  • Work around duplicate linking bug in clang 11902da

2.0.7 Aug 26 2015

  • Build: Repackage

2.0.6 Aug 26 2015

  • Bugfix: Properly handle null callback in FunctionTemplate factory 6e99cb1
  • Bugfix: Remove unused static std::map instances 525bddc
  • Bugfix: Make better use of maybe versions of APIs bfba85b
  • Bugfix: Fix shadowing issues with handle in ObjectWrap 0a9072d

2.0.5 Aug 10 2015

  • Bugfix: Reimplement weak callback in ObjectWrap 98d38c1
  • Bugfix: Make sure callback classes are not assignable, copyable or movable 81f9b1d

2.0.4 Aug 6 2015

  • Build: Repackage

2.0.3 Aug 6 2015

  • Bugfix: Don't use clang++ / g++ syntax extension. 231450e

2.0.2 Aug 6 2015

  • Build: Repackage

2.0.1 Aug 6 2015

  • Bugfix: Add workaround for missing REPLACE_INVALID_UTF8 60d6687
  • Bugfix: Reimplement ObjectWrap from scratch to prevent memory leaks 6484601
  • Bugfix: Fix Persistent leak in FunctionCallbackInfo and PropertyCallbackInfo 641ef5f
  • Bugfix: Add missing overload for Nan::NewInstance that takes argc/argv 29450ed

2.0.0 Jul 31 2015

  • Change: Renamed identifiers with leading underscores b5932b4
  • Change: Replaced NanObjectWrapHandle with class NanObjectWrap 464f1e1
  • Change: Replace NanScope and NanEscpableScope macros with classes 47751c4
  • Change: Rename NanNewBufferHandle to NanNewBuffer 6745f99
  • Change: Rename NanBufferUse to NanNewBuffer 3e8b0a5
  • Change: Rename NanNewBuffer to NanCopyBuffer d6af78d
  • Change: Remove Nan prefix from all names 72d1f67
  • Change: Update Buffer API for new upstream changes d5d3291
  • Change: Rename Scope and EscapableScope to HandleScope and EscapableHandleScope 21a7a6a
  • Change: Get rid of Handles e6c0daf
  • Feature: Support io.js 3 with V8 4.4
  • Feature: Introduce NanPersistent 7fed696
  • Feature: Introduce NanGlobal 4408da1
  • Feature: Added NanTryCatch 10f1ca4
  • Feature: Update for V8 v4.3 4b6404a
  • Feature: Introduce NanNewOneByteString c543d32
  • Feature: Introduce namespace Nan 67ed1b1
  • Removal: Remove NanLocker and NanUnlocker dd6e401
  • Removal: Remove string converters, except NanUtf8String, which now follows the node implementation b5d00a9
  • Removal: Remove NanReturn* macros d90a25c
  • Removal: Remove HasInstance e8f84fe

1.9.0 Jul 31 2015

  • Feature: Added NanFatalException 81d4a2c
  • Feature: Added more error types 4265f06
  • Feature: Added dereference and function call operators to NanCallback c4b2ed0
  • Feature: Added indexed GetFromPersistent and SaveToPersistent edd510c
  • Feature: Added more overloads of SaveToPersistent and GetFromPersistent 8b1cef6
  • Feature: Added NanErrnoException dd87d9e
  • Correctness: Prevent assign, copy, and move for classes that do not support it 1f55c59, 4b808cb, c96d9b2, fba4a29, 3357130
  • Deprecation: Deprecate NanGetPointerSafe and NanSetPointerSafe 81d4a2c
  • Deprecation: Deprecate NanBooleanOptionValue and NanUInt32OptionValue 0ad254b

1.8.4 Apr 26 2015

  • Build: Repackage

1.8.3 Apr 26 2015

  • Bugfix: Include missing header 1af8648

1.8.2 Apr 23 2015

  • Build: Repackage

1.8.1 Apr 23 2015

  • Bugfix: NanObjectWrapHandle should take a pointer 155f1d3

1.8.0 Apr 23 2015

  • Feature: Allow primitives with NanReturnValue 2e4475e
  • Feature: Added comparison operators to NanCallback 55b075e
  • Feature: Backport thread local storage 15bb7fa
  • Removal: Remove support for signatures with arguments 8a2069d
  • Correcteness: Replaced NanObjectWrapHandle macro with function 0bc6d59

1.7.0 Feb 28 2015

  • Feature: Made NanCallback::Call accept optional target 8d54da7
  • Feature: Support atom-shell 0.21 0b7f1bb

1.6.2 Feb 6 2015

  • Bugfix: NanEncode: fix argument type for node::Encode on io.js 2be8639

1.6.1 Jan 23 2015

  • Build: version bump

1.5.3 Jan 23 2015

  • Build: repackage

1.6.0 Jan 23 2015

  • Deprecated NanNewContextHandle in favor of NanNew<Context> 49259af
  • Support utility functions moved in newer v8 versions (Node 0.11.15, io.js 1.0) a0aa179
  • Added NanEncode, NanDecodeBytes and NanDecodeWrite 75e6fb9

1.5.2 Jan 23 2015

  • Bugfix: Fix non-inline definition build error with clang++ 21d96a1, 60fadd4
  • Bugfix: Readded missing String constructors 18d828f
  • Bugfix: Add overload handling NanNew<FunctionTemplate>(..) 5ef813b
  • Bugfix: Fix uv_work_cb versioning 997e4ae
  • Bugfix: Add function factory and test 4eca89c
  • Bugfix: Add object template factory and test cdcb951
  • Correctness: Lifted an io.js related typedef c9490be
  • Correctness: Make explicit downcasts of String lengths 00074e6
  • Windows: Limit the scope of disabled warning C4530 83d7deb

1.5.1 Jan 15 2015

  • Build: version bump

1.4.3 Jan 15 2015

  • Build: version bump

1.4.2 Jan 15 2015

  • Feature: Support io.js 0dbc5e8

1.5.0 Jan 14 2015

  • Feature: Support io.js b003843
  • Correctness: Improved NanNew internals 9cd4f6a
  • Feature: Implement progress to NanAsyncWorker 8d6a160

1.4.1 Nov 8 2014

  • Bugfix: Handle DEBUG definition correctly
  • Bugfix: Accept int as Boolean

1.4.0 Nov 1 2014

  • Feature: Added NAN_GC_CALLBACK 6a5c245
  • Performance: Removed unnecessary local handle creation 18a7243, 41fe2f8
  • Correctness: Added constness to references in NanHasInstance 02c61cd
  • Warnings: Fixed spurious warnings from -Wundef and -Wshadow, 541b122, 99d8cb6
  • Windoze: Shut Visual Studio up when compiling 8d558c1
  • License: Switch to plain MIT from custom hacked MIT license 11de983
  • Build: Added test target to Makefile e232e46
  • Performance: Removed superfluous scope in NanAsyncWorker f4b7821
  • Sugar/Feature: Added NanReturnThis() and NanReturnHolder() shorthands 237a5ff, d697208
  • Feature: Added suitable overload of NanNew for v8::Integer::NewFromUnsigned b27b450

1.3.0 Aug 2 2014

  • Added NanNew<v8::String, std::string>(std::string)
  • Added NanNew<v8::String, std::string&>(std::string&)
  • Added NanAsciiString helper class
  • Added NanUtf8String helper class
  • Added NanUcs2String helper class
  • Deprecated NanRawString()
  • Deprecated NanCString()
  • Added NanGetIsolateData(v8::Isolate *isolate)
  • Added NanMakeCallback(v8::Handlev8::Object target, v8::Handlev8::Function func, int argc, v8::Handlev8::Value* argv)
  • Added NanMakeCallback(v8::Handlev8::Object target, v8::Handlev8::String symbol, int argc, v8::Handlev8::Value* argv)
  • Added NanMakeCallback(v8::Handlev8::Object target, const char* method, int argc, v8::Handlev8::Value* argv)
  • Added NanSetTemplate(v8::Handlev8::Template templ, v8::Handlev8::String name , v8::Handlev8::Data value, v8::PropertyAttribute attributes)
  • Added NanSetPrototypeTemplate(v8::Localv8::FunctionTemplate templ, v8::Handlev8::String name, v8::Handlev8::Data value, v8::PropertyAttribute attributes)
  • Added NanSetInstanceTemplate(v8::Localv8::FunctionTemplate templ, const char *name, v8::Handlev8::Data value)
  • Added NanSetInstanceTemplate(v8::Localv8::FunctionTemplate templ, v8::Handlev8::String name, v8::Handlev8::Data value, v8::PropertyAttribute attributes)

1.2.0 Jun 5 2014

  • Add NanSetPrototypeTemplate
  • Changed NAN_WEAK_CALLBACK internals, switched _NanWeakCallbackData to class, introduced _NanWeakCallbackDispatcher
  • Removed -Wno-unused-local-typedefs from test builds
  • Made test builds Windows compatible ('Sleep()')

1.1.2 May 28 2014

  • Release to fix more stuff-ups in 1.1.1

1.1.1 May 28 2014

  • Release to fix version mismatch in nan.h and lack of changelog entry for 1.1.0

1.1.0 May 25 2014

  • Remove nan_isolate, use v8::Isolate::GetCurrent() internally instead
  • Additional explicit overloads for NanNew(): (char,int), (uint8_t[,int]), (uint16_t[,int), double, int, unsigned int, bool, v8::String::ExternalStringResource, v8::String::ExternalAsciiStringResource*
  • Deprecate NanSymbol()
  • Added SetErrorMessage() and ErrorMessage() to NanAsyncWorker

1.0.0 May 4 2014

  • Heavy API changes for V8 3.25 / Node 0.11.13
  • Use cpplint.py
  • Removed NanInitPersistent
  • Removed NanPersistentToLocal
  • Removed NanFromV8String
  • Removed NanMakeWeak
  • Removed NanNewLocal
  • Removed NAN_WEAK_CALLBACK_OBJECT
  • Removed NAN_WEAK_CALLBACK_DATA
  • Introduce NanNew, replaces NanNewLocal, NanPersistentToLocal, adds many overloaded typed versions
  • Introduce NanUndefined, NanNull, NanTrue and NanFalse
  • Introduce NanEscapableScope and NanEscapeScope
  • Introduce NanMakeWeakPersistent (requires a special callback to work on both old and new node)
  • Introduce NanMakeCallback for node::MakeCallback
  • Introduce NanSetTemplate
  • Introduce NanGetCurrentContext
  • Introduce NanCompileScript and NanRunScript
  • Introduce NanAdjustExternalMemory
  • Introduce NanAddGCEpilogueCallback, NanAddGCPrologueCallback, NanRemoveGCEpilogueCallback, NanRemoveGCPrologueCallback
  • Introduce NanGetHeapStatistics
  • Rename NanAsyncWorker#SavePersistent() to SaveToPersistent()

0.8.0 Jan 9 2014

  • NanDispose -> NanDisposePersistent, deprecate NanDispose
  • Extract NANRETURNTYPE, pull up NAN_()

0.7.1 Jan 9 2014

  • Fixes to work against debug builds of Node
  • Safer NanPersistentToLocal (avoid reinterpret_cast)
  • Speed up common NanRawString case by only extracting flattened string when necessary

0.7.0 Dec 17 2013

  • New no-arg form of NanCallback() constructor.
  • NanCallback#Call takes Handle rather than Local
  • Removed deprecated NanCallback#Run method, use NanCallback#Call instead
  • Split off NANARGSTYPE from NAN_ARGS
  • Restore (unofficial) Node 0.6 compatibility at NanCallback#Call()
  • Introduce NanRawString() for char* (or appropriate void*) from v8::String (replacement for NanFromV8String)
  • Introduce NanCString() for null-terminated char* from v8::String

0.6.0 Nov 21 2013

  • Introduce NanNewLocal<T>(v8::Handle<T> value) for use in place of v8::Local<T>::New(...) since v8 started requiring isolate in Node 0.11.9

0.5.2 Nov 16 2013

  • Convert SavePersistent and GetFromPersistent in NanAsyncWorker from protected and public

0.5.1 Nov 12 2013

  • Use node::MakeCallback() instead of direct v8::Function::Call()

0.5.0 Nov 11 2013

  • Added @TooTallNate as collaborator
  • New, much simpler, "include_dirs" for binding.gyp
  • Added full range of NAN_INDEX_* macros to match NAN_PROPERTY_* macros

0.4.4 Nov 2 2013

  • Isolate argument from v8::Persistent::MakeWeak removed for 0.11.8+

0.4.3 Nov 2 2013

  • Include node_object_wrap.h, removed from node.h for Node 0.11.8.

0.4.2 Nov 2 2013

  • Handle deprecation of v8::Persistent::Dispose(v8::Isolate* isolate)) for Node 0.11.8 release.

0.4.1 Sep 16 2013

  • Added explicit #include <uv.h> as it was removed from node.h for v0.11.8

0.4.0 Sep 2 2013

  • Added NAN_INLINE and NAN_DEPRECATED and made use of them
  • Added NanError, NanTypeError and NanRangeError
  • Cleaned up code

0.3.2 Aug 30 2013

  • Fix missing scope declaration in GetFromPersistent() and SaveToPersistent in NanAsyncWorker

0.3.1 Aug 20 2013

  • fix "not all control paths return a value" compile warning on some platforms

0.3.0 Aug 19 2013

  • Made NAN work with NPM
  • Lots of fixes to NanFromV8String, pulling in features from new Node core
  • Changed node::encoding to Nan::Encoding in NanFromV8String to unify the API
  • Added optional error number argument for NanThrowError()
  • Added NanInitPersistent()
  • Added NanReturnNull() and NanReturnEmptyString()
  • Added NanLocker and NanUnlocker
  • Added missing scopes
  • Made sure to clear disposed Persistent handles
  • Changed NanAsyncWorker to allocate error messages on the heap
  • Changed NanThrowError(Local<Value>) to NanThrowError(Handle<Value>)
  • Fixed leak in NanAsyncWorker when errmsg is used

0.2.2 Aug 5 2013

  • Fixed usage of undefined variable with node::BASE64 in NanFromV8String()

0.2.1 Aug 5 2013

  • Fixed 0.8 breakage, node::BUFFER encoding type not available in 0.8 for NanFromV8String()

0.2.0 Aug 5 2013

  • Added NAN_PROPERTY_GETTER, NAN_PROPERTY_SETTER, NAN_PROPERTY_ENUMERATOR, NAN_PROPERTY_DELETER, NAN_PROPERTY_QUERY
  • Extracted NANMETHOD_ARGS, NANGETTER_ARGS, NANSETTER_ARGS, NANPROPERTY_GETTER_ARGS, NANPROPERTY_SETTER_ARGS, NANPROPERTY_ENUMERATOR_ARGS, NANPROPERTY_DELETER_ARGS, NANPROPERTY_QUERY_ARGS
  • Added NanGetInternalFieldPointer, NanSetInternalFieldPointer
  • Added NAN_WEAK_CALLBACK, NAN_WEAK_CALLBACK_OBJECT, NAN_WEAK_CALLBACK_DATA, NanMakeWeak
  • Renamed THROW_ERROR to NANTHROW_ERROR
  • Added NanNewBufferHandle(char, size_t, node::smalloc::FreeCallback, void)
  • Added NanBufferUse(char*, uint32_t)
  • Added NanNewContextHandle(v8::ExtensionConfiguration*,
    v8::Handle<v8::ObjectTemplate>, v8::Handle<v8::Value>)
  • Fixed broken NanCallback#GetFunction()
  • Added optional encoding and size arguments to NanFromV8String()
  • Added NanGetPointerSafe() and NanSetPointerSafe()
  • Added initial test suite (to be expanded)
  • Allow NanUInt32OptionValue to convert any Number object

0.1.0 Jul 21 2013

  • Added NAN_GETTER, NAN_SETTER
  • Added NanThrowError with single Local<Value> argument
  • Added NanNewBufferHandle with single uint32_t argument
  • Added NanHasInstance(Persistent<FunctionTemplate>&, Handle<Value>)
  • Added Local<Function> NanCallback#GetFunction()
  • Added NanCallback#Call(int, Local<Value>[])
  • Deprecated NanCallback#Run(int, Local<Value>[]) in favour of Call