bun-types 1.2.11-canary.20250417T140614 → 1.2.11-canary.20250419T140546

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.11-canary.20250417T140614
+[fetch] > User-Agent: Bun/1.2.11-canary.20250419T140546
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/api/spawn.md

@@ -120,7 +120,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.11-canary.20250417T140614"
+console.log(text); // => "1.2.11-canary.20250419T140546"
 ```
 
 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.11-canary.20250417T140614 (ca7428e9)
+bun publish v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (16b4bf34)
+bun install v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614"
++   "@types/bun": "^1.2.11-canary.20250419T140546"
   }
 }
 ```
@@ -28,7 +28,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
 ```json-diff
 {
   "peerDependencies": {
-    "@types/bun": "^1.2.11-canary.20250417T140614"
+    "@types/bun": "^1.2.11-canary.20250419T140546"
   },
   "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.11-canary.20250417T140614
+$ bun update @types/bun@1.2.11-canary.20250419T140546
 
 # 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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614 (9c68abdb)
+bun test v1.2.11-canary.20250419T140546 (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.11-canary.20250417T140614"
+Bun.version; // => "1.2.11-canary.20250419T140546"
 ```
 
 ---

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.11-canary.20250417T140614"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.11-canary.20250419T140546"
 ```
 
 ```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.11-canary.20250417T140614`.
+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.11-canary.20250419T140546`.
 
 ```sh
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.11-canary.20250417T140614"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.11-canary.20250419T140546"
 ```
 
 ### 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.11-canary.20250417T140614"
+$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.11-canary.20250419T140546"
 ```
 
 ## Downloading Bun binaries directly

package/docs/project/bindgen.md

@@ -32,7 +32,7 @@ pub fn add(global: *JSC.JSGlobalObject, a: i32, b: i32) !i32 {
 const gen = bun.gen.math; // "math" being this file's basename
 
 const std = @import("std");
-const bun = @import("root").bun;
+const bun = @import("bun");
 const JSC = bun.JSC;
 ```
 

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.11-canary.20250417T140614" -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.11-canary.20250419T140546" -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.11-canary.20250417T140614
+[fetch] > User-Agent: Bun/1.2.11-canary.20250419T140546
 [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.11-canary.20250417T140614
+[fetch] > User-Agent: Bun/1.2.11-canary.20250419T140546
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/runtime/nodejs-apis.md

@@ -106,8 +106,6 @@ This page is updated regularly to reflect compatibility status of the latest ver
 
 🟡 Missing `secureHeapUsed` `setEngine` `setFips`
 
-Some methods are not optimized yet.
-
 ### [`node:domain`](https://nodejs.org/api/domain.html)
 
 🟡 Missing `Domain` `active`
@@ -379,6 +377,7 @@ The table below lists all globals implemented by Node.js and Bun's current compa
 ### [`require()`](https://nodejs.org/api/globals.html#require)
 
 🟢 Fully implemented, including [`require.main`](https://nodejs.org/api/modules.html#requiremain), [`require.cache`](https://nodejs.org/api/modules.html#requirecache), [`require.resolve`](https://nodejs.org/api/modules.html#requireresolverequest-options).
+
 ### [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
 
 🟢 Fully implemented.

package/docs/test/dom.md

@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
 
 ```bash
 $ bun test
-bun test v1.2.11-canary.20250417T140614
+bun test v1.2.11-canary.20250419T140546
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/fetch.d.ts

@@ -39,7 +39,7 @@ declare module "bun" {
        *
        * Does not preserve insertion order. Well-known header names are lowercased. Other header names are left as-is.
        */
-      toJSON(): Record<string, string>;
+      toJSON(): Record<string, string> & { "set-cookie"?: string[] };
 
       /**
        * Get the total number of headers

package/globals.d.ts

@@ -1312,7 +1312,7 @@ interface PromiseConstructor {
    * This is useful when you want to return a Promise and have code outside the Promise
    * resolve or reject it.
    *
-   * ## Example
+   * @example
    * ```ts
    * const { promise, resolve, reject } = Promise.withResolvers();
    *
@@ -1322,8 +1322,6 @@ interface PromiseConstructor {
    *
    * await promise; // "Hello world!"
    * ```
-   *
-   * `Promise.withResolvers()` is a [stage3 proposal](https://github.com/tc39/proposal-promise-with-resolvers).
    */
   withResolvers<T>(): {
     promise: Promise<T>;
@@ -1832,14 +1830,40 @@ interface BunFetchRequestInit extends RequestInit {
   /**
    * Override http_proxy or HTTPS_PROXY
    * This is a custom property that is not part of the Fetch API specification.
+   *
+   * @example
+   * ```js
+   * const response = await fetch("http://example.com", {
+   *  proxy: "https://username:password@127.0.0.1:8080"
+   * });
+   * ```
    */
   proxy?: string;
 
   /**
    * Override the default S3 options
+   *
+   * @example
+   * ```js
+   * const response = await fetch("s3://bucket/key", {
+   *   s3: {
+   *     accessKeyId: "AKIAIOSFODNN7EXAMPLE",
+   *     secretAccessKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+   *     region: "us-east-1",
+   *   }
+   * });
+   * ```
    */
   s3?: Bun.S3Options;
 
+  /**
+   * Make the request over a Unix socket
+   *
+   * @example
+   * ```js
+   * const response = await fetch("http://example.com", { unix: "/path/to/socket" });
+   * ```
+   */
   unix?: string;
 }
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.11-canary.20250417T140614",
+  "version": "1.2.11-canary.20250419T140546",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",

package/redis.d.ts

@@ -1,11 +1,5 @@
 declare module "bun" {
   export interface RedisOptions {
-    /**
-     * URL to connect to, defaults to "redis://localhost:6379"
-     * Supported protocols: redis://, rediss://, redis+unix://, redis+tls://
-     */
-    url?: string;
-
     /**
      * Connection timeout in milliseconds
      * @default 10000

package/s3.d.ts

@@ -764,7 +764,6 @@ declare module "bun" {
    * @category Cloud Storage
    */
   class S3Client {
-    prototype: S3Client;
     /**
      * Create a new instance of an S3 bucket so that credentials can be managed
      * from a single instance instead of being passed to every method.

package/shell.d.ts

@@ -12,7 +12,13 @@ declare module "bun" {
     | ReadableStream;
 
   /**
-   * The Bun shell
+   * The [Bun shell](https://bun.sh/docs/runtime/shell) is a powerful tool for running shell commands.
+   *
+   * @example
+   * ```ts
+   * const result = await $`echo "Hello, world!"`.text();
+   * console.log(result); // "Hello, world!"
+   * ```
    *
    * @category Process Management
    */
@@ -46,8 +52,7 @@ declare module "bun" {
      * @param newEnv Default environment variables to use for shells created by this instance.
      * @default process.env
      *
-     * ## Example
-     *
+     * @example
      * ```js
      * import {$} from 'bun';
      * $.env({ BUN: "bun" });
@@ -73,6 +78,17 @@ declare module "bun" {
      */
     function throws(shouldThrow: boolean): typeof $;
 
+    /**
+     * The `Bun.$.ShellPromise` class represents a shell command that gets executed
+     * once awaited, or called with `.text()`, `.json()`, etc.
+     *
+     * @example
+     * ```ts
+     * const myShellPromise = $`echo "Hello, world!"`;
+     * const result = await myShellPromise.text();
+     * console.log(result); // "Hello, world!"
+     * ```
+     */
     class ShellPromise extends Promise<ShellOutput> {
       get stdin(): WritableStream;
 
@@ -81,6 +97,7 @@ declare module "bun" {
        * @param newCwd - The new working directory
        */
       cwd(newCwd: string): this;
+
       /**
        * Set environment variables for the shell.
        * @param newEnv - The new environment variables
@@ -92,6 +109,7 @@ declare module "bun" {
        * ```
        */
       env(newEnv: Record<string, string> | undefined): this;
+
       /**
        * By default, the shell will write to the current process's stdout and stderr, as well as buffering that output.
        *
@@ -107,27 +125,25 @@ declare module "bun" {
       lines(): AsyncIterable<string>;
 
       /**
-       * Read from stdout as a string
+       * Read from stdout as a string.
        *
        * Automatically calls {@link quiet} to disable echoing to stdout.
+       *
        * @param encoding - The encoding to use when decoding the output
        * @returns A promise that resolves with stdout as a string
-       * @example
-       *
-       * ## Read as UTF-8 string
        *
+       * @example
+       * **Read as UTF-8 string**
        * ```ts
        * const output = await $`echo hello`.text();
        * console.log(output); // "hello\n"
        * ```
        *
-       * ## Read as base64 string
-       *
+       * **Read as base64 string**
        * ```ts
        * const output = await $`echo ${atob("hello")}`.text("base64");
        * console.log(output); // "hello\n"
        * ```
-       *
        */
       text(encoding?: BufferEncoding): Promise<string>;
 
@@ -189,6 +205,20 @@ declare module "bun" {
       throws(shouldThrow: boolean): this;
     }
 
+    /**
+     * ShellError represents an error that occurred while executing a shell command with [the Bun Shell](https://bun.sh/docs/runtime/shell).
+     *
+     * @example
+     * ```ts
+     * try {
+     *   const result = await $`exit 1`;
+     * } catch (error) {
+     *   if (error instanceof ShellError) {
+     *     console.log(error.exitCode); // 1
+     *   }
+     * }
+     * ```
+     */
     class ShellError extends Error implements ShellOutput {
       readonly stdout: Buffer;
       readonly stderr: Buffer;
@@ -199,22 +229,19 @@ declare module "bun" {
        *
        * @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
        *
+       * @example
+       * **Read as UTF-8 string**
        * ```ts
        * const output = await $`echo hello`;
        * console.log(output.text()); // "hello\n"
        * ```
        *
-       * ## Read as base64 string
-       *
+       * **Read as base64 string**
        * ```ts
        * const output = await $`echo ${atob("hello")}`;
        * console.log(output.text("base64")); // "hello\n"
        * ```
-       *
        */
       text(encoding?: BufferEncoding): string;
 
@@ -280,22 +307,19 @@ declare module "bun" {
        *
        * @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
        *
+       * @example
+       * **Read as UTF-8 string**
        * ```ts
        * const output = await $`echo hello`;
        * console.log(output.text()); // "hello\n"
        * ```
        *
-       * ## Read as base64 string
-       *
+       * **Read as base64 string**
        * ```ts
        * const output = await $`echo ${atob("hello")}`;
        * console.log(output.text("base64")); // "hello\n"
        * ```
-       *
        */
       text(encoding?: BufferEncoding): string;