io-ts-types
Version:
A collection of codecs and combinators for use with io-ts
30 lines (19 loc) • 927 B
Markdown
A collection of runtime types and combinators for use with [io-ts](https://github.com/gcanti/io-ts)
# Installation
To install the stable version:
```sh
npm i io-ts-types
```
**Note**. `io-ts-types` depends on
- [`fp-ts`](https://github.com/gcanti/fp-ts)
- [`io-ts`](https://github.com/gcanti/io-ts)
- [`monocle-ts`](https://github.com/gcanti/monocle-ts)
- [`newtype-ts`](https://github.com/gcanti/newtype-ts)
starting from `0.5.0` you must install `fp-ts`, `io-ts`, `newtype-ts` and `monocle-ts` manually (`fp-ts`, `io-ts`, `newtype-ts` and `monocle-ts` are listed in `peerDependency`)
# TypeScript compatibility
| `io-ts-types` version | required `typescript` version |
| --------------------- | ----------------------------- |
| 0.5.x | 3.5+ |
| 0.4.x | 3.1+ |
# Documentation
- [API Reference](https://gcanti.github.io/io-ts-types)