rimraf

rimraf

Version 6.0.1
Published 5 months ago
281 kB
2 dependencies
ISC license

Install

npm i rimraf

yarn add rimraf

pnpm add rimraf

Overview

A deep deletion module for node (like `rm -rf`)

Index

Variables

variable manual

const manual: ((
    path: string | string[],
    opt?: RimrafAsyncOptions
) => Promise<boolean>) & {
    sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
};

variable moveRemove

const moveRemove: ((
    path: string | string[],
    opt?: RimrafAsyncOptions
) => Promise<boolean>) & {
    sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
};

variable native

const native: ((
    path: string | string[],
    opt?: RimrafAsyncOptions
) => Promise<boolean>) & {
    sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
};

variable posix

const posix: ((
    path: string | string[],
    opt?: RimrafAsyncOptions
) => Promise<boolean>) & {
    sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
};

variable rimraf

const rimraf: ((
    path: string | string[],
    opt?: RimrafAsyncOptions
) => Promise<boolean>) & {
    rimraf: (path: string | string[], opt?: RimrafAsyncOptions) => Promise<boolean>;
    sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    rimrafSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    manual: ((
        path: string | string[],
        opt?: RimrafAsyncOptions
    ) => Promise<boolean>) & {
        sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    };
    manualSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    native: ((
        path: string | string[],
        opt?: RimrafAsyncOptions
    ) => Promise<boolean>) & {
        sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    };
    nativeSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    posix: ((
        path: string | string[],
        opt?: RimrafAsyncOptions
    ) => Promise<boolean>) & {
        sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    };
    posixSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    windows: ((
        path: string | string[],
        opt?: RimrafAsyncOptions
    ) => Promise<boolean>) & {
        sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    };
    windowsSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    moveRemove: ((
        path: string | string[],
        opt?: RimrafAsyncOptions
    ) => Promise<boolean>) & {
        sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
    };
    moveRemoveSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
};

variable windows

const windows: ((
    path: string | string[],
    opt?: RimrafAsyncOptions
) => Promise<boolean>) & {
    sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;
};

Functions

function assertRimrafOptions

assertRimrafOptions: (o: any) => void;

function isRimrafOptions

isRimrafOptions: (o: any) => o is RimrafOptions;

function manualSync

manualSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

function moveRemoveSync

moveRemoveSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

function nativeSync

nativeSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

function posixSync

posixSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

function rimrafSync

rimrafSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

function sync

sync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

function windowsSync

windowsSync: (path: string | string[], opt?: RimrafSyncOptions) => boolean;

Interfaces

interface RimrafAsyncOptions

interface RimrafAsyncOptions {}

property backoff

backoff?: number;

property filter

filter?:
    | ((path: string, ent: Dirent | Stats) => boolean)
    | ((path: string, ent: Dirent | Stats) => Promise<boolean>);

property glob

glob?: boolean | GlobOptions;

property maxBackoff

maxBackoff?: number;

property maxRetries

maxRetries?: number;

property preserveRoot

preserveRoot?: boolean;

property retryDelay

retryDelay?: number;

property signal

signal?: AbortSignal;

property tmp

tmp?: string;

interface RimrafSyncOptions

interface RimrafSyncOptions extends RimrafAsyncOptions {}

property filter

filter?: (path: string, ent: Dirent | Stats) => boolean;

Type Aliases

type RimrafOptions

type RimrafOptions = RimrafSyncOptions | RimrafAsyncOptions;

Package Files (2)

Dependencies (2)

Dev Dependencies (6)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/rimraf.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/rimraf)

HTML

<a href="https://www.jsdocs.io/package/rimraf"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 5 months ago.
Package analyzed in 1913 ms.
Missing or incorrect documentation? Open an issue for this package.