Interface RmOptions

interface RmOptions {
    force?: boolean;
    maxRetries?: number;
    recursive?: boolean;
    retryDelay?: number;
}

Properties

force? maxRetries? recursive? retryDelay?

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, 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc