Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • StreamStateSubject
    • RunningState

Implements

  • Subscribable<StreamState>
  • SubscriptionLike
  • RunningStateLike

Index

Constructors

constructor

  • new RunningState(initial: StreamState, pinned: boolean): RunningState

Properties

closed

closed: boolean

hasError

hasError: boolean
deprecated

Internal implementation detail, do not use directly. Will be made internal in v8.

Readonly id

id: StreamID

isStopped

isStopped: boolean
deprecated

Internal implementation detail, do not use directly. Will be made internal in v8.

observers

observers: Observer<StreamState>[]
deprecated

Internal implementation detail, do not use directly. Will be made internal in v8.

operator

operator: Operator<any, StreamState> | undefined
deprecated

Internal implementation detail, do not use directly. Will be made internal in v8.

source

source: Observable<any> | undefined
deprecated

Internal implementation detail, do not use directly. Will be made internal in v8.

Readonly subscriptionSet

subscriptionSet: SubscriptionSet = new SubscriptionSet()

thrownError

thrownError: any
deprecated

Internal implementation detail, do not use directly. Will be made internal in v8.

Static create

create: (...args: any[]) => any

Creates a "subject" by basically gluing an observer to an observable.

nocollapse
deprecated

Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

isPinned

  • get isPinned(): boolean

observed

  • get observed(): boolean
  • Returns boolean

pinnedCommits

  • get pinnedCommits(): Set<string> | null

state

  • get state(): StreamState

tip

  • get tip(): CID

value

  • get value(): StreamState
  • Returns StreamState

Methods

add

  • add(subscription: Subscription): void

asObservable

  • asObservable(): Observable<StreamState>
  • 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<StreamState>

    Observable that the Subject casts to

complete

  • complete(): void

error

  • error(err: any): void
  • Parameters

    • err: any

    Returns void

forEach

  • forEach(next: (value: StreamState) => void): Promise<void>
  • forEach(next: (value: StreamState) => void, promiseCtor: PromiseConstructorLike): Promise<void>
  • 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 timeout, {@link take}, {@link takeWhile}, or {@link takeUntil} amongst others.

    Example

    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'
    

    Parameters

    • next: (value: StreamState) => void

      a handler for each value emitted by the observable

        • (value: StreamState): void
        • Parameters

          • value: StreamState

          Returns void

    Returns Promise<void>

    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.

    Parameters

    • next: (value: StreamState) => void

      a handler for each value emitted by the observable

        • (value: StreamState): void
        • Parameters

          • value: StreamState

          Returns void

    • promiseCtor: PromiseConstructorLike

      a constructor function used to instantiate the Promise

    Returns Promise<void>

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

getValue

  • getValue(): StreamState
  • Returns StreamState

lift

  • lift<R>(operator: Operator<StreamState, R>): Observable<R>
  • deprecated

    Internal implementation detail, do not use directly. Will be made internal in v8.

    Type parameters

    • R

    Parameters

    • operator: Operator<StreamState, R>

    Returns Observable<R>

markAsPinned

  • markAsPinned(): void

markAsUnpinned

  • markAsUnpinned(): void

next

  • next(next: StreamState): void

pipe

  • pipe(): Observable<StreamState>
  • pipe<A>(op1: OperatorFunction<StreamState, A>): Observable<A>
  • pipe<A, B>(op1: OperatorFunction<StreamState, A>, op2: OperatorFunction<A, B>): Observable<B>
  • pipe<A, B, C>(op1: OperatorFunction<StreamState, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
  • pipe<A, B, C, D>(op1: OperatorFunction<StreamState, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
  • pipe<A, B, C, D, E>(op1: OperatorFunction<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<unknown>
  • Returns Observable<StreamState>

  • Type parameters

    • A

    Parameters

    • op1: OperatorFunction<StreamState, A>

    Returns Observable<A>

  • Type parameters

    • A

    • B

    Parameters

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

    Returns Observable<B>

  • Type parameters

    • A

    • B

    • C

    Parameters

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

    Returns Observable<C>

  • Type parameters

    • A

    • B

    • C

    • D

    Parameters

    • op1: OperatorFunction<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<StreamState, 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<unknown>

subscribe

  • subscribe(observer?: Partial<Observer<StreamState>>): Subscription
  • subscribe(next: (value: StreamState) => void): Subscription
  • subscribe(next?: ((value: StreamState) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription
  • Parameters

    • Optional observer: Partial<Observer<StreamState>>

    Returns Subscription

  • Parameters

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

          • value: StreamState

          Returns void

    Returns 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

    Parameters

    • Optional next: ((value: StreamState) => void) | null
    • Optional error: ((error: any) => void) | null
    • Optional complete: (() => void) | null

    Returns Subscription

toPromise

  • toPromise(): Promise<StreamState | undefined>
  • toPromise(PromiseCtor: typeof Promise): Promise<StreamState | undefined>
  • toPromise(PromiseCtor: PromiseConstructorLike): Promise<StreamState | undefined>
  • deprecated

    Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise

    Returns Promise<StreamState | undefined>

  • deprecated

    Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise

    Parameters

    • PromiseCtor: typeof Promise

    Returns Promise<StreamState | undefined>

  • deprecated

    Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise

    Parameters

    • PromiseCtor: PromiseConstructorLike

    Returns Promise<StreamState | undefined>

unsubscribe

  • unsubscribe(): void