@superutils/core 1.0.7 → 1.1.1

package/README.md

@@ -53,8 +53,7 @@ is.map(new Map()) // true
 is.number(123) // true
 is.number(NaN) // false
 is.url('https://google.com') // true
-...
-
+//...
 ```
 
 All these functions can also be imported independantly.
@@ -80,16 +79,15 @@ import {
 `debounce()`, a sugar for `deferred()`, is also available.
 
 ```javascript
-
 import { deferred } from '@superutils/core'
 
 const handleChange = deferred(
-    event => console.log(event.target.value),
-    300 // debounce delay in milliseconds
+	event => console.log(event.target.value),
+	300, // debounce delay in milliseconds
 )
-handleChange({ target: { value 1 } }) // will be ignored
-handleChange({ target: { value 2 } }) // will be ignored
-handleChange({ target: { value 3 } }) // will be executed
+handleChange({ target: { value: 1 } }) // will be ignored
+handleChange({ target: { value: 2 } }) // will be ignored
+handleChange({ target: { value: 3 } }) // will be executed
 ```
 
 <div id="throttle"></div>
@@ -100,12 +98,12 @@ handleChange({ target: { value 3 } }) // will be executed
 import { throttle } from '@superutils/core'
 
 const handleChange = throttle(
-    event => console.log(event.target.value),
-    300 // throttle duration in milliseconds
+	event => console.log(event.target.value),
+	300, // throttle duration in milliseconds
 )
-handleChange({ target: { value 1 } }) // will be executed
-handleChange({ target: { value 2 } }) // will be ignored
-handleChange({ target: { value 3 } }) // will be ignored
+handleChange({ target: { value: 1 } }) // will be executed
+handleChange({ target: { value: 2 } }) // will be ignored
+handleChange({ target: { value: 3 } }) // will be ignored
 ```
 
 <div id="fallback-if-fails"></div>
@@ -150,11 +148,10 @@ fallbackIfFails(
 ).then(console.log)
 // Prints the result when request is successful or fallback value when request fails
 
-
 // use a promise
 fallbackIfFails(
 	Promise.reject('error'),
-	[], // 
+	[], //
 )
 ```
 

package/dist/index.d.ts

@@ -255,8 +255,8 @@ declare function curry<TData, TArgs extends unknown[], TArgsIsFinite extends boo
 ]): Curry<TData, CurriedArgs<TArgs, TArgsIsFinite, (...args: TArgs) => TData, TArity>>;
 
 /**
- * @function deferred AKA debounce
- * @summary returns a function that invokes the callback function after certain delay/timeout.
+ *
+ * Returns a function that invokes the callback function after certain delay/timeout.
  * All errors will be gracefully swallowed.
  *
  * @param	callback 	function to be invoked after timeout
@@ -267,20 +267,18 @@ declare function curry<TData, TArgs extends unknown[], TArgsIsFinite extends boo
  * @param	config.tid	   (optional) Timeout Id. If provided, will clear the timeout on first invocation.
  *
  * @example Debounce function calls
- * ```typescript
+ * ```javascript
  * import { deferred } from '@superutils/core'
  *
  * const handleChange = deferred(
- *     event => console.log(event.target.value),
+ *     event => console.log('Value:', event.target.value),
  *     300 // debounce delay in milliseconds
  * )
  *
- * handleChange({ target: { value 1 } }) // will be ignored
- * handleChange({ target: { value 2 } }) // will be ingored
- * handleChange({ target: { value 3 } }) // will be invoked
+ * handleChange({ target: { value: 1 } }) // will be ignored
+ * handleChange({ target: { value: 2 } }) // will be ingored
+ * handleChange({ target: { value: 3 } }) // will be invoked
  * ```
- *
- *
  */
 declare const deferred: {
     <TArgs extends unknown[], ThisArg>(callback: (this: ThisArg, ...args: TArgs) => ValueOrPromise<unknown>, delay?: number, config?: DeferredOptions<ThisArg>): (...args: TArgs) => void;
@@ -299,7 +297,13 @@ declare const deferred: {
 };
 
 /** Super for `deferred()` function */
-declare function debounce(...args: Parameters<typeof deferred>): (...args: unknown[]) => void;
+declare const debounce: {
+    <TArgs extends unknown[], ThisArg>(callback: (this: ThisArg, ...args: TArgs) => ValueOrPromise<unknown>, delay?: number, config?: DeferredOptions<ThisArg>): (...args: TArgs) => void;
+    defaults: {
+        leading: false;
+        onError: undefined;
+    };
+};
 
 /**
  * If `T` is a promise turn it into an union type by adding the value type
@@ -381,11 +385,6 @@ type IfPromiseAddValue<T> = T extends Promise<infer V> ? T | V : T;
  */
 declare const fallbackIfFails: <T, TArgs extends unknown[] = unknown[]>(target: T | ((...args: TArgs) => T), args: TArgs | (() => TArgs), fallbackValue: IfPromiseAddValue<T> | ((reason: unknown) => IfPromiseAddValue<T>)) => T;
 
-/** Cast a value as `any` type to bypass type check. Use with caution. */
-declare const asAny: <T = any>(x: unknown) => T;
-/** Force cast one type into another to bypass type checks. Use with caution. */
-declare const forceCast: <T>(x: unknown) => T;
-
 /** Check if value is an array */
 declare const isArr: <Item = unknown>(x: unknown) => x is Item[];
 /**
@@ -660,6 +659,19 @@ type ThrottleOptions<ThisArg = unknown> = {
  * @param   config.tid      (optional)
  * @param	config.thisArg  (optional) the special `thisArgs` to be used when invoking the callback.
  * @param   config.trailing (optional) whether to enable trailing edge execution. Default: `true`
+ *
+ * @example
+ * ```javascript
+ * import { throttle } from '@superutils/core'
+ *
+ * const handleChange = throttle(
+ *     event => console.log('Value:', event.target.value),
+ *     300, // throttle duration in milliseconds
+ * )
+ * handleChange({ target: { value: 1 } }) // will be executed
+ * handleChange({ target: { value: 2 } }) // will be ignored
+ * handleChange({ target: { value: 3 } }) // will be ignored
+ * ```
  */
 declare const throttled: {
     <TArgs extends unknown[], ThisArg>(callback: (this: ThisArg, ...args: TArgs) => ValueOrPromise<unknown>, delay?: number, config?: ThrottleOptions<ThisArg>): (...args: TArgs) => void;
@@ -712,7 +724,7 @@ declare const objClean: <T extends Record<PropertyKey, unknown>, Key extends key
  * Deep-copy an object to another object
  *
  * @param input input object
- * @param _output (optional) output object
+ * @param output (optional) output object
  * @param ignoreKeys (optional) input peroperties to be ignored. Prevents output's property to be overriden.
  *
  * For child object properties use "." (dot) separated path.
@@ -734,7 +746,7 @@ declare const objClean: <T extends Record<PropertyKey, unknown>, Key extends key
  *
  * Default: `false`
  *
- * @param reverse (optional) whether to reverse sort object properties. Default: `false`
+ * @param recursive (optional) whether to recursively copy nested objects. Default: `false`
  *
  *
  * @returns copied and/or merged object
@@ -774,7 +786,7 @@ declare const objCreate: <V, K extends PropertyKey, RV, RK extends PropertyKey,
  *
  * @param input
  * @param keys
- * @param equireValue (optional) whether each property should have some value.
+ * @param requireValue (optional) whether each property should have some value.
  */
 declare function objHasKeys(input?: object | unknown[], keys?: PropertyKey[], requireValue?: boolean): boolean;
 
@@ -1013,7 +1025,7 @@ type SearchOptions<K, V, MatchExact extends boolean = false, AsMap extends boole
  * 2. `key`: index/key
  * 3. `data`: value provided in the first argument (`data`)
  * @param limit	(optional) limit number of results
- * @param arArray
+ * @param asArray
  *
  * @returns new Map with filtered items
  *
@@ -1374,4 +1386,4 @@ declare const HASH_REGEX: RegExp;
  */
 declare const strToArr: (value: unknown, seperator?: string) => string[];
 
-export { type ArrayComparator, type AsyncFn, type CreateTuple, type CurriedArgs, type Curry, type DeferredOptions, type DropFirst, type DropFirstN, type DropLast, EMAIL_REGEX, type EntryComparator, type FindOptions, HASH_REGEX, HEX_REGEX, type IfPromiseAddValue, type IsFiniteTuple, type IsOptional, type IterableList, type KeepFirst, type KeepFirstN, type KeepOptionals, type KeepRequired, type MakeOptional, type MinLength, type NegativeNumber, type OptionalIf, type PositiveNumber, type PositiveNumberWithZero, type ReadOnlyAllowAddFn, ReadOnlyArrayHelper, type ReadOnlyConfig, type SearchOptions, type Slice, type SliceMapOptions, type SliceMapTransform, type SortOptions, type ThrottleOptions, type TimeoutId, type TupleMaxLength, type TupleWithAlt, type ValueOrFunc, type ValueOrPromise, arrReadOnly, arrReverse, arrToMap, arrUnique, asAny, clearClutter, copyToClipboard, curry, debounce, deferred, fallbackIfFails, filter, find, forceCast, getEntries, getKeys, getSize, getUrlParam, getValues, is, isArr, isArr2D, isArrLike, isArrLikeSafe, isArrObj, isArrUnique, isAsyncFn, isBool, isDate, isDateValid, isDefined, isEmpty, isEmptySafe, isEnvBrowser, isEnvNode, isEnvTouchable, isError, isFn, isInteger, isMap, isMapObj, isNumber, isObj, isPositiveInteger, isPositiveNumber, isPromise, isRegExp, isSet, isStr, isSymbol, isUint8Arr, isUrl, isUrlValid, mapJoin, matchObjOrProp, noop, noopAsync, objClean, objCopy, objCreate, objHasKeys, objKeys, objReadOnly, objSetProp, objSetPropUndefined, objSort, objWithoutKeys, randomInt, reverse, search, sliceMap, sort, strToArr, throttled, toDatetimeLocal };
+export { type ArrayComparator, type AsyncFn, type CreateTuple, type CurriedArgs, type Curry, type DeferredOptions, type DropFirst, type DropFirstN, type DropLast, EMAIL_REGEX, type EntryComparator, type FindOptions, HASH_REGEX, HEX_REGEX, type IfPromiseAddValue, type IsFiniteTuple, type IsOptional, type IterableList, type KeepFirst, type KeepFirstN, type KeepOptionals, type KeepRequired, type MakeOptional, type MinLength, type NegativeNumber, type OptionalIf, type PositiveNumber, type PositiveNumberWithZero, type ReadOnlyAllowAddFn, ReadOnlyArrayHelper, type ReadOnlyConfig, type SearchOptions, type Slice, type SliceMapOptions, type SliceMapTransform, type SortOptions, type ThrottleOptions, type TimeoutId, type TupleMaxLength, type TupleWithAlt, type ValueOrFunc, type ValueOrPromise, arrReadOnly, arrReverse, arrToMap, arrUnique, clearClutter, copyToClipboard, curry, debounce, deferred, fallbackIfFails, filter, find, getEntries, getKeys, getSize, getUrlParam, getValues, is, isArr, isArr2D, isArrLike, isArrLikeSafe, isArrObj, isArrUnique, isAsyncFn, isBool, isDate, isDateValid, isDefined, isEmpty, isEmptySafe, isEnvBrowser, isEnvNode, isEnvTouchable, isError, isFn, isInteger, isMap, isMapObj, isNumber, isObj, isPositiveInteger, isPositiveNumber, isPromise, isRegExp, isSet, isStr, isSymbol, isUint8Arr, isUrl, isUrlValid, mapJoin, matchObjOrProp, noop, noopAsync, objClean, objCopy, objCreate, objHasKeys, objKeys, objReadOnly, objSetProp, objSetPropUndefined, objSort, objWithoutKeys, randomInt, reverse, search, sliceMap, sort, strToArr, throttled, toDatetimeLocal };

package/dist/index.js

@@ -239,13 +239,7 @@ deferred.defaults = {
 var deferred_default = deferred;
 
 // src/debounce.ts
-function debounce(...args) {
-  return deferred_default(...args);
-}
-
-// src/forceCast.ts
-var asAny = (x) => x;
-var forceCast = (x) => x;
+var debounce = deferred_default;
 
 // src/throttled.ts
 var throttled = (callback, delay = 50, config = {}) => {
@@ -918,7 +912,6 @@ export {
   arrReverse,
   arrToMap,
   arrUnique,
-  asAny,
   clearClutter,
   copyToClipboard,
   curry,
@@ -927,7 +920,6 @@ export {
   fallbackIfFails,
   filter,
   find,
-  forceCast,
   getEntries,
   getKeys,
   getSize,

package/package.json

@@ -42,5 +42,5 @@
 	"sideEffects": false,
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "1.0.7"
+	"version": "1.1.1"
 }