moderndash 0.0.21 → 0.1.0

package/dist/index.d.ts

@@ -102,11 +102,6 @@ declare function differenceWith<T>(comparator: (a: T, b: T) => boolean, ...array
  * Elements are dropped until `predicate` returns falsey. The predicate is
  * invoked with three arguments: (value, index, array).
  *
- * @category Array
- * @param predicate - The function invoked per iteration.
- * @param array - The array to query.
- * @returns Returns the slice of `array`.
- * @example
  * const users = [
  *   { 'user': 'barney',  'active': false },
  *   { 'user': 'fred',    'active': true },
@@ -115,6 +110,11 @@ declare function differenceWith<T>(comparator: (a: T, b: T) => boolean, ...array
  *
  * dropRightWhile(users, { active }) => active)
  * // => objects for ['barney']
+ * @category Array
+ * @param predicate - The function invoked per iteration.
+ * @param array - The array to query.
+ * @returns Returns the slice of `array`.
+ * @example
  */
 declare function dropRightWhile<T>(array: T[], predicate: (value: T) => boolean): T[];
 
@@ -123,10 +123,6 @@ declare function dropRightWhile<T>(array: T[], predicate: (value: T) => boolean)
  * Elements are dropped until `predicate` returns falsey. The predicate is
  * invoked with three arguments: (value, index, array).
  *
- * @category Array
- * @param predicate - The function invoked per iteration.
- * @param array - The array to query.
- * @returns Returns the slice of `array`.
  * @example
  * const users = [
  *   { 'user': 'barney',  'active': true },
@@ -134,8 +130,12 @@ declare function dropRightWhile<T>(array: T[], predicate: (value: T) => boolean)
  *   { 'user': 'pebbles', 'active': false }
  * ]
  *
- * dropWhile(({ active }) => active, users)
+ * dropWhile(users, ({ active }) => active)
  * // => objects for ['pebbles']
+ * @category Array
+ * @param predicate - The function invoked per iteration.
+ * @param array - The array to query.
+ * @returns Returns the slice of `array`.
  */
 declare function dropWhile<T>(array: T[], predicate: (value: T) => boolean): T[];
 
@@ -547,95 +547,19 @@ declare function throttle<TFunc extends GenericFunction<TFunc>>(func: TFunc, wai
 declare function times<TInput>(n: number, func: (index: number) => TInput): TInput[];
 
 /**
- * Checks if `value` is an empty object, collection, map, or set.
- *
- * Objects are considered empty if they have no own enumerable string keyed
- * properties.
- *
- * Array-like values such as `arguments` objects, arrays, buffers, strings, or
- * Similarly, maps and sets are considered empty if they have a `size` of `0`.
+ * Omit specified keys from an object
  *
  * @example
- * isEmpty(null)
- * // => true
+ * const obj = {a: 1, b: 2, c: 3};
+ * omit(obj, ['a', 'b']);
+ * // => {c: 3}
  *
- * isEmpty({})
- * // => true
+ * @param object - The object to filter
+ * @param keysToOmit - The keys to exclude from the returned object
+ * @returns - An object without the specified keys
  *
- * isEmpty("")
- * // => true
- *
- * isEmpty([1, 2, 3])
- * // => false
- *
- * isEmpty('abc')
- * // => false
- *
- * isEmpty({ 'a': 1 })
- * // => false
- * @category Lang
- * @param value - The value to check.
- * @returns Returns `true` if given vlaue is empty, else `false`.
  */
-declare function isEmpty(value: string | object | null | undefined): boolean;
-
-/**
- * Performs a deep comparison between two values to determine if they are
- * equivalent.
- *
- * **Note:** This method supports comparing arrays, array buffers, booleans,
- * date objects, error objects, maps, numbers, `Object` objects, regexes,
- * sets, strings, symbols, and typed arrays. `Object` objects are compared
- * by their own, not inherited, enumerable properties. Functions and DOM
- * nodes are compared by strict equality, i.e. `===`.
- *
- * @category Lang
- * @param value1 - The value to compare.
- * @param value2 - The other value to compare.
- * @returns Returns `true` if the values are equivalent, else `false`.
- * @example
- * var object = { 'a': 1 };
- * var other = { 'a': 1 };
- *
- * isEqual(object, other);
- * // => true
- *
- * object === other;
- * // => false
- */
-declare function isEqual(value1: unknown, value2: unknown): boolean;
-
-/**
- * This method is like `_.isEqual` except that it accepts `customizer` which
- * is invoked to compare values. If `customizer` returns `undefined`, comparisons
- * are handled by the method instead. The `customizer` is invoked with up to
- * six arguments: (objValue, othValue [, index|key, object, other, stack]).
- *
- * @category Lang
- * @example
- * function isGreeting(value) {
- *   return /^h(?:i|ello)$/.test(value);
- * }
- *
- * function customizer(objValue, othValue) {
- *   if (isGreeting(objValue) && isGreeting(othValue)) {
- *     return true;
- *   }
- * }
- *
- * var array = ['hello', 'goodbye'];
- * var other = ['hi', 'goodbye'];
- *
- * isEqualWith(array, other, customizer);
- * // => true
- * @param a - The value to compare.
- * @param b - The other value to compare.
- * @param customizer - The function to customize comparisons.
- * @returns Returns `true` if the values are equivalent, else `false`.
-*/
-declare function isEqualWith<T>(a: T, b: T, customizer: (value: T) => unknown): boolean;
-
-declare function isPlainObject(value: unknown): value is object;
+declare function omit<TObj extends object, Key extends keyof TObj>(object: TObj, keysToOmit: Key[]): Omit<TObj, Key>;
 
 /**
  * Creates an object composed of the picked `object` properties.
@@ -647,10 +571,21 @@ declare function isPlainObject(value: unknown): value is object;
  * // => { 'a': 1, 'c': 3 }
  * @category Object
  * @param object - The source object.
- * @param keys - The property paths to pick.
+ * @param keysToPick - The property paths to pick.
  * @returns Returns the new object.
  */
-declare function pick<TInput, Key extends keyof TInput>(object: TInput, keys: Key[]): Pick<TInput, Key>;
+declare function pick<TInput, Key extends keyof TInput>(object: TInput, keysToPick: Key[]): Pick<TInput, Key>;
+
+/**
+ * Sleeps for the given amount of time.
+ *
+ * @example
+ * await sleep(1000);
+ * // => Waits for 1 second.
+ * @param ms -  Amount of time to sleep in milliseconds.
+ * @returns A promise that resolves after the given amount of time.
+ */
+declare function sleep(ms: number): Promise<unknown>;
 
 /**
  * Converts `string` to camelCase.
@@ -706,7 +641,7 @@ declare function deburr(str: string): string;
  * @param str - The string to escape.
  * @returns Returns the escaped string.
  */
-declare function escape(str: string): string;
+declare function escapeHtml(str: string): string;
 
 /**
  * Escapes the `RegExp` special characters `^`, `$`, `\`, `.`, `*`, `+`,
@@ -810,6 +745,110 @@ declare function stripSpecial(str: string): string;
  * @param str - The string to unescape.
  * @returns Returns the unescaped string.
  */
-declare function unescape(str: string): string;
+declare function unescapeHtml(str: string): string;
+
+/**
+ * Checks if `value` is an empty object, collection, map, or set.
+ *
+ * Objects are considered empty if they have no own enumerable string keyed
+ * properties.
+ *
+ * Array-like values such as `arguments` objects, arrays, buffers, strings, or
+ * Similarly, maps and sets are considered empty if they have a `size` of `0`.
+ *
+ * @example
+ * isEmpty(null)
+ * // => true
+ *
+ * isEmpty({})
+ * // => true
+ *
+ * isEmpty("")
+ * // => true
+ *
+ * isEmpty([1, 2, 3])
+ * // => false
+ *
+ * isEmpty('abc')
+ * // => false
+ *
+ * isEmpty({ 'a': 1 })
+ * // => false
+ * @category Lang
+ * @param value - The value to check.
+ * @returns Returns `true` if given vlaue is empty, else `false`.
+ */
+declare function isEmpty(value: string | object | null | undefined): boolean;
+
+/**
+ * Performs a deep comparison between two values to determine if they are
+ * equivalent.
+ *
+ * **Note:** This method supports comparing arrays, array buffers, booleans,
+ * date objects, error objects, maps, numbers, `Object` objects, regexes,
+ * sets, strings, symbols, and typed arrays. `Object` objects are compared
+ * by their own, not inherited, enumerable properties. Functions and DOM
+ * nodes are compared by strict equality, i.e. `===`.
+ *
+ * @category Lang
+ * @param value1 - The value to compare.
+ * @param value2 - The other value to compare.
+ * @returns Returns `true` if the values are equivalent, else `false`.
+ * @example
+ * var object = { 'a': 1 };
+ * var other = { 'a': 1 };
+ *
+ * isEqual(object, other);
+ * // => true
+ *
+ * object === other;
+ * // => false
+ */
+declare function isEqual(value1: unknown, value2: unknown): boolean;
+
+/**
+ * This method is like `_.isEqual` except that it accepts `customizer` which
+ * is invoked to compare values. If `customizer` returns `undefined`, comparisons
+ * are handled by the method instead. The `customizer` is invoked with up to
+ * six arguments: (objValue, othValue [, index|key, object, other, stack]).
+ *
+ * @category Lang
+ * @example
+ * function isGreeting(value) {
+ *   return /^h(?:i|ello)$/.test(value);
+ * }
+ *
+ * function customizer(objValue, othValue) {
+ *   if (isGreeting(objValue) && isGreeting(othValue)) {
+ *     return true;
+ *   }
+ * }
+ *
+ * var array = ['hello', 'goodbye'];
+ * var other = ['hi', 'goodbye'];
+ *
+ * isEqualWith(array, other, customizer);
+ * // => true
+ * @param a - The value to compare.
+ * @param b - The other value to compare.
+ * @param customizer - The function to customize comparisons.
+ * @returns Returns `true` if the values are equivalent, else `false`.
+*/
+declare function isEqualWith<T>(a: T, b: T, customizer: (value: T) => unknown): boolean;
+
+declare function isPlainObject(value: unknown): value is object;
+
+/**
+ * Checks if given string is a valid URL
+ *
+ * @example
+ * isUrl('https://google.com')
+ * // => true
+ * isUrl('google.com')
+ * // => false
+ * @param str - The string to check.
+ * @returns Returns `true` if given string is a valid URL, else `false`.
+ */
+declare function isUrl(str: string): boolean;
 
-export { GenericFunction, IterateeFunction, MinimumTwoArrays, NoUnion, PropertyShorthand, RecordKey, after, before, camelCase, capitalize, chunk, count, debounce, deburr, difference, differenceBy, differenceWith, dropRightWhile, dropWhile, escape, escapeRegExp, group, intersection, intersectionBy, intersectionWith, isEmpty, isEqual, isEqualWith, isPlainObject, kebabCase, memoize, once, pascalCase, pick, sample, sampleSize, shuffle, snakeCase, sort, startCase, stripSpecial, takeRightWhile, takeWhile, throttle, times, unescape, uniq, uniqBy, uniqWith, unzip, unzipWith, zip, zipWith };
+export { GenericFunction, IterateeFunction, MinimumTwoArrays, NoUnion, PropertyShorthand, RecordKey, after, before, camelCase, capitalize, chunk, count, debounce, deburr, difference, differenceBy, differenceWith, dropRightWhile, dropWhile, escapeHtml, escapeRegExp, group, intersection, intersectionBy, intersectionWith, isEmpty, isEqual, isEqualWith, isPlainObject, isUrl, kebabCase, memoize, omit, once, pascalCase, pick, sample, sampleSize, shuffle, sleep, snakeCase, sort, startCase, stripSpecial, takeRightWhile, takeWhile, throttle, times, unescapeHtml, uniq, uniqBy, uniqWith, unzip, unzipWith, zip, zipWith };

package/dist/index.js

@@ -39,7 +39,7 @@ function differenceWith(comparator, ...arrays) {
   return difference2;
 }
 
-// src/lang/isEqual.ts
+// src/validate/isEqual.ts
 function isEqual(value1, value2) {
   if (value1 === value2)
     return true;
@@ -102,7 +102,7 @@ function getIterateFunction(iteratee) {
   }
 }
 
-// src/lang/isEqualWith.ts
+// src/validate/isEqualWith.ts
 function isEqualWith(a, b, customizer) {
   return isEqual(customizer(a), customizer(b));
 }
@@ -440,37 +440,27 @@ function times(n, func) {
   return result;
 }
 
-// src/lang/isEmpty.ts
-function isEmpty(value) {
-  if (value === null || value === void 0) {
-    return true;
-  }
-  if (typeof value === "string" || Array.isArray(value)) {
-    return value.length === 0;
-  }
-  if (value instanceof Map || value instanceof Set) {
-    return value.size === 0;
-  }
-  if (typeof value === "object") {
-    return Object.keys(value).length === 0;
-  }
-  return false;
-}
-
-// src/lang/isPlainObject.ts
-function isPlainObject(value) {
-  return value !== null && typeof value === "object" && value.constructor === Object;
-}
-
 // src/object/pick.ts
-function pick(object, keys) {
+function pick(object, keysToPick) {
   const result = {};
-  for (const key of keys) {
+  for (const key of keysToPick) {
     result[key] = object[key];
   }
   return result;
 }
 
+// src/object/omit.ts
+function omit(object, keysToOmit) {
+  const keys = Object.keys(object);
+  const filteredKeys = keys.filter((key) => !keysToOmit.includes(key));
+  return pick(object, filteredKeys);
+}
+
+// src/promise/sleep.ts
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
 // src/string/deburr.ts
 function deburr(str) {
   return str.replace(/[^\u0000-\u007E]/g, (chr) => chr.normalize("NFD").replace(/[\u0300-\u036F]/g, ""));
@@ -502,8 +492,8 @@ function capitalize(str) {
   return str.charAt(0).toUpperCase() + str.slice(1);
 }
 
-// src/string/escape.ts
-function escape(str) {
+// src/string/escapeHtml.ts
+function escapeHtml(str) {
   const escapeChars = {
     "&": "&",
     "<": "&lt;",
@@ -568,8 +558,8 @@ function stripSpecial(str) {
   return str.replace(/[^\s\w]/gi, "");
 }
 
-// src/string/unescape.ts
-function unescape(str) {
+// src/string/unescapeHtml.ts
+function unescapeHtml(str) {
   const entityMap = {
     "&amp;": "&",
     "&lt;": "<",
@@ -579,6 +569,38 @@ function unescape(str) {
   };
   return str.replace(/&(?:amp|lt|gt|quot|#(0+)?39);/g, (entity) => entityMap[entity] || entity);
 }
+
+// src/validate/isEmpty.ts
+function isEmpty(value) {
+  if (value === null || value === void 0) {
+    return true;
+  }
+  if (typeof value === "string" || Array.isArray(value)) {
+    return value.length === 0;
+  }
+  if (value instanceof Map || value instanceof Set) {
+    return value.size === 0;
+  }
+  if (typeof value === "object") {
+    return Object.keys(value).length === 0;
+  }
+  return false;
+}
+
+// src/validate/isPlainObject.ts
+function isPlainObject(value) {
+  return value !== null && typeof value === "object" && value.constructor === Object;
+}
+
+// src/validate/isUrl.ts
+function isUrl(str) {
+  try {
+    new URL(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
 export {
   after,
   before,
@@ -593,7 +615,7 @@ export {
   differenceWith,
   dropRightWhile,
   dropWhile,
-  escape,
+  escapeHtml,
   escapeRegExp,
   group,
   intersection,
@@ -603,14 +625,17 @@ export {
   isEqual,
   isEqualWith,
   isPlainObject,
+  isUrl,
   kebabCase,
   memoize,
+  omit,
   once,
   pascalCase,
   pick,
   sample,
   sampleSize,
   shuffle,
+  sleep,
   snakeCase,
   sort,
   startCase,
@@ -619,7 +644,7 @@ export {
   takeWhile,
   throttle,
   times,
-  unescape,
+  unescapeHtml,
   uniq,
   uniqBy,
   uniqWith,