bun-types 1.2.18-canary.20250626T140617 → 1.2.18-canary.20250628T140543

package/bun.d.ts

@@ -346,6 +346,17 @@ declare module "bun" {
 
   type WorkerType = "classic" | "module";
 
+  /**
+   * This type-only interface is identical at runtime to {@link ReadableStream},
+   * and exists to document types that do not exist yet in libdom.
+   */
+  interface BunReadableStream<T = any> extends ReadableStream<T> {
+    text(): Promise<string>;
+    bytes(): Promise<Uint8Array>;
+    json(): Promise<any>;
+    blob(): Promise<Blob>;
+  }
+
   interface AbstractWorker {
     /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ServiceWorker/error_event) */
     onerror: ((this: AbstractWorker, ev: ErrorEvent) => any) | null;
@@ -1242,7 +1253,7 @@ declare module "bun" {
      */
     writer(options?: { highWaterMark?: number }): FileSink;
 
-    readonly readable: ReadableStream;
+    readonly readable: BunReadableStream;
 
     // TODO: writable: WritableStream;
 
@@ -6767,7 +6778,7 @@ declare module "bun" {
        *
        * For stdout and stdin you may pass:
        *
-       * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+       * - `"pipe"`, `undefined`: The process will have a {@link BunReadableStream} for standard output/error
        * - `"ignore"`, `null`: The process will have no standard output/error
        * - `"inherit"`: The process will inherit the standard output/error of the current process
        * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
@@ -6793,7 +6804,7 @@ declare module "bun" {
       /**
        * The file descriptor for the standard output. It may be:
        *
-       * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+       * - `"pipe"`, `undefined`: The process will have a {@link BunReadableStream} for standard output/error
        * - `"ignore"`, `null`: The process will have no standard output/error
        * - `"inherit"`: The process will inherit the standard output/error of the current process
        * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
@@ -6805,7 +6816,7 @@ declare module "bun" {
       /**
        * The file descriptor for the standard error. It may be:
        *
-       * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+       * - `"pipe"`, `undefined`: The process will have a {@link BunReadableStream} for standard output/error
        * - `"ignore"`, `null`: The process will have no standard output/error
        * - `"inherit"`: The process will inherit the standard output/error of the current process
        * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
@@ -6968,7 +6979,7 @@ declare module "bun" {
     type ReadableIO = ReadableStream<Uint8Array> | number | undefined;
 
     type ReadableToIO<X extends Readable> = X extends "pipe" | undefined
-      ? ReadableStream<Uint8Array>
+      ? BunReadableStream
       : X extends BunFile | ArrayBufferView | number
         ? number
         : undefined;

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.18-canary.20250626T140617
+[fetch] > User-Agent: Bun/1.2.18-canary.20250628T140543
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/api/s3.md

@@ -160,7 +160,8 @@ const writer = s3file.writer({
   partSize: 5 * 1024 * 1024,
 });
 for (let i = 0; i < 10; i++) {
-  await writer.write(bigFile);
+  writer.write(bigFile);
+  await writer.flush();
 }
 await writer.end();
 ```

package/docs/api/spawn.md

@@ -34,7 +34,7 @@ const proc = Bun.spawn(["cat"], {
   ),
 });
 
-const text = await new Response(proc.stdout).text();
+const text = await proc.stdout.text();
 console.log(text); // "const input = "hello world".repeat(400); ..."
 ```
 
@@ -113,14 +113,34 @@ proc.stdin.flush();
 proc.stdin.end();
 ```
 
+Passing a `ReadableStream` to `stdin` lets you pipe data from a JavaScript `ReadableStream` directly to the subprocess's input:
+
+```ts
+const stream = new ReadableStream({
+  start(controller) {
+    controller.enqueue("Hello from ");
+    controller.enqueue("ReadableStream!");
+    controller.close();
+  },
+});
+
+const proc = Bun.spawn(["cat"], {
+  stdin: stream,
+  stdout: "pipe",
+});
+
+const output = await new Response(proc.stdout).text();
+console.log(output); // "Hello from ReadableStream!"
+```
+
 ## Output streams
 
 You can read results from the subprocess via the `stdout` and `stderr` properties. By default these are instances of `ReadableStream`.
 
 ```ts
 const proc = Bun.spawn(["bun", "--version"]);
-const text = await new Response(proc.stdout).text();
-console.log(text); // => "1.2.18-canary.20250626T140617"
+const text = await proc.stdout.text();
+console.log(text); // => "1.2.18-canary.20250628T140543\n"
 ```
 
 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.18-canary.20250626T140617 (ca7428e9)
+bun publish v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (16b4bf34)
+bun install v1.2.18-canary.20250628T140543 (16b4bf34)
  + @nuxt/devtools@0.8.2
  + nuxt@3.7.0
  785 packages installed [2.67s]

package/docs/guides/ecosystem/prisma.md

@@ -30,7 +30,7 @@ $ bun add @prisma/client
 We'll use the Prisma CLI with `bunx` to initialize our schema and migration directory. For simplicity we'll be using an in-memory SQLite database.
 
 ```bash
-$ bunx prisma init --datasource-provider sqlite
+$ bunx --bun prisma init --datasource-provider sqlite
 ```
 
 ---

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

@@ -15,7 +15,7 @@ This will add the package to `peerDependencies` in `package.json`.
 ```json-diff
 {
   "peerDependencies": {
-+   "@types/bun": "^1.2.18-canary.20250626T140617"
++   "@types/bun": "^1.2.18-canary.20250628T140543"
   }
 }
 ```
@@ -27,7 +27,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
 ```json-diff
 {
   "peerDependencies": {
-    "@types/bun": "^1.2.18-canary.20250626T140617"
+    "@types/bun": "^1.2.18-canary.20250628T140543"
   },
   "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.18-canary.20250626T140617
+$ bun update @types/bun@1.2.18-canary.20250628T140543
 
 # Update all dependencies to the latest versions
 $ bun update --latest

package/docs/guides/process/spawn-stderr.md

@@ -13,14 +13,14 @@ proc.stderr; // => ReadableStream
 
 ---
 
-To read `stderr` until the child process exits, use the [`Bun.readableStreamToText()`](https://bun.sh/docs/api/utils#bun-readablestreamto) convenience function.
+To read `stderr` until the child process exits, use .text()
 
 ```ts
 const proc = Bun.spawn(["echo", "hello"], {
   stderr: "pipe",
 });
 
-const errors: string = await Bun.readableStreamToText(proc.stderr);
+const errors: string = await proc.stderr.text();
 if (errors) {
   // handle errors
 }

package/docs/guides/process/spawn-stdout.md

@@ -7,7 +7,7 @@ When using [`Bun.spawn()`](https://bun.sh/docs/api/spawn), the `stdout` of the c
 ```ts
 const proc = Bun.spawn(["echo", "hello"]);
 
-const output = await new Response(proc.stdout).text();
+const output = await proc.stdout.text();
 output; // => "hello"
 ```
 

package/docs/guides/process/spawn.md

@@ -32,8 +32,8 @@ By default, the `stdout` of the child process can be consumed as a `ReadableStre
 ```ts
 const proc = Bun.spawn(["echo", "hello"]);
 
-const output = await new Response(proc.stdout).text();
-output; // => "hello"
+const output = await proc.stdout.text();
+output; // => "hello\n"
 ```
 
 ---

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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617 (9c68abdb)
+bun test v1.2.18-canary.20250628T140543 (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.18-canary.20250626T140617"
+Bun.version; // => "1.2.18-canary.20250628T140543"
 ```
 
 ---

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.18-canary.20250626T140617"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250628T140543"
 ```
 
 ```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.18-canary.20250626T140617`.
+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.18-canary.20250628T140543`.
 
 ```sh
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250626T140617"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250628T140543"
 ```
 
 ### 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.18-canary.20250626T140617"
+$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.18-canary.20250628T140543"
 ```
 
 ## Downloading Bun binaries directly

package/docs/runtime/bunfig.md

@@ -353,6 +353,8 @@ dryRun = false
 
 To configure the directory where Bun puts globally installed packages.
 
+Environment variable: `BUN_INSTALL_GLOBAL_DIR`
+
 ```toml
 [install]
 # where `bun install --global` installs packages
@@ -363,6 +365,8 @@ globalDir = "~/.bun/install/global"
 
 To configure the directory where Bun installs globally installed binaries and CLIs.
 
+Environment variable: `BUN_INSTALL_BIN`
+
 ```toml
 # where globally-installed package bins are linked
 globalBinDir = "~/.bun/bin"

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.18-canary.20250626T140617" -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.18-canary.20250628T140543" -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.18-canary.20250626T140617
+[fetch] > User-Agent: Bun/1.2.18-canary.20250628T140543
 [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.18-canary.20250626T140617
+[fetch] > User-Agent: Bun/1.2.18-canary.20250628T140543
 [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.18-canary.20250626T140617
+bun test v1.2.18-canary.20250628T140543
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.18-canary.20250626T140617",
+  "version": "1.2.18-canary.20250628T140543",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",