NPM Build Utilities @ 0.3.0-alpha.9
    Preparing search index...

    Interface ArgsInternal

    Rather than the input arguments (i.e., FileSystemType.Args), this is the shape of the object built by FileSystem.buildArgs.

    0.1.0-alpha

    interface Args {
        argsRecursive: true;
        copy: Partial<FileSystemType.Copy.Args>;
        copyFile: CopyFileArgs;
        glob: Partial<FileSystemType.Glob.Args>;
        minify:
            | Partial<FileSystemType.Minify.Args>
            | (
                <F extends FileSystemType.Minify.Format>(
                    format: F,
                ) => Partial<
                    FileSystemType.Minify.Args[F] & FileSystemType.Minify.Args["glob"],
                >
            );
        prettier: {
            css: Partial<FileSystemType.Prettier.Args>;
            html: Partial<FileSystemType.Prettier.Args>;
            js: Partial<FileSystemType.Prettier.Args>;
            json: Partial<FileSystemType.Prettier.Args>;
            md: Partial<FileSystemType.Prettier.Args>;
            mdx: Partial<FileSystemType.Prettier.Args>;
            scss: Partial<FileSystemType.Prettier.Args>;
            ts: Partial<FileSystemType.Prettier.Args>;
            yaml: Partial<FileSystemType.Prettier.Args>;
        };
        readDir: ReadDirArgs;
        readFile: ReadFileArgs;
        root: string;
        write: WriteFileArgs;
    }

    Hierarchy

    Index

    Properties

    argsRecursive copy copyFile glob minify prettier readDir readFile root write

    Properties

    argsRecursive: true

    Whether the arguments should be merged recursively.

    copy: Partial<FileSystemType.Copy.Args>

    Defaults for the FileSystemType.copy method.

    copyFile: CopyFileArgs

    Default configuration for NodeFiles.copy.

    2.0.0-alpha — Renamed to copyFile from copyFileArgs.

    glob: Partial<FileSystemType.Glob.Args>

    Defaults for the FileSystemType.glob method.

    minify:
        | Partial<FileSystemType.Minify.Args>
        | (
            <F extends FileSystemType.Minify.Format>(
                format: F,
            ) => Partial<
                FileSystemType.Minify.Args[F] & FileSystemType.Minify.Args["glob"],
            >
        )

    Defaults for the FileSystemType.minify method.

    prettier: {
        css: Partial<FileSystemType.Prettier.Args>;
        html: Partial<FileSystemType.Prettier.Args>;
        js: Partial<FileSystemType.Prettier.Args>;
        json: Partial<FileSystemType.Prettier.Args>;
        md: Partial<FileSystemType.Prettier.Args>;
        mdx: Partial<FileSystemType.Prettier.Args>;
        scss: Partial<FileSystemType.Prettier.Args>;
        ts: Partial<FileSystemType.Prettier.Args>;
        yaml: Partial<FileSystemType.Prettier.Args>;
    }

    Defaults for the FileSystemType.prettier method.

    readDir: ReadDirArgs

    Default configuration for NodeFiles.readDir.

    2.0.0-alpha — Renamed to readDir from readDirArgs.

    readFile: ReadFileArgs

    Default configuration for NodeFiles.readFile.

    2.0.0-alpha — Renamed to readFile from readFileArgs.

    root: string

    Path to the root directory (relative to node's cwd).

    './'
    write: WriteFileArgs

    Default configuration for NodeFiles.write.

    2.0.0-alpha — Renamed to write from writeArgs.

    Settings

    Member Visibility

    On This Page

    Properties