Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Subscribable<T>

A stream of values that may be subscribed to.

Type parameters

  • T

Hierarchy

  • Subscribable

Index

Methods

Methods

subscribe

  • subscribe(observer?: PartialObserver<T>): Unsubscribable
  • subscribe(next: null | undefined, error: null | undefined, complete: function): Unsubscribable
  • subscribe(next: null | undefined, error: function, complete?: undefined | function): Unsubscribable
  • subscribe(next: function, error: null | undefined, complete: function): Unsubscribable
  • subscribe(next?: undefined | function, error?: undefined | function, complete?: undefined | function): Unsubscribable
  • Subscribes to the stream of values.

    Parameters

    Returns Unsubscribable

    An unsubscribable that, when its {@link Unsubscribable#unsubscribe} method is called, causes the subscription to stop reacting to the stream.

  • deprecated

    Use an observer instead of a complete callback

    Parameters

    • next: null | undefined
    • error: null | undefined
    • complete: function
        • (): void
        • Returns void

    Returns Unsubscribable

  • deprecated

    Use an observer instead of an error callback

    Parameters

    • next: null | undefined
    • error: function
        • (error: any): void
        • Parameters

          • error: any

          Returns void

    • Optional complete: undefined | function

    Returns Unsubscribable

  • deprecated

    Use an observer instead of a complete callback

    Parameters

    • next: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    • error: null | undefined
    • complete: function
        • (): void
        • Returns void

    Returns Unsubscribable

  • Parameters

    • Optional next: undefined | function
    • Optional error: undefined | function
    • Optional complete: undefined | function

    Returns Unsubscribable

Generated using TypeDoc