@stryke/hooks 0.4.77 → 0.4.79
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.
- package/CHANGELOG.md +26 -0
- package/README.md +1 -1
- package/dist/helpers/src/debounce.cjs +5 -4
- package/dist/helpers/src/debounce.d.cts.map +1 -1
- package/dist/helpers/src/debounce.d.mts.map +1 -1
- package/dist/helpers/src/debounce.mjs +5 -4
- package/dist/helpers/src/debounce.mjs.map +1 -1
- package/dist/helpers/src/throttle.mjs.map +1 -1
- package/dist/type-checks/src/is-equal.cjs +3 -3
- package/dist/type-checks/src/is-equal.mjs +3 -3
- package/dist/type-checks/src/is-equal.mjs.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,32 @@
|
|
|
2
2
|
|
|
3
3
|
# Changelog for Stryke - Hooks
|
|
4
4
|
|
|
5
|
+
## [0.4.79](https://github.com/storm-software/stryke/releases/tag/hooks%400.4.79) (03/23/2026)
|
|
6
|
+
|
|
7
|
+
### Bug Fixes
|
|
8
|
+
|
|
9
|
+
- **monorepo:** Update all repository projects to resolve linting failures ([e9fb597b](https://github.com/storm-software/stryke/commit/e9fb597b))
|
|
10
|
+
|
|
11
|
+
### Updated Dependencies
|
|
12
|
+
|
|
13
|
+
- Updated **type-checks** to **v0.6.0**
|
|
14
|
+
- Updated **helpers** to **v0.10.7**
|
|
15
|
+
- Updated **types** to **v0.11.2**
|
|
16
|
+
- Updated **env** to **v0.20.81**
|
|
17
|
+
|
|
18
|
+
## [0.4.78](https://github.com/storm-software/stryke/releases/tag/hooks%400.4.78) (03/16/2026)
|
|
19
|
+
|
|
20
|
+
### Miscellaneous
|
|
21
|
+
|
|
22
|
+
- **monorepo:** Added `README.md` workspace files ([515dc333](https://github.com/storm-software/stryke/commit/515dc333))
|
|
23
|
+
|
|
24
|
+
### Updated Dependencies
|
|
25
|
+
|
|
26
|
+
- Updated **type-checks** to **v0.5.41**
|
|
27
|
+
- Updated **helpers** to **v0.10.6**
|
|
28
|
+
- Updated **types** to **v0.11.1**
|
|
29
|
+
- Updated **env** to **v0.20.80**
|
|
30
|
+
|
|
5
31
|
## [0.4.77](https://github.com/storm-software/stryke/releases/tag/hooks%400.4.77) (03/16/2026)
|
|
6
32
|
|
|
7
33
|
### Updated Dependencies
|
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ This package is part of Storm Software's **🌩️ Stryke** monorepo. Stryke pac
|
|
|
28
28
|
|
|
29
29
|
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
|
|
30
30
|
|
|
31
|
-
[](https://github.com/storm-software/stryke) [](http://commitizen.github.io/cz-cli/)  
|
|
32
32
|
|
|
33
33
|
> [!IMPORTANT] Important
|
|
34
34
|
> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
|
|
@@ -30,13 +30,14 @@
|
|
|
30
30
|
* controller.abort();
|
|
31
31
|
* ```
|
|
32
32
|
*
|
|
33
|
-
* @param func - The function to debounce
|
|
34
|
-
* @param debounceMs - The number of milliseconds to delay
|
|
35
|
-
* @param options -
|
|
33
|
+
* @param func - The function to debounce
|
|
34
|
+
* @param debounceMs - The number of milliseconds to delay
|
|
35
|
+
* @param options - Optional configuration for the debounced function, including an AbortSignal to cancel the debounce
|
|
36
36
|
* @returns A new debounced function with a `cancel` method.
|
|
37
37
|
*/
|
|
38
|
-
function debounce(func, debounceMs,
|
|
38
|
+
function debounce(func, debounceMs, options = {}) {
|
|
39
39
|
let timeoutId = null;
|
|
40
|
+
const { signal } = options;
|
|
40
41
|
const debounced = ((...args) => {
|
|
41
42
|
if (timeoutId !== null) clearTimeout(timeoutId);
|
|
42
43
|
if (signal?.aborted) return;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"debounce.d.cts","names":[],"sources":["../../../../helpers/src/debounce.ts"],"sourcesContent":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"debounce.d.cts","names":[],"sources":["../../../../helpers/src/debounce.ts"],"sourcesContent":[],"mappings":";UAkBiB,eAAA;EAAA,MAAA,CAAA,EACN,WADqB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"debounce.d.mts","names":[],"sources":["../../../../helpers/src/debounce.ts"],"sourcesContent":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"debounce.d.mts","names":[],"sources":["../../../../helpers/src/debounce.ts"],"sourcesContent":[],"mappings":";UAkBiB,eAAA;EAAA,MAAA,CAAA,EACN,WADqB"}
|
|
@@ -29,13 +29,14 @@
|
|
|
29
29
|
* controller.abort();
|
|
30
30
|
* ```
|
|
31
31
|
*
|
|
32
|
-
* @param func - The function to debounce
|
|
33
|
-
* @param debounceMs - The number of milliseconds to delay
|
|
34
|
-
* @param options -
|
|
32
|
+
* @param func - The function to debounce
|
|
33
|
+
* @param debounceMs - The number of milliseconds to delay
|
|
34
|
+
* @param options - Optional configuration for the debounced function, including an AbortSignal to cancel the debounce
|
|
35
35
|
* @returns A new debounced function with a `cancel` method.
|
|
36
36
|
*/
|
|
37
|
-
function debounce(func, debounceMs,
|
|
37
|
+
function debounce(func, debounceMs, options = {}) {
|
|
38
38
|
let timeoutId = null;
|
|
39
|
+
const { signal } = options;
|
|
39
40
|
const debounced = ((...args) => {
|
|
40
41
|
if (timeoutId !== null) clearTimeout(timeoutId);
|
|
41
42
|
if (signal?.aborted) return;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"debounce.mjs","names":["timeoutId: ReturnType<typeof setTimeout> | null"],"sources":["../../../../helpers/src/debounce.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0
|
|
1
|
+
{"version":3,"file":"debounce.mjs","names":["timeoutId: ReturnType<typeof setTimeout> | null"],"sources":["../../../../helpers/src/debounce.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/stryke\n Documentation: https://docs.stormsoftware.com/projects/stryke\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport interface DebounceOptions {\n signal?: AbortSignal;\n}\n\n/**\n * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds\n * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`\n * method to cancel any pending execution.\n *\n * @example\n * ```typescript\n * const debouncedFunction = debounce(() => {\n * console.log('Function executed');\n * }, 1000);\n *\n * // Will log 'Function executed' after 1 second if not called again in that time\n * debouncedFunction();\n *\n * // Will not log anything as the previous call is canceled\n * debouncedFunction.cancel();\n *\n * // With AbortSignal\n * const controller = new AbortController();\n * const signal = controller.signal;\n * const debouncedWithSignal = debounce(() => {\n * console.log('Function executed');\n * }, 1000, { signal });\n *\n * debouncedWithSignal();\n *\n * // Will cancel the debounced function call\n * controller.abort();\n * ```\n *\n * @param func - The function to debounce\n * @param debounceMs - The number of milliseconds to delay\n * @param options - Optional configuration for the debounced function, including an AbortSignal to cancel the debounce\n * @returns A new debounced function with a `cancel` method.\n */\nexport function debounce<F extends (...args: any[]) => void>(\n func: F,\n debounceMs: number,\n options: DebounceOptions = {}\n): F & { cancel: () => void } {\n let timeoutId: ReturnType<typeof setTimeout> | null = null;\n const { signal } = options;\n\n const debounced = ((...args: Parameters<F>) => {\n if (timeoutId !== null) {\n clearTimeout(timeoutId);\n }\n\n if (signal?.aborted) {\n return;\n }\n\n timeoutId = setTimeout(() => {\n func(...args);\n timeoutId = null;\n }, debounceMs);\n }) as F & { cancel: () => void };\n\n const onAbort = () => {\n debounced.cancel();\n };\n\n debounced.cancel = () => {\n if (timeoutId !== null) {\n clearTimeout(timeoutId);\n timeoutId = null;\n }\n };\n\n signal?.addEventListener(\"abort\", onAbort, { once: true });\n\n return debounced;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDA,SAAgB,SACd,MACA,YACA,UAA2B,EAAE,EACD;CAC5B,IAAIA,YAAkD;CACtD,MAAM,EAAE,WAAW;CAEnB,MAAM,cAAc,GAAG,SAAwB;AAC7C,MAAI,cAAc,KAChB,cAAa,UAAU;AAGzB,MAAI,QAAQ,QACV;AAGF,cAAY,iBAAiB;AAC3B,QAAK,GAAG,KAAK;AACb,eAAY;KACX,WAAW;;CAGhB,MAAM,gBAAgB;AACpB,YAAU,QAAQ;;AAGpB,WAAU,eAAe;AACvB,MAAI,cAAc,MAAM;AACtB,gBAAa,UAAU;AACvB,eAAY;;;AAIhB,SAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,MAAM,CAAC;AAE1D,QAAO"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"throttle.mjs","names":["lastCallTime: number | null"],"sources":["../../../../helpers/src/throttle.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0
|
|
1
|
+
{"version":3,"file":"throttle.mjs","names":["lastCallTime: number | null"],"sources":["../../../../helpers/src/throttle.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/stryke\n Documentation: https://docs.stormsoftware.com/projects/stryke\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\n/**\n * Creates a throttled function that only invokes the provided function at most once\n * per every `throttleMs` milliseconds. Subsequent calls to the throttled function\n * within the wait time will not trigger the execution of the original function.\n *\n * @example\n * ```typescript\n * const throttledFunction = throttle(() => {\n * console.log('Function executed');\n * }, 1000);\n *\n * // Will log 'Function executed' immediately\n * throttledFunction();\n *\n * // Will not log anything as it is within the throttle time\n * throttledFunction();\n *\n * // After 1 second\n * setTimeout(() => {\n * throttledFunction(); // Will log 'Function executed'\n * }, 1000);\n * ```\n *\n * @param func - The function to throttle.\n * @param throttleMs - The number of milliseconds to throttle executions to.\n * @returns A new throttled function that accepts the same parameters as the original function.\n */\nexport function throttle<F extends (...args: any[]) => void>(\n func: F,\n throttleMs: number\n): F {\n let lastCallTime: number | null;\n\n const throttledFunction = ((...args: Parameters<F>) => {\n const now = Date.now();\n\n if (lastCallTime == null || now - lastCallTime >= throttleMs) {\n lastCallTime = now;\n func(...args);\n }\n }) as F;\n\n return throttledFunction;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,SAAgB,SACd,MACA,YACG;CACH,IAAIA;CAEJ,MAAM,sBAAsB,GAAG,SAAwB;EACrD,MAAM,MAAM,KAAK,KAAK;AAEtB,MAAI,gBAAgB,QAAQ,MAAM,gBAAgB,YAAY;AAC5D,kBAAe;AACf,QAAK,GAAG,KAAK;;;AAIjB,QAAO"}
|
|
@@ -8,9 +8,9 @@ const isEqual = (x, y) => {
|
|
|
8
8
|
const keysX = Reflect.ownKeys(x);
|
|
9
9
|
const keysY = Reflect.ownKeys(y);
|
|
10
10
|
if (keysX.length !== keysY.length) return false;
|
|
11
|
-
for (const
|
|
12
|
-
if (!Reflect.has(y,
|
|
13
|
-
if (!isEqual(x[
|
|
11
|
+
for (const element of keysX) {
|
|
12
|
+
if (!Reflect.has(y, element)) return false;
|
|
13
|
+
if (!isEqual(x[element], y[element])) return false;
|
|
14
14
|
}
|
|
15
15
|
return true;
|
|
16
16
|
};
|
|
@@ -7,9 +7,9 @@ const isEqual = (x, y) => {
|
|
|
7
7
|
const keysX = Reflect.ownKeys(x);
|
|
8
8
|
const keysY = Reflect.ownKeys(y);
|
|
9
9
|
if (keysX.length !== keysY.length) return false;
|
|
10
|
-
for (const
|
|
11
|
-
if (!Reflect.has(y,
|
|
12
|
-
if (!isEqual(x[
|
|
10
|
+
for (const element of keysX) {
|
|
11
|
+
if (!Reflect.has(y, element)) return false;
|
|
12
|
+
if (!isEqual(x[element], y[element])) return false;
|
|
13
13
|
}
|
|
14
14
|
return true;
|
|
15
15
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"is-equal.mjs","names":[],"sources":["../../../../type-checks/src/is-equal.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/stryke\n Documentation: https://docs.stormsoftware.com/projects/stryke\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport const isEqual = <TType>(x: TType, y: TType): boolean => {\n if (Object.is(x, y)) return true;\n if (x instanceof Date && y instanceof Date) {\n return x.getTime() === y.getTime();\n }\n if (x instanceof RegExp && y instanceof RegExp) {\n return x.toString() === y.toString();\n }\n if (\n typeof x !== \"object\" ||\n x === null ||\n typeof y !== \"object\" ||\n y === null\n ) {\n return false;\n }\n const keysX = Reflect.ownKeys(x as unknown as object) as (keyof typeof x)[];\n const keysY = Reflect.ownKeys(y as unknown as object);\n if (keysX.length !== keysY.length) return false;\n for (const
|
|
1
|
+
{"version":3,"file":"is-equal.mjs","names":[],"sources":["../../../../type-checks/src/is-equal.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/stryke\n Documentation: https://docs.stormsoftware.com/projects/stryke\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport const isEqual = <TType>(x: TType, y: TType): boolean => {\n if (Object.is(x, y)) return true;\n if (x instanceof Date && y instanceof Date) {\n return x.getTime() === y.getTime();\n }\n if (x instanceof RegExp && y instanceof RegExp) {\n return x.toString() === y.toString();\n }\n if (\n typeof x !== \"object\" ||\n x === null ||\n typeof y !== \"object\" ||\n y === null\n ) {\n return false;\n }\n\n const keysX = Reflect.ownKeys(x as unknown as object) as (keyof typeof x)[];\n const keysY = Reflect.ownKeys(y as unknown as object) as (keyof typeof y)[];\n if (keysX.length !== keysY.length) return false;\n for (const element of keysX) {\n if (!Reflect.has(y as unknown as object, element)) return false;\n if (!isEqual(x[element], y[element])) return false;\n }\n return true;\n};\n"],"mappings":";AAkBA,MAAa,WAAkB,GAAU,MAAsB;AAC7D,KAAI,OAAO,GAAG,GAAG,EAAE,CAAE,QAAO;AAC5B,KAAI,aAAa,QAAQ,aAAa,KACpC,QAAO,EAAE,SAAS,KAAK,EAAE,SAAS;AAEpC,KAAI,aAAa,UAAU,aAAa,OACtC,QAAO,EAAE,UAAU,KAAK,EAAE,UAAU;AAEtC,KACE,OAAO,MAAM,YACb,MAAM,QACN,OAAO,MAAM,YACb,MAAM,KAEN,QAAO;CAGT,MAAM,QAAQ,QAAQ,QAAQ,EAAuB;CACrD,MAAM,QAAQ,QAAQ,QAAQ,EAAuB;AACrD,KAAI,MAAM,WAAW,MAAM,OAAQ,QAAO;AAC1C,MAAK,MAAM,WAAW,OAAO;AAC3B,MAAI,CAAC,QAAQ,IAAI,GAAwB,QAAQ,CAAE,QAAO;AAC1D,MAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAE,QAAO;;AAE/C,QAAO"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stryke/hooks",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.79",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A package containing shared hooks that can be used in any React UI project",
|
|
6
6
|
"repository": {
|
|
@@ -106,5 +106,5 @@
|
|
|
106
106
|
"react-native": { "optional": true }
|
|
107
107
|
},
|
|
108
108
|
"publishConfig": { "access": "public" },
|
|
109
|
-
"gitHead": "
|
|
109
|
+
"gitHead": "ad0acb8f9d34c16300a0901dd4db448756480415"
|
|
110
110
|
}
|