Class DebugTap

An internal, opt-in tap on the SDK's postMessage traffic. The widgets report every message they send and receive here; nothing is captured or allocated unless a listener is subscribed, which only happens when sdkDebugger is enabled in the configuration.

Constructors

constructor

Methods

report subscribe

Constructors

constructor

Methods

Staticreport

  • report(widget, direction, envelope): void

  • Reports a message exchange to all subscribers. Returns immediately when nobody is subscribed, and never lets a failing listener affect the caller.

    Parameters

    • widget: IWidget

      The widget the message was sent to, or received from

    • direction: DebugTapDirection

      The direction the message travelled in

    • envelope: MessageEnvelope<any>

      The message envelope as it went over postMessage

    Returns void

Staticsubscribe

  • subscribe(listener): (() => void)

  • Subscribes to captured message exchanges.

    Parameters

    Returns (() => void)

    A function that removes the listener again

      • (): void

      • Returns void

Settings

Member Visibility

On This Page

Constructors
Methods