@bun-win32/advapi32
Zero-dependency, zero-overhead Win32 Advapi32 bindings for Bun on Windows.
Overview
@bun-win32/advapi32 exposes the advapi32.dll exports using Bun's FFI. It provides a single class, Advapi32, which lazily binds native symbols on first use. You can optionally preload a subset or all symbols up-front via Preload().
The bindings are strongly typed for a smooth DX in TypeScript.
Features
- Bun-first ergonomics on Windows 10/11.
- Direct FFI to
advapi32.dll (registry, security, services, cryptography, event logging, and more).
- In-source docs in
structs/Advapi32.ts with links to Microsoft Docs.
- Lazy binding on first call; optional eager preload (
Advapi32.Preload()).
- No wrapper overhead; calls map 1:1 to native APIs.
- Strongly-typed Win32 aliases (see
types/Advapi32.ts).
Requirements
- Bun runtime
- Windows 10 or later
Installation
bun add @bun-win32/advapi32
Quick Start
import Advapi32, { HKEY_LOCAL_MACHINE } from '@bun-win32/advapi32';
Advapi32.Preload(['GetUserNameW', 'RegOpenKeyExW', 'RegCloseKey']);
const size = new Uint32Array([256]);
const buf = new Uint16Array(256);
Advapi32.GetUserNameW(buf.ptr, size.ptr);
const username = String.fromCharCode(...buf.subarray(0, size[0]! - 1));
console.log('User: %s', username);
[!NOTE]
AI agents: see AI.md for the package binding contract and source-navigation guidance. It explains how to use the package without scanning the entire implementation.
Examples
Run the included examples:
bun run example
Notes
- Either rely on lazy binding or call
Advapi32.Preload().
- Windows only. Bun runtime required.
- SAL types & naming: nullability is in the type —
Optional<T> (formally optional, SAL _*opt_) and Nullable<T> (plain [in]/[out] the docs say can be NULL), the null sentinel derived from T (null for pointers LP*/P*, 0n for handles/by-value addresses); direction is in the parameter name — _out (_Out_), _in_out (_Inout_), _In_ bare. See AI.md and the repo AGENTS.md.