FrmSync
Bun

function

fs.rmSync

function rmSync(
path: PathLike,
options?: RmOptions
): void;

Synchronously removes files and directories (modeled on the standard POSIX rm utility). Returns undefined.

Referenced types

type PathLike = string | Buffer | URL

Valid types for path values in "fs".

interface RmOptions

  • force?: boolean

    When true, exceptions will be ignored if path does not exist.

  • maxRetries?: number

    If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or EPERM error is encountered, Node.js will retry the operation with a linear backoff wait of retryDelay ms longer on each try. This option represents the number of retries. This option is ignored if the recursive option is not true.

  • recursive?: boolean

    If true, perform a recursive directory removal. In recursive mode, operations are retried on failure.

  • retryDelay?: number

    The amount of time in milliseconds to wait between retries. This option is ignored if the recursive option is not true.