@fastify/view/types/index.d.ts

Template plugin for Fastify

import { FastifyPluginAsync } from 'fastify'

declare module 'fastify' {

  interface RouteSpecificOptions {
    layout?: string;
  }

  interface FastifyReply {
    view<T extends { [key: string]: any; }>(page: string, data: T, opts?: RouteSpecificOptions): FastifyReply;
    view(page: string, data?: object, opts?: RouteSpecificOptions): FastifyReply;
    viewAsync<T extends { [key: string]: any; }>(page: string, data: T, opts?: RouteSpecificOptions): Promise<string>;
    viewAsync(page: string, data?: object, opts?: RouteSpecificOptions): Promise<string>;
  }

  interface FastifyInstance {
    view<T extends { [key: string]: any; }>(page: string, data: T, opts?: RouteSpecificOptions): Promise<string>;
    view(page: string, data?: object, opts?: RouteSpecificOptions): Promise<string>;
  }
}

type FastifyView = FastifyPluginAsync<fastifyView.FastifyViewOptions>

declare namespace fastifyView {
  export interface FastifyViewOptions {
    engine: {
      ejs?: any;
      eta?: any;
      nunjucks?: any;
      pug?: any;
      handlebars?: any;
      mustache?: any;
      twig?: any;
      liquid?: any;
      dot?: any;
    };
    templates?: string | string[];
    includeViewExtension?: boolean;
    options?: object;
    charset?: string;
    maxCache?: number;
    production?: boolean;
    defaultContext?: object;
    layout?: string;
    root?: string;
    viewExt?: string;
    propertyName?: string;
    asyncPropertyName?: string;
  }

  /**
   * @deprecated Use FastifyViewOptions
   */
  export type PointOfViewOptions = FastifyViewOptions

  export const fastifyView: FastifyView
  export { fastifyView as default }
  export const fastifyViewCache: Symbol
}

declare function fastifyView (...params: Parameters<FastifyView>): ReturnType<FastifyView>
export = fastifyView