Class PugViewEngine

Implementation of the ViewEngine class that renders Pug/Jade templates.

Hierarchy

ViewEngine
- PugViewEngine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PugViewEngine(): PugViewEngine

Inherited from ViewEngine.constructor
- Defined in src/views/ViewEngine.ts:23
Returns PugViewEngine

Properties

Protected compileCache

compileCache: {} = {}

A cache of compiled templates.

Type declaration

[key: string]: (locals?: pug.LocalsObject) => string
- - (locals?: pug.LocalsObject): string
  - Parameters
    - Optional locals: pug.LocalsObject
    Returns string

Protected Readonly config

config: Config

Protected Readonly debug

debug: boolean

Protected Readonly globals

globals: {} = {}

Type declaration

[key: string]: (req: Maybe<Request>) => any
- - (req: Maybe<Request>): any
  - Parameters
    - req: Maybe<Request>
    Returns any

Protected Readonly namespaces

namespaces: {} = {}

Type declaration

[key: string]: UniversalPath

Protected Readonly request

request: RequestLocalStorage

Protected Readonly routing

routing: Routing

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

path

get path(): UniversalPath

- Defined in src/views/ViewEngine.ts:37
Get the UniversalPath to the base directory where views are loaded from.

Returns UniversalPath

Methods

Protected app

app(): Application

Inherited from ViewEngine.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected container

container(): Container

Inherited from ViewEngine.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from ViewEngine.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

getFileExtension

getFileExtension(): string

Overrides ViewEngine.getFileExtension
- Defined in src/views/PugViewEngine.ts:49
Returns string

Protected getGlobals

getGlobals(): {}

Inherited from ViewEngine.getGlobals
- Defined in src/views/ViewEngine.ts:65
Get the global variables that should be passed to every view rendered.

Returns {}
- [key: string]: any

Protected getOptions

getOptions(templateName?: string): Options

- Defined in src/views/PugViewEngine.ts:40
Get the object of options passed to Pug's compile methods.

Parameters
- Optional templateName: string
Returns Options

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from ViewEngine.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

registerGlobalFactory

registerGlobalFactory(name: string, factory: (req: Maybe<Request>) => any): PugViewEngine

Inherited from ViewEngine.registerGlobalFactory
- Defined in src/views/ViewEngine.ts:97
Register a new factory that produces a global available in the templates by default.

Parameters
- name: string
- factory: (req: Maybe<Request>) => any
  - - (req: Maybe<Request>): any
    - Parameters
      - req: Maybe<Request>
      Returns any
Returns PugViewEngine

registerNamespace

registerNamespace(namespace: string, basePath: UniversalPath): PugViewEngine

Inherited from ViewEngine.registerNamespace
- Defined in src/views/ViewEngine.ts:107
Register a path as a root for rendering views prefixed with the given namespace.

Parameters
- namespace: string
- basePath: UniversalPath
Returns PugViewEngine

renderByName

renderByName(templateName: string, locals: {}): string | Promise<string>

Overrides ViewEngine.renderByName
- Defined in src/views/PugViewEngine.ts:17
Parameters
- templateName: string
- locals: {}
  - [p: string]: any
Returns string | Promise<string>

renderString

renderString(templateString: string, locals: {}): string | Promise<string>

Overrides ViewEngine.renderString
- Defined in src/views/PugViewEngine.ts:13
Parameters
- templateString: string
- locals: {}
  - [p: string]: any
Returns string | Promise<string>

resolveBasePath

resolveBasePath(templateName: string): UniversalPath

Inherited from ViewEngine.resolveBasePath
- Defined in src/views/ViewEngine.ts:148
Given the name of a template, get a UniversalPath to the root of the tree where that template resides.

Parameters
- templateName: string
Returns UniversalPath

resolveName

resolveName(templateName: string): UniversalPath

Inherited from ViewEngine.resolveName
- Defined in src/views/ViewEngine.ts:120
Given the name of a template, get a UniversalPath pointing to its file.

Parameters
- templateName: string
Returns UniversalPath

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.