Function coalesceOnRejection

Executes an asynchronous function and resolves with an alternative result in case the function failed.

coalesceOnRejection<
    TExecutableReturn,
    TCoalesce,
    TFilter extends ConstructorOf<Error>,
>(
    executable: AnyFunctionReturning<
        TExecutableReturn
        | Promise<TExecutableReturn>,
    >,
    to: TCoalesce,
    filter?: TFilter,
): Promise<TExecutableReturn | TCoalesce>
Type Parameters
- TExecutableReturn
  The return type of the function.
- TCoalesce
  The type of the object to coalesce to.
- TFilter extends ConstructorOf<Error>
  The type of the error filter.
Parameters
- executable: AnyFunctionReturning<TExecutableReturn | Promise<TExecutableReturn>>
  The asynchronous function to execute.
- to: TCoalesce
  The result we want to return when the function errors.
- Optionalfilter: TFilter
  An Error subclass. If defined, only errors of this type will be coalesced.
Returns Promise<TExecutableReturn | TCoalesce>
Whatever the function resolved to, or the provided replacement, in case the function failed.
- Defined in source/async/async.ts:39