aboutsummaryrefslogtreecommitdiff
path: root/docs/api/file-io.md
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-04-13 18:26:45 -0700
committerGravatar GitHub <noreply@github.com> 2023-04-13 18:26:45 -0700
commit011e157cac7698050370e24495a9002dacfceea9 (patch)
treeebb561dbda3e8f67302cc4d5b398f4a2744f7884 /docs/api/file-io.md
parent0cc56e8efce9c7d4905b3649827bf9b40a677b25 (diff)
downloadbun-011e157cac7698050370e24495a9002dacfceea9.tar.gz
bun-011e157cac7698050370e24495a9002dacfceea9.tar.zst
bun-011e157cac7698050370e24495a9002dacfceea9.zip
Docs restructuring (#2638)
* Restructure * Update nav * Reorg * Reshuffle ecosystem pages * Split up runtime/runtime * Back to runtime/index * Fix issue * Split up runtime/index * Add Writing Tests page * Prettier matcher table * More updates
Diffstat (limited to 'docs/api/file-io.md')
-rw-r--r--docs/api/file-io.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/api/file-io.md b/docs/api/file-io.md
index 35d639422..ca78338d2 100644
--- a/docs/api/file-io.md
+++ b/docs/api/file-io.md
@@ -1,10 +1,10 @@
{% callout %}
-**Note** — The `Bun.file` and `Bun.write` APIs documented on this page are heavily optimized and represent the recommended way to perform file-system tasks using Bun. Existing Node.js projects may use Bun's [nearly complete](/docs/ecosystem/nodejs#node_fs) implementation of the [`node:fs`](https://nodejs.org/api/fs.html) module.
+**Note** — The `Bun.file` and `Bun.write` APIs documented on this page are heavily optimized and represent the recommended way to perform file-system tasks using Bun. Existing Node.js projects may use Bun's [nearly complete](/docs/runtime/nodejs-apis#node_fs) implementation of the [`node:fs`](https://nodejs.org/api/fs.html) module.
{% /callout %}
Bun provides a set of optimized APIs for reading and writing files.
-## Reading files
+## Reading files (`Bun.file()`)
`Bun.file(path): BunFile`
@@ -56,7 +56,7 @@ Bun.stdout;
Bun.stderr;
```
-## Writing files
+## Writing files (`Bun.write()`)
`Bun.write(destination, data): Promise<number>`