Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Stream$<T0, T1>

A RxJs observable that represents a DOM's attribute, child or children.

Type parameters

Hierarchy

  • Stream$

Index

Constructors

constructor

  • new Stream$<T0, T1>(stream$: Observable<T0>, map: (T0: any, ...args: any[]) => T1, __namedParameters: { sideEffects?: (T1: any, T0: any) => void; untilFirst?: T1; wrapper?: (T1: any) => T1 }): Stream$<T0, T1>
  • Type parameters

    • T0

    • T1 = T0

    Parameters

    • stream$: Observable<T0>

      domain's data stream defined as a RxJS observable

    • map: (T0: any, ...args: any[]) => T1
        • (T0: any, ...args: any[]): T1
        • Parameters

          • T0: any
          • Rest ...args: any[]

          Returns T1

    • __namedParameters: { sideEffects?: (T1: any, T0: any) => void; untilFirst?: T1; wrapper?: (T1: any) => T1 }
      • Optional sideEffects?: (T1: any, T0: any) => void

        is a function that provides a handle to execute side effects once the attribute/child as been set/added; both the domain's data and the rendered HTMLElement are provided to this function.

          • (T1: any, T0: any): void
          • Parameters

            • T1: any
            • T0: any

            Returns void

      • Optional untilFirst?: T1

        is the data that will be used until the first emitted element in stream$ is obtained. If not provided, the attribute/child does not exist until first emission.

      • Optional wrapper?: (T1: any) => T1

        is a function that is used to alter the data returned by vDomMap.

          • (T1: any): T1
          • Parameters

            • T1: any

            Returns T1

    Returns Stream$<T0, T1>

Properties

Readonly map

map: (T0: any, ...args: any[]) => T1

Type declaration

    • (T0: any, ...args: any[]): T1
    • Parameters

      • T0: any
      • Rest ...args: any[]

      Returns T1

Readonly sideEffects

sideEffects: any

Readonly stream$

stream$: Observable<T0>

Readonly untilFirst

untilFirst: any

Readonly wrapper

wrapper: any

Methods

Private finalize

  • finalize(fct: (T: any, ...args: any[]) => any, value: T1): void
  • Parameters

    • fct: (T: any, ...args: any[]) => any
        • (T: any, ...args: any[]): any
        • Parameters

          • T: any
          • Rest ...args: any[]

          Returns any

    • value: T1

    Returns void

subscribe

  • subscribe(fct: (T: any, ...args: any[]) => any, ...withData: any[]): Subscription
  • Implementation function that supposed to be called only by HTMLElement$.

    Parameters

    • fct: (T: any, ...args: any[]) => any
        • (T: any, ...args: any[]): any
        • Parameters

          • T: any
          • Rest ...args: any[]

          Returns any

    • Rest ...withData: any[]

    Returns Subscription

Generated using TypeDoc