+ useDepEffect alias for useEffect2

! missing dependency: `@ezez/utils`
dzek69 · Mar 4, 2024 · 0ad510e · 0ad510e
1 parent 64d016e
commit 0ad510e
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [UNRELEASED]
 (nothing yet)
 
+## [2.1.0] - 2024-03-03
+### Added
+- `useDepEffect` alias for `useEffect2`
+### Fixed
+- missing dependency: `@ezez/utils`
+
 ## [2.0.0] - 2023-12-30
 ### Breaking
 - `useEffect2` will trigger the callback whenever the dependency array size change, this is different from `useEffect`,

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ezez/hooks",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "repository": "[email protected]:dzek69/ezez-hooks.git",
   "author": "Jacek Nowacki",
   "license": "MIT",
@@ -33,6 +33,7 @@
   "types": "./esm/index.d.ts",
   "module": "./esm/index.js",
   "dependencies": {
+    "@ezez/utils": "^1.9.0",
     "oop-timers": "^5.0.0"
   },
   "devDependencies": {
@@ -44,7 +45,6 @@
     "@dzek69/eslint-config-import-typescript": "^1.0.1",
     "@dzek69/eslint-config-react": "^1.2.2",
     "@dzek69/eslint-config-typescript": "^1.1.1",
-    "@ezez/utils": "^1.9.0",
     "@knodes/typedoc-plugin-pages": "^0.23.4",
     "@types/jest": "^29.5.2",
     "@types/react": "^18.2.8",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/pages/_app.tsx b/src/pages/_app.tsx
@@ -9,7 +9,7 @@ import { InputDeviceProvider } from "../useInputDevice.js";
 const MyApp = ({ Component, pageProps }: AppProps) => (
     <>
         <Head>
-            <title>@ezez/utils</title>
+            <title>@ezez/hooks</title>
         </Head>
         <InputDeviceProvider>
             <Component {...pageProps} />

diff --git a/src/useEffect2.ts b/src/useEffect2.ts
@@ -19,6 +19,7 @@ const shallowCompareArrays = <T extends readonly any[]>(a: T, b: T) => { // esli
  * @param dependencies - array of dependencies
  *
  * @example
+ * ```typescript
  * const { isAdmin, name } = useUserData(); // isAdmin is boolean, name is string
  *
  * useEffect2((prev) => {
@@ -40,6 +41,7 @@ const shallowCompareArrays = <T extends readonly any[]>(a: T, b: T) => { // esli
  *     }
  *     alert(message);
  * }, [isAdmin, name] as const);
+ * ```
  */
 const useEffect2 = <P, T extends (Readonly<P[]>)>(
     // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
@@ -59,4 +61,5 @@ const useEffect2 = <P, T extends (Readonly<P[]>)>(
 
 export {
     useEffect2,
+    useEffect2 as useDepEffect,
 };