UNPKG

1.46 kBMarkdownView Raw
1[![build status](https://img.shields.io/travis/gcanti/io-ts/master.svg?style=flat-square)](https://travis-ci.org/gcanti/io-ts)
2![npm downloads](https://img.shields.io/npm/dm/io-ts.svg)
3
4<!-- START doctoc generated TOC please keep comment here to allow auto update -->
5<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
6
7- [Installation](#installation)
8- [Usage](#usage)
9 - [Stable features](#stable-features)
10 - [Experimental features (version `2.2+`)](#experimental-features-version-22)
11
12<!-- END doctoc generated TOC please keep comment here to allow auto update -->
13
14# Installation
15
16To install the stable version
17
18```sh
19npm i io-ts fp-ts
20```
21
22**Note**. [`fp-ts`](https://github.com/gcanti/fp-ts) is a peer dependency for `io-ts`
23
24# Usage
25
26## Stable features
27
28- [`index.ts` module](index.md)
29
30## Experimental modules (version `2.2+`)
31
32Experimental modules (\*) are published in order to get early feedback from the community, see these tracking [issues](https://github.com/gcanti/io-ts/issues?q=label%3Av2.2+) for further discussions and enhancements.
33
34The experimental modules are **independent and backward-incompatible** with stable ones.
35
36- [`Decoder.ts` module](Decoder.md)
37- [`Encoder.ts` module](Encoder.md)
38- [`Codec.ts` module](Codec.md)
39- [`Eq.ts` module](Eq.md)
40- [`Schema.ts` module (advanced feature)](Schema.md)
41
42(\*) A feature tagged as _Experimental_ is in a high state of flux, you're at risk of it changing without notice.