chkpt-napi 0.3.0

Node.js N-API bindings for chkpt – a fast, content-addressable checkpoint system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# chkpt-napi

Node.js N-API bindings for the filesystem checkpoint engine.

## Build

### Current platform only

```bash
pnpm build
```

Builds a `.node` binary for the host platform only.

### Cross-compile all targets

```bash
pnpm build:all
```

Builds N-API modules and CLI binaries for all 5 platforms.
To build a specific platform:

```bash
bash scripts/build-all.sh darwin-arm64
bash scripts/build-all.sh win32-x64-msvc
```

## Cross-compilation prerequisites

The following tools are required to run the full cross-build (`build:all`).

### 1. Rust targets

```bash
rustup target add aarch64-apple-darwin
rustup target add x86_64-apple-darwin
rustup target add aarch64-unknown-linux-gnu
rustup target add x86_64-unknown-linux-gnu
rustup target add x86_64-pc-windows-msvc
```

### 2. Linux — cross (Docker-based)

```bash
cargo install cross
```

Requires Docker to be installed and running.

### 3. Windows MSVC — cargo-xwin

```bash
# Install cargo-xwin
cargo install cargo-xwin

# Install LLVM (provides clang-cl)
# macOS
brew install llvm

# Ubuntu/Debian
sudo apt install llvm clang lld
```

On the first build, `cargo-xwin` automatically downloads the MSVC CRT headers and Windows SDK libraries.

### Summary

| Target | Build tool | Dependencies |
|--------|-----------|--------------|
| `aarch64-apple-darwin` | `cargo` | (native) |
| `x86_64-apple-darwin` | `cargo` | (native) |
| `aarch64-unknown-linux-gnu` | `cross` | Docker |
| `x86_64-unknown-linux-gnu` | `cross` | Docker |
| `x86_64-pc-windows-msvc` | `cargo xwin` | LLVM (clang-cl) |

## Test

```bash
pnpm test
```

## Publish

```bash
# dry-run
bash scripts/publish.sh --dry-run

# publish
bash scripts/publish.sh
```

Publishes platform-specific npm packages first, then the main package.