debounceMs -> debounceTime

visgl · Mar 6, 2024 · bffb0e3 · bffb0e3
1 parent 382d931
commit bffb0e3
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/docs/modules/loader-utils/api-reference/request-scheduler.md b/docs/modules/loader-utils/api-reference/request-scheduler.md
@@ -34,9 +34,9 @@ if (requestToken) {
 - `id`?: string;
 - `throttleRequests`?: boolean; — Whether to throttle requests.
 - `maxRequests`?: number; — Maximum concurrent requests to be opened by this scheduler. Additional requests are queued until an open request has completed.
-- `debounceMs`?: number; — Queue requests until no new requests have been added for at least `debounceMs` milliseconds.
+- `debounceTime`?: number; — Queue requests until no new requests have been added for at least `debounceTime` milliseconds.
 
-When `throttleRequests` is disabled, `maxRequeusts` and `debounceMs` options have no effect.
+When `throttleRequests` is disabled, `maxRequeusts` and `debounceTime` options have no effect.
 
 ### `scheduleRequest(handle: any, getPriority?: () => number): Promise<{done: () => any)}>`
 

diff --git a/docs/whats-new.mdx b/docs/whats-new.mdx
@@ -19,7 +19,7 @@ Target Release Date: February 6, 2024
 **@loaders.gl/loader-utils**
 
 - **Request Scheduling**
-  - [`RequestScheduler`](/docs/modules/loader-utils/api-reference/request-scheduler) now includes a 'debounceMs' option. When enabled, may reduce bandwidth usage and total loading time during interactive view transitions.
+  - [`RequestScheduler`](/docs/modules/loader-utils/api-reference/request-scheduler) now includes a 'debounceTime' option. When enabled, may reduce bandwidth usage and total loading time during interactive view transitions.
 
 ## v4.0
 

diff --git a/modules/loader-utils/src/lib/request-utils/request-scheduler.ts b/modules/loader-utils/src/lib/request-utils/request-scheduler.ts
@@ -12,7 +12,7 @@ export type RequestSchedulerProps = {
   id?: string;
   throttleRequests?: boolean;
   maxRequests?: number;
-  debounceMs?: number;
+  debounceTime?: number;
 };
 
 const STAT_QUEUED_REQUESTS = 'Queued Requests';
@@ -31,7 +31,7 @@ const DEFAULT_PROPS: Required<RequestSchedulerProps> = {
    * Specifies a debounce time, in milliseconds. All requests are queued, until no new requests have
    * been added to the queue for this amount of time.
    */
-  debounceMs: 0
+  debounceTime: 0
 };
 
 /** Tracks one request */
@@ -141,7 +141,7 @@ export default class RequestScheduler {
     if (this.updateTimer !== null) {
       clearTimeout(this.updateTimer);
     }
-    this.updateTimer = setTimeout(() => this._issueNewRequestsAsync(), this.props.debounceMs);
+    this.updateTimer = setTimeout(() => this._issueNewRequestsAsync(), this.props.debounceTime);
   }
 
   /** Refresh all requests  */

diff --git a/modules/loader-utils/test/lib/request-utils/request-scheduler.spec.ts b/modules/loader-utils/test/lib/request-utils/request-scheduler.spec.ts
@@ -59,8 +59,8 @@ test('RequestScheduler#scheduleRequest', async (t) => {
 });
 
 test('RequestScheduler#debounce', async (t) => {
-  const scheduler = new RequestScheduler({debounceMs: 0, maxRequests: 1});
-  const schedulerDebounced = new RequestScheduler({debounceMs: 10, maxRequests: 1});
+  const scheduler = new RequestScheduler({debounceTime: 0, maxRequests: 1});
+  const schedulerDebounced = new RequestScheduler({debounceTime: 10, maxRequests: 1});
 
   const request1 = scheduler.scheduleRequest({id: 1});
   const request2 = schedulerDebounced.scheduleRequest({id: 2});