Type Alias WalkFilesParams

WalkFilesParams: {
    handleFileContents: (
        params: { contents: ReadFileOutput; path: string },
    ) => MaybePromise<void>;
    startDirPath: string;
} & PartialWithUndefined<
    {
        fs: {
            readdir: (
                path: PathLike,
                options: { withFileTypes: true },
            ) => MaybePromise<Pick<Dirent, "name" | "isDirectory">[]>;
            readFile: (path: PathLike | FileHandle) => MaybePromise<ReadFileOutput>;
        };
        shouldRead: (
            params: { isDir: boolean; path: string },
        ) => MaybePromise<boolean>;
    },
>

Params for walkFiles.

Type Declaration

handleFileContents: (params: { contents: ReadFileOutput; path: string }) => MaybePromise<void>
Do something with a read file's contents.
startDirPath: string
The directory to start walking files at.

Package

@augment-vir/node

Type Alias WalkFilesParams

Type Declaration

handleFileContents: (params: { contents: ReadFileOutput; path: string }) => MaybePromise<void>

startDirPath: string

Package

Settings