@bun-win32/kernel32

Zero-dependency, zero-overhead Win32 Kernel32 bindings for Bun on Windows.

Overview

@bun-win32/kernel32 exposes the kernel32.dll exports using Bun's FFI. It provides a single class, Kernel32, 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 kernel32.dll (process, memory, files, console, time, and more).
• In-source docs in structs/Kernel32.ts with links to Microsoft Docs.
• Lazy binding on first call; optional eager preload (Kernel32.Preload()).
• No wrapper overhead; calls map 1:1 to native APIs.
• Strongly-typed Win32 aliases (see types/Kernel32.ts).

Requirements

• Bun runtime
• Windows 10 or later

Installation

bun add @bun-win32/kernel32

Quick Start

import Kernel32 from '@bun-win32/kernel32';

// Optionally bind a subset up-front
Kernel32.Preload(['GetCurrentProcessId', 'GetTickCount64']);

const pid = Kernel32.GetCurrentProcessId();
const ticks = Kernel32.GetTickCount64();

console.log('PID=%s Ticks=%s', pid, ticks.toString());

[!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              # Basic usage
bun run example:sysinfo      # System information dashboard
bun run example:processes    # Process explorer (like Task Manager)
bun run example:watcher      # File system watcher
bun run example:console      # Console color demo

Notes

• Either rely on lazy binding or call Kernel32.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.