Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BehaviorSubject<boolean>
    • LoadingEmitter

Index

Constructors

Properties

_isScalar: boolean

Internal implementation detail, do not use directly.

closed: boolean
hasError: boolean
isStopped: boolean
observers: Observer<boolean>[]
operator: Operator<any, boolean>
deprecated

This is an internal implementation detail, do not use.

source: Observable<any>
deprecated

This is an internal implementation detail, do not use.

thrownError: any
value: boolean
create: Function
nocollapse
deprecated

use new Subject() instead

if: (<T, F>(condition: (() => boolean), trueResult?: SubscribableOrPromise<T>, falseResult?: SubscribableOrPromise<F>) => Observable<T | F>)

Type declaration

    • <T, F>(condition: (() => boolean), trueResult?: SubscribableOrPromise<T>, falseResult?: SubscribableOrPromise<F>): Observable<T | F>
    • Decides at subscription time which Observable will actually be subscribed.

      If statement for Observables.

      iif accepts a condition function and two Observables. When an Observable returned by the operator is subscribed, condition function will be called. Based on what boolean it returns at that moment, consumer will subscribe either to the first Observable (if condition was true) or to the second (if condition was false). Condition function may also not return anything - in that case condition will be evaluated as false and second Observable will be subscribed.

      Note that Observables for both cases (true and false) are optional. If condition points to an Observable that was left undefined, resulting stream will simply complete immediately. That allows you to, rather than controlling which Observable will be subscribed, decide at runtime if consumer should have access to given Observable or not.

      If you have more complex logic that requires decision between more than two Observables, {@link defer} will probably be a better choice. Actually iif can be easily implemented with {@link defer} and exists only for convenience and readability reasons.

      Examples

      Change at runtime which Observable will be subscribed

      import { iif, of } from 'rxjs';

      let subscribeToFirst;
      const firstOrSecond = iif(
      () => subscribeToFirst,
      of('first'),
      of('second'),
      );

      subscribeToFirst = true;
      firstOrSecond.subscribe(value => console.log(value));

      // Logs:
      // "first"

      subscribeToFirst = false;
      firstOrSecond.subscribe(value => console.log(value));

      // Logs:
      // "second"

      Control an access to an Observable

      let accessGranted;
      const observableIfYouHaveAccess = iif(
      () => accessGranted,
      of('It seems you have an access...'), // Note that only one Observable is passed to the operator.
      );

      accessGranted = true;
      observableIfYouHaveAccess.subscribe(
      value => console.log(value),
      err => {},
      () => console.log('The end'),
      );

      // Logs:
      // "It seems you have an access..."
      // "The end"

      accessGranted = false;
      observableIfYouHaveAccess.subscribe(
      value => console.log(value),
      err => {},
      () => console.log('The end'),
      );

      // Logs:
      // "The end"
      see

      {@link defer}

      static

      true

      name

      iif

      owner

      Observable

      Type Parameters

      • T = never

      • F = never

      Parameters

      • condition: (() => boolean)

        Condition which Observable should be chosen.

          • (): boolean
          • Returns boolean

      • Optional trueResult: SubscribableOrPromise<T>
      • Optional falseResult: SubscribableOrPromise<F>

      Returns Observable<T | F>

      Either first or second Observable, depending on condition.

throw: ((error: any, scheduler?: SchedulerLike) => Observable<never>)

Type declaration

    • (error: any, scheduler?: SchedulerLike): Observable<never>
    • Creates an Observable that emits no items to the Observer and immediately emits an error notification.

      Just emits 'error', and nothing else.

      This static operator is useful for creating a simple Observable that only emits the error notification. It can be used for composing with other Observables, such as in a {@link mergeMap}.

      Examples

      Emit the number 7, then emit an error

      import { throwError, concat, of } from 'rxjs';

      const result = concat(of(7), throwError(new Error('oops!')));
      result.subscribe(x => console.log(x), e => console.error(e));

      // Logs:
      // 7
      // Error: oops!

      Map and flatten numbers to the sequence 'a', 'b', 'c', but throw an error for 2

      import { throwError, interval, of } from 'rxjs';
      import { mergeMap } from 'rxjs/operators';

      interval(1000).pipe(
      mergeMap(x => x === 2
      ? throwError('Twos are bad')
      : of('a', 'b', 'c')
      ),
      ).subscribe(x => console.log(x), e => console.error(e));

      // Logs:
      // a
      // b
      // c
      // a
      // b
      // c
      // Twos are bad
      see

      {@link Observable}

      see

      empty

      see

      {@link never}

      see

      {@link of}

      static

      true

      name

      throwError

      owner

      Observable

      Parameters

      • error: any

        The particular Error to pass to the error notification.

      • Optional scheduler: SchedulerLike

      Returns Observable<never>

      An error Observable: emits only the error notification using the given error argument.

Accessors

  • get isActive(): boolean

Methods

  • _subscribe(subscriber: Subscriber<boolean>): Subscription
  • deprecated

    This is an internal implementation detail, do not use.

    Parameters

    • subscriber: Subscriber<boolean>

    Returns Subscription

  • _trySubscribe(subscriber: Subscriber<boolean>): TeardownLogic
  • deprecated

    This is an internal implementation detail, do not use.

    Parameters

    • subscriber: Subscriber<boolean>

    Returns TeardownLogic

  • asObservable(): Observable<boolean>
  • Creates a new Observable with this Subject as the source. You can do this to create customize Observer-side logic of the Subject and conceal it from code that uses the Observable.

    Returns Observable<boolean>

    Observable that the Subject casts to

  • complete(): void
  • Returns void

  • error(err: any): void
  • Parameters

    • err: any

    Returns void

  • forEach(next: ((value: boolean) => void), promiseCtor?: PromiseConstructorLike): Promise<void>
  • method

    forEach

    Parameters

    • next: ((value: boolean) => void)

      a handler for each value emitted by the observable

        • (value: boolean): void
        • Parameters

          • value: boolean

          Returns void

    • Optional promiseCtor: PromiseConstructorLike

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

  • getValue(): boolean
  • Returns boolean

  • lift<R>(operator: Operator<boolean, R>): Observable<R>
  • Type Parameters

    • R

    Parameters

    • operator: Operator<boolean, R>

    Returns Observable<R>

  • next(value: boolean): void
  • Parameters

    • value: boolean

    Returns void

  • off(): void
  • on(): void
  • pipe(): Observable<boolean>
  • pipe<A>(op1: OperatorFunction<boolean, A>): Observable<A>
  • pipe<A, B>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>): Observable<B>
  • pipe<A, B, C>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
  • pipe<A, B, C, D>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
  • pipe<A, B, C, D, E>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>): Observable<E>
  • pipe<A, B, C, D, E, F>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>): Observable<F>
  • pipe<A, B, C, D, E, F, G>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>): Observable<G>
  • pipe<A, B, C, D, E, F, G, H>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>): Observable<H>
  • pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>, op9: OperatorFunction<H, I>): Observable<I>
  • pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<boolean, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>, op9: OperatorFunction<H, I>, ...operations: OperatorFunction<any, any>[]): Observable<{}>
  • Returns Observable<boolean>

  • Type Parameters

    • A

    Parameters

    • op1: OperatorFunction<boolean, A>

    Returns Observable<A>

  • Type Parameters

    • A

    • B

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>

    Returns Observable<B>

  • Type Parameters

    • A

    • B

    • C

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>

    Returns Observable<C>

  • Type Parameters

    • A

    • B

    • C

    • D

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>

    Returns Observable<D>

  • Type Parameters

    • A

    • B

    • C

    • D

    • E

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>

    Returns Observable<E>

  • Type Parameters

    • A

    • B

    • C

    • D

    • E

    • F

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>

    Returns Observable<F>

  • Type Parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>

    Returns Observable<G>

  • Type Parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>
    • op8: OperatorFunction<G, H>

    Returns Observable<H>

  • Type Parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    • I

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>
    • op8: OperatorFunction<G, H>
    • op9: OperatorFunction<H, I>

    Returns Observable<I>

  • Type Parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    • I

    Parameters

    • op1: OperatorFunction<boolean, A>
    • op2: OperatorFunction<A, B>
    • op3: OperatorFunction<B, C>
    • op4: OperatorFunction<C, D>
    • op5: OperatorFunction<D, E>
    • op6: OperatorFunction<E, F>
    • op7: OperatorFunction<F, G>
    • op8: OperatorFunction<G, H>
    • op9: OperatorFunction<H, I>
    • Rest ...operations: OperatorFunction<any, any>[]

    Returns Observable<{}>

  • subscribe(observer?: PartialObserver<boolean>): Subscription
  • subscribe(next: null, error: null, complete: (() => void)): Subscription
  • subscribe(next: null, error: ((error: any) => void), complete?: (() => void)): Subscription
  • subscribe(next: ((value: boolean) => void), error: null, complete: (() => void)): Subscription
  • subscribe(next?: ((value: boolean) => void), error?: ((error: any) => void), complete?: (() => void)): Subscription
  • Parameters

    • Optional observer: PartialObserver<boolean>

    Returns Subscription

  • deprecated

    Use an observer instead of a complete callback

    Parameters

    • next: null
    • error: null
    • complete: (() => void)
        • (): void
        • Returns void

    Returns Subscription

  • deprecated

    Use an observer instead of an error callback

    Parameters

    • next: null
    • error: ((error: any) => void)
        • (error: any): void
        • Parameters

          • error: any

          Returns void

    • Optional complete: (() => void)
        • (): void
        • Returns void

    Returns Subscription

  • deprecated

    Use an observer instead of a complete callback

    Parameters

    • next: ((value: boolean) => void)
        • (value: boolean): void
        • Parameters

          • value: boolean

          Returns void

    • error: null
    • complete: (() => void)
        • (): void
        • Returns void

    Returns Subscription

  • Parameters

    • Optional next: ((value: boolean) => void)
        • (value: boolean): void
        • Parameters

          • value: boolean

          Returns void

    • Optional error: ((error: any) => void)
        • (error: any): void
        • Parameters

          • error: any

          Returns void

    • Optional complete: (() => void)
        • (): void
        • Returns void

    Returns Subscription

  • toPromise<T>(this: Observable<T>): Promise<T>
  • toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructor): Promise<T>
  • toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructorLike): Promise<T>
  • Type Parameters

    • T

    Parameters

    • this: Observable<T>

    Returns Promise<T>

  • Type Parameters

    • T

    Parameters

    • this: Observable<T>
    • PromiseCtor: PromiseConstructor

    Returns Promise<T>

  • Type Parameters

    • T

    Parameters

    • this: Observable<T>
    • PromiseCtor: PromiseConstructorLike

    Returns Promise<T>

  • toggle(): void
  • unsubscribe(): void
  • Returns void

Generated using TypeDoc