version 0.7.0

Author: gcanti

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 120
+}

.travis.yml

@@ -1,9 +1,3 @@
 language: node_js
 node_js:
-  - "10"
-
-install:
-  - npm install
-
-script:
-  - npm run test
+  - '10'

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

CHANGELOG.md

@@ -13,6 +13,11 @@
 **Note**: Gaps between patch versions are faulty/broken releases. **Note**: A feature tagged as Experimental is in a
 high state of flux, you're at risk of it changing without notice.
 
+# 0.7.0
+
+- **Breaking Change**
+  - Upgrade to io-ts@2 and add fp-ts dependency, #20 (@ifiokjr)
+
 # 0.6.2
 
 - **Polish**

README.md

@@ -62,11 +62,11 @@ export default class Alert extends React.Component<Props, void> {
 # Errors on console
 
 ```ts
-;<Alert type="foo" /> // => Invalid value "foo" supplied to : Props/type: AlertType
+<Alert type="foo" /> // => Invalid value "foo" supplied to : Props/type: AlertType
 ```
 
 ```ts
-;<Alert type="info" foo="bar" /> // => Invalid additional prop(s): ["foo"]
+<Alert type="info" foo="bar" /> // => Invalid additional prop(s): ["foo"]
 ```
 
 # Excess Property Checks
@@ -136,4 +136,7 @@ export default class Alert extends React.Component<Props, void> {
 
 # TypeScript compatibility
 
-The stable version is tested against TypeScript 3.2.2, but should run with TypeScript 2.7.1+ too
+| `prop-type-ts` version | required `typescript` version |
+| ---------------------- | ----------------------------- |
+| 0.7.x+                 | 3.5+                          |
+| 0.6.x+                 | 3.2+                          |

docs/_config.yml

@@ -0,0 +1,9 @@
+remote_theme: pmarsceill/just-the-docs
+
+# Enable or disable the site search
+search_enabled: true
+
+# Aux links for the upper right navigation
+aux_links:
+  'prop-types-ts on GitHub':
+    - 'https://github.com/gcanti/prop-types-ts'

docs/index.md

@@ -0,0 +1,4 @@
+---
+title: Home
+nav_order: 1
+---

docs/modules/index.md

@@ -0,0 +1,6 @@
+---
+title: Modules
+has_children: true
+permalink: /docs/modules
+nav_order: 2
+---

docs/modules/index.ts.md

@@ -0,0 +1,218 @@
+---
+title: index.ts
+nav_order: 1
+parent: Modules
+---
+
+# index overview
+
+Added in v0.6.0
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [PropTypeableIntersection (interface)](#proptypeableintersection-interface)
+- [PropTypeableReadonlyType (interface)](#proptypeablereadonlytype-interface)
+- [PropTypeableRefinement (interface)](#proptypeablerefinement-interface)
+- [PropTypeableUnion (interface)](#proptypeableunion-interface)
+- [Options (type alias)](#options-type-alias)
+- [PropTypeable (type alias)](#proptypeable-type-alias)
+- [ReactChildType (class)](#reactchildtype-class)
+- [ReactElementType (class)](#reactelementtype-class)
+- [ReactFragmentType (class)](#reactfragmenttype-class)
+- [ReactNodeType (class)](#reactnodetype-class)
+- [ReactChild (constant)](#reactchild-constant)
+- [ReactElement (constant)](#reactelement-constant)
+- [ReactFragment (constant)](#reactfragment-constant)
+- [ReactNode (constant)](#reactnode-constant)
+- [getPropTypes (function)](#getproptypes-function)
+- [props (function)](#props-function)
+
+---
+
+# PropTypeableIntersection (interface)
+
+**Signature**
+
+```ts
+export interface PropTypeableIntersection extends t.IntersectionType<Array<PropTypeable>> {}
+```
+
+Added in v0.6.0
+
+# PropTypeableReadonlyType (interface)
+
+**Signature**
+
+```ts
+export interface PropTypeableReadonlyType extends t.ReadonlyType<PropTypeable> {}
+```
+
+Added in v0.6.0
+
+# PropTypeableRefinement (interface)
+
+**Signature**
+
+```ts
+export interface PropTypeableRefinement extends t.RefinementType<PropTypeable> {}
+```
+
+Added in v0.6.0
+
+# PropTypeableUnion (interface)
+
+**Signature**
+
+```ts
+export interface PropTypeableUnion extends t.UnionType<Array<PropTypeable>> {}
+```
+
+Added in v0.6.0
+
+# Options (type alias)
+
+**Signature**
+
+```ts
+export type Options = {
+  strict?: boolean
+  children?: t.Mixed
+  reporter?: Reporter<string[]>
+}
+```
+
+Added in v0.6.0
+
+# PropTypeable (type alias)
+
+**Signature**
+
+```ts
+export type PropTypeable =
+  // tslint:disable-next-line: deprecation
+  | t.AnyType
+  | PropTypeableRefinement
+  | PropTypeableReadonlyType
+  | PropTypeableIntersection
+  | t.InterfaceType<any>
+  // tslint:disable-next-line: deprecation
+  | t.StrictType<any>
+  | t.PartialType<any>
+  | PropTypeableUnion
+```
+
+Added in v0.6.0
+
+# ReactChildType (class)
+
+**Signature**
+
+```ts
+export class ReactChildType {
+  constructor() { ... }
+  ...
+}
+```
+
+Added in v0.6.0
+
+# ReactElementType (class)
+
+**Signature**
+
+```ts
+export class ReactElementType {
+  constructor() { ... }
+  ...
+}
+```
+
+Added in v0.6.0
+
+# ReactFragmentType (class)
+
+**Signature**
+
+```ts
+export class ReactFragmentType {
+  constructor() { ... }
+  ...
+}
+```
+
+Added in v0.6.0
+
+# ReactNodeType (class)
+
+**Signature**
+
+```ts
+export class ReactNodeType {
+  constructor() { ... }
+  ...
+}
+```
+
+Added in v0.6.0
+
+# ReactChild (constant)
+
+**Signature**
+
+```ts
+export const ReactChild: ReactChildType = ...
+```
+
+Added in v0.6.0
+
+# ReactElement (constant)
+
+**Signature**
+
+```ts
+export const ReactElement: ReactElementType = ...
+```
+
+Added in v0.6.0
+
+# ReactFragment (constant)
+
+**Signature**
+
+```ts
+export const ReactFragment: ReactFragmentType = ...
+```
+
+Added in v0.6.0
+
+# ReactNode (constant)
+
+**Signature**
+
+```ts
+export const ReactNode: ReactNodeType = ...
+```
+
+Added in v0.6.0
+
+# getPropTypes (function)
+
+**Signature**
+
+```ts
+export function getPropTypes(type: PropTypeable, options: Options = { strict: true }) { ... }
+```
+
+Added in v0.6.0
+
+# props (function)
+
+**Signature**
+
+```ts
+export function props(type: PropTypeable, options?: Options): (C: React.ComponentClass<any>) => void { ... }
+```
+
+Added in v0.6.0