# fs.rmDir.options

options for <fs.rmDir> and <fs.rmDirSync> methods

Availability

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

# maxRetries

Availability

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

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

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