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

[react] Remove timeoutMs mentions from JSDoc #60567

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions types/react/index.d.ts
Expand Up @@ -1117,7 +1117,7 @@ declare namespace React {
}

/**
* Returns a deferred version of the value that may “lag behind” it for at most `timeoutMs`.
* Returns a deferred version of the value that may “lag behind” it.
*
* This is commonly used to keep the interface responsive when you have something that renders immediately
* based on user input and something that needs to wait for a data fetch.
Expand All @@ -1141,9 +1141,7 @@ declare namespace React {
* The first is a boolean, React’s way of informing us whether we’re waiting for the transition to finish.
* The second is a function that takes a callback. We can use it to tell React which state we want to defer.
*
* **If some state update causes a component to suspend, that state update should be wrapped in a transition.**
*
* @param config An optional object with `timeoutMs`
* **If some state update causes a component to suspend, that state update should be wrapped in a transition.**`
*
* @see https://reactjs.org/docs/concurrent-mode-reference.html#usetransition
*/
Expand Down