upgrade to latest docs-ts

qstearns · Jun 15, 2020 · baca458 · baca458
1 parent 2aa88a8
commit baca458
Show file tree

Hide file tree

Showing 27 changed files with 2,365 additions and 1,923 deletions.
diff --git a/docs/modules/Codec.ts.md b/docs/modules/Codec.ts.md
diff --git a/docs/modules/Decoder.ts.md b/docs/modules/Decoder.ts.md
diff --git a/docs/modules/Encoder.ts.md b/docs/modules/Encoder.ts.md
@@ -4,232 +4,253 @@ nav_order: 3
 parent: Modules
 ---
 
-# Encoder overview
+## Encoder overview
 
 Added in v2.2.3
 
 ---
 
 <h2 class="text-delta">Table of contents</h2>
 
-- [Encoder (interface)](#encoder-interface)
-- [OutputOf (type alias)](#outputof-type-alias)
-- [TypeOf (type alias)](#typeof-type-alias)
-- [URI (type alias)](#uri-type-alias)
-- [URI](#uri)
-- [array](#array)
-- [categoryEncoder](#categoryencoder)
-- [compose](#compose)
-- [contramap](#contramap)
-- [contravariantEncoder](#contravariantencoder)
-- [id](#id)
-- [intersection](#intersection)
-- [lazy](#lazy)
-- [nullable](#nullable)
-- [partial](#partial)
-- [record](#record)
-- [sum](#sum)
-- [tuple](#tuple)
-- [type](#type)
+- [Contravariant](#contravariant)
+  - [contramap](#contramap)
+- [Semigroupoid](#semigroupoid)
+  - [compose](#compose)
+- [combinators](#combinators)
+  - [array](#array)
+  - [intersection](#intersection)
+  - [lazy](#lazy)
+  - [nullable](#nullable)
+  - [partial](#partial)
+  - [record](#record)
+  - [sum](#sum)
+  - [tuple](#tuple)
+  - [type](#type)
+- [constructors](#constructors)
+  - [id](#id)
+- [instances](#instances)
+  - [URI](#uri)
+  - [URI (type alias)](#uri-type-alias)
+  - [categoryEncoder](#categoryencoder)
+  - [contravariantEncoder](#contravariantencoder)
+- [model](#model)
+  - [Encoder (interface)](#encoder-interface)
+- [utils](#utils)
+  - [OutputOf (type alias)](#outputof-type-alias)
+  - [TypeOf (type alias)](#typeof-type-alias)
 
 ---
 
-# Encoder (interface)
+# Contravariant
+
+## contramap
 
 **Signature**
 
 ```ts
-export interface Encoder<O, A> {
-  readonly encode: (a: A) => O
-}
+export declare const contramap: <A, B>(f: (b: B) => A) => <E>(fa: Encoder<E, A>) => Encoder<E, B>
 ```
 
 Added in v2.2.3
 
-# OutputOf (type alias)
+# Semigroupoid
+
+## compose
 
 **Signature**
 
 ```ts
-export type OutputOf<E> = E extends Encoder<infer O, any> ? O : never
+export declare const compose: <E, A>(ea: Encoder<E, A>) => <B>(ab: Encoder<A, B>) => Encoder<E, B>
 ```
 
 Added in v2.2.3
 
-# TypeOf (type alias)
+# combinators
+
+## array
 
 **Signature**
 
 ```ts
-export type TypeOf<E> = E extends Encoder<any, infer A> ? A : never
+export declare function array<O, A>(items: Encoder<O, A>): Encoder<Array<O>, Array<A>>
 ```
 
 Added in v2.2.3
 
-# URI (type alias)
+## intersection
 
 **Signature**
 
 ```ts
-export type URI = typeof URI
+export declare function intersection<O, A, P, B>(left: Encoder<O, A>, right: Encoder<P, B>): Encoder<O & P, A & B>
 ```
 
 Added in v2.2.3
 
-# URI
+## lazy
 
 **Signature**
 
 ```ts
-export declare const URI: 'io-ts/Encoder'
+export declare function lazy<O, A>(f: () => Encoder<O, A>): Encoder<O, A>
 ```
 
 Added in v2.2.3
 
-# array
+## nullable
 
 **Signature**
 
 ```ts
-export declare function array<O, A>(items: Encoder<O, A>): Encoder<Array<O>, Array<A>>
+export declare function nullable<O, A>(or: Encoder<O, A>): Encoder<null | O, null | A>
 ```
 
 Added in v2.2.3
 
-# categoryEncoder
+## partial
 
 **Signature**
 
 ```ts
-export declare const categoryEncoder: Category2<'io-ts/Encoder'>
+export declare function partial<P extends Record<string, Encoder<any, any>>>(
+  properties: P
+): Encoder<Partial<{ [K in keyof P]: OutputOf<P[K]> }>, Partial<{ [K in keyof P]: TypeOf<P[K]> }>>
 ```
 
 Added in v2.2.3
 
-# compose
+## record
 
 **Signature**
 
 ```ts
-export declare const compose: <E, A>(ea: Encoder<E, A>) => <B>(ab: Encoder<A, B>) => Encoder<E, B>
+export declare function record<O, A>(codomain: Encoder<O, A>): Encoder<Record<string, O>, Record<string, A>>
 ```
 
 Added in v2.2.3
 
-# contramap
+## sum
 
 **Signature**
 
 ```ts
-export declare const contramap: <A, B>(f: (b: B) => A) => <E>(fa: Encoder<E, A>) => Encoder<E, B>
+export declare function sum<T extends string>(
+  tag: T
+): <M extends Record<string, Encoder<any, any>>>(members: M) => Encoder<OutputOf<M[keyof M]>, TypeOf<M[keyof M]>>
 ```
 
 Added in v2.2.3
 
-# contravariantEncoder
+## tuple
 
 **Signature**
 
 ```ts
-export declare const contravariantEncoder: Contravariant2<'io-ts/Encoder'>
+export declare function tuple<C extends ReadonlyArray<Encoder<any, any>>>(
+  ...components: C
+): Encoder<{ [K in keyof C]: OutputOf<C[K]> }, { [K in keyof C]: TypeOf<C[K]> }>
 ```
 
 Added in v2.2.3
 
-# id
+## type
 
 **Signature**
 
 ```ts
-export declare function id<A>(): Encoder<A, A>
+export declare function type<P extends Record<string, Encoder<any, any>>>(
+  properties: P
+): Encoder<{ [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
 ```
 
 Added in v2.2.3
 
-# intersection
+# constructors
+
+## id
 
 **Signature**
 
 ```ts
-export declare function intersection<O, A, P, B>(left: Encoder<O, A>, right: Encoder<P, B>): Encoder<O & P, A & B>
+export declare function id<A>(): Encoder<A, A>
 ```
 
 Added in v2.2.3
 
-# lazy
+# instances
+
+## URI
 
 **Signature**
 
 ```ts
-export declare function lazy<O, A>(f: () => Encoder<O, A>): Encoder<O, A>
+export declare const URI: 'io-ts/Encoder'
 ```
 
 Added in v2.2.3
 
-# nullable
+## URI (type alias)
 
 **Signature**
 
 ```ts
-export declare function nullable<O, A>(or: Encoder<O, A>): Encoder<null | O, null | A>
+export type URI = typeof URI
 ```
 
 Added in v2.2.3
 
-# partial
+## categoryEncoder
 
 **Signature**
 
 ```ts
-export declare function partial<P extends Record<string, Encoder<any, any>>>(
-  properties: P
-): Encoder<Partial<{ [K in keyof P]: OutputOf<P[K]> }>, Partial<{ [K in keyof P]: TypeOf<P[K]> }>>
+export declare const categoryEncoder: Category2<'io-ts/Encoder'>
 ```
 
 Added in v2.2.3
 
-# record
+## contravariantEncoder
 
 **Signature**
 
 ```ts
-export declare function record<O, A>(codomain: Encoder<O, A>): Encoder<Record<string, O>, Record<string, A>>
+export declare const contravariantEncoder: Contravariant2<'io-ts/Encoder'>
 ```
 
 Added in v2.2.3
 
-# sum
+# model
+
+## Encoder (interface)
 
 **Signature**
 
 ```ts
-export declare function sum<T extends string>(
-  tag: T
-): <M extends Record<string, Encoder<any, any>>>(members: M) => Encoder<OutputOf<M[keyof M]>, TypeOf<M[keyof M]>>
+export interface Encoder<O, A> {
+  readonly encode: (a: A) => O
+}
 ```
 
 Added in v2.2.3
 
-# tuple
+# utils
+
+## OutputOf (type alias)
 
 **Signature**
 
 ```ts
-export declare function tuple<C extends ReadonlyArray<Encoder<any, any>>>(
-  ...components: C
-): Encoder<{ [K in keyof C]: OutputOf<C[K]> }, { [K in keyof C]: TypeOf<C[K]> }>
+export type OutputOf<E> = E extends Encoder<infer O, any> ? O : never
 ```
 
 Added in v2.2.3
 
-# type
+## TypeOf (type alias)
 
 **Signature**
 
 ```ts
-export declare function type<P extends Record<string, Encoder<any, any>>>(
-  properties: P
-): Encoder<{ [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>
+export type TypeOf<E> = E extends Encoder<any, infer A> ? A : never
 ```
 
 Added in v2.2.3