bun-types 1.2.8-canary.20250330T140625 → 1.2.8

package/bun.d.ts

@@ -510,7 +510,7 @@ declare module "bun" {
     threadId: number;
   }
 
-  interface Env extends NodeJS.ProcessEnv {
+  interface Env {
     NODE_ENV?: string;
     /**
      * Can be used to change the default timezone at runtime
@@ -525,7 +525,7 @@ declare module "bun" {
    *
    * Changes to `process.env` at runtime won't automatically be reflected in the default value. For that, you can pass `process.env` explicitly.
    */
-  const env: Env;
+  const env: Env & NodeJS.ProcessEnv;
 
   /**
    * The raw arguments passed to the process, including flags passed to Bun. If you want to easily read flags passed to your script, consider using `process.argv` instead.
@@ -3061,8 +3061,6 @@ declare module "bun" {
   /**
    * A fast WebSocket designed for servers.
    *
-   * @category HTTP & Networking
-   *
    * Features:
    * - **Message compression** - Messages can be compressed
    * - **Backpressure** - If the client is not ready to receive data, the server will tell you.
@@ -3074,9 +3072,7 @@ declare module "bun" {
    * Powered by [uWebSockets](https://github.com/uNetworking/uWebSockets).
    *
    * @example
-   * import { serve } from "bun";
-   *
-   * serve({
+   * Bun.serve({
    *   websocket: {
    *     open(ws) {
    *       console.log("Connected", ws.remoteAddress);
@@ -3090,6 +3086,8 @@ declare module "bun" {
    *     },
    *   }
    * });
+   *
+   * @category HTTP & Networking
    */
   interface ServerWebSocket<T = undefined> {
     /**
@@ -3698,8 +3696,7 @@ declare module "bun" {
      *
      * @example
      * ```js
-     * import { serve } from "bun";
-     * serve({
+     * Bun.serve({
      *  websocket: {
      *    open: (ws) => {
      *      console.log("Client connected");
@@ -4040,13 +4037,13 @@ declare module "bun" {
    *
    * To start the server, see {@link serve}
    *
-   * @category HTTP & Networking
-   *
    * For performance, Bun pre-allocates most of the data for 2048 concurrent requests.
    * That means starting a new server allocates about 500 KB of memory. Try to
    * avoid starting and stopping the server often (unless it's a new instance of bun).
    *
-   * Powered by a fork of [uWebSockets](https://github.com/uNetworking/uWebSockets). Thank you @alexhultman.
+   * Powered by a fork of [uWebSockets](https://github.com/uNetworking/uWebSockets). Thank you \@alexhultman.
+   *
+   * @category HTTP & Networking
    */
   interface Server extends Disposable {
     /**
@@ -4261,15 +4258,30 @@ declare module "bun" {
 
     readonly url: URL;
 
-    readonly port: number;
     /**
-     * The hostname the server is listening on. Does not include the port
+     * The port the server is listening on.
+     *
+     * This will be undefined when the server is listening on a unix socket.
+     *
+     * @example
+     * ```js
+     * 3000
+     * ```
+     */
+    readonly port: number | undefined;
+
+    /**
+     * The hostname the server is listening on. Does not include the port.
+     *
+     * This will be `undefined` when the server is listening on a unix socket.
+     *
      * @example
      * ```js
      * "localhost"
      * ```
      */
-    readonly hostname: string;
+    readonly hostname: string | undefined;
+
     /**
      * Is the server running in development mode?
      *

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.8-canary.20250330T140625
+[fetch] > User-Agent: Bun/1.2.8
 [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.8-canary.20250330T140625"
+console.log(text); // => "1.2.8"
 ```
 
 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.8-canary.20250330T140625 (ca7428e9)
+bun publish v1.2.8 (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.8-canary.20250330T140625 (16b4bf34)
+bun install v1.2.8 (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.8-canary.20250330T140625"
++   "@types/bun": "^1.2.8"
   }
 }
 ```
@@ -28,7 +28,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
 ```json-diff
 {
   "peerDependencies": {
-    "@types/bun": "^1.2.8-canary.20250330T140625"
+    "@types/bun": "^1.2.8"
   },
   "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.8-canary.20250330T140625
+$ bun update @types/bun@1.2.8
 
 # 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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625 (9c68abdb)
+bun test v1.2.8 (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.8-canary.20250330T140625"
+Bun.version; // => "1.2.8"
 ```
 
 ---

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.8-canary.20250330T140625"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.8"
 ```
 
 ```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.8-canary.20250330T140625`.
+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`.
 
 ```sh
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.8-canary.20250330T140625"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.8"
 ```
 
 ### 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.8-canary.20250330T140625"
+$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.8"
 ```
 
 ## 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.8-canary.20250330T140625" -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" -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.8-canary.20250330T140625
+[fetch] > User-Agent: Bun/1.2.8
 [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.8-canary.20250330T140625
+[fetch] > User-Agent: Bun/1.2.8
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/test/dom.md

@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
 
 ```bash
 $ bun test
-bun test v1.2.8-canary.20250330T140625
+bun test v1.2.8
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/globals.d.ts

@@ -16,15 +16,11 @@ declare module "bun" {
 
     type LibEmptyOrNodeUtilTextDecoder = LibDomIsLoaded extends true ? {} : import("util").TextDecoder;
 
-    type LibEmptyOrNodeReadableStream<T = any> = LibDomIsLoaded extends true
-      ? {}
-      : import("stream/web").ReadableStream<T>;
+    type LibEmptyOrNodeReadableStream<T> = LibDomIsLoaded extends true ? {} : import("stream/web").ReadableStream<T>;
 
-    type LibEmptyOrNodeWritableStream<T = any> = LibDomIsLoaded extends true
-      ? {}
-      : import("stream/web").WritableStream<T>;
+    type LibEmptyOrNodeWritableStream<T> = LibDomIsLoaded extends true ? {} : import("stream/web").WritableStream<T>;
 
-    type LibEmptyOrNodeTransformStream<I = any, O = any> = LibDomIsLoaded extends true
+    type LibEmptyOrNodeTransformStream<I, O> = LibDomIsLoaded extends true
       ? {}
       : import("stream/web").TransformStream<I, O>;
 
@@ -32,7 +28,7 @@ declare module "bun" {
   }
 }
 
-interface ReadableStream<R = any> extends Bun.__internal.LibEmptyOrNodeReadableStream {}
+interface ReadableStream<R = any> extends Bun.__internal.LibEmptyOrNodeReadableStream<R> {}
 declare var ReadableStream: Bun.__internal.UseLibDomIfAvailable<
   "ReadableStream",
   {
@@ -42,7 +38,7 @@ declare var ReadableStream: Bun.__internal.UseLibDomIfAvailable<
   }
 >;
 
-interface WritableStream<W = any> extends Bun.__internal.LibEmptyOrNodeWritableStream {}
+interface WritableStream<W = any> extends Bun.__internal.LibEmptyOrNodeWritableStream<W> {}
 declare var WritableStream: Bun.__internal.UseLibDomIfAvailable<
   "WritableStream",
   {
@@ -1750,6 +1746,8 @@ interface BunFetchRequestInit extends RequestInit {
    * Override the default S3 options
    */
   s3?: Bun.S3Options;
+
+  unix?: string;
 }
 
 /**

package/overrides.d.ts

@@ -2,6 +2,8 @@ export {};
 
 declare global {
   namespace NodeJS {
+    interface ProcessEnv extends Bun.Env {}
+
     interface Process {
       readonly version: string;
       browser: boolean;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.8-canary.20250330T140625",
+  "version": "1.2.8",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",

package/s3.d.ts

@@ -90,7 +90,7 @@ declare module "bun" {
      *
      * @example
      *     // Setting public read access
-     *     const file = s3("public-file.txt", {
+     *     const file = s3.file("public-file.txt", {
      *       acl: "public-read",
      *       bucket: "my-bucket"
      *     });
@@ -113,24 +113,24 @@ declare module "bun" {
       | "log-delivery-write";
 
     /**
-     * The S3 bucket name. Can be set via `S3_BUCKET` or `AWS_BUCKET` environment variables.
+     * The S3 bucket name. Defaults to `S3_BUCKET` or `AWS_BUCKET` environment variables.
      *
      * @example
      *     // Using explicit bucket
-     *     const file = s3("my-file.txt", { bucket: "my-bucket" });
+     *     const file = s3.file("my-file.txt", { bucket: "my-bucket" });
      *
      * @example
      *     // Using environment variables
      *     // With S3_BUCKET=my-bucket in .env
-     *     const file = s3("my-file.txt");
+     *     const file = s3.file("my-file.txt");
      */
     bucket?: string;
 
     /**
-     * The AWS region. Can be set via `S3_REGION` or `AWS_REGION` environment variables.
+     * The AWS region. Defaults to `S3_REGION` or `AWS_REGION` environment variables.
      *
      * @example
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       bucket: "my-bucket",
      *       region: "us-west-2"
      *     });
@@ -139,23 +139,23 @@ declare module "bun" {
 
     /**
      * The access key ID for authentication.
-     * Can be set via `S3_ACCESS_KEY_ID` or `AWS_ACCESS_KEY_ID` environment variables.
+     * Defaults to `S3_ACCESS_KEY_ID` or `AWS_ACCESS_KEY_ID` environment variables.
      */
     accessKeyId?: string;
 
     /**
      * The secret access key for authentication.
-     * Can be set via `S3_SECRET_ACCESS_KEY` or `AWS_SECRET_ACCESS_KEY` environment variables.
+     * Defaults to `S3_SECRET_ACCESS_KEY` or `AWS_SECRET_ACCESS_KEY` environment variables.
      */
     secretAccessKey?: string;
 
     /**
      * Optional session token for temporary credentials.
-     * Can be set via `S3_SESSION_TOKEN` or `AWS_SESSION_TOKEN` environment variables.
+     * Defaults to `S3_SESSION_TOKEN` or `AWS_SESSION_TOKEN` environment variables.
      *
      * @example
      *     // Using temporary credentials
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       accessKeyId: tempAccessKey,
      *       secretAccessKey: tempSecretKey,
      *       sessionToken: tempSessionToken
@@ -165,29 +165,29 @@ declare module "bun" {
 
     /**
      * The S3-compatible service endpoint URL.
-     * Can be set via `S3_ENDPOINT` or `AWS_ENDPOINT` environment variables.
+     * Defaults to `S3_ENDPOINT` or `AWS_ENDPOINT` environment variables.
      *
      * @example
      *     // AWS S3
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       endpoint: "https://s3.us-east-1.amazonaws.com"
      *     });
      *
      * @example
      *     // Cloudflare R2
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       endpoint: "https://<account-id>.r2.cloudflarestorage.com"
      *     });
      *
      * @example
      *     // DigitalOcean Spaces
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       endpoint: "https://<region>.digitaloceanspaces.com"
      *     });
      *
      * @example
      *     // MinIO (local development)
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       endpoint: "http://localhost:9000"
      *     });
      */
@@ -198,7 +198,7 @@ declare module "bun" {
      *
      * @example
      *     // Using virtual hosted style
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       virtualHostedStyle: true,
      *       endpoint: "https://my-bucket.s3.us-east-1.amazonaws.com"
      *     });
@@ -213,7 +213,7 @@ declare module "bun" {
      *
      * @example
      *     // Configuring multipart uploads
-     *     const file = s3("large-file.dat", {
+     *     const file = s3.file("large-file.dat", {
      *       partSize: 10 * 1024 * 1024, // 10 MiB parts
      *       queueSize: 4  // Upload 4 parts in parallel
      *     });
@@ -240,7 +240,7 @@ declare module "bun" {
      *
      * @example
      *    // Setting retry attempts
-     *     const file = s3("my-file.txt", {
+     *     const file = s3.file("my-file.txt", {
      *       retry: 5 // Retry failed uploads up to 5 times
      *     });
      */
@@ -252,7 +252,7 @@ declare module "bun" {
      *
      * @example
      *    // Setting explicit content type
-     *     const file = s3("data.bin", {
+     *     const file = s3.file("data.bin", {
      *       type: "application/octet-stream"
      *     });
      */
@@ -263,7 +263,7 @@ declare module "bun" {
      *
      * @example
      *    // Setting explicit Storage class
-     *     const file = s3("my-file.json", {
+     *     const file = s3.file("my-file.json", {
      *       storageClass: "STANDARD_IA"
      *     });
      */
@@ -471,7 +471,7 @@ declare module "bun" {
      * The name or path of the file in the bucket.
      *
      * @example
-     * const file = s3("folder/image.jpg");
+     * const file = s3.file("folder/image.jpg");
      * console.log(file.name); // "folder/image.jpg"
      */
     readonly name?: string;
@@ -480,7 +480,7 @@ declare module "bun" {
      * The bucket name containing the file.
      *
      * @example
-     *    const file = s3("s3://my-bucket/file.txt");
+     *    const file = s3.file("s3://my-bucket/file.txt");
      *    console.log(file.bucket); // "my-bucket"
      */
     readonly bucket?: string;
@@ -631,7 +631,7 @@ declare module "bun" {
    *     });
    *
    *     // Get file instance
-   *     const file = bucket("image.jpg");
+   *     const file = bucket.file("image.jpg");
    *
    *     // Common operations
    *     await bucket.write("data.json", JSON.stringify({hello: "world"}));
@@ -682,7 +682,7 @@ declare module "bun" {
      * @example
      * const file = bucket.file("image.jpg");
      * await file.write(imageData);
-     * const configFile = bucket("config.json", {
+     * const configFile = bucket.file("config.json", {
      *   type: "application/json",
      *   acl: "private"
      * });
@@ -797,7 +797,7 @@ declare module "bun" {
      * @example
      *     // Check existence
      *     if (await bucket.exists("config.json")) {
-     *       const file = bucket("config.json");
+     *       const file = bucket.file("config.json");
      *       const config = await file.json();
      *     }
      *