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

A collection of codecs and combinators for use with io-ts
https://github.com/gcanti/io-ts-types

Last synced: 10 days ago
JSON representation

A collection of codecs and combinators for use with io-ts

• Host: GitHub
• URL: https://github.com/gcanti/io-ts-types
• Owner: gcanti
• License: mit
• Created: 2017-04-08T09:53:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-14T21:35:29.000Z (about 1 year ago)
• Last Synced: 2024-10-12T22:55:29.904Z (28 days ago)
• Language: TypeScript
• Homepage: https://gcanti.github.io/io-ts-types/
• Size: 703 KB
• Stars: 311
• Watchers: 11
• Forks: 40
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-fp-ts - gcanti/io-ts-types - A collection of codecs and combinators (Domain modeling in TypeScript by Benoit Ruiz)

README

        
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)