napi-rs/napi-rs
Napi Rs
napi-rs is a framework and toolkit for building high-performance native extensions for Node.js using Rust. It functions as a bridge between Rust and JavaScript runtimes, enabling the conversion of data types and the execution of native functions within a JavaScript environment.
The project provides a native binary compiler and a cross-platform module orchestrator to automate the compilation and publishing of packages across multiple operating systems and architectures. It generates corresponding JavaScript type definitions and platform-specific binaries to ensure consistent installation.
The framework covers the development of native add-ons by exposing native logic to JavaScript, managing type interoperability for memory and value exchange, and bootstrapping the necessary project structures and build scripts.
Features
- Node.js Native Addons - Provides a comprehensive framework for building high-performance native extensions for Node.js using Rust.
- Native Module Development - Provides a framework for authoring high-performance native extensions to expand Node.js runtime capabilities.
- Native Binary Toolchains - Ships a toolchain that compiles source code into platform-specific native binaries and associated JS bindings.
- Native Build Orchestrators - Provides a system for compiling and packaging Rust source code into platform-specific native binaries for Node.js.
- Native Type Bridges - Implements interfaces for transforming and bridging data types between Rust and JavaScript.
- Binary Compilation - Implements a build pipeline that transforms Rust source code into standalone native binary units for Node.js.
- Module Interface Exports - Implements mechanisms to register native methods and properties onto the public JavaScript exports object.
- FFI Type Definitions - Defines the mapping between Rust native types and JavaScript values for safe memory exchange.
- JavaScript-to-Native Bridges - Provides the bridge enabling JavaScript code to call and execute native Rust functions directly.
- Node-API Bindings - Maps native Rust functions to the Node-API binary interface to ensure cross-runtime compatibility.
- Runtime Extensions - Enables the integration of native Rust binaries into the JavaScript environment for computationally expensive tasks.
- Rust-JavaScript Bridges - Implements a system for converting data types and calling functions between Rust and JavaScript runtimes.
- Cross-Platform Orchestrators - Manages complex compilation and publishing pipelines across multiple hardware architectures and operating systems.
- Package Publishing Pipelines - Automates the compilation and release pipeline for distributing native packages across multiple target platforms.
- Procedural Macros - Utilizes Rust procedural macros to automatically generate the boilerplate glue code for JavaScript exports.
- External Library Linking - Handles the configuration of linker flags to compile native logic into shared objects for JavaScript loading.
- Cross-Platform Binary Generation - Generates platform-specific native binaries for diverse CPU architectures and operating systems.
- Type Definition Generators - Automatically synthesizes TypeScript type declaration files from native Rust function signatures.
- Cross-Platform Integration - Framework for building compiled Node.js add-ons in Rust.
