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

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

import { Observable } from '../Observable';
import { async } from '../scheduler/async';
import { SchedulerLike, OperatorFunction } from '../types';
import { scan } from './scan';
import { defer } from '../observable/defer';
import { map } from './map';

/**
 *
 * Emits an object containing the current value, and the time that has
 * passed between emitting the current value and the previous value, which is
 * calculated by using the provided `scheduler`'s `now()` method to retrieve
 * the current time at each emission, then calculating the difference. The `scheduler`
 * defaults to {@link asyncScheduler}, so by default, the `interval` will be in
 * milliseconds.
 *
 * <span class="informal">Convert an Observable that emits items into one that
 * emits indications of the amount of time elapsed between those emissions.</span>
 *
 * ![](timeinterval.png)
 *
 * ## Examples
 * Emit inteval between current value with the last value
 *
 * ```ts
 * const seconds = interval(1000);
 *
 * seconds.pipe(timeInterval())
 * .subscribe(
 *     value => console.log(value),
 *     err => console.log(err),
 * );
 *
 * seconds.pipe(timeout(900))
 * .subscribe(
 *     value => console.log(value),
 *     err => console.log(err),
 * );
 *
 * // NOTE: The values will never be this precise,
 * // intervals created with `interval` or `setInterval`
 * // are non-deterministic.
 *
 * // {value: 0, interval: 1000}
 * // {value: 1, interval: 1000}
 * // {value: 2, interval: 1000}
 * ```
 *
 * @param {SchedulerLike} [scheduler] Scheduler used to get the current time.
 * @return {Observable<{ interval: number, value: T }>} Observable that emit infomation about value and interval
 * @method timeInterval
 */
export function timeInterval<T>(scheduler: SchedulerLike = async): OperatorFunction<T, TimeInterval<T>> {
  return (source: Observable<T>) => defer(() => {
    return source.pipe(
      // TODO(benlesh): correct these typings.
      scan(
        ({ current }, value) => ({ value, current: scheduler.now(), last: current }),
        { current: scheduler.now(), value: undefined,  last: undefined }
      ) as any,
      map<any, TimeInterval<T>>(({ current, last, value }) => new TimeInterval(value, current - last)),
    );
  });
}

// TODO(benlesh): make this an interface, export the interface, but not the implemented class,
// there's no reason users should be manually creating this type.

/**
 * @deprecated exposed API, use as interface only.
 */
export class TimeInterval<T> {
  constructor(public value: T, public interval: number) {}
}

[-] 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]