Skip to content

Commit

Permalink
add zone of death
Browse files Browse the repository at this point in the history
  • Loading branch information
gcanti committed Sep 30, 2022
1 parent df9c5fc commit 08b8ebf
Show file tree
Hide file tree
Showing 124 changed files with 3,173 additions and 2,762 deletions.
3 changes: 3 additions & 0 deletions docs/modules/Applicative.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Added in v2.0.0
- [Applicative4 (interface)](#applicative4-interface)
- [utils](#utils)
- [getApplicativeMonoid](#getapplicativemonoid)
- [zone of death](#zone-of-death)
- [~~ApplicativeComposition11~~ (interface)](#applicativecomposition11-interface)
- [~~ApplicativeComposition12C~~ (interface)](#applicativecomposition12c-interface)
- [~~ApplicativeComposition12~~ (interface)](#applicativecomposition12-interface)
Expand Down Expand Up @@ -157,6 +158,8 @@ export declare function getApplicativeMonoid<F>(F: Applicative<F>): <A>(M: Monoi

Added in v2.10.0

# zone of death

## ~~ApplicativeComposition11~~ (interface)

**Signature**
Expand Down
127 changes: 65 additions & 62 deletions docs/modules/Array.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ Added in v2.0.0
- [makeBy](#makeby)
- [of](#of)
- [replicate](#replicate)
- [~~cons~~](#cons)
- [~~range~~](#range)
- [~~snoc~~](#snoc)
- [conversions](#conversions)
- [fromEither](#fromeither)
- [fromOption](#fromoption)
Expand Down Expand Up @@ -89,7 +86,6 @@ Added in v2.0.0
- [getShow](#getshow)
- [getUnionMonoid](#getunionmonoid)
- [getUnionSemigroup](#getunionsemigroup)
- [~~array~~](#array)
- [lifting](#lifting)
- [fromEitherK](#fromeitherk)
- [fromOptionK](#fromoptionk)
Expand Down Expand Up @@ -194,8 +190,13 @@ Added in v2.0.0
- [zero](#zero)
- [zip](#zip)
- [zipWith](#zipwith)
- [zone of death](#zone-of-death)
- [~~array~~](#array)
- [~~cons~~](#cons)
- [~~empty~~](#empty)
- [~~prependToAll~~](#prependtoall)
- [~~range~~](#range)
- [~~snoc~~](#snoc)

---

Expand Down Expand Up @@ -271,42 +272,6 @@ assert.deepStrictEqual(replicate(2.985647, 'a'), ['a', 'a'])

Added in v2.0.0

## ~~cons~~

Use `prepend` instead.

**Signature**

```ts
export declare const cons: typeof NEA.cons
```
Added in v2.0.0
## ~~range~~
Use `NonEmptyArray` module instead.
**Signature**
```ts
export declare const range: (start: number, end: number) => NEA.NonEmptyArray<number>
```
Added in v2.0.0
## ~~snoc~~
Use `append` instead.
**Signature**
```ts
export declare const snoc: <A>(init: A[], end: A) => NEA.NonEmptyArray<A>
```
Added in v2.0.0
# conversions

## fromEither
Expand Down Expand Up @@ -1361,28 +1326,6 @@ assert.deepStrictEqual(S.concat([1, 2], [2, 3]), [1, 2, 3])

Added in v2.11.0

## ~~array~~

This instance is deprecated, use small, specific instances instead.
For example if a function needs a `Functor` instance, pass `A.Functor` instead of `A.array`
(where `A` is from `import A from 'fp-ts/Array'`)

**Signature**

```ts
export declare const array: FunctorWithIndex1<'Array', number> &
Monad1<'Array'> &
Unfoldable1<'Array'> &
Alternative1<'Array'> &
Extend1<'Array'> &
FilterableWithIndex1<'Array', number> &
FoldableWithIndex1<'Array', number> &
TraversableWithIndex1<'Array', number> &
Witherable1<'Array'>
```
Added in v2.0.0
# lifting

## fromEitherK
Expand Down Expand Up @@ -3604,6 +3547,42 @@ assert.deepStrictEqual(

Added in v2.0.0

# zone of death

## ~~array~~

This instance is deprecated, use small, specific instances instead.
For example if a function needs a `Functor` instance, pass `A.Functor` instead of `A.array`
(where `A` is from `import A from 'fp-ts/Array'`)

**Signature**

```ts
export declare const array: FunctorWithIndex1<'Array', number> &
Monad1<'Array'> &
Unfoldable1<'Array'> &
Alternative1<'Array'> &
Extend1<'Array'> &
FilterableWithIndex1<'Array', number> &
FoldableWithIndex1<'Array', number> &
TraversableWithIndex1<'Array', number> &
Witherable1<'Array'>
```

Added in v2.0.0

## ~~cons~~

Use `prepend` instead.

**Signature**

```ts
export declare const cons: typeof NEA.cons
```

Added in v2.0.0

## ~~empty~~

Use a new `[]` instead.
Expand All @@ -3627,3 +3606,27 @@ export declare const prependToAll: <A>(middle: A) => (as: A[]) => A[]
```

Added in v2.9.0

## ~~range~~

Use `NonEmptyArray` module instead.

**Signature**

```ts
export declare const range: (start: number, end: number) => NEA.NonEmptyArray<number>
```

Added in v2.0.0

## ~~snoc~~

Use `append` instead.

**Signature**

```ts
export declare const snoc: <A>(init: A[], end: A) => NEA.NonEmptyArray<A>
```

Added in v2.0.0
49 changes: 26 additions & 23 deletions docs/modules/BooleanAlgebra.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ Added in v2.0.0

- [instances](#instances)
- [booleanAlgebraVoid](#booleanalgebravoid)
- [~~booleanAlgebraBoolean~~](#booleanalgebraboolean)
- [~~getFunctionBooleanAlgebra~~](#getfunctionbooleanalgebra)
- [model](#model)
- [BooleanAlgebra (interface)](#booleanalgebra-interface)
- [utils](#utils)
- [reverse](#reverse)
- [zone of death](#zone-of-death)
- [~~booleanAlgebraBoolean~~](#booleanalgebraboolean)
- [~~getDualBooleanAlgebra~~](#getdualbooleanalgebra)
- [~~getFunctionBooleanAlgebra~~](#getfunctionbooleanalgebra)

---

Expand All @@ -45,66 +46,68 @@ export declare const booleanAlgebraVoid: BooleanAlgebra<void>
Added in v2.0.0
## ~~booleanAlgebraBoolean~~
# model
Use [`BooleanAlgebra`](./boolean.ts.html#booleanalgebra) instead.
## BooleanAlgebra (interface)
**Signature**
```ts
export declare const booleanAlgebraBoolean: BooleanAlgebra<boolean>
export interface BooleanAlgebra<A> extends HeytingAlgebra<A> {}
```

Added in v2.0.0

## ~~getFunctionBooleanAlgebra~~
# utils

Use [`getBooleanAlgebra`](./function.ts.html#getbooleanalgebra) instead.
## reverse

Every boolean algebras has a dual algebra, which involves reversing one/zero as well as join/meet.

**Signature**

```ts
export declare const getFunctionBooleanAlgebra: <B>(
B: BooleanAlgebra<B>
) => <A = never>() => BooleanAlgebra<(a: A) => B>
export declare const reverse: <A>(B: BooleanAlgebra<A>) => BooleanAlgebra<A>
```
Added in v2.0.0
Added in v2.10.0
# model
# zone of death
## BooleanAlgebra (interface)
## ~~booleanAlgebraBoolean~~
Use [`BooleanAlgebra`](./boolean.ts.html#booleanalgebra) instead.
**Signature**
```ts
export interface BooleanAlgebra<A> extends HeytingAlgebra<A> {}
export declare const booleanAlgebraBoolean: BooleanAlgebra<boolean>
```
Added in v2.0.0
# utils

## reverse
## ~~getDualBooleanAlgebra~~
Every boolean algebras has a dual algebra, which involves reversing one/zero as well as join/meet.
Use [`reverse`](#reverse) instead.
**Signature**
```ts
export declare const reverse: <A>(B: BooleanAlgebra<A>) => BooleanAlgebra<A>
export declare const getDualBooleanAlgebra: <A>(B: BooleanAlgebra<A>) => BooleanAlgebra<A>
```
Added in v2.10.0
Added in v2.0.0
## ~~getDualBooleanAlgebra~~
## ~~getFunctionBooleanAlgebra~~
Use [`reverse`](#reverse) instead.
Use [`getBooleanAlgebra`](./function.ts.html#getbooleanalgebra) instead.
**Signature**
```ts
export declare const getDualBooleanAlgebra: <A>(B: BooleanAlgebra<A>) => BooleanAlgebra<A>
export declare const getFunctionBooleanAlgebra: <B>(
B: BooleanAlgebra<B>
) => <A = never>() => BooleanAlgebra<(a: A) => B>
```
Added in v2.0.0
32 changes: 16 additions & 16 deletions docs/modules/Bounded.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,16 @@ Added in v2.0.0

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

- [instances](#instances)
- [~~boundedNumber~~](#boundednumber)
- [model](#model)
- [Bounded (interface)](#bounded-interface)
- [utils](#utils)
- [clamp](#clamp)
- [reverse](#reverse)
- [zone of death](#zone-of-death)
- [~~boundedNumber~~](#boundednumber)

---

# instances

## ~~boundedNumber~~

Use [`Bounded`](./number.ts.html#bounded) instead.

**Signature**

```ts
export declare const boundedNumber: Bounded<number>
```
Added in v2.0.0
# model

## Bounded (interface)
Expand Down Expand Up @@ -82,3 +68,17 @@ export declare const reverse: <A>(B: Bounded<A>) => Bounded<A>
```
Added in v2.12.0
# zone of death
## ~~boundedNumber~~
Use [`Bounded`](./number.ts.html#bounded) instead.
**Signature**
```ts
export declare const boundedNumber: Bounded<number>
```
Added in v2.0.0
3 changes: 3 additions & 0 deletions docs/modules/Choice.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Added in v2.0.0
- [fanIn](#fanin)
- [split](#split)
- [~~fanin~~](#fanin)
- [zone of death](#zone-of-death)
- [~~splitChoice~~](#splitchoice)

---
Expand Down Expand Up @@ -213,6 +214,8 @@ export declare function fanin<F>(

Added in v2.0.0

# zone of death

## ~~splitChoice~~

Use [`split`](#split) instead.
Expand Down
Loading

0 comments on commit 08b8ebf

Please sign in to comment.