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.

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

[useTimeoutFn] immediate in the documentation is different from the code #119

Closed
nnecec opened this issue Dec 8, 2024 · 3 comments · Fixed by #120
Closed

[useTimeoutFn] immediate in the documentation is different from the code #119

nnecec opened this issue Dec 8, 2024 · 3 comments · Fixed by #120

Comments

@nnecec
Copy link
Contributor

nnecec commented Dec 8, 2024

The default value for immediate in the documentation is false, but the default value in the code is true.

documentation: https://www.reactuse.com/effect/useTimeoutFn#usetimeoutfnoptions

code implementation: https://github.com/childrentime/reactuse/blob/main/packages/core/src/useTimeoutFn/index.ts#L20

@childrentime
Copy link
Owner

Sorry for that. Do you want to open a pr to fix docs? just modify the interface.ts near to index.ts

@nnecec
Copy link
Contributor Author

nnecec commented Dec 8, 2024

Do we need to set the immediate default to true?

@childrentime
Copy link
Owner

Yeah

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants