bun-types 1.3.3 → 1.3.4-canary.20251123T140630

package/docs/runtime/utils.mdx

@@ -9,7 +9,7 @@ A `string` containing the version of the `bun` CLI that is currently running.
 
 ```ts terminal icon="terminal"
 Bun.version;
-// => "0.6.4"
+// => "1.3.3"
 ```
 
 ## `Bun.revision`
@@ -231,9 +231,9 @@ const currentFile = import.meta.url;
 Bun.openInEditor(currentFile);
 ```
 
-You can override this via the `debug.editor` setting in your [`bunfig.toml`](/runtime/bunfig).
+You can override this via the `debug.editor` setting in your [`bunfig.toml`](/docs/runtime/bunfig).
 
-```toml bunfig.toml
+```toml bunfig.toml icon="settings"
 [debug] # [!code ++]
 editor = "code" # [!code ++]
 ```

package/docs/runtime/watch-mode.mdx

@@ -89,7 +89,7 @@ Use `bun --hot` to enable hot reloading when executing code with Bun. This is di
   This is not the same as hot reloading in the browser! Many frameworks provide a "hot reloading" experience, where you
   can edit & save your frontend code (say, a React component) and see the changes reflected in the browser without
   refreshing the page. Bun's `--hot` is the server-side equivalent of this experience. To get hot reloading in the
-  browser, use a framework like [Vite](https://vitejs.dev).
+  browser, use a framework like [Vite](https://vite.dev).
 </Note>
 
 ```bash terminal icon="terminal"

package/docs/runtime/workers.mdx

@@ -29,7 +29,7 @@ worker.onmessage = event => {
 
 ### Worker thread
 
-```ts worker.ts  icon="file-code"
+```ts worker.ts icon="file-code"
 // prevents TS errors
 declare var self: Worker;
 
@@ -81,15 +81,9 @@ const worker = new Worker("./worker.ts", {
 You can also pass a `blob:` URL to `Worker`. This is useful for creating workers from strings or other sources.
 
 ```js
-const blob = new Blob(
-  [
-    `
-  self.onmessage = (event: MessageEvent) => postMessage(event.data)`,
-  ],
-  {
-    type: "application/typescript",
-  },
-);
+const blob = new Blob([`self.onmessage = (event: MessageEvent) => postMessage(event.data)`], {
+  type: "application/typescript",
+});
 const url = URL.createObjectURL(blob);
 const worker = new Worker(url);
 ```
@@ -97,13 +91,7 @@ const worker = new Worker(url);
 Like the rest of Bun, workers created from `blob:` URLs support TypeScript, JSX, and other file types out of the box. You can communicate it should be loaded via typescript either via `type` or by passing a `filename` to the `File` constructor.
 
 ```ts
-const file = new File(
-  [
-    `
-  self.onmessage = (event: MessageEvent) => postMessage(event.data)`,
-  ],
-  "worker.ts",
-);
+const file = new File([`self.onmessage = (event: MessageEvent) => postMessage(event.data)`], "worker.ts");
 const url = URL.createObjectURL(file);
 const worker = new Worker(url);
 ```

package/docs/snippets/cli/publish.mdx

@@ -25,7 +25,7 @@ bun publish --access public
 
 </ParamField>
 
-<ParamField path="--tag" type="string"  default="latest">
+<ParamField path="--tag" type="string" default="latest">
 Set the tag of the package version being published. By default, the tag is `latest`. The initial version of a package is always given the `latest` tag in addition to the specified tag.
 
 ```sh terminal icon="terminal"
@@ -34,7 +34,7 @@ bun publish --tag alpha
 
 `--tag` can also be set in the `publishConfig` field of your `package.json`.
 
-```json package.json file="file-json"
+```json package.json icon="file-json"
 {
   "publishConfig": {
     "tag": "next" // [!code ++]

package/docs/test/configuration.mdx

@@ -306,7 +306,7 @@ coveragePathIgnorePatterns = [
 ]
 ```
 
-Files matching any of these patterns will be excluded from coverage calculation and reporting. See the [coverage documentation](/test/code-coverage) for more details and examples.
+Files matching any of these patterns will be excluded from coverage calculation and reporting. See the [coverage documentation](/docs/test/code-coverage) for more details and examples.
 
 #### Common Ignore Patterns
 

package/docs/test/dom.mdx

@@ -65,7 +65,7 @@ bun test
 ```
 
 ```
-bun test v1.3.2
+bun test v1.3.3
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/docs/test/index.mdx

@@ -25,7 +25,7 @@ Bun ships with a fast, built-in, Jest-compatible test runner. Tests are executed
 bun test
 ```
 
-Tests are written in JavaScript or TypeScript with a Jest-like API. Refer to [Writing tests](/test/writing-tests) for full documentation.
+Tests are written in JavaScript or TypeScript with a Jest-like API. Refer to [Writing tests](/docs/test/writing-tests) for full documentation.
 
 ```ts math.test.ts icon="/icons/typescript.svg"
 import { expect, test } from "bun:test";
@@ -61,7 +61,7 @@ To run a specific file in the test runner, make sure the path starts with `./` o
 bun test ./test/specific-file.test.ts
 ```
 
-The test runner runs all tests in a single process. It loads all `--preload` scripts (see [Lifecycle](/test/lifecycle) for details), then runs all tests. If a test fails, the test runner will exit with a non-zero exit code.
+The test runner runs all tests in a single process. It loads all `--preload` scripts (see [Lifecycle](/docs/test/lifecycle) for details), then runs all tests. If a test fails, the test runner will exit with a non-zero exit code.
 
 ## CI/CD integration
 
@@ -275,11 +275,11 @@ Bun supports the following lifecycle hooks:
 
 These hooks can be defined inside test files, or in a separate file that is preloaded with the `--preload` flag.
 
-```ts terminal icon="terminal"
+```sh terminal icon="terminal"
 bun test --preload ./setup.ts
 ```
 
-See [Test > Lifecycle](/test/lifecycle) for complete documentation.
+See [Test > Lifecycle](/docs/test/lifecycle) for complete documentation.
 
 ## Mocks
 
@@ -307,7 +307,7 @@ const random = mock(() => Math.random()); // [!code --]
 const random = jest.fn(() => Math.random()); // [!code ++]
 ```
 
-See [Test > Mocks](/test/mocks) for complete documentation.
+See [Test > Mocks](/docs/test/mocks) for complete documentation.
 
 ## Snapshot testing
 
@@ -328,7 +328,7 @@ To update snapshots, use the `--update-snapshots` flag.
 bun test --update-snapshots
 ```
 
-See [Test > Snapshots](/test/snapshots) for complete documentation.
+See [Test > Snapshots](/docs/test/snapshots) for complete documentation.
 
 ## UI & DOM testing
 
@@ -338,13 +338,13 @@ Bun is compatible with popular UI testing libraries:
 - [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro/)
 - [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
 
-See [Test > DOM Testing](/test/dom) for complete documentation.
+See [Test > DOM Testing](/docs/test/dom) for complete documentation.
 
 ## Performance
 
 Bun's test runner is fast.
 
-<Frame>![Running 266 React SSR tests faster than Jest can print its version number.](/images/buntest.jpeg)</Frame>
+<Frame>![Running 266 React SSR tests faster than Jest can print its version number.](https://bun.com/images/buntest.jpeg)</Frame>
 
 ## AI Agent Integration
 

package/docs/test/reporters.mdx

@@ -98,7 +98,7 @@ The JUnit reporter currently has a few limitations that will be addressed in fut
 
 Bun test automatically detects when it's running inside GitHub Actions and emits GitHub Actions annotations to the console directly. No special configuration is needed beyond installing Bun and running `bun test`.
 
-For a GitHub Actions workflow configuration example, see the [CI/CD integration](/pm/cli/install#ci%2Fcd) section of the CLI documentation.
+For a GitHub Actions workflow configuration example, see the [CI/CD integration](/docs/pm/cli/install#ci%2Fcd) section of the CLI documentation.
 
 ---
 

package/docs/test/snapshots.mdx

@@ -32,8 +32,8 @@ your-project/
 
 The snapshot file contains:
 
-```txt title="snapshot file" icon="file-code"
-// Bun Snapshot v1, https://goo.gl/fbAQLP
+```ts title="__snapshots__/snap.test.ts.snap" icon="file-code"
+// Bun Snapshot v1, https://bun.com/docs/test/snapshots
 
 exports[`snap 1`] = `"foo"`;
 ```
@@ -400,7 +400,7 @@ tests/
 
 When snapshots fail, you'll see a diff:
 
-```text title="diff" icon="file-code"
+```diff title="diff" icon="file-code"
 - Expected
 + Received
 

package/docs/test/writing-tests.mdx

@@ -78,6 +78,43 @@ In `bun:test`, test timeouts throw an uncatchable exception to force the test to
 
 The default timeout for each test is 5000ms (5 seconds) if not overridden by this timeout option or `jest.setDefaultTimeout()`.
 
+## Retries and Repeats
+
+### test.retry
+
+Use the `retry` option to automatically retry a test if it fails. The test passes if it succeeds within the specified number of attempts. This is useful for flaky tests that may fail intermittently.
+
+```ts title="example.test.ts" icon="/icons/typescript.svg"
+import { test } from "bun:test";
+
+test(
+  "flaky network request",
+  async () => {
+    const response = await fetch("https://example.com/api");
+    expect(response.ok).toBe(true);
+  },
+  { retry: 3 }, // Retry up to 3 times if the test fails
+);
+```
+
+### test.repeats
+
+Use the `repeats` option to run a test multiple times regardless of pass/fail status. The test fails if any iteration fails. This is useful for detecting flaky tests or stress testing. Note that `repeats: N` runs the test N+1 times total (1 initial run + N repeats).
+
+```ts title="example.test.ts" icon="/icons/typescript.svg"
+import { test } from "bun:test";
+
+test(
+  "ensure test is stable",
+  () => {
+    expect(Math.random()).toBeLessThan(1);
+  },
+  { repeats: 20 }, // Runs 21 times total (1 initial + 20 repeats)
+);
+```
+
+<Note>You cannot use both `retry` and `repeats` on the same test.</Note>
+
 ### 🧟 Zombie Process Killer
 
 When a test times out and processes spawned in the test via `Bun.spawn`, `Bun.spawnSync`, or `node:child_process` are not killed, they will be automatically killed and a message will be logged to the console. This prevents zombie processes from lingering in the background after timed-out tests.

package/docs/typescript.mdx

@@ -15,7 +15,7 @@ At this point, you should be able to reference the `Bun` global in your TypeScri
 
 Bun supports things like top-level await, JSX, and extensioned `.ts` imports, which TypeScript doesn't allow by default. Below is a set of recommended `compilerOptions` for a Bun project, so you can use these features without seeing compiler warnings from TypeScript.
 
-```json tsconfig.json icon="file-code"
+```json tsconfig.json icon="file-json"
 {
   "compilerOptions": {
     // Environment setup & latest features
@@ -49,6 +49,6 @@ Bun supports things like top-level await, JSX, and extensioned `.ts` imports, wh
 
 If you run `bun init` in a new directory, this `tsconfig.json` will be generated for you. (The stricter flags are disabled by default.)
 
-```sh terminal 	icon="terminal"
+```sh terminal icon="terminal"
 bun init
 ```

package/package.json

@@ -1,5 +1,4 @@
 {
-  "version": "1.3.3",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",
@@ -25,8 +24,7 @@
   },
   "scripts": {
     "prebuild": "echo $(pwd)",
-    "copy-docs": "rm -rf docs && cp -rL ../../docs/ ./docs && find ./docs -type f -name '*.{md,mdx}' -exec sed -i 's/\\$BUN_LATEST_VERSION/'\"${BUN_VERSION#bun-v}\"'/g' {} +",
-    "build": "bun run copy-docs && cp ../../src/init/rule.md CLAUDE.md && bun scripts/build.ts",
+    "build": "bun scripts/build.ts",
     "test": "tsc",
     "fmt": "echo $(which biome) && biome format --write ."
   },
@@ -34,5 +32,6 @@
     "bun",
     "bun.js",
     "types"
-  ]
+  ],
+  "version": "1.3.4-canary.20251123T140630"
 }

package/docs/snippets/product-card.mdx

@@ -1,32 +0,0 @@
-export const ProductCard = ({ img, href, title, description, model, type }) => {
-  return (
-    <a href={href} target="_blank" rel="noopener noreferrer" className="group">
-      <div className="flex flex-col gap-4 rounded-xl md:p-1">
-        <div className="w-full h-32 overflow-hidden rounded-xl bg-gray-100 dark:bg-gray-800">
-          <img
-            src={img}
-            className="w-full h-full object-cover transition-transform duration-300 group-hover:scale-105"
-            alt={title}
-            loading="lazy"
-          />
-        </div>
-        <div className="flex flex-col gap-3 pb-2">
-          <h2 className="text-md font-medium text-gray-900 dark:text-gray-200 group-hover:text-gray-600 dark:group-hover:text-gray-400 transition-colors mb-[-8px]">
-            {title}
-          </h2>
-          <p className="text-gray-500 dark:text-gray-400 text-sm font-medium">{description}</p>
-          <div className="flex gap-2 mt-2 mb-1">
-            <span className="bg-gray-100 dark:bg-[#181817] text-gray-600 dark:text-white rounded-lg px-2 py-1 text-sm font-medium">
-              {model}
-            </span>
-            <span className="bg-primary-light dark:bg-primary-dark text-white dark:text-white rounded-lg px-2 py-1 text-sm font-medium">
-              {type}
-            </span>
-          </div>
-        </div>
-      </div>
-    </a>
-  );
-};
-
-;

package/docs/snippets/product-tiles.mdx

@@ -1,94 +0,0 @@
-export const ProductTiles = ({ categories, hideButtons = false }) => {
-  const [activeCategory, setActiveCategory] = useState(categories[0].id)
-  const [activeSubTab, setActiveSubTab] = useState(
-    categories[0].items[0]?.id ?? null
-  )
-
-const currentCategory = categories.find((cat) => cat.id === activeCategory)
-const currentSub = currentCategory?.items.find(
-(item) => item.id === activeSubTab
-)
-
-return (
-
-<div className="not-prose space-y-6">
-{!hideButtons && (
-<div className="flex flex-wrap gap-2">
-{categories.map((cat) => (
-<button
-key={cat.id}
-onClick={() => {
-setActiveCategory(cat.id)
-setActiveSubTab(cat.items[0]?.id ?? null)
-}}
-className={`px-4 py-2 text-sm rounded-full font-medium transition-colors ${activeCategory === cat.id
-              ? 'bg-[#0A0B0D] text-white dark:bg-white dark:text-[#0A0B0D] border-black'
-              : 'bg-gray-100 dark:bg-white/10 text-black dark:text-white'
-              }`} >
-{cat.label}
-</button>
-))}
-</div>
-)}
-
-      <div>
-        {currentCategory?.items?.length ? (
-          <div className="flex flex-col lg:flex-row gap-6 bg-gray-100 dark:bg-[#141414] rounded-2xl">
-            <div className="flex flex-col w-full lg:w-1/2 space-y-2 p-4">
-              {currentCategory.items.map((item) => (
-                <a
-                  key={item.id}
-                  href={item.href}
-                  onMouseOver={() => setActiveSubTab(item.id)}
-                  className={`flex items-start gap-1.5 text-left px-5 py-3 rounded-2xl transition-all ${activeSubTab === item.id
-                    ? 'bg-white dark:bg-white/5'
-                    : ''
-                    }`}
-                >
-                  <div className="text-xl mr-3 mt-1"><img src={item.icon} alt={item.title} className="w-8 h-8" /></div>
-                  <div className="flex-1">
-                    <h3 className="font-medium text-base text-black dark:text-white">
-                      {item.title}
-                    </h3>
-                    <p className="text-sm text-gray-600 dark:text-gray-400">{item.desc}</p>
-                  </div>
-                  <div className={`flex items-center justify-center min-w-[24px] self-center ${activeSubTab === item.id ? 'opacity-100' : 'opacity-0'}`}>
-                    <div className="hidden dark:block">
-                      <Icon icon="chevron-right" size="14" color="#FFF" />
-                    </div>
-                    <div className="block dark:hidden">
-                      <Icon icon="chevron-right" size="14" color="#0A0B0D" />
-                    </div>
-                  </div>
-                </a>
-              ))}
-            </div>
-            <div className="group w-full h-fit lg:w-1/2 rounded-2xl flex items-center justify-center  overflow-hidden min-h-[320px] p-4">
-              {currentSub?.image ? (
-              <>
-                <img
-                  src={currentSub.image.light}
-                  alt={currentSub.title}
-                  className="block dark:hidden w-full h-full object-cover rounded-xl"
-                />
-                <img
-                  src={currentSub.image.dark}
-                  alt={currentSub.title}
-                  className="hidden dark:block w-full h-full object-cover rounded-xl"
-                />
-              </>
-              ) : (
-                <p className="text-gray-400 dark:text-gray-500 p-8">No preview available</p>
-              )}
-            </div>
-          </div>
-        ) : (
-          <p className="text-sm text-gray-500 dark:text-gray-400">
-            No features available for this category.
-          </p>
-        )}
-      </div>
-    </div>
-
-)
-}