@types/rrdir NPM

Installation

npm install --save @types/rrdir

Summary

This package contains type definitions for rrdir (https://github.com/silverwind/rrdir#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rrdir.

index.d.ts

// Type definitions for rrdir 8.2
// Project: https://github.com/silverwind/rrdir#readme
// Definitions by: Zhang Nan <https://github.com/anyone-developer>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

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

import * as fs from "fs";
import { PicomatchOptions } from "picomatch";

interface rrdir {
    async(dir: string, options?: Options): Promise<Array<Entry<string>>>;
    async(dir: Buffer, options?: Options): Promise<Array<Entry<Buffer>>>;

    sync(dir: string, options?: Options): Array<Entry<string>>;
    sync(dir: Buffer, options?: Options): Array<Entry<Buffer>>;

    (dir: string, options?: Options): AsyncIterable<Entry<string>>;
    (dir: Buffer, options?: Options): AsyncIterable<Entry<Buffer>>;
}

declare const c: rrdir;
export = c;

interface Options {
    stats?: boolean | undefined;
    followSymlinks?: boolean | undefined;
    exclude?: string[] | undefined;
    include?: string[] | undefined;
    strict?: boolean | undefined;
    match?: PicomatchOptions | undefined;
}

interface Entry<T extends string | Buffer> {
    path: T;
    directory?: boolean | undefined;
    symlink?: boolean | undefined;
    stats?: fs.Stats | undefined;
    err?: Error | undefined;
}