mirror of
https://github.com/zoriya/v10.git
synced 2026-08-10 16:09:18 +00:00
22 lines
926 B
TypeScript
22 lines
926 B
TypeScript
//#region src/utils/use-destroy.d.ts
|
|
interface Destroyable {
|
|
destroy(): void;
|
|
}
|
|
/**
|
|
* 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.
|
|
*/
|
|
declare function useDestroy(instance: Destroyable, setup?: () => void, teardown?: () => void): void;
|
|
//#endregion
|
|
export { useDestroy };
|
|
//# sourceMappingURL=use-destroy.d.ts.map
|