Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 990 Bytes

README.md

File metadata and controls

17 lines (13 loc) · 990 Bytes

Observable DOM Common

@mml-io/observable-dom-common

npm version

This package contains the interface types and messages used by the Observable DOM system and some helper functions for bridging messages and interfaces.

Classes

  • ObservableDOMInterface
    • The interface of an ObservableDOM.
  • observableDOMInterfaceToMessageSender
    • A function that returns an object that matches the ObservableDOMInterface, but sends messages corresponding to interactions with the interface to a provided callback.
  • applyMessageToObservableDOMInstance
    • A function that applies a message (from observableDOMInterfaceToMessageSender) to an ObservableDOM instance.
  • ToObservableDOMInstanceMessage and FromObservableDOMInstanceMessage
    • Messages that can describe the emissions and interactions with an ObservableDOM instance.