ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / local / lib / node_modules / ghost-cli / node_modules / rxjs / src / internal / operators

import { Operator } from '../Operator';
import { Subscriber } from '../Subscriber';
import { Subscription } from '../Subscription';
import { async } from '../scheduler/async';
import { Observable } from '../Observable';
import { ThrottleConfig, defaultThrottleConfig } from './throttle';
import { MonoTypeOperatorFunction, SchedulerLike, TeardownLogic } from '../types';

/**
 * Emits a value from the source Observable, then ignores subsequent source
 * values for `duration` milliseconds, then repeats this process.
 *
 * <span class="informal">Lets a value pass, then ignores source values for the
 * next `duration` milliseconds.</span>
 *
 * ![](throttleTime.png)
 *
 * `throttleTime` emits the source Observable values on the output Observable
 * when its internal timer is disabled, and ignores source values when the timer
 * is enabled. Initially, the timer is disabled. As soon as the first source
 * value arrives, it is forwarded to the output Observable, and then the timer
 * is enabled. After `duration` milliseconds (or the time unit determined
 * internally by the optional `scheduler`) has passed, the timer is disabled,
 * and this process repeats for the next source value. Optionally takes a
 * {@link SchedulerLike} for managing timers.
 *
 * ## Examples
 *
 * #### Limit click rate
 *
 * Emit clicks at a rate of at most one click per second
 * ```ts
 * import { fromEvent } from 'rxjs';
 * import { throttleTime } from 'rxjs/operators';
 *
 * const clicks = fromEvent(document, 'click');
 * const result = clicks.pipe(throttleTime(1000));
 * result.subscribe(x => console.log(x));
 * ```
 *
 * #### Double Click
 *
 * The following example only emits clicks which happen within a subsequent
 * delay of 400ms of the previous click. This for example can emulate a double
 * click. It makes use of the `trailing` parameter of the throttle configuration.
 *
 * ```ts
 * import { fromEvent, asyncScheduler } from 'rxjs';
 * import { throttleTime, withLatestFrom } from 'rxjs/operators';
 *
 * // defaultThottleConfig = { leading: true, trailing: false }
 * const throttleConfig = {
 *   leading: false,
 *   trailing: true
 * }
 *
 * const click = fromEvent(document, 'click');
 * const doubleClick = click.pipe(
 *   throttleTime(400, asyncScheduler, throttleConfig)
 * );
 *
 * doubleClick.subscribe((throttleValue: Event) => {
 *   console.log(`Double-clicked! Timestamp: ${throttleValue.timeStamp}`);
 * });
 * ```
 *
 * If you enable the `leading` parameter in this example, the output would be the primary click and
 * the double click, but restricts additional clicks within 400ms.
 *
 * @see {@link auditTime}
 * @see {@link debounceTime}
 * @see {@link delay}
 * @see {@link sampleTime}
 * @see {@link throttle}
 *
 * @param {number} duration Time to wait before emitting another value after
 * emitting the last value, measured in milliseconds or the time unit determined
 * internally by the optional `scheduler`.
 * @param {SchedulerLike} [scheduler=async] The {@link SchedulerLike} to use for
 * managing the timers that handle the throttling.
 * @param {Object} config a configuration object to define `leading` and
 * `trailing` behavior. Defaults to `{ leading: true, trailing: false }`.
 * @return {Observable<T>} An Observable that performs the throttle operation to
 * limit the rate of emissions from the source.
 * @method throttleTime
 * @owner Observable
 */
export function throttleTime<T>(duration: number,
                                scheduler: SchedulerLike = async,
                                config: ThrottleConfig = defaultThrottleConfig): MonoTypeOperatorFunction<T> {
  return (source: Observable<T>) => source.lift(new ThrottleTimeOperator(duration, scheduler, config.leading, config.trailing));
}

class ThrottleTimeOperator<T> implements Operator<T, T> {
  constructor(private duration: number,
              private scheduler: SchedulerLike,
              private leading: boolean,
              private trailing: boolean) {
  }

call(subscriber: Subscriber<T>, source: any): TeardownLogic {
    return source.subscribe(
      new ThrottleTimeSubscriber(subscriber, this.duration, this.scheduler, this.leading, this.trailing)
    );
  }
}

/**
 * We need this JSDoc comment for affecting ESDoc.
 * @ignore
 * @extends {Ignored}
 */
class ThrottleTimeSubscriber<T> extends Subscriber<T> {
  private throttled: Subscription;
  private _hasTrailingValue: boolean = false;
  private _trailingValue: T = null;

constructor(destination: Subscriber<T>,
              private duration: number,
              private scheduler: SchedulerLike,
              private leading: boolean,
              private trailing: boolean) {
    super(destination);
  }

protected _next(value: T) {
    if (this.throttled) {
      if (this.trailing) {
        this._trailingValue = value;
        this._hasTrailingValue = true;
      }
    } else {
      this.add(this.throttled = this.scheduler.schedule<DispatchArg<T>>(dispatchNext, this.duration, { subscriber: this }));
      if (this.leading) {
        this.destination.next(value);
      } else if (this.trailing) {
        this._trailingValue = value;
        this._hasTrailingValue = true;
      }
    }
  }

protected _complete() {
    if (this._hasTrailingValue) {
      this.destination.next(this._trailingValue);
      this.destination.complete();
    } else {
      this.destination.complete();
    }
  }

clearThrottle() {
    const throttled = this.throttled;
    if (throttled) {
      if (this.trailing && this._hasTrailingValue) {
        this.destination.next(this._trailingValue);
        this._trailingValue = null;
        this._hasTrailingValue = false;
      }
      throttled.unsubscribe();
      this.remove(throttled);
      this.throttled = null;
    }
  }
}

interface DispatchArg<T> {
  subscriber: ThrottleTimeSubscriber<T>;
}

function dispatchNext<T>(arg: DispatchArg<T>) {
  const { subscriber } = arg;
  subscriber.clearThrottle();
}

[-] toArray.ts [edit]
[-] window.ts [edit]
[-] retry.ts [edit]
[-] mergeAll.ts [edit]
[-] windowWhen.ts [edit]
[-] every.ts [edit]
[-] timeout.ts [edit]
[-] debounceTime.ts [edit]
[-] index.ts [edit]
[-] takeWhile.ts [edit]
[-] audit.ts [edit]
[-] reduce.ts [edit]
[-] mapTo.ts [edit]
[-] count.ts [edit]
[-] debounce.ts [edit]
[-] throwIfEmpty.ts [edit]
[-] auditTime.ts [edit]
[-] scan.ts [edit]
[-] switchAll.ts [edit]
[-] map.ts [edit]
[-] bufferCount.ts [edit]
[-] mergeScan.ts [edit]
[-] publish.ts [edit]
[-] min.ts [edit]
[+] ..
[-] publishReplay.ts [edit]
[-] bufferTime.ts [edit]
[-] share.ts [edit]
[-] repeat.ts [edit]
[-] distinct.ts [edit]
[-] concatMapTo.ts [edit]
[-] buffer.ts [edit]
[-] concatMap.ts [edit]
[-] max.ts [edit]
[-] partition.ts [edit]
[-] observeOn.ts [edit]
[-] bufferWhen.ts [edit]
[-] dematerialize.ts [edit]
[-] throttle.ts [edit]
[-] groupBy.ts [edit]
[-] withLatestFrom.ts [edit]
[-] exhaust.ts [edit]
[-] exhaustMap.ts [edit]
[-] retryWhen.ts [edit]
[-] zipAll.ts [edit]
[-] find.ts [edit]
[-] mergeMap.ts [edit]
[-] single.ts [edit]
[-] last.ts [edit]
[-] combineLatest.ts [edit]
[-] publishLast.ts [edit]
[-] pluck.ts [edit]
[-] pairwise.ts [edit]
[-] distinctUntilChanged.ts [edit]
[-] timeInterval.ts [edit]
[-] shareReplay.ts [edit]
[-] skipUntil.ts [edit]
[-] findIndex.ts [edit]
[-] windowToggle.ts [edit]
[-] startWith.ts [edit]
[-] timeoutWith.ts [edit]
[-] concat.ts [edit]
[-] materialize.ts [edit]
[-] timestamp.ts [edit]
[-] onErrorResumeNext.ts [edit]
[-] subscribeOn.ts [edit]
[-] takeUntil.ts [edit]
[-] skipLast.ts [edit]
[-] throttleTime.ts [edit]
[-] mergeMapTo.ts [edit]
[-] multicast.ts [edit]
[-] merge.ts [edit]
[-] takeLast.ts [edit]
[-] delayWhen.ts [edit]
[-] sampleTime.ts [edit]
[-] tap.ts [edit]
[-] take.ts [edit]
[-] sample.ts [edit]
[-] filter.ts [edit]
[-] skip.ts [edit]
[-] expand.ts [edit]
[-] publishBehavior.ts [edit]
[-] sequenceEqual.ts [edit]
[-] ignoreElements.ts [edit]
[-] catchError.ts [edit]
[-] endWith.ts [edit]
[-] refCount.ts [edit]
[-] windowCount.ts [edit]
[-] defaultIfEmpty.ts [edit]
[-] windowTime.ts [edit]
[-] switchMapTo.ts [edit]
[-] switchMap.ts [edit]
[-] delay.ts [edit]
[-] bufferToggle.ts [edit]
[-] repeatWhen.ts [edit]
[-] concatAll.ts [edit]
[-] first.ts [edit]
[-] zip.ts [edit]
[-] elementAt.ts [edit]
[-] skipWhile.ts [edit]
[-] race.ts [edit]
[-] finalize.ts [edit]
[-] combineAll.ts [edit]
[-] distinctUntilKeyChanged.ts [edit]
[-] isEmpty.ts [edit]