@vinicunca/perkakas 1.1.0 → 1.2.2

package/dist/add.d.cts

@@ -8,7 +8,6 @@
  * @example
  *    P.add(10, 5) // => 15
  *    P.add(10, -5) // => 5
- *    P.reduce([1, 2, 3, 4], P.add, 0) // => 10
  * @dataFirst
  * @category Number
  */

package/dist/add.d.ts

@@ -8,7 +8,6 @@
  * @example
  *    P.add(10, 5) // => 15
  *    P.add(10, -5) // => 5
- *    P.reduce([1, 2, 3, 4], P.add, 0) // => 10
  * @dataFirst
  * @category Number
  */

package/dist/chunk-6YAVWI3X.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk4MAOF3ZPcjs = require('./chunk-4MAOF3ZP.cjs');function c(...e){return _chunk4MAOF3ZPcjs.a.call(void 0, d,e)}function d(e,o){let n={};for(let[a,y]of e.entries()){let r=o(y,a,e);r!==void 0&&(n[r]??=0,n[r]+=1)}return n}exports.a = c;

package/dist/chunk-AWXJSK4F.js

@@ -0,0 +1 @@
+function T(c,{triggerAt:l="end",minQuietPeriodMs:u,maxBurstDurationMs:t,minGapMs:o,reducer:p=g}){let e,n,d,r;function a(){let i=d;i!==void 0&&(d=void 0,c(i),o!==void 0&&(n=setTimeout(f,o)))}function f(){clearTimeout(n),n=void 0,e===void 0&&a()}function m(){clearTimeout(e),e=void 0,r=void 0,n===void 0&&a()}return{call:(...i)=>{let s=e===void 0&&n===void 0;if((l!=="start"||s)&&(d=p(d,...i)),!(e===void 0&&!s)){if(u!==void 0||t!==void 0||o===void 0){clearTimeout(e);let y=Date.now();r??=y;let R=t===void 0?u??0:Math.min(u??t,t-(y-r));e=setTimeout(m,R)}l!=="end"&&s&&a()}},cancel:()=>{clearTimeout(e),e=void 0,r=void 0,clearTimeout(n),n=void 0,d=void 0},flush:()=>{m(),f()},get isIdle(){return e===void 0&&n===void 0}}}var g=()=>"";export{T as a};

package/dist/chunk-C3NLWEGJ.js

@@ -0,0 +1 @@
+import{a as t}from"./chunk-ENYMRDJU.js";function c(...e){return t(d,e)}function d(e,o){let n={};for(let[a,y]of e.entries()){let r=o(y,a,e);r!==void 0&&(n[r]??=0,n[r]+=1)}return n}export{c as a};

package/dist/{chunk-TW3AOKT4.js → chunk-CUCNZMQN.js}

@@ -1 +1 @@
-import{a}from"./chunk-ENYMRDJU.js";function f(...e){return a(s,e)}function s(e,n){if(n<1)throw new RangeError(`chunk: A chunk size of '${n}' would result in an infinite array`);if(e.length===0)return[];if(n>=e.length)return[[...e]];let i=Math.ceil(e.length/n),u=new Array(i);if(n===1)for(let[r,t]of e.entries())u[r]=[t];else for(let r=0;r<i;r+=1){let t=r*n;u[r]=e.slice(t,t+n)}return u}export{f as a};
+import{a}from"./chunk-ENYMRDJU.js";function l(...e){return a(s,e)}function s(e,n){if(n<1)throw new RangeError(`chunk: A chunk size of '${n}' would result in an infinite array`);if(e.length===0)return[];if(n>=e.length)return[[...e]];let i=Math.ceil(e.length/n),u=new Array(i);if(n===1)for(let[r,t]of e.entries())u[r]=[t];else for(let r=0;r<i;r+=1){let t=r*n;u[r]=e.slice(t,t+n)}return u}export{l as a};

package/dist/{chunk-3TLR3L2W.cjs → chunk-EGUKWDAK.cjs}

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk4MAOF3ZPcjs = require('./chunk-4MAOF3ZP.cjs');function f(...e){return _chunk4MAOF3ZPcjs.a.call(void 0, s,e)}function s(e,n){if(n<1)throw new RangeError(`chunk: A chunk size of '${n}' would result in an infinite array`);if(e.length===0)return[];if(n>=e.length)return[[...e]];let i=Math.ceil(e.length/n),u=new Array(i);if(n===1)for(let[r,t]of e.entries())u[r]=[t];else for(let r=0;r<i;r+=1){let t=r*n;u[r]=e.slice(t,t+n)}return u}exports.a = f;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk4MAOF3ZPcjs = require('./chunk-4MAOF3ZP.cjs');function l(...e){return _chunk4MAOF3ZPcjs.a.call(void 0, s,e)}function s(e,n){if(n<1)throw new RangeError(`chunk: A chunk size of '${n}' would result in an infinite array`);if(e.length===0)return[];if(n>=e.length)return[[...e]];let i=Math.ceil(e.length/n),u=new Array(i);if(n===1)for(let[r,t]of e.entries())u[r]=[t];else for(let r=0;r<i;r+=1){let t=r*n;u[r]=e.slice(t,t+n)}return u}exports.a = l;

package/dist/chunk-ETVIOWIV.js

@@ -0,0 +1 @@
+import{a as n}from"./chunk-ENYMRDJU.js";function p(...e){return n(t,e)}function t(e,o){return e[o]}export{p as a,t as b};

package/dist/chunk-GOUUMCT7.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }function T(c,{triggerAt:l="end",minQuietPeriodMs:u,maxBurstDurationMs:t,minGapMs:o,reducer:p=g}){let e,n,d,r;function a(){let i=d;i!==void 0&&(d=void 0,c(i),o!==void 0&&(n=setTimeout(f,o)))}function f(){clearTimeout(n),n=void 0,e===void 0&&a()}function m(){clearTimeout(e),e=void 0,r=void 0,n===void 0&&a()}return{call:(...i)=>{let s=e===void 0&&n===void 0;if((l!=="start"||s)&&(d=p(d,...i)),!(e===void 0&&!s)){if(u!==void 0||t!==void 0||o===void 0){clearTimeout(e);let y=Date.now();r??=y;let R=t===void 0?_nullishCoalesce(u, () => (0)):Math.min(_nullishCoalesce(u, () => (t)),t-(y-r));e=setTimeout(m,R)}l!=="end"&&s&&a()}},cancel:()=>{clearTimeout(e),e=void 0,r=void 0,clearTimeout(n),n=void 0,d=void 0},flush:()=>{m(),f()},get isIdle(){return e===void 0&&n===void 0}}}var g=()=>"";exports.a = T;

package/dist/chunk-I2Z6A55T.js

@@ -0,0 +1 @@
+function o(r,n){let e=Math.ceil(r),t=Math.floor(n);if(t<e)throw new RangeError(`randomInt: The range [${r},${n}] contains no integer`);return Math.floor(Math.random()*(t-e+1)+e)}export{o as a};

package/dist/chunk-SJMGQLYS.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});function o(r,n){let e=Math.ceil(r),t=Math.floor(n);if(t<e)throw new RangeError(`randomInt: The range [${r},${n}] contains no integer`);return Math.floor(Math.random()*(t-e+1)+e)}exports.a = o;

package/dist/{chunk-WP5D3YAQ.cjs → chunk-YNCQNUT4.cjs}

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk4MAOF3ZPcjs = require('./chunk-4MAOF3ZP.cjs');function p(...n){return _chunk4MAOF3ZPcjs.a.call(void 0, r,n)}function r(n,e){return n[e]}exports.a = p; exports.b = r;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk4MAOF3ZPcjs = require('./chunk-4MAOF3ZP.cjs');function p(...e){return _chunk4MAOF3ZPcjs.a.call(void 0, t,e)}function t(e,o){return e[o]}exports.a = p; exports.b = t;

package/dist/chunk.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk3TLR3L2Wcjs = require('./chunk-3TLR3L2W.cjs');require('./chunk-4MAOF3ZP.cjs');require('./chunk-4YUDBZFA.cjs');exports.chunk = _chunk3TLR3L2Wcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkEGUKWDAKcjs = require('./chunk-EGUKWDAK.cjs');require('./chunk-4MAOF3ZP.cjs');require('./chunk-4YUDBZFA.cjs');exports.chunk = _chunkEGUKWDAKcjs.a;

package/dist/chunk.d.cts

@@ -1,4 +1,5 @@
 import { IsNumericLiteral, LessThan, IfNever, Subtract, ValueOf, IntRange } from 'type-fest';
+import { I as IntRangeInclusive } from './int-range-inclusive-Cn-qsrAN.cjs';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.cjs';
 import { T as TupleParts, N as NTuple } from './tuple-parts-DcH94smG.cjs';
 import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.cjs';
@@ -86,10 +87,6 @@ type SuffixChunk<T extends Array<unknown>, Item, N extends number> = T extends r
  * our output based on if we know for sure that the array is empty or not.
  */
 type GenericChunk<T extends IterableContainer> = T extends readonly [...Array<unknown>, unknown] | readonly [unknown, ...Array<unknown>] ? NonEmptyArray<NonEmptyArray<T[number]>> : Array<NonEmptyArray<T[number]>>;
-/**
- * Type-fest's IntRange doesn't include the `To` value, but we need it!
- */
-type IntRangeInclusive<From extends number, To extends number> = IntRange<From, To> | To;
 /**
  * Split an array into groups the length of `size`. If `array` can't be split evenly, the final chunk will be the remaining elements.
  *

package/dist/chunk.d.ts

@@ -1,4 +1,5 @@
 import { IsNumericLiteral, LessThan, IfNever, Subtract, ValueOf, IntRange } from 'type-fest';
+import { I as IntRangeInclusive } from './int-range-inclusive-Cn-qsrAN.js';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.js';
 import { T as TupleParts, N as NTuple } from './tuple-parts-DcH94smG.js';
 import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.js';
@@ -86,10 +87,6 @@ type SuffixChunk<T extends Array<unknown>, Item, N extends number> = T extends r
  * our output based on if we know for sure that the array is empty or not.
  */
 type GenericChunk<T extends IterableContainer> = T extends readonly [...Array<unknown>, unknown] | readonly [unknown, ...Array<unknown>] ? NonEmptyArray<NonEmptyArray<T[number]>> : Array<NonEmptyArray<T[number]>>;
-/**
- * Type-fest's IntRange doesn't include the `To` value, but we need it!
- */
-type IntRangeInclusive<From extends number, To extends number> = IntRange<From, To> | To;
 /**
  * Split an array into groups the length of `size`. If `array` can't be split evenly, the final chunk will be the remaining elements.
  *

package/dist/chunk.js

@@ -1 +1 @@
-import{a}from"./chunk-TW3AOKT4.js";import"./chunk-ENYMRDJU.js";import"./chunk-K2EX7PYH.js";export{a as chunk};
+import{a}from"./chunk-CUCNZMQN.js";import"./chunk-ENYMRDJU.js";import"./chunk-K2EX7PYH.js";export{a as chunk};

package/dist/count-by.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk6YAVWI3Xcjs = require('./chunk-6YAVWI3X.cjs');require('./chunk-4MAOF3ZP.cjs');require('./chunk-4YUDBZFA.cjs');exports.countBy = _chunk6YAVWI3Xcjs.a;

package/dist/count-by.d.cts

@@ -0,0 +1,41 @@
+import { E as ExactRecord } from './exact-record-h-jwajoM.cjs';
+import './if-bounded-record-DVYSMNKL.cjs';
+import 'type-fest';
+
+/**
+ * Categorize and count elements in an array using a defined callback function.
+ * The callback function is applied to each element in the array to determine
+ * its category and then counts how many elements fall into each category.
+ *
+ * @param data - The array.
+ * @param categorizationFn - The categorization function.
+ * @signature
+ *   P.countBy(data, categorizationFn)
+ * @example
+ *    P.countBy(
+ *      ["a", "b", "c", "B", "A", "a"],
+ *      toLowerCase
+ *    ); //=> { a: 3, b: 2, c: 1 }
+ * @dataFirst
+ * @category Array
+ */
+declare function countBy<T, K extends PropertyKey>(data: ReadonlyArray<T>, categorizationFn: (value: T, index: number, data: ReadonlyArray<T>) => K | undefined): ExactRecord<K, number>;
+/**
+ * Categorize and count elements in an array using a defined callback function.
+ * The callback function is applied to each element in the array to determine
+ * its category and then counts how many elements fall into each category.
+ *
+ * @param categorizationFn - The categorization function.
+ * @signature
+ *   P.countBy(categorizationFn)(data)
+ * @example
+ *    P.pipe(
+ *      ["a", "b", "c", "B", "A", "a"],
+ *      P.countBy(toLowerCase),
+ *    ); //=> { a: 3, b: 2, c: 1 }
+ * @dataLast
+ * @category Array
+ */
+declare function countBy<T, K extends PropertyKey>(categorizationFn: (value: T, index: number, data: ReadonlyArray<T>) => K | undefined): (data: ReadonlyArray<T>) => ExactRecord<K, number>;
+
+export { countBy };

package/dist/count-by.d.ts

@@ -0,0 +1,41 @@
+import { E as ExactRecord } from './exact-record-Bf4LoPyZ.js';
+import './if-bounded-record-DVYSMNKL.js';
+import 'type-fest';
+
+/**
+ * Categorize and count elements in an array using a defined callback function.
+ * The callback function is applied to each element in the array to determine
+ * its category and then counts how many elements fall into each category.
+ *
+ * @param data - The array.
+ * @param categorizationFn - The categorization function.
+ * @signature
+ *   P.countBy(data, categorizationFn)
+ * @example
+ *    P.countBy(
+ *      ["a", "b", "c", "B", "A", "a"],
+ *      toLowerCase
+ *    ); //=> { a: 3, b: 2, c: 1 }
+ * @dataFirst
+ * @category Array
+ */
+declare function countBy<T, K extends PropertyKey>(data: ReadonlyArray<T>, categorizationFn: (value: T, index: number, data: ReadonlyArray<T>) => K | undefined): ExactRecord<K, number>;
+/**
+ * Categorize and count elements in an array using a defined callback function.
+ * The callback function is applied to each element in the array to determine
+ * its category and then counts how many elements fall into each category.
+ *
+ * @param categorizationFn - The categorization function.
+ * @signature
+ *   P.countBy(categorizationFn)(data)
+ * @example
+ *    P.pipe(
+ *      ["a", "b", "c", "B", "A", "a"],
+ *      P.countBy(toLowerCase),
+ *    ); //=> { a: 3, b: 2, c: 1 }
+ * @dataLast
+ * @category Array
+ */
+declare function countBy<T, K extends PropertyKey>(categorizationFn: (value: T, index: number, data: ReadonlyArray<T>) => K | undefined): (data: ReadonlyArray<T>) => ExactRecord<K, number>;
+
+export { countBy };

package/dist/count-by.js

@@ -0,0 +1 @@
+import{a}from"./chunk-C3NLWEGJ.js";import"./chunk-ENYMRDJU.js";import"./chunk-K2EX7PYH.js";export{a as countBy};

package/dist/funnel.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkGOUUMCT7cjs = require('./chunk-GOUUMCT7.cjs');exports.funnel = _chunkGOUUMCT7cjs.a;

package/dist/funnel.d.cts

@@ -0,0 +1,147 @@
+import { RequireAtLeastOne } from 'type-fest';
+
+type FunnelOptions<Args extends RestArguments, R> = {
+    readonly reducer?: (accumulator: R | undefined, ...params: Args) => R;
+} & FunnelTimingOptions;
+/**
+ * Not all combinations of timing options are valid, there are dependencies
+ * between them to ensure users can't configure the funnel in a way which would
+ * cause it to never trigger.
+ */
+type FunnelTimingOptions = {
+    readonly triggerAt: 'both' | 'start';
+    readonly minQuietPeriodMs?: number;
+    readonly maxBurstDurationMs?: number;
+    readonly minGapMs?: number;
+} | ({
+    readonly triggerAt?: 'end';
+} & (({
+    readonly minGapMs: number;
+} & RequireAtLeastOne<{
+    readonly minQuietPeriodMs: number;
+    readonly maxBurstDurationMs: number;
+}>) | {
+    readonly minQuietPeriodMs?: number;
+    readonly maxBurstDurationMs?: number;
+    readonly minGapMs?: never;
+}));
+type RestArguments = Array<any>;
+interface Funnel<Args extends RestArguments = []> {
+    /**
+     * Call the function. This might result in the `execute` function being called
+     * now or later, depending on it's configuration and it's current state.
+     *
+     * @param args - The args are defined by the `reducer` function.
+     */
+    readonly call: (...args: Args) => void;
+    /**
+     * Resets the funnel to it's initial state. Any calls made since the last
+     * invocation will be discarded.
+     */
+    readonly cancel: () => void;
+    /**
+     * Triggers an invocation regardless of the current state of the funnel.
+     * Like any other invocation, The funnel will also be reset to it's initial
+     * state afterwards.
+     */
+    readonly flush: () => void;
+    /**
+     * The funnel is in it's initial state (there are no active timeouts).
+     */
+    readonly isIdle: boolean;
+}
+/**
+ * Creates a funnel that controls the timing and execution of `callback`. Its
+ * main purpose is to manage multiple consecutive (usually fast-paced) calls,
+ * reshaping them according to a defined batching strategy and timing policy.
+ * This is useful when handling uncontrolled call rates, such as DOM events or
+ * network traffic. It can implement strategies like debouncing, throttling,
+ * batching, and more.
+ *
+ * An optional `reducer` function can be provided to allow passing data to the
+ * callback via calls to `call` (otherwise the signature of `call` takes no
+ * arguments).
+ *
+ * Typing is inferred from `callback`s param, and from the rest params that
+ * the optional `reducer` function accepts. Use **explicit** types for these
+ * to ensure that everything _else_ is well-typed.
+ *
+ * Notice that this function constructs a funnel **object**, and does **not**
+ * execute anything when called. The returned object should be used to execute
+ * the funnel via the its `call` method.
+ *
+ * - Debouncing: use `minQuietPeriodMs` and any `triggerAt`.
+ * - Throttling: use `minGapMs` and `triggerAt: "start"` or `"both"`.
+ * - Batching: See the reference implementation in [`funnel.reference-batch.test.ts`](https://github.com/vinicunca/perkakas/blob/main/src/funnel.reference-batch.test.ts).
+ *
+ * @param callback - The main function that would be invoked periodically based
+ * on `options`. The function would take the latest result of the `reducer`; if
+ * no calls where made since the last time it was invoked it will not be
+ * invoked. (If a return value is needed, it should be passed via a reference or
+ * via closure to the outer scope of the funnel).
+ * @param options - An object that defines when `execute` should be invoked,
+ * relative to the calls of `call`. An empty/missing options object is
+ * equivalent to setting `minQuietPeriodMs` to `0`.
+ * @param options.reducer - Combines the arguments passed to `call` with the
+ * value computed on the previous call (or `undefined` on the first time). The
+ * goal of the function is to extract and summarize the data needed for
+ * `callback`. It should be fast and simple as it is called often and should
+ * defer heavy operations to the `execute` function. If the final value
+ * is `undefined`, `callback` will not be called.
+ * @param options.triggerAt - At what "edges" of the funnel's burst window
+ * would `execute` invoke:
+ * - `start` - the function will be invoked immediately (within the  **same**
+ * execution frame!), and any subsequent calls would be ignored until the funnel
+ * is idle again. During this period `reducer` will also not be called.
+ * - `end` - the function will **not** be invoked initially but the timer will
+ * be started. Any calls during this time would be passed to the reducer, and
+ * when the timers are done, the reduced result would trigger an invocation.
+ * - `both` - the function will be invoked immediately, and then the funnel
+ * would behave as if it was in the 'end' state. @default 'end'.
+ * @param options.minQuietPeriodMs - The burst timer prevents subsequent calls
+ * in short succession to cause excessive invocations (aka "debounce"). This
+ * duration represents the **minimum** amount of time that needs to pass
+ * between calls (the "quiet" part) in order for the subsequent call to **not**
+ * be considered part of the burst. In other words, as long as calls are faster
+ * than this, they are considered part of the burst and the burst is extended.
+ * @param options.maxBurstDurationMs - Bursts are extended every time a call is
+ * made within the burst period. This means that the burst period could be
+ * extended indefinitely. To prevent such cases, a maximum burst duration could
+ * be defined. When `minQuietPeriodMs` is not defined and this option is, they
+ * will both share the same value.
+ * @param options.minGapMs - A minimum duration between calls of `execute`.
+ * This is maintained regardless of the shape of the burst and is ensured even
+ * if the `maxBurstDurationMs` is reached before it. (aka "throttle").
+ * @returns A funnel with a `call` function that is used to trigger invocations.
+ * In addition to it the funnel also comes with the following functions and
+ * properties:
+ * - `cancel` - Resets the funnel to it's initial state, discarding the current
+ * `reducer` result without calling `execute` on it.
+ * - `flush` - Triggers an invocation even if there are active timeouts, and
+ * then resets the funnel to it's initial state.
+ * - `isIdle` - Checks if there are any active timeouts.
+ * @signature
+ *   P.funnel(callback, options);
+ * @example
+ *   const debouncer = P.funnel(
+ *     () => {
+ *       console.log("Callback executed!");
+ *     },
+ *     { minQuietPeriodMs: 100 },
+ *   );
+ *   debouncer.call();
+ *   debouncer.call();
+ *
+ *   const throttle = P.funnel(
+ *     () => {
+ *       console.log("Callback executed!");
+ *     },
+ *     { minGapMs: 100, triggerAt: "start" },
+ *   );
+ *   throttle.call();
+ *   throttle.call();
+ * @category Function
+ */
+declare function funnel<Args extends RestArguments = [], R = never>(callback: (data: R) => void, { triggerAt, minQuietPeriodMs, maxBurstDurationMs, minGapMs, reducer, }: FunnelOptions<Args, R>): Funnel<Args>;
+
+export { funnel };

package/dist/funnel.d.ts

@@ -0,0 +1,147 @@
+import { RequireAtLeastOne } from 'type-fest';
+
+type FunnelOptions<Args extends RestArguments, R> = {
+    readonly reducer?: (accumulator: R | undefined, ...params: Args) => R;
+} & FunnelTimingOptions;
+/**
+ * Not all combinations of timing options are valid, there are dependencies
+ * between them to ensure users can't configure the funnel in a way which would
+ * cause it to never trigger.
+ */
+type FunnelTimingOptions = {
+    readonly triggerAt: 'both' | 'start';
+    readonly minQuietPeriodMs?: number;
+    readonly maxBurstDurationMs?: number;
+    readonly minGapMs?: number;
+} | ({
+    readonly triggerAt?: 'end';
+} & (({
+    readonly minGapMs: number;
+} & RequireAtLeastOne<{
+    readonly minQuietPeriodMs: number;
+    readonly maxBurstDurationMs: number;
+}>) | {
+    readonly minQuietPeriodMs?: number;
+    readonly maxBurstDurationMs?: number;
+    readonly minGapMs?: never;
+}));
+type RestArguments = Array<any>;
+interface Funnel<Args extends RestArguments = []> {
+    /**
+     * Call the function. This might result in the `execute` function being called
+     * now or later, depending on it's configuration and it's current state.
+     *
+     * @param args - The args are defined by the `reducer` function.
+     */
+    readonly call: (...args: Args) => void;
+    /**
+     * Resets the funnel to it's initial state. Any calls made since the last
+     * invocation will be discarded.
+     */
+    readonly cancel: () => void;
+    /**
+     * Triggers an invocation regardless of the current state of the funnel.
+     * Like any other invocation, The funnel will also be reset to it's initial
+     * state afterwards.
+     */
+    readonly flush: () => void;
+    /**
+     * The funnel is in it's initial state (there are no active timeouts).
+     */
+    readonly isIdle: boolean;
+}
+/**
+ * Creates a funnel that controls the timing and execution of `callback`. Its
+ * main purpose is to manage multiple consecutive (usually fast-paced) calls,
+ * reshaping them according to a defined batching strategy and timing policy.
+ * This is useful when handling uncontrolled call rates, such as DOM events or
+ * network traffic. It can implement strategies like debouncing, throttling,
+ * batching, and more.
+ *
+ * An optional `reducer` function can be provided to allow passing data to the
+ * callback via calls to `call` (otherwise the signature of `call` takes no
+ * arguments).
+ *
+ * Typing is inferred from `callback`s param, and from the rest params that
+ * the optional `reducer` function accepts. Use **explicit** types for these
+ * to ensure that everything _else_ is well-typed.
+ *
+ * Notice that this function constructs a funnel **object**, and does **not**
+ * execute anything when called. The returned object should be used to execute
+ * the funnel via the its `call` method.
+ *
+ * - Debouncing: use `minQuietPeriodMs` and any `triggerAt`.
+ * - Throttling: use `minGapMs` and `triggerAt: "start"` or `"both"`.
+ * - Batching: See the reference implementation in [`funnel.reference-batch.test.ts`](https://github.com/vinicunca/perkakas/blob/main/src/funnel.reference-batch.test.ts).
+ *
+ * @param callback - The main function that would be invoked periodically based
+ * on `options`. The function would take the latest result of the `reducer`; if
+ * no calls where made since the last time it was invoked it will not be
+ * invoked. (If a return value is needed, it should be passed via a reference or
+ * via closure to the outer scope of the funnel).
+ * @param options - An object that defines when `execute` should be invoked,
+ * relative to the calls of `call`. An empty/missing options object is
+ * equivalent to setting `minQuietPeriodMs` to `0`.
+ * @param options.reducer - Combines the arguments passed to `call` with the
+ * value computed on the previous call (or `undefined` on the first time). The
+ * goal of the function is to extract and summarize the data needed for
+ * `callback`. It should be fast and simple as it is called often and should
+ * defer heavy operations to the `execute` function. If the final value
+ * is `undefined`, `callback` will not be called.
+ * @param options.triggerAt - At what "edges" of the funnel's burst window
+ * would `execute` invoke:
+ * - `start` - the function will be invoked immediately (within the  **same**
+ * execution frame!), and any subsequent calls would be ignored until the funnel
+ * is idle again. During this period `reducer` will also not be called.
+ * - `end` - the function will **not** be invoked initially but the timer will
+ * be started. Any calls during this time would be passed to the reducer, and
+ * when the timers are done, the reduced result would trigger an invocation.
+ * - `both` - the function will be invoked immediately, and then the funnel
+ * would behave as if it was in the 'end' state. @default 'end'.
+ * @param options.minQuietPeriodMs - The burst timer prevents subsequent calls
+ * in short succession to cause excessive invocations (aka "debounce"). This
+ * duration represents the **minimum** amount of time that needs to pass
+ * between calls (the "quiet" part) in order for the subsequent call to **not**
+ * be considered part of the burst. In other words, as long as calls are faster
+ * than this, they are considered part of the burst and the burst is extended.
+ * @param options.maxBurstDurationMs - Bursts are extended every time a call is
+ * made within the burst period. This means that the burst period could be
+ * extended indefinitely. To prevent such cases, a maximum burst duration could
+ * be defined. When `minQuietPeriodMs` is not defined and this option is, they
+ * will both share the same value.
+ * @param options.minGapMs - A minimum duration between calls of `execute`.
+ * This is maintained regardless of the shape of the burst and is ensured even
+ * if the `maxBurstDurationMs` is reached before it. (aka "throttle").
+ * @returns A funnel with a `call` function that is used to trigger invocations.
+ * In addition to it the funnel also comes with the following functions and
+ * properties:
+ * - `cancel` - Resets the funnel to it's initial state, discarding the current
+ * `reducer` result without calling `execute` on it.
+ * - `flush` - Triggers an invocation even if there are active timeouts, and
+ * then resets the funnel to it's initial state.
+ * - `isIdle` - Checks if there are any active timeouts.
+ * @signature
+ *   P.funnel(callback, options);
+ * @example
+ *   const debouncer = P.funnel(
+ *     () => {
+ *       console.log("Callback executed!");
+ *     },
+ *     { minQuietPeriodMs: 100 },
+ *   );
+ *   debouncer.call();
+ *   debouncer.call();
+ *
+ *   const throttle = P.funnel(
+ *     () => {
+ *       console.log("Callback executed!");
+ *     },
+ *     { minGapMs: 100, triggerAt: "start" },
+ *   );
+ *   throttle.call();
+ *   throttle.call();
+ * @category Function
+ */
+declare function funnel<Args extends RestArguments = [], R = never>(callback: (data: R) => void, { triggerAt, minQuietPeriodMs, maxBurstDurationMs, minGapMs, reducer, }: FunnelOptions<Args, R>): Funnel<Args>;
+
+export { funnel };

package/dist/funnel.js

@@ -0,0 +1 @@
+import{a}from"./chunk-AWXJSK4F.js";export{a as funnel};

package/dist/funnel.lodash-debounce-with-cached-value.test.cjs

@@ -0,0 +1 @@
+"use strict"; function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var _chunkAQRYBCA3cjs = require('./chunk-AQRYBCA3.cjs');var _chunkHC3HZK4Qcjs = require('./chunk-HC3HZK4Q.cjs');var _chunkGOUUMCT7cjs = require('./chunk-GOUUMCT7.cjs');var _chunkWLNQOMKLcjs = require('./chunk-WLNQOMKL.cjs');function o(e,t=0,{leading:s=!1,trailing:r=!0,maxWait:u}={}){let d,{call:h,flush:f,cancel:b}=_chunkGOUUMCT7cjs.a.call(void 0, l=>{!s&&!r||(d=e(...l))},{reducer:(l,...x)=>x,minQuietPeriodMs:t,...u!==void 0&&{maxBurstDurationMs:u},...r?s?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign((...l)=>(h(...l),d),{flush:()=>(f(),d),cancel:b})}var n=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L4187",()=>{it("should debounce a function",async()=>{let e=vi.fn(_chunkAQRYBCA3cjs.a.call(void 0, )),t=o(e,n);expect(t("a")).toBeUndefined(),expect(t("b")).toBeUndefined(),expect(t("c")).toBeUndefined(),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*n),expect(e).toHaveBeenCalledTimes(1),expect(t("d")).toBe("c"),expect(t("e")).toBe("c"),expect(t("f")).toBe("c"),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*n),expect(e).toHaveBeenCalledTimes(2)}),it("subsequent debounced calls return the last `func` result",async()=>{let e=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n);e("a"),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e("b")).not.toBe("b"),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e("c")).not.toBe("c")}),it("subsequent leading debounced calls return the last `func` result",async()=>{let e=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n,{leading:!0,trailing:!1});expect(e("a")).toBe("a"),expect(e("b")).toBe("a"),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e("c")).toBe("c"),expect(e("d")).toBe("c")}),it("should invoke the trailing call with the correct arguments and `this` binding",async()=>{let e={},t=vi.fn(_chunkWLNQOMKLcjs.a.call(void 0, !1)),s=o(t,n,{maxWait:2*n});for(;_nullishCoalesce(s(e,"a"), () => (!0));)await _chunkHC3HZK4Qcjs.a.call(void 0, 0);await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(t).toHaveBeenCalledTimes(2),expect(t).toHaveBeenLastCalledWith(e,"a")})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should reset `lastCalled` after cancelling",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!0});expect(t()).toBe(1),t.cancel(),expect(t()).toBe(2),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e).toBe(3)}),it("should support flushing delayed calls",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!1});t(),expect(t.flush()).toBe(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e).toBe(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(_chunkWLNQOMKLcjs.a.call(void 0, "hello")),t=o(e,n);t.cancel(),expect(t.flush()).toBeUndefined(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e).toHaveBeenCalledTimes(0)})});describe("features not tested by Lodash",()=>{it("does nothing when neither leading nor trailing are enabled",async()=>{let e=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n,{leading:!1,trailing:!1});expect(e("hello")).toBeUndefined(),expect(e("world")).toBeUndefined(),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*n),expect(e("goodbye")).toBeUndefined()})});

package/dist/funnel.lodash-debounce-with-cached-value.test.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-debounce-with-cached-value.test.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-debounce-with-cached-value.test.js

@@ -0,0 +1 @@
+import{a as c}from"./chunk-46GBCFAG.js";import{a}from"./chunk-6SYP2DRD.js";import{a as p}from"./chunk-AWXJSK4F.js";import{a as i}from"./chunk-T5XG33UI.js";function o(e,t=0,{leading:s=!1,trailing:r=!0,maxWait:u}={}){let d,{call:h,flush:f,cancel:b}=p(l=>{!s&&!r||(d=e(...l))},{reducer:(l,...x)=>x,minQuietPeriodMs:t,...u!==void 0&&{maxBurstDurationMs:u},...r?s?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign((...l)=>(h(...l),d),{flush:()=>(f(),d),cancel:b})}var n=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L4187",()=>{it("should debounce a function",async()=>{let e=vi.fn(c()),t=o(e,n);expect(t("a")).toBeUndefined(),expect(t("b")).toBeUndefined(),expect(t("c")).toBeUndefined(),expect(e).toHaveBeenCalledTimes(0),await a(4*n),expect(e).toHaveBeenCalledTimes(1),expect(t("d")).toBe("c"),expect(t("e")).toBe("c"),expect(t("f")).toBe("c"),expect(e).toHaveBeenCalledTimes(1),await a(4*n),expect(e).toHaveBeenCalledTimes(2)}),it("subsequent debounced calls return the last `func` result",async()=>{let e=o(c(),n);e("a"),await a(2*n),expect(e("b")).not.toBe("b"),await a(2*n),expect(e("c")).not.toBe("c")}),it("subsequent leading debounced calls return the last `func` result",async()=>{let e=o(c(),n,{leading:!0,trailing:!1});expect(e("a")).toBe("a"),expect(e("b")).toBe("a"),await a(2*n),expect(e("c")).toBe("c"),expect(e("d")).toBe("c")}),it("should invoke the trailing call with the correct arguments and `this` binding",async()=>{let e={},t=vi.fn(i(!1)),s=o(t,n,{maxWait:2*n});for(;s(e,"a")??!0;)await a(0);await a(2*n),expect(t).toHaveBeenCalledTimes(2),expect(t).toHaveBeenLastCalledWith(e,"a")})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should reset `lastCalled` after cancelling",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!0});expect(t()).toBe(1),t.cancel(),expect(t()).toBe(2),t(),await a(2*n),expect(e).toBe(3)}),it("should support flushing delayed calls",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!1});t(),expect(t.flush()).toBe(1),await a(2*n),expect(e).toBe(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(i("hello")),t=o(e,n);t.cancel(),expect(t.flush()).toBeUndefined(),await a(2*n),expect(e).toHaveBeenCalledTimes(0)})});describe("features not tested by Lodash",()=>{it("does nothing when neither leading nor trailing are enabled",async()=>{let e=o(c(),n,{leading:!1,trailing:!1});expect(e("hello")).toBeUndefined(),expect(e("world")).toBeUndefined(),await a(4*n),expect(e("goodbye")).toBeUndefined()})});

package/dist/funnel.lodash-debounce.test.cjs

@@ -0,0 +1 @@
+"use strict";var _chunkHC3HZK4Qcjs = require('./chunk-HC3HZK4Q.cjs');var _chunkGOUUMCT7cjs = require('./chunk-GOUUMCT7.cjs');function i(e,t=0,{leading:o=!1,trailing:s=!0,maxWait:c}={}){let{call:m,isIdle:v,...r}=_chunkGOUUMCT7cjs.a.call(void 0, d=>{!s&&!o||e(...d)},{reducer:(d,...p)=>p,minQuietPeriodMs:t,...c!==void 0&&{maxBurstDurationMs:c},...s?o?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign(m,r)}var a=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L4187",()=>{it("should debounce a function",async()=>{let e=vi.fn(),t=i(e,a);t("a"),t("b"),t("c"),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),expect(e).toHaveBeenCalledTimes(1),expect(e).toHaveBeenCalledWith("c"),t("d"),t("e"),t("f"),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should not immediately call `func` when `wait` is `0`",async()=>{let e=vi.fn(),t=i(e,0);t(),t(),expect(e).toHaveBeenCalledTimes(0),await l(),expect(e).toHaveBeenCalledTimes(1)}),it("should apply default options",async()=>{let e=vi.fn();i(e,a,{})(),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should support a `leading` option",async()=>{let e=vi.fn(),t=vi.fn(),o=i(e,a,{leading:!0,trailing:!1}),s=i(t,a,{leading:!0,trailing:!0});o(),expect(e).toHaveBeenCalledTimes(1),s(),s(),expect(t).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledTimes(2),o(),expect(e).toHaveBeenCalledTimes(2)}),it("should support a `trailing` option",async()=>{let e=vi.fn(),t=vi.fn(),o=i(e,a,{trailing:!0}),s=i(t,a,{trailing:!1});o(),expect(e).toHaveBeenCalledTimes(0),s(),expect(t).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledTimes(0)}),it("should support a `maxWait` option",async()=>{let e=vi.fn(),t=i(e,a,{maxWait:2*a});t(),t(),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),expect(e).toHaveBeenCalledTimes(1),t(),t(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should support `maxWait` in a tight loop",async()=>{let e=vi.fn(),t=vi.fn(),o=i(e,2*a,{maxWait:4*a}),s=i(t,3*a),c=Date.now()+10*a;for(;Date.now()<c;)o(),s();expect(t).toHaveBeenCalledTimes(0),expect(e).toHaveBeenCalledTimes(0),await l(),expect(t).toHaveBeenCalledTimes(0),expect(e).toHaveBeenCalledTimes(1)}),it("should queue a trailing call for subsequent debounced calls after `maxWait`",async()=>{let e=vi.fn(),t=i(e,6*a,{maxWait:6*a});t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 5.5*a),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, .5*a),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, .5*a),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 9.5*a),expect(e).toHaveBeenCalledTimes(2)}),it("should cancel `maxDelayed` when `delayed` is invoked",async()=>{let e=vi.fn(),t=i(e,a,{maxWait:2*a});t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),t(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(2)}),it("should invoke the trailing call with the correct arguments and `this` binding",async()=>{let e=vi.fn(),t={},o=i(e,a,{leading:!0,maxWait:2*a});for(;e.mock.calls.length<2;)o(t,"a"),await l();await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(2),expect(e).toHaveBeenLastCalledWith(t,"a")})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should use a default `wait` of `0`",async()=>{let e=vi.fn(),t=i(e);t(),await _chunkHC3HZK4Qcjs.a.call(void 0, a),t(),expect(e).toHaveBeenCalledTimes(1)}),it("supports recursive calls",async()=>{let e=[],t=["a","b","c"],o=i(s=>{e.push(s);let c=t.shift();c!==void 0&&o(c)},a);o(t.shift()),expect(e).toStrictEqual([]),await _chunkHC3HZK4Qcjs.a.call(void 0, 8*a),expect(e).toStrictEqual(["a","b","c"])}),it("should support cancelling delayed calls",async()=>{let e=vi.fn(),t=i(e,a,{leading:!1});t(),t.cancel(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(0)}),it("should reset `lastCalled` after cancelling",async()=>{let e=vi.fn(),t=i(e,a,{leading:!0});t(),expect(e).toHaveBeenCalledTimes(1),t.cancel(),t(),expect(e).toHaveBeenCalledTimes(2),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(3)}),it("should support flushing delayed calls",async()=>{let e=vi.fn(),t=i(e,a,{leading:!1});t(),t.flush(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(),t=i(e,a);t.cancel(),t.flush(),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(0)})});var l=async()=>await _chunkHC3HZK4Qcjs.a.call(void 0, 0);

package/dist/funnel.lodash-debounce.test.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-debounce.test.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-debounce.test.js

@@ -0,0 +1 @@
+import{a as n}from"./chunk-6SYP2DRD.js";import{a as u}from"./chunk-AWXJSK4F.js";function i(e,t=0,{leading:o=!1,trailing:s=!0,maxWait:c}={}){let{call:m,isIdle:v,...r}=u(d=>{!s&&!o||e(...d)},{reducer:(d,...p)=>p,minQuietPeriodMs:t,...c!==void 0&&{maxBurstDurationMs:c},...s?o?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign(m,r)}var a=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L4187",()=>{it("should debounce a function",async()=>{let e=vi.fn(),t=i(e,a);t("a"),t("b"),t("c"),expect(e).toHaveBeenCalledTimes(0),await n(4*a),expect(e).toHaveBeenCalledTimes(1),expect(e).toHaveBeenCalledWith("c"),t("d"),t("e"),t("f"),expect(e).toHaveBeenCalledTimes(1),await n(4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should not immediately call `func` when `wait` is `0`",async()=>{let e=vi.fn(),t=i(e,0);t(),t(),expect(e).toHaveBeenCalledTimes(0),await l(),expect(e).toHaveBeenCalledTimes(1)}),it("should apply default options",async()=>{let e=vi.fn();i(e,a,{})(),expect(e).toHaveBeenCalledTimes(0),await n(2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should support a `leading` option",async()=>{let e=vi.fn(),t=vi.fn(),o=i(e,a,{leading:!0,trailing:!1}),s=i(t,a,{leading:!0,trailing:!0});o(),expect(e).toHaveBeenCalledTimes(1),s(),s(),expect(t).toHaveBeenCalledTimes(1),await n(2*a),expect(e).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledTimes(2),o(),expect(e).toHaveBeenCalledTimes(2)}),it("should support a `trailing` option",async()=>{let e=vi.fn(),t=vi.fn(),o=i(e,a,{trailing:!0}),s=i(t,a,{trailing:!1});o(),expect(e).toHaveBeenCalledTimes(0),s(),expect(t).toHaveBeenCalledTimes(0),await n(2*a),expect(e).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledTimes(0)}),it("should support a `maxWait` option",async()=>{let e=vi.fn(),t=i(e,a,{maxWait:2*a});t(),t(),expect(e).toHaveBeenCalledTimes(0),await n(4*a),expect(e).toHaveBeenCalledTimes(1),t(),t(),expect(e).toHaveBeenCalledTimes(1),await n(4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should support `maxWait` in a tight loop",async()=>{let e=vi.fn(),t=vi.fn(),o=i(e,2*a,{maxWait:4*a}),s=i(t,3*a),c=Date.now()+10*a;for(;Date.now()<c;)o(),s();expect(t).toHaveBeenCalledTimes(0),expect(e).toHaveBeenCalledTimes(0),await l(),expect(t).toHaveBeenCalledTimes(0),expect(e).toHaveBeenCalledTimes(1)}),it("should queue a trailing call for subsequent debounced calls after `maxWait`",async()=>{let e=vi.fn(),t=i(e,6*a,{maxWait:6*a});t(),await n(5.5*a),t(),await n(.5*a),t(),await n(.5*a),t(),await n(9.5*a),expect(e).toHaveBeenCalledTimes(2)}),it("should cancel `maxDelayed` when `delayed` is invoked",async()=>{let e=vi.fn(),t=i(e,a,{maxWait:2*a});t(),await n(4*a),t(),expect(e).toHaveBeenCalledTimes(1),await n(2*a),expect(e).toHaveBeenCalledTimes(2)}),it("should invoke the trailing call with the correct arguments and `this` binding",async()=>{let e=vi.fn(),t={},o=i(e,a,{leading:!0,maxWait:2*a});for(;e.mock.calls.length<2;)o(t,"a"),await l();await n(2*a),expect(e).toHaveBeenCalledTimes(2),expect(e).toHaveBeenLastCalledWith(t,"a")})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should use a default `wait` of `0`",async()=>{let e=vi.fn(),t=i(e);t(),await n(a),t(),expect(e).toHaveBeenCalledTimes(1)}),it("supports recursive calls",async()=>{let e=[],t=["a","b","c"],o=i(s=>{e.push(s);let c=t.shift();c!==void 0&&o(c)},a);o(t.shift()),expect(e).toStrictEqual([]),await n(8*a),expect(e).toStrictEqual(["a","b","c"])}),it("should support cancelling delayed calls",async()=>{let e=vi.fn(),t=i(e,a,{leading:!1});t(),t.cancel(),await n(2*a),expect(e).toHaveBeenCalledTimes(0)}),it("should reset `lastCalled` after cancelling",async()=>{let e=vi.fn(),t=i(e,a,{leading:!0});t(),expect(e).toHaveBeenCalledTimes(1),t.cancel(),t(),expect(e).toHaveBeenCalledTimes(2),t(),await n(2*a),expect(e).toHaveBeenCalledTimes(3)}),it("should support flushing delayed calls",async()=>{let e=vi.fn(),t=i(e,a,{leading:!1});t(),t.flush(),expect(e).toHaveBeenCalledTimes(1),await n(2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(),t=i(e,a);t.cancel(),t.flush(),expect(e).toHaveBeenCalledTimes(0),await n(2*a),expect(e).toHaveBeenCalledTimes(0)})});var l=async()=>await n(0);

package/dist/funnel.lodash-throttle-with-cached-value.test.cjs

@@ -0,0 +1 @@
+"use strict";var _chunkAQRYBCA3cjs = require('./chunk-AQRYBCA3.cjs');var _chunkHC3HZK4Qcjs = require('./chunk-HC3HZK4Q.cjs');var _chunkGOUUMCT7cjs = require('./chunk-GOUUMCT7.cjs');var _chunkWLNQOMKLcjs = require('./chunk-WLNQOMKL.cjs');function o(e,t=0,{leading:a=!0,trailing:i=!0}={}){let c,{call:h,flush:p,cancel:f}=_chunkGOUUMCT7cjs.a.call(void 0, r=>{!a&&!i||(c=e(...r))},{reducer:(r,...g)=>g,minQuietPeriodMs:t,maxBurstDurationMs:t,...i?a?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign((...r)=>(h(...r),c),{flush:()=>(p(),c),cancel:f})}var n=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L22768",()=>{it("subsequent calls should return the result of the first call",async()=>{let e=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n);expect(e("a")).toBe("a"),expect(e("b")).toBe("a"),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n);let t=e("c"),a=e("d");expect(t).not.toBe("a"),expect(t).toBeDefined(),expect(a).not.toBe("d"),expect(a).toBeDefined()}),it("should support a `leading` option",()=>{let e=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n,{leading:!0}),t=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n,{leading:!1});expect(e("a")).toBe("a"),expect(t("a")).toBeUndefined()}),it("should support a `trailing` option",async()=>{let e=vi.fn(_chunkAQRYBCA3cjs.a.call(void 0, )),t=vi.fn(_chunkAQRYBCA3cjs.a.call(void 0, )),a=o(e,2*n,{trailing:!0}),i=o(t,2*n,{trailing:!1});expect(a("a")).toBe("a"),expect(a("b")).toBe("a"),expect(i("a")).toBe("a"),expect(i("b")).toBe("a"),await _chunkHC3HZK4Qcjs.a.call(void 0, 8*n),expect(e).toHaveBeenCalledTimes(2),expect(t).toHaveBeenCalledTimes(1)})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should reset `lastCalled` after cancelling",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!0});expect(t()).toBe(1),t.cancel(),expect(t()).toBe(2),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e).toBe(3)}),it("should support flushing delayed calls",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!1});t(),expect(t.flush()).toBe(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e).toBe(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(_chunkWLNQOMKLcjs.a.call(void 0, "hello")),t=o(e,n);t.cancel(),expect(t.flush()).toBeUndefined(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*n),expect(e).toHaveBeenCalledTimes(0)})});describe("features not tested by Lodash",()=>{it("does nothing when neither leading nor trailing are enabled",async()=>{let e=o(_chunkAQRYBCA3cjs.a.call(void 0, ),n,{leading:!1,trailing:!1});expect(e("hello")).toBeUndefined(),expect(e("world")).toBeUndefined(),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*n),expect(e("goodbye")).toBeUndefined()})});

package/dist/funnel.lodash-throttle-with-cached-value.test.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-throttle-with-cached-value.test.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-throttle-with-cached-value.test.js

@@ -0,0 +1 @@
+import{a as l}from"./chunk-46GBCFAG.js";import{a as s}from"./chunk-6SYP2DRD.js";import{a as u}from"./chunk-AWXJSK4F.js";import{a as d}from"./chunk-T5XG33UI.js";function o(e,t=0,{leading:a=!0,trailing:i=!0}={}){let c,{call:h,flush:p,cancel:f}=u(r=>{!a&&!i||(c=e(...r))},{reducer:(r,...g)=>g,minQuietPeriodMs:t,maxBurstDurationMs:t,...i?a?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign((...r)=>(h(...r),c),{flush:()=>(p(),c),cancel:f})}var n=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L22768",()=>{it("subsequent calls should return the result of the first call",async()=>{let e=o(l(),n);expect(e("a")).toBe("a"),expect(e("b")).toBe("a"),await s(2*n);let t=e("c"),a=e("d");expect(t).not.toBe("a"),expect(t).toBeDefined(),expect(a).not.toBe("d"),expect(a).toBeDefined()}),it("should support a `leading` option",()=>{let e=o(l(),n,{leading:!0}),t=o(l(),n,{leading:!1});expect(e("a")).toBe("a"),expect(t("a")).toBeUndefined()}),it("should support a `trailing` option",async()=>{let e=vi.fn(l()),t=vi.fn(l()),a=o(e,2*n,{trailing:!0}),i=o(t,2*n,{trailing:!1});expect(a("a")).toBe("a"),expect(a("b")).toBe("a"),expect(i("a")).toBe("a"),expect(i("b")).toBe("a"),await s(8*n),expect(e).toHaveBeenCalledTimes(2),expect(t).toHaveBeenCalledTimes(1)})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should reset `lastCalled` after cancelling",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!0});expect(t()).toBe(1),t.cancel(),expect(t()).toBe(2),t(),await s(2*n),expect(e).toBe(3)}),it("should support flushing delayed calls",async()=>{let e=0,t=o(()=>(e+=1,e),n,{leading:!1});t(),expect(t.flush()).toBe(1),await s(2*n),expect(e).toBe(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(d("hello")),t=o(e,n);t.cancel(),expect(t.flush()).toBeUndefined(),await s(2*n),expect(e).toHaveBeenCalledTimes(0)})});describe("features not tested by Lodash",()=>{it("does nothing when neither leading nor trailing are enabled",async()=>{let e=o(l(),n,{leading:!1,trailing:!1});expect(e("hello")).toBeUndefined(),expect(e("world")).toBeUndefined(),await s(4*n),expect(e("goodbye")).toBeUndefined()})});

package/dist/funnel.lodash-throttle.test.cjs

@@ -0,0 +1 @@
+"use strict";var _chunkHC3HZK4Qcjs = require('./chunk-HC3HZK4Q.cjs');var _chunkGOUUMCT7cjs = require('./chunk-GOUUMCT7.cjs');function l(e,t=0,{leading:o=!0,trailing:s=!0}={}){let{call:i,isIdle:u,...r}=_chunkGOUUMCT7cjs.a.call(void 0, c=>{!o&&!s||e(...c)},{reducer:(c,...h)=>h,minQuietPeriodMs:t,maxBurstDurationMs:t,...s?o?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign(i,r)}var a=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L22768",()=>{it("should throttle a function",async()=>{let e=vi.fn(),t=l(e,a);t(),t(),t();let o=e.mock.calls.length;expect(o).toBeGreaterThan(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e.mock.calls.length).toBeGreaterThan(o)}),it("should clear timeout when `func` is called",async()=>{let e=vi.fn(),t=l(e,a);t(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),t(),expect(e).toHaveBeenCalledTimes(2)}),it("should not trigger a trailing call when invoked once",async()=>{let e=vi.fn();l(e,a)(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should trigger a call when invoked repeatedly",()=>{let e=vi.fn(),t=l(e,a),o=Date.now()+10*a;for(;Date.now()<o;)t();expect(e).toHaveBeenCalledWith()}),it("should trigger a call when invoked repeatedly and `leading` is `false`",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1}),o=Date.now()+10*a;for(;Date.now()<o;)t();await _chunkHC3HZK4Qcjs.a.call(void 0, 0),expect(e).toHaveBeenCalledWith()}),it("should trigger a second throttled call as soon as possible",async()=>{let e=vi.fn(),t=l(e,4*a,{leading:!1});t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 6*a),expect(e).toHaveBeenCalledTimes(1),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should apply default options",async()=>{let e=vi.fn(),t=l(e,a,{});t(),t(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should support a `leading` option",()=>{let e=vi.fn(),t=vi.fn(),o=l(e,a,{leading:!0}),s=l(t,a,{leading:!1});o(),s(),expect(e).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledTimes(0)}),it("should support a `trailing` option",async()=>{let e=vi.fn(),t=vi.fn(),o=l(e,2*a,{trailing:!0}),s=l(t,2*a,{trailing:!1});o("a"),o("b"),s("a"),s("b"),expect(e).toHaveBeenCalledTimes(1),expect(e).toHaveBeenCalledWith("a"),expect(t).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledWith("a"),await _chunkHC3HZK4Qcjs.a.call(void 0, 8*a),expect(e).toHaveBeenCalledTimes(2),expect(t).toHaveBeenCalledTimes(1)}),it("should not update `lastCalled`, at the end of the timeout, when `trailing` is `false`",async()=>{let e=vi.fn(),t=l(e,64,{trailing:!1});t(),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 3*a),t(),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 3*a),expect(e).toHaveBeenCalledWith()})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should use a default `wait` of `0`",async()=>{let e=vi.fn(),t=l(e);t(),await _chunkHC3HZK4Qcjs.a.call(void 0, a),t(),expect(e).toHaveBeenCalledTimes(2)}),it("supports recursive calls",async()=>{let e=[],t=["a","b","c"],o=l(s=>{e.push(s);let i=t.shift();i!==void 0&&o(i)},a);o(t.shift()),expect(e).toStrictEqual(["a"]),await _chunkHC3HZK4Qcjs.a.call(void 0, 8*a),expect(e).toStrictEqual(["a","b","c"])}),it("should support cancelling delayed calls",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1});t(),t.cancel(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(0)}),it("should reset `lastCalled` after cancelling",async()=>{let e=vi.fn(),t=l(e,a,{leading:!0});t(),expect(e).toHaveBeenCalledTimes(1),t.cancel(),t(),expect(e).toHaveBeenCalledTimes(2),t(),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(3)}),it("should support flushing delayed calls",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1});t(),t.flush(),expect(e).toHaveBeenCalledTimes(1),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(),t=l(e,a);t.cancel(),t.flush(),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(0)})});describe("not tested by Lodash",()=>{it("should do nothing when `leading` and `trailing` are both `disabled`",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1,trailing:!1});t(),t(),t(),expect(e).toHaveBeenCalledTimes(0),await _chunkHC3HZK4Qcjs.a.call(void 0, 2*a),expect(e).toHaveBeenCalledTimes(0)})});

package/dist/funnel.lodash-throttle.test.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-throttle.test.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/funnel.lodash-throttle.test.js

@@ -0,0 +1 @@
+import{a as n}from"./chunk-6SYP2DRD.js";import{a as d}from"./chunk-AWXJSK4F.js";function l(e,t=0,{leading:o=!0,trailing:s=!0}={}){let{call:i,isIdle:u,...r}=d(c=>{!o&&!s||e(...c)},{reducer:(c,...h)=>h,minQuietPeriodMs:t,maxBurstDurationMs:t,...s?o?{triggerAt:"both"}:{triggerAt:"end"}:{triggerAt:"start"}});return Object.assign(i,r)}var a=16;describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L22768",()=>{it("should throttle a function",async()=>{let e=vi.fn(),t=l(e,a);t(),t(),t();let o=e.mock.calls.length;expect(o).toBeGreaterThan(0),await n(2*a),expect(e.mock.calls.length).toBeGreaterThan(o)}),it("should clear timeout when `func` is called",async()=>{let e=vi.fn(),t=l(e,a);t(),expect(e).toHaveBeenCalledTimes(1),await n(2*a),t(),expect(e).toHaveBeenCalledTimes(2)}),it("should not trigger a trailing call when invoked once",async()=>{let e=vi.fn();l(e,a)(),expect(e).toHaveBeenCalledTimes(1),await n(2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should trigger a call when invoked repeatedly",()=>{let e=vi.fn(),t=l(e,a),o=Date.now()+10*a;for(;Date.now()<o;)t();expect(e).toHaveBeenCalledWith()}),it("should trigger a call when invoked repeatedly and `leading` is `false`",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1}),o=Date.now()+10*a;for(;Date.now()<o;)t();await n(0),expect(e).toHaveBeenCalledWith()}),it("should trigger a second throttled call as soon as possible",async()=>{let e=vi.fn(),t=l(e,4*a,{leading:!1});t(),await n(6*a),expect(e).toHaveBeenCalledTimes(1),t(),await n(2*a),expect(e).toHaveBeenCalledTimes(1),await n(4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should apply default options",async()=>{let e=vi.fn(),t=l(e,a,{});t(),t(),expect(e).toHaveBeenCalledTimes(1),await n(4*a),expect(e).toHaveBeenCalledTimes(2)}),it("should support a `leading` option",()=>{let e=vi.fn(),t=vi.fn(),o=l(e,a,{leading:!0}),s=l(t,a,{leading:!1});o(),s(),expect(e).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledTimes(0)}),it("should support a `trailing` option",async()=>{let e=vi.fn(),t=vi.fn(),o=l(e,2*a,{trailing:!0}),s=l(t,2*a,{trailing:!1});o("a"),o("b"),s("a"),s("b"),expect(e).toHaveBeenCalledTimes(1),expect(e).toHaveBeenCalledWith("a"),expect(t).toHaveBeenCalledTimes(1),expect(t).toHaveBeenCalledWith("a"),await n(8*a),expect(e).toHaveBeenCalledTimes(2),expect(t).toHaveBeenCalledTimes(1)}),it("should not update `lastCalled`, at the end of the timeout, when `trailing` is `false`",async()=>{let e=vi.fn(),t=l(e,64,{trailing:!1});t(),t(),await n(3*a),t(),t(),await n(3*a),expect(e).toHaveBeenCalledWith()})});describe("https://github.com/lodash/lodash/blob/4.17.21/test/test.js#L23038",()=>{it("should use a default `wait` of `0`",async()=>{let e=vi.fn(),t=l(e);t(),await n(a),t(),expect(e).toHaveBeenCalledTimes(2)}),it("supports recursive calls",async()=>{let e=[],t=["a","b","c"],o=l(s=>{e.push(s);let i=t.shift();i!==void 0&&o(i)},a);o(t.shift()),expect(e).toStrictEqual(["a"]),await n(8*a),expect(e).toStrictEqual(["a","b","c"])}),it("should support cancelling delayed calls",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1});t(),t.cancel(),await n(2*a),expect(e).toHaveBeenCalledTimes(0)}),it("should reset `lastCalled` after cancelling",async()=>{let e=vi.fn(),t=l(e,a,{leading:!0});t(),expect(e).toHaveBeenCalledTimes(1),t.cancel(),t(),expect(e).toHaveBeenCalledTimes(2),t(),await n(2*a),expect(e).toHaveBeenCalledTimes(3)}),it("should support flushing delayed calls",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1});t(),t.flush(),expect(e).toHaveBeenCalledTimes(1),await n(2*a),expect(e).toHaveBeenCalledTimes(1)}),it("should noop `cancel` and `flush` when nothing is queued",async()=>{let e=vi.fn(),t=l(e,a);t.cancel(),t.flush(),expect(e).toHaveBeenCalledTimes(0),await n(2*a),expect(e).toHaveBeenCalledTimes(0)})});describe("not tested by Lodash",()=>{it("should do nothing when `leading` and `trailing` are both `disabled`",async()=>{let e=vi.fn(),t=l(e,a,{leading:!1,trailing:!1});t(),t(),t(),expect(e).toHaveBeenCalledTimes(0),await n(2*a),expect(e).toHaveBeenCalledTimes(0)})});