UNPKG

@reactivex/rxjs

Version:

Reactive Extensions for modern JavaScript

53 lines 1.87 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); var async_1 = require("../scheduler/async"); var map_1 = require("./map"); /** * Attaches a timestamp to each item emitted by an observable indicating when it was emitted * * The `timestamp` operator maps the *source* observable stream to an object of type * `{value: T, timestamp: R}`. The properties are generically typed. The `value` property contains the value * and type of the *source* observable. The `timestamp` is generated by the schedulers `now` function. By * default it uses the *async* scheduler which simply returns `Date.now()` (milliseconds since 1970/01/01 * 00:00:00:000) and therefore is of type `number`. * * ![](timestamp.png) * * ## Example * * In this example there is a timestamp attached to the documents click event. * * ```ts * import { fromEvent } from 'rxjs'; * import { timestamp } from 'rxjs/operators'; * * const clickWithTimestamp = fromEvent(document, 'click').pipe( * timestamp() * ); * * // Emits data of type {value: MouseEvent, timestamp: number} * clickWithTimestamp.subscribe(data => { * console.log(data); * }); * ``` * * @param scheduler * @return {Observable<Timestamp<any>>|WebSocketSubject<T>|Observable<T>} * @method timestamp * @owner Observable */ function timestamp(scheduler) { if (scheduler === void 0) { scheduler = async_1.async; } return map_1.map(function (value) { return new Timestamp(value, scheduler.now()); }); // return (source: Observable<T>) => source.lift(new TimestampOperator(scheduler)); } exports.timestamp = timestamp; var Timestamp = /** @class */ (function () { function Timestamp(value, timestamp) { this.value = value; this.timestamp = timestamp; } return Timestamp; }()); exports.Timestamp = Timestamp; //# sourceMappingURL=timestamp.js.map