Skip to content

requireTemplaterApi

Gets Templater’s internal API, throwing when it cannot be had.

Use this where the caller cannot carry on without Templater — the error names the plugin and says which of the two failures occurred. Use resolveTemplaterApi instead where the integration is optional.

Import:

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

Signature:

function requireTemplaterApi(app: App): TemplaterApi

Parameters:

ParameterTypeDescription
appAppThe Obsidian app instance.

Returns: TemplaterApi — Templater’s internal API.