@plugjs/plug
Version:
PlugJS Build System ===================
30 lines (29 loc) • 1.07 kB
TypeScript
import type { MatchOptions } from '../utils/match';
/** Options for filtering {@link Files}. */
export interface FilterOptions extends MatchOptions {
/** The base directory for filtering, and relativising the resulting files. */
directory?: string;
}
declare module '../index' {
interface Pipe {
/**
* Filter the current {@link Files} using globs.
*
* @param glob The glob to use for filtering files
*/
filter(glob: string): Pipe;
/**
* Filter the current {@link Files} using globs.
*
* @param globs The globs to use for filtering files (at least one)
*/
filter(...globs: [string, ...string[]]): Pipe;
/**
* Filter the current {@link Files} using globs.
*
* @param globs The globs to use for filtering files (at least one)
* @param options Additional {@link FilterOptions | options} for filtering
*/
filter(...args: [...globs: [string, ...string[]], options: FilterOptions]): Pipe;
}
}