@sofie-automation/shared-lib

v1.51.3

Published

Library for types & values shared by core, workers and gateways

Downloads

1,323

Readme

Sofie: The Modern TV News Studio Automation System (Shared Lib)

npm

This library is used as part of Sofie Server Core.

This is a part of the Sofie TV News Studio Automation System.

Note: This library should normally not be used directly, it should be used via one of:

  • npm
  • npm

If you find yourself importing something from this package which isn't re-exported by one of the above, then either someone forgot to export it or you shouldn't be using it.

Purpose

This library is a collection of shared typings used across various of the components that make up Sofie. Any typings or small utilities that are needed by multiple of the components can go in here.
Eventually this will likely be split up into multiple more targetted libraries, once there is a compelling reason to do the split.

Because of the wide use of this library, it is important that it does not get any large dependencies added. Small typings only packages such as timeline-state-resolver-types and @mos-connection/model are acceptable as they are needed for the api definitions, and are concise as only typings.
Their dependencies are also kept light using only tslib and optionally type-fest, which we use in most places already.