Requirements

Node.js

Koffi requires a recent Node.js version with N-API version 8 support:

• Node < 12.22.0 is not supported

• Node 12.x: Node 12.22.0 or newer

• Node 14.x: Node 14.17.0 or newer

• Node 15.x: Node 15.12.0 or newer

• Node 16.0.0 or later versions

Use NVM to install more recent Node versions on older Linux distributions.

Supported platforms

The following combinations of OS and architectures are officially supported and tested at the moment:

ISA / OS	Windows	Linux	macOS	FreeBSD	OpenBSD
x86 (IA32) [1]	✅ Yes	✅ Yes	⬜️ N/A	✅ Yes	✅ Yes
x86_64 (AMD64)	✅ Yes	✅ Yes	✅ Yes	✅ Yes	✅ Yes
ARM32 LE [2]	⬜️ N/A	✅ Yes	⬜️ N/A	🟨 Probably	🟨 Probably
ARM64 (AArch64) LE	✅ Yes	✅ Yes	✅ Yes	✅ Yes	🟨 Probably
RISC-V 64 [3]	⬜️ N/A	✅ Yes	⬜️ N/A	🟨 Probably	🟨 Probably

For all fully supported platforms (green check marks), a prebuilt binary is included in the NPM package which means you can install Koffi without a C++ compiler.

---

[1]

The following call conventions are supported for forward calls: cdecl, stdcall, MS fastcall, thiscall. Only cdecl and stdcall can be used for C to JS callbacks.

[2]

The prebuilt binary uses the hard float ABI and expects a VFP coprocessor. Build from source to use Koffi with a different ABI (softfp, soft).

[3]

The prebuilt binary uses the LP64D (double-precision float) ABI. The LP64 ABI is supported in theory if you build Koffi from source (untested), the LP64F ABI is not supported.