PlatformViews

@tsed/platform-views

Usage

import { PlatformViews } from "@tsed/platform-views";

See /packages/platform/platform-views/src/services/PlatformViews.ts.

Overview

class PlatformViews {
    readonly root: string;
    readonly cache: boolean | undefined;
    readonly disabled: string | boolean;
    readonly viewEngine: string;
    protected env: Env | undefined;
    protected extensionsOptions: PlatformViewsExtensionsTypes;
    protected engineOptions: Record<string, PlatformViewsEngineOptions>;
    $onInit(): Promise<void>;
    loadEngines(): Promise<void>;
    getEngines(): {
        extension: string;
        engine: PlatformViewEngine;
    }[];
    registerEngine(engineType: string, engine: PlatformViewEngine): this;
    getEngine(type: string): PlatformViewEngine | undefined;
    getEngineOptions(engineType: string): PlatformViewsEngineOptions;
    render(viewPath: string, options?: any): Promise<string | PlatformViewWritableStream>;
    protected getExtension(viewPath: string): string;
    protected resolve(viewPath: string): {
        path: string;
        extension: string;
    };
}

readonly root

readonly root: string;

readonly cache

readonly cache: boolean | undefined;

readonly disabled

readonly disabled: string | boolean;

readonly viewEngine

readonly viewEngine: string;

protected env

protected env: Env | undefined;

protected extensionsOptions

protected extensionsOptions: PlatformViewsExtensionsTypes;

protected engineOptions

protected engineOptions: Record<string, PlatformViewsEngineOptions>;

$onInit

$onInit(): Promise<void>;

loadEngines

loadEngines(): Promise<void>;

getEngines

getEngines(): {
     extension: string;
     engine: PlatformViewEngine;
 }[];

registerEngine

registerEngine(engineType: string, engine: PlatformViewEngine): this;

getEngine

getEngine(type: string): PlatformViewEngine | undefined;

getEngineOptions

getEngineOptions(engineType: string): PlatformViewsEngineOptions;

render

render(viewPath: string, options?: any): Promise<string | PlatformViewWritableStream>;

protected getExtension

protected getExtension(viewPath: string): string;

protected resolve

protected resolve(viewPath: string): {
     path: string;
     extension: string;
 };