MENU
      The TypeScript Framework Architecture
      • 15 Oct 2024
      • 1 Minute to read

      The TypeScript Framework Architecture


      Article summary

      The Framework is supplied in two flavors and they both implement the Model-View-Controller Pattern (MVC), where:

      • Model
        The Message data from the CMS along with Player-metadata, e.g. the current Attribute/Trigger states, the View Mode, the location of this item in the Playlist etc.

      • View
        Your “template implementation“ as an implementation of the ITemplateView interface. This is usually done by subclassing either TemplateViewBase or SimpleViewBase.

      • Controller
        This is the TemplateController, which hosts (your) View. It takes care of all the event-communication with the Player and abstracts the API for the template/View.

      Framework variants

      The framework currently includes two different implementations. Choose the one that best suits your needs.

      1. Plain/classic Typescript (namespaces)
        - Located in “TemplateFramework/framework”
        - async/Promise-based

      2. ESM
        - Located in “TemplateFramework/esm“
        - ES6 modules
        - The same as the “async“-framework from the client’s point-of-view

      The ESM framework requires a bundler (e.g. WebPack) for deployment if you are using external modules from NPM or want to rely on the standard “zipping“ script. The other can be bundled by the TypeScript compiler.



      Was this article helpful?

      Changing your password will log you out immediately. Use the new password to log back in.
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.