UNPKG

1.5 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[![dependency status](https://img.shields.io/david/gcanti/io-ts.svg?style=flat-square)](https://david-dm.org/gcanti/io-ts)
3![npm downloads](https://img.shields.io/npm/dm/io-ts.svg)
4
5<!-- START doctoc generated TOC please keep comment here to allow auto update -->
6<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
7
8- [Installation](#installation)
9- [Usage](#usage)
10 - [Stable features](#stable-features)
11 - [Experimental features (version `2.2+`)](#experimental-features-version-22)
12
13<!-- END doctoc generated TOC please keep comment here to allow auto update -->
14
15# Installation
16
17To install the stable version
18
19```sh
20npm i io-ts fp-ts
21```
22
23**Note**. [`fp-ts`](https://github.com/gcanti/fp-ts) is a peer dependency for `io-ts`
24
25# Usage
26
27## Stable features
28
29- [`index.ts` module](index.md)
30
31## Experimental features (version `2.2+`)
32
33Experimental features (\*) 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.
34
35- [`Decoder.ts` module](Decoder.md)
36- [`Encoder.ts` module](Encoder.md)
37- [`Codec.ts` module](Codec.md)
38- [`Eq.ts` module](Eq.md)
39- [`Schema.ts` module (advanced feature)](Schema.md)
40
41(\*) A feature tagged as _Experimental_ is in a high state of flux, you're at risk of it changing without notice.