• Version 3.0.2
  • Published
  • 7.5 kB
  • 2 dependencies
  • MIT license


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


TypeScript definitions for rimraf



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.


    interface Options

    interface Options {}

    property chmod

    chmod?: typeof fs.chmod | undefined;

      property chmodSync

      chmodSync?: typeof fs.chmodSync | undefined;

        property disableGlob

        disableGlob?: boolean | undefined;
        • false

        property emfileWait

        emfileWait?: number | undefined;

          property glob

          glob?: glob.IOptions | false | undefined;

            property lstat

            lstat?: typeof fs.lstat | undefined;

              property lstatSync

              lstatSync?: typeof fs.lstatSync | undefined;

                property maxBusyTries

                maxBusyTries?: number | undefined;

                  property readdir

                  readdir?: typeof fs.readdir | undefined;

                    property readdirSync

                    readdirSync?: typeof fs.readdirSync | undefined;

                      property rmdir

                      rmdir?: typeof fs.rmdir | undefined;

                        property rmdirSync

                        rmdirSync?: typeof fs.rmdirSync | undefined;

                          property stat

                          stat?: typeof fs.stat | undefined;

                            property statSync

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

                                property unlinkSync

                                unlinkSync?: typeof fs.unlinkSync | undefined;

                                  Package Files (1)

                                  Dependencies (2)

                                  Dev Dependencies (0)

                                  No dev dependencies.

                                  Peer Dependencies (0)

                                  No peer dependencies.


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