DefinitelyTyped/types/express-flash-2/index.d.ts

// Type definitions for express-flash-2 1.0
// Project: https://github.com/jack2gs/express-flash-2
// Definitions by: Matheus Salmi <https://github.com/mathsalmi>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

import express = require('express');

/**
 * Expose `flash()` function on responses.
 */
declare function flash(): express.RequestHandler;

export = flash;

declare global {
    namespace Express {
        interface Request {
            session?: Session;
        }

        interface Session {
            flash: Flash;
        }

        interface Flash {
            [key: string]: any[];
        }

        interface Response {
            /**
             * Queue flash `msg` of the given `type`.
             *
             * Examples:
             *
             *      req.flash('info', 'email sent');
             *      req.flash('error', 'email delivery failed');
             *      req.flash('info', 'email re-sent');
             *
             *
             * Formatting:
             *
             * Flash notifications also support arbitrary formatting support.
             * For example you may pass variable arguments to `req.flash()`
             * and use the %s specifier to be replaced by the associated argument:
             *
             *     req.flash('info', 'email has been sent to %s.', userName);
             *
             * Formatting uses `util.format()`, which is available on Node 0.6+.
             */
            flash(type: string, msg: string | any[]): void;

            locals: {
                flash: Flash
            };
        }
    }
}