Issue #69 Consider removing peer dependency usage directly in exported objects

Port lodash methods to private functions. Issue #69

Author: brandongregoryscott

src/utilities/collection-utils.ts

@@ -1,5 +1,12 @@
 import * as Immutable from "immutable";
 import _ from "lodash";
+import {
+    Comparator2,
+    Dictionary,
+    List,
+    ListOfRecursiveArraysOrValues,
+    NumericDictionary
+} from "lodash";
 
 // -----------------------------------------------------------------------------------------
 // #region Private Methods
@@ -16,7 +23,7 @@ import _ from "lodash";
  * @returns true if both arrays contain all the same elements of the other,
  *          not considering order, false otherwise.
  */
-const _equalsBy = function<T, V>(
+const equalsBy = function<T, V>(
     selector: (element: T) => V,
     array1: Array<T> | Immutable.List<any> | undefined,
     array2: Array<T> | Immutable.List<any> | undefined
@@ -29,7 +36,7 @@ const _equalsBy = function<T, V>(
         return false;
     }
 
-    if (_length(array1) !== _length(array2)) {
+    if (length(array1) !== length(array2)) {
         return false;
     }
 
@@ -52,9 +59,9 @@ const _equalsBy = function<T, V>(
  * @param values The arrays of values to exclude.
  * @return Returns the new array of filtered values.
  */
-const _difference = <T>(
-    array: Array<T> | null | undefined,
-    ...values: Array<Array<T>>
+const difference = <T>(
+    array: List<T> | null | undefined,
+    ...values: Array<List<T>>
 ): T[] => _.difference(array, ...values);
 
 /**
@@ -63,7 +70,7 @@ const _difference = <T>(
  * @param array The array to recursively flatten.
  * @return Returns the new flattened array.
  */
-const _flattenDeep = <T>(array: Array<T> | null | undefined): T[] =>
+const flattenDeep = <T>(array: ListOfRecursiveArraysOrValues<T> | null | undefined): T[] =>
     _.flattenDeep(array);
 
 /**
@@ -77,13 +84,13 @@ const _flattenDeep = <T>(array: Array<T> | null | undefined): T[] =>
  * @returns {boolean} False if `collections` is null/undefined, or every element is also null/undefined,
  * or has no sub-elements. True if any element has sub-elements.
  */
-const _hasValues = (
+const hasValues = (
     ...collections: Array<any[] | Immutable.List<any> | undefined>
 ): boolean => {
     let hasValues = false;
     collections.forEach(
         (collection: any[] | Immutable.List<any> | undefined) => {
-            if (!_isEmpty(collection)) {
+            if (!isEmpty(collection)) {
                 hasValues = true;
             }
         }
@@ -102,7 +109,7 @@ const _hasValues = (
  * @returns {boolean} True if `collections` is null/undefined, or every element is also null/undefined,
  * or has no sub-elements. False if any element has sub-elements.
  */
-const _isEmpty = (
+const isEmpty = (
     ...collections: Array<any[] | Immutable.List<any> | undefined>
 ): boolean => {
     let isEmpty = true;
@@ -140,10 +147,10 @@ const _isEmpty = (
  * @returns {boolean} False if `collections` is null/undefined, or every element is also null/undefined,
  * or has no sub-elements. True if any element has sub-elements.
  */
-const _isNotEmpty = (
+const isNotEmpty = (
     ...collections: Array<any[] | Immutable.List<any> | undefined>
 ): boolean => {
-    return !_isEmpty(...collections);
+    return !isEmpty(...collections);
 };
 
 /**
@@ -152,7 +159,7 @@ const _isNotEmpty = (
  * @param arr the collection
  * @returns number the length of the collection
  */
-const _length = (arr: Array<any> | Immutable.List<any>): number => {
+const length = (arr: Array<any> | Immutable.List<any>): number => {
     if (arr == null) {
         return -1;
     }
@@ -172,7 +179,7 @@ const _length = (arr: Array<any> | Immutable.List<any>): number => {
  * @param array The array to query.
  * @return Returns the first element of array.
  */
-const _head = <T>(array: Array<T> | null | undefined): T | undefined =>
+const first = <T>(array: List<T> | null | undefined): T | undefined =>
     _.head(array);
 
 /**
@@ -182,7 +189,7 @@ const _head = <T>(array: Array<T> | null | undefined): T | undefined =>
  * @param arrays The arrays to inspect.
  * @return Returns the new array of shared values.
  */
-const _intersection = <T>(...arrays: Array<Array<T>>) =>
+const intersection = <T>(...arrays: Array<List<T>>) =>
     _.intersection(...arrays);
 
 /**
@@ -203,18 +210,18 @@ const _intersection = <T>(...arrays: Array<Array<T>>) =>
  * _.intersectionWith(objects, others, _.isEqual);
  * => [{ 'x': 1, 'y': 2 }]
  */
-const _intersectionWith = <T1, T2>(
-    array: Array<T1>,
-    values: Array<T2>,
-    comparator: (a: T1, b: T2) => boolean
+const intersectionWith = <T1, T2>(
+    array: List<T1>,
+    values: List<T2>,
+    comparator: Comparator2<T1, T2>
 ): T1[] => _.intersectionWith(array, values, comparator);
 
 /**
  * Removes a supplied element by index
  * @param source original array
  * @param index array index to remove
  */
-const _removeElementAt = <T>(source: Array<T>, index: number): Array<T> => {
+const removeElementAt = <T>(source: Array<T>, index: number): Array<T> => {
     if (index < 0 || index > source.length) {
         return source;
     }
@@ -234,7 +241,7 @@ const _removeElementAt = <T>(source: Array<T>, index: number): Array<T> => {
  * @param index
  * @param value
  */
-const _replaceElementAt = <T>(
+const replaceElementAt = <T>(
     source: Array<T>,
     index: number,
     value: T
@@ -259,7 +266,7 @@ const _replaceElementAt = <T>(
  * @param collection The collection to sample.
  * @return Returns the random element.
  */
-const _sample = <T>(collection: Array<T> | null | undefined): T | undefined =>
+const sample = <T>(collection: List<T> | Dictionary<T> | NumericDictionary<T> | null | undefined): T | undefined =>
     _.sample(collection);
 
 /**
@@ -269,8 +276,8 @@ const _sample = <T>(collection: Array<T> | null | undefined): T | undefined =>
  * @param n The number of elements to sample.
  * @return Returns the random elements.
  */
-const _sampleSize = <T>(
-    collection: Array<T> | null | undefined,
+const sampleSize = <T>(
+    collection: List<T> | Dictionary<T> | NumericDictionary<T> | null | undefined,
     n?: number
 ): T[] => _.sampleSize(collection, n);
 
@@ -280,7 +287,7 @@ const _sampleSize = <T>(
  * @param selector function returning property to sort by from item
  * @param caseSensitive whether to consider letter case when sorting
  */
-const _sortByString = <T extends any>(
+const sortByString = <T extends any>(
     array: Array<T>,
     selector: (element: T) => string,
     caseSensitive: boolean = false
@@ -320,7 +327,7 @@ const _sortByString = <T extends any>(
  * @param n The number of elements to take.
  * @return Returns the slice of array.
  */
-const _take = <T>(array: Array<T> | null | undefined, n?: number): T[] =>
+const take = <T>(array: List<T> | null | undefined, n?: number): T[] =>
     _.take(array, n);
 
 // #endregion Private Methods
@@ -330,22 +337,22 @@ const _take = <T>(array: Array<T> | null | undefined, n?: number): T[] =>
 // -----------------------------------------------------------------------------------------
 
 export const CollectionUtils = {
-    difference: _difference,
-    equalsBy: _equalsBy,
-    first: _head,
-    flattenDeep: _flattenDeep,
-    hasValues: _hasValues,
-    isEmpty: _isEmpty,
-    isNotEmpty: _isNotEmpty,
-    intersection: _intersection,
-    intersectionWith: _intersectionWith,
-    length: _length,
-    removeElementAt: _removeElementAt,
-    replaceElementAt: _replaceElementAt,
-    sample: _sample,
-    sampleSize: _sampleSize,
-    sortByString: _sortByString,
-    take: _take,
+    difference,
+    equalsBy,
+    first,
+    flattenDeep,
+    hasValues,
+    isEmpty,
+    isNotEmpty,
+    intersection,
+    intersectionWith,
+    length,
+    removeElementAt,
+    replaceElementAt,
+    sample,
+    sampleSize,
+    sortByString,
+    take,
 };
 
 // #endregion Exports