actions/mc-publish
1
0
Fork 0
mirror of https://github.com/Kir-Antipov/mc-publish.git synced 2024-11-22 08:20:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Made a few utility types for writeFile options

Browse source
This commit is contained in:
Kir_Antipov 2023-01-25 17:51:19 +00:00
parent 88b6d0607a
commit 79519efc22
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
src/utils/io/write-file-options.ts Normal file
View file

@ -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;