Skip to content

Commit 0c3ddf8

Browse files
committed
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.
1 parent 846da75 commit 0c3ddf8

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

doc/api/addons.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ Once built, the binary Addon can be used from within Node.js by pointing
138138
139139
```js
140140
// hello.js
141-
const addon = require('./build/Release/addon');
141+
const buildType = process.config.target_defaults.default_configuration;
142+
const addon = require(`./build/${buildType}/addon`);
142143
143144
console.log(addon.hello()); // 'world'
144145
```
@@ -316,7 +317,8 @@ Once compiled, the example Addon can be required and used from within Node.js:
316317
317318
```js
318319
// test.js
319-
const addon = require('./build/Release/addon');
320+
const buildType = process.config.target_defaults.default_configuration;
321+
const addon = require(`./build/${buildType}/addon`);
320322
321323
console.log('This should be eight:', addon.add(3, 5));
322324
```
@@ -369,7 +371,8 @@ To test it, run the following JavaScript:
369371
370372
```js
371373
// test.js
372-
const addon = require('./build/Release/addon');
374+
const buildType = process.config.target_defaults.default_configuration;
375+
const addon = require(`./build/${buildType}/addon`);
373376
374377
addon((msg) => {
375378
console.log(msg); // 'hello world'
@@ -419,7 +422,8 @@ To test it in JavaScript:
419422
420423
```js
421424
// test.js
422-
const addon = require('./build/Release/addon');
425+
const buildType = process.config.target_defaults.default_configuration;
426+
const addon = require(`./build/${buildType}/addon`);
423427
424428
var obj1 = addon('hello');
425429
var obj2 = addon('world');
@@ -477,7 +481,8 @@ To test:
477481
478482
```js
479483
// test.js
480-
const addon = require('./build/Release/addon');
484+
const buildType = process.config.target_defaults.default_configuration;
485+
const addon = require(`./build/${buildType}/addon`);
481486
482487
var fn = addon();
483488
console.log(fn()); // 'hello world'
@@ -639,7 +644,8 @@ Test it with:
639644

640645
```js
641646
// test.js
642-
const addon = require('./build/Release/addon');
647+
const buildType = process.config.target_defaults.default_configuration;
648+
const addon = require(`./build/${buildType}/addon`);
643649

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

832838
```js
833839
// test.js
834-
const createObject = require('./build/Release/addon');
840+
const buildType = process.config.target_defaults.default_configuration;
841+
const createObject = require(`./build/${buildType}/addon`);
835842

836843
var obj = createObject(10);
837844
console.log(obj.plusOne()); // 11
@@ -1007,7 +1014,8 @@ Test it with:
10071014
10081015
```js
10091016
// test.js
1010-
const addon = require('./build/Release/addon');
1017+
const buildType = process.config.target_defaults.default_configuration;
1018+
const addon = require(`./build/${buildType}/addon`);
10111019
10121020
var obj1 = addon.createObject(10);
10131021
var obj2 = addon.createObject(20);
@@ -1091,7 +1099,8 @@ Test in JavaScript by running:
10911099
10921100
```js
10931101
// test.js
1094-
const addon = require('./build/Release/addon');
1102+
const buildType = process.config.target_defaults.default_configuration;
1103+
const addon = require(`./build/${buildType}/addon`);
10951104
```
10961105

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

0 commit comments

Comments
 (0)