bun-types 1.3.2-canary.20251106T140813 → 1.3.2

package/docs/guides/binary/blob-to-string.mdx

@@ -0,0 +1,17 @@
+---
+title: Convert a Blob to a string
+sidebarTitle: "Blob to string"
+mode: center
+---
+
+The [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) class provides a number of methods for consuming its contents in different formats, including `.text()`.
+
+```ts
+const blob = new Blob(["hello world"]);
+const str = await blob.text();
+// => "hello world"
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/blob-to-typedarray.mdx

@@ -0,0 +1,16 @@
+---
+title: Convert a Blob to a Uint8Array
+sidebarTitle: "Blob to Uint8Array"
+mode: center
+---
+
+The [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) class provides a number of methods for consuming its contents in different formats. This snippets reads the contents to an `ArrayBuffer`, then creates a `Uint8Array` from the buffer.
+
+```ts
+const blob = new Blob(["hello world"]);
+const arr = new Uint8Array(await blob.arrayBuffer());
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/buffer-to-arraybuffer.mdx

@@ -0,0 +1,16 @@
+---
+title: Convert a Buffer to an ArrayBuffer
+sidebarTitle: "Buffer to ArrayBuffer"
+mode: center
+---
+
+The Node.js [`Buffer`](https://nodejs.org/api/buffer.html) class provides a way to view and manipulate data in an underlying `ArrayBuffer`, which is available via the `buffer` property.
+
+```ts
+const nodeBuf = Buffer.alloc(64);
+const arrBuf = nodeBuf.buffer;
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/buffer-to-blob.mdx

@@ -0,0 +1,16 @@
+---
+title: Convert a Buffer to a blob
+sidebarTitle: "Buffer to Blob"
+mode: center
+---
+
+A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) can be constructed from an array of "chunks", where each chunk is a string, binary data structure (including `Buffer`), or another `Blob`.
+
+```ts
+const buf = Buffer.from("hello");
+const blob = new Blob([buf]);
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/buffer-to-readablestream.mdx

@@ -0,0 +1,43 @@
+---
+title: Convert a Buffer to a ReadableStream
+sidebarTitle: "Buffer to ReadableStream"
+mode: center
+---
+
+The naive approach to creating a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) from a [`Buffer`](https://nodejs.org/api/buffer.html) is to use the `ReadableStream` constructor and enqueue the entire array as a single chunk. For a large buffer, this may be undesirable as this approach does not "streaming" the data in smaller chunks.
+
+```ts
+const buf = Buffer.from("hello world");
+const stream = new ReadableStream({
+  start(controller) {
+    controller.enqueue(buf);
+    controller.close();
+  },
+});
+```
+
+---
+
+To stream the data in smaller chunks, first create a `Blob` instance from the `Buffer`. Then use the [`Blob.stream()`](https://developer.mozilla.org/en-US/docs/Web/API/Blob/stream) method to create a `ReadableStream` that streams the data in chunks of a specified size.
+
+```ts
+const buf = Buffer.from("hello world");
+const blob = new Blob([buf]);
+const stream = blob.stream();
+```
+
+---
+
+The chunk size can be set by passing a number to the `.stream()` method.
+
+```ts
+const buf = Buffer.from("hello world");
+const blob = new Blob([buf]);
+
+// set chunk size of 1024 bytes
+const stream = blob.stream(1024);
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/buffer-to-string.mdx

@@ -0,0 +1,27 @@
+---
+title: Convert a Buffer to a string
+sidebarTitle: "Buffer to string"
+mode: center
+---
+
+The [`Buffer`](https://nodejs.org/api/buffer.html) class provides a built-in `.toString()` method that converts a `Buffer` to a string.
+
+```ts
+const buf = Buffer.from("hello");
+const str = buf.toString();
+// => "hello"
+```
+
+---
+
+You can optionally specify an encoding and byte range.
+
+```ts
+const buf = Buffer.from("hello world!");
+const str = buf.toString("utf8", 0, 5);
+// => "hello"
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/buffer-to-typedarray.mdx

@@ -0,0 +1,16 @@
+---
+title: Convert a Buffer to a Uint8Array
+sidebarTitle: "Buffer to Uint8Array"
+mode: center
+---
+
+The Node.js [`Buffer`](https://nodejs.org/api/buffer.html) class extends [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), so no conversion is needed. All properties and methods on `Uint8Array` are available on `Buffer`.
+
+```ts
+const buf = Buffer.alloc(64);
+buf instanceof Uint8Array; // => true
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/dataview-to-string.mdx

@@ -0,0 +1,17 @@
+---
+title: Convert a DataView to a string
+sidebarTitle: "DataView to string"
+mode: center
+---
+
+If a [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) contains ASCII-encoded text, you can convert it to a string using the [`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder) class.
+
+```ts
+const dv: DataView = ...;
+const decoder = new TextDecoder();
+const str = decoder.decode(dv);
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/typedarray-to-arraybuffer.mdx

@@ -0,0 +1,27 @@
+---
+title: Convert a Uint8Array to an ArrayBuffer
+sidebarTitle: "Uint8Array to ArrayBuffer"
+mode: center
+---
+
+A [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) is a _typed array_ class, meaning it is a mechanism for viewing data in an underlying `ArrayBuffer`. The underlying `ArrayBuffer` is accessible via the `buffer` property.
+
+```ts
+const arr = new Uint8Array(64);
+arr.buffer; // => ArrayBuffer(64)
+```
+
+---
+
+The `Uint8Array` may be a view over a _subset_ of the data in the underlying `ArrayBuffer`. In this case, the `buffer` property will return the entire buffer, and the `byteOffset` and `byteLength` properties will indicate the subset.
+
+```ts
+const arr = new Uint8Array(64, 16, 32);
+arr.buffer; // => ArrayBuffer(64)
+arr.byteOffset; // => 16
+arr.byteLength; // => 32
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/typedarray-to-blob.mdx

@@ -0,0 +1,18 @@
+---
+title: Convert a Uint8Array to a Blob
+sidebarTitle: "Uint8Array to Blob"
+mode: center
+---
+
+A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) can be constructed from an array of "chunks", where each chunk is a string, binary data structure (including `Uint8Array`), or another `Blob`.
+
+```ts
+const arr = new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f]);
+const blob = new Blob([arr]);
+console.log(await blob.text());
+// => "hello"
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/typedarray-to-buffer.mdx

@@ -0,0 +1,16 @@
+---
+title: Convert a Uint8Array to a Buffer
+sidebarTitle: "Uint8Array to Buffer"
+mode: center
+---
+
+The [`Buffer`](https://nodejs.org/api/buffer.html) class extends [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) with a number of additional methods. Use `Buffer.from()` to create a `Buffer` instance from a `Uint8Array`.
+
+```ts
+const arr: Uint8Array = ...
+const buf = Buffer.from(arr);
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/typedarray-to-dataview.mdx

@@ -0,0 +1,16 @@
+---
+title: Convert a Uint8Array to a DataView
+sidebarTitle: "Uint8Array to DataView"
+mode: center
+---
+
+A [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) is a _typed array_ class, meaning it is a mechanism for viewing data in an underlying `ArrayBuffer`. The following snippet creates a [`DataView`] instance over the same range of data as the `Uint8Array`.
+
+```ts
+const arr: Uint8Array = ...
+const dv = new DataView(arr.buffer, arr.byteOffset, arr.byteLength);
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/typedarray-to-readablestream.mdx

@@ -0,0 +1,43 @@
+---
+title: Convert a Uint8Array to a ReadableStream
+sidebarTitle: "Uint8Array to ReadableStream"
+mode: center
+---
+
+The naive approach to creating a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) from a [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) is to use the [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) constructor and enqueue the entire array as a single chunk. For larger chunks, this may be undesirable as it isn't actually "streaming" the data.
+
+```ts
+const arr = new Uint8Array(64);
+const stream = new ReadableStream({
+  start(controller) {
+    controller.enqueue(arr);
+    controller.close();
+  },
+});
+```
+
+---
+
+To stream the data in smaller chunks, first create a `Blob` instance from the `Uint8Array`. Then use the [`Blob.stream()`](https://developer.mozilla.org/en-US/docs/Web/API/Blob/stream) method to create a `ReadableStream` that streams the data in chunks of a specified size.
+
+```ts
+const arr = new Uint8Array(64);
+const blob = new Blob([arr]);
+const stream = blob.stream();
+```
+
+---
+
+The chunk size can be set by passing a number to the `.stream()` method.
+
+```ts
+const arr = new Uint8Array(64);
+const blob = new Blob([arr]);
+
+// set chunk size of 1024 bytes
+const stream = blob.stream(1024);
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/binary/typedarray-to-string.mdx

@@ -0,0 +1,18 @@
+---
+title: Convert a Uint8Array to a string
+sidebarTitle: "Uint8Array to string"
+mode: center
+---
+
+Bun implements the Web-standard [`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder) class for converting from binary data types like `Uint8Array` and strings.
+
+```ts
+const arr = new Uint8Array([104, 101, 108, 108, 111]);
+const decoder = new TextDecoder();
+const str = decoder.decode(arr);
+// => "hello"
+```
+
+---
+
+See [Docs > API > Binary Data](https://bun.com/docs/api/binary-data#conversion) for complete documentation on manipulating binary data with Bun.

package/docs/guides/deployment/aws-lambda.mdx

@@ -0,0 +1,204 @@
+---
+title: Deploy a Bun application on AWS Lambda
+sidebarTitle: Deploy on AWS Lambda
+mode: center
+---
+
+[AWS Lambda](https://aws.amazon.com/lambda/) is a serverless compute service that lets you run code without provisioning or managing servers.
+
+In this guide, we will deploy a Bun HTTP server to AWS Lambda using a `Dockerfile`.
+
+<Note>
+	Before continuing, make sure you have:
+
+    	- A Bun application ready for deployment
+    	- An [AWS account](https://aws.amazon.com/)
+    	- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) installed and configured
+    	- [Docker](https://docs.docker.com/get-started/get-docker/) installed and added to your `PATH`
+
+</Note>
+
+---
+
+<Steps>
+	<Step title="Create a new Dockerfile">
+		Make sure you're in the directory containing your project, then create a new `Dockerfile` in the root of your project. This file contains the instructions to initialize the container, copy your local project files into it, install dependencies, and start the application.
+
+    	```docker Dockerfile icon="docker"
+    	# Use the official AWS Lambda adapter image to handle the Lambda runtime
+    	FROM public.ecr.aws/awsguru/aws-lambda-adapter:0.9.0 AS aws-lambda-adapter
+
+    	# Use the official Bun image to run the application
+    	FROM oven/bun:debian AS bun_latest
+
+    	# Copy the Lambda adapter into the container
+    	COPY --from=aws-lambda-adapter /lambda-adapter /opt/extensions/lambda-adapter
+
+    	# Set the port to 8080. This is required for the AWS Lambda adapter.
+    	ENV PORT=8080
+
+    	# Set the work directory to `/var/task`. This is the default work directory for Lambda.
+    	WORKDIR "/var/task"
+
+    	# Copy the package.json and bun.lock into the container
+    	COPY package.json bun.lock ./
+
+    	# Install the dependencies
+    	RUN bun install --production --frozen-lockfile
+
+    	# Copy the rest of the application into the container
+    	COPY . /var/task
+
+    	# Run the application.
+    	CMD ["bun", "index.ts"]
+    	```
+
+    	<Note>
+    		Make sure that the start command corresponds to your application's entry point. This can also be `CMD ["bun", "run", "start"]` if you have a start script in your `package.json`.
+
+    		This image installs dependencies and runs your app with Bun inside a container. If your app doesn't have dependencies, you can omit the `RUN bun install --production --frozen-lockfile` line.
+    	</Note>
+
+    	Create a new `.dockerignore` file in the root of your project. This file contains the files and directories that should be _excluded_ from the container image, such as `node_modules`. This makes your builds faster and smaller:
+
+    	```docker .dockerignore icon="Docker"
+    	node_modules
+    	Dockerfile*
+    	.dockerignore
+    	.git
+    	.gitignore
+    	README.md
+    	LICENSE
+    	.vscode
+    	.env
+    	# Any other files or directories you want to exclude
+    	```
+    </Step>
+    <Step title="Build the Docker image">
+    	Make sure you're in the directory containing your `Dockerfile`, then build the Docker image. In this case, we'll call the image `bun-lambda-demo` and tag it as `latest`.
+
+    	```bash terminal icon="terminal"
+    	# cd /path/to/your/app
+    	docker build --provenance=false --platform linux/amd64 -t bun-lambda-demo:latest .
+    	```
+    </Step>
+    <Step title="Create an ECR repository">
+    	To push the image to AWS Lambda, we first need to create an [ECR repository](https://aws.amazon.com/ecr/) to push the image to.
+
+    	By running the following command, we:
+    	- Create an ECR repository named `bun-lambda-demo` in the `us-east-1` region
+    	- Get the repository URI, and export the repository URI as an environment variable. This is optional, but make the next steps easier.
+
+    	```bash terminal icon="terminal"
+    	export ECR_URI=$(aws ecr create-repository --repository-name bun-lambda-demo --region us-east-1 --query 'repository.repositoryUri' --output text)
+    	echo $ECR_URI
+    	```
+    	```txt
+    	[id].dkr.ecr.us-east-1.amazonaws.com/bun-lambda-demo
+    	```
+
+    	<Note>
+    		If you're using IAM Identity Center (SSO) or have configured AWS CLI with profiles, you'll need to add the `--profile` flag to your AWS CLI commands.
+
+    		For example, if your profile is named `my-sso-app`, use `--profile my-sso-app`. Check your AWS CLI configuration with `aws configure list-profiles` to see available profiles.
+
+    		```bash terminal icon="terminal"
+    		export ECR_URI=$(aws ecr create-repository --repository-name bun-lambda-demo --region us-east-1 --profile my-sso-app --query 'repository.repositoryUri' --output text)
+    		echo $ECR_URI
+    		```
+    	</Note>
+
+    </Step>
+    <Step title="Authenticate with the ECR repository">
+    	Log in to the ECR repository:
+
+    	```bash terminal icon="terminal"
+    	aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin $ECR_URI
+    	```
+    	```txt
+    	Login Succeeded
+    	```
+
+    	<Note>
+    		If using a profile, use the `--profile` flag:
+
+    		```bash terminal icon="terminal"
+    		aws ecr get-login-password --region us-east-1 --profile my-sso-app | docker login --username AWS --password-stdin $ECR_URI
+    		```
+
+    	</Note>
+
+    </Step>
+    <Step title="Tag and push the docker image to the ECR repository">
+    	Make sure you're in the directory containing your `Dockerfile`, then tag the docker image with the ECR repository URI.
+
+    	```bash terminal icon="terminal"
+    	docker tag bun-lambda-demo:latest ${ECR_URI}:latest
+    	```
+
+    	Then, push the image to the ECR repository.
+
+    	```bash terminal icon="terminal"
+    	docker push ${ECR_URI}:latest
+    	```
+    </Step>
+    <Step title="Create an AWS Lambda function">
+    	Go to **AWS Console** > **Lambda** > [**Create Function**](https://us-east-1.console.aws.amazon.com/lambda/home?region=us-east-1#/create/function?intent=authorFromImage) > Select **Container image**
+
+    	<Warning>Make sure you've selected the right region, this URL defaults to `us-east-1`.</Warning>
+
+    	<Frame>
+    	![Create Function](/images/guides/lambda1.png)
+    	</Frame>
+
+    	Give the function a name, like `my-bun-function`.
+    </Step>
+    <Step title="Select the container image">
+    	Then, go to the **Container image URI** section, click on **Browse images**. Select the image we just pushed to the ECR repository.
+
+    	<Frame>
+    	![Select Container Repository](/images/guides/lambda2.png)
+    	</Frame>
+
+    	Then, select the `latest` image, and click on **Select image**.
+
+    	<Frame>
+    	![Select Container Image](/images/guides/lambda3.png)
+    	</Frame>
+    </Step>
+    <Step title="Configure the function">
+    	To get a public URL for the function, we need to go to **Additional configurations** > **Networking** > **Function URL**.
+
+    	Set this to **Enable**, with Auth Type **NONE**.
+
+    	<Frame>
+    		![Set the Function URL](/images/guides/lambda4.png)
+    	</Frame>
+    </Step>
+    <Step title="Create the function">
+    	Click on **Create function** at the bottom of the page, this will create the function.
+
+    	<Frame>
+    		![Create Function](/images/guides/lambda6.png)
+    	</Frame>
+
+    </Step>
+    <Step title="Get the function URL">
+    	Once the function has been created you'll be redirected to the function's page, where you can see the function URL in the **"Function URL"** section.
+
+    	<Frame>
+    		![Function URL](/images/guides/lambda5.png)
+    	</Frame>
+    </Step>
+    <Step title="Test the function">
+    	🥳 Your app is now live! To test the function, you can either go to the **Test** tab, or call the function URL directly.
+
+    	```bash terminal icon="terminal"
+    	curl -X GET https://[your-function-id].lambda-url.us-east-1.on.aws/
+    	```
+    	```txt
+    	Hello from Bun on Lambda!
+    	```
+    </Step>
+
+</Steps>