Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 | 47x 225x 2x 223x 85x 138x 542x 19x 138x 138x 138x 13x 7x 6x 138x 548x 548x 138x 29x 29x 29x 109x 109x 47x 125x 229x 88x 88x 88x 9x 75x 88x 141x 141x 125x 125x 109x 3x 106x 106x 125x 47x 581x 581x 581x 581x 581x 581x 581x 69x 15x 15x 15x 21x 21x 512x 581x 47x 28x 47x 47x 2x 47x 35x 35x 25x 25x 7x 18x 34x 2x 32x 32x 32x 32x 32x 11x 17x 15x 2x 4x 35x | import { errorify } from '../converter/errorify.ts';
import { isNotNullable } from './is-not-nullable.ts';
/**
* A resource that can be closed synchronously.
*
* Objects implementing this interface provide a `close()` method that performs cleanup operations immediately and
* returns `void`. This is typically used for resources that don't require asynchronous operations during cleanup, such
* as event listeners, timers, or simple state cleanup.
*
* The closable protocol expects that a single invocation of close is sufficient to perform all required operations
* (such as releasing resources), and that additional calls to close are safe and have no effect.
*/
export type SyncClosable = {
/**
* Performs synchronous cleanup operations, returning immediately after invoked.
*/
readonly close: () => void;
};
/**
* A resource that can be closed asynchronously.
*
* Objects implementing this interface provide a `close()` method that returns a `Promise<void>`. This is typically used
* for resources that require asynchronous operations during cleanup, such as file handles, database connections, or
* network resources.
*
* The closable protocol expects that a single invocation of close is sufficient to perform all required operations
* (such as releasing resources), and that additional calls to close are safe and have no effect.
*/
export type AsyncClosable = {
/**
* Performs asynchronous cleanup operations, returning a promise that resolves when the cleanup is complete.
*/
readonly close: () => Promise<void>;
};
/**
* A resource that can be closed either synchronously or asynchronously.
*
* This union type represents any closable resource, whether it requires synchronous or asynchronous cleanup. It's the
* most flexible type for accepting closable resources when the cleanup method is not known in advance.
*
* The closable protocol expects that a single invocation of close is sufficient to perform all required operations
* (such as releasing resources), and that additional calls to close are safe and have no effect.
*/
export type Closable = SyncClosable | AsyncClosable;
/**
* Closes all provided closables, returning a promise if at least one closable is asynchronous.
*
* This function ensures all closables are properly closed even if some throw errors during cleanup. Errors from
* individual closables are accumulated and then thrown (for synchronous closables) or rejected (for asynchronous
* closables) after all cleanup operations complete.
*
* The return type is automatically inferred based on the types of the provided closables:
*
* - All synchronous closables → returns `void`
* - Any asynchronous closables → returns `Promise<void>`
* - Ambiguous types → defaults to `Promise<void>` for safety
*
* @example Synchronous closables
*
* ```ts
* import { closeAll } from 'emitnlog/utils';
*
* const fileHandle = { close: () => console.log('File closed') };
* const eventListener = { close: () => console.log('Listener removed') };
*
* closeAll(fileHandle, eventListener); // Returns void immediately
* ```
*
* @example Mixed synchronous and asynchronous closables
*
* ```ts
* import { closeAll } from 'emitnlog/utils';
*
* const timer = { close: () => clearInterval(timerId) };
* const dbConnection = { close: async () => await db.disconnect() };
*
* await closeAll(timer, dbConnection); // Returns Promise<void>
* ```
*
* @example Error handling with single error
*
* ```ts
* import { closeAll } from 'emitnlog/utils';
*
* const failing = {
* close: () => {
* throw new Error('Cleanup failed');
* },
* };
* const working = { close: () => console.log('Cleaned up successfully') };
*
* try {
* closeAll(failing, working);
* } catch (error) {
* console.log(error.message); // 'Cleanup failed'
* // Both closables were called, but error was thrown after all completed
* }
* ```
*
* @example Error handling with multiple errors
*
* ```ts
* import { closeAll } from 'emitnlog/utils';
*
* const failing1 = {
* close: () => {
* throw new Error('First error');
* },
* };
* const failing2 = {
* close: async () => {
* throw new Error('Second error');
* },
* };
*
* try {
* await closeAll(failing1, failing2);
* } catch (error) {
* console.log(error.message); // 'Multiple errors occurred while closing closables'
* console.log(error.cause); // Array containing both Error objects
* }
* ```
*
* @param closables - The closables to close
* @returns `void` if all closables are synchronous, `Promise<void>` if any are asynchronous
* @throws {Error} Single error if only one closable fails, or aggregate error with `cause` array if multiple fail
*/
export const closeAll = <T extends readonly ClosableLike[]>(...closables: T): CloseAllReturn<T> => {
if (closables.length === 0) {
return undefined as CloseAllReturn<T>;
}
if (closables.length === 1) {
return closables[0].close?.() as CloseAllReturn<T>;
}
const errors: Error[] = [];
const onError = (index: number) => (error: unknown) => {
errors[index] = errorify(error);
};
const handleErrors = () => {
const prunedErrors = errors.filter(isNotNullable);
if (prunedErrors.length) {
if (prunedErrors.length === 1) {
throw prunedErrors[0];
}
throw new Error('Multiple errors occurred while closing closables', { cause: prunedErrors });
}
};
const promises: Promise<void>[] = closables
.map((closable, index): unknown => closable.close && asSafeClosable(closable as Closable, onError(index)).close())
.filter((result): result is Promise<void> => result instanceof Promise);
if (promises.length) {
return Promise.all(promises).then(() => {
handleErrors();
return undefined;
}) as CloseAllReturn<T>;
}
handleErrors();
return undefined as CloseAllReturn<T>;
};
/**
* Creates a single closable from one or more cleanup operations.
*
* This function serves two purposes:
*
* 1. It transforms individual cleanup functions (or objects with optional `close` methods) into proper closables.
* 2. It groups multiple such inputs into a single closable that performs all cleanup steps in order.
*
* All inputs are normalized to proper closables and closed when the returned `close()` is invoked. Errors are
* accumulated and handled using the same strategy as {@link closeAll}.
*
* The returned closable guarantees:
*
* - It can be called only once (subsequent calls are no-ops).
* - The return type of `close()` matches the most flexible input:
*
* - All synchronous inputs → returns `SyncClosable`
* - Any asynchronous input → returns `AsyncClosable`
* - Ambiguous → defaults to `AsyncClosable` for safety
*
* See {@link createCloser} for a more convenient way to create a "live closable" that can be used to accumulate
* closables as they are instantiated.
*
* @example Creating a closable from a single function
*
* ```ts
* import { asClosable } from 'emitnlog/utils';
*
* const timerCleanup = () => clearTimeout(timerId);
* const closable = asClosable(timerCleanup);
* closable.close(); // Runs the cleanup
* ```
*
* @example Combining multiple cleanup steps
*
* ```ts
* import { asClosable } from 'emitnlog/utils';
*
* const db = { close: async () => await disconnect() };
* const file = { close: () => console.log('Closed file') };
* const cleanup = () => console.log('Manual cleanup');
*
* const combined = asClosable(db, file, cleanup);
* await combined.close(); // Closes all in order
* ```
*
* @example Error handling
*
* ```ts
* import { asClosable } from 'emitnlog/utils';
*
* const failing = () => {
* throw new Error('Cleanup failed');
* };
* const working = () => console.log('Success');
*
* const combined = asClosable(failing, working);
*
* try {
* combined.close();
* } catch (error) {
* console.log(error.message); // 'Cleanup failed'
* // Both functions were called despite the error
* }
* ```
*
* @param input - One or more functions, closables, or partial closables to wrap
* @returns A closable that closes all specified inputs when `close()` is called
*/
export const asClosable = <T extends readonly ClosableLikeOrFunction[]>(...input: T): AsClosableReturn<T> => {
const closables: readonly Closable[] = input
.map((i): Closable | undefined => {
if (typeof i === 'function') {
const closable: Closable = {
close: () => {
const value = i();
if (value instanceof Promise) {
return value.then(() => undefined);
}
return undefined;
},
};
return closable;
}
Iif (!i.close) {
return undefined;
}
return i as Closable;
})
.filter(isNotNullable);
let closed = false;
const combined: Closable = {
close: () => {
if (closed) {
return undefined;
}
closed = true;
return closeAll(...closables);
},
};
return combined as AsClosableReturn<T>;
};
/**
* Wraps a closable to prevent errors during `close()` from propagating.
*
* This utility creates a "safe" version of a closable that catches both synchronous throws and asynchronous rejections
* during the close operation. If an error occurs, the optional `onError` callback is invoked with the error, and the
* error is then swallowed (the close operation completes normally).
*
* This is particularly useful for ensuring cleanup operations never fail, which is important in scenarios like
* application shutdown, resource cleanup chains, or when combining multiple closables with {@link asClosable} or
* {@link closeAll}.
*
* @example Basic usage
*
* ```ts
* import { asSafeClosable } from 'emitnlog/utils';
*
* const failing = {
* close: () => {
* throw new Error('Will be ignored');
* },
* };
* const silent = asSafeClosable(failing);
* silent.close(); // Error is silently swallowed
* ```
*
* @example Basic usage with error handling
*
* ```ts
* import { createConsoleLogLogger } from 'emitnlog/logger';
* import { asSafeClosable } from 'emitnlog/utils';
*
* const unreliableResource = {
* close: () => {
* throw new Error('Cleanup failed');
* },
* };
*
* const logger = createConsoleLogLogger();
* const safeResource = asSafeClosable(unreliableResource, (error) => {
* logger.w`Cleanup error: ${error}'`;
* });
*
* safeResource.close(); // Never throws, logs warning instead
* ```
*
* @example With asynchronous closables
*
* ```ts
* import { asSafeClosable } from 'emitnlog/utils';
*
* const asyncResource = {
* close: async () => {
* throw new Error('Async cleanup failed');
* },
* };
*
* const safeAsync = asSafeClosable(asyncResource, (error) => {
* console.error('Async cleanup error:', error);
* });
*
* await safeAsync.close(); // Never rejects, logs error instead
* ```
*
* @example Combining with asClosable for robust cleanup
*
* ```ts
* import { asClosable, asSafeClosable } from 'emitnlog/utils';
*
* const robustCleanup = asClosable(
* asSafeClosable(riskyResource1),
* asSafeClosable(riskyResource2),
* asSafeClosable(riskyResource3),
* );
*
* await robustCleanup.close(); // Guaranteed to not throw/reject
* ```
*
* @param closable - The closable to wrap with error protection
* @param onError - Optional callback invoked when an error occurs during close
* @returns A closable that never throws or rejects, matching the sync/async nature of the input
*/
export const asSafeClosable = <C extends ClosableLike>(
closable: C,
onError?: (error: unknown) => void,
): IsElementAsync<C> extends true ? AsyncClosable : SyncClosable => {
let closed = false;
const safe = {
close: () => {
Iif (closed) {
return undefined;
}
closed = true;
try {
const value = closable.close?.();
if (value instanceof Promise) {
return value.catch((error: unknown) => {
try {
onError?.(error);
} catch {
// ignore
}
return undefined;
});
}
} catch (error) {
try {
onError?.(error);
} catch {
// ignore
}
}
return undefined;
},
};
return safe as IsElementAsync<C> extends true ? AsyncClosable : SyncClosable;
};
/**
* Closes a closable safely, preventing errors from propagating.
*
* This function is a convenience wrapper around {@link asSafeClosable} that returns a promise that resolves when the
* closable is closed. The return is always a promise, even if the closable is a synchronous.
*
* @param closable The closable to wrap with error protection
* @param onError Optional callback invoked when an error occurs during close
* @returns A promise that resolves when the close operation is done and never rejects (or throws).
*/
export const safeClose = <C extends ClosableLike>(closable: C, onError?: (error: unknown) => void): Promise<void> =>
Promise.resolve().then(() => asSafeClosable(closable, onError).close());
/**
* A container for managing multiple closables with a single `close()` call.
*
* This utility type represents a composite closable that accumulates other closables over time via the `add()` method.
* Once `close()` is called, all registered closables are closed in reverse order, and the internal collection is
* cleared. Any subsequent calls to `add()` are still allowed, but the already-closed closables will not be invoked
* again.
*
* Useful for ensuring cleanup logic is always executed, even in complex control flows with multiple return points.
*/
export type Closer = AsyncClosable & {
/**
* Adds a closable to be handled when the closer is closed.
*
* @param closable
* @returns The closable
*/
readonly add: <T extends ClosableLike>(closable: T) => T;
/**
* Adds multiple closables to be handled when the closer is closed.
*
* @param closables
*/
readonly addAll: (...closables: readonly ClosableLike[]) => void;
/**
* The number of closables that have not been closed.
*/
readonly size: number;
// Review SyncClosable after changing Closer.
};
/**
* A container for managing multiple synchronous closables with a single `close()` call.
*
* This utility type represents a composite closable that accumulates other synchronous closables over time via the
* `add()` method. Once `close()` is called, all registered closables are closed in reverse order, and the internal
* collection is cleared. Any subsequent calls to `add()` are still allowed, but the already-closed closables will not
* be invoked again.
*
* Useful for ensuring cleanup logic is always executed, even in complex control flows with multiple return points.
*/
export type SyncCloser = SyncClosable & {
/**
* Adds a closable to be handled when the closer is closed.
*
* @param closable
* @returns The closable
*/
readonly add: <T extends SyncClosable | PartialSyncClosable>(closable: T) => T;
/**
* Adds multiple closables to be handled when the closer is closed.
*
* @param closables
*/
readonly addAll: (...closables: readonly (SyncClosable | PartialSyncClosable)[]) => void;
/**
* The number of closables that have not been closed.
*/
readonly size: number;
};
/**
* Creates a `Closer` that manages a group of closables as a single unit, simplifying resource management— especially in
* functions with multiple return points or error paths.
*
* The returned object allows you to register closables via `add()`, and later invoke `close()` once to clean them all
* up. Closables are executed in reverse order of registration (last in, first closed), which is useful when resources
* depend on each other.
*
* After `close()` is called:
*
* - The internal list is cleared, so previously added closables won't be called again.
* - Further `add()` calls are still allowed and track newly added closables.
* - A subsequent call to `close()` will only affect those new closables.
*
* Any errors thrown or rejected by the closables are accumulated and handled using the same strategy as
* {@link closeAll}.
*
* The difference between this utility and {@link asClosable} is that the object returned here is a "live closable" that
* can be used to accumulate closables as they are instantiated, whereas `asClosable` is meant to be a "one time"
* utility that produces a single closable. Additionally, `closer.add(...)` preserves and returns the original
* closable’s type, making it easier to work with typed resources.
*
* @example Basic usage
*
* ```ts
* import type { Logger } from 'emitnlog/logger';
* import { createConsoleByLevelLogger } from 'emitnlog/logger';
* import { asClosable, createCloser } from 'emitnlog/utils';
*
* const closer = createCloser();
*
* if (enableDB) {
* const db: DB = closer.add(asClosable(() => disconnect()));
* ...
* }
*
* const logger: Logger = closer.add(createConsoleByLevelLogger());
*
* // When needed...
* await closer.close(); // Closes logger first, then db
* ```
*
* @param input - Optional initial set of closables
* @returns A `Closer` that can register and close closables as a group
*/
export const createCloser = (...input: readonly ClosableLike[]): Closer => createBasicCloser(true, ...input) as Closer;
/**
* A version of {@link createCloser} to be used with synchronous closables.
*
* @param input - Optional initial set of closables
* @returns A `SyncCloser` that can register and close closables as a group
* @returns
*/
export const createSyncCloser = (...input: readonly SyncClosable[]): SyncCloser =>
createBasicCloser(false, ...input) as SyncCloser;
type BasicCloser = Omit<Closer, 'close'> & Closable;
const createBasicCloser = (forceAsync: boolean, ...input: readonly ClosableLike[]): BasicCloser => {
const closables = new Set<ClosableLike>(input);
const closer: BasicCloser = {
add: (closable) => {
closables.add(closable);
return closable;
},
addAll: (...all) => {
all.forEach((closable) => closables.add(closable));
},
get size() {
return closables.size;
},
close: () => {
if (!closables.size) {
return forceAsync ? Promise.resolve() : undefined;
}
const array = Array.from(closables).reverse();
closables.clear();
try {
const result = closeAll(...array);
if (result instanceof Promise) {
return result;
}
if (forceAsync) {
return Promise.resolve();
}
return undefined;
} catch (error) {
return forceAsync ? Promise.reject(errorify(error)) : errorify(error);
}
},
};
return closer;
};
type PartialSyncClosable = Partial<SyncClosable>;
type PartialAsyncClosable = Partial<AsyncClosable>;
type ClosableLike = SyncClosable | PartialSyncClosable | AsyncClosable | PartialAsyncClosable;
type ClosableLikeOrFunction = ClosableLike | (() => unknown);
type IsElementAsync<E> = E extends () => infer R
? R extends Promise<unknown>
? true
: false
: E extends { readonly close: () => infer R }
? R extends Promise<unknown>
? true
: false
: E extends { readonly close?: () => infer R }
? R extends Promise<unknown>
? true
: false
: false;
type IsArrayAsync<A extends readonly ClosableLikeOrFunction[]> = A extends [
infer F extends ClosableLikeOrFunction,
...infer R extends readonly ClosableLikeOrFunction[],
]
? IsElementAsync<F> extends false
? R extends []
? false
: IsArrayAsync<R>
: true
: A extends readonly (infer Item extends ClosableLikeOrFunction)[]
? IsElementAsync<Item> extends false
? false
: true
: false;
// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
type CloseAllReturn<T extends readonly ClosableLike[]> = IsArrayAsync<T> extends true ? Promise<void> : void;
type AsClosableReturn<T extends readonly ClosableLikeOrFunction[]> =
IsArrayAsync<T> extends true ? AsyncClosable : SyncClosable;
|