@creejs/commons-retrier 2.1.6 → 2.1.8

package/types/policy/fixed-backoff.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @class FixedBackoff
+ */
+export default class FixedBackoff extends FixedInterval {
+    /**
+     * Creates a fixed backoff policy with optional jitter.
+     * @param {number} fixedInterval - The fixed interval between retries in milliseconds.
+     * @param {number} [jitter=500] - The maximum random jitter to add to the interval in milliseconds.
+     */
+    constructor(fixedInterval: number, jitter?: number);
+}
+export { FixedBackoff as FixedBackoffType };
+import FixedInterval from './fixed-interval-policy.js';

package/types/policy/linear-backoff.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @class LinearBackoff
+ */
+export default class LinearBackoff extends FixedIncreasePolicy {
+    /**
+     * Creates a linear backoff policy with optional jitter.
+     * @param {number} increasement - The base increasement value for backoff.
+     * @param {number} [jitter=500] - The maximum jitter value to add to backoff (default: 500).
+     */
+    constructor(increasement: number, jitter?: number);
+}
+export { LinearBackoff as LinearBackoffType };
+import FixedIncreasePolicy from './fixed-increase-policy.js';

package/types/policy.d.ts

@@ -2,11 +2,16 @@ export default class Policy {
     _min: number;
     _max: number;
     _nextInterval: number;
+    _jitter: number;
+    set jitter(jitter: number);
+    get jitter(): number;
     /**
      * Copies settings to target policy.
+     * 1. range
+     * 2. nextInterval value
      * @param {Policy} targetPolicy - The policy to modify.
      */
-    copyPolicySetting(targetPolicy: Policy): void;
+    copyPolicySettingTo(targetPolicy: Policy): void;
     /**
      * Sets a fixed interval retry policy.
     }
@@ -37,16 +42,21 @@ export default class Policy {
     reset(): this;
     /**
      * Interval ms of next execution
+     * @param {number} retries current retry times
      * @returns {number}
-     * @throws {Error} Always throws "Not Implemented Yet" error.
      */
-    generate(): number;
-    _increase(): number;
+    generate(retries: number): number;
+    /**
+     * @param {number} retries current retry times
+     * @returns {number}
+     */
+    _increase(retries: number): number;
     /**
      * subclass should implement this method
+     * @param {number} retries current retry times
      * @returns {number} The interval in milliseconds to wait before the next retry attempt.
      * @protected
      */
-    protected _next(): number;
+    protected _next(retries: number): number;
 }
 export { Policy as PolicyType };

package/types/retrier-factory.d.ts

@@ -7,8 +7,11 @@ declare namespace _default {
     export { max };
     export { range };
     export { fixedInterval };
+    export { fixedBackoff };
     export { fixedIncrease };
+    export { linearBackoff };
     export { factorIncrease };
+    export { exponentialBackoff };
     export { shuttleInterval };
     export { timeout };
     export { taskTimeout };
@@ -63,18 +66,38 @@ export function range(min: number, max: number): Retrier;
  * @returns {Retrier} A new Retrier instance configured with the specified fixed interval.
  */
 export function fixedInterval(fixedInterval: number): Retrier;
+/**
+ * Creates a retrier with a fixed backoff strategy.
+ * @param {number} fixedInterval - The fixed interval between retries in milliseconds.
+ * @param {number} [jitter=500] - The maximum jitter to add to the interval in milliseconds.
+ * @returns {Retrier} A retrier instance configured with fixed backoff.
+ */
+export function fixedBackoff(fixedInterval: number, jitter?: number): Retrier;
 /**
  * Creates a retrier with a fixed increase strategy.
  * @param {number} increasement - The fixed amount to increase on each retry.
  * @returns {Retrier} A retrier instance configured with fixed increase.
  */
 export function fixedIncrease(increasement: number): Retrier;
+/**
+ * Creates a retrier with a fixed increase strategy.
+ * @param {number} increasement - The fixed amount to increase on each retry.
+ * @param {number} [jitter=500] - The maximum jitter to add to the interval in milliseconds.
+ * @returns {Retrier} A retrier instance configured with fixed increase.
+ */
+export function linearBackoff(increasement: number, jitter?: number): Retrier;
 /**
  * Creates a new Retrier instance with factor-increase strategy.
  * @param {number} factor - The factor by which to increase the interval on each retry.
  * @returns {Retrier} A new Retrier instance with factor-increase strategy.
  */
 export function factorIncrease(factor: number): Retrier;
+/**
+ * Creates a new Retrier instance with exponential-backoff strategy.
+ * @param {number} [jitter=500]
+ * @returns {Retrier} A new Retrier instance
+ */
+export function exponentialBackoff(jitter?: number): Retrier;
 /**
  * Creates a Retrier instance with a shuttle-interval strategt.
  * @param {number} stepLength - The interval step length of each change

package/types/retrier.d.ts

@@ -98,18 +98,38 @@ export default class Retrier {
      * @returns {Retrier} The Retrier instance for chaining.
      */
     fixedInterval(fixedInterval: number): Retrier;
+    /**
+     * sets a fixed backoff strategy.
+     * @param {number} fixedInterval - The fixed interval between retries in milliseconds.
+     * @param {number} [jitter=500] - The maximum jitter to add to the interval in milliseconds.
+     * @returns {Retrier} A retrier instance configured with fixed backoff.
+     */
+    fixedBackoff(fixedInterval: number, jitter?: number): Retrier;
     /**
      * Sets a fixed increase policy for retry intervals.
      * @param {number} increasement - The fixed amount to increase the interval by on each retry.
      * @returns {this} The retrier instance for chaining.
      */
     fixedIncrease(increasement: number): this;
+    /**
+     * Sets a fixed increase policy for retry intervals.
+     * @param {number} increasement - The fixed amount to increase the interval by on each retry.
+     * @param {number} [jitter=500] - The maximum jitter to add to the interval in milliseconds.
+     * @returns {this} The retrier instance for chaining.
+     */
+    linearBackoff(increasement: number, jitter?: number): this;
     /**
      * Sets a fixed increase factor for retry delays.
      * @param {number} factor - The multiplier for delay increase between retries.
      * @returns {this} The retrier instance for method chaining.
      */
     factorIncrease(factor: number): this;
+    /**
+     * Creates a new Retrier instance with exponential-backoff strategy.
+     * @param {number} [jitter]
+     * @returns {Retrier} A new Retrier instance
+     */
+    exponentialBackoff(jitter?: number): Retrier;
     /**
      * Sets a shuttle retry policy with the given step length.
      * @param {number} stepLength - The interval between retry attempts.