UNPKG

@stryke/fs

Version:

A package containing various file system utilities that expand the functionality of NodeJs's built-in `fs` module.

github.com/storm-software/stryke

51 lines (50 loc) • 2.29 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
import { GlobOptions, Path } from "glob"; import { AssetGlob } from "@stryke/types/file"; //#region src/list-files.d.ts type ListOptions = GlobOptions; type InferListReturnType<TOptions extends GlobOptions> = TOptions["withFileTypes"] extends true ? Path[] : string[]; /** * A files and directories listing helper function * * @param filesGlob - A glob pattern to match files * @returns A list of file paths */ declare function list<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): Promise<InferListReturnType<TOptions>>; /** * A synchronous files and directories listing helper function * * @param filesGlob - A glob pattern to match files * @returns A list of file paths */ declare function listSync<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): InferListReturnType<TOptions>; /** * A file listing helper function * * @param filesGlob - A glob pattern to match files * @returns A list of file paths */ declare function listFiles<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): Promise<InferListReturnType<TOptions>>; /** * A synchronous file listing helper function * * @param filesGlob - A glob pattern to match files * @returns A list of file paths */ declare function listFilesSync<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): InferListReturnType<TOptions>; /** * A directories listing helper function * * @param filesGlob - A glob pattern to match files * @returns A list of file paths */ declare function listDirectories<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): Promise<InferListReturnType<TOptions>>; /** * A synchronous directories listing helper function * * @param filesGlob - A glob pattern to match files * @returns A list of file paths */ declare function listDirectoriesSync<TOptions extends ListOptions>(filesGlob: string | Omit<AssetGlob, "output">, options?: TOptions): InferListReturnType<TOptions>; //#endregion export { InferListReturnType, ListOptions, list, listDirectories, listDirectoriesSync, listFiles, listFilesSync, listSync }; //# sourceMappingURL=list-files.d.mts.map