@sabinmarcu/observable

Index

Functions

• extendObservable
• isObservable
• makeController
• makeControllerFunction
• observable
• observableFrom
• observableMap
• observableSet
• observableValueStore
• projectObservables
• subject
• wrapMapMethod
• wrapSetMethod

Interfaces

• IObservableMap
• IObservableSet

Type Aliases

• MethodsOfMap
• MethodsOfSet
• Observable
• ObservableDispatch
• ObservableFilterFunction
• ObservableMap
• ObservableMapFunction
• ObservableProjection
• ObservableProjectionArguments
• ObservableProjector
• ObservableProjectorArguments
• ObservableSet
• ObservableSubscriberStore
• Observer
• ObserverController
• PipedObservable
• RawObservable
• Subject
• Subscription
• TypeOfObservable
• TypeOfObservableOrType

Variables

• MapKeysToWrap
• SetKeysToWrap
• __mock

Type Aliases

MethodsOfMap

MethodsOfMap: { [ Key in keyof Map<any, any> & string ]: Map<any, any>[Key] extends RawFunction ? Key : never }[keyof Map<any, any> & string]

MethodsOfSet

MethodsOfSet: { [ Key in keyof Set<any> & string ]: Set<any>[Key] extends RawFunction ? Key : never }[keyof Set<any> & string]

Observable

Observable<T>: RawObservable<T> & { filter: ObservableFilterFunction<T>; map: ObservableMapFunction<T>; value: any }

Type parameters

• T

ObservableDispatch

ObservableDispatch<T>: (controller: ObserverController<T>) => void

Type parameters

• T

Type declaration

• • (controller: ObserverController<T>): void

  • Parameters

    • controller: ObserverController<T>

    Returns void

ObservableFilterFunction

ObservableFilterFunction<T>: (filter: (input: T | undefined) => boolean) => PipedObservable<T>

Type parameters

• T

Type declaration

• • (filter: (input: T | undefined) => boolean): PipedObservable<T>

  • Parameters

    • filter: (input: T | undefined) => boolean

    Returns PipedObservable<T>

ObservableMap

ObservableMap<K, V>: Omit<IObservableMap<K, V>, value>

Type parameters

• K
• V

ObservableMapFunction

ObservableMapFunction<T>: <R>(map: (input: T | undefined) => R) => PipedObservable<R>

Type parameters

• T

Type declaration

• • <R>(map: (input: T | undefined) => R): PipedObservable<R>

  • Type parameters

    • R

    Parameters

    • map: (input: T | undefined) => R

    Returns PipedObservable<R>

ObservableProjection

ObservableProjection<Observables, Result>: (...values: ObservableProjectionArguments<Observables>) => Result

Type parameters

• Observables: Observable<any>[]
• Result

Type declaration

• • (...values: ObservableProjectionArguments<Observables>): Result

  • Parameters

    • rest...values: ObservableProjectionArguments<Observables>

    Returns Result

ObservableProjectionArguments

ObservableProjectionArguments<Observables>: Observables extends [Observable<infer Current>, ...infer Rest] ? [Current, ...ObservableProjectionArguments<Rest>] : []

Type parameters

• Observables: Observable<any>[]

ObservableProjector

ObservableProjector: <Observables, Result>(...values: ObservableProjectorArguments<Observables, Result>) => Observable<Result>

Type declaration

• • <Observables, Result>(...values: ObservableProjectorArguments<Observables, Result>): Observable<Result>

  • Type parameters

    • Observables: Observable<any>[] = Observable<any>[]
    • Result = any

    Parameters

    • rest...values: ObservableProjectorArguments<Observables, Result>

    Returns Observable<Result>

ObservableProjectorArguments

ObservableProjectorArguments<Observables, Result>: [...Observables, ObservableProjection<Observables, Result>]

Type parameters

• Observables: Observable<any>[]
• Result

ObservableSet

ObservableSet<T>: Omit<IObservableSet<T>, value>

Type parameters

• T

ObservableSubscriberStore

ObservableSubscriberStore<T>: Set<Observer<T>>

Type parameters

• T

Observer

Observer<T>: { complete?: () => void; error?: (error: Error) => void; next?: (value: T | undefined) => void }

Type parameters

• T

Type declaration

• optionalcomplete?: () => void

  • • (): void

    • Returns void

• optionalerror?: (error: Error) => void

  • • (error: Error): void

    • Parameters

      • error: Error

      Returns void

• optionalnext?: (value: T | undefined) => void

  • • (value: T | undefined): void

    • Parameters

      • value: T | undefined

      Returns void

ObserverController

ObserverController<T>: Required<Observer<T>>

Type parameters

• T

PipedObservable

PipedObservable<T>: Observable<T> & Subscription

Type parameters

• T

RawObservable

RawObservable<T>: { subscribe: (observer: Observer<T | undefined>) => Subscription }

Type parameters

• T

Type declaration

• subscribe: (observer: Observer<T | undefined>) => Subscription

  • • (observer: Observer<T | undefined>): Subscription

    • Parameters

      • observer: Observer<T | undefined>

      Returns Subscription

Subject

Subject<T>: Observable<T> & ObserverController<T>

Type parameters

• T

Subscription

Subscription: { unsubscribe: () => void }

Type declaration

• unsubscribe: () => void

  • • (): void

    • Returns void

TypeOfObservable

TypeOfObservable<T>: T extends Observable<infer U> ? U : never

Type parameters

• T: Observable<any>

TypeOfObservableOrType

TypeOfObservableOrType<T>: T extends Observable<infer U> ? U : T

Type parameters

• T: any

Variables

constMapKeysToWrap

MapKeysToWrap: MethodsOfMap[] = ...

constSetKeysToWrap

SetKeysToWrap: MethodsOfSet[] = ...

const__mock

__mock: { emptySubscriptionPool: () => void; endPooling: () => void; keys: string[]; startPooling: () => void; stuff: string; subscriptionPool: {} } = ...

Type declaration

• emptySubscriptionPool: () => void

  • • (): void

    • Returns void

• endPooling: () => void

  • • (): void

    • Returns void

• keys: string[]

• startPooling: () => void

  • • (): void

    • Returns void

• stuff: string

• subscriptionPool: {}