bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/guides/runtime/{import-yaml.md → import-yaml.mdx}

@@ -1,10 +1,12 @@
 ---
-name: Import a YAML file
+title: Import a YAML file
+sidebarTitle: Import YAML
+mode: center
 ---
 
 Bun natively supports `.yaml` and `.yml` imports.
 
-```yaml#config.yaml
+```yaml config.yaml icon="file-code"
 database:
   host: localhost
   port: 5432
@@ -23,7 +25,7 @@ features:
 
 Import the file like any other source file.
 
-```ts
+```ts config.ts icon="/icons/typescript.svg"
 import config from "./config.yaml";
 
 config.database.host; // => "localhost"
@@ -35,7 +37,7 @@ config.features.auth; // => true
 
 You can also use named imports to destructure top-level properties:
 
-```ts
+```ts config.ts icon="/icons/typescript.svg"
 import { database, server, features } from "./config.yaml";
 
 console.log(database.name); // => "myapp"
@@ -47,7 +49,7 @@ console.log(features.rateLimit); // => true
 
 Bun also supports [Import Attributes](https://github.com/tc39/proposal-import-attributes) syntax:
 
-```ts
+```ts config.ts icon="/icons/typescript.svg"
 import config from "./config.yaml" with { type: "yaml" };
 
 config.database.port; // => 5432
@@ -57,7 +59,7 @@ config.database.port; // => 5432
 
 For parsing YAML strings at runtime, use `Bun.YAML.parse()`:
 
-```ts
+```ts config.ts icon="/icons/typescript.svg"
 const yamlString = `
 name: John Doe
 age: 30
@@ -77,7 +79,7 @@ console.log(data.hobbies); // => ["reading", "coding"]
 
 To add TypeScript support for your YAML imports, create a declaration file with `.d.ts` appended to the YAML filename (e.g., `config.yaml` → `config.yaml.d.ts`);
 
-```ts#config.yaml.d.ts
+```ts config.yaml.d.ts icon="/icons/typescript.svg"
 const contents: {
   database: {
     host: string;

package/docs/guides/runtime/{read-env.md → read-env.mdx}

@@ -1,10 +1,12 @@
 ---
-name: Read environment variables
+title: Read environment variables
+sidebarTitle: Read env variables
+mode: center
 ---
 
 The current environment variables can be accessed via `process.env`.
 
-```ts
+```ts index.ts icon="/icons/typescript.svg"
 process.env.API_TOKEN; // => "secret"
 ```
 
@@ -12,7 +14,7 @@ process.env.API_TOKEN; // => "secret"
 
 Bun also exposes these variables via `Bun.env`, which is a simple alias of `process.env`.
 
-```ts
+```ts index.ts icon="/icons/typescript.svg"
 Bun.env.API_TOKEN; // => "secret"
 ```
 
@@ -20,8 +22,11 @@ Bun.env.API_TOKEN; // => "secret"
 
 To print all currently-set environment variables to the command line, run `bun --print process.env`. This is useful for debugging.
 
-```sh
-$ bun --print process.env
+```sh terminal icon="terminal"
+bun --print process.env
+```
+
+```txt
 BAZ=stuff
 FOOBAR=aaaaaa
 <lots more lines>

package/docs/guides/runtime/{set-env.md → set-env.mdx}

@@ -1,10 +1,12 @@
 ---
-name: Set environment variables
+title: Set environment variables
+sidebarTitle: Set env variables
+mode: center
 ---
 
 The current environment variables can be accessed via `process.env` or `Bun.env`.
 
-```ts
+```ts index.ts icon="/icons/typescript.svg"
 Bun.env.API_TOKEN; // => "secret"
 process.env.API_TOKEN; // => "secret"
 ```
@@ -19,7 +21,7 @@ Bun reads the following files automatically (listed in order of increasing prece
 - `.env.production`, `.env.development`, `.env.test` (depending on value of `NODE_ENV`)
 - `.env.local` (not loaded when `NODE_ENV=test`)
 
-```txt#.env
+```txt .env icon="settings"
 FOO=hello
 BAR=world
 ```
@@ -28,20 +30,22 @@ BAR=world
 
 Variables can also be set via the command line.
 
-{% codetabs %}
+<CodeGroup>
 
-```sh#Linux/macOS
-$ FOO=helloworld bun run dev
+```sh Linux/macOS icon="terminal"
+FOO=helloworld bun run dev
 ```
 
-```sh#Windows
+```sh Windows icon="windows"
 # Using CMD
-$ set FOO=helloworld && bun run dev
+set FOO=helloworld && bun run dev
 
 # Using PowerShell
-$ $env:FOO="helloworld"; bun run dev
+$env:FOO="helloworld"; bun run dev
 ```
 
-## {% /codetabs %}
+</CodeGroup>
+
+---
 
 See [Docs > Runtime > Environment variables](https://bun.com/docs/runtime/env) for more information on using environment variables with Bun.

package/docs/guides/runtime/{shell.md → shell.mdx}

@@ -1,12 +1,14 @@
 ---
-name: Run a Shell Command
+title: Run a Shell Command
+sidebarTitle: Run shell command
+mode: center
 ---
 
 Bun Shell is a cross-platform bash-like shell built in to Bun.
 
 It provides a simple way to run shell commands in JavaScript and TypeScript. To get started, import the `$` function from the `bun` package and use it to run shell commands.
 
-```ts#foo.ts
+```ts foo.ts icon="/icons/typescript.svg"
 import { $ } from "bun";
 
 await $`echo Hello, world!`; // => "Hello, world!"
@@ -16,7 +18,7 @@ await $`echo Hello, world!`; // => "Hello, world!"
 
 The `$` function is a tagged template literal that runs the command and returns a promise that resolves with the command's output.
 
-```ts#foo.ts
+```ts foo.ts icon="/icons/typescript.svg"
 import { $ } from "bun";
 
 const output = await $`ls -l`.text();
@@ -27,7 +29,7 @@ console.log(output);
 
 To get each line of the output as an array, use the `lines` method.
 
-```ts#foo.ts
+```ts foo.ts icon="/icons/typescript.svg"
 import { $ } from "bun";
 
 for await (const line of $`ls -l`.lines()) {

package/docs/guides/runtime/{timezone.md → timezone.mdx}

@@ -1,16 +1,19 @@
 ---
-name: Set a time zone in Bun
+title: Set a time zone in Bun
+sidebarTitle: Set time zone
+mode: center
 ---
 
 Bun supports programmatically setting a default time zone for the lifetime of the `bun` process. To do set, set the value of the `TZ` environment variable to a [valid timezone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
 
-{% callout %}
+<Note>
 When running a file with `bun`, the timezone defaults to your system's configured local time zone.
 
 When running tests with `bun test`, the timezone is set to `UTC` to make tests more deterministic.
-{% /callout %}
 
-```ts
+</Note>
+
+```ts process.ts icon="/icons/typescript.svg"
 process.env.TZ = "America/New_York";
 ```
 
@@ -18,15 +21,15 @@ process.env.TZ = "America/New_York";
 
 Alternatively, this can be set from the command line when running a Bun command.
 
-```sh
-$ TZ=America/New_York bun run dev
+```sh terminal icon="terminal"
+TZ=America/New_York bun run dev
 ```
 
 ---
 
 Once `TZ` is set, any `Date` instances will have that time zone. By default all dates use your system's configured time zone.
 
-```ts
+```ts process.ts icon="/icons/typescript.svg"
 new Date().getHours(); // => 18
 
 process.env.TZ = "America/New_York";

package/docs/guides/runtime/{tsconfig-paths.md → tsconfig-paths.mdx}

@@ -1,10 +1,12 @@
 ---
-name: Re-map import paths
+title: Re-map import paths
+sidebarTitle: Re-map import paths
+mode: center
 ---
 
 Bun reads the `paths` field in your `tsconfig.json` to re-write import paths. This is useful for aliasing package names or avoiding long relative paths.
 
-```json
+```json tsconfig.json icon="file-json"
 {
   "compilerOptions": {
     "paths": {
@@ -19,7 +21,7 @@ Bun reads the `paths` field in your `tsconfig.json` to re-write import paths. Th
 
 With the above `tsconfig.json`, the following imports will be re-written:
 
-```ts
+```ts tsconfig.ts icon="/icons/typescript.svg"
 import { z } from "my-custom-name"; // imports from "zod"
 import { Button } from "@components/Button"; // imports from "./src/components/Button"
 ```

package/docs/guides/runtime/{typescript.md → typescript.mdx}

@@ -1,18 +1,20 @@
 ---
-name: Install TypeScript declarations for Bun
+title: Install TypeScript declarations for Bun
+sidebarTitle: TypeScript types
+mode: center
 ---
 
 To install TypeScript definitions for Bun's built-in APIs in your project, install `@types/bun`.
 
-```sh
-$ bun add -d @types/bun # dev dependency
+```sh terminal icon="terminal"
+bun add -d @types/bun # dev dependency
 ```
 
 ---
 
 Below is the full set of recommended `compilerOptions` for a Bun project. With this `tsconfig.json`, you can use top-level await, extensioned or extensionless imports, and JSX.
 
-```jsonc
+```json package.json icon="file-json"
 {
   "compilerOptions": {
     // Environment setup & latest features
@@ -39,8 +41,8 @@ Below is the full set of recommended `compilerOptions` for a Bun project. With t
     // Some stricter flags (disabled by default)
     "noUnusedLocals": false,
     "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false,
-  },
+    "noPropertyAccessFromIndexSignature": false
+  }
 }
 ```
 

package/docs/guides/runtime/{vscode-debugger.md → vscode-debugger.mdx}

@@ -1,12 +1,13 @@
 ---
-name: Debugging Bun with the VS Code extension
+title: Debugging Bun with the VS Code extension
+sidebarTitle: VS Code debugger
+mode: center
 ---
 
-{% note %}
-
-VSCode extension support is currently buggy. We recommend the [Web Debugger](https://bun.com/guides/runtime/web-debugger) for now.
-
-{% /note %}
+<Note>
+  VSCode extension support is currently buggy. We recommend the [Web
+  Debugger](https://bun.com/guides/runtime/web-debugger) for now.
+</Note>
 
 Bun speaks the [WebKit Inspector Protocol](https://github.com/oven-sh/bun/blob/main/packages/bun-inspector-protocol/src/protocol/jsc/index.d.ts) so you can debug your code with an interactive debugger.
 
@@ -14,19 +15,19 @@ Bun speaks the [WebKit Inspector Protocol](https://github.com/oven-sh/bun/blob/m
 
 To install the extension, visit the [Bun for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=oven.bun-vscode) page on the VS Code marketplace website, then click Install.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/7c8c80e6-d49e-457a-a45e-45ebed946d56" /%}
+<Frame>![VS Code extension](https://github.com/oven-sh/bun/assets/3084745/7c8c80e6-d49e-457a-a45e-45ebed946d56)</Frame>
 
 ---
 
 Alternatively, search `bun-vscode` in the Extensions tab of VS Code.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/664b4c40-944c-4076-a4c2-f812aebd3dc9" /%}
+<Frame>![VS Code extension](https://github.com/oven-sh/bun/assets/3084745/664b4c40-944c-4076-a4c2-f812aebd3dc9)</Frame>
 
 ---
 
 Make sure you are installing the extension published by the verified Oven organization.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/73e6b09f-9ff1-4d85-b725-c5eb7215b6ae" /%}
+<Frame>![VS Code extension](https://github.com/oven-sh/bun/assets/3084745/73e6b09f-9ff1-4d85-b725-c5eb7215b6ae)</Frame>
 
 ---
 
@@ -36,7 +37,7 @@ Once installed, two new Bun-specific commands will appear in the Command Palette
 
 The `Bun: Run File` command will execute your code and print the output to the Debug Console in VS Code. Breakpoints will be ignored; this is similar to executing the file with `bun <file>` from the command line.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/1b2c7fd9-fbb9-486a-84d0-eb7ec135ded3" /%}
+<Frame>![VS Code extension](https://github.com/oven-sh/bun/assets/3084745/1b2c7fd9-fbb9-486a-84d0-eb7ec135ded3)</Frame>
 
 ---
 
@@ -44,4 +45,4 @@ The `Bun: Debug File` command will execute your code and print the output to the
 
 When you run the file with `Bun: Debug File`, execution will pause at the breakpoint. You can inspect the variables in scope and step through the code line-by-line using the VS Code controls.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/c579a36c-eb21-4a58-bc9c-74612aad82af" /%}
+<Frame>![VS Code extension](https://github.com/oven-sh/bun/assets/3084745/c579a36c-eb21-4a58-bc9c-74612aad82af)</Frame>

package/docs/guides/runtime/{web-debugger.md → web-debugger.mdx}

@@ -1,16 +1,18 @@
 ---
-name: Debugging Bun with the web debugger
+title: Debugging Bun with the web debugger
+sidebarTitle: Web debugger
+mode: center
 ---
 
 Bun speaks the [WebKit Inspector Protocol](https://github.com/oven-sh/bun/blob/main/packages/bun-vscode/types/jsc.d.ts). To enable debugging when running code with Bun, use the `--inspect` flag. For demonstration purposes, consider the following simple web server.
 
-```ts#server.ts
+```ts server.ts icon="/icons/typescript.svg"
 Bun.serve({
-  fetch(req){
+  fetch(req) {
     console.log(req.url);
     return new Response("Hello, world!");
-  }
-})
+  },
+});
 ```
 
 ---
@@ -21,8 +23,11 @@ This automatically starts a WebSocket server on an available port that can be us
 
 Bun hosts a web-based debugger at [debug.bun.sh](https://debug.bun.sh). It is a modified version of WebKit's [Web Inspector Interface](https://webkit.org/web-inspector/web-inspector-interface/), which will look familiar to Safari users.
 
-```sh
-$ bun --inspect server.ts
+```sh terminal icon="terminal"
+bun --inspect server.ts
+```
+
+```txt
 ------------------ Bun Inspector ------------------
 Listening at:
   ws://localhost:6499/0tqxs9exrgrm
@@ -36,13 +41,18 @@ Inspect in browser:
 
 Open the provided `debug.bun.sh` URL in your browser to start a debugging session. From this interface, you'll be able to view the source code of the running file, view and set breakpoints, and execute code with the built-in console.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/e6a976a8-80cc-4394-8925-539025cc025d" alt="Screenshot of Bun debugger, Console tab" /%}
+<Frame>
+  ![Screenshot of Bun debugger, Console
+  tab](https://github.com/oven-sh/bun/assets/3084745/e6a976a8-80cc-4394-8925-539025cc025d)
+</Frame>
 
 ---
 
 Let's set a breakpoint. Navigate to the Sources tab; you should see the code from earlier. Click on the line number `3` to set a breakpoint on our `console.log(req.url)` statement.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/3b69c7e9-25ff-4f9d-acc4-caa736862935" alt="screenshot of Bun debugger" /%}
+<Frame>
+  ![screenshot of Bun debugger](https://github.com/oven-sh/bun/assets/3084745/3b69c7e9-25ff-4f9d-acc4-caa736862935)
+</Frame>
 
 ---
 
@@ -50,33 +60,44 @@ Then visit [`http://localhost:3000`](http://localhost:3000) in your web browser.
 
 Note how the UI has changed.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/8b565e58-5445-4061-9bc4-f41090dfe769" alt="screenshot of Bun debugger" /%}
+<Frame>
+  ![screenshot of Bun debugger](https://github.com/oven-sh/bun/assets/3084745/8b565e58-5445-4061-9bc4-f41090dfe769)
+</Frame>
 
 ---
 
 At this point there's a lot we can do to introspect the current execution environment. We can use the console at the bottom to run arbitrary code in the context of the program, with full access to the variables in scope at our breakpoint.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/f4312b76-48ba-4a7d-b3b6-6205968ac681" /%}
+<Frame>
+  ![Bun debugger console](https://github.com/oven-sh/bun/assets/3084745/f4312b76-48ba-4a7d-b3b6-6205968ac681)
+</Frame>
 
 ---
 
 On the right side of the Sources pane, we can see all local variables currently in scope, and drill down to see their properties and methods. Here, we're inspecting the `req` variable.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/63d7f843-5180-489c-aa94-87c486e68646" /%}
+<Frame>
+  ![Bun debugger variables panel](https://github.com/oven-sh/bun/assets/3084745/63d7f843-5180-489c-aa94-87c486e68646)
+</Frame>
 
 ---
 
 In the upper left of the Sources pane, we can control the execution of the program.
 
-{% image src="https://github.com/oven-sh/bun/assets/3084745/41b76deb-7371-4461-9d5d-81b5a6d2f7a4" /%}
+<Frame>
+  ![Bun debugger controls](https://github.com/oven-sh/bun/assets/3084745/41b76deb-7371-4461-9d5d-81b5a6d2f7a4)
+</Frame>
 
 ---
 
 Here's a cheat sheet explaining the functions of the control flow buttons.
 
-- _Continue script execution_ — continue running the program until the next breakpoint or exception.
-- _Step over_ — The program will continue to the next line.
-- _Step into_ — If the current statement contains a function call, the debugger will "step into" the called function.
-- _Step out_ — If the current statement is a function call, the debugger will finish executing the call, then "step out" of the function to the location where it was called.
+- _Continue script execution_ — continue running the program until the next breakpoint or exception.
+- _Step over_ — The program will continue to the next line.
+- _Step into_ — If the current statement contains a function call, the debugger will "step into" the called function.
+- _Step out_ — If the current statement is a function call, the debugger will finish executing the call, then "step out" of the function to the location where it was called.
 
-{% image src="https://github-production-user-asset-6210df.s3.amazonaws.com/3084745/261510346-6a94441c-75d3-413a-99a7-efa62365f83d.png" /%}
+<Frame>
+  ![Debugger control buttons cheat
+  sheet](https://github-production-user-asset-6210df.s3.amazonaws.com/3084745/261510346-6a94441c-75d3-413a-99a7-efa62365f83d.png)
+</Frame>

package/docs/guides/streams/{node-readable-to-arraybuffer.md → node-readable-to-arraybuffer.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a Node.js Readable to an ArrayBuffer
+title: Convert a Node.js Readable to an ArrayBuffer
+sidebarTitle: Readable to ArrayBuffer
+mode: center
 ---
 
 To convert a Node.js `Readable` stream to an `ArrayBuffer` in Bun, you can create a new `Response` object with the stream as the body, then use `arrayBuffer()` to read the stream into an `ArrayBuffer`.

package/docs/guides/streams/{node-readable-to-blob.md → node-readable-to-blob.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a Node.js Readable to a Blob
+title: Convert a Node.js Readable to a Blob
+sidebarTitle: Readable to Blob
+mode: center
 ---
 
 To convert a Node.js `Readable` stream to a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) in Bun, you can create a new [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object with the stream as the body, then use [`response.blob()`](https://developer.mozilla.org/en-US/docs/Web/API/Response/blob) to read the stream into a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob).

package/docs/guides/streams/{node-readable-to-json.md → node-readable-to-json.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a Node.js Readable to JSON
+title: Convert a Node.js Readable to JSON
+sidebarTitle: Readable to JSON
+mode: center
 ---
 
 To convert a Node.js `Readable` stream to a JSON object in Bun, you can create a new [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object with the stream as the body, then use [`response.json()`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json) to read the stream into a JSON object.

package/docs/guides/streams/{node-readable-to-string.md → node-readable-to-string.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a Node.js Readable to a string
+title: Convert a Node.js Readable to a string
+sidebarTitle: Readable to string
+mode: center
 ---
 
 To convert a Node.js `Readable` stream to a string in Bun, you can create a new [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object with the stream as the body, then use [`response.text()`](https://developer.mozilla.org/en-US/docs/Web/API/Response/text) to read the stream into a string.

package/docs/guides/streams/{node-readable-to-uint8array.md → node-readable-to-uint8array.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a Node.js Readable to an Uint8Array
+title: Convert a Node.js Readable to an Uint8Array
+sidebarTitle: Readable to Uint8Array
+mode: center
 ---
 
 To convert a Node.js `Readable` stream to an `Uint8Array` in Bun, you can create a new `Response` object with the stream as the body, then use `bytes()` to read the stream into an `Uint8Array`.

package/docs/guides/streams/{to-array.md → to-array.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a ReadableStream to an array of chunks
+title: Convert a ReadableStream to an array of chunks
+sidebarTitle: Stream to array
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats. The `Bun.readableStreamToArray` function reads the contents of a `ReadableStream` to an array of chunks.

package/docs/guides/streams/{to-arraybuffer.md → to-arraybuffer.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a ReadableStream to an ArrayBuffer
+title: Convert a ReadableStream to an ArrayBuffer
+sidebarTitle: Stream to ArrayBuffer
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats.

package/docs/guides/streams/{to-blob.md → to-blob.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a ReadableStream to a Blob
+title: Convert a ReadableStream to a Blob
+sidebarTitle: Stream to Blob
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats.

package/docs/guides/streams/{to-buffer.md → to-buffer.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a ReadableStream to a Buffer
+title: Convert a ReadableStream to a Buffer
+sidebarTitle: Stream to Buffer
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats. This snippet reads the contents of a `ReadableStream` to an [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), then creates a [`Buffer`](https://nodejs.org/api/buffer.html) that points to it.

package/docs/guides/streams/{to-json.md → to-json.mdx}

@@ -1,12 +1,14 @@
 ---
-name: Convert a ReadableStream to JSON
+title: Convert a ReadableStream to JSON
+sidebarTitle: Stream to JSON
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats.
 
 ```ts
 const stream = new ReadableStream();
-const json = await Bun.readableStreamToJSON(stream);
+const json = await stream.json();
 ```
 
 ---

package/docs/guides/streams/{to-string.md → to-string.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a ReadableStream to a string
+title: Convert a ReadableStream to a string
+sidebarTitle: Stream to string
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats.

package/docs/guides/streams/{to-typedarray.md → to-typedarray.mdx}

@@ -1,5 +1,7 @@
 ---
-name: Convert a ReadableStream to a Uint8Array
+title: Convert a ReadableStream to a Uint8Array
+sidebarTitle: Stream to Uint8Array
+mode: center
 ---
 
 Bun provides a number of convenience functions for reading the contents of a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) into different formats. This snippet reads the contents of a `ReadableStream` to an [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), then creates a [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) that points to the buffer.

package/docs/guides/test/{bail.md → bail.mdx}

@@ -1,20 +1,22 @@
 ---
-name: Bail early with the Bun test runner
+title: Bail early with the Bun test runner
+sidebarTitle: Bail early
+mode: center
 ---
 
 Use the `--bail` flag to bail on a test run after a single failure. This is useful for aborting as soon as possible in a continuous integration environment.
 
-```sh
-$ bun test --bail
+```sh terminal icon="terminal"
+bun test --bail
 ```
 
 ---
 
 To bail after a certain threshold of failures, optionally specify a number after the flag.
 
-```sh
+```sh terminal icon="terminal"
 # bail after 10 failures
-$ bun test --bail=10
+bun test --bail=10
 ```
 
 ---