@types/dir-walker-gen v1.0.4

Installation

npm install --save @types/dir-walker-gen

Summary

This package contains type definitions for dir-walker-gen (https://github.com/vsoneji/dir-walker-gen).

Details

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

index.d.ts

// Type definitions for dir-walker-gen 1.0
// Project: https://github.com/vsoneji/dir-walker-gen
// Definitions by: Shavkat Aynurin <https://github.com/aynurin>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare function DirGen(
    options: {
        /**
         * (Required) List of starting folders
         */
        folders: string[],
        /**
         * Does not show console warning when directories do not exist
         * @default {false}
         */
        silent?: boolean | undefined,
        /**
         * Ignores directories that start with a dot (e.g. .git, .vscode, etc)
         * @default {false}
         */
        ignoreDotDir?: boolean | undefined,
        /**
         * Exclude all folder that ends with any of the given strings
         * @default []
         */
        excludeFolders?: string[] | undefined,
        /**
         * List of extensions to ignore
         * @default []
         */
        excludeExtensions?: string[] | undefined,
        /**
         * List of extensions to scan (all other extensions are ignored)
         * @default []
         */
        includeExtensions?: string[] | undefined
    },
): IterableIterator<string>;

export = DirGen;

Additional Details

• Last updated: Thu, 08 Jul 2021 09:08:43 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Shavkat Aynurin.