Class ViewEngine

Abstract base class for rendering views via different view engines.

Hierarchy

AppClass
- ViewEngine
  - PugViewEngine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ViewEngine(): ViewEngine

Overrides AppClass.constructor
- Defined in src/views/ViewEngine.ts:23
Returns ViewEngine

Properties

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 AppClass.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected container

container(): Container

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

Returns Container

getBoundMethod

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

Inherited from AppClass.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

Abstract getFileExtension

getFileExtension(): string

- Defined in src/views/ViewEngine.ts:59
Get the file extension of template files of this engine.

example

.pug

Returns string

Protected getGlobals

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 make

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

Inherited from AppClass.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): ViewEngine

- 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 ViewEngine

registerNamespace

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

- 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 ViewEngine

Abstract renderByName

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

- Defined in src/views/ViewEngine.ts:53
Given the canonical name of a template file, render the file using the provided variables.

Parameters
- templateName: string
- locals: {}
  - [key: string]: any
Returns string | Promise<string>

Abstract renderString

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

- Defined in src/views/ViewEngine.ts:46
Given a template string and a set of variables for the view, render the string to HTML and return it.

Parameters
- templateString: string
- locals: {}
  - [key: string]: any
Returns string | Promise<string>

resolveBasePath

resolveBasePath(templateName: string): UniversalPath

- 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

- 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.