gd-sprest-def 2.1.1 → 2.1.3

package/base.d.ts

@@ -97,6 +97,11 @@ export interface IBaseResult {
     /** Gets the request digest value. */
     getRequestDigest(): string;
 
+    /**
+     * If present, the rate limit information to prevent throttling
+     */
+    rateLimit?: IRateLimit;
+
     /** The response */
     response: string;
 
@@ -156,7 +161,6 @@ export interface IMethodInfo {
     argValues?: Array<any>;
     data?: any;
     getAllItemsFl?: boolean;
-    getAllItemsWaitTime?: number;
     inheritMetadataType?: boolean;
     metadataType?: string;
     name?: string;
@@ -186,9 +190,6 @@ export interface IODataQuery {
      */
     GetAllItems?: boolean;
 
-    /** Time in ms to wait between calls to avoid throttling. */
-    GetAllItemsWaitTime?: number;
-
     /** The order by fields. */
     OrderBy?: Array<string>;
 
@@ -208,6 +209,20 @@ export interface IODataQuery {
     Top?: number;
 }
 
+/**
+ * Rate Limit
+ */
+export interface IRateLimit {
+    // The rate limit policy information
+    limit: string;
+
+    // The total resource units left before you get throttled
+    remaining: number;
+
+    // The number of seconds to wait before making the next request
+    reset: number;
+}
+
 /**
  * Request Information
  */

package/lib/base.d.ts

@@ -97,6 +97,11 @@ export interface IBaseResult {
     /** Gets the request digest value. */
     getRequestDigest(): string;
 
+    /**
+     * If present, the rate limit information to prevent throttling
+     */
+    rateLimit?: IRateLimit;
+
     /** The response */
     response: string;
 
@@ -156,7 +161,6 @@ export interface IMethodInfo {
     argValues?: Array<any>;
     data?: any;
     getAllItemsFl?: boolean;
-    getAllItemsWaitTime?: number;
     inheritMetadataType?: boolean;
     metadataType?: string;
     name?: string;
@@ -186,9 +190,6 @@ export interface IODataQuery {
      */
     GetAllItems?: boolean;
 
-    /** Time in ms to wait between calls to avoid throttling. */
-    GetAllItemsWaitTime?: number;
-
     /** The order by fields. */
     OrderBy?: Array<string>;
 
@@ -208,6 +209,20 @@ export interface IODataQuery {
     Top?: number;
 }
 
+/**
+ * Rate Limit
+ */
+export interface IRateLimit {
+    // The rate limit policy information
+    limit: string;
+
+    // The total resource units left before you get throttled
+    remaining: number;
+
+    // The number of seconds to wait before making the next request
+    reset: number;
+}
+
 /**
  * Request Information
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gd-sprest-def",
-    "version": "2.1.1",
+    "version": "2.1.3",
     "description": "TypeScript definition files generated from the $metadata REST endpoint in SharePoint.",
     "author": "Gunjan Datta <me@dattabase.com> (https://gunjandatta.github.io)",
     "license": "MIT",