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/write-file/basic.md | |
parent | 6bfee02301a2e2a0b79339974af0445eb5a2688f (diff) | |
download | bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.gz bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.zst bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.zip |
Add files (#3826)
Diffstat (limited to 'docs/guides/write-file/basic.md')
-rw-r--r-- | docs/guides/write-file/basic.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/guides/write-file/basic.md b/docs/guides/write-file/basic.md new file mode 100644 index 000000000..66f180a40 --- /dev/null +++ b/docs/guides/write-file/basic.md @@ -0,0 +1,44 @@ +--- +name: Write a string to a file +--- + +This code snippet writes a string to disk at a particular _absolute path_. + +It uses the fast [`Bun.write()`](/docs/api/file-io#writing-files-bun-write) API to efficiently write data to disk. The first argument is a _destination_; the second is the _data_ to write. + +```ts +const path = "/path/to/file.txt"; +await Bun.write(path, "Lorem ipsum"); +``` + +--- + +Any relative paths will be resolved relative to the project root (the nearest directory containing a `package.json` file). + +```ts +const path = "./file.txt"; +await Bun.write(path, "Lorem ipsum"); +``` + +--- + +You can pass a `BunFile` as the destination. `Bun.write()` will write the data to its associated path. + +```ts +const path = Bun.file("./file.txt"); +await Bun.write(path, "Lorem ipsum"); +``` + +--- + +`Bun.write()` returns the number of bytes written to disk. + +```ts +const path = "./file.txt"; +const bytes = await Bun.write(path, "Lorem ipsum"); +// => 11 +``` + +--- + +See [Docs > API > File I/O](/docs/api/file-io#writing-files-bun-write) for complete documentation of `Bun.write()`. |