Broadcastable

Updated on August 22, 2024Source codeTests

Broadcastable is a class that enriches application state, allowing it to:

• Broadcast itself
• Store the BroadcastChannel instance used for broadcasting

Construct a Broadcastable instance

The Broadcastable constructor accepts two parameters:

Broadcastable constructor options

State and methods

Using with Listenable

Broadcastable is designed to work seamlessly with Listenable.

To listen for messages:

1. Construct your Listenable instance, passing message as the event type.
2. Use the toMessageListenParams function exported from Baleada Logic to easily format your Broadcastable instance and your onMessage callback into parameters for Listenable's listen method.

import {
  Listenable,
  Broadcastable,
  toMessageListenParams,
} from '@baleada/logic'

const broadcastable = new Broadcastable('hello world'),
      message = new Listenable('message')

message.listen(...toMessageListenParams(
  broadcastable,
  event => {
    console.log(event)
  }
))

Using with TypeScript

The Broadcastable constructor accepts one generic type that you can use to enforce a type for state. By default, TypeScript will infer the type from the initial state you pass to the constructor, but you can specify the type manually if needed.

const withInferredTypes = new Broadcastable(0)
withInferredTypes.state = 'a' // Type error

const withManualTypes = new Broadcastable<string | number>(0)
withManualTypes.state = 'a' // No type error

API design compliance

Edit doc on GitHub