Type Alias ThrottledFunction<T>

ThrottledFunction: (
    ...args: Parameters<T>,
) => ReturnType<T> extends PromiseLike<infer Return>
    ? Promise<Return>
    : Promise<ReturnType<T>> & {
    abort: (message?: string, dispose?: boolean) => void;
}

Type Parameters

  • T extends (...args: any[]) => any

Type declaration

    • (
          ...args: Parameters<T>,
      ): ReturnType<T> extends PromiseLike<infer Return>
          ? Promise<Return>
          : Promise<ReturnType<T>>
    • Parameters

      • ...args: Parameters<T>

      Returns ReturnType<T> extends PromiseLike<infer Return>
          ? Promise<Return>
          : Promise<ReturnType<T>>

  • abort: (message?: string, dispose?: boolean) => void

    Abort pending executions. All unresolved promises are rejected with a AbortError error.