carbon-react/lib/utils/helpers/should-component-update/should-component-update.js

A library of reusable React components and an interface for easily building user interfaces based on Flux.

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

exports.default = function (scope, nextProps, nextState) {
  return !(0, _lodash.isEqualWith)(scope.props, nextProps, customCheck) || !(0, _lodash.isEqualWith)(scope.state, nextState, customCheck);
};

var _immutable = require('immutable');

var _immutable2 = _interopRequireDefault(_immutable);

var _lodash = require('lodash');

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/**
 * Performs a custom check of parameters from the isEqual method.
 *
 * @method customCheck
 * @param current - could be any type
 * @param next - could be any type
 * @param {String} key
 * @private
 */
function customCheck(current, next, key) {
  if (key == "validations") {
    // validations are new objects each time - and only need to update the component
    // when the value changes so we can safely skip them.
    return true;
  }

  // if immutable object, do custom comparison. otherwise return undefined to
  // allow isEqual to continue as normal
  if (_immutable2.default.Iterable.isIterable(current)) {
    return _immutable2.default.is(current, next);
  } else {
    return void 0;
  }
}

/**
 * A shouldComponentUpdate helper. Run this method with your instance, nextProps and nextState
 * and it will perform a deep comparison of the properties - handling immutable objects.
 *
 * @method
 * @param {Object} scope
 * @param {Object} nextProps
 * @param {Object} nextState
 * @return {Boolean}
 */