use-async-effekt-hooks
Version:
React hooks for async effects and memoization with proper dependency tracking and linting support
184 lines (183 loc) • 8.26 kB
JavaScript
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
import { useEffect, useRef } from "react";
/**
* A hook for handling async effects with proper dependency tracking and cleanup management.
* The name is intentionally spelled with "k" to work correctly with react-hooks/exhaustive-deps ESLint rule.
*
* @param effect - An async function to execute. Receives an object with:
* - `isMounted`: Function to check if the component is still mounted
* - `waitForPrevious`: Function that returns a Promise to wait for the previous effect and its cleanup to complete
*
* The effect function can optionally return a cleanup function that can be either synchronous or asynchronous.
*
* @param deps - Dependency array for the effect (same as useEffect)
*
* @example
* // Basic usage without waiting for previous effects
* useAsyncEffekt(async ({ isMounted }) => {
* const data = await fetchData();
* if (isMounted()) {
* setData(data);
* }
* }, []);
*
* @example
* // Usage with waiting for previous effect to complete
* useAsyncEffekt(async ({ isMounted, waitForPrevious }) => {
* await waitForPrevious(); // Wait for previous effect and cleanup
* const data = await fetchData();
* if (isMounted()) {
* setData(data);
* }
* }, [dependency]);
*
* @example
* // Usage with synchronous cleanup
* useAsyncEffekt(async ({ isMounted }) => {
* const subscription = await createSubscription();
*
* return () => {
* subscription.unsubscribe(); // Sync cleanup
* };
* }, []);
*
* @example
* // Usage with asynchronous cleanup
* useAsyncEffekt(async ({ isMounted }) => {
* const connection = await establishConnection();
*
* return async () => {
* await connection.close(); // Async cleanup
* };
* }, []);
*
* @example
* // Complex usage with waiting and async cleanup
* useAsyncEffekt(async ({ isMounted, waitForPrevious }) => {
* await waitForPrevious(); // Ensure previous effect is fully cleaned up
*
* const resource = await acquireResource();
* if (isMounted()) {
* setResource(resource);
* }
*
* return async () => {
* await resource.cleanup(); // Async cleanup
* };
* }, [resourceId]);
*/
export function useAsyncEffekt(effect, deps) {
var _this = this;
var isMountedRef = useRef(true);
// Track the promise chain of all previous effects and their cleanups
var lastEffectChainRef = useRef(Promise.resolve());
useEffect(function () {
isMountedRef.current = true;
var cleanup;
var cleanupResolver = null;
// Capture the current chain to wait for
var previousEffectChain = lastEffectChainRef.current;
// Create a promise that resolves when this effect's cleanup is complete
var cleanupPromise = new Promise(function (resolve) {
cleanupResolver = resolve;
});
var executeEffect = function () { return __awaiter(_this, void 0, void 0, function () {
var error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, effect({
isMounted: function () { return isMountedRef.current; },
waitForPrevious: function () { return previousEffectChain; },
})];
case 1:
cleanup = _a.sent();
return [3 /*break*/, 3];
case 2:
error_1 = _a.sent();
if (isMountedRef.current) {
console.error("useAsyncEffekt error:", error_1);
}
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); };
// Create the current effect promise
var currentEffectPromise = executeEffect();
// Update the chain to include both current effect and its future cleanup
lastEffectChainRef.current = currentEffectPromise.then(function () { return cleanupPromise; });
return function () {
isMountedRef.current = false;
// Trigger cleanup and resolve the cleanup promise
currentEffectPromise
.then(function () { return __awaiter(_this, void 0, void 0, function () {
var error_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!cleanup)
return [2 /*return*/];
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, cleanup()];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
error_2 = _a.sent();
console.error("useAsyncEffekt cleanup error:", error_2);
return [3 /*break*/, 4];
case 4: return [2 /*return*/];
}
});
}); })
.catch(function () {
// Effect already failed, no cleanup needed
})
.then(function () {
// Resolve the cleanup promise to signal completion
if (cleanupResolver) {
cleanupResolver();
}
});
};
}, deps);
}