Class NunjucksEnvironment

constructor

• new NunjucksEnvironment(loader?, opts?): NunjucksEnvironment

• Parameters

  • Optional loader: null | ILoaderAny | ILoaderAny[]
  • Optional opts: ConfigureOptions

  Returns NunjucksEnvironment

options

addExtension

• addExtension(name, ext): NunjucksEnvironment

• Parameters

  • name: string
  • ext: Extension

  Returns NunjucksEnvironment

addFilter

• addFilter(name, func, async?): NunjucksEnvironment

• Parameters

  • name: string
  • func: ((...args) => any)
    • • (...args): any

      • Parameters

        • Rest ...args: any[]

        Returns any

  • Optional async: boolean

  Returns NunjucksEnvironment

addGlobal

• addGlobal(name, value): NunjucksEnvironment

• Parameters

  • name: string
  • value: any

  Returns NunjucksEnvironment

express

• express(app): void

• Parameters

  • app: object

  Returns void

getExtension

• getExtension(name): Extension

• Parameters

  • name: string

  Returns Extension

getFilter

• getFilter(name): ((...args) => any)

• Parameters

  • name: string

  Returns ((...args) => any)

  • • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

getGlobal

• getGlobal(name): any

• Parameters

  • name: string

  Returns any

getTemplate

• getTemplate(name, eagerCompile?): NunjucksTemplate

• Parameters

  • name: string
  • Optional eagerCompile: boolean

  Returns NunjucksTemplate

• getTemplate(name, eagerCompile?, callback?): void

• Parameters

  • name: string
  • Optional eagerCompile: boolean
  • Optional callback: Callback<Error, NunjucksTemplate>

  Returns void

hasExtension

• hasExtension(name): boolean

• Parameters

  • name: string

  Returns boolean

on

• on(event, fn): void

• Parameters

  • event: "load"
  • fn: ((name, source, loader) => void)
    • • (name, source, loader): void

      • Parameters

        • name: string
        • source: {
              noCache: boolean;
              path: string;
              src: string;
          }

          • noCache: boolean

          • path: string

          • src: string

        • loader: Loader

        Returns void

  Returns void

removeExtension

• removeExtension(name): void

• Parameters

  • name: string

  Returns void

render

• render(name, context?): string

• Parameters

  • name: string
  • Optional context: object

  Returns string

• render(name, context?, callback?): void

• Parameters

  • name: string
  • Optional context: object
  • Optional callback: NunjucksTemplateCallback<string>

  Returns void

renderString

• renderString(name, context): string

• Parameters

  • name: string
  • context: object

  Returns string

• renderString(name, context, callback?): void

• Parameters

  • name: string
  • context: object
  • Optional callback: NunjucksTemplateCallback<string>

  Returns void