@types/recursive-readdir

Installation

npm install --save @types/recursive-readdir

Summary

This package contains type definitions for recursive-readdir (https://github.com/jergason/recursive-readdir/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/recursive-readdir.

index.d.ts

/// <reference types="node" />

import * as fs from "fs";
declare namespace RecursiveReaddir {
    type IgnoreFunction = (file: string, stats: fs.Stats) => boolean;
    type Ignores = ReadonlyArray<string | IgnoreFunction>;
    type Callback = (error: Error, files: string[]) => void;
    interface readDir {
        (path: string, ignores?: Ignores): Promise<string[]>;
        (path: string, callback: Callback): void;
        (path: string, ignores: Ignores, callback: Callback): void;
    }
}

declare var recursiveReadDir: RecursiveReaddir.readDir;
export = recursiveReadDir;

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: @types/node

Credits

These definitions were written by Micah Zoltu.

Similar packages

Other packages similar to @types/recursive-readdir

readdirp

readdirp is a recursive version of fs.readdir with additional features like filtering and streaming. It provides a more flexible API compared to recursive-readdir.

klaw

klaw is a file system walker that reads directories recursively and supports filtering and streaming. It is similar to recursive-readdir but offers more advanced features like custom filters and event-based processing.

fs-extra

fs-extra is a module that extends the native Node.js fs module with additional methods, including recursive directory reading. It provides a comprehensive set of file system utilities beyond just reading directories.