Skip to content

soul-codes/diots

Repository files navigation

diots - documentation-preserving decoders

diots (for "documented io-ts" ) augments io-ts decoders. It provides a parallel set of decoder factory functions (such as string, struct, etc), with the main difference that diots decoders also preserve structural metadata that can be inspected through the meta property. Additionally, the decoders can be documented with the documentation tagger doc, which lets you write documentation using kbts, "kbts").

The diots decoders are compatible with/can substitute for native io-ts decoders, and the latter can be lifted into the diots realm using the atomic function.

It provides the docgen module, which inspects decoder's structural metadata fields and generate kbts documentation.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published