Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

From npm

npm install laurus-nodejs

From source

Building from source requires a Rust toolchain (1.85 or later) and Node.js 18+.

# Clone the repository
git clone https://github.com/mosuka/laurus.git
cd laurus/laurus-nodejs

# Install dependencies
npm install

# Build the native module (release)
npm run build

# Or build in debug mode (faster builds)
npm run build:debug

Verify

import { Index } from "laurus-nodejs";
const index = await Index.create();
console.log(index.stats());
// { documentCount: 0, vectorFields: {} }

Requirements

  • Node.js 18 or later
  • No runtime dependencies beyond the compiled native addon