Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface promiseUtils

Various utilities and convenience functions for working with promises.

Read more...

Hierarchy

  • promiseUtils

Index

Methods

create

  • create(executor: Executor): Promise<any>
  • Convenience utility method for creating and resolving a promise.

    Read more...

    Parameters

    Returns Promise<any>

createAbortError

  • createAbortError(): Error
  • Creates a special error object which is used to signal aborted requests in promise chains.

    Read more...

    Returns Error

debounce

  • debounce<T>(callback: T): T
  • A utility for ensuring an input function is not simultaneously invoked more than once at a time.

    Read more...

    Type parameters

    • T

    Parameters

    • callback: T

    Returns T

eachAlways

  • eachAlways(promises: any): any
  • Convenience utility method to wait for a number of promises to either resolve or reject.

    Read more...

    Parameters

    • promises: any

    Returns any

filter

  • A convenience utility method for filtering an array of values using an asynchronous predicate function.

    Read more...

    Type parameters

    • T

    Parameters

    Returns Promise<T[]>

isAbortError

  • isAbortError(error: Error): boolean
  • Check if the provided error object is the special kind of error with which promises are rejected when they are aborted.

    Read more...

    Parameters

    Returns boolean

reject

  • reject<T>(error?: any): Promise<T>
  • Convenience utility method to create a promise that has been rejected with a provided error value.

    Read more...

    Type parameters

    • T

    Parameters

    • Optional error: any

    Returns Promise<T>

resolve

  • resolve<T>(value?: T): Promise<T>
  • Convenience utility method to create a promise that will be resolved with a provided value.

    Read more...

    Type parameters

    • T

    Parameters

    • Optional value: T

    Returns Promise<T>

Generated using TypeDoc