-
-
Notifications
You must be signed in to change notification settings - Fork 488
Enable include files via package dependency #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,22 @@ | ||
# Node.js API (NAPI) C++ Wrapper | ||
# Node.js API (N-API) Package | ||
|
||
This repo contains header-only C++ wrapper classes for the C APIs for the ABI Stable Node API project (NAPI). | ||
This package contains header-only C++ wrapper classes for the ABI-stable | ||
Node.js API (N-API). | ||
|
||
See the [main project README](https://github.com/nodejs/abi-stable-node/blob/doc/README.md) for more details. | ||
To use these headers in a native module: | ||
1. Add a dependency on this package to `package.json`. | ||
2. Reference this package's include directory in `binding.gyp`: | ||
```gyp | ||
{ | ||
'target_name': 'example_module', | ||
'include_dirs': ["<!(node -p \"require('node-api').include\")"], | ||
} | ||
``` | ||
|
||
Eventually this package will also contain library code that enables | ||
backward-compatibility with use with older versions of Node.js that do | ||
not have N-API built-in. | ||
|
||
See the [main project README]( | ||
https://github.com/nodejs/abi-stable-node/blob/doc/README.md) | ||
for more details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
const include = __dirname; | ||
const isNodeApiBuiltin = process.versions.modules >= 52; | ||
|
||
module.exports = { | ||
include: include, | ||
isNodeApiBuiltin: isNodeApiBuiltin, | ||
}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{ | ||
"bugs": { | ||
"url": "https://github.com/nodejs/node-api/issues" | ||
}, | ||
"dependencies": {}, | ||
"description": "Node.js API (N-API)", | ||
"devDependencies": { | ||
}, | ||
"directories": {}, | ||
"homepage": "https://github.com/nodejs/node-api", | ||
"license": "MIT", | ||
"main": "index.js", | ||
"name": "node-api", | ||
"optionalDependencies": {}, | ||
"readme": "README.md", | ||
"repository": { | ||
"type": "git", | ||
"url": "git://github.com/nodejs/node-api.git" | ||
}, | ||
"scripts": { | ||
}, | ||
"version": "0.1.0" | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a story for versioning N-API or do we always just provide whichever version is provided by the napi header/cc?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For versions of node without N-API built-in, the N-API version will be the same as the
node-api
package version. For versions of node with N-API built-in, the N-API version will be the same as the node version. It's tricky because the former is determined at build time, while the latter is determined at run-time. This is an area we know we need to further define and document the behavior and best practices for native module developers.