Skip to content

TyRAS data libraries for Runtypes validation library

License

Notifications You must be signed in to change notification settings

ty-ras/data-runtypes

Repository files navigation

Typesafe REST API Specification - Runtypes Data Validation Related Libraries

CI Pipeline CD Pipeline

The Typesafe REST API Specification (TyRAS) is a family of libraries used to enable seamless development of Backend and/or Frontend which communicate via HTTP protocol. The protocol specification is checked both at compile-time and run-time to verify that communication indeed adhers to the protocol. This all is done in such way that it does not make development tedious or boring, but instead robust and fun!

This particular repository contains related libraries related to using TyRAS with runtypes data validation library:

  • data folder contains runtypes-specific library @ty-ras/data-runtypes commonly used by both frontend and backend,
  • data-backend folder contains runtypes-specific library @ty-ras/data-backend-runtypes used by backend,
  • state folder contains runtypes-specific library @ty-ras/state-runtypes used by backend
  • data-frontend folder contains runtypes-specific library @ty-ras/data-frontend-runtypes used by frontend, and
  • metadata-jsonchema folder contains runtypes-specific library @ty-ras/metadata-jsonschema-runtypes used to transform runtypes validators into JSON schema objects. It is typically used by backend, but it is not restricted to that.