import { Operator } from './Operator'; import { Subscriber } from './Subscriber'; import { Subscription } from './Subscription'; import { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types'; /** * A representation of any set of values over any amount of time. This is the most basic building block * of RxJS. * * @class Observable */ export declare class Observable implements Subscribable { /** * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */ source: Observable | undefined; /** * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */ operator: Operator | undefined; /** * @constructor * @param {Function} subscribe the function that is called when the Observable is * initially subscribed to. This function is given a Subscriber, to which new values * can be `next`ed, or an `error` method can be called to raise an error, or * `complete` can be called to notify of a successful completion. */ constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic); /** * Creates a new Observable by calling the Observable constructor * @owner Observable * @method create * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor * @return {Observable} a new observable * @nocollapse * @deprecated Use `new Observable()` instead. Will be removed in v8. */ static create: (...args: any[]) => any; /** * Creates a new Observable, with this Observable instance as the source, and the passed * operator defined as the new observable's operator. * @method lift * @param operator the operator defining the operation to take on the observable * @return a new observable with the Operator applied * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. * If you have implemented an operator using `lift`, it is recommended that you create an * operator by simply returning `new Observable()` directly. See "Creating new operators from * scratch" section here: https://rxjs.dev/guide/operators */ lift(operator?: Operator): Observable; subscribe(observer?: Partial>): Subscription; subscribe(next: (value: T) => void): Subscription; /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */ subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription; /** * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with * APIs that expect promises, like `async/await`. You cannot unsubscribe from this. * * **WARNING**: Only use this with observables you *know* will complete. If the source * observable does not complete, you will end up with a promise that is hung up, and * potentially all of the state of an async function hanging out in memory. To avoid * this situation, look into adding something like {@link timeout}, {@link take}, * {@link takeWhile}, or {@link takeUntil} amongst others. * * ## Example * * ```ts * import { interval, take } from 'rxjs'; * * const source$ = interval(1000).pipe(take(4)); * * async function getTotal() { * let total = 0; * * await source$.forEach(value => { * total += value; * console.log('observable -> ' + value); * }); * * return total; * } * * getTotal().then( * total => console.log('Total: ' + total) * ); * * // Expected: * // 'observable -> 0' * // 'observable -> 1' * // 'observable -> 2' * // 'observable -> 3' * // 'Total: 6' * ``` * * @param next a handler for each value emitted by the observable * @return a promise that either resolves on observable completion or * rejects with the handled error */ forEach(next: (value: T) => void): Promise; /** * @param next a handler for each value emitted by the observable * @param promiseCtor a constructor function used to instantiate the Promise * @return a promise that either resolves on observable completion or * rejects with the handled error * @deprecated Passing a Promise constructor will no longer be available * in upcoming versions of RxJS. This is because it adds weight to the library, for very * little benefit. If you need this functionality, it is recommended that you either * polyfill Promise, or you create an adapter to convert the returned native promise * to whatever promise implementation you wanted. Will be removed in v8. */ forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise; pipe(): Observable; pipe(op1: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction, op5: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction, op5: OperatorFunction, op6: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction, op5: OperatorFunction, op6: OperatorFunction, op7: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction, op5: OperatorFunction, op6: OperatorFunction, op7: OperatorFunction, op8: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction, op5: OperatorFunction, op6: OperatorFunction, op7: OperatorFunction, op8: OperatorFunction, op9: OperatorFunction): Observable; pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction, op4: OperatorFunction, op5: OperatorFunction, op6: OperatorFunction, op7: OperatorFunction, op8: OperatorFunction, op9: OperatorFunction, ...operations: OperatorFunction[]): Observable; /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */ toPromise(): Promise; /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */ toPromise(PromiseCtor: typeof Promise): Promise; /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */ toPromise(PromiseCtor: PromiseConstructorLike): Promise; } //# sourceMappingURL=Observable.d.ts.map