Clarify what useLatest is for

I was touching this file and noticed a chance to clean up this little TODO comment by swapping in our useLatest hook and giving it better documentation.
This commit is contained in:
Robin
2025-02-24 17:45:40 +07:00
parent 832a5aaf57
commit 9b59544db2
2 changed files with 16 additions and 21 deletions

View File

@@ -8,12 +8,13 @@ Please see LICENSE in the repository root for full details.
import { type RefObject, useRef } from "react";
export interface LatestRef<T> extends RefObject<T> {
current: T;
current: T; // Always defined, unlike RefObject["current"]
}
/**
* React hook that returns a ref containing the value given on the latest
* render.
* render. Useful for accessing the latest value of something in an effect or
* callback when you don't want reactivity.
*/
export function useLatest<T>(value: T): LatestRef<T> {
const ref = useRef<T>(value);