fix to return rate limit headers (#654)

* fix to return rate limit headers

* addressing pr comments

Author: csumana19

api/ClientApiBases.ts

@@ -48,4 +48,32 @@ export class ClientApiBase {
             serializationData.responseIsCollection);
         return deserializedResult;
     }
+
+    public extractRateLimitHeaders(headers: any, target: any): void {
+        if (!headers || !target) {
+            return;
+        }
+
+        const rateLimit: VsoBaseInterfaces.RateLimit = {};
+
+        if (headers['x-ratelimit-resource']) {
+            rateLimit.resource = headers['x-ratelimit-resource'];
+        }
+        if (headers['x-ratelimit-delay']) {
+            rateLimit.delay = parseFloat(headers['x-ratelimit-delay']);
+        }
+        if (headers['x-ratelimit-limit']) {
+            rateLimit.limit = parseInt(headers['x-ratelimit-limit'], 10);
+        }
+        if (headers['x-ratelimit-remaining']) {
+            rateLimit.remaining = parseInt(headers['x-ratelimit-remaining'], 10);
+        }
+        if (headers['x-ratelimit-reset']) {
+            rateLimit.reset = parseInt(headers['x-ratelimit-reset'], 10);
+        }
+        if (headers['retry-after']) {
+            rateLimit.retryAfter = parseInt(headers['retry-after'], 10);
+        }
+        target.rateLimit = rateLimit;
+    }
 }

api/interfaces/common/VsoBaseInterfaces.ts

@@ -120,3 +120,30 @@ export interface ICertConfiguration {
     keyFile?: string;
     passphrase?: string;
 }
+
+export interface RateLimit {
+    /**
+     * Service and type of threshold reached. For display purposes only.
+     */
+    resource?: string;
+    /**
+     * Request delay in seconds (tarpit state). Supports up to 3 decimal places.
+     */
+    delay?: number;
+    /**
+     * Total TSTUs allowed before delays are imposed.
+     */
+    limit?: number;
+    /**
+     * TSTUs remaining before delays start. 0 if already delayed or blocked.
+     */
+    remaining?: number;
+    /**
+     * Unix epoch time (seconds) when usage resets to 0 TSTUs.
+     */
+    reset?: number;
+    /**
+     * Seconds to wait before retrying (HTTP 429 block state).
+     */
+    retryAfter?: number;
+}

package-lock.json

@@ -1,7 +1,7 @@
 {
     "name": "azure-devops-node-api",
     "description": "Node client for Azure DevOps and TFS REST APIs",
-    "version": "15.1.1",
+    "version": "15.1.2",
     "main": "./WebApi.js",
     "types": "./WebApi.d.ts",
     "scripts": {