Interface TwingEnvironment

interface TwingEnvironment {
    cache: null | TwingCache;
    charset: string;
    dateFormat: string;
    dateIntervalFormat: string;
    escapingStrategyHandlers: Record<string, TwingEscapingStrategyHandler>;
    filters: Map<string, TwingFilter>;
    functions: Map<string, TwingFunction>;
    globals: TwingContext<string, any>;
    loader: TwingLoader | TwingSynchronousLoader;
    numberFormat: TwingNumberFormat;
    sandboxPolicy: TwingSandboxSecurityPolicy;
    tests: Map<string, TwingTest>;
    timezone: string;
    addExtension(extension: TwingExtension): void;
    addFilter(filter: TwingFilter): void;
    addFunction(aFunction: TwingFunction): void;
    addNodeVisitor(visitor: TwingNodeVisitor): void;
    addOperator(operator: TwingOperator): void;
    addTagHandler(parser: TwingTagHandler): void;
    addTest(test: TwingTest): void;
    loadTemplate(name: string, from?: null | string): Promise<TwingTemplate>;
    parse(stream: TwingTokenStream, options?: TwingParserOptions): TwingTemplateNode;
    registerEscapingStrategy(handler: TwingEscapingStrategyHandler, name: string): void;
    render(name: string, context: Record<string, any>, options?: {
        sandboxed?: boolean;
        strict?: boolean;
    }): Promise<string>;
    renderWithSourceMap(name: string, context: Record<string, any>, options?: {
        sandboxed?: boolean;
        strict?: boolean;
    }): Promise<{
        data: string;
        sourceMap: RawSourceMap;
    }>;
    tokenize(source: TwingSource): TwingTokenStream;
}

Properties

cache charset dateFormat dateIntervalFormat escapingStrategyHandlers filters functions globals loader numberFormat sandboxPolicy tests timezone

Methods

addExtension addFilter addFunction addNodeVisitor addOperator addTagHandler addTest loadTemplate parse registerEscapingStrategy render renderWithSourceMap tokenize

Properties

Readonlycache

cache: null | TwingCache

Readonlycharset

charset: string

ReadonlydateFormat

dateFormat: string

ReadonlydateIntervalFormat

dateIntervalFormat: string

ReadonlyescapingStrategyHandlers

escapingStrategyHandlers: Record<string, TwingEscapingStrategyHandler>

Readonlyfilters

filters: Map<string, TwingFilter>

Readonlyfunctions

functions: Map<string, TwingFunction>

Readonlyglobals

globals: TwingContext<string, any>

Readonlyloader

loader: TwingLoader | TwingSynchronousLoader

ReadonlynumberFormat

numberFormat: TwingNumberFormat

ReadonlysandboxPolicy

sandboxPolicy: TwingSandboxSecurityPolicy

Readonlytests

tests: Map<string, TwingTest>

Readonlytimezone

timezone: string

Methods

addExtension

addFilter

addFunction

addNodeVisitor

addOperator

addTagHandler

addTest

loadTemplate

  • loadTemplate(name, from?): Promise<TwingTemplate>

  • Loads a template by its name.

    Parameters

    • name: string

      The name of the template to load

    • Optionalfrom: null | string

      The name of the template that requested the load

    Returns Promise<TwingTemplate>

    Throws

    When the template cannot be found

    Throws

    When an error occurred during the parsing of the source

parse

registerEscapingStrategy

render

  • render(name, context, options?): Promise<string>

  • Convenient method that renders a template from its name.

    Parameters

    • name: string
    • context: Record<string, any>
    • Optionaloptions: {
          sandboxed?: boolean;
          strict?: boolean;
      }
      • Optionalsandboxed?: boolean
      • Optionalstrict?: boolean

    Returns Promise<string>

renderWithSourceMap

  • renderWithSourceMap(name, context, options?): Promise<{
        data: string;
        sourceMap: RawSourceMap;
    }>

  • Convenient method that renders a template from its name and returns both the render result and its belonging source map.

    Parameters

    • name: string
    • context: Record<string, any>
    • Optionaloptions: {
          sandboxed?: boolean;
          strict?: boolean;
      }
      • Optionalsandboxed?: boolean
      • Optionalstrict?: boolean

    Returns Promise<{
        data: string;
        sourceMap: RawSourceMap;
    }>

tokenize

Settings

Member Visibility

On This Page

Properties
Methods