From 79519efc2258a8af65bfdad556fbd3a2891742d3 Mon Sep 17 00:00:00 2001 From: Kir_Antipov <kp.antipov@gmail.com> Date: Wed, 25 Jan 2023 17:51:19 +0000 Subject: [PATCH] Made a few utility types for `writeFile` options --- src/utils/io/write-file-options.ts | 32 ++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 src/utils/io/write-file-options.ts diff --git a/src/utils/io/write-file-options.ts b/src/utils/io/write-file-options.ts new file mode 100644 index 0000000..fdc0d2e --- /dev/null +++ b/src/utils/io/write-file-options.ts @@ -0,0 +1,32 @@ +import { writeFileSync } from "node:fs"; +import { writeFile } from "node:fs/promises"; + +/** + * Options that can be used with `fs.writeFile()` to write a file asynchronously. + */ +export type AsyncWriteFileOptions = Parameters<typeof writeFile>[2]; + +/** + * Options that can be used with `fs.writeFileSync()` to write a file synchronously. + */ +export type SyncWriteFileOptions = Parameters<typeof writeFileSync>[2]; + +/** + * All possible options that can be passed to `fs.writeFile()` and `fs.writeFileSync()`. + */ +export type WriteFileOptions = AsyncWriteFileOptions | SyncWriteFileOptions; + +/** + * Object-style options that can be used with `fs.writeFile()` to write a file asynchronously. + */ +export type AsyncWriteFileOptionsObject = Exclude<AsyncWriteFileOptions, string>; + +/** + * Object-style options that can be used with `fs.writeFileSync()` to write a file synchronously. + */ +export type SyncWriteFileOptionsObject = Exclude<SyncWriteFileOptions, string>; + +/** + * All possible object-style options that can be passed to `fs.writeFile()` and `fs.writeFileSync()`. + */ +export type WriteFileOptionsObject = AsyncWriteFileOptionsObject | SyncWriteFileOptionsObject;