Module lib/msg

Index

Type Aliases

Interfaces

Classes

MessageBus

Functions

Type Aliases

Direction

Direction: "in" | "out"

AudioOriginUI

AudioOriginUI: "eventList" | "playBar" | "transcriptHeader" | "transcrippet"

EventAudioAction

EventAudioAction: "play" | "pause"

Functions

Provider

Provider(options: { bus?: MessageBus; children: ReactNode }): ReactElement<any, string | JSXElementConstructor<any>>

- Defined in src/lib/msg/index.tsx:196
A React Provider to configure an app-level MessageBus

Parameters
- options: { bus?: MessageBus; children: ReactNode }
  - Optional bus?: MessageBus
  - children: ReactNode
Returns ReactElement<any, string | JSXElementConstructor<any>>

useMessageBus

useMessageBus(): MessageBus

- Defined in src/lib/msg/index.tsx:200
Returns MessageBus

useMessageListener

useMessageListener<E>(type: E, listener: ((msg: Message<E>) => void | Promise<void>), direction: Direction): MessageBus

- Defined in src/lib/msg/index.tsx:208
Hook to easily setup a message bus listener that will unregister when the component unmounts.

Type Parameters
- E extends keyof MessageBusEvents
Parameters
- type: E
- listener: ((msg: Message<E>) => void | Promise<void>)
  - - (msg: Message<E>): void | Promise<void>
    - Parameters
      - msg: Message<E>
      Returns void | Promise<void>
- direction: Direction
Returns MessageBus

Generated using TypeDoc