Interface ProcessTemplateFileConfig

Configuration object for the template() function.

interface ProcessTemplateFileConfig {
    baseDir?: string;
    filters?: Map<string, Function>;
    includeDir?: string;
    layoutDir?: string;
    parentIncludes?: string[];
    parentLayouts?: string[];
    preprocessors?: Preprocessor[];
    relativeIncludes?: boolean;
    resolve?: (file: string) => Promise<string | Buffer>;
}

Properties

baseDir? filters? includeDir? layoutDir? parentIncludes? parentLayouts? preprocessors? relativeIncludes? resolve?

Properties

OptionalbaseDir

baseDir?: string

base directory. default: "."

Optionalfilters

filters?: Map<string, Function>

map of additional filters to be used in the template

OptionalincludeDir

includeDir?: string

subdirectory to look for html partials. default: "_includes"

OptionallayoutDir

layoutDir?: string

subdirectory to look for layout files. default: "_layouts"

OptionalparentIncludes

parentIncludes?: string[]

array of parent includes. Internally used to detect cyclic dependencies

OptionalparentLayouts

parentLayouts?: string[]

array of parent layouts. Internally used to detect cyclic dependencies

Optionalpreprocessors

preprocessors?: Preprocessor[]

list of preprocessors. By default: built-ins for html, css, markdown

OptionalrelativeIncludes

relativeIncludes?: boolean

whether to include relative to the current file. default: false

Optionalresolve

resolve?: (file: string) => Promise<string | Buffer>

optional resolver function (defaults to node readFile)

Settings

Member Visibility

On This Page

Properties