moderndash 0.0.11 → 0.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "moderndash",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "type": "module",
   "description": "A lodash inspired utility framework for ESM/Typescript/ES2020",
   "scripts": {
@@ -40,7 +40,7 @@
     "dist",
     "src"
   ],
-  "homepage": "https://github.com/Maggi64/moderndash#readme",
+  "homepage": "https://moderndash.io",
   "devDependencies": {
     "@vitest/coverage-c8": "0.27.1",
     "@vitest/ui": "0.27.1",

package/src/array/shuffle.ts

@@ -5,7 +5,7 @@
  * @since 0.1.0
  * @category Array
  * @param array - The array or object to shuffle.
- * @returns {Array} Returns the new shuffled array.
+ * @returns Returns the new shuffled array.
  * @example
  * shuffle([1, 2, 3, 4])
  * // => [4, 1, 3, 2]

package/src/array/uniqWith.ts

@@ -5,7 +5,7 @@
  * @category Array
  * @param array - The array to inspect.
  * @param comparator - The comparator invoked per element.
- * @returns {Array} Returns the new duplicate free array.
+ * @returns Returns the new duplicate free array.
  * @example
  * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }]
  *

package/src/collection/countBy.ts

@@ -7,10 +7,6 @@ import { getValuesFromCollection } from '@helpers/collections';
  * each element of `collection` thru `iteratee`. The corresponding value of
  * each key is the number of times the key was returned by `iteratee`.
  *
- * @category Collection
- * @param iteratee - The iteratee to transform keys.
- * @param collection - The array or record to iterate over.
- * @returns Returns the composed aggregate object.
  * @example
  * const users = [
  *   { 'user': 'barney', 'active': true },
@@ -20,6 +16,10 @@ import { getValuesFromCollection } from '@helpers/collections';
  *
  * countBy(users, value => value.active);
  * // => { 'true': 2, 'false': 1 }
+ * @category Collection
+ * @param iteratee - The iteratee to transform keys.
+ * @param collection - The array or record to iterate over.
+ * @returns Returns the composed aggregate object.
  */
 
 export function countBy<TInput, TKey extends RecordKey>(collection: ArrayOrRecord<TInput>, iteratee: (value: TInput) => TKey): Record<TKey, number> {

package/src/collection/groupBy.ts

@@ -10,13 +10,13 @@ import { getValuesFromCollection } from '@helpers/collections';
  * value of each key is an array of elements responsible for generating the
  * key.
  *
+ * @example
+ * groupBy([6.1, 4.2, 6.3], Math.floor)
+ * // => { '4': [4.2], '6': [6.1, 6.3] }
  * @category Collection
  * @param collection - The array or object to iterate over.
  * @param iteratee - The iteratee to transform keys.
  * @returns Returns the composed aggregate object.
- * @example
- * groupBy([6.1, 4.2, 6.3], Math.floor)
- * // => { '4': [4.2], '6': [6.1, 6.3] }
  */
 
 export function groupBy<T, U extends RecordKey>(collection: ArrayOrRecord<T>, iteratee: (value: T) => U): Record<U, T[]> {

package/src/object/pick.ts

@@ -1,16 +1,15 @@
 /**
  * Creates an object composed of the picked `object` properties.
  *
- * @category Object
- * @param object The source object.
- * @param keys The property paths to pick.
- * @returns {Object} Returns the new object.
  * @example
- *
  * const object = { 'a': 1, 'b': '2', 'c': 3 }
  *
  * pick(object, ['a', 'c'])
  * // => { 'a': 1, 'c': 3 }
+ * @category Object
+ * @param object - The source object.
+ * @param keys - The property paths to pick.
+ * @returns Returns the new object.
  */
 
 export function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K> {

package/src/string/camelCase.ts

@@ -1,5 +1,20 @@
 import { splitWords } from '@helpers/stringModifiers';
 
+/**
+ * Converts `string` to camelCase.
+ *
+ * @example
+ * camelCase('Foo Bar')
+ * // => 'fooBar'
+ * camelCase('--foo-bar--')
+ * // => 'fooBar'
+ * camelCase('__FOO_BAR__')
+ * // => 'fooBar'
+ * @category String
+ * @param str - The string to convert.
+ * @returns Returns the camel cased string.
+ */
+
 export function camelCase(str: string): string {
     const words = splitWords(str);
 

package/src/string/capitalize.ts

@@ -1,3 +1,14 @@
+/**
+ * Converts the first character of a string to upper case and the remaining to lower case.
+ *
+ * @example
+ * capitalize('FRED')
+ * // => 'Fred'
+ * @category String
+ * @param str - The string to capitalize.
+ * @returns Returns the capitalized string.
+ */
+
 export function capitalize(str: string): string {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }

package/src/string/deburr.ts

@@ -1,3 +1,18 @@
+/**
+ * Deburrs a string by converting
+ * [Latin-1 Supplement](https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table)
+ * and [Latin Extended-A](https://en.wikipedia.org/wiki/Latin_Extended-A)
+ * letters to basic Latin letters and removing
+ * [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
+ *
+ * @example
+ * deburr('déjà vu')
+ * // => 'deja vu'
+ * @category String
+ * @param str - The string to deburr.
+ * @returns Returns the deburred string.
+ */
+
 export function deburr(str: string): string {
     // eslint-disable-next-line no-control-regex
     return str.replace(/[^\u0000-\u007E]/g, (chr: string) =>

package/src/string/escape.ts

@@ -1,3 +1,14 @@
+/**
+ * Converts the characters `&`, `<`, `>`, `"` and `'` in a string to their corresponding HTML entities.
+ *
+ * @example
+ * escape('fred, barney, & pebbles')
+ * // => 'fred, barney, &amp; pebbles'
+ * @category String
+ * @param str - The string to escape.
+ * @returns Returns the escaped string.
+ */
+
 export function escape(str: string): string {
     const escapeChars: Record<string, string> = {
         '&': '&amp;',

package/src/string/escapeRegExp.ts

@@ -1,3 +1,15 @@
+/**
+ * Escapes the `RegExp` special characters `^`, `$`, `\`, `.`, `*`, `+`,
+ * `?`, `(`, `)`, `[`, `]`, `{`, `}`, and `|` in a string.
+ *
+ * @example
+ * escapeRegExp('[moderndash](https://moderndash.io/)')
+ * // => '\[moderndash\]\(https://moderndash\.io/\)'
+ * @category String
+ * @param str - The string to escape.
+ * @returns Returns the escaped string.
+ */
+
 export function escapeRegExp(str: string): string {
     return str.replace(/[$()*+.?[\\\]^{|}]/g, '\\$&');
 }

package/src/string/kebabCase.ts

@@ -1,5 +1,20 @@
 import { splitWords } from '@helpers/stringModifiers';
 
+/**
+ * Converts a string to kebab-case.
+ *
+ * @example
+ * kebabCase('Foo Bar')
+ * // => 'foo-bar'
+ * kebabCase('fooBar')
+ * // => 'foo-bar'
+ * kebabCase('__FOO_BAR__')
+ * // => 'foo-bar'
+ * @category String
+ * @param str - The string to convert.
+ * @returns Returns the kebab cased string.
+ */
+
 export function kebabCase(str: string): string {
     const words = splitWords(str);
     let kebabCase = '';

package/src/string/pascalCase.ts

@@ -1,5 +1,21 @@
 import { splitWords } from '@helpers/stringModifiers';
 
+
+/**
+ * Converts a string to PascalCase.
+ *
+ * @example
+ * kebabCase('Foo Bar')
+ * // => 'FooBar'
+ * kebabCase('fooBar')
+ * // => 'FooBar'
+ * kebabCase('__FOO_BAR__')
+ * // => 'FooBar'
+ * @category String
+ * @param str - The string to convert.
+ * @returns Returns the pascal cased string.
+ */
+
 export function pascalCase(str: string): string {
     const words = splitWords(str);
     let pascalCase = '';

package/src/string/snakeCase.ts

@@ -1,5 +1,22 @@
 import { splitWords } from '@helpers/stringModifiers';
 
+/**
+ * Converts a string to snake_case.
+ *
+ * @example
+ * snakeCase('Foo Bar')
+ * // => 'foo_bar'
+ * snakeCase('fooBar')
+ * // => 'foo_bar'
+ * snakeCase('--FOO-BAR--')
+ * // => 'foo_bar'
+ * snakeCase('foo2bar')
+ * // => 'foo_2_bar'
+ * @category String
+ * @param str - The string to convert.
+ * @returns Returns the snake cased string.
+ */
+
 export function snakeCase(str: string): string {
     const words = splitWords(str);
     let snakeCase = '';

package/src/string/startCase.ts

@@ -1,5 +1,20 @@
 import { splitWords } from '@helpers/stringModifiers';
 
+/**
+ * Converts a string to Start Case.
+ *
+ * @example
+ * startCase('--foo-bar--')
+ * // => 'Foo Bar'
+ * startCase('fooBar')
+ * // => 'Foo Bar'
+ * startCase('__FOO_BAR__')
+ * // => 'Foo Bar'
+ * @category String
+ * @param str - The string to convert.
+ * @returns Returns the start cased string.
+ */
+
 export function startCase(str: string): string {
     const words = splitWords(str);
     let startCase = '';

package/src/string/stripSpecialChars.ts

@@ -1,5 +1,16 @@
 import { deburr } from '@string/deburr';
 
+/**
+ * Removes all special characters from a string.
+ *
+ * @example
+ * stripSpecialChars('Héllo! World #$%&*!')
+ * // => 'Hello World'
+ * @category String
+ * @param str - The string to remove special characters from.
+ * @returns Returns the string with special characters removed.
+*/
+
 export function stripSpecialChars(str: string): string {
     str = deburr(str);
     return str.replace(/[^\s\w]/gi, '');

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/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