@ryanatkn/gro 0.138.0 → 0.138.1

package/dist/package.js

@@ -1,7 +1,7 @@
 // generated by src/lib/package.gen.ts
 export const package_json = {
     name: '@ryanatkn/gro',
-    version: '0.138.0',
+    version: '0.138.1',
     description: 'task runner and toolkit extending SvelteKit',
     motto: 'generate, run, optimize',
     glyph: '🌰',
@@ -264,7 +264,7 @@ export const package_json = {
 };
 export const src_json = {
     name: '@ryanatkn/gro',
-    version: '0.138.0',
+    version: '0.138.1',
     modules: {
         '.': {
             path: 'index.ts',

package/dist/throttle.d.ts

@@ -7,11 +7,13 @@
  * In other words, all calls and their args are discarded
  * during the pending window except for the most recent.
  * Unlike debouncing, this calls the throttled callback
- * both on the leading and trailing edges of the delay window.
+ * both on the leading and trailing edges of the delay window,
+ * and this can be customized by setting `leading` to `false`.
  * It also differs from a queue where every call to the throttled callback eventually runs.
  * @param cb - any function that returns a void promise
  * @param delay - delay this many milliseconds between the pending call finishing and the next starting
+ * @param leading - if `true`, the default, the callback is called immediately
  * @returns same as `cb`
  */
-export declare const throttle: <T extends (...args: any[]) => Promise<void>>(cb: T, delay?: number) => T;
+export declare const throttle: <T extends (...args: any[]) => Promise<void>>(cb: T, delay?: number, leading?: boolean) => T;
 //# sourceMappingURL=throttle.d.ts.map

package/dist/throttle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"throttle.d.ts","sourceRoot":"../src/lib/","sources":["throttle.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAc,CA2CxF,CAAC"}
+{"version":3,"file":"throttle.d.ts","sourceRoot":"../src/lib/","sources":["throttle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,MAC/D,CAAC,wCAGH,CA0CF,CAAC"}

package/dist/throttle.js

@@ -1,5 +1,3 @@
-import { wait } from '@ryanatkn/belt/async.js';
-// TODO maybe support non-promise return values?
 /**
  * Throttles calls to a callback that returns a void promise.
  * Immediately invokes the callback on the first call.
@@ -9,13 +7,15 @@ import { wait } from '@ryanatkn/belt/async.js';
  * In other words, all calls and their args are discarded
  * during the pending window except for the most recent.
  * Unlike debouncing, this calls the throttled callback
- * both on the leading and trailing edges of the delay window.
+ * both on the leading and trailing edges of the delay window,
+ * and this can be customized by setting `leading` to `false`.
  * It also differs from a queue where every call to the throttled callback eventually runs.
  * @param cb - any function that returns a void promise
  * @param delay - delay this many milliseconds between the pending call finishing and the next starting
+ * @param leading - if `true`, the default, the callback is called immediately
  * @returns same as `cb`
  */
-export const throttle = (cb, delay = 0) => {
+export const throttle = (cb, delay = 0, leading = true) => {
     let pending_promise = null;
     let next_args = null;
     let next_promise = null;
@@ -26,6 +26,7 @@ export const throttle = (cb, delay = 0) => {
             next_promise = new Promise((resolve) => {
                 next_promise_resolve = resolve;
             });
+            setTimeout(flush, delay);
         }
         return next_promise;
     };
@@ -41,15 +42,13 @@ export const throttle = (cb, delay = 0) => {
     };
     const call = (args) => {
         pending_promise = cb(...args);
-        void pending_promise.then(async () => {
-            await wait(delay);
+        void pending_promise.then(() => {
             pending_promise = null;
-            await flush();
         });
         return pending_promise;
     };
     return ((...args) => {
-        if (pending_promise) {
+        if (pending_promise || !leading) {
             return defer(args);
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ryanatkn/gro",
-  "version": "0.138.0",
+  "version": "0.138.1",
   "description": "task runner and toolkit extending SvelteKit",
   "motto": "generate, run, optimize",
   "glyph": "🌰",

package/src/lib/package.ts

@@ -5,7 +5,7 @@ import type {Src_Json} from './src_json.js';
 
 export const package_json = {
 	name: '@ryanatkn/gro',
-	version: '0.138.0',
+	version: '0.138.1',
 	description: 'task runner and toolkit extending SvelteKit',
 	motto: 'generate, run, optimize',
 	glyph: '🌰',
@@ -270,7 +270,7 @@ export const package_json = {
 
 export const src_json = {
 	name: '@ryanatkn/gro',
-	version: '0.138.0',
+	version: '0.138.1',
 	modules: {
 		'.': {
 			path: 'index.ts',

package/src/lib/throttle.ts

@@ -1,7 +1,3 @@
-import {wait} from '@ryanatkn/belt/async.js';
-
-// TODO maybe support non-promise return values?
-
 /**
  * Throttles calls to a callback that returns a void promise.
  * Immediately invokes the callback on the first call.
@@ -11,13 +7,19 @@ import {wait} from '@ryanatkn/belt/async.js';
  * In other words, all calls and their args are discarded
  * during the pending window except for the most recent.
  * Unlike debouncing, this calls the throttled callback
- * both on the leading and trailing edges of the delay window.
+ * both on the leading and trailing edges of the delay window,
+ * and this can be customized by setting `leading` to `false`.
  * It also differs from a queue where every call to the throttled callback eventually runs.
  * @param cb - any function that returns a void promise
  * @param delay - delay this many milliseconds between the pending call finishing and the next starting
+ * @param leading - if `true`, the default, the callback is called immediately
  * @returns same as `cb`
  */
-export const throttle = <T extends (...args: any[]) => Promise<void>>(cb: T, delay = 0): T => {
+export const throttle = <T extends (...args: any[]) => Promise<void>>(
+	cb: T,
+	delay = 0,
+	leading = true,
+): T => {
 	let pending_promise: Promise<void> | null = null;
 	let next_args: any[] | null = null;
 	let next_promise: Promise<void> | null = null;
@@ -29,6 +31,7 @@ export const throttle = <T extends (...args: any[]) => Promise<void>>(cb: T, del
 			next_promise = new Promise((resolve) => {
 				next_promise_resolve = resolve;
 			});
+			setTimeout(flush, delay);
 		}
 		return next_promise;
 	};
@@ -45,16 +48,14 @@ export const throttle = <T extends (...args: any[]) => Promise<void>>(cb: T, del
 
 	const call = (args: any[]): Promise<any> => {
 		pending_promise = cb(...args);
-		void pending_promise.then(async () => {
-			await wait(delay);
+		void pending_promise.then(() => {
 			pending_promise = null;
-			await flush();
 		});
 		return pending_promise;
 	};
 
 	return ((...args) => {
-		if (pending_promise) {
+		if (pending_promise || !leading) {
 			return defer(args);
 		} else {
 			return call(args);