Skip to content

Latest commit

 

History

History
 
 

modules

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Napa module source tree

The source codes can be organized as the structure below.

+-- napa-module-example
    +-- inc
    |   +-- example.h
    +-- lib
    |   +-- example.ts
    |   +-- tsconfig.json
    +-- napa
    |   +-- addon.cpp
    |   +-- CMakeLists.txt (cmake specific)
    |   +-- example-wrap.cpp
    |   +-- example-wrap.h
    +-- src
    |   +-- CMakeLists.txt (cmake specific)
    |   +-- example.cpp
    +-- test
    |   +-- test.ts
    |   +-- tsconfig.json
    +-- binding.gyp (gyp specific)
    +-- CMakeLists.txt (cmake specific)
    +-- package.json
    +-- README.md

How to build and test ?

For the module examples, node-gyp or cmake-js build solution is provided for your reference.

Please make sure node-gyp or cmake-js has been set up correctly at your client, then you could follow the below steps to build and test the module examples.

1. go to the directory of a module example
2. run "npm install" to build the module
3. run "npm test" to build and run the module test, as well as its unittest if any