bun-types 1.2.20-canary.20250731T140826 → 1.2.20-canary.20250802T140550

package/docs/test/dom.md

@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
 
 ```bash
 $ bun test
-bun test v1.2.20-canary.20250731T140826
+bun test v1.2.20-canary.20250802T140550
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/docs/test/writing.md

@@ -426,6 +426,54 @@ test("exactly two assertions", () => {
 
 This helps ensure all your assertions run, especially in complex async code with multiple code paths.
 
+## Type Testing
+
+Bun includes `expectTypeOf` for testing typescript types, compatible with Vitest.
+
+### expectTypeOf
+
+{% callout %}
+
+**Note** — These functions are no-ops at runtime - you need to run TypeScript separately to verify the type checks.
+
+{% endcallout %}
+
+The `expectTypeOf` function provides type-level assertions that are checked by TypeScript's type checker. **Important**:
+
+To test your types:
+
+1. Write your type assertions using `expectTypeOf`
+2. Run `bunx tsc --noEmit` to check that your types are correct
+
+```ts
+import { expectTypeOf } from "bun:test";
+
+// Basic type assertions
+expectTypeOf<string>().toEqualTypeOf<string>();
+expectTypeOf(123).toBeNumber();
+expectTypeOf("hello").toBeString();
+
+// Object type matching
+expectTypeOf({ a: 1, b: "hello" }).toMatchObjectType<{ a: number }>();
+
+// Function types
+function greet(name: string): string {
+  return `Hello ${name}`;
+}
+
+expectTypeOf(greet).toBeFunction();
+expectTypeOf(greet).parameters.toEqualTypeOf<[string]>();
+expectTypeOf(greet).returns.toEqualTypeOf<string>();
+
+// Array types
+expectTypeOf([1, 2, 3]).items.toBeNumber();
+
+// Promise types
+expectTypeOf(Promise.resolve(42)).resolves.toBeNumber();
+```
+
+For full documentation on expectTypeOf matchers, see the [API Reference](/reference/bun/test/expectTypeOf)
+
 ## Matchers
 
 Bun implements the following matchers. Full Jest compatibility is on the roadmap; track progress [here](https://github.com/oven-sh/bun/issues/1825).
@@ -629,17 +677,17 @@ Bun implements the following matchers. Full Jest compatibility is on the roadmap
 
 ---
 
-- ❌
+- ✅
 - [`.toHaveReturnedWith()`](https://jestjs.io/docs/expect#tohavereturnedwithvalue)
 
 ---
 
-- ❌
+- ✅
 - [`.toHaveLastReturnedWith()`](https://jestjs.io/docs/expect#tohavelastreturnedwithvalue)
 
 ---
 
-- ❌
+- ✅
 - [`.toHaveNthReturnedWith()`](https://jestjs.io/docs/expect#tohaventhreturnedwithnthcall-value)
 
 ---

package/fetch.d.ts

@@ -1,19 +1,21 @@
 /*
-
-  This file does not declare any global types.
-
-  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.
-
+ * This file does not declare any global types.
+ *
+ * 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.
+ *
+ * This may change in the future, which would be
+ * a nice thing as it would allow us to split up
+ * relevant types into their own files.
  */
-
 declare module "bun" {
   type HeadersInit = string[][] | Record<string, string | ReadonlyArray<string>> | Headers;
   type BodyInit =
     | ReadableStream
     | Bun.XMLHttpRequestBodyInit
-    | URLSearchParams
+    // Extras that Bun supports:
+    | AsyncIterable<string | ArrayBuffer | ArrayBufferView>
     | AsyncGenerator<string | ArrayBuffer | ArrayBufferView>
     | (() => AsyncGenerator<string | ArrayBuffer | ArrayBufferView>);
 
@@ -26,7 +28,7 @@ declare module "bun" {
       ? {}
       : Omit<import("undici-types").RequestInit, "body" | "headers"> & {
           body?: Bun.BodyInit | null | undefined;
-          headers?: Bun.HeadersInit;
+          headers?: Bun.HeadersInit | undefined;
         };
 
     interface BunHeadersOverride extends LibOrFallbackHeaders {

package/globals.d.ts

@@ -999,6 +999,7 @@ interface ArrayBuffer {
    * Read-only. The length of the ArrayBuffer (in bytes).
    */
   readonly byteLength: number;
+
   /**
    * Resize an ArrayBuffer in-place.
    */
@@ -1008,7 +1009,6 @@ interface ArrayBuffer {
    * Returns a section of an ArrayBuffer.
    */
   slice(begin: number, end?: number): ArrayBuffer;
-  readonly [Symbol.toStringTag]: string;
 }
 
 interface SharedArrayBuffer {
@@ -1426,12 +1426,12 @@ interface Blob {
   /**
    * Returns a promise that resolves to the contents of the blob as a Uint8Array (array of bytes) its the same as `new Uint8Array(await blob.arrayBuffer())`
    */
-  bytes(): Promise<Uint8Array>;
+  bytes(): Promise<Uint8Array<ArrayBuffer>>;
 
   /**
    * Returns a readable stream of the blob's contents
    */
-  stream(): ReadableStream<Uint8Array>;
+  stream(): ReadableStream<Uint8Array<ArrayBuffer>>;
 }
 
 declare var Blob: Bun.__internal.UseLibDomIfAvailable<
@@ -1506,14 +1506,14 @@ interface Uint8ArrayConstructor {
       alphabet?: "base64" | "base64url";
       lastChunkHandling?: "loose" | "strict" | "stop-before-partial";
     },
-  ): Uint8Array;
+  ): Uint8Array<ArrayBuffer>;
 
   /**
    * Create a new Uint8Array from a hex encoded string
    * @param hex The hex encoded string to convert to a Uint8Array
    * @returns A new Uint8Array containing the decoded data
    */
-  fromHex(hex: string): Uint8Array;
+  fromHex(hex: string): Uint8Array<ArrayBuffer>;
 }
 
 interface BroadcastChannel extends Bun.__internal.LibEmptyOrBroadcastChannel {}

package/overrides.d.ts

@@ -6,14 +6,17 @@ declare module "stream/web" {
      * Consume a ReadableStream as text
      */
     text(): Promise<string>;
+
     /**
      * Consume a ReadableStream as a Uint8Array
      */
-    bytes(): Promise<Uint8Array>;
+    bytes(): Promise<Uint8Array<ArrayBuffer>>;
+
     /**
      * Consume a ReadableStream as JSON
      */
     json(): Promise<any>;
+
     /**
      * Consume a ReadableStream as a Blob
      */

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.20-canary.20250731T140826",
+  "version": "1.2.20-canary.20250802T140550",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",
@@ -11,10 +11,11 @@
   },
   "files": [
     "./*.d.ts",
-    "docs/**/*.md",
-    "docs/*.md",
-    "CLAUDE.md",
-    "README.md"
+    "./vendor/**/*.d.ts",
+    "./docs/**/*.md",
+    "./docs/*.md",
+    "./CLAUDE.md",
+    "./README.md"
   ],
   "homepage": "https://bun.com",
   "dependencies": {
@@ -24,8 +25,7 @@
     "@types/react": "^19"
   },
   "devDependencies": {
-    "@types/react": "^19",
-    "typescript": "^5.0.2"
+    "@types/react": "^19"
   },
   "scripts": {
     "prebuild": "echo $(pwd)",

package/s3.d.ts

@@ -487,8 +487,8 @@ declare module "bun" {
      *       // Process text chunk by chunk
      *     }
      */
-    readonly readable: ReadableStream;
-    stream(): ReadableStream;
+    readonly readable: ReadableStream<Uint8Array<ArrayBuffer>>;
+    stream(): ReadableStream<Uint8Array<ArrayBuffer>>;
 
     /**
      * The name or path of the file in the bucket.

package/shell.d.ts

@@ -1,6 +1,4 @@
 declare module "bun" {
-  type ShellFunction = (input: Uint8Array) => Uint8Array;
-
   type ShellExpression =
     | { toString(): string }
     | Array<ShellExpression>
@@ -294,7 +292,7 @@ declare module "bun" {
        * console.log(output.bytes()); // Uint8Array { byteLength: 6 }
        * ```
        */
-      bytes(): Uint8Array;
+      bytes(): Uint8Array<ArrayBuffer>;
     }
 
     interface ShellOutput {
@@ -361,7 +359,7 @@ declare module "bun" {
        * console.log(output.bytes()); // Uint8Array { byteLength: 6 }
        * ```
        */
-      bytes(): Uint8Array;
+      bytes(): Uint8Array<ArrayBuffer>;
 
       /**
        * Read from stdout as a Blob

package/sqlite.d.ts

@@ -383,19 +383,28 @@ declare module "bun:sqlite" {
      * ]);
      * ```
      */
-    transaction(insideTransaction: (...args: any) => void): CallableFunction & {
+    transaction<A extends any[], T>(
+      insideTransaction: (...args: A) => T,
+    ): {
       /**
-       * uses "BEGIN DEFERRED"
+       * Execute the transaction
        */
-      deferred: (...args: any) => void;
+      (...args: A): T;
+
       /**
-       * uses "BEGIN IMMEDIATE"
+       * Execute the transaction using "BEGIN DEFERRED"
        */
-      immediate: (...args: any) => void;
+      deferred: (...args: A) => T;
+
+      /**
+       * Execute the transaction using "BEGIN IMMEDIATE"
+       */
+      immediate: (...args: A) => T;
+
       /**
-       * uses "BEGIN EXCLUSIVE"
+       * Execute the transaction using "BEGIN EXCLUSIVE"
        */
-      exclusive: (...args: any) => void;
+      exclusive: (...args: A) => T;
     };
 
     /**
@@ -664,7 +673,7 @@ declare module "bun:sqlite" {
     [Symbol.iterator](): IterableIterator<ReturnType>;
 
     /**
-     * Execute the prepared statement. This returns `undefined`.
+     * Execute the prepared statement.
      *
      * @param params optional values to bind to the statement. If omitted, the statement is run with the last bound values or no parameters if there are none.
      *

package/test-globals.d.ts

@@ -10,6 +10,7 @@ declare var test: typeof import("bun:test").test;
 declare var it: typeof import("bun:test").it;
 declare var describe: typeof import("bun:test").describe;
 declare var expect: typeof import("bun:test").expect;
+declare var expectTypeOf: typeof import("bun:test").expectTypeOf;
 declare var beforeAll: typeof import("bun:test").beforeAll;
 declare var beforeEach: typeof import("bun:test").beforeEach;
 declare var afterEach: typeof import("bun:test").afterEach;

package/test.d.ts

@@ -56,6 +56,11 @@ declare module "bun:test" {
      * Restore the previous value of mocks.
      */
     restore(): void;
+
+    /**
+     * Reset all mock function state (calls, results, etc.) without restoring their original implementation.
+     */
+    clearAllMocks(): void;
   };
 
   /**
@@ -1642,6 +1647,26 @@ declare module "bun:test" {
      */
     toHaveReturnedTimes(times: number): void;
 
+    /**
+     * Ensures that a mock function has returned a specific value.
+     * This matcher uses deep equality, like toEqual(), and supports asymmetric matchers.
+     */
+    toHaveReturnedWith(expected: unknown): void;
+
+    /**
+     * Ensures that a mock function has returned a specific value on its last invocation.
+     * This matcher uses deep equality, like toEqual(), and supports asymmetric matchers.
+     */
+    toHaveLastReturnedWith(expected: unknown): void;
+
+    /**
+     * Ensures that a mock function has returned a specific value on the nth invocation.
+     * This matcher uses deep equality, like toEqual(), and supports asymmetric matchers.
+     * @param n The 1-based index of the function call
+     * @param expected The expected return value
+     */
+    toHaveNthReturnedWith(n: number, expected: unknown): void;
+
     /**
      * Ensures that a mock function is called.
      */
@@ -2182,4 +2207,6 @@ declare module "bun:test" {
 
     export type UnknownFunction = (...args: unknown[]) => unknown;
   }
+
+  export const expectTypeOf: typeof import("./vendor/expect-type").expectTypeOf;
 }

package/vendor/expect-type/branding.d.ts

@@ -0,0 +1,283 @@
+/*
+   Copyright 2024 Misha Kaletsky
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+*/
+
+import type { ConstructorOverloadParameters, NumOverloads, OverloadsInfoUnion } from "./overloads";
+import type {
+  IsAny,
+  IsNever,
+  IsUnknown,
+  MutuallyExtends,
+  OptionalKeys,
+  ReadonlyKeys,
+  RequiredKeys,
+  UnionToTuple,
+} from "./utils";
+/**
+ * Represents a deeply branded type.
+ *
+ * Recursively walk a type and replace it with a branded type related to the
+ * original. This is useful for equality-checking stricter than
+ * `A extends B ? B extends A ? true : false : false`, because it detects the
+ * difference between a few edge-case types that vanilla TypeScript
+ * doesn't by default:
+ * - `any` vs `unknown`
+ * - `{ readonly a: string }` vs `{ a: string }`
+ * - `{ a?: string }` vs `{ a: string | undefined }`
+ *
+ * __Note__: not very performant for complex types - this should only be used
+ * when you know you need it. If doing an equality check, it's almost always
+ * better to use {@linkcode StrictEqualUsingTSInternalIdenticalToOperator}.
+ */
+export type DeepBrand<T> =
+  IsNever<T> extends true
+    ? {
+        type: "never";
+      }
+    : IsAny<T> extends true
+      ? {
+          type: "any";
+        }
+      : IsUnknown<T> extends true
+        ? {
+            type: "unknown";
+          }
+        : T extends string | number | boolean | symbol | bigint | null | undefined | void
+          ? {
+              type: "primitive";
+              value: T;
+            }
+          : T extends new (...args: any[]) => any
+            ? {
+                type: "constructor";
+                params: ConstructorOverloadParameters<T>;
+                instance: DeepBrand<InstanceType<Extract<T, new (...args: any) => any>>>;
+              }
+            : T extends (...args: infer P) => infer R
+              ? NumOverloads<T> extends 1
+                ? {
+                    type: "function";
+                    params: DeepBrand<P>;
+                    return: DeepBrand<R>;
+                    this: DeepBrand<ThisParameterType<T>>;
+                    props: DeepBrand<Omit<T, keyof Function>>;
+                  }
+                : UnionToTuple<OverloadsInfoUnion<T>> extends infer OverloadsTuple
+                  ? {
+                      type: "overloads";
+                      overloads: {
+                        [K in keyof OverloadsTuple]: DeepBrand<OverloadsTuple[K]>;
+                      };
+                    }
+                  : never
+              : T extends any[]
+                ? {
+                    type: "array";
+                    items: {
+                      [K in keyof T]: T[K];
+                    };
+                  }
+                : {
+                    type: "object";
+                    properties: {
+                      [K in keyof T]: DeepBrand<T[K]>;
+                    };
+                    readonly: ReadonlyKeys<T>;
+                    required: RequiredKeys<T>;
+                    optional: OptionalKeys<T>;
+                    constructorParams: DeepBrand<ConstructorOverloadParameters<T>>;
+                  };
+/**
+ * Checks if two types are strictly equal using branding.
+ */
+export type StrictEqualUsingBranding<Left, Right> = MutuallyExtends<DeepBrand<Left>, DeepBrand<Right>>;