| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295 |
- import { IScheduler } from '../Scheduler';
- import { Action } from '../scheduler/Action';
- import { Observable } from '../Observable' ;
- import { Subscriber } from '../Subscriber';
- import { Subscription } from '../Subscription';
- import { isScheduler } from '../util/isScheduler';
- const selfSelector = <T>(value: T) => value;
- export type ConditionFunc<S> = (state: S) => boolean;
- export type IterateFunc<S> = (state: S) => S;
- export type ResultFunc<S, T> = (state: S) => T;
- interface SchedulerState<T, S> {
- needIterate?: boolean;
- state: S;
- subscriber: Subscriber<T>;
- condition?: ConditionFunc<S>;
- iterate: IterateFunc<S>;
- resultSelector: ResultFunc<S, T>;
- }
- export interface GenerateBaseOptions<S> {
- /**
- * Initial state.
- */
- initialState: S;
- /**
- * Condition function that accepts state and returns boolean.
- * When it returns false, the generator stops.
- * If not specified, a generator never stops.
- */
- condition?: ConditionFunc<S>;
- /**
- * Iterate function that accepts state and returns new state.
- */
- iterate: IterateFunc<S>;
- /**
- * IScheduler to use for generation process.
- * By default, a generator starts immediately.
- */
- scheduler?: IScheduler;
- }
- export interface GenerateOptions<T, S> extends GenerateBaseOptions<S> {
- /**
- * Result selection function that accepts state and returns a value to emit.
- */
- resultSelector: ResultFunc<S, T>;
- }
- /**
- * We need this JSDoc comment for affecting ESDoc.
- * @extends {Ignored}
- * @hide true
- */
- export class GenerateObservable<T, S> extends Observable<T> {
- constructor(private initialState: S,
- private condition: ConditionFunc<S>,
- private iterate: IterateFunc<S>,
- private resultSelector: ResultFunc<S, T>,
- private scheduler?: IScheduler) {
- super();
- }
- /**
- * Generates an observable sequence by running a state-driven loop
- * producing the sequence's elements, using the specified scheduler
- * to send out observer messages.
- *
- * <img src="./img/generate.png" width="100%">
- *
- * @example <caption>Produces sequence of 0, 1, 2, ... 9, then completes.</caption>
- * var res = Rx.Observable.generate(0, x => x < 10, x => x + 1, x => x);
- *
- * @example <caption>Using asap scheduler, produces sequence of 2, 3, 5, then completes.</caption>
- * var res = Rx.Observable.generate(1, x => x < 5, x => x * 2, x => x + 1, Rx.Scheduler.asap);
- *
- * @see {@link from}
- * @see {@link create}
- *
- * @param {S} initialState Initial state.
- * @param {function (state: S): boolean} condition Condition to terminate generation (upon returning false).
- * @param {function (state: S): S} iterate Iteration step function.
- * @param {function (state: S): T} resultSelector Selector function for results produced in the sequence.
- * @param {Scheduler} [scheduler] A {@link IScheduler} on which to run the generator loop. If not provided, defaults to emit immediately.
- * @returns {Observable<T>} The generated sequence.
- */
- static create<T, S>(initialState: S,
- condition: ConditionFunc<S>,
- iterate: IterateFunc<S>,
- resultSelector: ResultFunc<S, T>,
- scheduler?: IScheduler): Observable<T>
- /**
- * Generates an observable sequence by running a state-driven loop
- * producing the sequence's elements, using the specified scheduler
- * to send out observer messages.
- * The overload uses state as an emitted value.
- *
- * <img src="./img/generate.png" width="100%">
- *
- * @example <caption>Produces sequence of 0, 1, 2, ... 9, then completes.</caption>
- * var res = Rx.Observable.generate(0, x => x < 10, x => x + 1);
- *
- * @example <caption>Using asap scheduler, produces sequence of 1, 2, 4, then completes.</caption>
- * var res = Rx.Observable.generate(1, x => x < 5, x => x * 2, Rx.Scheduler.asap);
- *
- * @see {@link from}
- * @see {@link create}
- *
- * @param {S} initialState Initial state.
- * @param {function (state: S): boolean} condition Condition to terminate generation (upon returning false).
- * @param {function (state: S): S} iterate Iteration step function.
- * @param {Scheduler} [scheduler] A {@link IScheduler} on which to run the generator loop. If not provided, defaults to emit immediately.
- * @returns {Observable<S>} The generated sequence.
- */
- static create<S>(initialState: S,
- condition: ConditionFunc<S>,
- iterate: IterateFunc<S>,
- scheduler?: IScheduler): Observable<S>
- /**
- * Generates an observable sequence by running a state-driven loop
- * producing the sequence's elements, using the specified scheduler
- * to send out observer messages.
- * The overload accepts options object that might contain initial state, iterate,
- * condition and scheduler.
- *
- * <img src="./img/generate.png" width="100%">
- *
- * @example <caption>Produces sequence of 0, 1, 2, ... 9, then completes.</caption>
- * var res = Rx.Observable.generate({
- * initialState: 0,
- * condition: x => x < 10,
- * iterate: x => x + 1
- * });
- *
- * @see {@link from}
- * @see {@link create}
- *
- * @param {GenerateBaseOptions<S>} options Object that must contain initialState, iterate and might contain condition and scheduler.
- * @returns {Observable<S>} The generated sequence.
- */
- static create<S>(options: GenerateBaseOptions<S>): Observable<S>
- /**
- * Generates an observable sequence by running a state-driven loop
- * producing the sequence's elements, using the specified scheduler
- * to send out observer messages.
- * The overload accepts options object that might contain initial state, iterate,
- * condition, result selector and scheduler.
- *
- * <img src="./img/generate.png" width="100%">
- *
- * @example <caption>Produces sequence of 0, 1, 2, ... 9, then completes.</caption>
- * var res = Rx.Observable.generate({
- * initialState: 0,
- * condition: x => x < 10,
- * iterate: x => x + 1,
- * resultSelector: x => x
- * });
- *
- * @see {@link from}
- * @see {@link create}
- *
- * @param {GenerateOptions<T, S>} options Object that must contain initialState, iterate, resultSelector and might contain condition and scheduler.
- * @returns {Observable<T>} The generated sequence.
- */
- static create<T, S>(options: GenerateOptions<T, S>): Observable<T>
- static create<T, S>(initialStateOrOptions: S | GenerateOptions<T, S>,
- condition?: ConditionFunc<S>,
- iterate?: IterateFunc<S>,
- resultSelectorOrObservable?: (ResultFunc<S, T>) | IScheduler,
- scheduler?: IScheduler): Observable<T> {
- if (arguments.length == 1) {
- return new GenerateObservable<T, S>(
- (<GenerateOptions<T, S>>initialStateOrOptions).initialState,
- (<GenerateOptions<T, S>>initialStateOrOptions).condition,
- (<GenerateOptions<T, S>>initialStateOrOptions).iterate,
- (<GenerateOptions<T, S>>initialStateOrOptions).resultSelector || selfSelector as ResultFunc<S, T>,
- (<GenerateOptions<T, S>>initialStateOrOptions).scheduler);
- }
- if (resultSelectorOrObservable === undefined || isScheduler(resultSelectorOrObservable)) {
- return new GenerateObservable<T, S>(
- <S>initialStateOrOptions,
- condition,
- iterate,
- selfSelector as ResultFunc<S, T>,
- <IScheduler>resultSelectorOrObservable);
- }
- return new GenerateObservable<T, S>(
- <S>initialStateOrOptions,
- condition,
- iterate,
- <ResultFunc<S, T>>resultSelectorOrObservable,
- <IScheduler>scheduler);
- }
- /** @deprecated internal use only */ _subscribe(subscriber: Subscriber<any>): Subscription | Function | void {
- let state = this.initialState;
- if (this.scheduler) {
- return this.scheduler.schedule<SchedulerState<T, S>>(GenerateObservable.dispatch, 0, {
- subscriber,
- iterate: this.iterate,
- condition: this.condition,
- resultSelector: this.resultSelector,
- state });
- }
- const { condition, resultSelector, iterate } = this;
- do {
- if (condition) {
- let conditionResult: boolean;
- try {
- conditionResult = condition(state);
- } catch (err) {
- subscriber.error(err);
- return;
- }
- if (!conditionResult) {
- subscriber.complete();
- break;
- }
- }
- let value: T;
- try {
- value = resultSelector(state);
- } catch (err) {
- subscriber.error(err);
- return;
- }
- subscriber.next(value);
- if (subscriber.closed) {
- break;
- }
- try {
- state = iterate(state);
- } catch (err) {
- subscriber.error(err);
- return;
- }
- } while (true);
- }
- private static dispatch<T, S>(state: SchedulerState<T, S>): Subscription | void {
- const { subscriber, condition } = state;
- if (subscriber.closed) {
- return;
- }
- if (state.needIterate) {
- try {
- state.state = state.iterate(state.state);
- } catch (err) {
- subscriber.error(err);
- return;
- }
- } else {
- state.needIterate = true;
- }
- if (condition) {
- let conditionResult: boolean;
- try {
- conditionResult = condition(state.state);
- } catch (err) {
- subscriber.error(err);
- return;
- }
- if (!conditionResult) {
- subscriber.complete();
- return;
- }
- if (subscriber.closed) {
- return;
- }
- }
- let value: T;
- try {
- value = state.resultSelector(state.state);
- } catch (err) {
- subscriber.error(err);
- return;
- }
- if (subscriber.closed) {
- return;
- }
- subscriber.next(value);
- if (subscriber.closed) {
- return;
- }
- return (<Action<SchedulerState<T, S>>><any>this).schedule(state);
- }
- }
|