Getting Started

Welcome to Rspack Custom Binding! This guide will help you get started with creating your own native Node.js addon for Rspack.

⚠️ Experimental Stage: Rspack Custom Binding is currently in experimental stage. Rust APIs are likely to change in the future as the ecosystem evolves. JavaScript APIs follow semantic versioning (semver), but Rust crate versions do not follow semver due to the version mapping strategy.

Prerequisites

Before diving into Rspack Custom Binding, we recommend:

1. Read the Rationale - Understand why you might want to use custom bindings and how they work
2. Basic Rust Knowledge - Familiarity with Rust programming language
3. Node.js Experience - Understanding of Node.js addons and N-API concepts

If you're not familiar with writing Node.js addons and N-API in Rust, don't worry. We will cover the basics in this guide.

Next Steps

Once you understand the rationale and architecture, proceed to the Create From Template guide to set up your development environment.