Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update addons.md to consider the build type
When running:
$ rm test/addons/.docbuildstamp
$ make test/addons/.docbuildstamp

A numder of JavaScript test files are generated. These have hard codes
paths to build/Release/addons. This commit updates these paths to
consider the type of build being performed.
  • Loading branch information
danbev committed Oct 1, 2016
commit 0c3ddf8c85930351db694ae7a61285f4bd175300
27 changes: 18 additions & 9 deletions doc/api/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,8 @@ Once built, the binary Addon can be used from within Node.js by pointing

```js
// hello.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

console.log(addon.hello()); // 'world'
```
Expand Down Expand Up @@ -316,7 +317,8 @@ Once compiled, the example Addon can be required and used from within Node.js:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

console.log('This should be eight:', addon.add(3, 5));
```
Expand Down Expand Up @@ -369,7 +371,8 @@ To test it, run the following JavaScript:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

addon((msg) => {
console.log(msg); // 'hello world'
Expand Down Expand Up @@ -419,7 +422,8 @@ To test it in JavaScript:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

var obj1 = addon('hello');
var obj2 = addon('world');
Expand Down Expand Up @@ -477,7 +481,8 @@ To test:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

var fn = addon();
console.log(fn()); // 'hello world'
Expand Down Expand Up @@ -639,7 +644,8 @@ Test it with:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

var obj = new addon.MyObject(10);
console.log(obj.plusOne()); // 11
Expand Down Expand Up @@ -831,7 +837,8 @@ Test it with:

```js
// test.js
const createObject = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const createObject = require(`./build/${buildType}/addon`);

var obj = createObject(10);
console.log(obj.plusOne()); // 11
Expand Down Expand Up @@ -1007,7 +1014,8 @@ Test it with:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);

var obj1 = addon.createObject(10);
var obj2 = addon.createObject(20);
Expand Down Expand Up @@ -1091,7 +1099,8 @@ Test in JavaScript by running:

```js
// test.js
const addon = require('./build/Release/addon');
const buildType = process.config.target_defaults.default_configuration;
const addon = require(`./build/${buildType}/addon`);
```

[bindings]: https://github.com/TooTallNate/node-bindings
Expand Down