Merge pull request #22 from tristonarmstrong/chore/type-docs

chore(useEffect): add jsdoc to useffect for type hints
CrimsonChi · Oct 13, 2024 · acaa414 · acaa414
2 parents 655edd8 + 631f19a
commit acaa414
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/lib/src/hooks/useEffect.ts b/packages/lib/src/hooks/useEffect.ts
@@ -5,6 +5,12 @@ import {
   useHook,
 } from "./utils.js"
 
+/**
+ * Runs a function after the component is rendered, or when a value provided in the optional [dependency
+ * array](https://kaioken.dev/docs/hooks/dependency-arrays) has changed.
+ *
+ * [Kaioken Reference](https://kaioken.dev/docs/hooks/useEffect)
+ * */
 export function useEffect(
   callback: () => void | (() => void),
   deps?: unknown[]