Logo for jsDocs.io

@types/recursive-readdir

  • Version 2.2.1
  • Published
  • 4.34 kB
  • 1 dependency
  • MIT license

Install

npm i @types/recursive-readdir
yarn add @types/recursive-readdir
pnpm add @types/recursive-readdir

Overview

TypeScript definitions for recursive-readdir

Index

Variables

Namespaces

Variables

variable recursiveReadDir

var recursiveReadDir: RecursiveReaddir.readDir;

    Namespaces

    namespace RecursiveReaddir

    namespace RecursiveReaddir {}

      interface readDir

      interface readDir {}

        call signature

        (path: string, ignores?: Ignores): Promise<string[]>;

          call signature

          (path: string, callback: Callback): void;

            call signature

            (path: string, ignores: Ignores, callback: Callback): void;

              type Callback

              type Callback = (error: Error, files: string[]) => void;

                type IgnoreFunction

                type IgnoreFunction = (file: string, stats: fs.Stats) => boolean;

                  type Ignores

                  type Ignores = ReadonlyArray<string | IgnoreFunction>;

                    Package Files (1)

                    Dependencies (1)

                    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/recursive-readdir.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/recursive-readdir)
                    • HTML
                      <a href="https://www.jsdocs.io/package/@types/recursive-readdir"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>