Skip to content

TemplaterApi.create_running_config method

TemplaterApi › create_running_config

Builds the TemplaterRunningConfig that describes one render.

Signature:

create_running_config(templateFile: TFile | undefined, targetFile: TFile, runMode: TemplaterRunMode): TemplaterRunningConfig

Parameters:

ParameterTypeDescription
templateFileTFile | undefinedThe template being rendered, or undefined when there is none (as when only the functions object is wanted).
targetFileTFileThe file the render is for.
runModeTemplaterRunModeWhich {@link TemplaterRunMode} the render is.

Returns: TemplaterRunningConfigThe running config.