@plugjs/plug
Version:
PlugJS Build System ===================
29 lines (28 loc) • 917 B
TypeScript
import type { AbsolutePath } from '../paths';
import type { MatchOptions } from './match';
/** Specific options for walking a directory */
export interface WalkOptions extends MatchOptions {
/**
* Whether symlinks should be followed or not.
*
* @defaultValue `true`
*/
followSymlinks?: boolean;
/**
* The maximum depth (in directory levels) to recurse into.
*
* @defaultValue `Infinity`
*/
maxDepth?: number;
/**
* Whether to allow walking any `node_modules` directory or not.
*
* @defaultValue `false`
*/
allowNodeModules?: boolean;
}
/**
* Walk the specified directory, returning an asynchronous iterator over all
* the _relative_ files found matching the specified globs and matching options.
*/
export declare function walk(directory: AbsolutePath, globs: string[], options?: WalkOptions): AsyncGenerator<string, void, void>;