https://github.com/gcanti/io-ts

Runtime type system for IO decoding/encoding
https://github.com/gcanti/io-ts

inference runtime types typescript validation

Last synced: 7 days ago
JSON representation

Runtime type system for IO decoding/encoding

• Host: GitHub
• URL: https://github.com/gcanti/io-ts
• Owner: gcanti
• License: mit
• Created: 2017-01-28T16:23:37.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-04T07:57:23.000Z (11 months ago)
• Last Synced: 2024-04-14T14:59:53.870Z (7 months ago)
• Topics: inference, runtime, types, typescript, validation
• Language: TypeScript
• Homepage: https://gcanti.github.io/io-ts/
• Size: 2.78 MB
• Stars: 6,592
• Watchers: 54
• Forks: 331
• Open Issues: 158
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - gcanti/io-ts - Runtime type system for IO decoding/encoding (TypeScript)
• awesome-fp-ts - gcanti/io-ts - Runtime type system for IO decoding/encoding (Domain modeling in TypeScript by Benoit Ruiz)
• awesome-github-star - io-ts
• awesome-functional-frontend - io-ts

README

        
[![build status](https://img.shields.io/travis/gcanti/io-ts/master.svg?style=flat-square)](https://travis-ci.org/gcanti/io-ts)

![npm downloads](https://img.shields.io/npm/dm/io-ts.svg)

- [Installation](#installation)

- [Usage](#usage)

  - [Stable features](#stable-features)

  - [Experimental features (version `2.2+`)](#experimental-features-version-22)

# Installation

To install the stable version

```sh

npm i io-ts fp-ts

```

**Note**. [`fp-ts`](https://github.com/gcanti/fp-ts) is a peer dependency for `io-ts`

# Usage

## Stable features

- [Documentation of the main stable features (`index.ts` module)](index.md)

## Experimental modules (version `2.2+`)

Experimental 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.

The experimental modules are **independent and backward-incompatible** with stable ones.

- [`Decoder.ts` module](Decoder.md)

- [`Encoder.ts` module](Encoder.md)

- [`Codec.ts` module](Codec.md)

- [`Eq.ts` module](Eq.md)

- [`Schema.ts` module (advanced feature)](Schema.md)

(\*) A feature tagged as _Experimental_ is in a high state of flux, you're at risk of it changing without notice.