Skip to content
/ base Public

Interface-level abstract definitions, DTOs, type definitions for use across the project.

License

Notifications You must be signed in to change notification settings

tvkitchen/base

Repository files navigation

lint test CodeQL codecov

TV Kitchen: Base

This monorepo contains four base packages that are imported by various portions of the TV Kitchen:

  • @tvkitchen/base-errors contains common error types.
  • @tvkitchen/base-interfaces contains interfaces that define the shape of modular architectural components.
  • @tvkitchen/base-classes contains the Payload class, which is used to communicate between appliances.
  • @tvkitchen/base-constants contains constant strings that define interfaces across the project (e.g. types of data being passed around).

Driving Philosophy

Utilities, interface implementations (including abstract implementations), and other seemingly useful common code elements should NOT be included in this repository or these packages.

We want to minimize universal coupling. Abstract implementations specific to an architectural component should be placed in an appropriate repository depending on the nature of the element in question.

Setting Up

yarn install

This will install project dependencies, link local sibling dependencies (we're using Yarn Workspaces), and build/transpile each package.

About the TV Kitchen

TV Kitchen is a project of Bad Idea Factory. Learn more at the TV Kitchen project site.

About

Interface-level abstract definitions, DTOs, type definitions for use across the project.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •