📝 Update documentation

geoblink · Jul 24, 2019 · 32ab7e1 · 32ab7e1
1 parent 72835a8
commit 32ab7e1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/docs/global.html b/docs/global.html
@@ -1209,7 +1209,7 @@ <h4 class="name" id="mergeForEach">
 Can be used to implement efficient algorithms which profit from sorted data
 like `mergeSort` or `mergeJoinWith`.
 
-Both collections must be sortable. They will be sorted ascendently using
+Both collections must be sortable. They will be sorted ascendantly using
 value returned by the corresponding iteratee.
   </div>
 

diff --git a/docs/mergeForEach.ts.html b/docs/mergeForEach.ts.html
@@ -104,7 +104,7 @@ <h1 class="page-title">
  * Can be used to implement efficient algorithms which profit from sorted data
  * like `mergeSort` or `mergeJoinWith`.
  *
- * Both collections must be sortable. They will be sorted ascendently using
+ * Both collections must be sortable. They will be sorted ascendantly using
  * value returned by the corresponding iteratee.
  *
  * @param lhs A collection of elements.
@@ -151,13 +151,11 @@ <h1 class="page-title">
       const lhsValue = getLHSValue(lhsItem) as any
       const rhsValue = getRHSValue(rhsItem) as any
 
-      if (lhsValue &lt; rhsValue) {
-        return SORTING_ORDER.LHS_BEFORE_RHS
-      } else if (lhsValue > rhsValue) {
-        return SORTING_ORDER.LHS_AFTER_RHS
-      } else {
-        return SORTING_ORDER.EQUAL
-      }
+      if (lhsValue === rhsValue) return SORTING_ORDER.EQUAL
+      if (lhsValue &lt; rhsValue) return SORTING_ORDER.LHS_BEFORE_RHS
+      if (lhsValue > rhsValue) return SORTING_ORDER.LHS_AFTER_RHS
+
+      throw new Error(`[@geoblink/lodash-mixins#mergeForEach] Found non-comparable values: ${lhsValue} on LHS and ${rhsValue} on RHS`)
     }
   }: {
     lhsIteratee?: LHSItemKey | ((item: LHSItem) => any),
@@ -227,7 +225,7 @@ <h1 class="page-title">
      * Can be used to implement efficient algorithms which profit from sorted
      * data like `mergeSort` or `mergeJoinWith`.
      *
-     * Both collections must be sortable. They will be sorted ascendently using
+     * Both collections must be sortable. They will be sorted ascendantly using
      * value returned by the corresponding iteratee.
      *
      * @param lhs A collection of elements.