Interface TwingSynchronousTemplate

Readonlyaliases

Readonlyast

ReadonlyblockHandlers

ReadonlycanBeUsedAsATrait

ReadonlyembeddedTemplates

ReadonlymacroHandlers

Readonlyname

Readonlysource

displayBlock

• displayBlock(
      executionContext: TwingSynchronousExecutionContext,
      name: string,
      useBlocks: boolean,
  ): void

  Parameters

  • executionContext: TwingSynchronousExecutionContext
  • name: string
  • useBlocks: boolean

  Returns void

displayParentBlock

• displayParentBlock(
      executionContext: TwingSynchronousExecutionContext,
      name: string,
  ): void

  Parameters

  • executionContext: TwingSynchronousExecutionContext
  • name: string

  Returns void

execute

• execute(
      environment: TwingSynchronousEnvironment,
      context: Record<string, any> | MapLike<string, any>,
      blocks: TwingSynchronousTemplateBlockMap,
      outputBuffer: TwingOutputBuffer,
      options?: {
          nodeExecutor?: TwingSynchronousNodeExecutor;
          sandboxed?: boolean;
          sourceMapRuntime?: TwingSourceMapRuntime;
          strict?: boolean;
          templateLoader?: TwingSynchronousTemplateLoader;
      },
  ): void

  Semantically speaking, provide a closure to the template:

  • an environment providing the filters, functions, globals and tests;
  • a context providing the variables;
  • a block map providing the available blocks;
  • an output buffer providing the mean to output the result of an expression.

  Technically speaking, execute the template and stream the result to the output buffer.

  Parameters

  • environment: TwingSynchronousEnvironment
  • context: Record<string, any> | MapLike<string, any>
  • blocks: TwingSynchronousTemplateBlockMap
  • outputBuffer: TwingOutputBuffer
  • Optionaloptions: {
        nodeExecutor?: TwingSynchronousNodeExecutor;
        sandboxed?: boolean;
        sourceMapRuntime?: TwingSourceMapRuntime;
        strict?: boolean;
        templateLoader?: TwingSynchronousTemplateLoader;
    }

    • OptionalnodeExecutor?: TwingSynchronousNodeExecutor

    • Optionalsandboxed?: boolean

    • OptionalsourceMapRuntime?: TwingSourceMapRuntime

    • Optionalstrict?: boolean

      Controls whether accessing invalid variables (variables and or attributes/methods that do not exist) triggers an error.

      When set to true, accessing invalid variables triggers an error.

    • OptionaltemplateLoader?: TwingSynchronousTemplateLoader

  Returns void

getBlocks

• getBlocks(
      executionContext: TwingSynchronousExecutionContext,
  ): TwingSynchronousTemplateBlockMap

  Parameters

  • executionContext: TwingSynchronousExecutionContext

  Returns TwingSynchronousTemplateBlockMap

getParent

• getParent(
      executionContext: TwingSynchronousExecutionContext,
  ): TwingSynchronousTemplate | null

  Parameters

  • executionContext: TwingSynchronousExecutionContext

  Returns TwingSynchronousTemplate | null

getTraits

• getTraits(
      executionContext: TwingSynchronousExecutionContext,
  ): TwingSynchronousTemplateBlockMap

  Parameters

  • executionContext: TwingSynchronousExecutionContext

  Returns TwingSynchronousTemplateBlockMap

hasBlock

• hasBlock(
      executionContext: TwingSynchronousExecutionContext,
      name: string,
      blocks: TwingSynchronousTemplateBlockMap,
  ): boolean

  Parameters

  • executionContext: TwingSynchronousExecutionContext
  • name: string
  • blocks: TwingSynchronousTemplateBlockMap

  Returns boolean

hasMacro

• hasMacro(name: string): boolean

  Parameters

  • name: string

  Returns boolean

loadTemplate

• loadTemplate(
      executionContext: TwingSynchronousExecutionContext,
      identifier:
          | string
          | TwingSynchronousTemplate
          | (string | TwingSynchronousTemplate | null)[],
  ): TwingSynchronousTemplate

  Parameters

  • executionContext: TwingSynchronousExecutionContext
  • identifier: string | TwingSynchronousTemplate | (string | TwingSynchronousTemplate | null)[]

  Returns TwingSynchronousTemplate

  Throws

  When no embedded template exists for the passed identifier.

render

• render(
      environment: TwingSynchronousEnvironment,
      context: Record<string, any> | MapLike<string, any>,
      options?: {
          nodeExecutor?: TwingSynchronousNodeExecutor;
          outputBuffer?: TwingOutputBuffer;
          sandboxed?: boolean;
          sourceMapRuntime?: TwingSourceMapRuntime;
          strict?: boolean;
          templateLoader?: TwingSynchronousTemplateLoader;
      },
  ): string

  Parameters

  • environment: TwingSynchronousEnvironment
  • context: Record<string, any> | MapLike<string, any>
  • Optionaloptions: {
        nodeExecutor?: TwingSynchronousNodeExecutor;
        outputBuffer?: TwingOutputBuffer;
        sandboxed?: boolean;
        sourceMapRuntime?: TwingSourceMapRuntime;
        strict?: boolean;
        templateLoader?: TwingSynchronousTemplateLoader;
    }

    • OptionalnodeExecutor?: TwingSynchronousNodeExecutor

    • OptionaloutputBuffer?: TwingOutputBuffer

    • Optionalsandboxed?: boolean

    • OptionalsourceMapRuntime?: TwingSourceMapRuntime

    • Optionalstrict?: boolean

      Controls whether accessing invalid variables (variables and or attributes/methods that do not exist) triggers an error.

      When set to true, accessing invalid variables triggers an error.

    • OptionaltemplateLoader?: TwingSynchronousTemplateLoader

  Returns string