diff options
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); +``` |