Skip to content

Commit

Permalink
Preparing for release v3.0.0
Browse files Browse the repository at this point in the history
Resolved #39
Resolved #42
  • Loading branch information
piotrwitek committed Dec 20, 2018
1 parent ad002a7 commit ef3484d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,18 @@
[![Dependency Status](https://img.shields.io/david/piotrwitek/utility-types.svg)](https://david-dm.org/piotrwitek/utility-types)
[![peerDependency Status](https://img.shields.io/david/peer/piotrwitek/utility-types.svg)](https://david-dm.org/piotrwitek/utility-types#info=devDependencies)

## Utility Types for TypeScript (provide migration from [Flow's Utility Types](https://flow.org/en/docs/types/utilities/))
## Utility Types Collection for TypeScript

* v1.X - compatible with TS v2.7.2
* v2.X - compatible with TS v2.8.1 (rewritten to conditional types)
## TypeScript compatibility notes
* v1 - minimum TS v2.7.2
* v2 - minimum TS v2.8.1 (rewritten to conditional types)
* v3 - minimum TS v3.1.0

## Motivation

The primary goal of this library is to provide a set of proven Utility Types (inspired by [Set Theory](https://en.wikipedia.org/wiki/Set_theory) and functional languages) that should complement existing [TypeScript Mapped Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html).

The secondary goal is to provide a compatibility layer with [Flow's Utility Types](https://flow.org/en/docs/types/utilities/).
The secondary goal is to provide additional utility types compatible with [Flow's Utility Types](https://flow.org/en/docs/types/utilities/).
[Flow](https://flow.org) and [TypeScript](https://typescriptlang.org) have a lot in common. By using this library TypeScript Developers will become more familiar with differences to "Flow" and extend their static-typing toolbelt.
Moreover it can help to migrate between "Flow" and "TypeScript" projects much easier.

Expand All @@ -29,9 +31,8 @@ Moreover it can help to migrate between "Flow" and "TypeScript" projects much ea

## Features

* Tested for type correctness
* No third-party dependencies
* Provides multiple output formats (es5-commonjs, es5-module, jsnext)
* Tested for type correctness with type-testing library `dts-jest`
* Minimal footprint - type-level only, no third-party dependencies

## Installation

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "utility-types",
"version": "2.1.0",
"description": "Utility Types Library for TypeScript",
"version": "3.0.0",
"description": "Utility Types Collection for TypeScript",
"author": "Piotr Witek <piotrek.witek@gmail.com> (http://piotrwitek.github.io)",
"repository": "https://github.com/piotrwitek/utility-types",
"homepage": "https://github.com/piotrwitek/utility-types",
Expand Down

0 comments on commit ef3484d

Please sign in to comment.