UNPKG

1.75 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/bash-glob`
3
4# Summary
5This package contains type definitions for bash-glob (https://github.com/micromatch/bash-glob).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bash-glob.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bash-glob/index.d.ts)
10````ts
11type Patterns = string | string[];
12type Callback = (err: Error, files: string[]) => void;
13
14declare function bashGlob(pattern: Patterns, callback: Callback): void;
15declare function bashGlob(pattern: Patterns, options: bashGlob.Options, callback: Callback): void;
16
17declare namespace bashGlob {
18 interface Options {
19 cwd?: string | undefined;
20 dot?: boolean | undefined;
21 dotglob?: boolean | undefined;
22 extglob?: boolean | undefined;
23 failglob?: boolean | undefined;
24 globstar?: boolean | undefined;
25 nocase?: boolean | undefined;
26 nocaseglob?: boolean | undefined;
27 nullglob?: boolean | undefined;
28 }
29
30 function on(event: "match" | "files", callback: (files: string, cwd: string) => void): void;
31 function on(event: "end", callback: (files: string) => void): void;
32
33 function each(patterns: Patterns, callback: Callback): void;
34 function each(patterns: Patterns, options: Options, callback: Callback): void;
35
36 function promise(patterns: Patterns, options?: Options): Promise<string[]>;
37
38 function sync(patterns: Patterns, options?: Options): string[];
39}
40
41export = bashGlob;
42
43````
44
45### Additional Details
46 * Last updated: Mon, 06 Nov 2023 22:41:04 GMT
47 * Dependencies: none
48
49# Credits
50These definitions were written by [mrmlnc](https://github.com/mrmlnc).
51
\No newline at end of file