update docs

fp-ts · Dec 13, 2022 · 97d9abf · 97d9abf
1 parent 51bb90b
commit 97d9abf
Show file tree

Hide file tree

Showing 31 changed files with 101 additions and 646 deletions.
diff --git a/docs/modules/HKT.ts.md b/docs/modules/HKT.ts.md
@@ -1,6 +1,6 @@
 ---
 title: HKT.ts
-nav_order: 3
+nav_order: 1
 parent: Modules
 ---
 
@@ -27,20 +27,20 @@ Added in v1.0.0
 
 ```ts
 export type Kind<F extends TypeLambda, In, Out2, Out1, Target> = F extends {
-  readonly type: unknown
+  type: unknown
 }
   ? (F & {
-      readonly In: In
-      readonly Out2: Out2
-      readonly Out1: Out1
-      readonly Target: Target
+      In: In
+      Out2: Out2
+      Out1: Out1
+      Target: Target
     })['type']
   : {
-      readonly F: F
-      readonly In: (_: In) => void
-      readonly Out2: () => Out2
-      readonly Out1: () => Out1
-      readonly Target: (_: Target) => Target
+      F: F
+      In: (_: In) => void
+      Out2: () => Out2
+      Out1: () => Out1
+      Target: (_: Target) => Target
     }
 ```
 
@@ -52,7 +52,7 @@ Added in v1.0.0
 
 ```ts
 export interface TypeClass<F extends TypeLambda> {
-  readonly [URI]?: F
+  [URI]?: F
 }
 ```
 
@@ -64,10 +64,10 @@ Added in v1.0.0
 
 ```ts
 export interface TypeLambda {
-  readonly In: unknown
-  readonly Out2: unknown
-  readonly Out1: unknown
-  readonly Target: unknown
+  In: unknown
+  Out2: unknown
+  Out1: unknown
+  Target: unknown
 }
 ```
 

diff --git a/docs/modules/data/Either.ts.md b/docs/modules/data/Either.ts.md
diff --git a/docs/modules/data/Option.ts.md b/docs/modules/data/Option.ts.md
diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md
@@ -1,6 +1,6 @@
 ---
 title: index.ts
-nav_order: 4
+nav_order: 2
 parent: Modules
 ---
 
@@ -12,20 +12,15 @@ Added in v1.0.0
 
 <h2 class="text-delta">Table of contents</h2>
 
-- [data types](#data-types)
-  - [either](#either)
-  - [option](#option)
 - [typeclass](#typeclass)
   - [alternative](#alternative)
   - [applicative](#applicative)
   - [bicovariant](#bicovariant)
   - [bounded](#bounded)
   - [chainable](#chainable)
-  - [compactable](#compactable)
   - [contravariant](#contravariant)
   - [coproduct](#coproduct)
   - [covariant](#covariant)
-  - [filterable](#filterable)
   - [flatMap](#flatmap)
   - [foldable](#foldable)
   - [invariant](#invariant)
@@ -42,34 +37,11 @@ Added in v1.0.0
   - [semiProduct](#semiproduct)
   - [semigroup](#semigroup)
   - [traversable](#traversable)
-  - [traversableFilterable](#traversablefilterable)
 - [utils](#utils)
   - [hkt](#hkt)
 
 ---
 
-# data types
-
-## either
-
-**Signature**
-
-```ts
-export declare const either: typeof either
-```
-
-Added in v1.0.0
-
-## option
-
-**Signature**
-
-```ts
-export declare const option: typeof option
-```
-
-Added in v1.0.0
-
 # typeclass
 
 ## alternative
@@ -122,16 +94,6 @@ export declare const chainable: typeof chainable
 
 Added in v1.0.0
 
-## compactable
-
-**Signature**
-
-```ts
-export declare const compactable: typeof compactable
-```
-
-Added in v1.0.0
-
 ## contravariant
 
 **Signature**
@@ -162,16 +124,6 @@ export declare const covariant: typeof covariant
 
 Added in v1.0.0
 
-## filterable
-
-**Signature**
-
-```ts
-export declare const filterable: typeof filterable
-```
-
-Added in v1.0.0
-
 ## flatMap
 
 **Signature**
@@ -332,16 +284,6 @@ export declare const traversable: typeof traversable
 
 Added in v1.0.0
 
-## traversableFilterable
-
-**Signature**
-
-```ts
-export declare const traversableFilterable: typeof traversableFilterable
-```
-
-Added in v1.0.0
-
 # utils
 
 ## hkt

diff --git a/docs/modules/typeclass/Alternative.ts.md b/docs/modules/typeclass/Alternative.ts.md
@@ -1,6 +1,6 @@
 ---
 title: typeclass/Alternative.ts
-nav_order: 5
+nav_order: 3
 parent: Modules
 ---
 

diff --git a/docs/modules/typeclass/Applicative.ts.md b/docs/modules/typeclass/Applicative.ts.md
@@ -1,6 +1,6 @@
 ---
 title: typeclass/Applicative.ts
-nav_order: 6
+nav_order: 4
 parent: Modules
 ---
 

diff --git a/docs/modules/typeclass/Bicovariant.ts.md b/docs/modules/typeclass/Bicovariant.ts.md
@@ -1,6 +1,6 @@
 ---
 title: typeclass/Bicovariant.ts
-nav_order: 7
+nav_order: 5
 parent: Modules
 ---
 
@@ -29,10 +29,7 @@ Added in v1.0.0
 
 ```ts
 export interface Bicovariant<F extends TypeLambda> extends TypeClass<F> {
-  readonly bimap: <E1, E2, A, B>(
-    f: (e: E1) => E2,
-    g: (a: A) => B
-  ) => <R, O>(self: Kind<F, R, O, E1, A>) => Kind<F, R, O, E2, B>
+  bimap: <E1, E2, A, B>(f: (e: E1) => E2, g: (a: A) => B) => <R, O>(self: Kind<F, R, O, E1, A>) => Kind<F, R, O, E2, B>
 }
 ```
 

diff --git a/docs/modules/typeclass/Bounded.ts.md b/docs/modules/typeclass/Bounded.ts.md
@@ -1,6 +1,6 @@
 ---
 title: typeclass/Bounded.ts
-nav_order: 8
+nav_order: 6
 parent: Modules
 ---
 
@@ -30,8 +30,8 @@ Added in v1.0.0
 
 ```ts
 export interface Bounded<A> extends Order<A> {
-  readonly maxBound: A
-  readonly minBound: A
+  maxBound: A
+  minBound: A
 }
 ```
 
@@ -45,7 +45,7 @@ Added in v1.0.0
 
 ```ts
 export interface BoundedTypeLambda extends TypeLambda {
-  readonly type: Bounded<this['Target']>
+  type: Bounded<this['Target']>
 }
 ```