moderndash 0.0.16 → 0.0.17

package/README.md

@@ -2,92 +2,33 @@
 
 <p align=center>
   A Typescript-First utility library inspired by Lodash.
-  Optimized for modern browsers.
+  Optimized for modern browsers, typescript & developer experience.
 </p>
 <p align=center>
   ✅ ESM
   ✅ Tree-shakable
   ✅ Typescript Strict Mode (no any types)
   ✅ Zero dependencies
+  ✅ Hoverable Docs
 </p>
 
--------
+<h2 align=center>
+  <a href="https://moderndash.io" target="_blank">
+       📓 Documentation
+  </a>
+</h2>
+
+---
 
 > **Warning**
 > This library is still in development and is not ready for production use.
 
-## Documentation
-The documentation is WIP.
-[Documentation](https://moderndash.io/)
-
-## Removed Functions because of trivial native alternatives
-Look at [You-Dont-Need-Lodash](https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore) for native replacements.
-
-### Array Functions
-- compact
-- concat
-- differenceBy property shorthand
-- drop
-- dropRight
-- fill
-- findIndex
-- findLastIndex
-- first/head
-- flatten
-- flattenDeep
-- flattenDepth
-- fromPairs
-- initial
-- join
-- last
-- lastIndexOf
-- nth
-- without
-- reverse
-- slice
-- sortedIndexOf
-- tail
-- take
-- takeRight
-- without
-
-### Collection Functions
-- each/forEach
-- every
-- filter
-- find
-- flatMap
-- includes
-
-### String Functions
-- lowerCase
-- trim
-- trimEnd
-- trimStart
-- pad
-- padEnd
-- padStart
-
-Functions are not considered trivial if they:
- - include reduce methods
- - include multiple nested function calls
-
-## TODO
-- More unzip tests
-- Check if flatmapdeep, flatmapDepth is included in native flatmap
-- GroupBy Property Shorthand
+## Installation
 
-## Might be added later (open for discussion)
-- pull functions (pull, pullAll, pullAllBy, pullAllWith, pullAt)
-- remove
-- sorted functions (sortedIndex, sortedIndexBy, sortedIndexOf, sortedLastIndex, sortedLastIndexBy, sortedLastIndexOf, sortedUniq, sortedUniqBy)
-  - if performance is better than native alternatives (testing needed)
-- xor functions (xor, xorBy, xorWith)
-- zipObject, zipObjectDeep
-- forEachRight
-- findLast
-- lowerFirst
-- keyBy
+```bash
+npm install moderndash
+```
 
-## Continue at
- - invokeMap
+## Why is X lodash function not included?
+Please check [You-Dont-Need-Lodash](https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore) for native replacements.
+If you still think a function is missing please open an issue.

package/dist/index.cjs

@@ -25,7 +25,7 @@ __export(src_exports, {
   camelCase: () => camelCase,
   capitalize: () => capitalize,
   chunk: () => chunk,
-  countBy: () => countBy,
+  count: () => count,
   debounce: () => debounce,
   deburr: () => deburr,
   difference: () => difference,
@@ -35,7 +35,7 @@ __export(src_exports, {
   dropWhile: () => dropWhile,
   escape: () => escape,
   escapeRegExp: () => escapeRegExp,
-  groupBy: () => groupBy,
+  group: () => group,
   intersection: () => intersection,
   intersectionBy: () => intersectionBy,
   intersectionWith: () => intersectionWith,
@@ -52,9 +52,9 @@ __export(src_exports, {
   sampleSize: () => sampleSize,
   shuffle: () => shuffle,
   snakeCase: () => snakeCase,
-  sortBy: () => sortBy,
+  sort: () => sort,
   startCase: () => startCase,
-  stripSpecialChars: () => stripSpecialChars,
+  stripSpecial: () => stripSpecial,
   takeRightWhile: () => takeRightWhile,
   takeWhile: () => takeWhile,
   throttle: () => throttle,
@@ -85,6 +85,20 @@ function chunk(chunkSize, array) {
   return chunkedArray;
 }
 
+// src/array/count.ts
+function count(array, iteratee) {
+  const result = {};
+  for (const value of array) {
+    const key = iteratee(value);
+    if (result[key] === void 0) {
+      result[key] = 1;
+    } else {
+      result[key] += 1;
+    }
+  }
+  return result;
+}
+
 // src/array/differenceWith.ts
 function differenceWith(comparator, ...arrays) {
   const difference2 = [];
@@ -172,7 +186,7 @@ function differenceBy(iteratee, ...arrays) {
 }
 
 // src/array/dropRightWhile.ts
-function dropRightWhile(predicate, array) {
+function dropRightWhile(array, predicate) {
   let i = array.length;
   while (i > 0 && predicate(array[i - 1])) {
     i--;
@@ -181,11 +195,22 @@ function dropRightWhile(predicate, array) {
 }
 
 // src/array/dropWhile.ts
-function dropWhile(predicate, array) {
+function dropWhile(array, predicate) {
   const index = array.findIndex((x) => !predicate(x));
   return array.slice(index === -1 ? array.length : index);
 }
 
+// src/array/group.ts
+function group(array, iteratee) {
+  const result = {};
+  for (const value of array) {
+    const key = iteratee(value);
+    result[key] = result[key] ?? [];
+    result[key].push(value);
+  }
+  return result;
+}
+
 // src/array/intersectionWith.ts
 function intersectionWith(comparator, ...arrays) {
   const intersection2 = [];
@@ -219,7 +244,7 @@ function sample(array) {
 }
 
 // src/array/sampleSize.ts
-function sampleSize(size, array) {
+function sampleSize(array, size) {
   const sampleArray = [];
   if (array.length === 0 || size <= 0) {
     return sampleArray;
@@ -246,6 +271,21 @@ function shuffle(array) {
   return shuffledArray;
 }
 
+// src/array/sort.ts
+function sort(array, order, iteratee) {
+  return [...array].sort((a, b) => {
+    const aValue = iteratee ? iteratee(a) : a;
+    const bValue = iteratee ? iteratee(b) : b;
+    if (aValue < bValue) {
+      return order === "desc" ? 1 : -1;
+    }
+    if (aValue > bValue) {
+      return order === "desc" ? -1 : 1;
+    }
+    return 0;
+  });
+}
+
 // src/array/takeRightWhile.ts
 function takeRightWhile(predicate, array) {
   const result = [];
@@ -260,7 +300,7 @@ function takeRightWhile(predicate, array) {
 }
 
 // src/array/takeWhile.ts
-function takeWhile(predicate, array) {
+function takeWhile(array, predicate) {
   const result = [];
   for (const element of array) {
     if (predicate(element)) {
@@ -273,7 +313,7 @@ function takeWhile(predicate, array) {
 }
 
 // src/array/uniqWith.ts
-function uniqWith(comparator, array) {
+function uniqWith(array, comparator) {
   return array.filter((value, index, self) => {
     return self.findIndex((otherValue) => comparator(value, otherValue)) === index;
   });
@@ -281,17 +321,17 @@ function uniqWith(comparator, array) {
 
 // src/array/uniq.ts
 function uniq(array) {
-  return uniqWith(isEqual, array);
+  return uniqWith(array, isEqual);
 }
 
 // src/array/uniqBy.ts
-function uniqBy(iteratee, array) {
+function uniqBy(array, iteratee) {
   const iterateeFunction = getIterateFunction(iteratee);
-  return uniqWith((a, b) => iterateeFunction(a) === iterateeFunction(b), array);
+  return uniqWith(array, (a, b) => iterateeFunction(a) === iterateeFunction(b));
 }
 
 // src/array/unzipWith.ts
-function unzipWith(iteratee, array) {
+function unzipWith(array, iteratee) {
   const result = [];
   for (const elements of array) {
     result.push(iteratee(...elements));
@@ -301,7 +341,7 @@ function unzipWith(iteratee, array) {
 
 // src/array/unzip.ts
 function unzip(array) {
-  return unzipWith((...t) => t, array);
+  return unzipWith(array, (...t) => t);
 }
 
 // src/array/zipWith.ts
@@ -319,71 +359,24 @@ function zip(...arrays) {
   return zipWith((...t) => t, ...arrays);
 }
 
-// src/helpers/collections.ts
-function getValuesFromCollection(collection) {
-  return Array.isArray(collection) ? collection : Object.values(collection);
-}
-
-// src/collection/countBy.ts
-function countBy(collection, iteratee) {
-  const result = {};
-  const values = getValuesFromCollection(collection);
-  for (const value of values) {
-    const key = iteratee(value);
-    if (result[key] === void 0) {
-      result[key] = 1;
-    } else {
-      result[key] += 1;
-    }
-  }
-  return result;
-}
-
-// src/collection/groupBy.ts
-function groupBy(collection, iteratee) {
-  const result = {};
-  const values = getValuesFromCollection(collection);
-  for (const value of values) {
-    const key = iteratee(value);
-    result[key] = result[key] ?? [];
-    result[key].push(value);
-  }
-  return result;
-}
-
-// src/collection/sortBy.ts
-function sortBy(iteratee, array) {
-  return array.sort((a, b) => {
-    const aValue = iteratee(a);
-    const bValue = iteratee(b);
-    if (aValue < bValue) {
-      return -1;
-    }
-    if (aValue > bValue) {
-      return 1;
-    }
-    return 0;
-  });
-}
-
 // src/function/after.ts
 function after(n, func) {
-  let count = 1;
+  let count2 = 1;
   return (...args) => {
-    if (count >= n) {
+    if (count2 >= n) {
       return func(...args);
     }
-    count += 1;
+    count2 += 1;
   };
 }
 
 // src/function/before.ts
 function before(n, func) {
-  let count = 0;
+  let count2 = 0;
   let result;
   return (...args) => {
-    if (count < n) {
-      count += 1;
+    if (count2 < n) {
+      count2 += 1;
       result = func(...args);
     }
     return result;
@@ -641,8 +634,8 @@ function startCase(str) {
   return startCase2.trimEnd();
 }
 
-// src/string/stripSpecialChars.ts
-function stripSpecialChars(str) {
+// src/string/stripSpecial.ts
+function stripSpecial(str) {
   str = deburr(str);
   return str.replace(/[^\s\w]/gi, "");
 }
@@ -665,7 +658,7 @@ function unescape(str) {
   camelCase,
   capitalize,
   chunk,
-  countBy,
+  count,
   debounce,
   deburr,
   difference,
@@ -675,7 +668,7 @@ function unescape(str) {
   dropWhile,
   escape,
   escapeRegExp,
-  groupBy,
+  group,
   intersection,
   intersectionBy,
   intersectionWith,
@@ -692,9 +685,9 @@ function unescape(str) {
   sampleSize,
   shuffle,
   snakeCase,
-  sortBy,
+  sort,
   startCase,
-  stripSpecialChars,
+  stripSpecial,
   takeRightWhile,
   takeWhile,
   throttle,