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

3.2.4 • Public • Published

Installation

npm install --save @types/folder-walker

Summary

This package contains type definitions for folder-walker (https://github.com/okdistribute/folder-walker (Does not have to be to GitHub).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/folder-walker.

index.d.ts

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

import * as fs from "fs";

interface WalkerOptions {
    fs?: NodeRequire;
    maxDepth?: number;
    filter: (filename: string) => boolean;
}

declare function walker(dirs: readonly string[], opts?: WalkerOptions): NodeJS.ReadableStream;

declare namespace walker {
    interface Entry {
        basename: string;
        relname: string;
        root: string;
        filepath: string;
        stat: fs.Stats;
        type: "file" | "directory";
    }
}

export = walker;

Additional Details

  • Last updated: Mon, 20 Nov 2023 23:36:24 GMT
  • Dependencies: @types/node

Credits

These definitions were written by bfsgr.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/folder-walker

Weekly Downloads

37

Version

3.2.4

License

MIT

Unpacked Size

3.67 kB

Total Files

5

Last publish

Collaborators

  • types