Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • RmOptions

Index

Properties

Optional force

force: boolean

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

default

false

Optional maxRetries

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.

default

0

Optional recursive

recursive: boolean

If true, perform a recursive directory removal. In recursive mode, errors are not reported if path does not exist, and operations are retried on failure.

default

false

Optional retryDelay

retryDelay: number

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

default

100

Generated using TypeDoc