Skip to content
Inline C++ with Node.js
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
.npmignore
LICENSE
README.md
index.js
package.json

README.md

NPM version NPM download GitHub issues GitHub license

inline-cpp

Inline C++ with Node.js

Works on: Linux, Windows, MacOS

Purpose:

  • Simplify native module prototyping. Enable native code in Node.js REPL.
  • Allow JS scripts to generate C++ code and run it dynamically.
  • Popularise NAPI usage and node-addon-api.
  • This is NOT intended to be used as native module replacement!
    If you want to publish a native module, please package it as required by node-gyp.

Installation

npm install --save inline-cpp

or install it globally (it works with Node.js REPL):

npm install -g inline-cpp

Usage

// test.js
const compile = require('inline-cpp');

const hello = compile `
  String func(const CallbackInfo& info) {
    return String::New(info.Env(), "Hello world from C++!");
  }
`

console.log(hello())

Now run it:

➜ node test.js
Hello world from C++!

The first time you run the script, it takes longer to execute. For each inline block of code, a native module will be generated, compiled with node-gyp and loaded dynamically. If the module Init function is not defined, it is generated as well.
The next time you run the script, it will reuse previously generated module, so it will run instantly (unless you change the inline C++ code).

For more C++ code examples, see node-addon-api
For more inline-cpp API examples, see examples on github

API

inline-cpp supports several invocation methods.

Pass some code as string to build it with default options.

const InlineCPP = require('inline-cpp');
InlineCPP('code')

You can also pass code using tagged template syntax.

InlineCPP `code`

Pass an object to create a new compiler with custom options.
Options will get passed to node-gyp target.

const customCompiler = InlineCPP({ ... })

If the code block only contains a single function, the compiler returns the function.
If it contains multiple functions or custom Init, the module itself is returned.

Disclaimer

This is just a prototype. I created this to check the general concept.
You're welcome to contribute! Here are some ideas:

  • Parse/Find all functions in the block of code, add them to exports
  • Use node-gyp directly, instead of invoking node node-gyp.js
  • Improve error handling/reporting
  • Create advanced usage examples
  • Cleanup unused modules from cache periodically
  • ...

Debugging

You can enable debug output by setting env. variable: DEBUG=inline-cpp

You can’t perform that action at this time.