Skip to main content

Documentation Index

Fetch the complete documentation index at: https://bun.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Bun’s test runner supports Jest-style snapshot testing via .toMatchSnapshot().
https://mintcdn.com/bun-1dd33a4e/JUhaF6Mf68z_zHyy/icons/typescript.svg?fit=max&auto=format&n=JUhaF6Mf68z_zHyy&q=85&s=7ac549adaea8d5487d8fbd58cc3ea35bsnap.test.ts
import { test, expect } from "bun:test";

test("snapshot", () => {
  expect({ foo: "bar" }).toMatchSnapshot();
});
The first time this test is executed, Bun will write a snapshot file to disk in a directory called __snapshots__ that lives alongside the test file.
File Tree
test
├── __snapshots__
│   └── snap.test.ts.snap
└── snap.test.ts
To regenerate snapshots, use the --update-snapshots flag.
terminal
bun test --update-snapshots

test/snap.test.ts:
✓ snapshot [0.86ms]

 1 pass
 0 fail
 snapshots: +1 added # the snapshot was regenerated
 1 expect() calls
Ran 1 tests across 1 files. [102.00ms]
See Docs > Test Runner > Snapshots for complete documentation on snapshots with the Bun test runner.