fs | @fal-works/s-l-t-r

Index

Functions

Functions

Const copyFile

copyFile(src: fs.PathLike, dest: fs.PathLike, flags?: CopyFileParams[2]): Command

- Defined in command/builtin/fs.ts:28
Creates a Command that calls fs.promises.unlink().

Parameters
- src: fs.PathLike
- dest: fs.PathLike
- Optional flags: CopyFileParams[2]
  
  See Node.js docs.
Returns Command

Const mkdir

mkdir(path: fs.PathLike, options?: MkdirParams[1]): Command

- Defined in command/builtin/fs.ts:44
Creates a Command that calls fs.promises.mkdir().

Parameters
- path: fs.PathLike
- Optional options: MkdirParams[1]
  
  See Node.js docs.
Returns Command

Const rename

rename(oldPath: fs.PathLike, newPath: fs.PathLike): Command

- Defined in command/builtin/fs.ts:16
Creates a Command that calls fs.promises.rename().

Parameters
- oldPath: fs.PathLike
- newPath: fs.PathLike
Returns Command

Const rmdir

rmdir(path: fs.PathLike, options?: RmdirParams[1]): Command

- Defined in command/builtin/fs.ts:56
Creates a Command that calls fs.promises.rmdir().

Parameters
- path: fs.PathLike
- Optional options: RmdirParams[1]
  
  See Node.js docs.
Returns Command

Const unlink

unlink(path: fs.PathLike): Command

- Defined in command/builtin/fs.ts:10
Creates a Command that calls fs.promises.unlink().

Parameters
- path: fs.PathLike
Returns Command

Const writeFile

writeFile(path: WriteFileParams[0], data: WriteFileParams[1], options: WriteFileParams[2]): Command

- Defined in command/builtin/fs.ts:68
Creates a Command that calls fs.promises.writeFile().

Parameters
- path: WriteFileParams[0]
- data: WriteFileParams[1]
- options: WriteFileParams[2]
  
  See Node.js docs.
Returns Command

Generated using TypeDoc