How to expose a C++ class to JavaScript using v8pp?

Wrap your C++ class with v8pp::class_, use methods like .ctor() for constructors and .function() for member functions, then add it to a v8pp::module. The README provides a step-by-step example with class X and binding details.

v8pp vs nbind for Node.js addons: which should I choose?

v8pp offers a header-only, template-focused approach for fine-grained V8 control, while nbind might provide different abstractions. v8pp is better for complex C++ hierarchies, but nbind could be easier for rapid prototyping; check the alternatives list in the README for context.

Does v8pp support async functions or promises in bindings?

The README doesn't explicitly cover async support; v8pp binds standard C++ functions, so you may need to manually integrate V8's promise API or use callbacks for asynchronous operations, adding complexity.

How to manage memory when C++ objects are exposed to JavaScript with v8pp?

v8pp provides utilities like import_external to transfer ownership to JavaScript for deletion, or reference_external to keep C++ memory separate. This allows control over lifecycle, as shown in the external object examples.

Can I embed JavaScript in a C++ desktop app with v8pp?

Yes, use v8pp::context to create a V8 context with require() support for loading plugins, enabling embedded scripting in C++ applications, as illustrated in the context creation and script running examples.

What are the performance trade-offs of using v8pp over raw V8 API?

v8pp adds minimal runtime overhead due to its thin template layer, but compile times may increase with template instantiation. For most cases, it's efficient, but direct V8 API usage might offer marginal gains for experts.

v8pp — C++ Binding Library for V8

What is v8pp?

v8pp is a header-only C++ library that provides bindings between C++ code and the V8 JavaScript engine. It allows developers to expose C++ classes, functions, and objects to JavaScript, enabling the creation of Node.js addons or embedding JavaScript in C++ applications. The library simplifies the complex process of V8 integration with a clean, template-based API.

Target Audience

C++ developers who need to embed JavaScript (via V8) in their applications or create high-performance Node.js/io.js native addons. It's also suitable for projects requiring bidirectional communication between C++ and JavaScript.

Value Proposition

Developers choose v8pp for its header-only design, which simplifies integration, and its expressive API that reduces the verbosity of raw V8 bindings. It offers specific features like plugin loading, external object management, and inheritance support that are not always straightforward with lower-level V8 APIs.

Bind C++ functions and classes into V8 JavaScript engine

Use Cases

Best For

Creating Node.js native addons with complex C++ class hierarchies
Embedding a JavaScript runtime (V8) within a C++ application
Exposing existing C++ libraries to JavaScript with minimal boilerplate
Building plugins or extensions that load shared libraries dynamically
Developing performance-sensitive JavaScript bindings where control over memory and object lifecycle is needed
Projects that require inheritance and polymorphism between bound C++ classes in JavaScript

Not Ideal For

Projects targeting multiple JavaScript engines beyond V8 (e.g., SpiderMonkey or JavaScriptCore)
Teams with limited C++ expertise seeking higher-level abstractions like Node-API for simpler addon development
Applications requiring strict binary compatibility and avoidance of V8's frequent API breaking changes
Environments with legacy C++ compilers that do not support C++17

Pros & Cons

Pros

Header-Only Simplicity

As a header-only library, v8pp requires no separate compilation, making integration straightforward by including headers directly, as emphasized in the README's build options with V8PP_HEADER_ONLY enabled by default.

Expressive Template API

The template-based wrappers v8pp::class_ and v8pp::module reduce boilerplate for binding C++ classes and functions, with clear examples in the README showing inheritance support and property binding.

Plugin System Flexibility

v8pp includes a require() function for dynamically loading plugins from shared libraries, enabling modular architecture in embedded JavaScript contexts, as demonstrated in the context and module examples.

Node.js Addon Integration

Specifically designed for Node.js and io.js addons, v8pp provides structured exports and patterns, documented in the addons section, simplifying native extension development.

Cons

V8 API Volatility Risk

v8pp is tightly coupled to V8, which has a history of breaking API changes; this dependency can lead to maintenance burdens and compatibility issues, as hinted by the abandoned alternatives listed in the README.

C++17 Compiler Lock-In

Requires C++17 support, excluding older compilers and environments, limiting adoption in legacy systems or projects with strict toolchain constraints, as noted in the tested compilers list.

Complex Initial Setup

Setting up involves configuring V8 and CMake, which can be daunting for developers unfamiliar with V8's isolate model or C++ build systems, despite the header-only design simplifying later steps.

Sparse Documentation Depth

While functional, the documentation lacks extensive tutorials or community resources compared to more popular bindings, potentially slowing down troubleshooting and advanced usage.

Frequently Asked Questions

What is v8pp?

Target Audience

Value Proposition

Use Cases

Best For

Creating Node.js native addons with complex C++ class hierarchies
Embedding a JavaScript runtime (V8) within a C++ application
Exposing existing C++ libraries to JavaScript with minimal boilerplate
Building plugins or extensions that load shared libraries dynamically
Developing performance-sensitive JavaScript bindings where control over memory and object lifecycle is needed
Projects that require inheritance and polymorphism between bound C++ classes in JavaScript

Not Ideal For

Projects targeting multiple JavaScript engines beyond V8 (e.g., SpiderMonkey or JavaScriptCore)
Teams with limited C++ expertise seeking higher-level abstractions like Node-API for simpler addon development
Applications requiring strict binary compatibility and avoidance of V8's frequent API breaking changes
Environments with legacy C++ compilers that do not support C++17

Pros & Cons

Pros

Header-Only Simplicity

Expressive Template API

The template-based wrappers v8pp::class_ and v8pp::module reduce boilerplate for binding C++ classes and functions, with clear examples in the README showing inheritance support and property binding.

Plugin System Flexibility

Node.js Addon Integration

Specifically designed for Node.js and io.js addons, v8pp provides structured exports and patterns, documented in the addons section, simplifying native extension development.

Cons

V8 API Volatility Risk

C++17 Compiler Lock-In

Requires C++17 support, excluding older compilers and environments, limiting adoption in legacy systems or projects with strict toolchain constraints, as noted in the tested compilers list.

Complex Initial Setup

Setting up involves configuring V8 and CMake, which can be daunting for developers unfamiliar with V8's isolate model or C++ build systems, despite the header-only design simplifying later steps.

Sparse Documentation Depth

While functional, the documentation lacks extensive tutorials or community resources compared to more popular bindings, potentially slowing down troubleshooting and advanced usage.

Frequently Asked Questions

v8pp

What is v8pp?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

v8pp

What is v8pp?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?