jsDocs.io logo

@types/rimraf

  • Version 3.0.0
  • Published
  • 5.1 kB
  • 2 dependencies
  • MIT license

Install

npm i @types/rimraf
yarn add @types/rimraf
pnpm add @types/rimraf

Overview

TypeScript definitions for rimraf

Index

Functions

Interfaces

Functions

function rimraf

rimraf: typeof rimraf;

    function sync

    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.

    Interfaces

    interface Options

    interface Options {}

    property chmod

    chmod?: typeof fs.chmod;

      property chmodSync

      chmodSync?: typeof fs.chmodSync;

        property disableGlob

        disableGlob?: boolean;

        • false

        property emfileWait

        emfileWait?: number;

          property glob

          glob?: glob.IOptions | false;

            property lstat

            lstat?: typeof fs.lstat;

              property lstatSync

              lstatSync?: typeof fs.lstatSync;

                property maxBusyTries

                maxBusyTries?: number;

                  property readdir

                  readdir?: typeof fs.readdir;

                    property readdirSync

                    readdirSync?: typeof fs.readdirSync;

                      property rmdir

                      rmdir?: typeof fs.rmdir;

                        property rmdirSync

                        rmdirSync?: typeof fs.rmdirSync;

                          property stat

                          stat?: typeof fs.stat;

                            property statSync

                            statSync?: typeof fs.statSync;
                              unlink?: typeof fs.unlink;

                                property unlinkSync

                                unlinkSync?: typeof fs.unlinkSync;

                                  Package Files (1)

                                  Dependencies (2)

                                  Dev Dependencies (0)

                                  No dev dependencies.

                                  Peer Dependencies (0)

                                  No peer dependencies.

                                  Badge

                                  To add a badge like this onejsDocs.io badgeto 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>