More JSDoc

Author: emmenko

src/utils/createReduxShape.js

@@ -1,3 +1,9 @@
+/**
+ * Define the shape of the `redux` prop, used for props validation.
+ *
+ * @param  {Object} PropTypes
+ * @return {Object}
+ */
 export default function createReduxShape(PropTypes) {
   return PropTypes.shape({
     subscribe: PropTypes.func.isRequired,

src/utils/identity.js

@@ -1,3 +1,9 @@
+/**
+ * Returns the first argument provided to it.
+ *
+ * @param  {*} value
+ * @return {*}
+ */
 export default function identity(value) {
   return value;
 }

src/utils/isPlainObject.js

@@ -1,3 +1,11 @@
+/**
+ * Given an object, checks that it's a plain object. That is, an object
+ * created by the `Object` constructor or one with a `Prototype` of `null`.
+ *
+ * @param  {*} obj - the value to check
+ * @return {Boolean} `true` if it's a plain object, else `false`
+ */
 export default function isPlainObject(obj) {
-  return obj ? typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype : false;
+  return obj ? typeof obj === 'object'
+    && Object.getPrototypeOf(obj) === Object.prototype : false;
 }

src/utils/mapValues.js

@@ -1,3 +1,12 @@
+/**
+ * Given an object, returns a new object with the same keys
+ * and values generated by running each own enumerable property
+ * of the object through an `iteratee` function.
+ *
+ * @param  {Object} obj
+ * @param  {Function} fn - invoked to map the new value
+ * @return {Object}
+ */
 export default function mapValues(obj, fn) {
   return Object.keys(obj).reduce((result, key) => {
     result[key] = fn(obj[key], key);

src/utils/pick.js

@@ -1,3 +1,12 @@
+/**
+ * Given an object, returns a new object with the same keys
+ * and values filtered by the result of the `iteratee` function.
+ *
+ * @param  {Object} obj
+ * @param  {Function} fn - invoked to determine whether to discard
+ * the property or not
+ * @return {Object}
+ */
 export default function pick(obj, fn) {
   return Object.keys(obj).reduce((result, key) => {
     if (fn(obj[key])) {