bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/{api/binary-data.md → runtime/binary-data.mdx}

@@ -1,41 +1,23 @@
-This page is intended as an introduction to working with binary data in JavaScript. Bun implements a number of data types and utilities for working with binary data, most of which are Web-standard. Any Bun-specific APIs will be noted as such.
-
-Below is a quick "cheat sheet" that doubles as a table of contents. Click an item in the left column to jump to that section.
-
-{% table %}
-
----
-
-- [`TypedArray`](#typedarray)
-- A family of classes that provide an `Array`-like interface for interacting with binary data. Includes `Uint8Array`, `Uint16Array`, `Int8Array`, and more.
-
 ---
-
-- [`Buffer`](#buffer)
-- A subclass of `Uint8Array` that implements a wide range of convenience methods. Unlike the other elements in this table, this is a Node.js API (which Bun implements). It can't be used in the browser.
-
----
-
-- [`DataView`](#dataview)
-- A class that provides a `get/set` API for writing some number of bytes to an `ArrayBuffer` at a particular byte offset. Often used reading or writing binary protocols.
-
+title: Binary Data
+description: Working with binary data in JavaScript
 ---
 
-- [`Blob`](#blob)
-- A readonly blob of binary data usually representing a file. Has a MIME `type`, a `size`, and methods for converting to `ArrayBuffer`, `ReadableStream`, and string.
+This page is intended as an introduction to working with binary data in JavaScript. Bun implements a number of data types and utilities for working with binary data, most of which are Web-standard. Any Bun-specific APIs will be noted as such.
 
----
+Below is a quick "cheat sheet" that doubles as a table of contents. Click an item in the left column to jump to that section.
 
-- [`File`](#file)
-- A subclass of `Blob` that represents a file. Has a `name` and `lastModified` timestamp. There is experimental support in Node.js v20.
+| Class                       | Description                                                                                                                                                                                             |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`TypedArray`](#typedarray) | A family of classes that provide an `Array`-like interface for interacting with binary data. Includes `Uint8Array`, `Uint16Array`, `Int8Array`, and more.                                               |
+| [`Buffer`](#buffer)         | A subclass of `Uint8Array` that implements a wide range of convenience methods. Unlike the other elements in this table, this is a Node.js API (which Bun implements). It can't be used in the browser. |
+| [`DataView`](#dataview)     | A class that provides a `get/set` API for writing some number of bytes to an `ArrayBuffer` at a particular byte offset. Often used reading or writing binary protocols.                                 |
+| [`Blob`](#blob)             | A readonly blob of binary data usually representing a file. Has a MIME `type`, a `size`, and methods for converting to `ArrayBuffer`, `ReadableStream`, and string.                                     |
+| [`File`](#file)             | A subclass of `Blob` that represents a file. Has a `name` and `lastModified` timestamp. There is experimental support in Node.js v20.                                                                   |
+| [`BunFile`](#bunfile)       | _Bun only_. A subclass of `Blob` that represents a lazily-loaded file on disk. Created with `Bun.file(path)`.                                                                                           |
 
 ---
 
-- [`BunFile`](#bunfile)
-- _Bun only_. A subclass of `Blob` that represents a lazily-loaded file on disk. Created with `Bun.file(path)`.
-
-{% /table %}
-
 ## `ArrayBuffer` and views
 
 Until 2009, there was no language-native way to store and manipulate binary data in JavaScript. ECMAScript v5 introduced a range of new mechanisms for this. The most fundamental building block is `ArrayBuffer`, a simple data structure that represents a sequence of bytes in memory.
@@ -98,70 +80,28 @@ dv.setFloat64(0, 3.1415);
 
 The following methods are available on `DataView`:
 
-{% table %}
-
-- Getters
-- Setters
-
----
-
-- [`getBigInt64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getBigInt64)
-- [`setBigInt64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setBigInt64)
-
----
-
-- [`getBigUint64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getBigUint64)
-- [`setBigUint64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setBigUint64)
-
----
-
-- [`getFloat32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getFloat32)
-- [`setFloat32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setFloat32)
-
----
-
-- [`getFloat64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getFloat64)
-- [`setFloat64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setFloat64)
-
----
-
-- [`getInt16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getInt16)
-- [`setInt16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setInt16)
-
----
-
-- [`getInt32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getInt32)
-- [`setInt32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setInt32)
-
----
-
-- [`getInt8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getInt8)
-- [`setInt8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setInt8)
-
----
-
-- [`getUint16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getUint16)
-- [`setUint16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setUint16)
-
----
-
-- [`getUint32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getUint32)
-- [`setUint32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setUint32)
-
----
-
-- [`getUint8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getUint8)
-- [`setUint8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setUint8)
-
-{% /table %}
+| Getters                                                                                                                    | Setters                                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| [`getBigInt64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getBigInt64)   | [`setBigInt64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setBigInt64)   |
+| [`getBigUint64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getBigUint64) | [`setBigUint64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setBigUint64) |
+| [`getFloat32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getFloat32)     | [`setFloat32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setFloat32)     |
+| [`getFloat64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getFloat64)     | [`setFloat64()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setFloat64)     |
+| [`getInt16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getInt16)         | [`setInt16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setInt16)         |
+| [`getInt32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getInt32)         | [`setInt32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setInt32)         |
+| [`getInt8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getInt8)           | [`setInt8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setInt8)           |
+| [`getUint16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getUint16)       | [`setUint16()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setUint16)       |
+| [`getUint32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getUint32)       | [`setUint32()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setUint32)       |
+| [`getUint8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/getUint8)         | [`setUint8()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView/setUint8)         |
 
 ### `TypedArray`
 
 Typed arrays are a family of classes that provide an `Array`-like interface for interacting with data in an `ArrayBuffer`. Whereas a `DataView` lets you write numbers of varying size at a particular offset, a `TypedArray` interprets the underlying bytes as an array of numbers, each of a fixed size.
 
-{% callout %}
-**Note** — It's common to refer to this family of classes collectively by their shared superclass `TypedArray`. This class as _internal_ to JavaScript; you can't directly create instances of it, and `TypedArray` is not defined in the global scope. Think of it as an `interface` or an abstract class.
-{% /callout %}
+<Note>
+  It's common to refer to this family of classes collectively by their shared superclass `TypedArray`. This class as
+  _internal_ to JavaScript; you can't directly create instances of it, and `TypedArray` is not defined in the global
+  scope. Think of it as an `interface` or an abstract class.
+</Note>
 
 ```ts
 const buffer = new ArrayBuffer(3);
@@ -182,121 +122,32 @@ The top row contains the raw bytes, and the later rows contain how these bytes w
 
 The following classes are typed arrays, along with a description of how they interpret the bytes in an `ArrayBuffer`:
 
-{% table %}
-
-- Class
-- Description
-
----
-
-- [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
-- Every one (1) byte is interpreted as an unsigned 8-bit integer. Range 0 to 255.
-
----
-
-- [`Uint16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array)
-- Every two (2) bytes are interpreted as an unsigned 16-bit integer. Range 0 to 65535.
-
----
-
-- [`Uint32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array)
-- Every four (4) bytes are interpreted as an unsigned 32-bit integer. Range 0 to 4294967295.
-
----
-
-- [`Int8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array)
-- Every one (1) byte is interpreted as a signed 8-bit integer. Range -128 to 127.
-
----
-
-- [`Int16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array)
-- Every two (2) bytes are interpreted as a signed 16-bit integer. Range -32768 to 32767.
-
----
-
-- [`Int32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array)
-- Every four (4) bytes are interpreted as a signed 32-bit integer. Range -2147483648 to 2147483647.
-
----
-
-- [`Float16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float16Array)
-- Every two (2) bytes are interpreted as a 16-bit floating point number. Range -6.104e5 to 6.55e4.
-
----
-
-- [`Float32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array)
-- Every four (4) bytes are interpreted as a 32-bit floating point number. Range -3.4e38 to 3.4e38.
-
----
-
-- [`Float64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array)
-- Every eight (8) bytes are interpreted as a 64-bit floating point number. Range -1.7e308 to 1.7e308.
-
----
-
-- [`BigInt64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt64Array)
-- Every eight (8) bytes are interpreted as a signed `BigInt`. Range -9223372036854775808 to 9223372036854775807 (though `BigInt` is capable of representing larger numbers).
-
----
-
-- [`BigUint64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigUint64Array)
-- Every eight (8) bytes are interpreted as an unsigned `BigInt`. Range 0 to 18446744073709551615 (though `BigInt` is capable of representing larger numbers).
-
----
-
-- [`Uint8ClampedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray)
-- Same as `Uint8Array`, but automatically "clamps" to the range 0-255 when assigning a value to an element.
-
-{% /table %}
+Here's the first table formatted as a markdown table:
+
+| Class                                                                                                                     | Description                                                                                                                                                                |
+| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)               | Every one (1) byte is interpreted as an unsigned 8-bit integer. Range 0 to 255.                                                                                            |
+| [`Uint16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array)             | Every two (2) bytes are interpreted as an unsigned 16-bit integer. Range 0 to 65535.                                                                                       |
+| [`Uint32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array)             | Every four (4) bytes are interpreted as an unsigned 32-bit integer. Range 0 to 4294967295.                                                                                 |
+| [`Int8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array)                 | Every one (1) byte is interpreted as a signed 8-bit integer. Range -128 to 127.                                                                                            |
+| [`Int16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array)               | Every two (2) bytes are interpreted as a signed 16-bit integer. Range -32768 to 32767.                                                                                     |
+| [`Int32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array)               | Every four (4) bytes are interpreted as a signed 32-bit integer. Range -2147483648 to 2147483647.                                                                          |
+| [`Float16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float16Array)           | Every two (2) bytes are interpreted as a 16-bit floating point number. Range -6.104e5 to 6.55e4.                                                                           |
+| [`Float32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array)           | Every four (4) bytes are interpreted as a 32-bit floating point number. Range -3.4e38 to 3.4e38.                                                                           |
+| [`Float64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array)           | Every eight (8) bytes are interpreted as a 64-bit floating point number. Range -1.7e308 to 1.7e308.                                                                        |
+| [`BigInt64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt64Array)         | Every eight (8) bytes are interpreted as a signed `BigInt`. Range -9223372036854775808 to 9223372036854775807 (though `BigInt` is capable of representing larger numbers). |
+| [`BigUint64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigUint64Array)       | Every eight (8) bytes are interpreted as an unsigned `BigInt`. Range 0 to 18446744073709551615 (though `BigInt` is capable of representing larger numbers).                |
+| [`Uint8ClampedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray) | Same as `Uint8Array`, but automatically "clamps" to the range 0-255 when assigning a value to an element.                                                                  |
 
 The table below demonstrates how the bytes in an `ArrayBuffer` are interpreted when viewed using different typed array classes.
 
-{% table %}
-
----
-
-- `ArrayBuffer`
-- `00000000`
-- `00000001`
-- `00000010`
-- `00000011`
-- `00000100`
-- `00000101`
-- `00000110`
-- `00000111`
-
----
-
-- `Uint8Array`
-- 0
-- 1
-- 2
-- 3
-- 4
-- 5
-- 6
-- 7
-
----
-
-- `Uint16Array`
-- 256 (`1 * 256 + 0`) {% colspan=2 %}
-- 770 (`3 * 256 + 2`) {% colspan=2 %}
-- 1284 (`5 * 256 + 4`) {% colspan=2 %}
-- 1798 (`7 * 256 + 6`) {% colspan=2 %}
-
----
-
-- `Uint32Array`
-- 50462976 {% colspan=4 %}
-- 117835012 {% colspan=4 %}
-
----
-
-- `BigUint64Array`
-- 506097522914230528n {% colspan=8 %}
-
-{% /table %}
+|                  | Byte 0              | Byte 1     | Byte 2              | Byte 3     | Byte 4               | Byte 5     | Byte 6               | Byte 7     |
+| ---------------- | ------------------- | ---------- | ------------------- | ---------- | -------------------- | ---------- | -------------------- | ---------- |
+| `ArrayBuffer`    | `00000000`          | `00000001` | `00000010`          | `00000011` | `00000100`           | `00000101` | `00000110`           | `00000111` |
+| `Uint8Array`     | 0                   | 1          | 2                   | 3          | 4                    | 5          | 6                    | 7          |
+| `Uint16Array`    | 256 (`1 * 256 + 0`) |            | 770 (`3 * 256 + 2`) |            | 1284 (`5 * 256 + 4`) |            | 1798 (`7 * 256 + 6`) |            |
+| `Uint32Array`    | 50462976            |            |                     |            | 117835012            |            |                      |            |
+| `BigUint64Array` | 506097522914230528n |            |                     |            |                      |            |                      |            |
 
 To create a typed array from a pre-defined `ArrayBuffer`:
 
@@ -468,9 +319,7 @@ const file = Bun.file("index.txt");
 
 ### `File`
 
-{% callout %}
-Browser only. Experimental support in Node.js 20.
-{% /callout %}
+<Warning>Browser only. Experimental support in Node.js 20.</Warning>
 
 [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) is a subclass of `Blob` that adds a `name` and `lastModified` property. It's commonly used in the browser to represent files uploaded via a `<input type="file">` element. Node.js and Bun implement `File`.
 
@@ -490,15 +339,21 @@ const file = new File(["<html>Hello</html>"], "index.html", {
 
 Refer to the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/Blob) for complete docs information.
 
+---
+
 ## Streams
 
 Streams are an important abstraction for working with binary data without loading it all into memory at once. They are commonly used for reading and writing files, sending and receiving network requests, and processing large amounts of data.
 
 Bun implements the Web APIs [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) and [`WritableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream).
 
-{% callout %}
-Bun also implements the `node:stream` module, including [`Readable`](https://nodejs.org/api/stream.html#stream_readable_streams), [`Writable`](https://nodejs.org/api/stream.html#stream_writable_streams), and [`Duplex`](https://nodejs.org/api/stream.html#stream_duplex_and_transform_streams). For complete documentation, refer to the Node.js docs.
-{% /callout %}
+<Note>
+  Bun also implements the `node:stream` module, including
+  [`Readable`](https://nodejs.org/api/stream.html#stream_readable_streams),
+  [`Writable`](https://nodejs.org/api/stream.html#stream_writable_streams), and
+  [`Duplex`](https://nodejs.org/api/stream.html#stream_duplex_and_transform_streams). For complete documentation, refer
+  to the Node.js docs.
+</Note>
 
 To create a simple readable stream:
 
@@ -517,12 +372,15 @@ The contents of this stream can be read chunk-by-chunk with `for await` syntax.
 ```ts
 for await (const chunk of stream) {
   console.log(chunk);
-  // => "hello"
-  // => "world"
 }
+
+// => "hello"
+// => "world"
 ```
 
-For a more complete discussion of streams in Bun, see [API > Streams](https://bun.com/docs/api/streams).
+For a more complete discussion of streams in Bun, see [API > Streams](/runtime/streams).
+
+---
 
 ## Conversion
 
@@ -574,12 +432,6 @@ Array.from(new Uint8Array(buf));
 new Blob([buf], { type: "text/plain" });
 ```
 
-<!-- #### To `File`
-
-```ts
-new File([buf], "filename.txt", { type: "text/plain", lastModified: Date.now() });
-``` -->
-
 #### To `ReadableStream`
 
 The following snippet creates a `ReadableStream` and enqueues the entire `ArrayBuffer` as a single chunk.
@@ -593,7 +445,7 @@ new ReadableStream({
 });
 ```
 
-{% details summary="With chunking" %}
+<Accordion title="With chunking">
 To stream the `ArrayBuffer` in chunks, use a `Uint8Array` view and enqueue each chunk.
 
 ```ts
@@ -610,7 +462,7 @@ new ReadableStream({
 });
 ```
 
-{% /details %}
+</Accordion>
 
 ### From `TypedArray`
 
@@ -657,12 +509,6 @@ Array.from(arr);
 new Blob([arr.buffer], { type: "text/plain" });
 ```
 
-<!-- #### To `File`
-
-```ts
-new File([arr.buffer], "filename.txt", { type: "text/plain", lastModified: Date.now() });
-``` -->
-
 #### To `ReadableStream`
 
 ```ts
@@ -674,7 +520,8 @@ new ReadableStream({
 });
 ```
 
-{% details summary="With chunking" %}
+<Accordion title="With chunking">
+
 To stream the `ArrayBuffer` in chunks, split the `TypedArray` into chunks and enqueue each one individually.
 
 ```ts
@@ -688,7 +535,7 @@ new ReadableStream({
 });
 ```
 
-{% /details %}
+</Accordion>
 
 ### From `DataView`
 
@@ -735,12 +582,6 @@ Array.from(view);
 new Blob([view.buffer], { type: "text/plain" });
 ```
 
-<!-- #### To `File`
-
-```ts
-new File([view.buffer], "filename.txt", { type: "text/plain", lastModified: Date.now() });
-``` -->
-
 #### To `ReadableStream`
 
 ```ts
@@ -752,7 +593,7 @@ new ReadableStream({
 });
 ```
 
-{% details summary="With chunking" %}
+<Accordion title="With chunking">
 To stream the `ArrayBuffer` in chunks, split the `DataView` into chunks and enqueue each one individually.
 
 ```ts
@@ -766,7 +607,7 @@ new ReadableStream({
 });
 ```
 
-{% /details %}
+</Accordion>
 
 ### From `Buffer`
 
@@ -820,12 +661,6 @@ Array.from(buf);
 new Blob([buf], { type: "text/plain" });
 ```
 
-<!-- #### To `File`
-
-```ts
-new File([buf], "filename.txt", { type: "text/plain", lastModified: Date.now() });
-``` -->
-
 #### To `ReadableStream`
 
 ```ts
@@ -837,7 +672,7 @@ new ReadableStream({
 });
 ```
 
-{% details summary="With chunking" %}
+<Accordion title="With chunking">
 To stream the `ArrayBuffer` in chunks, split the `Buffer` into chunks and enqueue each one individually.
 
 ```ts
@@ -851,7 +686,7 @@ new ReadableStream({
 });
 ```
 
-{% /details %}
+</Accordion>
 
 ### From `Blob`
 
@@ -901,8 +736,6 @@ Array.from(await blob.bytes());
 blob.stream();
 ```
 
-<!-- ### From `File` -->
-
 ### From `ReadableStream`
 
 It's common to use [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) as a convenient intermediate representation to make it easier to convert `ReadableStream` to other formats.
@@ -1004,14 +837,6 @@ Bun.readableStreamToArray(stream);
 new Response(stream).blob();
 ```
 
-<!-- #### To `File`
-
-```ts
-new Response(stream)
-  .blob()
-  .then(blob => new File([blob], "filename.txt", { type: "text/plain", lastModified: Date.now() }));
-``` -->
-
 #### To `ReadableStream`
 
 To split a `ReadableStream` into two streams that can be consumed independently:
@@ -1019,20 +844,3 @@ To split a `ReadableStream` into two streams that can be consumed independently:
 ```ts
 const [a, b] = stream.tee();
 ```
-
-<!-- - Use Buffer
-- TextEncoder
-- `Bun.ArrayBufferSink`
-- ReadableStream
-- AsyncIterator
-- TypedArray vs ArrayBuffer vs DataView
-- Bun.indexOfLine
-- “direct” readablestream
-  - readable stream has assumptions about
-  - its very generic
-  - all data is copies and queued
-  - direct : no queueing
-  - just a write function
-  - you can write strings
-  - more synchronous
-  - corking works better -->

package/docs/runtime/bun-apis.mdx

@@ -0,0 +1,59 @@
+---
+title: "Bun APIs"
+description: "Overview of Bun's native APIs available on the Bun global object and built-in modules"
+mode: center
+---
+
+Bun implements a set of native APIs on the `Bun` global object and through a number of built-in modules. These APIs are heavily optimized and represent the canonical "Bun-native" way to implement some common functionality.
+
+Bun strives to implement standard Web APIs wherever possible. Bun introduces new APIs primarily for server-side tasks where no standard exists, such as file I/O and starting an HTTP server. In these cases, Bun's approach still builds atop standard APIs like `Blob`, `URL`, and `Request`.
+
+```ts server.ts icon="/icons/typescript.svg"
+Bun.serve({
+  fetch(req: Request) {
+    return new Response("Success!");
+  },
+});
+```
+
+Click the link in the right column to jump to the associated documentation.
+
+| Topic                            | APIs                                                                                                                                                                                                                                                                                                                   |
+| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| HTTP Server                      | [`Bun.serve`](/runtime/http/server)                                                                                                                                                                                                                                                                                    |
+| Shell                            | [`$`](/runtime/shell)                                                                                                                                                                                                                                                                                                  |
+| Bundler                          | [`Bun.build`](/bundler)                                                                                                                                                                                                                                                                                                |
+| File I/O                         | [`Bun.file`](/runtime/file-io#reading-files-bun-file), [`Bun.write`](/runtime/file-io#writing-files-bun-write), `Bun.stdin`, `Bun.stdout`, `Bun.stderr`                                                                                                                                                                |
+| Child Processes                  | [`Bun.spawn`](/runtime/child-process#spawn-a-process-bun-spawn), [`Bun.spawnSync`](/runtime/child-process#blocking-api-bun-spawnsync)                                                                                                                                                                                  |
+| TCP Sockets                      | [`Bun.listen`](/runtime/networking/tcp#start-a-server-bun-listen), [`Bun.connect`](/runtime/networking/tcp#start-a-server-bun-listen)                                                                                                                                                                                  |
+| UDP Sockets                      | [`Bun.udpSocket`](/runtime/networking/udp)                                                                                                                                                                                                                                                                             |
+| WebSockets                       | `new WebSocket()` (client), [`Bun.serve`](/runtime/http/websockets) (server)                                                                                                                                                                                                                                           |
+| Transpiler                       | [`Bun.Transpiler`](/runtime/transpiler)                                                                                                                                                                                                                                                                                |
+| Routing                          | [`Bun.FileSystemRouter`](/runtime/file-system-router)                                                                                                                                                                                                                                                                  |
+| Streaming HTML                   | [`HTMLRewriter`](/runtime/html-rewriter)                                                                                                                                                                                                                                                                               |
+| Hashing                          | [`Bun.password`](/runtime/hashing#bun-password), [`Bun.hash`](/runtime/hashing#bun-hash), [`Bun.CryptoHasher`](/runtime/hashing#bun-cryptohasher), `Bun.sha`                                                                                                                                                           |
+| SQLite                           | [`bun:sqlite`](/runtime/sqlite)                                                                                                                                                                                                                                                                                        |
+| PostgreSQL Client                | [`Bun.SQL`](/runtime/sql), `Bun.sql`                                                                                                                                                                                                                                                                                   |
+| Redis (Valkey) Client            | [`Bun.RedisClient`](/runtime/redis), `Bun.redis`                                                                                                                                                                                                                                                                       |
+| FFI (Foreign Function Interface) | [`bun:ffi`](/runtime/ffi)                                                                                                                                                                                                                                                                                              |
+| DNS                              | [`Bun.dns.lookup`](/runtime/networking/dns), `Bun.dns.prefetch`, `Bun.dns.getCacheStats`                                                                                                                                                                                                                               |
+| Testing                          | [`bun:test`](/test)                                                                                                                                                                                                                                                                                                    |
+| Workers                          | [`new Worker()`](/runtime/workers)                                                                                                                                                                                                                                                                                     |
+| Module Loaders                   | [`Bun.plugin`](/bundler/plugins)                                                                                                                                                                                                                                                                                       |
+| Glob                             | [`Bun.Glob`](/runtime/glob)                                                                                                                                                                                                                                                                                            |
+| Cookies                          | [`Bun.Cookie`](/runtime/cookies), [`Bun.CookieMap`](/runtime/cookies)                                                                                                                                                                                                                                                  |
+| Node-API                         | [`Node-API`](/runtime/node-api)                                                                                                                                                                                                                                                                                        |
+| `import.meta`                    | [`import.meta`](/runtime/module-resolution#import-meta)                                                                                                                                                                                                                                                                |
+| Utilities                        | [`Bun.version`](/runtime/utils#bun-version), [`Bun.revision`](/runtime/utils#bun-revision), [`Bun.env`](/runtime/utils#bun-env), [`Bun.main`](/runtime/utils#bun-main)                                                                                                                                                 |
+| Sleep & Timing                   | [`Bun.sleep()`](/runtime/utils#bun-sleep), [`Bun.sleepSync()`](/runtime/utils#bun-sleepsync), [`Bun.nanoseconds()`](/runtime/utils#bun-nanoseconds)                                                                                                                                                                    |
+| Random & UUID                    | [`Bun.randomUUIDv7()`](/runtime/utils#bun-randomuuidv7)                                                                                                                                                                                                                                                                |
+| System & Environment             | [`Bun.which()`](/runtime/utils#bun-which)                                                                                                                                                                                                                                                                              |
+| Comparison & Inspection          | [`Bun.peek()`](/runtime/utils#bun-peek), [`Bun.deepEquals()`](/runtime/utils#bun-deepequals), `Bun.deepMatch`, [`Bun.inspect()`](/runtime/utils#bun-inspect)                                                                                                                                                           |
+| String & Text Processing         | [`Bun.escapeHTML()`](/runtime/utils#bun-escapehtml), [`Bun.stringWidth()`](/runtime/utils#bun-stringwidth), `Bun.indexOfLine`                                                                                                                                                                                          |
+| URL & Path Utilities             | [`Bun.fileURLToPath()`](/runtime/utils#bun-fileurltopath), [`Bun.pathToFileURL()`](/runtime/utils#bun-pathtofileurl)                                                                                                                                                                                                   |
+| Compression                      | [`Bun.gzipSync()`](/runtime/utils#bun-gzipsync), [`Bun.gunzipSync()`](/runtime/utils#bun-gunzipsync), [`Bun.deflateSync()`](/runtime/utils#bun-deflatesync), [`Bun.inflateSync()`](/runtime/utils#bun-inflatesync), `Bun.zstdCompressSync()`, `Bun.zstdDecompressSync()`, `Bun.zstdCompress()`, `Bun.zstdDecompress()` |
+| Stream Processing                | [`Bun.readableStreamTo*()`](/runtime/utils#bun-readablestreamto), `Bun.readableStreamToBytes()`, `Bun.readableStreamToBlob()`, `Bun.readableStreamToFormData()`, `Bun.readableStreamToJSON()`, `Bun.readableStreamToArray()`                                                                                           |
+| Memory & Buffer Management       | `Bun.ArrayBufferSink`, `Bun.allocUnsafe`, `Bun.concatArrayBuffers`                                                                                                                                                                                                                                                     |
+| Module Resolution                | [`Bun.resolveSync()`](/runtime/utils#bun-resolvesync)                                                                                                                                                                                                                                                                  |
+| Parsing & Formatting             | [`Bun.semver`](/runtime/semver), `Bun.TOML.parse`, [`Bun.color`](/runtime/color)                                                                                                                                                                                                                                       |
+| Low-level / Internals            | `Bun.mmap`, `Bun.gc`, `Bun.generateHeapSnapshot`, [`bun:jsc`](https://bun.com/reference/bun/jsc)                                                                                                                                                                                                                       |