Add TS Docs throws to constructor

2026-08-06 10:08:13 +00:00
parent 67c0239106
commit 44981839f8
1 changed files with 5 additions and 0 deletions
@@ -76,6 +76,11 @@ export class ExponentialBackoff {
     * @param options.baseDelay - Delay used as the basis for the first retry. Default: `1_000` ms.
     * @param options.growthRate - Multiplier applied to the delay after each attempt. Default: `2`.
     * @param options.jitter - Maximum proportional reduction subtracted from each delay (0–1). Default: `0.1`.
+     * 
+     * @throws An {@link ExponentialBackoffNumberNotFiniteError} if a provided option is not a finite number
+     * @throws An {@link ExponentialBackoffNumberOutOfBoundsError} if a provided option is out of bounds
+     * @throws An {@link ExponentialBackoffNumberTooSmallError} if a provided option is too small
+     * @throws An {@link ExponentialBackoffNonIntegerError} if a provided option is not an integer
     */
    constructor(options: Partial<ExponentialBackoffOptions> = {}) {
        this.#options = {