websocket-ts
Version:
<div> <div align="center"> <img src="https://raw.githubusercontent.com/jjxxs/websocket-ts/gh-pages/websocket-ts-logo.svg" alt="websocket-ts" width="300" height="65" /> </div> <p align="center"> <img src="https://github.com/jjxxs/websocket-ts
89 lines • 3.27 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.LinearBackoff = void 0;
/**
* LinearBackoff returns a backoff-time that is incremented by a fixed amount
* with every step/retry. An optional maximum can be provided as an upper bound
* to the returned backoff.
*
* The series can be described as ('i' is the current step/retry):
* backoff = initial + increment * i | without bound
* backoff = initial + increment * min(i, max) | with bound
*
* Example:
*
* 1) Without bound:
* initial = 1000, increment = 1000
* backoff = 1000 + 1000 * 0 = 1000 // first retry
* backoff = 1000 + 1000 * 1 = 2000 // second retry
* backoff = 1000 + 1000 * 2 = 3000 // ...increases by 'increment' with every retry
* backoff = 1000 + 1000 * 3 = 4000
* backoff = 1000 + 1000 * 4 = 5000
* ... // and so on
*
* 2) With bound:
* initial = 1000, increment = 1000, max = 5000
* backoff = 1000 + 1000 * 0 = 1000 // first retry
* backoff = 1000 + 1000 * 1 = 2000 // second retry
* backoff = 1000 + 1000 * 2 = 3000 // third retry
* backoff = 1000 + 1000 * 3 = 4000 // fourth retry
* backoff = 1000 + 1000 * 4 = 5000 // maximum reached, don't increase further
* backoff = 1000 + 1000 * 4 = 5000
* backoff = 1000 + 1000 * 4 = 5000
* ... // and so on
*/
var LinearBackoff = /** @class */ (function () {
/**
* Creates a new LinearBackoff.
* @param initial the initial backoff-time in milliseconds
* @param increment the amount to increment the backoff-time with every step (in milliseconds)
* @param max the maximum backoff-time (in milliseconds), no bound if undefined
*/
function LinearBackoff(initial, increment, max) {
this.i = 0;
this._retries = 0;
if (initial < 0) {
throw new Error("Initial must be a positive number or zero");
}
if (increment < 0) {
throw new Error("Increment must be a positive number or zero");
}
if (max !== undefined && max < 0) {
throw new Error("Max must be undefined, a positive number or zero");
}
if (max !== undefined && max < initial) {
throw new Error("Max must be undefined or greater than or equal to initial");
}
this.initial = initial;
this.increment = increment;
this.max = max;
}
Object.defineProperty(LinearBackoff.prototype, "retries", {
get: function () {
return this._retries;
},
enumerable: false,
configurable: true
});
Object.defineProperty(LinearBackoff.prototype, "current", {
get: function () {
return this.max === undefined
? this.initial + this.increment * this.i
: Math.min(this.initial + this.increment * this.i, this.max);
},
enumerable: false,
configurable: true
});
LinearBackoff.prototype.next = function () {
this._retries++;
this.i++;
return this.current;
};
LinearBackoff.prototype.reset = function () {
this._retries = 0;
this.i = 0;
};
return LinearBackoff;
}());
exports.LinearBackoff = LinearBackoff;
//# sourceMappingURL=linearbackoff.js.map