moderndash 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +92 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,92 @@
1
+ ![ModernDash Logo](/website/src/assets/moderndashLogo.svg)
2
+
3
+ <p align=center>
4
+ A Typescript-First utility library inspired by Lodash.
5
+ Optimized for modern browsers.
6
+ </p>
7
+ <p align=center>
8
+ ✅ ESM
9
+ ✅ Tree-shakable
10
+ ✅ Typescript Strict Mode (no any types)
11
+ ✅ Zero dependencies
12
+ </p>
13
+
14
+ -------
15
+
16
+ > **Warning**
17
+ > This library is still in development and is not ready for production use.
18
+
19
+ ## Documentation
20
+ The documentation is WIP.
21
+
22
+ ## Removed Functions because of trivial native alternatives
23
+ Look at [You-Dont-Need-Lodash](https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore) for native replacements.
24
+
25
+ ### Array Functions
26
+ - compact
27
+ - concat
28
+ - differenceBy property shorthand
29
+ - drop
30
+ - dropRight
31
+ - fill
32
+ - findIndex
33
+ - findLastIndex
34
+ - first/head
35
+ - flatten
36
+ - flattenDeep
37
+ - flattenDepth
38
+ - fromPairs
39
+ - initial
40
+ - join
41
+ - last
42
+ - lastIndexOf
43
+ - nth
44
+ - without
45
+ - reverse
46
+ - slice
47
+ - sortedIndexOf
48
+ - tail
49
+ - take
50
+ - takeRight
51
+ - without
52
+
53
+ ### Collection Functions
54
+ - each/forEach
55
+ - every
56
+ - filter
57
+ - find
58
+ - flatMap
59
+ - includes
60
+
61
+ ### String Functions
62
+ - lowerCase
63
+ - trim
64
+ - trimEnd
65
+ - trimStart
66
+ - pad
67
+ - padEnd
68
+ - padStart
69
+
70
+ Functions are not considered trivial if they:
71
+ - include reduce methods
72
+ - include multiple nested function calls
73
+
74
+ ## TODO
75
+ - More unzip tests
76
+ - Check if flatmapdeep, flatmapDepth is included in native flatmap
77
+ - GroupBy Property Shorthand
78
+
79
+ ## Might be added later (open for discussion)
80
+ - pull functions (pull, pullAll, pullAllBy, pullAllWith, pullAt)
81
+ - remove
82
+ - sorted functions (sortedIndex, sortedIndexBy, sortedIndexOf, sortedLastIndex, sortedLastIndexBy, sortedLastIndexOf, sortedUniq, sortedUniqBy)
83
+ - if performance is better than native alternatives (testing needed)
84
+ - xor functions (xor, xorBy, xorWith)
85
+ - zipObject, zipObjectDeep
86
+ - forEachRight
87
+ - findLast
88
+ - lowerFirst
89
+ - keyBy
90
+
91
+ ## Continue at
92
+ - invokeMap
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "moderndash",
3
- "version": "0.0.6",
3
+ "version": "0.0.7",
4
4
  "type": "module",
5
5
  "description": "A lodash inspired utility framework for ESM/Typescript/ES2020",
6
6
  "scripts": {
7
7
  "build": "ctix create ----startAt src --overwrite --noBackup & tsup",
8
- "prepublishOnly": "npm run build && @powershell cp '../README.md' './dist/README.md'",
8
+ "prepublishOnly": "npm run build && @powershell cp '../README.md' './README.md'",
9
9
  "test": "vitest",
10
10
  "test-ui": "vitest --ui"
11
11
  },