diff --git a/docs/functions/deferred.html b/docs/functions/deferred.html index 89124aa..08043ed 100644 --- a/docs/functions/deferred.html +++ b/docs/functions/deferred.html @@ -161,7 +161,7 @@

Type Parameters

Returns DeferredOut<T>

An object containing the promise, resolve, and reject functions.

-
DeferredOut<T>: {
    promise: Promise<T>;
    reject: ((reason?) => void);
    resolve: ((value) => void);
}

Represents a deferred promise, which exposes the resolve and reject functions.

Type Parameters

  • T

    The type of the value that the promise resolves to.

    -

Type declaration

  • promise: Promise<T>
  • reject: ((reason?) => void)
      • (reason?): void
      • Parameters

        • Optional reason: any

        Returns void

  • resolve: ((value) => void)
RetryOptions: {
    delay?: number;
}

Options for the retry function.

-

Type declaration

  • Optional delay?: number
TimeoutIn<T>: Promise<T>

Type alias for a promise of type T.

-

Type Parameters

  • T
TimeoutOut<T>: Promise<T>

Return type for the timeout function.

-

Type Parameters

  • T
ToFinally: (() => void | Promise<void>)

Type alias for a function that can optionally be executed after the promise resolves or rejects. It can return void or a Promise that resolves to void.

-

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

ToIn<T>: Promise<T>

Type alias for a promise of type T.

-

Type Parameters

  • T
ToOut<T>: [Error, null] | [null, T]

Type alias for the output of the to function. It can be either an array with an Error and null, or an array with null and the result of type T.

-

Type Parameters

  • T