From 631f19a92326f4b30de59f17c8e17b57d4c0376f Mon Sep 17 00:00:00 2001 From: Triston Armstrong Date: Sat, 12 Oct 2024 07:49:25 -0400 Subject: [PATCH] chore(useEffect): add jsdoc to useffect for type hints --- packages/lib/src/hooks/useEffect.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/lib/src/hooks/useEffect.ts b/packages/lib/src/hooks/useEffect.ts index 6b939080..5151a787 100644 --- 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[]