18 lines
679 B
TypeScript
18 lines
679 B
TypeScript
import { DependencyList } from 'react';
|
|
/**
|
|
* An _immediate_ effect that runs an effect callback when its dependency array
|
|
* changes. This is helpful for updates should must run during render, most
|
|
* commonly state derived from props; a more ergonomic version of https://reactjs.org/docs/hooks-faq.html#how-do-i-implement-getderivedstatefromprops
|
|
*
|
|
* ```ts
|
|
* function Example({ value }) {
|
|
* const [intermediaryValue, setValue] = useState(value);
|
|
*
|
|
* useImmediateUpdateEffect(() => {
|
|
* setValue(value)
|
|
* }, [value])
|
|
* ```
|
|
*/
|
|
declare function useImmediateUpdateEffect(effect: () => void, deps: DependencyList): void;
|
|
export default useImmediateUpdateEffect;
|