diff options
author | 2023-07-26 14:59:39 -0700 | |
---|---|---|
committer | 2023-07-26 14:59:39 -0700 | |
commit | 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 (patch) | |
tree | fc1d2f47309c0345a850933496baa40d94bfdcbb /docs/guides/read-file/string.md | |
parent | 6bfee02301a2e2a0b79339974af0445eb5a2688f (diff) | |
download | bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.gz bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.zst bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.zip |
Add files (#3826)
Diffstat (limited to 'docs/guides/read-file/string.md')
-rw-r--r-- | docs/guides/read-file/string.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/guides/read-file/string.md b/docs/guides/read-file/string.md new file mode 100644 index 000000000..08cdfd952 --- /dev/null +++ b/docs/guides/read-file/string.md @@ -0,0 +1,22 @@ +--- +name: Read a file as a string +--- + +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 `.text()` to read the contents as a string. + +```ts +const path = "/path/to/file.txt"; +const file = Bun.file(path); + +const text = await file.text(); +// string +``` + +--- + +Any relative paths will be resolved relative to the project root (the nearest directory containing a `package.json` file). + +```ts +const path = "./file.txt"; +const file = Bun.file(path); +``` |