sails/lib/hooks/responses/defaults/ok.js

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

/**
 * Module dependencies
 */

var util = require('util');
var _ = require('@sailshq/lodash');



/**
 * 200 (OK) Response
 *
 * Usage:
 * return res.ok();
 * return res.ok(data);
 *
 * @param  {JSON?} data
 * @param  {Ref?} noLongerSupported
 */

module.exports = function sendOK (data, noLongerSupported) {

  // Get access to `req` and `res`
  var req = this.req;
  var res = this.res;

  // Get access to `sails`
  var sails = req._sails;

  // If a second argument was given, log a message.
  if (noLongerSupported) {
    sails.log.debug('The second argument to `res.ok()` is deprecated.');
    sails.log.debug('To serve a view via `res.ok()`, override the response');
    sails.log.debug('in \'api/responses/ok.js\'.\n');
  }

  // Set status code
  res.status(200);

  // If no data was provided, use res.sendStatus().
  if (_.isUndefined(data)) {
    return res.sendStatus(200);
  }

  // Extreme edge case (very rare to pass an Error into res.ok() -- but still, just in case)
  // If the data is an Error instance and it doesn't have a custom .toJSON(),
  // then util.inspect() it instead (otherwise res.json() will turn it into an empty dictionary).
  // > Note that we don't do this in production, since (depending on your Node.js version) inspecting
  // > the Error might reveal the `stack`.  And since `res.ok()` could certainly be used in
  // > production, and it could inadvertently be passed an Error instance, we censor the stack trace
  // > as a simple failsafe.
  if (_.isError(data)) {
    if (!_.isFunction(data.toJSON)) {
      if (process.env.NODE_ENV === 'production') {
        return res.sendStatus(200);
      }
      // No need to JSON stringify (it's already a string).
      return res.send(util.inspect(data));
    }
  }
  return res.json(data);

};