https://github.com/fcanas/node-native-boilerplate

A very small, understandable node native extension with approachable project structure
https://github.com/fcanas/node-native-boilerplate

Last synced: 11 days ago
JSON representation

A very small, understandable node native extension with approachable project structure

• Host: GitHub
• URL: https://github.com/fcanas/node-native-boilerplate
• Owner: fcanas
• License: mit
• Created: 2015-05-24T01:32:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-11T20:34:54.000Z (4 months ago)
• Last Synced: 2024-08-05T10:15:50.523Z (3 months ago)
• Language: C++
• Homepage:
• Size: 16.6 KB
• Stars: 168
• Watchers: 8
• Forks: 50
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node Native Extension Boilerplate

[![Build Status](https://travis-ci.org/fcanas/node-native-boilerplate.svg)](https://travis-ci.org/fcanas/node-native-boilerplate)

A very approachable node native extension.

This repository serves as a nearly minimal native extension built on [Nan](https://github.com/nodejs/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](#to-run-tests).

### Working With the Extension Locally

After building:

```node

$ node

> var NativeExtension = require('./')

undefined

> NativeExtension.aString()

'This is a thing.'

> NativeExtension.aBoolean()

false

> NativeExtension.nothing()

undefined

> 

```

### To run tests:

```

$ npm test

```

or to run test continuously 

```

$ npm test -- watch

```

## The Parts

File | Contents

-------------|----------------

`NativeExtension.cc` | Represents the top level of the module. C++ constructs that are exposed to javascript are exported here

`functions.cc` | Example top-level functions. These functions demonstrate how to build and return various js types.

`index.js` | The main entry point for the node dependency

`binding.gyp` | Describes your node native extention to the build system (`node-gyp`). As you add source files to the project, you should also add them to the binding file.