From 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 Mon Sep 17 00:00:00 2001 From: Colin McDonnell Date: Wed, 26 Jul 2023 14:59:39 -0700 Subject: Add files (#3826) --- docs/guides/write-file/cat.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/guides/write-file/cat.md (limited to 'docs/guides/write-file/cat.md') diff --git a/docs/guides/write-file/cat.md b/docs/guides/write-file/cat.md new file mode 100644 index 000000000..a9f9a0ba6 --- /dev/null +++ b/docs/guides/write-file/cat.md @@ -0,0 +1,17 @@ +--- +name: Write a file to stdout +--- + +Bun exposes `stdout` as a `BunFile` with the `Bun.stdout` property. This can be used as a destination for [`Bun.write()`](/docs/api/file-io#writing-files-bun-write). + +This code writes a file to `stdout` similar to the `cat` command in Unix. + +```ts#cat.ts +const path = "/path/to/file.txt"; +const file = Bun.file(path); +await Bun.write(Bun.stdout, file); +``` + +--- + +See [Docs > API > File I/O](/docs/api/file-io#writing-files-bun-write) for complete documentation of `Bun.write()`. -- cgit v1.2.3