aaronccasanova / aacc Goto Github PK

Resources:

• https://nodejs.org/api/fs.html#fspromisesreadfilepath-options

Never gonna happen: microsoft/TypeScript#14116

Hello,

It would be nice to add the following features to cross-runtime :

• Tauri support :
  • for isTauri using window.__TAURI__ ;
  • for writeFile using writeTextFile from @tauri-apps/api/fs ;
  • for readFile using readTextFile from @tauri-apps/api/fs.
• A readLines method for reading a file line by line :
  • for Node using createInterface from node:readline & createReadStream from node:fs ;
  • solutions pending for Deno, Bun and Tauri.
• An exec method for running a command and returning an output :
  • for Deno using Deno.Command().output() ;
  • for Node using exec from node:child_process ;
  • for Bun using $`​`.quiet() from bun ;
  • for Tauri using new Command().execute() from @tauri-apps/api/shell.
• A spawn method for running a command and returning a stream :
  • for Deno using Deno.Command().spawn() ;
  • for Node using spawn from node:child_process ;
  • for Bun using Bun.spawn() ;
  • for Tauri using new Command().spawn() from @tauri-apps/api/shell.
• A writeBinaryFile method for writing binary files :
  • for Deno using Deno.writeFile() taking an Uint8Array ;
  • for Node using encoding = null taking a Buffer or any TypedArray ;
  • for Bun using Bun.write() taking an ArrayBuffer, a Blob or any TypedArray ;
  • for Tauri using writeBinaryFile from @tauri-apps/api/fs taking an ArrayBuffer ;
  • while converting any output type the user passes to what the runtime wants.
• A readBinaryFile method for reading binary files :
  • for Deno using Deno.readFile() returning an Uint8Array ;
  • for Node using encoding = null returning a Buffer ;
  • for Bun using Bun.file().arrayBuffer() returning an ArrayBuffer ;
  • for Tauri using readBinaryFile from @tauri-apps/api/fs returning an Uint8Array ;
  • while converting any output type the runtime returns to what the user wants, probably ArrayBuffer by default.

Additionally, it would be nice to :

• have writeTextFile & readTextFile aliases for writeFile & readFile for consistency purposes ;
• use Bun.file().text() in readFile instead of relying on Bun's Node polyfill.

If you'd like, I'm willing to make a PR for everything listed here, with JS and JSDoc, but not TS though.

Thanks