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/buffer.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/guides/read-file/buffer.md (limited to 'docs/guides/read-file/buffer.md') diff --git a/docs/guides/read-file/buffer.md b/docs/guides/read-file/buffer.md new file mode 100644 index 000000000..d27fa1489 --- /dev/null +++ b/docs/guides/read-file/buffer.md @@ -0,0 +1,19 @@ +--- +name: Read a file to a Buffer +--- + +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. + +To read the file into a `Buffer` instance, first use `.arrayBuffer()` to consume the file as an `ArrayBuffer`, then use `Buffer.from()` to create a `Buffer` from the `ArrayBuffer`. + +```ts +const path = "/path/to/package.json"; +const file = Bun.file(path); + +const arrbuf = await file.arrayBuffer(); +const buffer = Buffer.from(arrbuf); +``` + +--- + +Refer to [Binary data > Buffer](/docs/api/binary-data#buffer) for more information on working with `Buffer` and other binary data formats in Bun. -- cgit v1.2.3