@stryke/fs/dist/list-files.d.ts

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

import type { GlobOptions, Path } from "glob";
export type ListOptions = GlobOptions;
export 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
 */
export declare function list<TOptions extends ListOptions>(filesGlob: string, options?: TOptions): Promise<InferListReturnType<TOptions>>;
/**
 * A file listing helper function
 *
 * @param filesGlob - A glob pattern to match files
 * @returns A list of file paths
 */
export declare function listFiles<TOptions extends ListOptions>(filesGlob: string, options?: TOptions): Promise<InferListReturnType<TOptions>>;
/**
 * A directories listing helper function
 *
 * @param filesGlob - A glob pattern to match files
 * @returns A list of file paths
 */
export declare function listDirectories<TOptions extends ListOptions>(filesGlob: string, options?: TOptions): Promise<InferListReturnType<TOptions>>;