Interface TwingTemplate

interface TwingTemplate {
    aliases: TwingTemplateAliases;
    blockHandlers: Map<string, TwingTemplateBlockHandler>;
    canBeUsedAsATrait: boolean;
    macroHandlers: Map<string, TwingTemplateMacroHandler>;
    name: string;
    source: TwingSource;
    checkMethodAllowed(candidate, method): void;
    checkPropertyAllowed(candidate, property): void;
    checkSecurity(tags, filters, functions): void;
    createTemplateFromString(content, name): Promise<TwingTemplate>;
    displayBlock(name, context, outputBuffer, blocks, useBlocks, sandboxed, sourceMapRuntime?): Promise<void>;
    escape(value, strategy, charset, autoEscape?): Promise<string | boolean | TwingMarkup>;
    execute(context, outputBuffer, childBlocks, options?): Promise<void>;
    getBlocks(): Promise<TwingTemplateBlockMap>;
    getFilter(name): null | TwingFilter;
    getFunction(name): null | TwingFunction;
    getParent(context, outputBuffer, sandboxed, sourceMapRuntime?): Promise<null | TwingTemplate>;
    getTemplateSource(name): Promise<null | TwingSource>;
    getTest(name): null | TwingTest;
    getTraits(): Promise<TwingTemplateBlockMap>;
    hasBlock(name, context, outputBuffer, blocks, sandboxed, sourceMapRuntime?): Promise<boolean>;
    hasMacro(name): Promise<boolean>;
    loadEmbeddedTemplate(index): Promise<TwingTemplate>;
    loadTemplate(identifier): Promise<TwingTemplate>;
    render(context, options?): Promise<string>;
    renderBlock(name, context, outputBuffer, blocks, useBlocks, sandboxed, sourceMapRuntime?): Promise<string>;
    renderParentBlock(name, context, outputBuffer, sandboxed, sourceMapRuntime?): Promise<string>;
    resolveTemplate(names): Promise<TwingTemplate>;
}

Properties

aliases blockHandlers canBeUsedAsATrait macroHandlers name source

Methods

checkMethodAllowed checkPropertyAllowed checkSecurity createTemplateFromString displayBlock escape execute getBlocks getFilter getFunction getParent getTemplateSource getTest getTraits hasBlock hasMacro loadEmbeddedTemplate loadTemplate render renderBlock renderParentBlock resolveTemplate

Properties

Readonly aliases

aliases: TwingTemplateAliases

Readonly blockHandlers

blockHandlers: Map<string, TwingTemplateBlockHandler>

Readonly canBeUsedAsATrait

canBeUsedAsATrait: boolean

Readonly macroHandlers

macroHandlers: Map<string, TwingTemplateMacroHandler>

Readonly name

name: string

Readonly source

source: TwingSource

Methods

checkMethodAllowed

checkPropertyAllowed

checkSecurity

  • checkSecurity(tags, filters, functions): void

  • Parameters

    • tags: string[]
    • filters: string[]
    • functions: string[]

    Returns void

createTemplateFromString

displayBlock

escape

  • escape(value, strategy, charset, autoEscape?): Promise<string | boolean | TwingMarkup>

  • Parameters

    • value: undefined | null | string | boolean | TwingMarkup
    • strategy: string
    • charset: null | string
    • Optional autoEscape: boolean

    Returns Promise<string | boolean | TwingMarkup>

execute

getBlocks

getFilter

getFunction

getParent

getTemplateSource

getTest

getTraits

hasBlock

hasMacro

  • hasMacro(name): Promise<boolean>

  • Parameters

    • name: string

    Returns Promise<boolean>

loadEmbeddedTemplate

loadTemplate

render

renderBlock

renderParentBlock

resolveTemplate

  • resolveTemplate(names): Promise<TwingTemplate>

  • Tries to load templates consecutively from an array.

    Similar to loadTemplate() but it also accepts instances of TwingTemplate and an array of templates where each is tried to be loaded.

    Parameters

    • names: (null | string | TwingTemplate)[]

      A template or an array of templates to try consecutively

    Returns Promise<TwingTemplate>

Settings

Member Visibility

Theme

On This Page

aliasesblockHandlerscanBeUsedAsATraitmacroHandlersnamesourcecheckMethodAllowedcheckPropertyAllowedcheckSecuritycreateTemplateFromStringdisplayBlockescapeexecutegetBlocksgetFiltergetFunctiongetParentgetTemplateSourcegetTestgetTraitshasBlockhasMacroloadEmbeddedTemplateloadTemplaterenderrenderBlockrenderParentBlockresolveTemplate

Generated using TypeDoc