bun-types 1.2.6-canary.20250312T140728 → 1.2.6-canary.20250313T140623

package/bun.d.ts

@@ -1,74 +1,3 @@
-declare class _ShellError extends Error implements ShellOutput {
-	readonly stdout: Buffer;
-	readonly stderr: Buffer;
-	readonly exitCode: number;
-
-	/**
-	 * Read from stdout as a string
-	 *
-	 * @param encoding - The encoding to use when decoding the output
-	 * @returns Stdout as a string with the given encoding
-	 * @example
-	 *
-	 * ## Read as UTF-8 string
-	 *
-	 * ```ts
-	 * const output = await $`echo hello`;
-	 * console.log(output.text()); // "hello\n"
-	 * ```
-	 *
-	 * ## Read as base64 string
-	 *
-	 * ```ts
-	 * const output = await $`echo ${atob("hello")}`;
-	 * console.log(output.text("base64")); // "hello\n"
-	 * ```
-	 *
-	 */
-	text(encoding?: BufferEncoding): string;
-
-	/**
-	 * Read from stdout as a JSON object
-	 *
-	 * @returns Stdout as a JSON object
-	 * @example
-	 *
-	 * ```ts
-	 * const output = await $`echo '{"hello": 123}'`;
-	 * console.log(output.json()); // { hello: 123 }
-	 * ```
-	 *
-	 */
-	json(): any;
-
-	/**
-	 * Read from stdout as an ArrayBuffer
-	 *
-	 * @returns Stdout as an ArrayBuffer
-	 * @example
-	 *
-	 * ```ts
-	 * const output = await $`echo hello`;
-	 * console.log(output.arrayBuffer()); // ArrayBuffer { byteLength: 6 }
-	 * ```
-	 */
-	arrayBuffer(): ArrayBuffer;
-
-	/**
-	 * Read from stdout as a Blob
-	 *
-	 * @returns Stdout as a blob
-	 * @example
-	 * ```ts
-	 * const output = await $`echo hello`;
-	 * console.log(output.blob()); // Blob { size: 6, type: "" }
-	 * ```
-	 */
-	blob(): Blob;
-
-	bytes(): Uint8Array;
-}
-
 /**
  * Bun.js runtime APIs
  *
@@ -192,6 +121,77 @@ declare module "bun" {
 		| SpawnOptions.Writable
 		| ReadableStream;
 
+	class ShellError extends Error implements ShellOutput {
+		readonly stdout: Buffer;
+		readonly stderr: Buffer;
+		readonly exitCode: number;
+
+		/**
+		 * Read from stdout as a string
+		 *
+		 * @param encoding - The encoding to use when decoding the output
+		 * @returns Stdout as a string with the given encoding
+		 * @example
+		 *
+		 * ## Read as UTF-8 string
+		 *
+		 * ```ts
+		 * const output = await $`echo hello`;
+		 * console.log(output.text()); // "hello\n"
+		 * ```
+		 *
+		 * ## Read as base64 string
+		 *
+		 * ```ts
+		 * const output = await $`echo ${atob("hello")}`;
+		 * console.log(output.text("base64")); // "hello\n"
+		 * ```
+		 *
+		 */
+		text(encoding?: BufferEncoding): string;
+
+		/**
+		 * Read from stdout as a JSON object
+		 *
+		 * @returns Stdout as a JSON object
+		 * @example
+		 *
+		 * ```ts
+		 * const output = await $`echo '{"hello": 123}'`;
+		 * console.log(output.json()); // { hello: 123 }
+		 * ```
+		 *
+		 */
+		json(): any;
+
+		/**
+		 * Read from stdout as an ArrayBuffer
+		 *
+		 * @returns Stdout as an ArrayBuffer
+		 * @example
+		 *
+		 * ```ts
+		 * const output = await $`echo hello`;
+		 * console.log(output.arrayBuffer()); // ArrayBuffer { byteLength: 6 }
+		 * ```
+		 */
+		arrayBuffer(): ArrayBuffer;
+
+		/**
+		 * Read from stdout as a Blob
+		 *
+		 * @returns Stdout as a blob
+		 * @example
+		 * ```ts
+		 * const output = await $`echo hello`;
+		 * console.log(output.blob()); // Blob { size: 6, type: "" }
+		 * ```
+		 */
+		blob(): Blob;
+
+		bytes(): Uint8Array;
+	}
+
 	class ShellPromise extends Promise<ShellOutput> {
 		get stdin(): WritableStream;
 		/**
@@ -311,15 +311,15 @@ declare module "bun" {
 		new (): Shell;
 	}
 
-	type ShellError = _ShellError;
-
 	export interface Shell {
 		(
 			strings: TemplateStringsArray,
 			...expressions: ShellExpression[]
 		): ShellPromise;
 
-		readonly ShellError: typeof _ShellError;
+		readonly Shell: ShellConstructor;
+		readonly ShellError: typeof ShellError;
+		readonly ShellPromise: typeof ShellPromise;
 
 		/**
 		 * Perform bash-like brace expansion on the given pattern.
@@ -372,9 +372,6 @@ declare module "bun" {
 		 * Configure whether or not the shell should throw an exception on non-zero exit codes.
 		 */
 		throws(shouldThrow: boolean): this;
-
-		readonly ShellPromise: typeof ShellPromise;
-		readonly Shell: ShellConstructor;
 	}
 
 	export interface ShellOutput {
@@ -4513,25 +4510,7 @@ declare module "bun" {
 		 * Passing other options such as `port` or `hostname` won't do anything.
 		 */
 		reload<T, R extends { [K in keyof R]: RouterTypes.RouteValue<K & string> }>(
-			options: (
-				| (Omit<ServeOptions, "fetch"> & {
-						routes: R;
-						fetch?: (
-							this: Server,
-							request: Request,
-							server: Server,
-						) => Response | Promise<Response>;
-				  })
-				| (Omit<ServeOptions, "routes"> & {
-						routes?: never;
-						fetch: (
-							this: Server,
-							request: Request,
-							server: Server,
-						) => Response | Promise<Response>;
-				  })
-				| WebSocketServeOptions<T>
-			) & {
+			options: ServeFunctionOptions<T, R> & {
 				/**
 				 * @deprecated Use `routes` instead in new code. This will continue to work for awhile though.
 				 */
@@ -4912,25 +4891,7 @@ declare module "bun" {
 		T,
 		R extends { [K in keyof R]: RouterTypes.RouteValue<K & string> },
 	>(
-		options: (
-			| (DistributedOmit<Serve, "fetch"> & {
-					routes: R;
-					fetch?: (
-						this: Server,
-						request: Request,
-						server: Server,
-					) => Response | Promise<Response>;
-			  })
-			| (DistributedOmit<Serve, "routes"> & {
-					routes?: never;
-					fetch: (
-						this: Server,
-						request: Request,
-						server: Server,
-					) => Response | Promise<Response>;
-			  })
-			| WebSocketServeOptions<T>
-		) & {
+		options: ServeFunctionOptions<T, R> & {
 			/**
 			 * @deprecated Use `routes` instead in new code. This will continue to work for a while though.
 			 */
@@ -4938,6 +4899,46 @@ declare module "bun" {
 		},
 	): Server;
 
+	type ServeFunctionOptions<
+		T,
+		R extends { [K in keyof R]: RouterTypes.RouteValue<K & string> },
+	> =
+		| (DistributedOmit<Exclude<Serve<T>, WebSocketServeOptions<T>>, "fetch"> & {
+				routes: R;
+				fetch?: (
+					this: Server,
+					request: Request,
+					server: Server,
+				) => Response | Promise<Response>;
+		  })
+		| (DistributedOmit<
+				Exclude<Serve<T>, WebSocketServeOptions<T>>,
+				"routes"
+		  > & {
+				routes?: never;
+				fetch: (
+					this: Server,
+					request: Request,
+					server: Server,
+				) => Response | Promise<Response>;
+		  })
+		| (WebSocketServeOptions<T> & {
+				routes: R;
+				fetch?: (
+					this: Server,
+					request: Request,
+					server: Server,
+				) => Response | Promise<Response | void | undefined> | void | undefined;
+		  })
+		| (WebSocketServeOptions<T> & {
+				routes?: never;
+				fetch: (
+					this: Server,
+					request: Request,
+					server: Server,
+				) => Response | Promise<Response | void | undefined> | void | undefined;
+		  });
+
 	/**
 	 * [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) powered by the fastest system calls available for operating on files.
 	 *

package/devserver.d.ts

@@ -1,6 +1,23 @@
 export {};
 
 declare global {
+	namespace Bun {
+		type HMREventNames =
+			| "bun:beforeUpdate"
+			| "bun:afterUpdate"
+			| "bun:beforeFullReload"
+			| "bun:beforePrune"
+			| "bun:invalidate"
+			| "bun:error"
+			| "bun:ws:disconnect"
+			| "bun:ws:connect";
+
+		/**
+		 * The event names for the dev server
+		 */
+		type HMREvent = `bun:${HMREventNames}` | (string & {});
+	}
+
 	interface ImportMeta {
 		/**
 		 * Hot module replacement APIs. This value is `undefined` in production and
@@ -131,6 +148,49 @@ declare global {
 			 * @deprecated
 			 */
 			decline(): void;
+
+			// NOTE TO CONTRIBUTORS ////////////////////////////////////////
+			//     Callback is currently never called for `.prune()`      //
+			//     so the types are commented out until we support it.    //
+			////////////////////////////////////////////////////////////////
+			// /**
+			//  * Attach a callback that is called when the module is removed from the module graph.
+			//  *
+			//  * This can be used to clean up resources that were created when the module was loaded.
+			//  * Unlike `import.meta.hot.dispose()`, this pairs much better with `accept` and `data` to manage stateful resources.
+			//  *
+			//  * @example
+			//  * ```ts
+			//  * export const ws = (import.meta.hot.data.ws ??= new WebSocket(location.origin));
+			//  *
+			//  * import.meta.hot.prune(() => {
+			//  *   ws.close();
+			//  * });
+			//  * ```
+			//  */
+			// prune(callback: () => void): void;
+
+			/**
+			 * Listen for an event from the dev server
+			 *
+			 * For compatibility with Vite, event names are also available via vite:* prefix instead of bun:*.
+			 *
+			 * https://bun.sh/docs/bundler/hmr#import-meta-hot-on-and-off
+			 * @param event The event to listen to
+			 * @param callback The callback to call when the event is emitted
+			 */
+			on(event: Bun.HMREvent, callback: () => void): void;
+
+			/**
+			 * Stop listening for an event from the dev server
+			 *
+			 * For compatibility with Vite, event names are also available via vite:* prefix instead of bun:*.
+			 *
+			 * https://bun.sh/docs/bundler/hmr#import-meta-hot-on-and-off
+			 * @param event The event to stop listening to
+			 * @param callback The callback to stop listening to
+			 */
+			off(event: Bun.HMREvent, callback: () => void): void;
 		};
 	}
 }

package/docs/api/fetch.md

@@ -337,7 +337,7 @@ This will print the request and response headers to your terminal:
 ```sh
 [fetch] > HTTP/1.1 GET http://example.com/
 [fetch] > Connection: keep-alive
-[fetch] > User-Agent: Bun/1.2.6-canary.20250312T140728
+[fetch] > User-Agent: Bun/1.2.6-canary.20250313T140623
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/api/spawn.md

@@ -110,7 +110,7 @@ You can read results from the subprocess via the `stdout` and `stderr` propertie
 ```ts
 const proc = Bun.spawn(["bun", "--version"]);
 const text = await new Response(proc.stdout).text();
-console.log(text); // => "1.2.6-canary.20250312T140728"
+console.log(text); // => "1.2.6-canary.20250313T140623"
 ```
 
 Configure the output stream by passing one of the following values to `stdout/stderr`:

package/docs/cli/publish.md

@@ -7,7 +7,7 @@ Use `bun publish` to publish a package to the npm registry.
 $ bun publish
 
 ## Output
-bun publish v1.2.6-canary.20250312T140728 (ca7428e9)
+bun publish v1.2.6-canary.20250313T140623 (ca7428e9)
 
 packed 203B package.json
 packed 224B README.md

package/docs/guides/ecosystem/nuxt.md

@@ -9,7 +9,7 @@ $ bunx nuxi init my-nuxt-app
 ✔ Which package manager would you like to use?
 bun
 ◐ Installing dependencies...
-bun install v1.2.6-canary.20250312T140728 (16b4bf34)
+bun install v1.2.6-canary.20250313T140623 (16b4bf34)
  + @nuxt/devtools@0.8.2
  + nuxt@3.7.0
  785 packages installed [2.67s]

package/docs/guides/install/add-peer.md

@@ -16,7 +16,7 @@ This will add the package to `peerDependencies` in `package.json`.
 ```json-diff
 {
   "peerDependencies": {
-+   "@types/bun": "^1.2.6-canary.20250312T140728"
++   "@types/bun": "^1.2.6-canary.20250313T140623"
   }
 }
 ```
@@ -28,7 +28,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
 ```json-diff
 {
   "peerDependencies": {
-    "@types/bun": "^1.2.6-canary.20250312T140728"
+    "@types/bun": "^1.2.6-canary.20250313T140623"
   },
   "peerDependenciesMeta": {
 +   "@types/bun": {

package/docs/guides/install/from-npm-install-to-bun-install.md

@@ -97,7 +97,7 @@ $ bun update
 $ bun update @types/bun --latest
 
 # Update a dependency to a specific version
-$ bun update @types/bun@1.2.6-canary.20250312T140728
+$ bun update @types/bun@1.2.6-canary.20250313T140623
 
 # Update all dependencies to the latest versions
 $ bun update --latest

package/docs/guides/test/run-tests.md

@@ -21,7 +21,7 @@ Here's what the output of a typical test run looks like. In this case, there are
 
 ```sh
 $ bun test
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test.test.js:
 ✓ add [0.87ms]
@@ -47,7 +47,7 @@ To only run certain test files, pass a positional argument to `bun test`. The ru
 
 ```sh
 $ bun test test3
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test3.test.js:
 ✓ add [1.40ms]
@@ -85,7 +85,7 @@ Adding `-t add` will only run tests with "add" in the name. This works with test
 
 ```sh
 $ bun test -t add
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test.test.js:
 ✓ add [1.79ms]

package/docs/guides/test/snapshot.md

@@ -18,7 +18,7 @@ The first time this test is executed, Bun will evaluate the value passed into `e
 
 ```sh
 $ bun test test/snap
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [1.48ms]
@@ -61,7 +61,7 @@ Later, when this test file is executed again, Bun will read the snapshot file an
 
 ```sh
 $ bun test
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [1.05ms]
@@ -78,7 +78,7 @@ To update snapshots, use the `--update-snapshots` flag.
 
 ```sh
 $ bun test --update-snapshots
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [0.86ms]

package/docs/guides/test/update-snapshots.md

@@ -29,7 +29,7 @@ To regenerate snapshots, use the `--update-snapshots` flag.
 
 ```sh
 $ bun test --update-snapshots
-bun test v1.2.6-canary.20250312T140728 (9c68abdb)
+bun test v1.2.6-canary.20250313T140623 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [0.86ms]

package/docs/guides/util/version.md

@@ -5,7 +5,7 @@ name: Get the current Bun version
 Get the current version of Bun in a semver format.
 
 ```ts#index.ts
-Bun.version; // => "1.2.6-canary.20250312T140728"
+Bun.version; // => "1.2.6-canary.20250313T140623"
 ```
 
 ---

package/docs/installation.md

@@ -14,7 +14,7 @@ Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. Us
 ```bash#macOS/Linux_(curl)
 $ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL
 # to install a specific version
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.6-canary.20250312T140728"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.6-canary.20250313T140623"
 ```
 
 ```bash#npm
@@ -189,10 +189,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
 
 ### Installing a specific version of Bun on Linux/Mac
 
-To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.6-canary.20250312T140728`.
+To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.6-canary.20250313T140623`.
 
 ```sh
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.6-canary.20250312T140728"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.6-canary.20250313T140623"
 ```
 
 ### Installing a specific version of Bun on Windows
@@ -201,7 +201,7 @@ On Windows, you can install a specific version of Bun by passing the version num
 
 ```sh
 # PowerShell:
-$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.6-canary.20250312T140728"
+$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.6-canary.20250313T140623"
 ```
 
 ## Downloading Bun binaries directly

package/docs/project/contributing.md

@@ -205,18 +205,30 @@ WebKit is not cloned by default (to save time and disk space). To clone and buil
 # Clone WebKit into ./vendor/WebKit
 $ git clone https://github.com/oven-sh/WebKit vendor/WebKit
 
+# Check out the commit hash specified in `set(WEBKIT_VERSION <commit_hash>)` in cmake/tools/SetupWebKit.cmake
+$ git -C vendor/WebKit checkout <commit_hash>
+
 # Make a debug build of JSC. This will output build artifacts in ./vendor/WebKit/WebKitBuild/Debug
 # Optionally, you can use `make jsc` for a release build
-$ make jsc-debug
+$ make jsc-debug && rm vendor/WebKit/WebKitBuild/Debug/JavaScriptCore/DerivedSources/inspector/InspectorProtocolObjects.h
 
 # Build bun with the local JSC build
 $ bun run build:local
 ```
 
+Using `bun run build:local` will build Bun in the `./build/debug-local` directory (instead of `./build/debug`), you'll have to change a couple of places to use this new directory:
+
+- The first line in [`src/js/builtins.d.ts`](/src/js/builtins.d.ts)
+- The `CompilationDatabase` line in [`.clangd` config](/.clangd) should be `CompilationDatabase: build/debug-local`
+- In [`build.zig`](/build.zig), the `codegen_path` option should be `build/debug-local/codegen` (instead of `build/debug/codegen`)
+- In [`.vscode/launch.json`](/.vscode/launch.json), many configurations use `./build/debug/`, change them as you see fit
+
 Note that the WebKit folder, including build artifacts, is 8GB+ in size.
 
 If you are using a JSC debug build and using VScode, make sure to run the `C/C++: Select a Configuration` command to configure intellisense to find the debug headers.
 
+Note that if you change make changes to our [WebKit fork](https://github.com/oven-sh/WebKit), you will also have to change [`SetupWebKit.cmake`](/cmake/tools/SetupWebKit.cmake) to point to the commit hash.
+
 ## Troubleshooting
 
 ### 'span' file not found on Ubuntu

package/docs/runtime/debugger.md

@@ -124,11 +124,11 @@ await fetch("https://example.com", {
 This prints the `fetch` request as a single-line `curl` command to let you copy-paste into your terminal to replicate the request.
 
 ```sh
-[fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.6-canary.20250312T140728" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
+[fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.6-canary.20250313T140623" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
 [fetch] > HTTP/1.1 POST https://example.com/
 [fetch] > content-type: application/json
 [fetch] > Connection: keep-alive
-[fetch] > User-Agent: Bun/1.2.6-canary.20250312T140728
+[fetch] > User-Agent: Bun/1.2.6-canary.20250313T140623
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br
@@ -170,7 +170,7 @@ This prints the following to the console:
 [fetch] > HTTP/1.1 POST https://example.com/
 [fetch] > content-type: application/json
 [fetch] > Connection: keep-alive
-[fetch] > User-Agent: Bun/1.2.6-canary.20250312T140728
+[fetch] > User-Agent: Bun/1.2.6-canary.20250313T140623
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/runtime/nodejs-apis.md

@@ -346,7 +346,7 @@ The table below lists all globals implemented by Node.js and Bun's current compa
 
 ### [`process`](https://nodejs.org/api/process.html)
 
-🟡 Mostly implemented. `process.binding` (internal Node.js bindings some packages rely on) is partially implemented. `process.title` is a currently a no-op on macOS & Linux. `getActiveResourcesInfo` `setActiveResourcesInfo`, `getActiveResources` and `setSourceMapsEnabled` are stubs. Newer APIs like `process.loadEnvFile` and `process.getBuiltinModule` are not implemented yet.
+🟡 Mostly implemented. `process.binding` (internal Node.js bindings some packages rely on) is partially implemented. `process.title` is currently a no-op on macOS & Linux. `getActiveResourcesInfo` `setActiveResourcesInfo`, `getActiveResources` and `setSourceMapsEnabled` are stubs. Newer APIs like `process.loadEnvFile` and `process.getBuiltinModule` are not implemented yet.
 
 ### [`queueMicrotask()`](https://developer.mozilla.org/en-US/docs/Web/API/queueMicrotask)
 

package/docs/test/dom.md

@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
 
 ```bash
 $ bun test
-bun test v1.2.6-canary.20250312T140728
+bun test v1.2.6-canary.20250313T140623
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.2.6-canary.20250312T140728",
+	"version": "1.2.6-canary.20250313T140623",
 	"name": "bun-types",
 	"license": "MIT",
 	"types": "./index.d.ts",