Class Renderer

Renderer class.

Hierarchy

Renderer

Index

Constructors

constructor

new Renderer(): Renderer
Returns Renderer

Properties

_viewIndex

_viewIndex: undefined | ViewIndex = undefined

autoCompress

autoCompress: boolean = true

Try to negotiate compression for dynamically generated response content and gzip compress it automatically.

defaultEngine

defaultEngine: string = 'tmpl'

The default template engine to use for rendering in cases where auto-detection doesn't work, like for inline templates, defaults to tmpl.

defaultFormat

defaultFormat: string = 'html'

The default format to render if format is not set, defaults to html. Note that changing the default away from html is not recommended, as it has the potential to break, for example, plugins with bundled templates.

engines

engines: Record<string, ViewEngine> = {}

Template engines.

minCompressSize

minCompressSize: number = 860

Minimum output size in bytes required for compression to be used if enabled, defaults to 860.

viewPaths

viewPaths: string[] = ...

Directories to look for templates in, first one has the highest precedence.

Methods

_renderInline

_renderInline(ctx, options): Promise<null | EngineResult>
Parameters
- ctx: MojoContext
- options: MojoRenderOptions
Returns Promise<null | EngineResult>
- Defined in mojo.js-main/src/renderer.ts:208

_renderView

_renderView(ctx, options): Promise<null | EngineResult>
Parameters
- ctx: MojoContext
- options: MojoRenderOptions
Returns Promise<null | EngineResult>
- Defined in mojo.js-main/src/renderer.ts:214

addEngine

addEngine(name, engine): Renderer
Register a template engine.
Parameters
- name: string
- engine: ViewEngine
Returns Renderer
- Defined in mojo.js-main/src/renderer.ts:60

findView

findView(options): null | ViewSuggestion
Find a view for render parameters.
Parameters
- options: MojoRenderOptions
Returns null | ViewSuggestion
Example
```
// Find path to JSON view
const suggestion = renderer.findView({view: 'foo', 'format': 'json'});
const {path} = suggestion;
```
- Defined in mojo.js-main/src/renderer.ts:72

render

render(ctx, options): Promise<null | EngineResult>
Render output through one of the template engines.
Parameters
- ctx: MojoContext
- options: MojoRenderOptions
Returns Promise<null | EngineResult>
- Defined in mojo.js-main/src/renderer.ts:97

respond

respond(ctx, result, options): Promise<boolean>
Finalize dynamically generated response content and compress it if possible.
Parameters
- ctx: MojoContext
- result: EngineResult
- options: {
  status?: number;
  }
  - Optional status?: number
Returns Promise<boolean>
- Defined in mojo.js-main/src/renderer.ts:166

warmup

warmup(): Promise<void>
Prepare views for rendering.

Returns Promise<void>
- Defined in mojo.js-main/src/renderer.ts:191

Class Renderer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Renderer

Properties

_viewIndex

autoCompress

defaultEngine

defaultFormat

engines

minCompressSize

viewPaths

Methods

_renderInline

Parameters

ctx: MojoContext

options: MojoRenderOptions

Returns Promise<null | EngineResult>

_renderView

Parameters

ctx: MojoContext

options: MojoRenderOptions

Returns Promise<null | EngineResult>

addEngine

Parameters

name: string

engine: ViewEngine

Returns Renderer

findView

Parameters

options: MojoRenderOptions

Returns null | ViewSuggestion

Example

render

Parameters

ctx: MojoContext

options: MojoRenderOptions

Returns Promise<null | EngineResult>

respond

Parameters

ctx: MojoContext

result: EngineResult

options: { status?: number; }

Optional status?: number

Returns Promise<boolean>

warmup

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

options: {
status?: number;
}

`Optional` status?: number