@augment-vir/node/dist/augments/fs/walk-files.d.ts

A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.

import { type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
import { type Dirent, type PathLike } from 'node:fs';
import { type FileHandle, type readFile } from 'node:fs/promises';
/**
 * Output from `readfile`, used in {@link WalkFilesParams}.
 *
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export type ReadFileOutput = Awaited<ReturnType<typeof readFile>>;
/**
 * Params for {@link walkFiles}.
 *
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export type WalkFilesParams = {
    /** The directory to start walking files at. */
    startDirPath: string;
    /** Do something with a read file's contents. */
    handleFileContents: (params: {
        path: string;
        contents: ReadFileOutput;
    }) => MaybePromise<void>;
} & PartialWithUndefined<{
    /**
     * Check if a file should be read or a directory should be traversed.
     *
     * If this is not provided, every file will be read and every directory will be traversed.
     */
    shouldRead: (params: {
        path: string;
        isDir: boolean;
    }) => MaybePromise<boolean>;
    /** Optional overrides for the internally used `node:fs/promises' imports. */
    fs: {
        readFile: (path: PathLike | FileHandle) => MaybePromise<ReadFileOutput>;
        readdir: (path: PathLike, options: {
            withFileTypes: true;
        }) => MaybePromise<Pick<Dirent, 'name' | 'isDirectory'>[]>;
    };
}>;
/**
 * Walks files within a directory.
 *
 * @category Node : File
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export declare function walkFiles({ handleFileContents, shouldRead, startDirPath, fs, }: Readonly<WalkFilesParams>): Promise<void>;