# fs.rm.options

options for <fs.rm> and rmSync methods

Availability
8.3.0
8.3.0
9.2.0
Extends
Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# force

Availability
8.3.0
8.3.0
9.2.0
force :Boolean

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

Default: false


# maxRetries

Availability
8.3.0
8.3.0
9.2.0
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 milliseconds longer on each try. This option represents the number of retries. This option is ignored if the recursive option is not true.

Default: 0


# recursive

Availability
8.3.0
8.3.0
9.2.0
recursive :Boolean

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

Default: false


# retryDelay

Availability
8.3.0
8.3.0
9.2.0
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