Interface TwingSynchronousEnvironment

interface TwingSynchronousEnvironment {
    cache: null | TwingSynchronousCache;
    charset: string;
    dateFormat: string;
    dateIntervalFormat: string;
    escapingStrategyHandlers: Record<string, TwingEscapingStrategyHandler>;
    filters: Map<string, TwingSynchronousFilter>;
    functions: Map<string, TwingSynchronousFunction>;
    globals: Map<string, any>;
    loader: TwingSynchronousLoader;
    numberFormat: TwingNumberFormat;
    sandboxPolicy: TwingSandboxSecurityPolicy;
    tests: Map<string, TwingSynchronousTest>;
    timezone: string;
    addExtension(extension: TwingSynchronousExtension): void;
    addFilter(filter: TwingSynchronousFilter): void;
    addFunction(aFunction: TwingSynchronousFunction): void;
    addNodeVisitor(visitor: TwingNodeVisitor): void;
    addOperator(operator: TwingOperator): void;
    addTagHandler(parser: TwingTagHandler): void;
    addTest(test: TwingSynchronousTest): void;
    loadTemplate(name: string, from?: null | string): TwingSynchronousTemplate;
    parse(stream: TwingTokenStream, options?: TwingParserOptions): TwingTemplateNode;
    registerEscapingStrategy(handler: TwingEscapingStrategyHandler, name: string): void;
    render(name: string, context: Record<string, any>, options?: {
        sandboxed?: boolean;
        strict?: boolean;
    }): string;
    renderWithSourceMap(name: string, context: Record<string, any>, options?: {
        sandboxed?: boolean;
        strict?: boolean;
    }): {
        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 | TwingSynchronousCache

Readonlycharset

charset: string

ReadonlydateFormat

dateFormat: string

ReadonlydateIntervalFormat

dateIntervalFormat: string

ReadonlyescapingStrategyHandlers

escapingStrategyHandlers: Record<string, TwingEscapingStrategyHandler>

Readonlyfilters

filters: Map<string, TwingSynchronousFilter>

Readonlyfunctions

functions: Map<string, TwingSynchronousFunction>

Readonlyglobals

globals: Map<string, any>

Readonlyloader

loader: TwingSynchronousLoader

ReadonlynumberFormat

numberFormat: TwingNumberFormat

ReadonlysandboxPolicy

sandboxPolicy: TwingSandboxSecurityPolicy

Readonlytests

tests: Map<string, TwingSynchronousTest>

Readonlytimezone

timezone: string

Methods

addExtension

addFilter

addFunction

addNodeVisitor

addOperator

addTagHandler

addTest

loadTemplate

parse

registerEscapingStrategy

render

  • render(name, context, options?): 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 string

renderWithSourceMap

  • renderWithSourceMap(name, context, options?): {
        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 {
        data: string;
        sourceMap: RawSourceMap;
    }

    • data: string
    • sourceMap: RawSourceMap

tokenize

Settings

Member Visibility

On This Page

Properties
Methods