@types/rrdir
TypeScript icon, indicating that this package has built-in type declarations

13.0.0 • Public • Published

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.

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

import * as fs from "fs";

declare function rrdirAsync(dir: string, options?: Options): Promise<Array<Entry<string>>>;
declare function rrdirAsync(dir: Uint8Array, options?: Options): Promise<Array<Entry<Uint8Array>>>;

declare function rrdirSync(dir: string, options?: Options): Array<Entry<string>>;
declare function rrdirSync(dir: Uint8Array, options?: Options): Array<Entry<Uint8Array>>;

declare function rrdir(dir: string, options?: Options): AsyncIterable<Entry<string>>;
declare function rrdir(dir: Uint8Array, options?: Options): AsyncIterable<Entry<Uint8Array>>;

export { rrdir, rrdirAsync, rrdirSync };

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

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

Additional Details

  • Last updated: Thu, 21 Mar 2024 10:06:51 GMT
  • Dependencies: @types/node

Credits

These definitions were written by Zhang Nan.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/rrdir

Weekly Downloads

11

Version

13.0.0

License

MIT

Unpacked Size

4.81 kB

Total Files

5

Last publish

Collaborators

  • types