@types/koa-favicon NPM

Installation

npm install --save @types/koa-favicon

Summary

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

Details

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

index.d.ts

// Type definitions for koa-favicon v2.x
// Project: https://github.com/koajs/favicon
// Definitions by: Jerry Chin <https://github.com/hellopao>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

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

    import favicon = require("koa-favicon");
    var Koa = require('koa');

    var app = new Koa();
    app.use(favicon(__dirname + '/public/favicon.ico'));

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


import * as Koa from "koa";

/**
 * Returns a middleware serving the favicon found on the given path.
 */
declare function favicon(path: string, options?: {

    /**
     * cache-control max-age directive in ms, defaulting to 1 day.
     */
    maxage?: number | undefined;

}): Koa.Middleware;

declare namespace favicon {}
export = favicon;