import { create } from "express-handlebars";
import { SentMessageInfo, Transporter } from "nodemailer";
import Mail = require("nodemailer/lib/mailer");

declare function hbs(options: hbs.NodemailerExpressHandlebarsOptions): Mail.PluginFunction;

declare namespace hbs {
    type Exphbs = ReturnType<typeof create>;

    type ExphbsOptions = Parameters<typeof create>[0];

    interface TemplateOptions {
        template?: string | undefined;
        context?: any;
    }

    type HbsTransporter = Transporter & {
        sendMail(
            mailOptions: Mail.Options & TemplateOptions,
            callback: (err: Error | null, info: SentMessageInfo) => void,
        ): void;
        sendMail(mailOptions: Mail.Options & TemplateOptions): Promise<SentMessageInfo>;
    };

    interface NodemailerExpressHandlebarsOptions {
        viewEngine: Exphbs | ExphbsOptions;
        viewPath: string;
        extName?: string | undefined;
    }

    export { HbsTransporter, NodemailerExpressHandlebarsOptions, TemplateOptions };
}

export = hbs;

Additional Details

Last updated: Fri, 24 Oct 2025 0441 GMT
Dependencies: @types/express-handlebars, @types/nodemailer

Credits

These definitions were written by Gabriel de Oliveira.