moderndash 0.0.12 → 0.0.14

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Maximilian Dewald
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+![ModernDash Logo](/website/src/assets/moderndashLogo.svg)
+
+<p align=center>
+  A Typescript-First utility library inspired by Lodash.
+  Optimized for modern browsers.
+</p>
+<p align=center>
+  ✅ ESM
+  ✅ Tree-shakable
+  ✅ Typescript Strict Mode (no any types)
+  ✅ Zero dependencies
+</p>
+
+-------
+
+> **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
+
+## 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
+
+## Continue at
+ - invokeMap

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "moderndash",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "type": "module",
   "description": "A lodash inspired utility framework for ESM/Typescript/ES2020",
   "scripts": {

package/src/array/intersectionBy.ts

@@ -11,13 +11,13 @@ import { isEqualWith } from '@lang/isEqualWith';
  * determined by the first array. The iteratee is invoked with one argument:
  * (value).
  *
+ * @example
+ * intersectionBy(Math.floor, [2.1, 1.2], [2.3, 3.4])
+ * // => [2.1]
  * @category Array
  * @param iteratee - The iteratee invoked per element. Or property shorthand.
  * @param arrays - The arrays to inspect.
  * @returns Returns the new array of intersecting values.
- * @example
- * intersectionBy(Math.floor, [2.1, 1.2], [2.3, 3.4])
- * // => [2.1]
  */
 
 export function intersectionBy<TInput>(iteratee: IterateeFunction<TInput> | PropertyShorthand<TInput>, ...arrays: MinimumTwoArrays<TInput>): TInput[] {

package/src/array/intersectionWith.ts

@@ -6,16 +6,16 @@ import type { MinimumTwoArrays } from '../types';
  * of result values are determined by the first array. The comparator is
  * invoked with two arguments: (arrVal, othVal).
  *
- * @category Array
- * @param comparator - The comparator invoked per element.
- * @param arrays - The arrays to inspect.
- * @returns Returns the new array of intersecting values.
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]
  * const others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }]
  *
  * intersectionWith(isEqual, objects, others)
  * // => [{ 'x': 1, 'y': 2 }]
+ * @category Array
+ * @param comparator - The comparator invoked per element.
+ * @param arrays - The arrays to inspect.
+ * @returns Returns the new array of intersecting values.
  */
 
 export function intersectionWith<T>(comparator: (a: T, b: T) => boolean, ...arrays: MinimumTwoArrays<T>): T[] {

package/src/function/times.ts

@@ -0,0 +1,24 @@
+/**
+ * Invokes the iteratee `n` times, returning an array of the results of
+ * each invocation. The function is invoked with one argument: (index).
+ *
+ * @example
+ * times(3, index => console.log("Run", index)))
+ * // => "Run 0" | "Run 1" | "Run 2"
+ * times(3, Math.random)
+ * // => [0.123, 0.456, 0.789]
+ * times(4, () => 0)
+ * // => [0, 0, 0, 0]
+ * @category Function
+ * @param n - The number of times to invoke `func`.
+ * @param iteratee - The function invoked per iteration.
+ * @returns Returns the array of results.
+ */
+
+export function times<T>(n: number, func: (index: number) => T): T[] {
+    const result: T[] = [];
+    for (let i = 0; i < n; i++) {
+        result.push(func(i));
+    }
+    return result;
+}