Options
All
  • Public
  • Public/Protected
  • All
Menu

Class $Sub<T>

Type parameters

  • T = any

Hierarchy

  • Subscription<T, T>
    • $Sub

Index

Constructors

constructor

Properties

Optional __owner

__owner: ISubscription<any, any>

Protected cacheLast

cacheLast: boolean

closeIn

closeIn: CloseMode

closeOut

closeOut: CloseMode

Optional el

el: Element

id

id: string

Protected inner

inner: IMountWithState<undefined | T>

Protected last

last: any

Optional parent

parent: ISubscription<any, T>

Protected state

state: State

Protected subs

subs: Partial<ISubscriber<T>>[]

Protected Optional wrapped

wrapped: Partial<ISubscriber<T>>

Protected Optional xform

xform: Reducer<T[], T>

Methods

deref

  • deref(): undefined | T
  • Returns undefined | T

Protected dispatch

  • dispatch(x: T): void
  • Parameters

    • x: T

    Returns void

Protected dispatchTo

  • dispatchTo(type: "next" | "error" | "done", x?: T): boolean
  • Parameters

    • type: "next" | "error" | "done"
    • Optional x: T

    Returns boolean

Protected dispatchXform

  • dispatchXform(x: T): void
  • Parameters

    • x: T

    Returns void

Protected dispatchXformDone

  • dispatchXformDone(): boolean
  • Returns boolean

Protected dispatchXformVals

  • dispatchXformVals(acc: T[] | Reduced<T[]>): boolean
  • Parameters

    • acc: T[] | Reduced<T[]>

    Returns boolean

done

  • done(): void
  • Returns void

Protected ensureState

  • ensureState(): void
  • Returns void

error

  • error(e: any): boolean
  • Parameters

    • e: any

    Returns boolean

getState

  • getState(): State
  • Returns State

map

  • map<C>(fn: Fn<T, C>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<T, C>
  • Syntax sugar for {@link Subscription.transform} when using a single map transducer only. The given function fn is used as map's transformation fn.

    Type parameters

    • C

    Parameters

    • fn: Fn<T, C>
    • Optional opts: Partial<WithErrorHandlerOpts>

    Returns ISubscription<T, C>

mount

  • mount(parent: Element, index?: NumOrElement): Promise<Element>

next

  • next(x: T): void

Protected release

  • release(): void
  • Returns void

Protected setState

  • setState(state: State): void
  • Parameters

    • state: State

    Returns void

subscribe

  • subscribe<C>(sub: ISubscription<T, C>): ISubscription<T, C>
  • subscribe(sub: Partial<ISubscriber<T>>, opts?: Partial<CommonOpts>): ISubscription<T, T>
  • subscribe<C>(sub: Partial<ISubscriber<C>>, opts?: Partial<TransformableOpts<T, C>>): ISubscription<T, C>
  • Creates new child subscription with given subscriber and/or transducer and options.

    Type parameters

    • C

    Parameters

    • sub: ISubscription<T, C>

    Returns ISubscription<T, C>

  • Parameters

    • sub: Partial<ISubscriber<T>>
    • Optional opts: Partial<CommonOpts>

    Returns ISubscription<T, T>

  • Type parameters

    • C

    Parameters

    • sub: Partial<ISubscriber<C>>
    • Optional opts: Partial<TransformableOpts<T, C>>

    Returns ISubscription<T, C>

transform

  • transform<C>(a: Transducer<T, C>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<T, C>
  • transform<C, D>(a: Transducer<T, C>, b: Transducer<C, D>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<T, D>
  • transform<C, D, E>(a: Transducer<T, C>, b: Transducer<C, D>, c: Transducer<D, E>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<T, E>
  • transform<C, D, E, F>(a: Transducer<T, C>, b: Transducer<C, D>, c: Transducer<D, E>, d: Transducer<E, F>, opts?: Partial<WithErrorHandlerOpts>): ISubscription<T, F>
  • transform<C>(opts: WithTransform<T, C> & Partial<WithErrorHandlerOpts>): ISubscription<T, C>
  • Creates a new child subscription using given transducers and optional subscription ID. Supports up to 4 transducers and if more than one transducer is given, composes them in left-to-right order using {@link @thi.ng/transducers#(comp:1)}.

    Shorthand for subscribe(comp(xf1, xf2,...), id)

    Type parameters

    • C

    Parameters

    • a: Transducer<T, C>
    • Optional opts: Partial<WithErrorHandlerOpts>

    Returns ISubscription<T, C>

  • Type parameters

    • C

    • D

    Parameters

    • a: Transducer<T, C>
    • b: Transducer<C, D>
    • Optional opts: Partial<WithErrorHandlerOpts>

    Returns ISubscription<T, D>

  • Type parameters

    • C

    • D

    • E

    Parameters

    • a: Transducer<T, C>
    • b: Transducer<C, D>
    • c: Transducer<D, E>
    • Optional opts: Partial<WithErrorHandlerOpts>

    Returns ISubscription<T, E>

  • Type parameters

    • C

    • D

    • E

    • F

    Parameters

    • a: Transducer<T, C>
    • b: Transducer<C, D>
    • c: Transducer<D, E>
    • d: Transducer<E, F>
    • Optional opts: Partial<WithErrorHandlerOpts>

    Returns ISubscription<T, F>

  • Type parameters

    • C

    Parameters

    • opts: WithTransform<T, C> & Partial<WithErrorHandlerOpts>

    Returns ISubscription<T, C>

Protected unhandledError

  • unhandledError(e: any): boolean
  • Parameters

    • e: any

    Returns boolean

unmount

  • unmount(): Promise<void>

unsubscribe

  • unsubscribe(sub?: ISubscription<T, any>): boolean
  • Parameters

    • Optional sub: ISubscription<T, any>

    Returns boolean

Protected unsubscribeChild

  • unsubscribeChild(sub: ISubscription<T, any>): boolean
  • Parameters

    • sub: ISubscription<T, any>

    Returns boolean

Protected unsubscribeSelf

  • unsubscribeSelf(): boolean
  • Returns boolean

update

  • update(x: T): void

Generated using TypeDoc