Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yue/kizunapi
A set of header-only C++ classes for type conversion between C++ and JavaScript using Node-API.
https://github.com/yue/kizunapi
cpp javascript napi node-api node-module nodejs
Last synced: about 2 months ago
JSON representation
A set of header-only C++ classes for type conversion between C++ and JavaScript using Node-API.
- Host: GitHub
- URL: https://github.com/yue/kizunapi
- Owner: yue
- License: mit
- Created: 2022-06-27T12:36:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T23:42:07.000Z (4 months ago)
- Last Synced: 2024-09-07T02:53:12.665Z (4 months ago)
- Topics: cpp, javascript, napi, node-api, node-module, nodejs
- Language: C++
- Homepage:
- Size: 146 KB
- Stars: 17
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kizunapi
A set of header-only C++ classes for type conversion between C++ and JavaScript
using [Node-API](https://nodejs.org/api/n-api.html).
Kizunapi makes writing library bindings easy: you don't write wrapper code for
each API, instead you provide minimal information about types and kizunapi will
do the rest of the work via C++ type deduction.
__This project is at early stage, behavior of APIs may change without notice.__
## Usage
1. Add this module to dependencies in `package.json`:
```json
"dependencies": {
"kizunapi": "*",
}
```
2. Add include directory in `binding.gyp`:
```python
'include_dirs': ["
```
## Docs
* [Tutorial](docs/tutorial.md)
## Example
This example maps C++ classes with inheritance relationship to JavaScript
using non-intrusive APIs.
```c++
#include
// The classes to be exported to JavaScript.
class Parent {
public:
int Year() const {
return 1989;
}
};
class Child : public Parent {
public:
Child(int month, int day) : month_(month), day_(day) {}
std::string Date() const {
return std::to_string(month_) + std::to_string(day_);
}
private:
int month_;
int day_;
};
// Type information provided to kizunapi.
namespace ki {
template<>
struct Type {
static constexpr const char* name = "Parent";
static Parent* Constructor() {
return new Parent();
}
static void Destructor(Parent* ptr) {
delete ptr;
}
static void Define(napi_env env,
napi_value constructor,
napi_value prototype) {
Set(env, prototype, "year", &Parent::Year);
}
};
template<>
struct Type {
using Base = Parent;
static constexpr const char* name = "Child";
static Child* Constructor(int month, int day) {
return new Child(month, day);
}
static void Destructor(Child* ptr) {
delete ptr;
}
static void Define(napi_env env,
napi_value constructor,
napi_value prototype) {
Set(env, prototype, "date", &Child::Date);
}
};
} // namespace ki
// Export the converted constructors to JavaScript.
napi_value Init(napi_env env, napi_value exports) {
ki::Set(env, exports,
"Parent", ki::Class(),
"Child", ki::Class());
return nullptr;
}
NAPI_MODULE(NODE_GYP_MODULE_NAME, Init);
```
## Contributing
For new features, it is recommended to start an issue first before creating a
pull request.
Generally I would encourage forking if you would like to add a feature that
needs over a thousand lines, because I don't really have much time maintaining
this project. But bug reports are very welcomed.