moderndash 0.0.10 → 0.0.12

package/src/string/unescape.ts

@@ -1,4 +1,16 @@
-export function unescapeHTML(html: string): string {
+/**
+ * Converts the HTML entities `&`, `<`, `>`, `"` and `'`
+ * in a string to their corresponding characters.
+ *
+ * @example
+ * unescape('fred, barney, & pebbles')
+ * // => 'fred, barney, & pebbles'
+ * @category String
+ * @param str - The string to unescape.
+ * @returns Returns the unescaped string.
+ */
+
+export function unescape(str: string): string {
     const entityMap: Record<string, string> = {
         '&amp;': '&',
         '&lt;': '<',
@@ -6,5 +18,5 @@ export function unescapeHTML(html: string): string {
         '&quot;': '"',
         '&#39;': '\''
     };
-    return html.replace(/&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g, (entity: string) => entityMap[entity] || entity);
+    return str.replace(/&(?:amp|lt|gt|quot|#(0+)?39);/g, (entity: string) => entityMap[entity] || entity);
 }

package/src/types.ts

@@ -1,9 +1,15 @@
-export type MinimumTwoArrays<T> = [T[], T[], ...T[][]];
+export type MinimumTwoArrays<TInput> = [TInput[], TInput[], ...TInput[][]];
 
 export type IterateeFunction<T> = (value: T) => unknown;
 export type PropertyShorthand<T> = keyof T;
 
 export type RecordKey = string | number | symbol;
+export type ArrayOrRecord<TInput> = TInput[] | Record<RecordKey, TInput>;
 
-export type ArrayOrRecord<T> = T[] | Record<RecordKey, T>;
-export type NoUnion<T, U = T> = T extends U ? [U] extends [T] ? T : never : never; 
+export type NoUnion<T, U = T> = T extends U ? [U] extends [T] ? T : never : never;
+
+/**
+ * @description Generic function type, should fit any function
+ * @typeParam TFunc - The input function type
+ */
+export type GenericFunction<TFunc extends (...args: Parameters<TFunc>) => ReturnType<TFunc>> = (...args: Parameters<TFunc>) => ReturnType<TFunc>;

package/LICENSE

@@ -1,21 +0,0 @@
-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

@@ -1,92 +0,0 @@
-![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.
-
-## 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