ingescape v4.3.6

Ingescape NodeJS

Ingescape NodeJS embeds the Ingescape C library (statically linked) and uses n-api to wrap to it. prebuildify and node-gyp-build are used to prebuild the ingescape.node binary for windows, macos and linux, and to deliver the right package for all the supported operating systems.

Prerequisites

• NodeJS (https://nodejs.org/en/download/)

Installing

You can install ingescape with npm.

npm install ingescape

Two examples of ingescape agents are provided in the directory ./examples. The multiply_example is a minimal example and the echo_example is a full example.

Building your own ingescape Node package

Install prebuildify to build the package :

npm install prebuildify

Replace the paths to the static ingescape library with your owns in the binding.gyp file.

Then, build your own ingescape package :

npm run build

Your package will be built in ./prebuilds/{platform}-{arch}/node.napi.node.

Testing your own ingescape Node package

Once built, you can test your ingescape package thanks to the ./tests/test.js script. Be sure to specify correct values for network device (default is 'en0') and port (default is 5670) variables inside the script.

npm run test