@vertexvis/api-client-node 0.22.1 → 0.22.2

package/dist/cjs/client/helpers/queued-jobs.d.ts

@@ -32,7 +32,7 @@ interface PollJobRes<T> {
  * @param req - {@link PollQueuedJobReq}.
  * @returns {@link PollQueuedJobRes}.
  */
-export declare function pollQueuedJob<T>({ id, getQueuedJob, allow404, limit, polling: { intervalMs, maxAttempts }, }: PollQueuedJobReq): Promise<PollQueuedJobRes<T>>;
+export declare function pollQueuedJob<T>({ id, getQueuedJob, allow404, limit, polling: { intervalMs, maxAttempts, backoff }, }: PollQueuedJobReq): Promise<PollQueuedJobRes<T>>;
 export declare function isPollError<T>(r: PollRes<T>): r is QueuedJob | Failure;
 export declare function isBatch(obj: PollRes<Batch>): obj is Batch;
 export declare function throwOnError<T>(r: PollQueuedJobRes<T>): never;

package/dist/cjs/client/helpers/queued-jobs.js

@@ -29,7 +29,8 @@ const Debug = false;
  * @param req - {@link PollQueuedJobReq}.
  * @returns {@link PollQueuedJobRes}.
  */
-function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts }, }) {
+function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts, backoff }, }) {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         function poll(attempt) {
             var _a, _b;
@@ -72,7 +73,8 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
             });
         }
         let attempts = 1;
-        let pollRes = yield poll(attempts);
+        let backoffMs = (_a = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _a !== void 0 ? _a : 0;
+        const pollRes = yield poll(attempts);
         /* eslint-disable no-await-in-loop */
         while (!completeJob(pollRes.res) &&
             (allowed404(allow404, pollRes.status) ||
@@ -80,8 +82,9 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
                 isClientError(pollRes.res)) &&
             attempts <= maxAttempts) {
             attempts += 1;
-            yield (0, utils_1.delay)(intervalMs);
-            pollRes = yield poll(attempts);
+            backoffMs = (_b = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _b !== void 0 ? _b : backoffMs;
+            yield (0, utils_1.delay)(intervalMs + backoffMs);
+            yield poll(attempts);
         }
         /* eslint-enable no-await-in-loop */
         // At this point, the result is one of the following,

package/dist/cjs/client/index.d.ts

@@ -26,6 +26,11 @@ export interface Polling {
     readonly intervalMs: number;
     /** Maximum number of polling attempts. */
     readonly maxAttempts: number;
+    /**
+     * A map of polling attempt numbers to a delay in milliseconds.
+     * Once the attempts are reach, the backoff will be added to `intervalMs`.
+     */
+    readonly backoff?: Record<number, number | undefined>;
 }
 /**
  * Render image arguments. Render functions return Streams. Here's an

package/dist/esm/client/helpers/queued-jobs.d.ts

@@ -32,7 +32,7 @@ interface PollJobRes<T> {
  * @param req - {@link PollQueuedJobReq}.
  * @returns {@link PollQueuedJobRes}.
  */
-export declare function pollQueuedJob<T>({ id, getQueuedJob, allow404, limit, polling: { intervalMs, maxAttempts }, }: PollQueuedJobReq): Promise<PollQueuedJobRes<T>>;
+export declare function pollQueuedJob<T>({ id, getQueuedJob, allow404, limit, polling: { intervalMs, maxAttempts, backoff }, }: PollQueuedJobReq): Promise<PollQueuedJobRes<T>>;
 export declare function isPollError<T>(r: PollRes<T>): r is QueuedJob | Failure;
 export declare function isBatch(obj: PollRes<Batch>): obj is Batch;
 export declare function throwOnError<T>(r: PollQueuedJobRes<T>): never;

package/dist/esm/client/helpers/queued-jobs.js

@@ -23,7 +23,8 @@ const Debug = false;
  * @param req - {@link PollQueuedJobReq}.
  * @returns {@link PollQueuedJobRes}.
  */
-export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts }, }) {
+export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts, backoff }, }) {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         function poll(attempt) {
             var _a, _b;
@@ -66,7 +67,8 @@ export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polli
             });
         }
         let attempts = 1;
-        let pollRes = yield poll(attempts);
+        let backoffMs = (_a = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _a !== void 0 ? _a : 0;
+        const pollRes = yield poll(attempts);
         /* eslint-disable no-await-in-loop */
         while (!completeJob(pollRes.res) &&
             (allowed404(allow404, pollRes.status) ||
@@ -74,8 +76,9 @@ export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polli
                 isClientError(pollRes.res)) &&
             attempts <= maxAttempts) {
             attempts += 1;
-            yield delay(intervalMs);
-            pollRes = yield poll(attempts);
+            backoffMs = (_b = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _b !== void 0 ? _b : backoffMs;
+            yield delay(intervalMs + backoffMs);
+            yield poll(attempts);
         }
         /* eslint-enable no-await-in-loop */
         // At this point, the result is one of the following,

package/dist/esm/client/index.d.ts

@@ -26,6 +26,11 @@ export interface Polling {
     readonly intervalMs: number;
     /** Maximum number of polling attempts. */
     readonly maxAttempts: number;
+    /**
+     * A map of polling attempt numbers to a delay in milliseconds.
+     * Once the attempts are reach, the backoff will be added to `intervalMs`.
+     */
+    readonly backoff?: Record<number, number | undefined>;
 }
 /**
  * Render image arguments. Render functions return Streams. Here's an

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.22.1",
+  "version": "0.22.2",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -33,7 +33,7 @@
     "typescript"
   ],
   "dependencies": {
-    "axios": "^1.6.0",
+    "axios": "^1.6.1",
     "p-limit": "^3"
   },
   "devDependencies": {