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

Index

Namespaces

fs

Functions

Functions

Const cleandir

cleandir(dirPath: fs.PathLike): Command

- Defined in command/builtin/cleandir.ts:12
Removes all contents of a directory, or creates the directory if absent. (Actually it tries rmdir() and then mkdir()).

Parameters
- dirPath: fs.PathLike
Returns Command

Const echo

echo(s: string): Command

- Defined in command/builtin/echo.ts:8
Creates an echo command (actually it writes to process.stdout directly instead of echo).

Parameters
- s: string
Returns Command

Const editFile

editFile(path: string, convert: (data: string) => string, encoding?: BufferEncoding): Command

- Defined in command/builtin/edit-file.ts:9
Creates a Command that edits a file by readFile() and writeFile(). Does not use stream so not suited for huge files.

Parameters
- path: string
- convert: (data: string) => string
  - - (data: string): string
    - Parameters
      - data: string
      Returns string
- encoding: BufferEncoding = "utf8"
Returns Command

Generated using TypeDoc