@types/koa-hbs

Installation

npm install --save @types/koa-hbs

Summary

This package contains type definitions for koa-hbs (https://github.com/gilt/koa-hbs).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-hbs.

index.d.ts

// Type definitions for koa-hbs v1.x
// Project: https://github.com/gilt/koa-hbs
// Definitions by: Jacob Malone <https://github.com/jcbmln>, Mudkip <https://github.com/mudkipme>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

/* =================== USAGE ===================

    import * as Koa from "koa";
....import hbs = require("koa-hbs");

    var app = new Koa();

    app.use(hbs.middleware({
        viewPath: __dirname + '/views'
    }));

    app.use(async (ctx, next) => {
        await ctx.render('main', {
            title: 'koa-hbs'
        });
    });

 =============================================== */

/// <reference types="koa" />

import * as Koa from "koa";
import * as Handlebars from "handlebars";

declare namespace Hbs {
    export interface Middleware {
        viewPath: Array<string> | string,
        handlebars?: Function | undefined,
        templateOptions?: {} | undefined,
        extname?: string | undefined,
        partialsPath?: Array<string> | string | undefined,
        defaultLayout?: string | undefined,
        layoutsPath?: string | undefined,
        contentHelperName?: string | undefined,
        blockHelperName?: string | undefined,
        disableCache?: boolean | undefined
    }
}

declare class Hbs {
    constructor();
    middleware(opts: Hbs.Middleware): any;
    registerHelper: typeof Handlebars.registerHelper;
    SafeString: typeof Handlebars.SafeString;
    Utils: typeof Handlebars.Utils;
}

declare const hbs: Hbs;
export = hbs;

declare module "koa" {
    export interface Context {
        render(tpl: string, locals?: {[key: string]: any}): Promise<void>;
    }
}

Additional Details

• Last updated: Thu, 08 Jul 2021 16:23:21 GMT
• Dependencies: @types/koa, @types/handlebars
• Global values: none

Credits

These definitions were written by Jacob Malone, and Mudkip.