express-tsx-views/dist/react-view-engine.interface.d.ts

Server-side JSX/TSX rendering for your express or NestJS application 🚀

import { Application } from 'express';
import { Context } from 'react';
import { TsxRenderMiddleware } from './handler/index.js';
export interface ReactViewsOptions {
    /**
     * The directory where your views (`.tsx` files) are stored. Must be
     * specified.
     */
    viewsDirectory: string;
    /**
     * [Doctype](https://developer.mozilla.org/en-US/docs/Glossary/Doctype) to
     * be used. */
    doctype?: string;
    /**
     * If activated, the generated HTML string is formatted using
     * [prettier](https://github.com/prettier/prettier)
     *
     * @deprecated use `PrettifyRenderMiddleware` instead, @see `middlewares`
     */
    prettify?: boolean;
    /**
     * With this optional function the rendered HTML document can be modified. For
     * this purpose a function must be defined which gets the HTML `string` as
     * argument. The function returns a modified version of the HTML string as
     * `string`.
     */
    transform?: (html: string) => string | Promise<string>;
    middlewares?: TsxRenderMiddleware[];
}
export type EngineCallbackParameters = Parameters<Parameters<Application['engine']>[1]>;
export type ExpressLikeApp = Application;
export type ContextDefinition<T = unknown> = [Context<T>, T];
export interface ReactViewsContext<T> {
    contexts: ContextDefinition<T>[];
}
export interface ExpressRenderOptions {
    [name: string]: unknown;
    settings: Record<string, unknown>;
    _locals: Record<string, unknown>;
    cache: unknown;
    contexts?: ContextDefinition[];
}