From 76deb51c294126406c8f0be5f13bb184c1ddb454 Mon Sep 17 00:00:00 2001 From: dave caruso Date: Tue, 18 Apr 2023 14:09:41 -0400 Subject: clarify file io docs (#2689) --- docs/api/file-io.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/api') 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. 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. -- cgit v1.2.3