Files
v10/dist/default/utils/use-destroy.js

39 lines
1.3 KiB
JavaScript

"use client";
import { useLatestRef } from "./use-latest-ref.js";
import { useEffect, useRef } from "react";
//#region src/utils/use-destroy.ts
/**
* Destroy an instance on unmount, deferring destruction to survive React
* StrictMode's simulated unmount/re-mount cycle.
*
* StrictMode runs effects, then immediately runs cleanup, then re-runs
* effects — all synchronously. By deferring `destroy()` to a macrotask,
* the re-mount effect can cancel it before it fires.
*
* @param instance - Object with a `destroy()` method.
* @param setup - Optional setup called on first mount. Skipped on StrictMode
* re-mount since the previous setup was never torn down.
* @param teardown - Optional teardown called right before `destroy()` on real
* unmount. Skipped on StrictMode simulated unmount.
*/
function useDestroy(instance, setup, teardown) {
const pendingRef = useRef(null);
const setupRef = useLatestRef(setup);
const teardownRef = useLatestRef(teardown);
useEffect(() => {
if (pendingRef.current !== null) {
clearTimeout(pendingRef.current);
pendingRef.current = null;
} else setupRef.current?.();
return () => {
pendingRef.current = setTimeout(() => {
teardownRef.current?.();
instance.destroy();
}, 0);
};
}, [instance]);
}
//#endregion
export { useDestroy };
//# sourceMappingURL=use-destroy.js.map