Skip to content

ty-ras/data-io-ts

Repository files navigation

Typesafe REST API Specification - IO-TS 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 io-ts data validation library:

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