Skip to content

TemplaterRunningConfig

One Templater render, as Templater’s create_running_config describes it.

Its members are snake_case because Templater’s are.

Import:

import type { TemplaterRunningConfig } from 'obsidian-dev-utils/obsidian/templater';

Signature:

export interface TemplaterRunningConfig

Properties

PropertyTypeDescription
active_file?null | TFile | undefinedThe file Templater considers active. Templater fills this in itself from workspace.activeEditor?.file ?? workspace.getActiveFile(); it is optional here because a hand-built config may omit it.
run_modeTemplaterRunModeWhich TemplaterRunMode the render is.
target_fileTFileThe file the render is for — what tp.file.* resolves to.
template_file?TFile | undefinedThe template being rendered, when there is one.

Links to this page: