@types/rimraf

Install

npm i @types/rimraf

yarn add @types/rimraf

pnpm add @types/rimraf

TypeScript definitions for rimraf

rimraf: typeof rimraf;

sync: (path: string, options?: Options) => void;

It can remove stuff synchronously, too. But that's not so good. Use the async API. It's better.

interface Options {}

chmod?: typeof fs.chmod | undefined;

chmodSync?: typeof fs.chmodSync | undefined;

disableGlob?: boolean | undefined;

emfileWait?: number | undefined;

glob?: glob.IOptions | false | undefined;

lstat?: typeof fs.lstat | undefined;

lstatSync?: typeof fs.lstatSync | undefined;

maxBusyTries?: number | undefined;

readdir?: typeof fs.readdir | undefined;

readdirSync?: typeof fs.readdirSync | undefined;

rmdir?: typeof fs.rmdir | undefined;

rmdirSync?: typeof fs.rmdirSync | undefined;

stat?: typeof fs.stat | undefined;

statSync?: typeof fs.statSync | undefined;

unlink?: typeof fs.unlink | undefined;

unlinkSync?: typeof fs.unlinkSync | undefined;

No dev dependencies.

No peer dependencies.

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/@types/rimraf.

Markdown

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

HTML

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