@johngw/stream
Version:
Reactive programming tools using the WHATWG Streams API.
76 lines • 2.66 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.debounce = exports.DebounceTrailingBehavior = void 0;
const Transformer_1 = require("#transformers/debounce/Transformer");
const TrailingBehavior_1 = require("#transformers/debounce/TrailingBehavior");
Object.defineProperty(exports, "DebounceTrailingBehavior", { enumerable: true, get: function () { return TrailingBehavior_1.DebounceTrailingBehavior; } });
__exportStar(require("#transformers/debounce/BackOffBehavior"), exports);
__exportStar(require("#transformers/debounce/State"), exports);
__exportStar(require("#transformers/debounce/LeadingBehavior"), exports);
/**
* Delays queuing until after `ms` milliseconds have elapsed
* since the last time this transformer received anything.
* The queuing behavior is configurable.
*
* @see {@link DebounceLeadingBehavior:class}
* @see {@link DebounceTrailingBehavior:class}
* @see {@link DebounceBackOffBehavior:class}
* @group Transformers
* @example
* Using the trailing behavior.
* ```
* --a-b-c--------------d-----------
*
* debounce(20)
* // Same as...
* debounce(20, new DebounceTrailingBehavior())
*
* -------------c---------------d---
* ```
*
* @example
* Using the leading behavior.
* ```
* --a-b-c--------------d-----------
*
* debounce(20, new DebounceLeadingBehavior())
*
* ---a------------------d----------
* ```
*
* @example
* Using both leading and trailing behaviors
* ```
* --a-b-c--------------d-----------
*
* debounce(20, [
* new DebounceLeadingBehavior(),
* new DebounceTrailingBehavior()
*])
*
* ---a----------c--------d----------
* ```
*/
function debounce(ms, behaviors) {
return new TransformStream(new Transformer_1.DebounceTransformer(ms, !behaviors
? [new TrailingBehavior_1.DebounceTrailingBehavior()]
: Array.isArray(behaviors)
? behaviors
: [behaviors]));
}
exports.debounce = debounce;
//# sourceMappingURL=debounce.js.map