@667/restify/lib/plugins/chainableStatus.js

REST framework

/**
 * MIT License
 *
 * Copyright (c) 2020 June07
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

'use strict';

/**
 * Makes the res.status() function chainable by returning the res object as in Express.js.
 * The original Restify status function is still made available at res.statusRestify().
 * This plugin is helpful in cases where Restify is interfacing with Express.js and/or other
 * similar middleware code such as:
 *
 * middleware(req, res, next) {
 *     res.status(200).send('ok');
 * }
 *
 * and where interfacing code changes are not possible.
 *
 * @public
 * @function chainableStatus
 * @returns  {Function} Handler
 * @example
 * let server = restify.createServer();
 * server.use(restify.plugins.chainableStatus());
 */

function chainableStatus() {
    function status(req, res, next) {
        res.statusRestify = res.status;
        function wrapper(code) {
            res.statusRestify(code);
            return res;
        }
        res.status = wrapper;
        next();
    }

    return status;
}

module.exports = chainableStatus;