Interface LoadOptions<Type>

Options for loading a directory tree.

interface LoadOptions<Type> {
    isFile?: IsFile;
    readDir?: ReadDir;
    readFile?: ReadFile<Type>;
}

Type Parameters

Type

Index

Properties

isFile? readDir? readFile?

Properties

`Optional`isFile

isFile?: IsFile

The function to check if a path is a file.

If not provided, isFileByExt is used. This function checks if the last part of the path contains a period.

Param: path

The path to check.

`Optional`readDir

readDir?: ReadDir

The function to read a directory.

Param: path

The path to the directory.

`Optional`readFile

readFile?: ReadFile<Type>

The function to read a file.

Template: Type

The type of the file contents.

Param: path

The path to the file.