bun-types 1.2.6 → 1.2.8-canary.20250327T140605

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"
+Bun.version; // => "1.2.8-canary.20250327T140605"
 ```
 
 ---

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"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.8-canary.20250327T140605"
 ```
 
 ```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`.
+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.8-canary.20250327T140605`.
 
 ```sh
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.6"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.8-canary.20250327T140605"
 ```
 
 ### 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"
+$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.8-canary.20250327T140605"
 ```
 
 ## Downloading Bun binaries directly

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" -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.8-canary.20250327T140605" -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
+[fetch] > User-Agent: Bun/1.2.8-canary.20250327T140605
 [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
+[fetch] > User-Agent: Bun/1.2.8-canary.20250327T140605
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/runtime/nodejs-apis.md

@@ -104,7 +104,7 @@ This page is updated regularly to reflect compatibility status of the latest ver
 
 ### [`node:crypto`](https://nodejs.org/api/crypto.html)
 
-🟡 Missing `ECDH` `checkPrime` `checkPrimeSync` `generatePrime` `generatePrimeSync` `hkdf` `hkdfSync` `secureHeapUsed` `setEngine` `setFips`
+🟡 Missing `secureHeapUsed` `setEngine` `setFips`
 
 Some methods are not optimized yet.
 

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
+bun test v1.2.8-canary.20250327T140605
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/docs/typescript.md

@@ -17,7 +17,7 @@ Bun supports things like top-level await, JSX, and extensioned `.ts` imports, wh
 ```jsonc
 {
   "compilerOptions": {
-    // Enable latest features
+    // Environment setup & latest features
     "lib": ["ESNext"],
     "target": "ESNext",
     "module": "ESNext",
@@ -35,12 +35,13 @@ Bun supports things like top-level await, JSX, and extensioned `.ts` imports, wh
     "strict": true,
     "skipLibCheck": true,
     "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
 
-    // Some stricter flags
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noPropertyAccessFromIndexSignature": true
-  }
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false,
+  },
 }
 ```
 

package/extensions.d.ts

@@ -0,0 +1,31 @@
+declare module "*.txt" {
+  var text: string;
+  export = text;
+}
+
+declare module "*.toml" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*.jsonc" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*/bun.lock" {
+  var contents: import("bun").BunLockFile;
+  export = contents;
+}
+
+declare module "*.html" {
+  // In Bun v1.2, this might change to Bun.HTMLBundle
+  var contents: any;
+  export = contents;
+}
+
+declare module "*.svg" {
+  // Bun 1.2.3 added support for frontend dev server
+  var content: `${string}.svg`;
+  export = content;
+}

package/fetch.d.ts

@@ -1,169 +1,72 @@
-interface Headers {
-	/**
-	 * Convert {@link Headers} to a plain JavaScript object.
-	 *
-	 * About 10x faster than `Object.fromEntries(headers.entries())`
-	 *
-	 * Called when you run `JSON.stringify(headers)`
-	 *
-	 * Does not preserve insertion order. Well-known header names are lowercased. Other header names are left as-is.
-	 */
-	toJSON(): Record<string, string>;
-	/**
-	 * Get the total number of headers
-	 */
-	readonly count: number;
-	/**
-	 * Get all headers matching the name
-	 *
-	 * Only supports `"Set-Cookie"`. All other headers are empty arrays.
-	 *
-	 * @param name - The header name to get
-	 *
-	 * @returns An array of header values
-	 *
-	 * @example
-	 * ```ts
-	 * const headers = new Headers();
-	 * headers.append("Set-Cookie", "foo=bar");
-	 * headers.append("Set-Cookie", "baz=qux");
-	 * headers.getAll("Set-Cookie"); // ["foo=bar", "baz=qux"]
-	 * ```
-	 */
-	getAll(name: "set-cookie" | "Set-Cookie"): string[];
-}
-
-var Headers: {
-	prototype: Headers;
-	new (init?: Bun.HeadersInit): Headers;
-};
-
-interface Request {
-	headers: Headers;
-}
-
-var Request: {
-	prototype: Request;
-	new (requestInfo: string, requestInit?: RequestInit): Request;
-	new (requestInfo: RequestInit & { url: string }): Request;
-	new (requestInfo: Request, requestInit?: RequestInit): Request;
-};
+/*
 
-var Response: {
-	new (
-		body?: Bun.BodyInit | null | undefined,
-		init?: Bun.ResponseInit | undefined,
-	): Response;
-	/**
-	 * Create a new {@link Response} with a JSON body
-	 *
-	 * @param body - The body of the response
-	 * @param options - options to pass to the response
-	 *
-	 * @example
-	 *
-	 * ```ts
-	 * const response = Response.json({hi: "there"});
-	 * console.assert(
-	 *   await response.text(),
-	 *   `{"hi":"there"}`
-	 * );
-	 * ```
-	 * -------
-	 *
-	 * This is syntactic sugar for:
-	 * ```js
-	 *  new Response(JSON.stringify(body), {headers: { "Content-Type": "application/json" }})
-	 * ```
-	 * @link https://github.com/whatwg/fetch/issues/1389
-	 */
-	json(body?: any, options?: Bun.ResponseInit | number): Response;
+  This file does not declare any global types.
 
-	/**
-	 * Create a new {@link Response} that redirects to url
-	 *
-	 * @param url - the URL to redirect to
-	 * @param status - the HTTP status code to use for the redirect
-	 */
-	// tslint:disable-next-line:unified-signatures
-	redirect(url: string, status?: number): Response;
+  That should only happen in [./globals.d.ts](./globals.d.ts)
+  so that our documentation generator can pick it up, as it
+  expects all globals to be declared in one file.
 
-	/**
-	 * Create a new {@link Response} that redirects to url
-	 *
-	 * @param url - the URL to redirect to
-	 * @param options - options to pass to the response
-	 */
-	// tslint:disable-next-line:unified-signatures
-	redirect(url: string, options?: Bun.ResponseInit): Response;
+ */
 
-	/**
-	 * Create a new {@link Response} that has a network error
-	 */
-	error(): Response;
-};
+declare module "bun" {
+  type HeadersInit = string[][] | Record<string, string | ReadonlyArray<string>> | Headers;
+  type BodyInit = ReadableStream | Bun.XMLHttpRequestBodyInit | URLSearchParams | AsyncGenerator<Uint8Array>;
 
-type _BunTLSOptions = import("bun").TLSOptions;
-interface BunFetchRequestInitTLS extends _BunTLSOptions {
-	/**
-	 * Custom function to check the server identity
-	 * @param hostname - The hostname of the server
-	 * @param cert - The certificate of the server
-	 * @returns An error if the server is unauthorized, otherwise undefined
-	 */
-	checkServerIdentity?: NonNullable<
-		import("node:tls").ConnectionOptions["checkServerIdentity"]
-	>;
-}
+  namespace __internal {
+    type LibOrFallbackHeaders = LibDomIsLoaded extends true ? {} : import("undici-types").Headers;
+    type LibOrFallbackRequest = LibDomIsLoaded extends true ? {} : import("undici-types").Request;
+    type LibOrFallbackResponse = LibDomIsLoaded extends true ? {} : import("undici-types").Response;
+    type LibOrFallbackResponseInit = LibDomIsLoaded extends true ? {} : import("undici-types").ResponseInit;
+    type LibOrFallbackRequestInit = LibDomIsLoaded extends true
+      ? {}
+      : Omit<import("undici-types").RequestInit, "body" | "headers"> & {
+          body?: Bun.BodyInit | null | undefined;
+          headers?: Bun.HeadersInit;
+        };
 
-/**
- * BunFetchRequestInit represents additional options that Bun supports in `fetch()` only.
- *
- * Bun extends the `fetch` API with some additional options, except
- * this interface is not quite a `RequestInit`, because they won't work
- * if passed to `new Request()`. This is why it's a separate type.
- */
-interface BunFetchRequestInit extends RequestInit {
-	/**
-	 * Override the default TLS options
-	 */
-	tls?: BunFetchRequestInitTLS;
-}
+    interface BunHeadersOverride extends LibOrFallbackHeaders {
+      /**
+       * Convert {@link Headers} to a plain JavaScript object.
+       *
+       * About 10x faster than `Object.fromEntries(headers.entries())`
+       *
+       * Called when you run `JSON.stringify(headers)`
+       *
+       * Does not preserve insertion order. Well-known header names are lowercased. Other header names are left as-is.
+       */
+      toJSON(): Record<string, string>;
 
-var fetch: {
-	/**
-	 * Send a HTTP(s) request
-	 *
-	 * @param request Request object
-	 * @param init A structured value that contains settings for the fetch() request.
-	 *
-	 * @returns A promise that resolves to {@link Response} object.
-	 */
-	(request: Request, init?: BunFetchRequestInit): Promise<Response>;
+      /**
+       * Get the total number of headers
+       */
+      readonly count: number;
 
-	/**
-	 * Send a HTTP(s) request
-	 *
-	 * @param url URL string
-	 * @param init A structured value that contains settings for the fetch() request.
-	 *
-	 * @returns A promise that resolves to {@link Response} object.
-	 */
-	(url: string | URL | Request, init?: BunFetchRequestInit): Promise<Response>;
+      /**
+       * Get all headers matching the name
+       *
+       * Only supports `"Set-Cookie"`. All other headers are empty arrays.
+       *
+       * @param name - The header name to get
+       *
+       * @returns An array of header values
+       *
+       * @example
+       * ```ts
+       * const headers = new Headers();
+       * headers.append("Set-Cookie", "foo=bar");
+       * headers.append("Set-Cookie", "baz=qux");
+       * headers.getAll("Set-Cookie"); // ["foo=bar", "baz=qux"]
+       * ```
+       */
+      getAll(name: "set-cookie" | "Set-Cookie"): string[];
+    }
 
-	(
-		input: string | URL | globalThis.Request,
-		init?: BunFetchRequestInit,
-	): Promise<Response>;
+    interface BunRequestOverride extends LibOrFallbackRequest {
+      headers: BunHeadersOverride;
+    }
 
-	/**
-	 * Start the DNS resolution, TCP connection, and TLS handshake for a request
-	 * before the request is actually sent.
-	 *
-	 * This can reduce the latency of a request when you know there's some
-	 * long-running task that will delay the request starting.
-	 *
-	 * This is a bun-specific API and is not part of the Fetch API specification.
-	 */
-	preconnect(url: string | URL): void;
-};
+    interface BunResponseOverride extends LibOrFallbackResponse {
+      headers: BunHeadersOverride;
+    }
+  }
+}