readdirp

Variables

• EntryTypes

Functions

• readdirp()
• readdirpPromise()

Classes

• ReaddirpStream

  • parent
  • parents
  • reading

Interfaces

• DirEntry

  • depth
  • files
  • path
• EntryInfo

  • basename
  • dirent
  • fullPath
  • path
  • stats

Type Aliases

• EntryType
• Path
• PathOrDirent
• Predicate
• ReaddirpOptions
• Tester

variable EntryTypes

const EntryTypes: {
    readonly FILE_TYPE: 'files';
    readonly DIR_TYPE: 'directories';
    readonly FILE_DIR_TYPE: 'files_directories';
    readonly EVERYTHING_TYPE: 'all';
};

function readdirp

readdirp: (root: Path, options?: Partial<ReaddirpOptions>) => ReaddirpStream;

• Streaming version: Reads all files and directories in given root recursively. Consumes ~constant small amount of RAM.

  Parameter root

  Root directory

  Parameter options

  Options to specify root (start directory), filters and recursion depth

function readdirpPromise

readdirpPromise: (
    root: Path,
    options?: Partial<ReaddirpOptions>
) => Promise<EntryInfo[]>;

• Promise version: Reads all files and directories in given root recursively. Compared to streaming version, will consume a lot of RAM e.g. when 1 million files are listed.

  Returns

  array of paths and their entry infos

type EntryType

type EntryType = (typeof EntryTypes)[keyof typeof EntryTypes];

type Path

type Path = string;

• Path in file system.

type PathOrDirent

type PathOrDirent = Dirent | Path;

• Path or dir entries (files)

type Predicate

type Predicate = string[] | string | Tester;

type ReaddirpOptions

type ReaddirpOptions = {
    root: string;
    fileFilter?: Predicate;
    directoryFilter?: Predicate;
    type?: EntryType;
    lstat?: boolean;
    depth?: number;
    alwaysStat?: boolean;
    highWaterMark?: number;
};

• Options for readdirp. * type: files, directories, or both * lstat: whether to use symlink-friendly stat * depth: max depth * alwaysStat: whether to use stat (more resources) or dirent * highWaterMark: streaming param, specifies max amount of resources per entry

type Tester

type Tester = (entryInfo: EntryInfo) => boolean;

• Filterer for files