musquette
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

Private Optional _connection

_connection: MQTTClient

_isScalar

_isScalar: boolean

Internal implementation detail, do not use directly.

Private _output

_output: Subject<MQTTMessage<T>> = new Subject<MQTTMessage<T>>()
deprecated

This is an internal implementation detail, do not use.

closed

closed: boolean

Protected Optional destination

destination: Observer<MQTTMessage<T>>

hasError

hasError: boolean

isStopped

isStopped: boolean

observers

observers: Observer<MQTTMessage<T>>[]

operator

operator: Operator<any, MQTTMessage<T>>
deprecated

This is an internal implementation detail, do not use.

source

source: Observable<any>
deprecated

This is an internal implementation detail, do not use.

thrownError

thrownError: any

Static create

create: Function
nocollapse
deprecated

use new Subject() instead

Static if

if: typeof iif
nocollapse
deprecated

In favor of iif creation function: import { iif } from 'rxjs';

Static throw

throw: typeof throwError
nocollapse
deprecated

In favor of throwError creation function: import { throwError } from 'rxjs';

Methods

Private _connectBroker

  • _connectBroker(): void

Private _resetState

  • _resetState(): void

_subscribe

  • _subscribe(subscriber: Subscriber<MQTTMessage<T>>): Subscription
  • deprecated

    This is an internal implementation detail, do not use.

    Parameters

    Returns Subscription

_trySubscribe

  • _trySubscribe(subscriber: Subscriber<MQTTMessage<T>>): TeardownLogic
  • deprecated

    This is an internal implementation detail, do not use.

    Parameters

    Returns TeardownLogic

asObservable

  • 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<MQTTMessage<T>>

    Observable that the Subject casts to

complete

  • complete(): void

  • Returns void

error

  • error(err: any): void

  • Parameters

    • err: any

    Returns void

forEach

  • forEach(next: (value: MQTTMessage<T>) => void, promiseCtor?: PromiseConstructorLike): Promise<void>
  • method

    forEach

    Parameters

    • next: (value: MQTTMessage<T>) => void

      a handler for each value emitted by the observable

    • Optional promiseCtor: PromiseConstructorLike

    Returns Promise<void>

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

lift

  • lift<R>(operator: Operator<MQTTMessage<T>, R>): Observable<R>

next

  • Parameters

    Returns void

pipe

  • pipe(): Observable<MQTTMessage<T>>
  • pipe<A>(op1: OperatorFunction<MQTTMessage<T>, A>): Observable<A>
  • pipe<A, B>(op1: OperatorFunction<MQTTMessage<T>, A>, op2: OperatorFunction<A, B>): Observable<B>
  • pipe<A, B, C>(op1: OperatorFunction<MQTTMessage<T>, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
  • pipe<A, B, C, D>(op1: OperatorFunction<MQTTMessage<T>, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
  • pipe<A, B, C, D, E>(op1: OperatorFunction<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<{}>

  • Returns Observable<MQTTMessage<T>>

  • Type parameters

    • A

    Parameters

    Returns Observable<A>

  • Type parameters

    • A

    • B

    Parameters

    • op1: OperatorFunction<MQTTMessage<T>, A>
    • op2: OperatorFunction<A, B>

    Returns Observable<B>

  • Type parameters

    • A

    • B

    • C

    Parameters

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

    Returns Observable<C>

  • Type parameters

    • A

    • B

    • C

    • D

    Parameters

    • op1: OperatorFunction<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<MQTTMessage<T>, 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<{}>

publish

  • publish(topic: string, message: T): void

subscribe

  • subscribe(observer?: PartialObserver<MQTTMessage<T>>): Subscription
  • subscribe(next: null | undefined, error: null | undefined, complete: () => void): Subscription
  • subscribe(next: null | undefined, error: (error: any) => void, complete?: undefined | (() => void)): Subscription
  • subscribe(next: (value: MQTTMessage<T>) => void, error: null | undefined, complete: () => void): Subscription
  • subscribe(next?: undefined | ((value: MQTTMessage<T>) => void), error?: undefined | ((error: any) => void), complete?: undefined | (() => void)): Subscription

  • Parameters

    Returns Subscription

  • deprecated

    Use an observer instead of a complete callback

    Parameters

    • next: null | undefined
    • error: null | undefined
    • complete: () => void
        • (): void

        • Returns void

    Returns Subscription

  • deprecated

    Use an observer instead of an error callback

    Parameters

    • next: null | undefined
    • error: (error: any) => void
        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: undefined | (() => void)

    Returns Subscription

  • deprecated

    Use an observer instead of a complete callback

    Parameters

    • next: (value: MQTTMessage<T>) => void
    • error: null | undefined
    • complete: () => void
        • (): void

        • Returns void

    Returns Subscription

  • Parameters

    • Optional next: undefined | ((value: MQTTMessage<T>) => void)
    • Optional error: undefined | ((error: any) => void)
    • Optional complete: undefined | (() => void)

    Returns Subscription

toPromise

  • toPromise<T>(this: Observable<T>): Promise<T>
  • toPromise<T>(this: Observable<T>, PromiseCtor: typeof Promise): Promise<T>
  • toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructorLike): Promise<T>

  • Type parameters

    • T

    Parameters

    • this: Observable<T>

    Returns Promise<T>

  • Type parameters

    • T

    Parameters

    • this: Observable<T>
    • PromiseCtor: typeof Promise

    Returns Promise<T>

  • Type parameters

    • T

    Parameters

    • this: Observable<T>
    • PromiseCtor: PromiseConstructorLike

    Returns Promise<T>

topic

unsubscribe

  • unsubscribe(): void

Object literals

Private _config

_config: object

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Property

Generated using TypeDoc