@eggjs/view/src/app/extend/context.ts

Base view plugin for egg

import { Context } from '@eggjs/core';
import { ContextView } from '../../lib/context_view.js';
import { RenderOptions } from '../../lib/view_manager.js';

const VIEW = Symbol('Context#view');

export default class ViewContext extends Context {
  [VIEW]: ContextView;

  /**
   * Render a file by view engine, then set to body
   * @param {String} name - the file path based on root
   * @param {Object} [locals] - data used by template
   * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
   */
  async render(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<void> {
    const body = await this.renderView(name, locals, options);
    this.body = body;
  }

  /**
   * Render a file by view engine and return it
   * @param {String} name - the file path based on root
   * @param {Object} [locals] - data used by template
   * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
   * @return {Promise<String>} result - return a promise with a render result
   */
  async renderView(
    name: string,
    locals?: Record<string, any>,
    options?: RenderOptions,
  ): Promise<string> {
    return await this.view.render(name, locals, options);
  }

  /**
   * Render template string by view engine and return it
   * @param {String} tpl - template string
   * @param {Object} [locals] - data used by template
   * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
   * @return {Promise<String>} result - return a promise with a render result
   */
  async renderString(tpl: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string> {
    return await this.view.renderString(tpl, locals, options);
  }

  /**
   * View instance that is created every request
   * @member {ContextView} Context#view
   */
  get view() {
    if (!this[VIEW]) {
      this[VIEW] = new ContextView(this);
    }
    return this[VIEW];
  }
}

declare module '@eggjs/core' {
  interface Context {
    view: ContextView;
    render(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<void>;
    renderView(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
    renderString(tpl: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
  }
}