GitHub - fcanas/node-native-boilerplate: A very small, understandable node native extension with approachable project structure (original) (raw)

Node Native Extension Boilerplate

A very approachable node native extension.

This repository serves as a nearly minimal native extension built on Nan with enough tooling to also make it a great starting point for more complex projects.

Building

To compile the extension for the first time, run

$ npm i
$ npm run configure
$ npm run build

All subsequent builds only need npm run build

You can confirm everything built correctly by running the test suite.

Working With the Extension Locally

After building:

$ node

var NativeExtension = require('./') undefined NativeExtension.aString() 'This is a thing.' NativeExtension.aBoolean() false NativeExtension.nothing() undefined

To run tests:

or to run test continuously

The Parts