Skip to content

Commit

Permalink
upgrade to latest docs-ts
Browse files Browse the repository at this point in the history
  • Loading branch information
gcanti committed Dec 11, 2019
1 parent 45b126b commit 60719ba
Show file tree
Hide file tree
Showing 185 changed files with 872 additions and 343 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,19 @@
**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.

# 2.3.0

- **New Feature**
- add `ReaderTask` module (@sledorze)
- `ReaderTaskEither`
- add `getReaderTaskValidation` (@sledorze)
- `ReaderEither`
- add `getReaderValidation` (@gcanti)
- `TaskEither`
- improve `getTaskValidation` (@gcanti)
- `IOEither`
- improve `getIOValidation` (@gcanti)

# 2.2.0

- **New Feature**
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Alt.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 1
parent: Modules
---

# Overview
# Alt overview

The `Alt` type class identifies an associative operation on a type constructor. It is similar to `Semigroup`, except
that it applies to types of kind `* -> *`, like `Array` or `Option`, rather than concrete types like `string` or
Expand All @@ -15,6 +15,8 @@ that it applies to types of kind `* -> *`, like `Array` or `Option`, rather than
1. Associativity: `A.alt(A.alt(fa, ga), ha) = A.alt(fa, A.alt(ga, ha))`
2. Distributivity: `A.map(A.alt(fa, ga), ab) = A.alt(A.map(fa, ab), A.map(ga, ab))`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Alternative.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 2
parent: Modules
---

# Overview
# Alternative overview

The `Alternative` type class extends the `Alt` type class with a value that should be the left and right identity for `alt`.

Expand All @@ -19,6 +19,8 @@ concrete types like `string` or `number`.
4. Distributivity: `A.ap(A.alt(fab, gab), fa) = A.alt(A.ap(fab, fa), A.ap(gab, fa))`
5. Annihilation: `A.ap(zero, fa) = zero`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Applicative.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 3
parent: Modules
---

# Overview
# Applicative overview

The `Applicative` type class extends the `Apply` type class with a `of` function, which can be used to create values
of type `f a` from values of type `a`.
Expand All @@ -22,6 +22,8 @@ Instances must satisfy the following laws in addition to the `Apply` laws:

Note. `Functor`'s `map` can be derived: `A.map(x, f) = A.ap(A.of(f), x)`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Apply.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 4
parent: Modules
---

# Overview
# Apply overview

The `Apply` class provides the `ap` which is used to apply a function to an argument under a type constructor.

Expand All @@ -17,6 +17,8 @@ Instances must satisfy the following law in addition to the `Functor` laws:

Formally, `Apply` represents a strong lax semi-monoidal endofunctor.

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Array.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ nav_order: 5
parent: Modules
---

# Overview
# Array overview

Adapted from https://github.com/purescript/purescript-arrays

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/Bifunctor.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 6
parent: Modules
---

# Bifunctor overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/BooleanAlgebra.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 8
parent: Modules
---

# Overview
# BooleanAlgebra overview

Boolean algebras are Heyting algebras with the additional constraint that the law of the excluded middle is true
(equivalently, double-negation is true).
Expand All @@ -15,6 +15,8 @@ Instances should satisfy the following laws in addition to the `HeytingAlgebra`

Boolean algebras generalize classical logic: one is equivalent to "true" and zero is equivalent to "false".

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Bounded.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ nav_order: 9
parent: Modules
---

# Overview
# Bounded overview

The `Bounded` type class represents totally ordered types that have an upper and lower boundary.

Instances should satisfy the following law in addition to the `Ord` laws:

- Bounded: `bottom <= a <= top`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/BoundedDistributiveLattice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ nav_order: 10
parent: Modules
---

# Overview
# BoundedDistributiveLattice overview

A `BoundedDistributiveLattice` is a lattice that is both bounded and distributive

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/BoundedJoinSemilattice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ nav_order: 11
parent: Modules
---

# Overview
# BoundedJoinSemilattice overview

A `BoundedJoinSemilattice` must satisfy the following laws in addition to `JoinSemilattice` laws:

- `a ∨ 0 == a`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/BoundedLattice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ nav_order: 12
parent: Modules
---

# Overview
# BoundedLattice overview

A `BoundedLattice` must satisfy the following in addition to `BoundedMeetSemilattice` and `BoundedJoinSemilattice` laws:

- Absorption law for meet: `a ∧ (a ∨ b) == a`
- Absorption law for join: `a ∨ (a ∧ b) == a`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/BoundedMeetSemilattice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ nav_order: 13
parent: Modules
---

# Overview
# BoundedMeetSemilattice overview

A `BoundedMeetSemilattice` must satisfy the following laws in addition to `MeetSemilattice` laws:

- `a ∧ 1 = a`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/Category.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 14
parent: Modules
---

# Category overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Chain.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 15
parent: Modules
---

# Overview
# Chain overview

The `Chain` type class extends the `Apply` type class with a `chain` operation which composes computations in
sequence, using the return value of one computation to determine the next computation.
Expand All @@ -15,6 +15,8 @@ Instances must satisfy the following law in addition to the `Apply` laws:

Note. `Apply`'s `ap` can be derived: `(fab, fa) => F.chain(fab, f => F.map(f, fa))`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/ChainRec.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 16
parent: Modules
---

# ChainRec overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Choice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 17
parent: Modules
---

# Overview
# Choice overview

The `Choice` class extends `Profunctor` with combinators for working with
sum types.
Expand Down Expand Up @@ -33,6 +33,8 @@ left side of an `Either`, and `right` maps it over the right side (same as `map`

Adapted from https://github.com/purescript/purescript-profunctor/blob/master/src/Data/Profunctor/Choice.purs

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/Comonad.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 18
parent: Modules
---

# Comonad overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Compactable.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 19
parent: Modules
---

# Overview
# Compactable overview

`Compactable` represents data structures which can be _compacted_/_filtered_. This is a generalization of
`catOptions` as a new function `compact`. `compact` has relations with `Functor`, `Applicative`,
Expand All @@ -14,6 +14,8 @@ values, or failure.

Adapted from https://github.com/LiamGoodacre/purescript-filterable/blob/master/src/Data/Compactable.purs

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Console.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ nav_order: 20
parent: Modules
---

# Overview
# Console overview

Adapted from https://github.com/purescript/purescript-console

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/Const.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 21
parent: Modules
---

# Const overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/Contravariant.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 22
parent: Modules
---

# Contravariant overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/Date.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 23
parent: Modules
---

# Date overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/DistributiveLattice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ nav_order: 24
parent: Modules
---

# Overview
# DistributiveLattice overview

A `DistributiveLattice` must satisfy the following laws in addition to `Lattice` laws:

- Distributivity for meet: `a ∨ (b ∧ c) = (a ∨ b) ∧ (a ∨ c)`
- Distributivity for join: `a ∧ (b ∨ c) = (a ∧ b) ∨ (a ∧ c)`

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/Either.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 25
parent: Modules
---

# Overview
# Either overview

Represents a value of one of two possible types (a disjoint union).

Expand Down Expand Up @@ -33,6 +33,8 @@ either.map(right(12), double) // right(24)
either.map(left(23), double) // left(23)
```

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/EitherT.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ nav_order: 26
parent: Modules
---

# EitherT overview

Added in v2.0.0

---

<h2 class="text-delta">Table of contents</h2>
Expand Down
Loading

0 comments on commit 60719ba

Please sign in to comment.