From 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 Mon Sep 17 00:00:00 2001 From: Colin McDonnell Date: Wed, 26 Jul 2023 14:59:39 -0700 Subject: Add files (#3826) --- docs/guides/read-file/arraybuffer.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/guides/read-file/arraybuffer.md (limited to 'docs/guides/read-file/arraybuffer.md') diff --git a/docs/guides/read-file/arraybuffer.md b/docs/guides/read-file/arraybuffer.md new file mode 100644 index 000000000..149b08d8e --- /dev/null +++ b/docs/guides/read-file/arraybuffer.md @@ -0,0 +1,28 @@ +--- +name: Read a file to an ArrayBuffer +--- + +The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats. Use `.arrayBuffer()` to read the file as an `ArrayBuffer`. + +```ts +const path = "/path/to/package.json"; +const file = Bun.file(path); + +const buffer = await file.arrayBuffer(); +``` + +--- + +The binary content in the `ArrayBuffer` can then be read as a typed array, such as `Uint8Array`. + +```ts +const buffer = await file.arrayBuffer(); +const bytes = new Uint8Array(buffer); + +bytes[0]; +bytes.length; +``` + +--- + +Refer to the [Typed arrays](/docs/api/binary-data#typedarray) docs for more information on working with typed arrays in Bun. -- cgit v1.2.3