Source: common/arrays.js

  1. 'use strict';
  2. /**
  3.  * @module lib/common/arrays
  4.  * @summary Whiteflag API common array functions module
  5.  * @description Module with synchronous array functions making life easier
  6.  * @tutorial modules
  7.  */
  8. module.exports = {
  9.     // Array functions
  10.     addItem,
  11.     addArray,
  12.     pluck,
  13.     plucksub
  14. };
  16. // MAIN MODULE FUNCTIONS //
  17. /**
  18.  * Adds item to array
  19.  * @function addItem
  20.  * @alias module:lib/common/arrays.addItem
  21.  * @param {Array} array
  22.  * @param {*} item
  23.  * @returns {Array}
  24.  */
  25. function addItem(array, item) {
  26.     if (Array.isArray(array)) {
  27.         array.push(item);
  28.         return array;
  29.     }
  30.     return [ item ];
  31. }
  33. /**
  34.  * Adds array 2 to the end of array 1
  35.  * @function addArray
  36.  * @alias module:lib/common/arrays.addArray
  37.  * @param {Array} array1
  38.  * @param {Array} array2
  39.  * @returns {Array}
  40.  */
  41. function addArray(array1, array2) {
  42.     if (Array.isArray(array1)) {
  43.         if (Array.isArray(array2)) return array1.concat(array2);
  44.         return array1;
  45.     }
  46.     if (Array.isArray(array2)) return array2;
  47.     return [];
  48. }
  50. /**
  51.  * Gets single property from array of objects
  52.  * @function pluck
  53.  * @alias module:lib/common/arrays.pluck
  54.  * @param {Array} array array of objects
  55.  * @param {string} key object property name
  56.  * @returns {Array}
  57.  */
  58. function pluck(array, key) {
  59.     return array.map(object => {
  60.         return object[key];
  61.     });
  62. }
  64. /**
  65.  * Gets single subobject property from array of objects
  66.  * @function plucksub
  67.  * @alias module:lib/common/arrays.plucksub
  68.  * @param {Array} array array of objects
  69.  * @param {string} key object property name
  70.  * @param {string} subkey object property name
  71.  * @returns {Array}
  72.  */
  73. function plucksub(array, key, subkey) {
  74.     return array.map(object => {
  75.         return object[key][subkey];
  76.     });
  77. }