UNPKG

1.68 kBTypeScriptView Raw
1/// <reference types="node" />
2import * as taskManager from './managers/tasks';
3import { Options as OptionsInternal } from './settings';
4import { Entry as EntryInternal, FileSystemAdapter as FileSystemAdapterInternal, Pattern as PatternInternal } from './types';
5declare type EntryObjectModePredicate = {
6 [TKey in keyof Pick<OptionsInternal, 'objectMode'>]-?: true;
7};
8declare type EntryStatsPredicate = {
9 [TKey in keyof Pick<OptionsInternal, 'stats'>]-?: true;
10};
11declare type EntryObjectPredicate = EntryObjectModePredicate | EntryStatsPredicate;
12declare function FastGlob(source: PatternInternal | PatternInternal[], options: OptionsInternal & EntryObjectPredicate): Promise<EntryInternal[]>;
13declare function FastGlob(source: PatternInternal | PatternInternal[], options?: OptionsInternal): Promise<string[]>;
14declare namespace FastGlob {
15 type Options = OptionsInternal;
16 type Entry = EntryInternal;
17 type Task = taskManager.Task;
18 type Pattern = PatternInternal;
19 type FileSystemAdapter = FileSystemAdapterInternal;
20 function sync(source: PatternInternal | PatternInternal[], options: OptionsInternal & EntryObjectPredicate): EntryInternal[];
21 function sync(source: PatternInternal | PatternInternal[], options?: OptionsInternal): string[];
22 function stream(source: PatternInternal | PatternInternal[], options?: OptionsInternal): NodeJS.ReadableStream;
23 function generateTasks(source: PatternInternal | PatternInternal[], options?: OptionsInternal): Task[];
24 function isDynamicPattern(source: PatternInternal, options?: OptionsInternal): boolean;
25 function escapePath(source: PatternInternal): PatternInternal;
26}
27export = FastGlob;