Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(useEffect): add jsdoc to useffect for type hints #22

Merged
merged 1 commit into from
Oct 13, 2024
Merged

chore(useEffect): add jsdoc to useffect for type hints #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/lib/src/hooks/useEffect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down