DefinitelyTyped/types/dir-walker-gen/index.d.ts
Shavkat Aynurin 48fd0bd15a Added type definitions for dir-walker-gen (#35824)
* Added type definitions for dir-walker-gen

* Regenerated type defintions for dir-walker-gen using dts-gen

* Fixed lint errors for dir-walker-gen
2019-05-30 12:03:53 -07:00

41 lines
1.1 KiB
TypeScript

// 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,
/**
* Ignores directories that start with a dot (e.g. .git, .vscode, etc)
* @default {false}
*/
ignoreDotDir?: boolean,
/**
* Exclude all folder that ends with any of the given strings
* @default []
*/
excludeFolders?: string[],
/**
* List of extensions to ignore
* @default []
*/
excludeExtensions?: string[],
/**
* List of extensions to scan (all other extensions are ignored)
* @default []
*/
includeExtensions?: string[]
},
): IterableIterator<string>;
export = DirGen;