aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar dave caruso <me@paperdave.net> 2023-04-18 14:09:41 -0400
committerGravatar GitHub <noreply@github.com> 2023-04-18 11:09:41 -0700
commit76deb51c294126406c8f0be5f13bb184c1ddb454 (patch)
tree99c796557cab1523dc9016bd8bba2011810c07ca
parent5712fbd5b9f6c69830f666348e85a173f9ed7f2e (diff)
downloadbun-76deb51c294126406c8f0be5f13bb184c1ddb454.tar.gz
bun-76deb51c294126406c8f0be5f13bb184c1ddb454.tar.zst
bun-76deb51c294126406c8f0be5f13bb184c1ddb454.zip
clarify file io docs (#2689)
-rw-r--r--docs/api/file-io.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/api/file-io.md b/docs/api/file-io.md
index ca78338d2..07336d071 100644
--- a/docs/api/file-io.md
+++ b/docs/api/file-io.md
@@ -1,5 +1,9 @@
{% 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/runtime/nodejs-apis#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. -->
+
+**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. For operations that are not yet available with `Bun.file`, such as `mkdir`, you can 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.