Skip to content

README.md

Latest commit

 

History

History
28 lines (20 loc) · 845 Bytes

README.md

File metadata and controls

28 lines (20 loc) · 845 Bytes
Raw

tinybuf-node

Node.js native N-API bindings for the tinybuf C++ protocol library.

Prerequisites

  • Node.js ≥ 18 or Bun
  • cmake-js build toolchain (CMake ≥ 3.15, Python 3, C++17 compiler)

Install & build

bun install    # or npm install
bun run build  # or npm run build

Build tasks:

  • bun run build:native: Rebuild the C++ N-API addon with cmake-js
  • bun run build:ts: Compile TypeScript files with bun build
  • bun run build: Run native rebuild + TypeScript build
  • bun run electron-rebuild: Rebuild native addon for Electron

Project structure

  • src/tinybuf-node.cpp: C++ N-API implementation wrapping tinybuf
  • include/: Header files for the underlying tinybuf C++ library
  • index.ts: TypeScript entrypoint and type definitions
  • CMakeLists.txt: CMake build configuration