From 08b8ebf3abed88fca64493125ab3708a857698e9 Mon Sep 17 00:00:00 2001 From: gcanti Date: Fri, 30 Sep 2022 18:20:34 +0200 Subject: [PATCH] add zone of death --- docs/modules/Applicative.ts.md | 3 + docs/modules/Array.ts.md | 127 +++--- docs/modules/BooleanAlgebra.ts.md | 49 +- docs/modules/Bounded.ts.md | 32 +- docs/modules/Choice.ts.md | 3 + docs/modules/Compactable.ts.md | 35 +- docs/modules/Const.ts.md | 33 +- docs/modules/Either.ts.md | 253 +++++------ docs/modules/EitherT.ts.md | 72 +-- docs/modules/Eq.ts.md | 119 ++--- docs/modules/Field.ts.md | 32 +- docs/modules/Filterable.ts.md | 3 + docs/modules/Foldable.ts.md | 32 +- docs/modules/FoldableWithIndex.ts.md | 3 + docs/modules/Functor.ts.md | 3 + docs/modules/FunctorWithIndex.ts.md | 3 + docs/modules/IO.ts.md | 110 ++--- docs/modules/IOEither.ts.md | 175 ++++---- docs/modules/Identity.ts.md | 43 +- docs/modules/Map.ts.md | 29 +- docs/modules/Monoid.ts.md | 270 +++++------ docs/modules/NonEmptyArray.ts.md | 97 ++-- docs/modules/Option.ts.md | 267 +++++------ docs/modules/OptionT.ts.md | 72 +-- docs/modules/Ord.ts.md | 133 +++--- docs/modules/Ordering.ts.md | 81 ++-- docs/modules/Reader.ts.md | 93 ++-- docs/modules/ReaderEither.ts.md | 147 +++--- docs/modules/ReaderT.ts.md | 84 ++-- docs/modules/ReaderTask.ts.md | 115 ++--- docs/modules/ReaderTaskEither.ts.md | 163 +++---- docs/modules/ReadonlyArray.ts.md | 127 +++--- docs/modules/ReadonlyMap.ts.md | 33 +- docs/modules/ReadonlyNonEmptyArray.ts.md | 97 ++-- docs/modules/ReadonlyRecord.ts.md | 171 +++---- docs/modules/ReadonlySet.ts.md | 29 +- docs/modules/ReadonlyTuple.ts.md | 41 +- docs/modules/Record.ts.md | 171 +++---- docs/modules/Ring.ts.md | 32 +- docs/modules/Semigroup.ts.md | 315 ++++++------- docs/modules/Semiring.ts.md | 30 +- docs/modules/Set.ts.md | 3 + docs/modules/Show.ts.md | 84 ++-- docs/modules/State.ts.md | 33 +- docs/modules/StateReaderTaskEither.ts.md | 79 ++-- docs/modules/StateT.ts.md | 3 + docs/modules/Store.ts.md | 33 +- docs/modules/Strong.ts.md | 3 + docs/modules/Task.ts.md | 141 +++--- docs/modules/TaskEither.ts.md | 187 ++++---- docs/modules/TaskThese.ts.md | 137 +++--- docs/modules/These.ts.md | 59 +-- docs/modules/TheseT.ts.md | 72 +-- docs/modules/Traced.ts.md | 29 +- docs/modules/Traversable.ts.md | 3 + docs/modules/Tree.ts.md | 33 +- docs/modules/Tuple.ts.md | 67 +-- docs/modules/ValidationT.ts.md | 4 +- docs/modules/Writer.ts.md | 29 +- docs/modules/function.ts.md | 29 +- docs/modules/index.ts.md | 25 +- docs/modules/pipeable.ts.md | 547 ++++++++++++----------- src/Applicative.ts | 12 + src/Array.ts | 10 +- src/BooleanAlgebra.ts | 5 +- src/Bounded.ts | 2 +- src/Choice.ts | 1 + src/Compactable.ts | 21 +- src/Const.ts | 2 +- src/Either.ts | 19 +- src/EitherT.ts | 11 +- src/Eq.ts | 13 +- src/Field.ts | 2 +- src/Filterable.ts | 10 + src/Foldable.ts | 12 +- src/FoldableWithIndex.ts | 9 + src/Functor.ts | 14 + src/FunctorWithIndex.ts | 9 + src/IO.ts | 8 +- src/IOEither.ts | 12 +- src/Identity.ts | 2 +- src/Map.ts | 4 +- src/Monoid.ts | 24 +- src/NonEmptyArray.ts | 13 +- src/Option.ts | 12 +- src/OptionT.ts | 11 +- src/Ord.ts | 12 +- src/Ordering.ts | 7 +- src/Reader.ts | 6 +- src/ReaderEither.ts | 10 +- src/ReaderT.ts | 13 +- src/ReaderTask.ts | 10 +- src/ReaderTaskEither.ts | 11 +- src/ReadonlyArray.ts | 9 +- src/ReadonlyMap.ts | 3 +- src/ReadonlyNonEmptyArray.ts | 14 +- src/ReadonlyRecord.ts | 16 +- src/ReadonlySet.ts | 2 +- src/ReadonlyTuple.ts | 2 +- src/Record.ts | 17 +- src/Ring.ts | 3 +- src/Semigroup.ts | 29 +- src/Semiring.ts | 2 +- src/Set.ts | 1 + src/Show.ts | 8 +- src/State.ts | 4 +- src/StateReaderTaskEither.ts | 7 +- src/StateT.ts | 7 + src/Store.ts | 2 +- src/Strong.ts | 2 + src/Task.ts | 10 +- src/TaskEither.ts | 12 +- src/TaskThese.ts | 10 +- src/These.ts | 4 +- src/TheseT.ts | 10 +- src/Traced.ts | 2 +- src/Traversable.ts | 5 + src/Tree.ts | 2 +- src/Tuple.ts | 6 +- src/ValidationT.ts | 7 + src/Writer.ts | 4 +- src/function.ts | 6 +- src/index.ts | 2 +- src/pipeable.ts | 93 ++++ 124 files changed, 3173 insertions(+), 2762 deletions(-) diff --git a/docs/modules/Applicative.ts.md b/docs/modules/Applicative.ts.md index ae9a260ac..1fb82d016 100644 --- a/docs/modules/Applicative.ts.md +++ b/docs/modules/Applicative.ts.md @@ -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) @@ -157,6 +158,8 @@ export declare function getApplicativeMonoid(F: Applicative): (M: Monoi Added in v2.10.0 +# zone of death + ## ~~ApplicativeComposition11~~ (interface) **Signature** diff --git a/docs/modules/Array.ts.md b/docs/modules/Array.ts.md index 9647eca9a..a2e0456b5 100644 --- a/docs/modules/Array.ts.md +++ b/docs/modules/Array.ts.md @@ -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) @@ -89,7 +86,6 @@ Added in v2.0.0 - [getShow](#getshow) - [getUnionMonoid](#getunionmonoid) - [getUnionSemigroup](#getunionsemigroup) - - [~~array~~](#array) - [lifting](#lifting) - [fromEitherK](#fromeitherk) - [fromOptionK](#fromoptionk) @@ -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) --- @@ -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 -``` - -Added in v2.0.0 - -## ~~snoc~~ - -Use `append` instead. - -**Signature** - -```ts -export declare const snoc: (init: A[], end: A) => NEA.NonEmptyArray -``` - -Added in v2.0.0 - # conversions ## fromEither @@ -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 @@ -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. @@ -3627,3 +3606,27 @@ export declare const prependToAll: (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 +``` + +Added in v2.0.0 + +## ~~snoc~~ + +Use `append` instead. + +**Signature** + +```ts +export declare const snoc: (init: A[], end: A) => NEA.NonEmptyArray +``` + +Added in v2.0.0 diff --git a/docs/modules/BooleanAlgebra.ts.md b/docs/modules/BooleanAlgebra.ts.md index 58f10cf7f..7a4e749bd 100644 --- a/docs/modules/BooleanAlgebra.ts.md +++ b/docs/modules/BooleanAlgebra.ts.md @@ -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) --- @@ -45,66 +46,68 @@ export declare const booleanAlgebraVoid: BooleanAlgebra Added in v2.0.0 -## ~~booleanAlgebraBoolean~~ +# model -Use [`BooleanAlgebra`](./boolean.ts.html#booleanalgebra) instead. +## BooleanAlgebra (interface) **Signature** ```ts -export declare const booleanAlgebraBoolean: BooleanAlgebra +export interface BooleanAlgebra extends HeytingAlgebra {} ``` 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: BooleanAlgebra -) => () => BooleanAlgebra<(a: A) => B> +export declare const reverse: (B: BooleanAlgebra) => BooleanAlgebra ``` -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 extends HeytingAlgebra {} +export declare const booleanAlgebraBoolean: BooleanAlgebra ``` 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: (B: BooleanAlgebra) => BooleanAlgebra +export declare const getDualBooleanAlgebra: (B: BooleanAlgebra) => BooleanAlgebra ``` -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: (B: BooleanAlgebra) => BooleanAlgebra +export declare const getFunctionBooleanAlgebra: ( + B: BooleanAlgebra +) => () => BooleanAlgebra<(a: A) => B> ``` Added in v2.0.0 diff --git a/docs/modules/Bounded.ts.md b/docs/modules/Bounded.ts.md index 60d8201b1..8e5b4615e 100644 --- a/docs/modules/Bounded.ts.md +++ b/docs/modules/Bounded.ts.md @@ -18,30 +18,16 @@ Added in v2.0.0

Table of contents

-- [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 -``` - -Added in v2.0.0 - # model ## Bounded (interface) @@ -82,3 +68,17 @@ export declare const reverse:
(B: Bounded) => Bounded ``` Added in v2.12.0 + +# zone of death + +## ~~boundedNumber~~ + +Use [`Bounded`](./number.ts.html#bounded) instead. + +**Signature** + +```ts +export declare const boundedNumber: Bounded +``` + +Added in v2.0.0 diff --git a/docs/modules/Choice.ts.md b/docs/modules/Choice.ts.md index 053e67719..e864aea0d 100644 --- a/docs/modules/Choice.ts.md +++ b/docs/modules/Choice.ts.md @@ -48,6 +48,7 @@ Added in v2.0.0 - [fanIn](#fanin) - [split](#split) - [~~fanin~~](#fanin) +- [zone of death](#zone-of-death) - [~~splitChoice~~](#splitchoice) --- @@ -213,6 +214,8 @@ export declare function fanin( Added in v2.0.0 +# zone of death + ## ~~splitChoice~~ Use [`split`](#split) instead. diff --git a/docs/modules/Compactable.ts.md b/docs/modules/Compactable.ts.md index 7daba3238..f857aeee6 100644 --- a/docs/modules/Compactable.ts.md +++ b/docs/modules/Compactable.ts.md @@ -31,6 +31,8 @@ Added in v2.0.0 - [utils](#utils) - [compact](#compact) - [separate](#separate) + - [~~Separated~~ (interface)](#separated-interface) +- [zone of death](#zone-of-death) - [~~CompactableComposition11~~ (interface)](#compactablecomposition11-interface) - [~~CompactableComposition12C~~ (interface)](#compactablecomposition12c-interface) - [~~CompactableComposition12~~ (interface)](#compactablecomposition12-interface) @@ -41,7 +43,6 @@ Added in v2.0.0 - [~~CompactableComposition23~~ (interface)](#compactablecomposition23-interface) - [~~CompactableComposition2C1~~ (interface)](#compactablecomposition2c1-interface) - [~~CompactableComposition~~ (interface)](#compactablecomposition-interface) - - [~~Separated~~ (interface)](#separated-interface) - [~~getCompactableComposition~~](#getcompactablecomposition) --- @@ -218,6 +219,23 @@ export declare function separate( Added in v2.10.0 +## ~~Separated~~ (interface) + +Use [`Separated`](./Separated.ts.html#separated) instead. + +**Signature** + +```ts +export interface Separated { + readonly left: A + readonly right: B +} +``` + +Added in v2.0.0 + +# zone of death + ## ~~CompactableComposition11~~ (interface) **Signature** @@ -364,21 +382,6 @@ export interface CompactableComposition extends FunctorComposition { Added in v2.0.0 -## ~~Separated~~ (interface) - -Use [`Separated`](./Separated.ts.html#separated) instead. - -**Signature** - -```ts -export interface Separated { - readonly left: A - readonly right: B -} -``` - -Added in v2.0.0 - ## ~~getCompactableComposition~~ Use [`compact`](#compact) and [`separate`](#separate) instead. diff --git a/docs/modules/Const.ts.md b/docs/modules/Const.ts.md index 96ff274a2..fe643e076 100644 --- a/docs/modules/Const.ts.md +++ b/docs/modules/Const.ts.md @@ -40,7 +40,6 @@ Added in v2.0.0 - [getSemigroup](#getsemigroup) - [getSemiring](#getsemiring) - [getShow](#getshow) - - [~~const\_~~](#const_) - [mapping](#mapping) - [bimap](#bimap) - [flap](#flap) @@ -50,6 +49,8 @@ Added in v2.0.0 - [type lambdas](#type-lambdas) - [URI](#uri) - [URI (type alias)](#uri-type-alias) +- [zone of death](#zone-of-death) + - [~~const\_~~](#const_) --- @@ -243,20 +244,6 @@ export declare function getShow(S: Show): Show> Added in v2.0.0 -## ~~const\_~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `C.Functor` instead of `C.const_` -(where `C` is from `import C from 'fp-ts/Const'`) - -**Signature** - -```ts -export declare const const_: Functor2<'Const'> & Contravariant2<'Const'> & Bifunctor2<'Const'> -``` - -Added in v2.0.0 - # mapping ## bimap @@ -327,3 +314,19 @@ export type URI = typeof URI ``` Added in v2.0.0 + +# zone of death + +## ~~const\_~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `C.Functor` instead of `C.const_` +(where `C` is from `import C from 'fp-ts/Const'`) + +**Signature** + +```ts +export declare const const_: Functor2<'Const'> & Contravariant2<'Const'> & Bifunctor2<'Const'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Either.ts.md b/docs/modules/Either.ts.md index 8c1736233..dfd1195c2 100644 --- a/docs/modules/Either.ts.md +++ b/docs/modules/Either.ts.md @@ -77,8 +77,6 @@ Added in v2.0.0 - [left](#left) - [of](#of) - [right](#right) - - [~~parseJSON~~](#parsejson) - - [~~stringifyJSON~~](#stringifyjson) - [conversions](#conversions) - [fromNullable](#fromnullable) - [fromOption](#fromoption) @@ -129,12 +127,6 @@ Added in v2.0.0 - [getSemigroup](#getsemigroup) - [getShow](#getshow) - [getWitherable](#getwitherable) - - [~~either~~](#either) - - [~~getApplyMonoid~~](#getapplymonoid) - - [~~getApplySemigroup~~](#getapplysemigroup) - - [~~getValidationMonoid~~](#getvalidationmonoid) - - [~~getValidationSemigroup~~](#getvalidationsemigroup) - - [~~getValidation~~](#getvalidation) - [interop](#interop) - [tryCatch](#trycatch) - [tryCatchK](#trycatchk) @@ -193,9 +185,18 @@ Added in v2.0.0 - [traverseArrayWithIndex](#traversearraywithindex) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) - [~~JsonArray~~ (interface)](#jsonarray-interface) - [~~JsonRecord~~ (interface)](#jsonrecord-interface) - [~~Json~~ (type alias)](#json-type-alias) + - [~~either~~](#either) + - [~~getApplyMonoid~~](#getapplymonoid) + - [~~getApplySemigroup~~](#getapplysemigroup) + - [~~getValidationMonoid~~](#getvalidationmonoid) + - [~~getValidationSemigroup~~](#getvalidationsemigroup) + - [~~getValidation~~](#getvalidation) + - [~~parseJSON~~](#parsejson) + - [~~stringifyJSON~~](#stringifyjson) --- @@ -237,30 +238,6 @@ export declare const right: (a: A) => Either Added in v2.0.0 -## ~~parseJSON~~ - -Use [`parse`](./Json.ts.html#parse) instead. - -**Signature** - -```ts -export declare function parseJSON(s: string, onError: (reason: unknown) => E): Either -``` - -Added in v2.0.0 - -## ~~stringifyJSON~~ - -Use [`stringify`](./Json.ts.html#stringify) instead. - -**Signature** - -```ts -export declare const stringifyJSON: (u: unknown, onError: (reason: unknown) => E) => Either -``` - -Added in v2.0.0 - # conversions ## fromNullable @@ -1054,99 +1031,6 @@ export declare const getWitherable: (M: Monoid) => Witherable2C<'Either', Added in v2.0.0 -## ~~either~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `E.Functor` instead of `E.either` -(where `E` is from `import E from 'fp-ts/Either'`) - -**Signature** - -```ts -export declare const either: Monad2<'Either'> & - Foldable2<'Either'> & - Traversable2<'Either'> & - Bifunctor2<'Either'> & - Alt2<'Either'> & - Extend2<'Either'> & - ChainRec2<'Either'> & - MonadThrow2<'Either'> -``` - -Added in v2.0.0 - -## ~~getApplyMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getApplyMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getApplySemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values -are concatenated using the provided `Semigroup` - -**Signature** - -```ts -export declare const getApplySemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getValidationMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getValidationMonoid: (SE: Semigroup, MA: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getValidationSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getValidationSemigroup: (SE: Semigroup, SA: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getValidation~~ - -Use [`getApplicativeValidation`](#getapplicativevalidation) and [`getAltValidation`](#getaltvalidation) instead. - -**Signature** - -```ts -export declare function getValidation( - SE: Semigroup -): Monad2C & - Foldable2 & - Traversable2 & - Bifunctor2 & - Alt2C & - Extend2 & - ChainRec2C & - MonadThrow2C -``` - -Added in v2.0.0 - # interop ## tryCatch @@ -1892,6 +1776,8 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( Added in v2.11.0 +# zone of death + ## ~~JsonArray~~ (interface) Use [`Json`](./Json.ts.html) module instead. @@ -1929,3 +1815,120 @@ export type Json = boolean | number | string | null | JsonArray | JsonRecord ``` Added in v2.6.7 + +## ~~either~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `E.Functor` instead of `E.either` +(where `E` is from `import E from 'fp-ts/Either'`) + +**Signature** + +```ts +export declare const either: Monad2<'Either'> & + Foldable2<'Either'> & + Traversable2<'Either'> & + Bifunctor2<'Either'> & + Alt2<'Either'> & + Extend2<'Either'> & + ChainRec2<'Either'> & + MonadThrow2<'Either'> +``` + +Added in v2.0.0 + +## ~~getApplyMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getApplyMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getApplySemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values +are concatenated using the provided `Semigroup` + +**Signature** + +```ts +export declare const getApplySemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getValidationMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getValidationMonoid: (SE: Semigroup, MA: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getValidationSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getValidationSemigroup: (SE: Semigroup, SA: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getValidation~~ + +Use [`getApplicativeValidation`](#getapplicativevalidation) and [`getAltValidation`](#getaltvalidation) instead. + +**Signature** + +```ts +export declare function getValidation( + SE: Semigroup +): Monad2C & + Foldable2 & + Traversable2 & + Bifunctor2 & + Alt2C & + Extend2 & + ChainRec2C & + MonadThrow2C +``` + +Added in v2.0.0 + +## ~~parseJSON~~ + +Use [`parse`](./Json.ts.html#parse) instead. + +**Signature** + +```ts +export declare function parseJSON(s: string, onError: (reason: unknown) => E): Either +``` + +Added in v2.0.0 + +## ~~stringifyJSON~~ + +Use [`stringify`](./Json.ts.html#stringify) instead. + +**Signature** + +```ts +export declare const stringifyJSON: (u: unknown, onError: (reason: unknown) => E) => Either +``` + +Added in v2.0.0 diff --git a/docs/modules/EitherT.ts.md b/docs/modules/EitherT.ts.md index e08f2dfbb..3c77ffda7 100644 --- a/docs/modules/EitherT.ts.md +++ b/docs/modules/EitherT.ts.md @@ -20,10 +20,6 @@ Added in v2.0.0 - [altValidation](#altvalidation) - [orElseFirst](#orelsefirst) - [orLeft](#orleft) -- [model](#model) - - [~~EitherT1~~ (type alias)](#eithert1-type-alias) - - [~~EitherT2~~ (type alias)](#eithert2-type-alias) - - [~~EitherT~~ (interface)](#eithert-interface) - [pattern matching](#pattern-matching) - [match](#match) - [utils](#utils) @@ -45,9 +41,13 @@ Added in v2.0.0 - [rightF](#rightf) - [swap](#swap) - [toUnion](#tounion) +- [zone of death](#zone-of-death) - [~~EitherM1~~ (interface)](#eitherm1-interface) - [~~EitherM2~~ (interface)](#eitherm2-interface) - [~~EitherM~~ (interface)](#eitherm-interface) + - [~~EitherT1~~ (type alias)](#eithert1-type-alias) + - [~~EitherT2~~ (type alias)](#eithert2-type-alias) + - [~~EitherT~~ (interface)](#eithert-interface) - [~~getEitherM~~](#geteitherm) --- @@ -161,38 +161,6 @@ export declare function orLeft( Added in v2.11.0 -# model - -## ~~EitherT1~~ (type alias) - -**Signature** - -```ts -export type EitherT1 = Kind> -``` - -Added in v2.0.0 - -## ~~EitherT2~~ (type alias) - -**Signature** - -```ts -export type EitherT2 = Kind2> -``` - -Added in v2.0.0 - -## ~~EitherT~~ (interface) - -**Signature** - -```ts -export interface EitherT extends HKT> {} -``` - -Added in v2.0.0 - # pattern matching ## match @@ -773,6 +741,8 @@ export declare function toUnion(F: Functor): (fa: HKT extends ApplicativeCompositionHKT2 { Added in v2.0.0 +## ~~EitherT1~~ (type alias) + +**Signature** + +```ts +export type EitherT1 = Kind> +``` + +Added in v2.0.0 + +## ~~EitherT2~~ (type alias) + +**Signature** + +```ts +export type EitherT2 = Kind2> +``` + +Added in v2.0.0 + +## ~~EitherT~~ (interface) + +**Signature** + +```ts +export interface EitherT extends HKT> {} +``` + +Added in v2.0.0 + ## ~~getEitherM~~ **Signature** diff --git a/docs/modules/Eq.ts.md b/docs/modules/Eq.ts.md index 96802587d..e0e63b10c 100644 --- a/docs/modules/Eq.ts.md +++ b/docs/modules/Eq.ts.md @@ -29,11 +29,6 @@ Added in v2.0.0 - [eqStrict](#eqstrict) - [getMonoid](#getmonoid) - [getSemigroup](#getsemigroup) - - [~~eqBoolean~~](#eqboolean) - - [~~eqDate~~](#eqdate) - - [~~eqNumber~~](#eqnumber) - - [~~eqString~~](#eqstring) - - [~~eq~~](#eq) - [model](#model) - [Eq (interface)](#eq-interface) - [type lambdas](#type-lambdas) @@ -42,6 +37,12 @@ Added in v2.0.0 - [utils](#utils) - [struct](#struct) - [tuple](#tuple) +- [zone of death](#zone-of-death) + - [~~eqBoolean~~](#eqboolean) + - [~~eqDate~~](#eqdate) + - [~~eqNumber~~](#eqnumber) + - [~~eqString~~](#eqstring) + - [~~eq~~](#eq) - [~~getStructEq~~](#getstructeq) - [~~getTupleEq~~](#gettupleeq) - [~~strictEqual~~](#strictequal) @@ -157,142 +158,144 @@ export declare const getSemigroup: () => Semigroup> Added in v2.10.0 -## ~~eqBoolean~~ +# model -Use [`Eq`](./boolean.ts.html#eq) instead. +## Eq (interface) **Signature** ```ts -export declare const eqBoolean: Eq +export interface Eq { + readonly equals: (x: A, y: A) => boolean +} ``` Added in v2.0.0 -## ~~eqDate~~ +# type lambdas -Use [`Eq`](./Date.ts.html#eq) instead. +## URI **Signature** ```ts -export declare const eqDate: Eq +export declare const URI: 'Eq' ``` Added in v2.0.0 -## ~~eqNumber~~ - -Use [`Eq`](./number.ts.html#eq) instead. +## URI (type alias) **Signature** ```ts -export declare const eqNumber: Eq +export type URI = typeof URI ``` Added in v2.0.0 -## ~~eqString~~ +# utils -Use [`Eq`](./string.ts.html#eq) instead. +## struct **Signature** ```ts -export declare const eqString: Eq +export declare const struct: (eqs: { [K in keyof A]: Eq }) => Eq<{ readonly [K in keyof A]: A[K] }> ``` -Added in v2.0.0 +Added in v2.10.0 -## ~~eq~~ +## tuple -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Contravariant` instance, pass `E.Contravariant` instead of `E.eq` -(where `E` is from `import E from 'fp-ts/Eq'`) +Given a tuple of `Eq`s returns a `Eq` for the tuple **Signature** ```ts -export declare const eq: Contravariant1<'Eq'> +export declare const tuple: (...eqs: { [K in keyof A]: Eq }) => Eq> ``` -Added in v2.0.0 +**Example** -# model +```ts +import { tuple } from 'fp-ts/Eq' +import * as S from 'fp-ts/string' +import * as N from 'fp-ts/number' +import * as B from 'fp-ts/boolean' -## Eq (interface) +const E = tuple(S.Eq, N.Eq, B.Eq) +assert.strictEqual(E.equals(['a', 1, true], ['a', 1, true]), true) +assert.strictEqual(E.equals(['a', 1, true], ['b', 1, true]), false) +assert.strictEqual(E.equals(['a', 1, true], ['a', 2, true]), false) +assert.strictEqual(E.equals(['a', 1, true], ['a', 1, false]), false) +``` + +Added in v2.10.0 + +# zone of death + +## ~~eqBoolean~~ + +Use [`Eq`](./boolean.ts.html#eq) instead. **Signature** ```ts -export interface Eq { - readonly equals: (x: A, y: A) => boolean -} +export declare const eqBoolean: Eq ``` Added in v2.0.0 -# type lambdas +## ~~eqDate~~ -## URI +Use [`Eq`](./Date.ts.html#eq) instead. **Signature** ```ts -export declare const URI: 'Eq' +export declare const eqDate: Eq ``` Added in v2.0.0 -## URI (type alias) +## ~~eqNumber~~ + +Use [`Eq`](./number.ts.html#eq) instead. **Signature** ```ts -export type URI = typeof URI +export declare const eqNumber: Eq ``` Added in v2.0.0 -# utils +## ~~eqString~~ -## struct +Use [`Eq`](./string.ts.html#eq) instead. **Signature** ```ts -export declare const struct: (eqs: { [K in keyof A]: Eq }) => Eq<{ readonly [K in keyof A]: A[K] }> +export declare const eqString: Eq ``` -Added in v2.10.0 +Added in v2.0.0 -## tuple +## ~~eq~~ -Given a tuple of `Eq`s returns a `Eq` for the tuple +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Contravariant` instance, pass `E.Contravariant` instead of `E.eq` +(where `E` is from `import E from 'fp-ts/Eq'`) **Signature** ```ts -export declare const tuple: (...eqs: { [K in keyof A]: Eq }) => Eq> -``` - -**Example** - -```ts -import { tuple } from 'fp-ts/Eq' -import * as S from 'fp-ts/string' -import * as N from 'fp-ts/number' -import * as B from 'fp-ts/boolean' - -const E = tuple(S.Eq, N.Eq, B.Eq) -assert.strictEqual(E.equals(['a', 1, true], ['a', 1, true]), true) -assert.strictEqual(E.equals(['a', 1, true], ['b', 1, true]), false) -assert.strictEqual(E.equals(['a', 1, true], ['a', 2, true]), false) -assert.strictEqual(E.equals(['a', 1, true], ['a', 1, false]), false) +export declare const eq: Contravariant1<'Eq'> ``` -Added in v2.10.0 +Added in v2.0.0 ## ~~getStructEq~~ diff --git a/docs/modules/Field.ts.md b/docs/modules/Field.ts.md index df29c39ab..134509d39 100644 --- a/docs/modules/Field.ts.md +++ b/docs/modules/Field.ts.md @@ -14,30 +14,16 @@ Added in v2.0.0

Table of contents

-- [instances](#instances) - - [~~fieldNumber~~](#fieldnumber) - [model](#model) - [Field (interface)](#field-interface) - [utils](#utils) - [gcd](#gcd) - [lcm](#lcm) +- [zone of death](#zone-of-death) + - [~~fieldNumber~~](#fieldnumber) --- -# instances - -## ~~fieldNumber~~ - -Use [`Field`](./number.ts.html#field) instead. - -**Signature** - -```ts -export declare const fieldNumber: Field -``` - -Added in v2.0.0 - # model ## Field (interface) @@ -79,3 +65,17 @@ export declare function lcm
(E: Eq, F: Field): (x: A, y: A) => A ``` Added in v2.0.0 + +# zone of death + +## ~~fieldNumber~~ + +Use [`Field`](./number.ts.html#field) instead. + +**Signature** + +```ts +export declare const fieldNumber: Field +``` + +Added in v2.0.0 diff --git a/docs/modules/Filterable.ts.md b/docs/modules/Filterable.ts.md index 950fb3121..e77869e8a 100644 --- a/docs/modules/Filterable.ts.md +++ b/docs/modules/Filterable.ts.md @@ -43,6 +43,7 @@ Added in v2.0.0 - [filterMap](#filtermap) - [partition](#partition) - [partitionMap](#partitionmap) +- [zone of death](#zone-of-death) - [~~FilterableComposition11~~ (interface)](#filterablecomposition11-interface) - [~~FilterableComposition12C~~ (interface)](#filterablecomposition12c-interface) - [~~FilterableComposition12~~ (interface)](#filterablecomposition12-interface) @@ -547,6 +548,8 @@ export declare function partitionMap( Added in v2.10.0 +# zone of death + ## ~~FilterableComposition11~~ (interface) **Signature** diff --git a/docs/modules/Foldable.ts.md b/docs/modules/Foldable.ts.md index ed15c9135..9584a57c2 100644 --- a/docs/modules/Foldable.ts.md +++ b/docs/modules/Foldable.ts.md @@ -12,8 +12,6 @@ Added in v2.0.0

Table of contents

-- [conversions](#conversions) - - [~~toArray~~](#toarray) - [model](#model) - [Foldable (interface)](#foldable-interface) - [Foldable1 (interface)](#foldable1-interface) @@ -30,6 +28,7 @@ Added in v2.0.0 - [reduceRight](#reduceright) - [toReadonlyArray](#toreadonlyarray) - [traverse\_](#traverse_) +- [zone of death](#zone-of-death) - [~~FoldableComposition11~~ (interface)](#foldablecomposition11-interface) - [~~FoldableComposition12C~~ (interface)](#foldablecomposition12c-interface) - [~~FoldableComposition12~~ (interface)](#foldablecomposition12-interface) @@ -40,23 +39,10 @@ Added in v2.0.0 - [~~FoldableComposition~~ (interface)](#foldablecomposition-interface) - [~~foldM~~](#foldm) - [~~getFoldableComposition~~](#getfoldablecomposition) + - [~~toArray~~](#toarray) --- -# conversions - -## ~~toArray~~ - -Use [`toReadonlyArray`](#toreadonlyarray) instead - -**Signature** - -```ts -export declare const toArray: typeof toReadonlyArray -``` - -Added in v2.8.0 - # model ## Foldable (interface) @@ -399,6 +385,8 @@ assert.strictEqual(log, 'abc') Added in v2.0.0 +# zone of death + ## ~~FoldableComposition11~~ (interface) **Signature** @@ -591,3 +579,15 @@ export declare function getFoldableComposition(F: Foldable, G: Foldable ``` Added in v2.0.0 + +## ~~toArray~~ + +Use [`toReadonlyArray`](#toreadonlyarray) instead + +**Signature** + +```ts +export declare const toArray: typeof toReadonlyArray +``` + +Added in v2.8.0 diff --git a/docs/modules/FoldableWithIndex.ts.md b/docs/modules/FoldableWithIndex.ts.md index 1472df98e..68b4770f5 100644 --- a/docs/modules/FoldableWithIndex.ts.md +++ b/docs/modules/FoldableWithIndex.ts.md @@ -33,6 +33,7 @@ Added in v2.0.0 - [foldMapWithIndex](#foldmapwithindex) - [reduceRightWithIndex](#reducerightwithindex) - [reduceWithIndex](#reducewithindex) +- [zone of death](#zone-of-death) - [~~FoldableWithIndexComposition11~~ (interface)](#foldablewithindexcomposition11-interface) - [~~FoldableWithIndexComposition12C~~ (interface)](#foldablewithindexcomposition12c-interface) - [~~FoldableWithIndexComposition12~~ (interface)](#foldablewithindexcomposition12-interface) @@ -204,6 +205,8 @@ export declare function reduceWithIndex( Added in v2.10.0 +# zone of death + ## ~~FoldableWithIndexComposition11~~ (interface) **Signature** diff --git a/docs/modules/Functor.ts.md b/docs/modules/Functor.ts.md index a78662130..ba20570c3 100644 --- a/docs/modules/Functor.ts.md +++ b/docs/modules/Functor.ts.md @@ -37,6 +37,7 @@ Added in v2.0.0 - [let](#let) - [let\_](#let_) - [map](#map) +- [zone of death](#zone-of-death) - [~~FunctorComposition11~~ (interface)](#functorcomposition11-interface) - [~~FunctorComposition12C~~ (interface)](#functorcomposition12c-interface) - [~~FunctorComposition12~~ (interface)](#functorcomposition12-interface) @@ -313,6 +314,8 @@ export declare function map( Added in v2.10.0 +# zone of death + ## ~~FunctorComposition11~~ (interface) **Signature** diff --git a/docs/modules/FunctorWithIndex.ts.md b/docs/modules/FunctorWithIndex.ts.md index 67007542c..670db5587 100644 --- a/docs/modules/FunctorWithIndex.ts.md +++ b/docs/modules/FunctorWithIndex.ts.md @@ -32,6 +32,7 @@ Added in v2.0.0 - [FunctorWithIndex4 (interface)](#functorwithindex4-interface) - [utils](#utils) - [mapWithIndex](#mapwithindex) +- [zone of death](#zone-of-death) - [~~FunctorWithIndexComposition11~~ (interface)](#functorwithindexcomposition11-interface) - [~~FunctorWithIndexComposition12C~~ (interface)](#functorwithindexcomposition12c-interface) - [~~FunctorWithIndexComposition12~~ (interface)](#functorwithindexcomposition12-interface) @@ -151,6 +152,8 @@ export declare function mapWithIndex( Added in v2.10.0 +# zone of death + ## ~~FunctorWithIndexComposition11~~ (interface) **Signature** diff --git a/docs/modules/IO.ts.md b/docs/modules/IO.ts.md index d59b887e7..cdd78fa34 100644 --- a/docs/modules/IO.ts.md +++ b/docs/modules/IO.ts.md @@ -26,8 +26,6 @@ Added in v2.0.0 - [constructors](#constructors) - [of](#of) -- [conversions](#conversions) - - [~~fromIO~~](#fromio) - [do notation](#do-notation) - [Do](#do) - [apS](#aps) @@ -44,9 +42,6 @@ Added in v2.0.0 - [Monad](#monad) - [MonadIO](#monadio) - [Pointed](#pointed) - - [~~getMonoid~~](#getmonoid) - - [~~getSemigroup~~](#getsemigroup) - - [~~io~~](#io) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -70,6 +65,11 @@ Added in v2.0.0 - [traverseArrayWithIndex](#traversearraywithindex) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) + - [~~fromIO~~](#fromio) + - [~~getMonoid~~](#getmonoid) + - [~~getSemigroup~~](#getsemigroup) + - [~~io~~](#io) --- @@ -85,18 +85,6 @@ export declare const of:
(a: A) => IO Added in v2.0.0 -# conversions - -## ~~fromIO~~ - -**Signature** - -```ts -export declare const fromIO: (fa: IO) => IO -``` - -Added in v2.7.0 - # do notation ## Do @@ -250,44 +238,6 @@ export declare const Pointed: Pointed1<'IO'> Added in v2.10.0 -## ~~getMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~io~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `IO.Functor` instead of `IO.io` -(where `IO` is from `import IO from 'fp-ts/IO'`) - -**Signature** - -```ts -export declare const io: Monad1<'IO'> & MonadIO1<'IO'> & ChainRec1<'IO'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -493,3 +443,53 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( ``` Added in v2.11.0 + +# zone of death + +## ~~fromIO~~ + +**Signature** + +```ts +export declare const fromIO: (fa: IO) => IO +``` + +Added in v2.7.0 + +## ~~getMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~io~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `IO.Functor` instead of `IO.io` +(where `IO` is from `import IO from 'fp-ts/IO'`) + +**Signature** + +```ts +export declare const io: Monad1<'IO'> & MonadIO1<'IO'> & ChainRec1<'IO'> +``` + +Added in v2.0.0 diff --git a/docs/modules/IOEither.ts.md b/docs/modules/IOEither.ts.md index 52d73f8d2..297502cf8 100644 --- a/docs/modules/IOEither.ts.md +++ b/docs/modules/IOEither.ts.md @@ -73,12 +73,6 @@ Added in v2.0.0 - [MonadIO](#monadio) - [MonadThrow](#monadthrow-1) - [Pointed](#pointed) - - [~~Applicative~~](#applicative) - - [~~getApplyMonoid~~](#getapplymonoid) - - [~~getApplySemigroup~~](#getapplysemigroup) - - [~~getIOValidation~~](#getiovalidation) - - [~~getSemigroup~~](#getsemigroup) - - [~~ioEither~~](#ioeither) - [interop](#interop) - [tryCatch](#trycatch) - [tryCatchK](#trycatchk) @@ -139,6 +133,13 @@ Added in v2.0.0 - [traverseReadonlyNonEmptyArrayWithIndexSeq](#traversereadonlynonemptyarraywithindexseq) - [traverseSeqArray](#traverseseqarray) - [traverseSeqArrayWithIndex](#traverseseqarraywithindex) +- [zone of death](#zone-of-death) + - [~~Applicative~~](#applicative) + - [~~getApplyMonoid~~](#getapplymonoid) + - [~~getApplySemigroup~~](#getapplysemigroup) + - [~~getIOValidation~~](#getiovalidation) + - [~~getSemigroup~~](#getsemigroup) + - [~~ioEither~~](#ioeither) --- @@ -710,86 +711,6 @@ export declare const Pointed: Pointed2<'IOEither'> Added in v2.10.0 -## ~~Applicative~~ - -Use [`ApplicativePar`](#applicativepar) instead - -**Signature** - -```ts -export declare const Applicative: Applicative2<'IOEither'> -``` - -Added in v2.7.0 - -## ~~getApplyMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getApplyMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getApplySemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getApplySemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getIOValidation~~ - -Use [`getApplicativeIOValidation`](#getapplicativeiovalidation) and [`getAltIOValidation`](#getaltiovalidation). - -**Signature** - -```ts -export declare function getIOValidation( - SE: Semigroup -): Monad2C & Bifunctor2 & Alt2C & MonadIO2C & MonadThrow2C -``` - -Added in v2.0.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~ioEither~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `IOE.Functor` instead of `IOE.ioEither` -(where `IOE` is from `import IOE from 'fp-ts/IOEither'`) - -**Signature** - -```ts -export declare const ioEither: Monad2<'IOEither'> & - Bifunctor2<'IOEither'> & - Alt2<'IOEither'> & - MonadIO2<'IOEither'> & - MonadThrow2<'IOEither'> -``` - -Added in v2.0.0 - # interop ## tryCatch @@ -1460,3 +1381,85 @@ export declare const traverseSeqArrayWithIndex: ( ``` Added in v2.9.0 + +# zone of death + +## ~~Applicative~~ + +Use [`ApplicativePar`](#applicativepar) instead + +**Signature** + +```ts +export declare const Applicative: Applicative2<'IOEither'> +``` + +Added in v2.7.0 + +## ~~getApplyMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getApplyMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getApplySemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getApplySemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getIOValidation~~ + +Use [`getApplicativeIOValidation`](#getapplicativeiovalidation) and [`getAltIOValidation`](#getaltiovalidation). + +**Signature** + +```ts +export declare function getIOValidation( + SE: Semigroup +): Monad2C & Bifunctor2 & Alt2C & MonadIO2C & MonadThrow2C +``` + +Added in v2.0.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~ioEither~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `IOE.Functor` instead of `IOE.ioEither` +(where `IOE` is from `import IOE from 'fp-ts/IOEither'`) + +**Signature** + +```ts +export declare const ioEither: Monad2<'IOEither'> & + Bifunctor2<'IOEither'> & + Alt2<'IOEither'> & + MonadIO2<'IOEither'> & + MonadThrow2<'IOEither'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Identity.ts.md b/docs/modules/Identity.ts.md index 0c56378a6..a9593ed64 100644 --- a/docs/modules/Identity.ts.md +++ b/docs/modules/Identity.ts.md @@ -43,7 +43,6 @@ Added in v2.0.0 - [Traversable](#traversable) - [getEq](#geteq) - [getShow](#getshow) - - [~~identity~~](#identity) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -64,6 +63,8 @@ Added in v2.0.0 - [apSecond](#apsecond) - [duplicate](#duplicate) - [extend](#extend) +- [zone of death](#zone-of-death) + - [~~identity~~](#identity) --- @@ -345,25 +346,6 @@ export declare const getShow: (S: Show) => Show Added in v2.0.0 -## ~~identity~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `I.Functor` instead of `I.identity` -(where `I` is from `import I from 'fp-ts/Identity'`) - -**Signature** - -```ts -export declare const identity: Monad1<'Identity'> & - Foldable1<'Identity'> & - Traversable1<'Identity'> & - Alt1<'Identity'> & - Comonad1<'Identity'> & - ChainRec1<'Identity'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -535,3 +517,24 @@ export declare const extend: (f: (wa: A) => B) => (wa: A) => B ``` Added in v2.0.0 + +# zone of death + +## ~~identity~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `I.Functor` instead of `I.identity` +(where `I` is from `import I from 'fp-ts/Identity'`) + +**Signature** + +```ts +export declare const identity: Monad1<'Identity'> & + Foldable1<'Identity'> & + Traversable1<'Identity'> & + Alt1<'Identity'> & + Comonad1<'Identity'> & + ChainRec1<'Identity'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Map.ts.md b/docs/modules/Map.ts.md index 3308090b6..e0a9ca45c 100644 --- a/docs/modules/Map.ts.md +++ b/docs/modules/Map.ts.md @@ -44,7 +44,6 @@ Added in v2.0.0 - [getUnionMonoid](#getunionmonoid) - [getUnionSemigroup](#getunionsemigroup) - [getWitherable](#getwitherable) - - [~~map\_~~](#map_) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -78,8 +77,10 @@ Added in v2.0.0 - [updateAt](#updateat) - [upsertAt](#upsertat) - [values](#values) +- [zone of death](#zone-of-death) - [~~empty~~](#empty) - [~~insertAt~~](#insertat) + - [~~map\_~~](#map_) --- @@ -405,18 +406,6 @@ export declare function getWitherable(O: Ord): Witherable2C & Trav Added in v2.0.0 -## ~~map\_~~ - -Use [`Filterable`](#filterable) instead. - -**Signature** - -```ts -export declare const map_: Filterable2<'Map'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -785,6 +774,8 @@ export declare const values: (O: Ord) => (m: Map) => A[] Added in v2.0.0 +# zone of death + ## ~~empty~~ Use a `new Map()` instead. @@ -808,3 +799,15 @@ export declare const insertAt: (E: Eq) => (k: K, a: A) => (m: Map ``` Added in v2.0.0 + +## ~~map\_~~ + +Use [`Filterable`](#filterable) instead. + +**Signature** + +```ts +export declare const map_: Filterable2<'Map'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Monoid.ts.md b/docs/modules/Monoid.ts.md index f40932cfa..7d2b6ee44 100644 --- a/docs/modules/Monoid.ts.md +++ b/docs/modules/Monoid.ts.md @@ -46,17 +46,6 @@ Added in v2.0.0 - [constructors](#constructors) - [max](#max) - [min](#min) - - [~~getJoinMonoid~~](#getjoinmonoid) - - [~~getMeetMonoid~~](#getmeetmonoid) -- [instances](#instances) - - [~~getEndomorphismMonoid~~](#getendomorphismmonoid) - - [~~getFunctionMonoid~~](#getfunctionmonoid) - - [~~monoidAll~~](#monoidall) - - [~~monoidAny~~](#monoidany) - - [~~monoidProduct~~](#monoidproduct) - - [~~monoidString~~](#monoidstring) - - [~~monoidSum~~](#monoidsum) - - [~~monoidVoid~~](#monoidvoid) - [model](#model) - [Monoid (interface)](#monoid-interface) - [utils](#utils) @@ -64,10 +53,21 @@ Added in v2.0.0 - [reverse](#reverse) - [struct](#struct) - [tuple](#tuple) +- [zone of death](#zone-of-death) - [~~fold~~](#fold) - [~~getDualMonoid~~](#getdualmonoid) + - [~~getEndomorphismMonoid~~](#getendomorphismmonoid) + - [~~getFunctionMonoid~~](#getfunctionmonoid) + - [~~getJoinMonoid~~](#getjoinmonoid) + - [~~getMeetMonoid~~](#getmeetmonoid) - [~~getStructMonoid~~](#getstructmonoid) - [~~getTupleMonoid~~](#gettuplemonoid) + - [~~monoidAll~~](#monoidall) + - [~~monoidAny~~](#monoidany) + - [~~monoidProduct~~](#monoidproduct) + - [~~monoidString~~](#monoidstring) + - [~~monoidSum~~](#monoidsum) + - [~~monoidVoid~~](#monoidvoid) --- @@ -123,130 +123,6 @@ assert.deepStrictEqual(M1.concat(1, 2), 1) Added in v2.10.0 -## ~~getJoinMonoid~~ - -Use [`max`](#max) instead. - -**Signature** - -```ts -export declare const getJoinMonoid: (B: Bounded) => Monoid -``` - -Added in v2.0.0 - -## ~~getMeetMonoid~~ - -Use [`min`](#min) instead. - -**Signature** - -```ts -export declare const getMeetMonoid: (B: Bounded) => Monoid -``` - -Added in v2.0.0 - -# instances - -## ~~getEndomorphismMonoid~~ - -Use [`getEndomorphismMonoid`](./function.ts.html#getendomorphismmonoid) instead. - -**Note**. The execution order in [`getEndomorphismMonoid`](./function.ts.html#getendomorphismmonoid) is reversed. - -**Signature** - -```ts -export declare const getEndomorphismMonoid: () => Monoid> -``` - -Added in v2.0.0 - -## ~~getFunctionMonoid~~ - -Use [`getMonoid`](./function.ts.html#getmonoid) instead. - -**Signature** - -```ts -export declare const getFunctionMonoid: (M: Monoid) => () => Monoid<(a: A) => M> -``` - -Added in v2.0.0 - -## ~~monoidAll~~ - -Use [`MonoidAll`](./boolean.ts.html#monoidall) instead. - -**Signature** - -```ts -export declare const monoidAll: Monoid -``` - -Added in v2.0.0 - -## ~~monoidAny~~ - -Use [`MonoidAny`](./boolean.ts.html#monoidany) instead. - -**Signature** - -```ts -export declare const monoidAny: Monoid -``` - -Added in v2.0.0 - -## ~~monoidProduct~~ - -Use [`MonoidProduct`](./number.ts.html#monoidproduct) instead. - -**Signature** - -```ts -export declare const monoidProduct: Monoid -``` - -Added in v2.0.0 - -## ~~monoidString~~ - -Use [`Monoid`](./string.ts.html#monoid) instead. - -**Signature** - -```ts -export declare const monoidString: Monoid -``` - -Added in v2.0.0 - -## ~~monoidSum~~ - -Use [`MonoidSum`](./number.ts.html#monoidsum) instead. - -**Signature** - -```ts -export declare const monoidSum: Monoid -``` - -Added in v2.0.0 - -## ~~monoidVoid~~ - -Use [`Monoid`](./void.ts.html#monoid) instead. - -**Signature** - -```ts -export declare const monoidVoid: Monoid -``` - -Added in v2.0.0 - # model ## Monoid (interface) @@ -368,6 +244,8 @@ assert.deepStrictEqual(M2.concat(['a', 1, true], ['b', 2, false]), ['ab', 3, fal Added in v2.10.0 +# zone of death + ## ~~fold~~ Use [`concatAll`](#concatall) instead. @@ -392,6 +270,56 @@ export declare const getDualMonoid: (M: Monoid) => Monoid Added in v2.0.0 +## ~~getEndomorphismMonoid~~ + +Use [`getEndomorphismMonoid`](./function.ts.html#getendomorphismmonoid) instead. + +**Note**. The execution order in [`getEndomorphismMonoid`](./function.ts.html#getendomorphismmonoid) is reversed. + +**Signature** + +```ts +export declare const getEndomorphismMonoid: () => Monoid> +``` + +Added in v2.0.0 + +## ~~getFunctionMonoid~~ + +Use [`getMonoid`](./function.ts.html#getmonoid) instead. + +**Signature** + +```ts +export declare const getFunctionMonoid: (M: Monoid) => () => Monoid<(a: A) => M> +``` + +Added in v2.0.0 + +## ~~getJoinMonoid~~ + +Use [`max`](#max) instead. + +**Signature** + +```ts +export declare const getJoinMonoid: (B: Bounded) => Monoid +``` + +Added in v2.0.0 + +## ~~getMeetMonoid~~ + +Use [`min`](#min) instead. + +**Signature** + +```ts +export declare const getMeetMonoid: (B: Bounded) => Monoid +``` + +Added in v2.0.0 + ## ~~getStructMonoid~~ Use [`struct`](#struct) instead. @@ -419,3 +347,75 @@ export declare const getTupleMonoid: []>( ``` Added in v2.0.0 + +## ~~monoidAll~~ + +Use [`MonoidAll`](./boolean.ts.html#monoidall) instead. + +**Signature** + +```ts +export declare const monoidAll: Monoid +``` + +Added in v2.0.0 + +## ~~monoidAny~~ + +Use [`MonoidAny`](./boolean.ts.html#monoidany) instead. + +**Signature** + +```ts +export declare const monoidAny: Monoid +``` + +Added in v2.0.0 + +## ~~monoidProduct~~ + +Use [`MonoidProduct`](./number.ts.html#monoidproduct) instead. + +**Signature** + +```ts +export declare const monoidProduct: Monoid +``` + +Added in v2.0.0 + +## ~~monoidString~~ + +Use [`Monoid`](./string.ts.html#monoid) instead. + +**Signature** + +```ts +export declare const monoidString: Monoid +``` + +Added in v2.0.0 + +## ~~monoidSum~~ + +Use [`MonoidSum`](./number.ts.html#monoidsum) instead. + +**Signature** + +```ts +export declare const monoidSum: Monoid +``` + +Added in v2.0.0 + +## ~~monoidVoid~~ + +Use [`Monoid`](./void.ts.html#monoid) instead. + +**Signature** + +```ts +export declare const monoidVoid: Monoid +``` + +Added in v2.0.0 diff --git a/docs/modules/NonEmptyArray.ts.md b/docs/modules/NonEmptyArray.ts.md index b14216e2a..0fa5830a7 100644 --- a/docs/modules/NonEmptyArray.ts.md +++ b/docs/modules/NonEmptyArray.ts.md @@ -28,8 +28,6 @@ Added in v2.0.0 - [of](#of) - [range](#range) - [replicate](#replicate) - - [~~cons~~](#cons) - - [~~snoc~~](#snoc) - [conversions](#conversions) - [fromArray](#fromarray) - [fromReadonlyNonEmptyArray](#fromreadonlynonemptyarray) @@ -66,7 +64,6 @@ Added in v2.0.0 - [getEq](#geteq) - [getSemigroup](#getsemigroup) - [getShow](#getshow) - - [~~nonEmptyArray~~](#nonemptyarray) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -131,11 +128,15 @@ Added in v2.0.0 - [updateLast](#updatelast) - [zip](#zip) - [zipWith](#zipwith) +- [zone of death](#zone-of-death) + - [~~cons~~](#cons) - [~~filterWithIndex~~](#filterwithindex) - [~~filter~~](#filter) - [~~fold~~](#fold) - [~~groupSort~~](#groupsort) + - [~~nonEmptyArray~~](#nonemptyarray) - [~~prependToAll~~](#prependtoall) + - [~~snoc~~](#snoc) - [~~uncons~~](#uncons) - [~~unsnoc~~](#unsnoc) @@ -220,31 +221,6 @@ assert.deepStrictEqual(pipe(3, replicate('a')), ['a', 'a', 'a']) Added in v2.11.0 -## ~~cons~~ - -Use [`prepend`](./Array.ts.html#prepend) instead. - -**Signature** - -```ts -export declare function cons(head: A): (tail: Array) => NonEmptyArray -export declare function cons(head: A, tail: Array): NonEmptyArray -``` - -Added in v2.0.0 - -## ~~snoc~~ - -Use [`append`](./Array.ts.html#append) instead. - -**Signature** - -```ts -export declare const snoc: (init: A[], end: A) => NonEmptyArray -``` - -Added in v2.0.0 - # conversions ## fromArray @@ -630,25 +606,6 @@ export declare const getShow: (S: Show) => Show> Added in v2.0.0 -## ~~nonEmptyArray~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `NEA.Functor` instead of `NEA.nonEmptyArray` -(where `NEA` is from `import NEA from 'fp-ts/NonEmptyArray'`) - -**Signature** - -```ts -export declare const nonEmptyArray: Monad1<'NonEmptyArray'> & - Comonad1<'NonEmptyArray'> & - TraversableWithIndex1<'NonEmptyArray', number> & - FunctorWithIndex1<'NonEmptyArray', number> & - FoldableWithIndex1<'NonEmptyArray', number> & - Alt1<'NonEmptyArray'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -1453,6 +1410,21 @@ export declare const zipWith: ( Added in v2.5.1 +# zone of death + +## ~~cons~~ + +Use [`prepend`](./Array.ts.html#prepend) instead. + +**Signature** + +```ts +export declare function cons(head: A): (tail: Array) => NonEmptyArray +export declare function cons(head: A, tail: Array): NonEmptyArray +``` + +Added in v2.0.0 + ## ~~filterWithIndex~~ Use [`filterWithIndex`](./Array.ts.html#filterwithindex) instead. @@ -1512,6 +1484,25 @@ export declare function groupSort(O: Ord): { Added in v2.0.0 +## ~~nonEmptyArray~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `NEA.Functor` instead of `NEA.nonEmptyArray` +(where `NEA` is from `import NEA from 'fp-ts/NonEmptyArray'`) + +**Signature** + +```ts +export declare const nonEmptyArray: Monad1<'NonEmptyArray'> & + Comonad1<'NonEmptyArray'> & + TraversableWithIndex1<'NonEmptyArray', number> & + FunctorWithIndex1<'NonEmptyArray', number> & + FoldableWithIndex1<'NonEmptyArray', number> & + Alt1<'NonEmptyArray'> +``` + +Added in v2.0.0 + ## ~~prependToAll~~ Use [`prependAll`](#prependall) instead. @@ -1524,6 +1515,18 @@ export declare const prependToAll: (middle: A) => (as: NonEmptyArray) => N Added in v2.9.0 +## ~~snoc~~ + +Use [`append`](./Array.ts.html#append) instead. + +**Signature** + +```ts +export declare const snoc: (init: A[], end: A) => NonEmptyArray +``` + +Added in v2.0.0 + ## ~~uncons~~ Use [`unprepend`](#unprepend) instead. diff --git a/docs/modules/Option.ts.md b/docs/modules/Option.ts.md index 37cc5cb66..67be6b4fc 100644 --- a/docs/modules/Option.ts.md +++ b/docs/modules/Option.ts.md @@ -129,11 +129,6 @@ Added in v2.0.0 - [getMonoid](#getmonoid) - [getOrd](#getord) - [getShow](#getshow) - - [~~getApplyMonoid~~](#getapplymonoid) - - [~~getApplySemigroup~~](#getapplysemigroup) - - [~~getFirstMonoid~~](#getfirstmonoid) - - [~~getLastMonoid~~](#getlastmonoid) - - [~~option~~](#option) - [interop](#interop) - [tryCatch](#trycatch) - [tryCatchK](#trycatchk) @@ -185,8 +180,14 @@ Added in v2.0.0 - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) - [zero](#zero) +- [zone of death](#zone-of-death) + - [~~getApplyMonoid~~](#getapplymonoid) + - [~~getApplySemigroup~~](#getapplysemigroup) + - [~~getFirstMonoid~~](#getfirstmonoid) + - [~~getLastMonoid~~](#getlastmonoid) - [~~getRefinement~~](#getrefinement) - [~~mapNullable~~](#mapnullable) + - [~~option~~](#option) --- @@ -939,133 +940,6 @@ export declare const getShow: (S: Show) => Show> Added in v2.0.0 -## ~~getApplyMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getApplyMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getApplySemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getApplySemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getFirstMonoid~~ - -Use - -```ts -import { first } from 'fp-ts/Semigroup' -import { getMonoid } from 'fp-ts/Option' - -getMonoid(first()) -``` - -instead. - -Monoid returning the left-most non-`None` value - -| x | y | concat(x, y) | -| ------- | ------- | ------------ | -| none | none | none | -| some(a) | none | some(a) | -| none | some(b) | some(b) | -| some(a) | some(b) | some(a) | - -**Signature** - -```ts -export declare const getFirstMonoid: () => Monoid> -``` - -**Example** - -```ts -import { getFirstMonoid, some, none } from 'fp-ts/Option' - -const M = getFirstMonoid() -assert.deepStrictEqual(M.concat(none, none), none) -assert.deepStrictEqual(M.concat(some(1), none), some(1)) -assert.deepStrictEqual(M.concat(none, some(2)), some(2)) -assert.deepStrictEqual(M.concat(some(1), some(2)), some(1)) -``` - -Added in v2.0.0 - -## ~~getLastMonoid~~ - -Use - -```ts -import { last } from 'fp-ts/Semigroup' -import { getMonoid } from 'fp-ts/Option' - -getMonoid(last()) -``` - -instead. - -Monoid returning the right-most non-`None` value - -| x | y | concat(x, y) | -| ------- | ------- | ------------ | -| none | none | none | -| some(a) | none | some(a) | -| none | some(b) | some(b) | -| some(a) | some(b) | some(b) | - -**Signature** - -```ts -export declare const getLastMonoid: () => Monoid> -``` - -**Example** - -```ts -import { getLastMonoid, some, none } from 'fp-ts/Option' - -const M = getLastMonoid() -assert.deepStrictEqual(M.concat(none, none), none) -assert.deepStrictEqual(M.concat(some(1), none), some(1)) -assert.deepStrictEqual(M.concat(none, some(2)), some(2)) -assert.deepStrictEqual(M.concat(some(1), some(2)), some(2)) -``` - -Added in v2.0.0 - -## ~~option~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `O.Functor` instead of `O.option` -(where `O` is from `import O from 'fp-ts/Option'`) - -**Signature** - -```ts -export declare const option: Monad1<'Option'> & - Foldable1<'Option'> & - Alternative1<'Option'> & - Extend1<'Option'> & - Witherable1<'Option'> & - MonadThrow1<'Option'> -``` - -Added in v2.0.0 - # interop ## tryCatch @@ -1736,6 +1610,116 @@ export declare const zero: () => Option Added in v2.7.0 +# zone of death + +## ~~getApplyMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getApplyMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getApplySemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getApplySemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getFirstMonoid~~ + +Use + +```ts +import { first } from 'fp-ts/Semigroup' +import { getMonoid } from 'fp-ts/Option' + +getMonoid(first()) +``` + +instead. + +Monoid returning the left-most non-`None` value + +| x | y | concat(x, y) | +| ------- | ------- | ------------ | +| none | none | none | +| some(a) | none | some(a) | +| none | some(b) | some(b) | +| some(a) | some(b) | some(a) | + +**Signature** + +```ts +export declare const getFirstMonoid: () => Monoid> +``` + +**Example** + +```ts +import { getFirstMonoid, some, none } from 'fp-ts/Option' + +const M = getFirstMonoid() +assert.deepStrictEqual(M.concat(none, none), none) +assert.deepStrictEqual(M.concat(some(1), none), some(1)) +assert.deepStrictEqual(M.concat(none, some(2)), some(2)) +assert.deepStrictEqual(M.concat(some(1), some(2)), some(1)) +``` + +Added in v2.0.0 + +## ~~getLastMonoid~~ + +Use + +```ts +import { last } from 'fp-ts/Semigroup' +import { getMonoid } from 'fp-ts/Option' + +getMonoid(last()) +``` + +instead. + +Monoid returning the right-most non-`None` value + +| x | y | concat(x, y) | +| ------- | ------- | ------------ | +| none | none | none | +| some(a) | none | some(a) | +| none | some(b) | some(b) | +| some(a) | some(b) | some(b) | + +**Signature** + +```ts +export declare const getLastMonoid: () => Monoid> +``` + +**Example** + +```ts +import { getLastMonoid, some, none } from 'fp-ts/Option' + +const M = getLastMonoid() +assert.deepStrictEqual(M.concat(none, none), none) +assert.deepStrictEqual(M.concat(some(1), none), some(1)) +assert.deepStrictEqual(M.concat(none, some(2)), some(2)) +assert.deepStrictEqual(M.concat(some(1), some(2)), some(2)) +``` + +Added in v2.0.0 + ## ~~getRefinement~~ Use `Refinement` module instead. @@ -1759,3 +1743,22 @@ export declare const mapNullable: (f: (a: A) => B | null | undefined) => ( ``` Added in v2.0.0 + +## ~~option~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `O.Functor` instead of `O.option` +(where `O` is from `import O from 'fp-ts/Option'`) + +**Signature** + +```ts +export declare const option: Monad1<'Option'> & + Foldable1<'Option'> & + Alternative1<'Option'> & + Extend1<'Option'> & + Witherable1<'Option'> & + MonadThrow1<'Option'> +``` + +Added in v2.0.0 diff --git a/docs/modules/OptionT.ts.md b/docs/modules/OptionT.ts.md index fd5b34bb5..418e8898b 100644 --- a/docs/modules/OptionT.ts.md +++ b/docs/modules/OptionT.ts.md @@ -14,10 +14,6 @@ Added in v2.0.0 - [lifting](#lifting) - [fromPredicate](#frompredicate) -- [model](#model) - - [~~OptionT1~~ (type alias)](#optiont1-type-alias) - - [~~OptionT2~~ (type alias)](#optiont2-type-alias) - - [~~OptionT~~ (interface)](#optiont-interface) - [pattern matching](#pattern-matching) - [match](#match) - [utils](#utils) @@ -36,10 +32,14 @@ Added in v2.0.0 - [matchE](#matche) - [some](#some) - [zero](#zero) +- [zone of death](#zone-of-death) - [~~OptionM1~~ (interface)](#optionm1-interface) - [~~OptionM2C~~ (interface)](#optionm2c-interface) - [~~OptionM2~~ (interface)](#optionm2-interface) - [~~OptionM~~ (interface)](#optionm-interface) + - [~~OptionT1~~ (type alias)](#optiont1-type-alias) + - [~~OptionT2~~ (type alias)](#optiont2-type-alias) + - [~~OptionT~~ (interface)](#optiont-interface) - [~~getOptionM~~](#getoptionm) --- @@ -102,38 +102,6 @@ export declare function fromPredicate(F: Pointed): { Added in v2.10.0 -# model - -## ~~OptionT1~~ (type alias) - -**Signature** - -```ts -export type OptionT1 = Kind> -``` - -Added in v2.0.0 - -## ~~OptionT2~~ (type alias) - -**Signature** - -```ts -export type OptionT2 = Kind2> -``` - -Added in v2.0.0 - -## ~~OptionT~~ (interface) - -**Signature** - -```ts -export interface OptionT extends HKT> {} -``` - -Added in v2.0.0 - # pattern matching ## match @@ -618,6 +586,8 @@ export declare function zero(F: Pointed): () => HKT> Added in v2.10.0 +# zone of death + ## ~~OptionM1~~ (interface) **Signature** @@ -694,6 +664,36 @@ export interface OptionM extends ApplicativeCompositionHKT1 { Added in v2.0.0 +## ~~OptionT1~~ (type alias) + +**Signature** + +```ts +export type OptionT1 = Kind> +``` + +Added in v2.0.0 + +## ~~OptionT2~~ (type alias) + +**Signature** + +```ts +export type OptionT2 = Kind2> +``` + +Added in v2.0.0 + +## ~~OptionT~~ (interface) + +**Signature** + +```ts +export interface OptionT extends HKT> {} +``` + +Added in v2.0.0 + ## ~~getOptionM~~ **Signature** diff --git a/docs/modules/Ord.ts.md b/docs/modules/Ord.ts.md index 7c75c94bf..031d7e322 100644 --- a/docs/modules/Ord.ts.md +++ b/docs/modules/Ord.ts.md @@ -30,11 +30,6 @@ Added in v2.0.0 - [Contravariant](#contravariant-1) - [getMonoid](#getmonoid) - [getSemigroup](#getsemigroup) - - [~~ordBoolean~~](#ordboolean) - - [~~ordDate~~](#orddate) - - [~~ordNumber~~](#ordnumber) - - [~~ordString~~](#ordstring) - - [~~ord~~](#ord) - [model](#model) - [Ord (interface)](#ord-interface) - [type lambdas](#type-lambdas) @@ -53,8 +48,14 @@ Added in v2.0.0 - [reverse](#reverse) - [trivial](#trivial) - [tuple](#tuple) +- [zone of death](#zone-of-death) - [~~getDualOrd~~](#getdualord) - [~~getTupleOrd~~](#gettupleord) + - [~~ordBoolean~~](#ordboolean) + - [~~ordDate~~](#orddate) + - [~~ordNumber~~](#ordnumber) + - [~~ordString~~](#ordstring) + - [~~ord~~](#ord) --- @@ -281,66 +282,6 @@ assert.deepStrictEqual( Added in v2.0.0 -## ~~ordBoolean~~ - -Use [`Ord`](./boolean.ts.html#ord) instead. - -**Signature** - -```ts -export declare const ordBoolean: Ord -``` - -Added in v2.0.0 - -## ~~ordDate~~ - -Use [`Ord`](./Date.ts.html#ord) instead. - -**Signature** - -```ts -export declare const ordDate: Ord -``` - -Added in v2.0.0 - -## ~~ordNumber~~ - -Use [`Ord`](./number.ts.html#ord) instead. - -**Signature** - -```ts -export declare const ordNumber: Ord -``` - -Added in v2.0.0 - -## ~~ordString~~ - -Use [`Ord`](./string.ts.html#ord) instead. - -**Signature** - -```ts -export declare const ordString: Ord -``` - -Added in v2.0.0 - -## ~~ord~~ - -Use [`Contravariant`](#contravariant) instead. - -**Signature** - -```ts -export declare const ord: Contravariant1<'Ord'> -``` - -Added in v2.0.0 - # model ## Ord (interface) @@ -531,6 +472,8 @@ assert.strictEqual(O.compare(['a', 1, true], ['a', 1, false]), 1) Added in v2.10.0 +# zone of death + ## ~~getDualOrd~~ Use [`reverse`](#reverse) instead. @@ -556,3 +499,63 @@ export declare const getTupleOrd: []>( ``` Added in v2.0.0 + +## ~~ordBoolean~~ + +Use [`Ord`](./boolean.ts.html#ord) instead. + +**Signature** + +```ts +export declare const ordBoolean: Ord +``` + +Added in v2.0.0 + +## ~~ordDate~~ + +Use [`Ord`](./Date.ts.html#ord) instead. + +**Signature** + +```ts +export declare const ordDate: Ord +``` + +Added in v2.0.0 + +## ~~ordNumber~~ + +Use [`Ord`](./number.ts.html#ord) instead. + +**Signature** + +```ts +export declare const ordNumber: Ord +``` + +Added in v2.0.0 + +## ~~ordString~~ + +Use [`Ord`](./string.ts.html#ord) instead. + +**Signature** + +```ts +export declare const ordString: Ord +``` + +Added in v2.0.0 + +## ~~ord~~ + +Use [`Contravariant`](#contravariant) instead. + +**Signature** + +```ts +export declare const ord: Contravariant1<'Ord'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Ordering.ts.md b/docs/modules/Ordering.ts.md index 474b69fd3..31aeb7267 100644 --- a/docs/modules/Ordering.ts.md +++ b/docs/modules/Ordering.ts.md @@ -16,9 +16,6 @@ Added in v2.0.0 - [Eq](#eq) - [Monoid](#monoid) - [Semigroup](#semigroup) - - [~~eqOrdering~~](#eqordering) - - [~~monoidOrdering~~](#monoidordering) - - [~~semigroupOrdering~~](#semigroupordering) - [model](#model) - [Ordering (type alias)](#ordering-type-alias) - [pattern matching](#pattern-matching) @@ -27,7 +24,11 @@ Added in v2.0.0 - [utils](#utils) - [reverse](#reverse) - [sign](#sign) +- [zone of death](#zone-of-death) + - [~~eqOrdering~~](#eqordering) - [~~invert~~](#invert) + - [~~monoidOrdering~~](#monoidordering) + - [~~semigroupOrdering~~](#semigroupordering) --- @@ -63,42 +64,6 @@ export declare const Semigroup: S.Semigroup Added in v2.10.0 -## ~~eqOrdering~~ - -Use [`Eq`](#eq) instead - -**Signature** - -```ts -export declare const eqOrdering: E.Eq -``` - -Added in v2.0.0 - -## ~~monoidOrdering~~ - -Use [`Monoid`](#monoid) instead - -**Signature** - -```ts -export declare const monoidOrdering: M.Monoid -``` - -Added in v2.4.0 - -## ~~semigroupOrdering~~ - -Use [`Semigroup`](#semigroup) instead - -**Signature** - -```ts -export declare const semigroupOrdering: S.Semigroup -``` - -Added in v2.0.0 - # model ## Ordering (type alias) @@ -163,6 +128,20 @@ export declare const sign: (n: number) => Ordering Added in v2.0.0 +# zone of death + +## ~~eqOrdering~~ + +Use [`Eq`](#eq) instead + +**Signature** + +```ts +export declare const eqOrdering: E.Eq +``` + +Added in v2.0.0 + ## ~~invert~~ Use [`reverse`](#reverse) instead. @@ -174,3 +153,27 @@ export declare const invert: (o: Ordering) => Ordering ``` Added in v2.0.0 + +## ~~monoidOrdering~~ + +Use [`Monoid`](#monoid) instead + +**Signature** + +```ts +export declare const monoidOrdering: M.Monoid +``` + +Added in v2.4.0 + +## ~~semigroupOrdering~~ + +Use [`Semigroup`](#semigroup) instead + +**Signature** + +```ts +export declare const semigroupOrdering: S.Semigroup +``` + +Added in v2.0.0 diff --git a/docs/modules/Reader.ts.md b/docs/modules/Reader.ts.md index 28f1c809f..08ac78c04 100644 --- a/docs/modules/Reader.ts.md +++ b/docs/modules/Reader.ts.md @@ -87,9 +87,6 @@ Added in v2.0.0 - [Pointed](#pointed) - [Profunctor](#profunctor-1) - [Strong](#strong-1) - - [~~getMonoid~~](#getmonoid) - - [~~getSemigroup~~](#getsemigroup) - - [~~reader~~](#reader) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -125,6 +122,10 @@ Added in v2.0.0 - [traverseArrayWithIndex](#traversearraywithindex) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) + - [~~getMonoid~~](#getmonoid) + - [~~getSemigroup~~](#getsemigroup) + - [~~reader~~](#reader) --- @@ -404,48 +405,6 @@ export declare const Strong: Strong2<'Reader'> Added in v2.8.3 -## ~~getMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~reader~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `R.Functor` instead of `R.reader` -(where `R` is from `import R from 'fp-ts/Reader'`) - -**Signature** - -```ts -export declare const reader: Monad2<'Reader'> & - Profunctor2<'Reader'> & - Category2<'Reader'> & - Strong2<'Reader'> & - Choice2<'Reader'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -842,3 +801,47 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( ``` Added in v2.11.0 + +# zone of death + +## ~~getMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~reader~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `R.Functor` instead of `R.reader` +(where `R` is from `import R from 'fp-ts/Reader'`) + +**Signature** + +```ts +export declare const reader: Monad2<'Reader'> & + Profunctor2<'Reader'> & + Category2<'Reader'> & + Strong2<'Reader'> & + Choice2<'Reader'> +``` + +Added in v2.0.0 diff --git a/docs/modules/ReaderEither.ts.md b/docs/modules/ReaderEither.ts.md index a4fa0e3a7..6edda9351 100644 --- a/docs/modules/ReaderEither.ts.md +++ b/docs/modules/ReaderEither.ts.md @@ -67,11 +67,6 @@ Added in v2.0.0 - [Monad](#monad) - [MonadThrow](#monadthrow-1) - [Pointed](#pointed) - - [~~getApplyMonoid~~](#getapplymonoid) - - [~~getApplySemigroup~~](#getapplysemigroup) - - [~~getReaderValidation~~](#getreadervalidation) - - [~~getSemigroup~~](#getsemigroup) - - [~~readerEither~~](#readereither) - [lifting](#lifting) - [fromEitherK](#fromeitherk) - [fromOptionK](#fromoptionk) @@ -126,6 +121,12 @@ Added in v2.0.0 - [traverseArrayWithIndex](#traversearraywithindex) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) + - [~~getApplyMonoid~~](#getapplymonoid) + - [~~getApplySemigroup~~](#getapplysemigroup) + - [~~getReaderValidation~~](#getreadervalidation) + - [~~getSemigroup~~](#getsemigroup) + - [~~readerEither~~](#readereither) --- @@ -723,73 +724,6 @@ export declare const Pointed: Pointed3<'ReaderEither'> Added in v2.10.0 -## ~~getApplyMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getApplyMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getApplySemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getApplySemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getReaderValidation~~ - -Use [`getApplicativeReaderValidation`](#getapplicativereadervalidation) and [`getAltReaderValidation`](#getaltreadervalidation) instead. - -**Signature** - -```ts -export declare function getReaderValidation( - SE: Semigroup -): Monad3C & Bifunctor3 & Alt3C & MonadThrow3C -``` - -Added in v2.3.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~readerEither~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RE.Functor` instead of `RE.readerEither` -(where `R` is from `import R from 'fp-ts/ReaderEither'`) - -**Signature** - -```ts -export declare const readerEither: Monad3<'ReaderEither'> & - Bifunctor3<'ReaderEither'> & - Alt3<'ReaderEither'> & - MonadThrow3<'ReaderEither'> -``` - -Added in v2.0.0 - # lifting ## fromEitherK @@ -1421,3 +1355,72 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( ``` Added in v2.11.0 + +# zone of death + +## ~~getApplyMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getApplyMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getApplySemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getApplySemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getReaderValidation~~ + +Use [`getApplicativeReaderValidation`](#getapplicativereadervalidation) and [`getAltReaderValidation`](#getaltreadervalidation) instead. + +**Signature** + +```ts +export declare function getReaderValidation( + SE: Semigroup +): Monad3C & Bifunctor3 & Alt3C & MonadThrow3C +``` + +Added in v2.3.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~readerEither~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RE.Functor` instead of `RE.readerEither` +(where `R` is from `import R from 'fp-ts/ReaderEither'`) + +**Signature** + +```ts +export declare const readerEither: Monad3<'ReaderEither'> & + Bifunctor3<'ReaderEither'> & + Alt3<'ReaderEither'> & + MonadThrow3<'ReaderEither'> +``` + +Added in v2.0.0 diff --git a/docs/modules/ReaderT.ts.md b/docs/modules/ReaderT.ts.md index 8a2f1759a..5fc8caffa 100644 --- a/docs/modules/ReaderT.ts.md +++ b/docs/modules/ReaderT.ts.md @@ -18,22 +18,22 @@ Added in v2.0.0 - [constructors](#constructors) - [fromNaturalTransformation](#fromnaturaltransformation) -- [model](#model) - - [~~ReaderT1~~ (interface)](#readert1-interface) - - [~~ReaderT2~~ (interface)](#readert2-interface) - - [~~ReaderT~~ (interface)](#readert-interface) - [utils](#utils) - [ap](#ap) - [chain](#chain) - [fromReader](#fromreader) - [map](#map) - [of](#of) +- [zone of death](#zone-of-death) - [~~ReaderM1~~ (interface)](#readerm1-interface) - [~~ReaderM2C~~ (interface)](#readerm2c-interface) - [~~ReaderM2~~ (interface)](#readerm2-interface) - [~~ReaderM3~~ (interface)](#readerm3-interface) - [~~ReaderM~~ (interface)](#readerm-interface) + - [~~ReaderT1~~ (interface)](#readert1-interface) + - [~~ReaderT2~~ (interface)](#readert2-interface) - [~~ReaderT3~~ (interface)](#readert3-interface) + - [~~ReaderT~~ (interface)](#readert-interface) - [~~getReaderM~~](#getreaderm) --- @@ -67,44 +67,6 @@ export declare function fromNaturalTransformation( Added in v2.11.0 -# model - -## ~~ReaderT1~~ (interface) - -**Signature** - -```ts -export interface ReaderT1 { - (r: R): Kind -} -``` - -Added in v2.0.0 - -## ~~ReaderT2~~ (interface) - -**Signature** - -```ts -export interface ReaderT2 { - (r: R): Kind2 -} -``` - -Added in v2.0.0 - -## ~~ReaderT~~ (interface) - -**Signature** - -```ts -export interface ReaderT { - (r: R): HKT -} -``` - -Added in v2.0.0 - # utils ## ap @@ -259,6 +221,8 @@ export declare function of(F: Pointed): (a: A) => Reader { Added in v2.0.0 +## ~~ReaderT1~~ (interface) + +**Signature** + +```ts +export interface ReaderT1 { + (r: R): Kind +} +``` + +Added in v2.0.0 + +## ~~ReaderT2~~ (interface) + +**Signature** + +```ts +export interface ReaderT2 { + (r: R): Kind2 +} +``` + +Added in v2.0.0 + ## ~~ReaderT3~~ (interface) **Signature** @@ -377,6 +365,18 @@ export interface ReaderT3 { Added in v2.0.0 +## ~~ReaderT~~ (interface) + +**Signature** + +```ts +export interface ReaderT { + (r: R): HKT +} +``` + +Added in v2.0.0 + ## ~~getReaderM~~ **Signature** diff --git a/docs/modules/ReaderTask.ts.md b/docs/modules/ReaderTask.ts.md index e95933ebe..5b513b123 100644 --- a/docs/modules/ReaderTask.ts.md +++ b/docs/modules/ReaderTask.ts.md @@ -45,10 +45,6 @@ Added in v2.3.0 - [MonadIO](#monadio) - [MonadTask](#monadtask) - [Pointed](#pointed) - - [~~getMonoid~~](#getmonoid) - - [~~getSemigroup~~](#getsemigroup) - - [~~readerTaskSeq~~](#readertaskseq) - - [~~readerTask~~](#readertask) - [lifting](#lifting) - [fromIOK](#fromiok) - [fromReaderIOK](#fromreaderiok) @@ -99,6 +95,11 @@ Added in v2.3.0 - [traverseReadonlyNonEmptyArrayWithIndexSeq](#traversereadonlynonemptyarraywithindexseq) - [traverseSeqArray](#traverseseqarray) - [traverseSeqArrayWithIndex](#traverseseqarraywithindex) +- [zone of death](#zone-of-death) + - [~~getMonoid~~](#getmonoid) + - [~~getSemigroup~~](#getsemigroup) + - [~~readerTaskSeq~~](#readertaskseq) + - [~~readerTask~~](#readertask) - [~~run~~](#run) - [~~sequenceSeqArray~~](#sequenceseqarray) @@ -433,58 +434,6 @@ export declare const Pointed: Pointed2<'ReaderTask'> Added in v2.10.0 -## ~~getMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.3.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.3.0 - -## ~~readerTaskSeq~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readerTaskSeq` -(where `RT` is from `import RT from 'fp-ts/ReaderTask'`) - -**Signature** - -```ts -export declare const readerTaskSeq: MonadTask2<'ReaderTask'> -``` - -Added in v2.3.0 - -## ~~readerTask~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readerTask` -(where `RT` is from `import RT from 'fp-ts/ReaderTask'`) - -**Signature** - -```ts -export declare const readerTask: MonadTask2<'ReaderTask'> -``` - -Added in v2.3.0 - # lifting ## fromIOK @@ -1028,6 +977,60 @@ export declare const traverseSeqArrayWithIndex: ( Added in v2.10.0 +# zone of death + +## ~~getMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.3.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.3.0 + +## ~~readerTaskSeq~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readerTaskSeq` +(where `RT` is from `import RT from 'fp-ts/ReaderTask'`) + +**Signature** + +```ts +export declare const readerTaskSeq: MonadTask2<'ReaderTask'> +``` + +Added in v2.3.0 + +## ~~readerTask~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readerTask` +(where `RT` is from `import RT from 'fp-ts/ReaderTask'`) + +**Signature** + +```ts +export declare const readerTask: MonadTask2<'ReaderTask'> +``` + +Added in v2.3.0 + ## ~~run~~ **Signature** diff --git a/docs/modules/ReaderTaskEither.ts.md b/docs/modules/ReaderTaskEither.ts.md index f050848d7..b6532bff2 100644 --- a/docs/modules/ReaderTaskEither.ts.md +++ b/docs/modules/ReaderTaskEither.ts.md @@ -87,12 +87,7 @@ Added in v2.0.0 - [MonadTask](#monadtask) - [MonadThrow](#monadthrow-1) - [Pointed](#pointed) - - [~~getApplyMonoid~~](#getapplymonoid) - - [~~getApplySemigroup~~](#getapplysemigroup) - [~~getReaderTaskValidation~~](#getreadertaskvalidation) - - [~~getSemigroup~~](#getsemigroup) - - [~~readerTaskEitherSeq~~](#readertaskeitherseq) - - [~~readerTaskEither~~](#readertaskeither) - [lifting](#lifting) - [fromEitherK](#fromeitherk) - [fromIOEitherK](#fromioeitherk) @@ -185,6 +180,12 @@ Added in v2.0.0 - [traverseReadonlyNonEmptyArrayWithIndexSeq](#traversereadonlynonemptyarraywithindexseq) - [traverseSeqArray](#traverseseqarray) - [traverseSeqArrayWithIndex](#traverseseqarraywithindex) +- [zone of death](#zone-of-death) + - [~~getApplyMonoid~~](#getapplymonoid) + - [~~getApplySemigroup~~](#getapplysemigroup) + - [~~getSemigroup~~](#getsemigroup) + - [~~readerTaskEitherSeq~~](#readertaskeitherseq) + - [~~readerTaskEither~~](#readertaskeither) - [~~run~~](#run) --- @@ -997,33 +998,6 @@ export declare const Pointed: Pointed3<'ReaderTaskEither'> Added in v2.10.0 -## ~~getApplyMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getApplyMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getApplySemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values -are concatenated using the provided `Semigroup` - -**Signature** - -```ts -export declare const getApplySemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - ## ~~getReaderTaskValidation~~ Use [`getApplicativeReaderTaskValidation`](#getapplicativereadertaskvalidation) and [`getAltReaderTaskValidation`](#getaltreadertaskvalidation) instead. @@ -1038,54 +1012,6 @@ export declare function getReaderTaskValidation( Added in v2.3.0 -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~readerTaskEitherSeq~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RTE.Functor` instead of `RTE.readerTaskEitherSeq` -(where `RTE` is from `import RTE from 'fp-ts/ReaderTaskEither'`) - -**Signature** - -```ts -export declare const readerTaskEitherSeq: Monad3<'ReaderTaskEither'> & - Bifunctor3<'ReaderTaskEither'> & - Alt3<'ReaderTaskEither'> & - MonadTask3<'ReaderTaskEither'> & - MonadThrow3<'ReaderTaskEither'> -``` - -Added in v2.0.0 - -## ~~readerTaskEither~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RTE.Functor` instead of `RTE.readerTaskEither` -(where `RTE` is from `import RTE from 'fp-ts/ReaderTaskEither'`) - -**Signature** - -```ts -export declare const readerTaskEither: Monad3<'ReaderTaskEither'> & - Bifunctor3<'ReaderTaskEither'> & - Alt3<'ReaderTaskEither'> & - MonadTask3<'ReaderTaskEither'> & - MonadThrow3<'ReaderTaskEither'> -``` - -Added in v2.0.0 - # lifting ## fromEitherK @@ -2239,6 +2165,83 @@ export declare const traverseSeqArrayWithIndex: ( Added in v2.9.0 +# zone of death + +## ~~getApplyMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getApplyMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getApplySemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values +are concatenated using the provided `Semigroup` + +**Signature** + +```ts +export declare const getApplySemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~readerTaskEitherSeq~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RTE.Functor` instead of `RTE.readerTaskEitherSeq` +(where `RTE` is from `import RTE from 'fp-ts/ReaderTaskEither'`) + +**Signature** + +```ts +export declare const readerTaskEitherSeq: Monad3<'ReaderTaskEither'> & + Bifunctor3<'ReaderTaskEither'> & + Alt3<'ReaderTaskEither'> & + MonadTask3<'ReaderTaskEither'> & + MonadThrow3<'ReaderTaskEither'> +``` + +Added in v2.0.0 + +## ~~readerTaskEither~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RTE.Functor` instead of `RTE.readerTaskEither` +(where `RTE` is from `import RTE from 'fp-ts/ReaderTaskEither'`) + +**Signature** + +```ts +export declare const readerTaskEither: Monad3<'ReaderTaskEither'> & + Bifunctor3<'ReaderTaskEither'> & + Alt3<'ReaderTaskEither'> & + MonadTask3<'ReaderTaskEither'> & + MonadThrow3<'ReaderTaskEither'> +``` + +Added in v2.0.0 + ## ~~run~~ **Signature** diff --git a/docs/modules/ReadonlyArray.ts.md b/docs/modules/ReadonlyArray.ts.md index f8c44bd19..f91cf5835 100644 --- a/docs/modules/ReadonlyArray.ts.md +++ b/docs/modules/ReadonlyArray.ts.md @@ -16,9 +16,6 @@ Added in v2.5.0 - [makeBy](#makeby) - [of](#of) - [replicate](#replicate) - - [~~cons~~](#cons) - - [~~range~~](#range) - - [~~snoc~~](#snoc) - [conversions](#conversions) - [fromArray](#fromarray) - [fromEither](#fromeither) @@ -87,7 +84,6 @@ Added in v2.5.0 - [getShow](#getshow) - [getUnionMonoid](#getunionmonoid) - [getUnionSemigroup](#getunionsemigroup) - - [~~readonlyArray~~](#readonlyarray) - [lifting](#lifting) - [fromEitherK](#fromeitherk) - [fromOptionK](#fromoptionk) @@ -192,7 +188,12 @@ Added in v2.5.0 - [zero](#zero) - [zip](#zip) - [zipWith](#zipwith) +- [zone of death](#zone-of-death) + - [~~cons~~](#cons) - [~~prependToAll~~](#prependtoall) + - [~~range~~](#range) + - [~~readonlyArray~~](#readonlyarray) + - [~~snoc~~](#snoc) --- @@ -253,42 +254,6 @@ assert.deepStrictEqual(replicate(3, 'a'), ['a', 'a', 'a']) Added in v2.5.0 -## ~~cons~~ - -Use [`prepend`](#prepend) instead. - -**Signature** - -```ts -export declare const cons: typeof RNEA.cons -``` - -Added in v2.5.0 - -## ~~range~~ - -Use `ReadonlyNonEmptyArray` module instead. - -**Signature** - -```ts -export declare const range: (start: number, end: number) => RNEA.ReadonlyNonEmptyArray -``` - -Added in v2.5.0 - -## ~~snoc~~ - -Use [`append`](#append) instead. - -**Signature** - -```ts -export declare const snoc: (init: readonly A[], end: A) => RNEA.ReadonlyNonEmptyArray -``` - -Added in v2.5.0 - # conversions ## fromArray @@ -1038,28 +1003,6 @@ export declare const getUnionSemigroup: (E: Eq) => Semigroup Added in v2.11.0 -## ~~readonlyArray~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RA.Functor` instead of `RA.readonlyArray` -(where `RA` is from `import RA from 'fp-ts/ReadonlyArray'`) - -**Signature** - -```ts -export declare const readonlyArray: FunctorWithIndex1<'ReadonlyArray', number> & - Monad1<'ReadonlyArray'> & - Unfoldable1<'ReadonlyArray'> & - Alternative1<'ReadonlyArray'> & - Extend1<'ReadonlyArray'> & - FilterableWithIndex1<'ReadonlyArray', number> & - FoldableWithIndex1<'ReadonlyArray', number> & - TraversableWithIndex1<'ReadonlyArray', number> & - Witherable1<'ReadonlyArray'> -``` - -Added in v2.5.0 - # lifting ## fromEitherK @@ -2977,6 +2920,20 @@ assert.deepStrictEqual( Added in v2.5.0 +# zone of death + +## ~~cons~~ + +Use [`prepend`](#prepend) instead. + +**Signature** + +```ts +export declare const cons: typeof RNEA.cons +``` + +Added in v2.5.0 + ## ~~prependToAll~~ Use [`prependAll`](#prependall) instead. @@ -2988,3 +2945,49 @@ export declare const prependToAll: (middle: A) => (as: readonly A[]) => reado ``` Added in v2.9.0 + +## ~~range~~ + +Use `ReadonlyNonEmptyArray` module instead. + +**Signature** + +```ts +export declare const range: (start: number, end: number) => RNEA.ReadonlyNonEmptyArray +``` + +Added in v2.5.0 + +## ~~readonlyArray~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RA.Functor` instead of `RA.readonlyArray` +(where `RA` is from `import RA from 'fp-ts/ReadonlyArray'`) + +**Signature** + +```ts +export declare const readonlyArray: FunctorWithIndex1<'ReadonlyArray', number> & + Monad1<'ReadonlyArray'> & + Unfoldable1<'ReadonlyArray'> & + Alternative1<'ReadonlyArray'> & + Extend1<'ReadonlyArray'> & + FilterableWithIndex1<'ReadonlyArray', number> & + FoldableWithIndex1<'ReadonlyArray', number> & + TraversableWithIndex1<'ReadonlyArray', number> & + Witherable1<'ReadonlyArray'> +``` + +Added in v2.5.0 + +## ~~snoc~~ + +Use [`append`](#append) instead. + +**Signature** + +```ts +export declare const snoc: (init: readonly A[], end: A) => RNEA.ReadonlyNonEmptyArray +``` + +Added in v2.5.0 diff --git a/docs/modules/ReadonlyMap.ts.md b/docs/modules/ReadonlyMap.ts.md index 8eff6029f..1ee76792e 100644 --- a/docs/modules/ReadonlyMap.ts.md +++ b/docs/modules/ReadonlyMap.ts.md @@ -52,7 +52,6 @@ Added in v2.5.0 - [getUnionMonoid](#getunionmonoid) - [getUnionSemigroup](#getunionsemigroup) - [getWitherable](#getwitherable) - - [~~readonlyMap~~](#readonlymap) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -84,7 +83,9 @@ Added in v2.5.0 - [updateAt](#updateat) - [upsertAt](#upsertat) - [values](#values) +- [zone of death](#zone-of-death) - [~~insertAt~~](#insertat) + - [~~readonlyMap~~](#readonlymap) --- @@ -507,20 +508,6 @@ export declare function getWitherable(O: Ord): Witherable2C & Trav Added in v2.5.0 -## ~~readonlyMap~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RM.Functor` instead of `RM.readonlyMap` -(where `RM` is from `import RM from 'fp-ts/ReadonlyMap'`) - -**Signature** - -```ts -export declare const readonlyMap: Filterable2<'ReadonlyMap'> -``` - -Added in v2.5.0 - # mapping ## flap @@ -885,6 +872,8 @@ export declare const values: (O: Ord) => (m: ReadonlyMap) => read Added in v2.5.0 +# zone of death + ## ~~insertAt~~ Use [`upsertAt`](#upsertat) instead. @@ -896,3 +885,17 @@ export declare const insertAt: (E: Eq) => (k: K, a: A) => (m: ReadonlyM ``` Added in v2.5.0 + +## ~~readonlyMap~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RM.Functor` instead of `RM.readonlyMap` +(where `RM` is from `import RM from 'fp-ts/ReadonlyMap'`) + +**Signature** + +```ts +export declare const readonlyMap: Filterable2<'ReadonlyMap'> +``` + +Added in v2.5.0 diff --git a/docs/modules/ReadonlyNonEmptyArray.ts.md b/docs/modules/ReadonlyNonEmptyArray.ts.md index 5e02cf5b1..66d7e9a86 100644 --- a/docs/modules/ReadonlyNonEmptyArray.ts.md +++ b/docs/modules/ReadonlyNonEmptyArray.ts.md @@ -30,8 +30,6 @@ Added in v2.5.0 - [of](#of) - [range](#range) - [replicate](#replicate) - - [~~cons~~](#cons) - - [~~snoc~~](#snoc) - [conversions](#conversions) - [fromArray](#fromarray) - [fromReadonlyArray](#fromreadonlyarray) @@ -68,7 +66,6 @@ Added in v2.5.0 - [getEq](#geteq) - [getSemigroup](#getsemigroup) - [getShow](#getshow) - - [~~readonlyNonEmptyArray~~](#readonlynonemptyarray) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -130,12 +127,16 @@ Added in v2.5.0 - [updateLast](#updatelast) - [zip](#zip) - [zipWith](#zipwith) +- [zone of death](#zone-of-death) + - [~~cons~~](#cons) - [~~filterWithIndex~~](#filterwithindex) - [~~filter~~](#filter) - [~~fold~~](#fold) - [~~groupSort~~](#groupsort) - [~~insertAt~~](#insertat) - [~~prependToAll~~](#prependtoall) + - [~~readonlyNonEmptyArray~~](#readonlynonemptyarray) + - [~~snoc~~](#snoc) - [~~uncons~~](#uncons) - [~~unsnoc~~](#unsnoc) @@ -232,31 +233,6 @@ assert.deepStrictEqual(pipe(3, replicate('a')), ['a', 'a', 'a']) Added in v2.11.0 -## ~~cons~~ - -Use [`prepend`](./ReadonlyArray.ts.html#prepend) instead. - -**Signature** - -```ts -export declare function cons(head: A): (tail: ReadonlyArray) => ReadonlyNonEmptyArray -export declare function cons(head: A, tail: ReadonlyArray): ReadonlyNonEmptyArray -``` - -Added in v2.5.0 - -## ~~snoc~~ - -Use [`append`](./ReadonlyArray.ts.html#append) instead. - -**Signature** - -```ts -export declare const snoc: (init: readonly A[], end: A) => ReadonlyNonEmptyArray -``` - -Added in v2.5.0 - # conversions ## fromArray @@ -664,25 +640,6 @@ export declare const getShow: (S: Show) => Show> Added in v2.5.0 -## ~~readonlyNonEmptyArray~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RNEA.Functor` instead of `RNEA.readonlyNonEmptyArray` -(where `RNEA` is from `import RNEA from 'fp-ts/ReadonlyNonEmptyArray'`) - -**Signature** - -```ts -export declare const readonlyNonEmptyArray: Monad1<'ReadonlyNonEmptyArray'> & - Comonad1<'ReadonlyNonEmptyArray'> & - TraversableWithIndex1<'ReadonlyNonEmptyArray', number> & - FunctorWithIndex1<'ReadonlyNonEmptyArray', number> & - FoldableWithIndex1<'ReadonlyNonEmptyArray', number> & - Alt1<'ReadonlyNonEmptyArray'> -``` - -Added in v2.5.0 - # mapping ## flap @@ -1524,6 +1481,21 @@ export declare const zipWith: ( Added in v2.5.1 +# zone of death + +## ~~cons~~ + +Use [`prepend`](./ReadonlyArray.ts.html#prepend) instead. + +**Signature** + +```ts +export declare function cons(head: A): (tail: ReadonlyArray) => ReadonlyNonEmptyArray +export declare function cons(head: A, tail: ReadonlyArray): ReadonlyNonEmptyArray +``` + +Added in v2.5.0 + ## ~~filterWithIndex~~ Use [`filterWithIndex`](./ReadonlyArray.ts.html#filterwithindex) instead. @@ -1609,6 +1581,37 @@ export declare const prependToAll: (middle: A) => (as: ReadonlyNonEmptyArray< Added in v2.9.0 +## ~~readonlyNonEmptyArray~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RNEA.Functor` instead of `RNEA.readonlyNonEmptyArray` +(where `RNEA` is from `import RNEA from 'fp-ts/ReadonlyNonEmptyArray'`) + +**Signature** + +```ts +export declare const readonlyNonEmptyArray: Monad1<'ReadonlyNonEmptyArray'> & + Comonad1<'ReadonlyNonEmptyArray'> & + TraversableWithIndex1<'ReadonlyNonEmptyArray', number> & + FunctorWithIndex1<'ReadonlyNonEmptyArray', number> & + FoldableWithIndex1<'ReadonlyNonEmptyArray', number> & + Alt1<'ReadonlyNonEmptyArray'> +``` + +Added in v2.5.0 + +## ~~snoc~~ + +Use [`append`](./ReadonlyArray.ts.html#append) instead. + +**Signature** + +```ts +export declare const snoc: (init: readonly A[], end: A) => ReadonlyNonEmptyArray +``` + +Added in v2.5.0 + ## ~~uncons~~ Use [`unprepend`](#unprepend) instead. diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md index 6a4d2ab71..1f09030c7 100644 --- a/docs/modules/ReadonlyRecord.ts.md +++ b/docs/modules/ReadonlyRecord.ts.md @@ -57,12 +57,6 @@ Added in v2.5.0 - [getUnionMonoid](#getunionmonoid) - [getUnionSemigroup](#getunionsemigroup) - [getWitherable](#getwitherable) - - [~~FoldableWithIndex~~](#foldablewithindex) - - [~~Foldable~~](#foldable) - - [~~TraversableWithIndex~~](#traversablewithindex) - - [~~Traversable~~](#traversable) - - [~~Witherable~~](#witherable) - - [~~readonlyRecord~~](#readonlyrecord) - [mapping](#mapping) - [flap](#flap) - [model](#model) @@ -104,8 +98,15 @@ Added in v2.5.0 - [union](#union) - [updateAt](#updateat) - [upsertAt](#upsertat) +- [zone of death](#zone-of-death) + - [~~FoldableWithIndex~~](#foldablewithindex) + - [~~Foldable~~](#foldable) + - [~~TraversableWithIndex~~](#traversablewithindex) + - [~~Traversable~~](#traversable) + - [~~Witherable~~](#witherable) - [~~hasOwnProperty (function)~~](#hasownproperty-function) - [~~insertAt~~](#insertat) + - [~~readonlyRecord~~](#readonlyrecord) --- @@ -878,84 +879,6 @@ export declare const getWitherable: (O: Ord) => Witherable1 Added in v2.11.0 -## ~~FoldableWithIndex~~ - -Use `getFoldableWithIndex` instead. - -**Signature** - -```ts -export declare const FoldableWithIndex: FoldableWithIndex1<'ReadonlyRecord', string> -``` - -Added in v2.7.0 - -## ~~Foldable~~ - -Use `getFoldable` instead. - -**Signature** - -```ts -export declare const Foldable: Foldable1<'ReadonlyRecord'> -``` - -Added in v2.7.0 - -## ~~TraversableWithIndex~~ - -Use `getTraversableWithIndex` instead. - -**Signature** - -```ts -export declare const TraversableWithIndex: TraversableWithIndex1<'ReadonlyRecord', string> -``` - -Added in v2.7.0 - -## ~~Traversable~~ - -Use `getTraversable` instead. - -**Signature** - -```ts -export declare const Traversable: Traversable1<'ReadonlyRecord'> -``` - -Added in v2.7.0 - -## ~~Witherable~~ - -Use `getWitherable` instead. - -**Signature** - -```ts -export declare const Witherable: Witherable1<'ReadonlyRecord'> -``` - -Added in v2.7.0 - -## ~~readonlyRecord~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RR.Functor` instead of `RR.readonlyRecord` -(where `RR` is from `import RR from 'fp-ts/ReadonlyRecord'`) - -**Signature** - -```ts -export declare const readonlyRecord: FunctorWithIndex1<'ReadonlyRecord', string> & - FoldableWithIndex1<'ReadonlyRecord', string> & - FilterableWithIndex1<'ReadonlyRecord', string> & - TraversableWithIndex1<'ReadonlyRecord', string> & - Witherable1<'ReadonlyRecord'> -``` - -Added in v2.5.0 - # mapping ## flap @@ -1969,6 +1892,68 @@ assert.deepStrictEqual(upsertAt('c', 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 }) Added in v2.10.0 +# zone of death + +## ~~FoldableWithIndex~~ + +Use `getFoldableWithIndex` instead. + +**Signature** + +```ts +export declare const FoldableWithIndex: FoldableWithIndex1<'ReadonlyRecord', string> +``` + +Added in v2.7.0 + +## ~~Foldable~~ + +Use `getFoldable` instead. + +**Signature** + +```ts +export declare const Foldable: Foldable1<'ReadonlyRecord'> +``` + +Added in v2.7.0 + +## ~~TraversableWithIndex~~ + +Use `getTraversableWithIndex` instead. + +**Signature** + +```ts +export declare const TraversableWithIndex: TraversableWithIndex1<'ReadonlyRecord', string> +``` + +Added in v2.7.0 + +## ~~Traversable~~ + +Use `getTraversable` instead. + +**Signature** + +```ts +export declare const Traversable: Traversable1<'ReadonlyRecord'> +``` + +Added in v2.7.0 + +## ~~Witherable~~ + +Use `getWitherable` instead. + +**Signature** + +```ts +export declare const Witherable: Witherable1<'ReadonlyRecord'> +``` + +Added in v2.7.0 + ## ~~hasOwnProperty (function)~~ Use [`has`](#has) instead. @@ -1992,3 +1977,21 @@ export declare const insertAt: (k: string, a: A) => (r: Readonly & + FoldableWithIndex1<'ReadonlyRecord', string> & + FilterableWithIndex1<'ReadonlyRecord', string> & + TraversableWithIndex1<'ReadonlyRecord', string> & + Witherable1<'ReadonlyRecord'> +``` + +Added in v2.5.0 diff --git a/docs/modules/ReadonlySet.ts.md b/docs/modules/ReadonlySet.ts.md index 930ea8fa0..cee3ab861 100644 --- a/docs/modules/ReadonlySet.ts.md +++ b/docs/modules/ReadonlySet.ts.md @@ -19,7 +19,6 @@ Added in v2.5.0 - [fromSet](#fromset) - [toReadonlyArray](#toreadonlyarray) - [toSet](#toset) - - [~~fromArray~~](#fromarray) - [folding](#folding) - [reduceRight](#reduceright) - [instances](#instances) @@ -56,6 +55,8 @@ Added in v2.5.0 - [some](#some) - [toggle](#toggle) - [union](#union) +- [zone of death](#zone-of-death) + - [~~fromArray~~](#fromarray) --- @@ -119,18 +120,6 @@ export declare function toSet(s: ReadonlySet): Set Added in v2.5.0 -## ~~fromArray~~ - -Use [`fromReadonlyArray`](#fromreadonlyarray) instead. - -**Signature** - -```ts -export declare const fromArray: (E: Eq) => (as: readonly A[]) => ReadonlySet -``` - -Added in v2.5.0 - # folding ## reduceRight @@ -524,3 +513,17 @@ export declare function union(E: Eq): { ``` Added in v2.5.0 + +# zone of death + +## ~~fromArray~~ + +Use [`fromReadonlyArray`](#fromreadonlyarray) instead. + +**Signature** + +```ts +export declare const fromArray: (E: Eq) => (as: readonly A[]) => ReadonlySet +``` + +Added in v2.5.0 diff --git a/docs/modules/ReadonlyTuple.ts.md b/docs/modules/ReadonlyTuple.ts.md index 41d819248..a5e82ff2f 100644 --- a/docs/modules/ReadonlyTuple.ts.md +++ b/docs/modules/ReadonlyTuple.ts.md @@ -34,7 +34,6 @@ Added in v2.5.0 - [getChain](#getchain) - [getChainRec](#getchainrec) - [getMonad](#getmonad) - - [~~readonlyTuple~~](#readonlytuple) - [mapping](#mapping) - [bimap](#bimap) - [flap](#flap) @@ -53,6 +52,8 @@ Added in v2.5.0 - [fst](#fst) - [snd](#snd) - [swap](#swap) +- [zone of death](#zone-of-death) + - [~~readonlyTuple~~](#readonlytuple) --- @@ -238,24 +239,6 @@ export declare function getMonad(M: Monoid): Monad2C Added in v2.5.0 -## ~~readonlyTuple~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readonlyTuple` -(where `RT` is from `import RT from 'fp-ts/ReadonlyTuple'`) - -**Signature** - -```ts -export declare const readonlyTuple: Semigroupoid2<'ReadonlyTuple'> & - Bifunctor2<'ReadonlyTuple'> & - Comonad2<'ReadonlyTuple'> & - Foldable2<'ReadonlyTuple'> & - Traversable2<'ReadonlyTuple'> -``` - -Added in v2.5.0 - # mapping ## bimap @@ -418,3 +401,23 @@ export declare const swap: (ea: readonly [A, E]) => readonly [E, A] ``` Added in v2.5.0 + +# zone of death + +## ~~readonlyTuple~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readonlyTuple` +(where `RT` is from `import RT from 'fp-ts/ReadonlyTuple'`) + +**Signature** + +```ts +export declare const readonlyTuple: Semigroupoid2<'ReadonlyTuple'> & + Bifunctor2<'ReadonlyTuple'> & + Comonad2<'ReadonlyTuple'> & + Foldable2<'ReadonlyTuple'> & + Traversable2<'ReadonlyTuple'> +``` + +Added in v2.5.0 diff --git a/docs/modules/Record.ts.md b/docs/modules/Record.ts.md index 586559cf9..d8d2002e4 100644 --- a/docs/modules/Record.ts.md +++ b/docs/modules/Record.ts.md @@ -50,12 +50,6 @@ Added in v2.0.0 - [getUnionMonoid](#getunionmonoid) - [getUnionSemigroup](#getunionsemigroup) - [getWitherable](#getwitherable) - - [~~FoldableWithIndex~~](#foldablewithindex) - - [~~Foldable~~](#foldable) - - [~~TraversableWithIndex~~](#traversablewithindex) - - [~~Traversable~~](#traversable) - - [~~Witherable~~](#witherable) - - [~~record~~](#record) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -96,9 +90,16 @@ Added in v2.0.0 - [union](#union) - [updateAt](#updateat) - [upsertAt](#upsertat) +- [zone of death](#zone-of-death) + - [~~FoldableWithIndex~~](#foldablewithindex) + - [~~Foldable~~](#foldable) + - [~~TraversableWithIndex~~](#traversablewithindex) + - [~~Traversable~~](#traversable) + - [~~Witherable~~](#witherable) - [~~empty~~](#empty) - [~~hasOwnProperty (function)~~](#hasownproperty-function) - [~~insertAt~~](#insertat) + - [~~record~~](#record) --- @@ -756,84 +757,6 @@ export declare const getWitherable: (O: Ord) => Witherable1 Added in v2.11.0 -## ~~FoldableWithIndex~~ - -Use `getFoldableWithIndex` instead. - -**Signature** - -```ts -export declare const FoldableWithIndex: FoldableWithIndex1<'Record', string> -``` - -Added in v2.7.0 - -## ~~Foldable~~ - -Use `getFoldable` instead. - -**Signature** - -```ts -export declare const Foldable: Foldable1<'Record'> -``` - -Added in v2.7.0 - -## ~~TraversableWithIndex~~ - -Use the `getTraversableWithIndex` instead. - -**Signature** - -```ts -export declare const TraversableWithIndex: TraversableWithIndex1<'Record', string> -``` - -Added in v2.7.0 - -## ~~Traversable~~ - -Use `getTraversable` instead. - -**Signature** - -```ts -export declare const Traversable: Traversable1<'Record'> -``` - -Added in v2.7.0 - -## ~~Witherable~~ - -Use `getWitherable` instead. - -**Signature** - -```ts -export declare const Witherable: Witherable1<'Record'> -``` - -Added in v2.7.0 - -## ~~record~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `R.Functor` instead of `R.record` -(where `R` is from `import R from 'fp-ts/Record'`) - -**Signature** - -```ts -export declare const record: FunctorWithIndex1<'Record', string> & - FoldableWithIndex1<'Record', string> & - FilterableWithIndex1<'Record', string> & - TraversableWithIndex1<'Record', string> & - Witherable1<'Record'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -1868,6 +1791,68 @@ assert.deepStrictEqual(upsertAt('c', 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 }) Added in v2.10.0 +# zone of death + +## ~~FoldableWithIndex~~ + +Use `getFoldableWithIndex` instead. + +**Signature** + +```ts +export declare const FoldableWithIndex: FoldableWithIndex1<'Record', string> +``` + +Added in v2.7.0 + +## ~~Foldable~~ + +Use `getFoldable` instead. + +**Signature** + +```ts +export declare const Foldable: Foldable1<'Record'> +``` + +Added in v2.7.0 + +## ~~TraversableWithIndex~~ + +Use the `getTraversableWithIndex` instead. + +**Signature** + +```ts +export declare const TraversableWithIndex: TraversableWithIndex1<'Record', string> +``` + +Added in v2.7.0 + +## ~~Traversable~~ + +Use `getTraversable` instead. + +**Signature** + +```ts +export declare const Traversable: Traversable1<'Record'> +``` + +Added in v2.7.0 + +## ~~Witherable~~ + +Use `getWitherable` instead. + +**Signature** + +```ts +export declare const Witherable: Witherable1<'Record'> +``` + +Added in v2.7.0 + ## ~~empty~~ Use a new `{}` instead. @@ -1903,3 +1888,21 @@ export declare const insertAt: (k: string, a: A) => (r: Record) => ``` Added in v2.0.0 + +## ~~record~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `R.Functor` instead of `R.record` +(where `R` is from `import R from 'fp-ts/Record'`) + +**Signature** + +```ts +export declare const record: FunctorWithIndex1<'Record', string> & + FoldableWithIndex1<'Record', string> & + FilterableWithIndex1<'Record', string> & + TraversableWithIndex1<'Record', string> & + Witherable1<'Record'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Ring.ts.md b/docs/modules/Ring.ts.md index 823da6f06..de995d2fc 100644 --- a/docs/modules/Ring.ts.md +++ b/docs/modules/Ring.ts.md @@ -20,31 +20,17 @@ Added in v2.0.0

Table of contents

-- [instances](#instances) - - [~~getFunctionRing~~](#getfunctionring) - [model](#model) - [Ring (interface)](#ring-interface) - [utils](#utils) - [negate](#negate) - [tuple](#tuple) +- [zone of death](#zone-of-death) + - [~~getFunctionRing~~](#getfunctionring) - [~~getTupleRing~~](#gettuplering) --- -# instances - -## ~~getFunctionRing~~ - -Use [`getRing`](./function.ts.html#getring) instead. - -**Signature** - -```ts -export declare const getFunctionRing: (R: Ring) => Ring<(a: A) => B> -``` - -Added in v2.0.0 - # model ## Ring (interface) @@ -101,6 +87,20 @@ assert.deepStrictEqual(R.zero, [0, 0, 0]) Added in v2.10.0 +# zone of death + +## ~~getFunctionRing~~ + +Use [`getRing`](./function.ts.html#getring) instead. + +**Signature** + +```ts +export declare const getFunctionRing: (R: Ring) => Ring<(a: A) => B> +``` + +Added in v2.0.0 + ## ~~getTupleRing~~ Use [`tuple`](#tuple) instead. diff --git a/docs/modules/Semigroup.ts.md b/docs/modules/Semigroup.ts.md index 0744b83a9..787da91ff 100644 --- a/docs/modules/Semigroup.ts.md +++ b/docs/modules/Semigroup.ts.md @@ -52,21 +52,9 @@ Added in v2.0.0 - [constant](#constant) - [max](#max) - [min](#min) - - [~~getJoinSemigroup~~](#getjoinsemigroup) - - [~~getMeetSemigroup~~](#getmeetsemigroup) - [instances](#instances) - [first](#first) - [last](#last) - - [~~getFirstSemigroup~~](#getfirstsemigroup) - - [~~getFunctionSemigroup~~](#getfunctionsemigroup) - - [~~getLastSemigroup~~](#getlastsemigroup) - - [~~getObjectSemigroup~~](#getobjectsemigroup) - - [~~semigroupAll~~](#semigroupall) - - [~~semigroupAny~~](#semigroupany) - - [~~semigroupProduct~~](#semigroupproduct) - - [~~semigroupString~~](#semigroupstring) - - [~~semigroupSum~~](#semigroupsum) - - [~~semigroupVoid~~](#semigroupvoid) - [model](#model) - [Semigroup (interface)](#semigroup-interface) - [utils](#utils) @@ -75,11 +63,24 @@ Added in v2.0.0 - [reverse](#reverse) - [struct](#struct) - [tuple](#tuple) +- [zone of death](#zone-of-death) - [~~fold~~](#fold) - [~~getDualSemigroup~~](#getdualsemigroup) + - [~~getFirstSemigroup~~](#getfirstsemigroup) + - [~~getFunctionSemigroup~~](#getfunctionsemigroup) - [~~getIntercalateSemigroup~~](#getintercalatesemigroup) + - [~~getJoinSemigroup~~](#getjoinsemigroup) + - [~~getLastSemigroup~~](#getlastsemigroup) + - [~~getMeetSemigroup~~](#getmeetsemigroup) + - [~~getObjectSemigroup~~](#getobjectsemigroup) - [~~getStructSemigroup~~](#getstructsemigroup) - [~~getTupleSemigroup~~](#gettuplesemigroup) + - [~~semigroupAll~~](#semigroupall) + - [~~semigroupAny~~](#semigroupany) + - [~~semigroupProduct~~](#semigroupproduct) + - [~~semigroupString~~](#semigroupstring) + - [~~semigroupSum~~](#semigroupsum) + - [~~semigroupVoid~~](#semigroupvoid) --- @@ -141,30 +142,6 @@ assert.deepStrictEqual(S1.concat(1, 2), 1) Added in v2.10.0 -## ~~getJoinSemigroup~~ - -Use [`max`](#max) instead. - -**Signature** - -```ts -export declare const getJoinSemigroup:
(O: Or.Ord) => Semigroup -``` - -Added in v2.0.0 - -## ~~getMeetSemigroup~~ - -Use [`min`](#min) instead. - -**Signature** - -```ts -export declare const getMeetSemigroup: (O: Or.Ord) => Semigroup -``` - -Added in v2.0.0 - # instances ## first @@ -207,126 +184,6 @@ assert.deepStrictEqual(S.last().concat(1, 2), 2) Added in v2.10.0 -## ~~getFirstSemigroup~~ - -Use [`first`](#first) instead. - -**Signature** - -```ts -export declare const getFirstSemigroup: () => Semigroup -``` - -Added in v2.0.0 - -## ~~getFunctionSemigroup~~ - -Use [`getSemigroup`](./function.ts.html#getSemigroup) instead. - -**Signature** - -```ts -export declare const getFunctionSemigroup: (S: Semigroup) => () => Semigroup<(a: A) => S> -``` - -Added in v2.0.0 - -## ~~getLastSemigroup~~ - -Use [`last`](#last) instead. - -**Signature** - -```ts -export declare const getLastSemigroup: () => Semigroup -``` - -Added in v2.0.0 - -## ~~getObjectSemigroup~~ - -Use [`getAssignSemigroup`](./struct.ts.html#getAssignSemigroup) instead. - -**Signature** - -```ts -export declare const getObjectSemigroup: () => Semigroup -``` - -Added in v2.0.0 - -## ~~semigroupAll~~ - -Use [`SemigroupAll`](./boolean.ts.html#SemigroupAll) instead. - -**Signature** - -```ts -export declare const semigroupAll: Semigroup -``` - -Added in v2.0.0 - -## ~~semigroupAny~~ - -Use [`SemigroupAny`](./boolean.ts.html#SemigroupAny) instead. - -**Signature** - -```ts -export declare const semigroupAny: Semigroup -``` - -Added in v2.0.0 - -## ~~semigroupProduct~~ - -Use [`SemigroupProduct`](./number.ts.html#SemigroupProduct) instead. - -**Signature** - -```ts -export declare const semigroupProduct: Semigroup -``` - -Added in v2.0.0 - -## ~~semigroupString~~ - -Use [`Semigroup`](./string.ts.html#Semigroup) instead. - -**Signature** - -```ts -export declare const semigroupString: Semigroup -``` - -Added in v2.0.0 - -## ~~semigroupSum~~ - -Use [`SemigroupSum`](./number.ts.html#SemigroupSum) instead. - -**Signature** - -```ts -export declare const semigroupSum: Semigroup -``` - -Added in v2.0.0 - -## ~~semigroupVoid~~ - -Use `void` module instead. - -**Signature** - -```ts -export declare const semigroupVoid: Semigroup -``` - -Added in v2.0.0 - # model ## Semigroup (interface) @@ -474,6 +331,8 @@ assert.deepStrictEqual(S2.concat(['a', 1, true], ['b', 2, false]), ['ab', 3, fal Added in v2.10.0 +# zone of death + ## ~~fold~~ Use [`concatAll`](#concatall) instead. @@ -501,6 +360,30 @@ export declare const getDualSemigroup: (S: Semigroup) => Semigroup Added in v2.0.0 +## ~~getFirstSemigroup~~ + +Use [`first`](#first) instead. + +**Signature** + +```ts +export declare const getFirstSemigroup: () => Semigroup +``` + +Added in v2.0.0 + +## ~~getFunctionSemigroup~~ + +Use [`getSemigroup`](./function.ts.html#getSemigroup) instead. + +**Signature** + +```ts +export declare const getFunctionSemigroup: (S: Semigroup) => () => Semigroup<(a: A) => S> +``` + +Added in v2.0.0 + ## ~~getIntercalateSemigroup~~ Use [`intercalate`](#intercalate) instead. @@ -513,6 +396,54 @@ export declare const getIntercalateSemigroup: (middle: A) => (S: Semigroup Added in v2.5.0 +## ~~getJoinSemigroup~~ + +Use [`max`](#max) instead. + +**Signature** + +```ts +export declare const getJoinSemigroup: (O: Or.Ord) => Semigroup +``` + +Added in v2.0.0 + +## ~~getLastSemigroup~~ + +Use [`last`](#last) instead. + +**Signature** + +```ts +export declare const getLastSemigroup: () => Semigroup +``` + +Added in v2.0.0 + +## ~~getMeetSemigroup~~ + +Use [`min`](#min) instead. + +**Signature** + +```ts +export declare const getMeetSemigroup: (O: Or.Ord) => Semigroup +``` + +Added in v2.0.0 + +## ~~getObjectSemigroup~~ + +Use [`getAssignSemigroup`](./struct.ts.html#getAssignSemigroup) instead. + +**Signature** + +```ts +export declare const getObjectSemigroup: () => Semigroup +``` + +Added in v2.0.0 + ## ~~getStructSemigroup~~ Use [`struct`](#struct) instead. @@ -540,3 +471,75 @@ export declare const getTupleSemigroup: []>( ``` Added in v2.0.0 + +## ~~semigroupAll~~ + +Use [`SemigroupAll`](./boolean.ts.html#SemigroupAll) instead. + +**Signature** + +```ts +export declare const semigroupAll: Semigroup +``` + +Added in v2.0.0 + +## ~~semigroupAny~~ + +Use [`SemigroupAny`](./boolean.ts.html#SemigroupAny) instead. + +**Signature** + +```ts +export declare const semigroupAny: Semigroup +``` + +Added in v2.0.0 + +## ~~semigroupProduct~~ + +Use [`SemigroupProduct`](./number.ts.html#SemigroupProduct) instead. + +**Signature** + +```ts +export declare const semigroupProduct: Semigroup +``` + +Added in v2.0.0 + +## ~~semigroupString~~ + +Use [`Semigroup`](./string.ts.html#Semigroup) instead. + +**Signature** + +```ts +export declare const semigroupString: Semigroup +``` + +Added in v2.0.0 + +## ~~semigroupSum~~ + +Use [`SemigroupSum`](./number.ts.html#SemigroupSum) instead. + +**Signature** + +```ts +export declare const semigroupSum: Semigroup +``` + +Added in v2.0.0 + +## ~~semigroupVoid~~ + +Use `void` module instead. + +**Signature** + +```ts +export declare const semigroupVoid: Semigroup +``` + +Added in v2.0.0 diff --git a/docs/modules/Semiring.ts.md b/docs/modules/Semiring.ts.md index 2d2377a9a..8237ebd99 100644 --- a/docs/modules/Semiring.ts.md +++ b/docs/modules/Semiring.ts.md @@ -32,40 +32,40 @@ Added in v2.0.0

Table of contents

-- [instances](#instances) - - [~~getFunctionSemiring~~](#getfunctionsemiring) - [model](#model) - [Semiring (interface)](#semiring-interface) +- [zone of death](#zone-of-death) + - [~~getFunctionSemiring~~](#getfunctionsemiring) --- -# instances - -## ~~getFunctionSemiring~~ +# model -Use [`getSemiring`](./function.ts.html#getsemiring) instead. +## Semiring (interface) **Signature** ```ts -export declare const getFunctionSemiring: (S: Semiring) => Semiring<(a: A) => B> +export interface Semiring
{ + readonly add: (x: A, y: A) => A + readonly zero: A + readonly mul: (x: A, y: A) => A + readonly one: A +} ``` Added in v2.0.0 -# model +# zone of death -## Semiring (interface) +## ~~getFunctionSemiring~~ + +Use [`getSemiring`](./function.ts.html#getsemiring) instead. **Signature** ```ts -export interface Semiring { - readonly add: (x: A, y: A) => A - readonly zero: A - readonly mul: (x: A, y: A) => A - readonly one: A -} +export declare const getFunctionSemiring: (S: Semiring) => Semiring<(a: A) => B> ``` Added in v2.0.0 diff --git a/docs/modules/Set.ts.md b/docs/modules/Set.ts.md index a401a6841..a19c7b0db 100644 --- a/docs/modules/Set.ts.md +++ b/docs/modules/Set.ts.md @@ -50,6 +50,7 @@ Added in v2.0.0 - [some](#some) - [toggle](#toggle) - [union](#union) +- [zone of death](#zone-of-death) - [~~subset~~](#subset) --- @@ -456,6 +457,8 @@ export declare function union(E: Eq): { Added in v2.0.0 +# zone of death + ## ~~subset~~ Use [`isSubset`](#issubset) instead. diff --git a/docs/modules/Show.ts.md b/docs/modules/Show.ts.md index 2238e65cd..56f7a7c74 100644 --- a/docs/modules/Show.ts.md +++ b/docs/modules/Show.ts.md @@ -19,58 +19,20 @@ Added in v2.0.0

Table of contents

-- [instances](#instances) - - [~~showBoolean~~](#showboolean) - - [~~showNumber~~](#shownumber) - - [~~showString~~](#showstring) - [model](#model) - [Show (interface)](#show-interface) - [utils](#utils) - [struct](#struct) - [tuple](#tuple) +- [zone of death](#zone-of-death) - [~~getStructShow~~](#getstructshow) - [~~getTupleShow~~](#gettupleshow) + - [~~showBoolean~~](#showboolean) + - [~~showNumber~~](#shownumber) + - [~~showString~~](#showstring) --- -# instances - -## ~~showBoolean~~ - -Use [`Show`](./boolean.ts.html#show) instead. - -**Signature** - -```ts -export declare const showBoolean: Show -``` - -Added in v2.0.0 - -## ~~showNumber~~ - -Use [`Show`](./number.ts.html#show) instead. - -**Signature** - -```ts -export declare const showNumber: Show -``` - -Added in v2.0.0 - -## ~~showString~~ - -Use [`Show`](./string.ts.html#show) instead. - -**Signature** - -```ts -export declare const showString: Show -``` - -Added in v2.0.0 - # model ## Show (interface) @@ -109,6 +71,8 @@ export declare const tuple:
( Added in v2.10.0 +# zone of death + ## ~~getStructShow~~ Use [`struct`](#struct) instead. @@ -136,3 +100,39 @@ export declare const getTupleShow: []>( ``` Added in v2.0.0 + +## ~~showBoolean~~ + +Use [`Show`](./boolean.ts.html#show) instead. + +**Signature** + +```ts +export declare const showBoolean: Show +``` + +Added in v2.0.0 + +## ~~showNumber~~ + +Use [`Show`](./number.ts.html#show) instead. + +**Signature** + +```ts +export declare const showNumber: Show +``` + +Added in v2.0.0 + +## ~~showString~~ + +Use [`Show`](./string.ts.html#show) instead. + +**Signature** + +```ts +export declare const showString: Show +``` + +Added in v2.0.0 diff --git a/docs/modules/State.ts.md b/docs/modules/State.ts.md index 3a72069e1..e52963d47 100644 --- a/docs/modules/State.ts.md +++ b/docs/modules/State.ts.md @@ -26,7 +26,6 @@ Added in v2.0.0 - [Functor](#functor) - [Monad](#monad) - [Pointed](#pointed) - - [~~state~~](#state) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -54,8 +53,10 @@ Added in v2.0.0 - [traverseArrayWithIndex](#traversearraywithindex) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) - [~~evalState~~](#evalstate) - [~~execState~~](#execstate) + - [~~state~~](#state) --- @@ -191,20 +192,6 @@ export declare const Pointed: Pointed2<'State'> Added in v2.10.0 -## ~~state~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `S.Functor` instead of `S.state` -(where `S` is from `import S from 'fp-ts/State'`) - -**Signature** - -```ts -export declare const state: Monad2<'State'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -472,6 +459,8 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( Added in v2.11.0 +# zone of death + ## ~~evalState~~ Use [`evaluate`](#evaluate) instead @@ -495,3 +484,17 @@ export declare const execState: (ma: State, s: S) => S ``` Added in v2.0.0 + +## ~~state~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `S.Functor` instead of `S.state` +(where `S` is from `import S from 'fp-ts/State'`) + +**Signature** + +```ts +export declare const state: Monad2<'State'> +``` + +Added in v2.0.0 diff --git a/docs/modules/StateReaderTaskEither.ts.md b/docs/modules/StateReaderTaskEither.ts.md index 1b60fa552..9106ed3c5 100644 --- a/docs/modules/StateReaderTaskEither.ts.md +++ b/docs/modules/StateReaderTaskEither.ts.md @@ -71,8 +71,6 @@ Added in v2.0.0 - [MonadTask](#monadtask) - [MonadThrow](#monadthrow-1) - [Pointed](#pointed) - - [~~stateReaderTaskEitherSeq~~](#statereadertaskeitherseq) - - [~~stateReaderTaskEither~~](#statereadertaskeither) - [lifting](#lifting) - [fromEitherK](#fromeitherk) - [fromIOEitherK](#fromioeitherk) @@ -141,9 +139,12 @@ Added in v2.0.0 - [traverseArrayWithIndex](#traversearraywithindex) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) - [~~evalState~~](#evalstate) - [~~execState~~](#execstate) - [~~run~~](#run) + - [~~stateReaderTaskEitherSeq~~](#statereadertaskeitherseq) + - [~~stateReaderTaskEither~~](#statereadertaskeither) --- @@ -743,42 +744,6 @@ export declare const Pointed: Pointed4<'StateReaderTaskEither'> Added in v2.10.0 -## ~~stateReaderTaskEitherSeq~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `SRTE.Functor` instead of `SRTE.stateReaderTaskEitherSeq` -(where `SRTE` is from `import SRTE from 'fp-ts/StateReaderTaskEither'`) - -**Signature** - -```ts -export declare const stateReaderTaskEitherSeq: Monad4<'StateReaderTaskEither'> & - Bifunctor4<'StateReaderTaskEither'> & - Alt4<'StateReaderTaskEither'> & - MonadTask4<'StateReaderTaskEither'> & - MonadThrow4<'StateReaderTaskEither'> -``` - -Added in v2.0.0 - -## ~~stateReaderTaskEither~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `SRTE.Functor` instead of `SRTE.stateReaderTaskEither` -(where `SRTE` is from `import SRTE from 'fp-ts/StateReaderTaskEither'`) - -**Signature** - -```ts -export declare const stateReaderTaskEither: Monad4<'StateReaderTaskEither'> & - Bifunctor4<'StateReaderTaskEither'> & - Alt4<'StateReaderTaskEither'> & - MonadTask4<'StateReaderTaskEither'> & - MonadThrow4<'StateReaderTaskEither'> -``` - -Added in v2.0.0 - # lifting ## fromEitherK @@ -1629,6 +1594,8 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( Added in v2.11.0 +# zone of death + ## ~~evalState~~ Use [`evaluate`](#evaluate) instead @@ -1668,3 +1635,39 @@ export declare function run(ma: StateReaderTaskEither, s ``` Added in v2.0.0 + +## ~~stateReaderTaskEitherSeq~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `SRTE.Functor` instead of `SRTE.stateReaderTaskEitherSeq` +(where `SRTE` is from `import SRTE from 'fp-ts/StateReaderTaskEither'`) + +**Signature** + +```ts +export declare const stateReaderTaskEitherSeq: Monad4<'StateReaderTaskEither'> & + Bifunctor4<'StateReaderTaskEither'> & + Alt4<'StateReaderTaskEither'> & + MonadTask4<'StateReaderTaskEither'> & + MonadThrow4<'StateReaderTaskEither'> +``` + +Added in v2.0.0 + +## ~~stateReaderTaskEither~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `SRTE.Functor` instead of `SRTE.stateReaderTaskEither` +(where `SRTE` is from `import SRTE from 'fp-ts/StateReaderTaskEither'`) + +**Signature** + +```ts +export declare const stateReaderTaskEither: Monad4<'StateReaderTaskEither'> & + Bifunctor4<'StateReaderTaskEither'> & + Alt4<'StateReaderTaskEither'> & + MonadTask4<'StateReaderTaskEither'> & + MonadThrow4<'StateReaderTaskEither'> +``` + +Added in v2.0.0 diff --git a/docs/modules/StateT.ts.md b/docs/modules/StateT.ts.md index 1cb7d800e..927fed1eb 100644 --- a/docs/modules/StateT.ts.md +++ b/docs/modules/StateT.ts.md @@ -31,6 +31,7 @@ Added in v2.0.0 - [fromState](#fromstate) - [map](#map) - [of](#of) +- [zone of death](#zone-of-death) - [~~StateM1~~ (interface)](#statem1-interface) - [~~StateM2C~~ (interface)](#statem2c-interface) - [~~StateM2~~ (interface)](#statem2-interface) @@ -273,6 +274,8 @@ export declare function of(F: Pointed): (a: A) => StateT Added in v2.10.0 +# zone of death + ## ~~StateM1~~ (interface) **Signature** diff --git a/docs/modules/Store.ts.md b/docs/modules/Store.ts.md index 1bb732a23..3023f3b75 100644 --- a/docs/modules/Store.ts.md +++ b/docs/modules/Store.ts.md @@ -17,7 +17,6 @@ Added in v2.0.0 - [instances](#instances) - [Comonad](#comonad) - [Functor](#functor) - - [~~store~~](#store) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -33,6 +32,8 @@ Added in v2.0.0 - [peeks](#peeks) - [seek](#seek) - [seeks](#seeks) +- [zone of death](#zone-of-death) + - [~~store~~](#store) --- @@ -70,20 +71,6 @@ export declare const Functor: Functor2<'Store'> Added in v2.7.0 -## ~~store~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Comonad` instance, pass `S.Comonad` instead of `S.store` -(where `S` is from `import S from 'fp-ts/Store'`) - -**Signature** - -```ts -export declare const store: Comonad2<'Store'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -232,3 +219,19 @@ export declare function seeks(f: Endomorphism): (wa: Store) => St ``` Added in v2.0.0 + +# zone of death + +## ~~store~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Comonad` instance, pass `S.Comonad` instead of `S.store` +(where `S` is from `import S from 'fp-ts/Store'`) + +**Signature** + +```ts +export declare const store: Comonad2<'Store'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Strong.ts.md b/docs/modules/Strong.ts.md index d87693c65..afad9f4bb 100644 --- a/docs/modules/Strong.ts.md +++ b/docs/modules/Strong.ts.md @@ -46,6 +46,7 @@ Added in v2.0.0 - [utils](#utils) - [fanOut](#fanout) - [split](#split) +- [zone of death](#zone-of-death) - [~~fanout~~](#fanout) - [~~splitStrong~~](#splitstrong) @@ -183,6 +184,8 @@ export declare function split( Added in v2.10.0 +# zone of death + ## ~~fanout~~ Use [`fanOut`](#fanout) instead. diff --git a/docs/modules/Task.ts.md b/docs/modules/Task.ts.md index f6776826a..26a32109e 100644 --- a/docs/modules/Task.ts.md +++ b/docs/modules/Task.ts.md @@ -25,7 +25,6 @@ Added in v2.0.0 - [of](#of) - [conversions](#conversions) - [fromIO](#fromio) - - [~~fromTask~~](#fromtask) - [do notation](#do-notation) - [Do](#do) - [apS](#aps) @@ -46,10 +45,6 @@ Added in v2.0.0 - [MonadTask](#monadtask) - [Pointed](#pointed) - [getRaceMonoid](#getracemonoid) - - [~~getMonoid~~](#getmonoid) - - [~~getSemigroup~~](#getsemigroup) - - [~~taskSeq~~](#taskseq) - - [~~task~~](#task) - [lifting](#lifting) - [fromIOK](#fromiok) - [mapping](#mapping) @@ -84,6 +79,12 @@ Added in v2.0.0 - [traverseReadonlyNonEmptyArrayWithIndexSeq](#traversereadonlynonemptyarraywithindexseq) - [traverseSeqArray](#traverseseqarray) - [traverseSeqArrayWithIndex](#traverseseqarraywithindex) +- [zone of death](#zone-of-death) + - [~~fromTask~~](#fromtask) + - [~~getMonoid~~](#getmonoid) + - [~~getSemigroup~~](#getsemigroup) + - [~~taskSeq~~](#taskseq) + - [~~task~~](#task) --- @@ -111,16 +112,6 @@ export declare const fromIO: (fa: IO) => Task Added in v2.0.0 -## ~~fromTask~~ - -**Signature** - -```ts -export declare const fromTask: (fa: Task) => Task -``` - -Added in v2.7.0 - # do notation ## Do @@ -341,60 +332,6 @@ test() Added in v2.0.0 -## ~~getMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -Lift a monoid into 'Task', the inner values are concatenated using the provided `Monoid`. - -**Signature** - -```ts -export declare const getMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~taskSeq~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.taskSeq` -(where `T` is from `import T from 'fp-ts/Task'`) - -**Signature** - -```ts -export declare const taskSeq: Monad1<'Task'> & MonadTask1<'Task'> -``` - -Added in v2.0.0 - -## ~~task~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.task` -(where `T` is from `import T from 'fp-ts/Task'`) - -**Signature** - -```ts -export declare const task: Monad1<'Task'> & MonadTask1<'Task'> -``` - -Added in v2.0.0 - # lifting ## fromIOK @@ -740,3 +677,69 @@ export declare const traverseSeqArrayWithIndex: ( ``` Added in v2.9.0 + +# zone of death + +## ~~fromTask~~ + +**Signature** + +```ts +export declare const fromTask: (fa: Task) => Task +``` + +Added in v2.7.0 + +## ~~getMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +Lift a monoid into 'Task', the inner values are concatenated using the provided `Monoid`. + +**Signature** + +```ts +export declare const getMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~taskSeq~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.taskSeq` +(where `T` is from `import T from 'fp-ts/Task'`) + +**Signature** + +```ts +export declare const taskSeq: Monad1<'Task'> & MonadTask1<'Task'> +``` + +Added in v2.0.0 + +## ~~task~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.task` +(where `T` is from `import T from 'fp-ts/Task'`) + +**Signature** + +```ts +export declare const task: Monad1<'Task'> & MonadTask1<'Task'> +``` + +Added in v2.0.0 diff --git a/docs/modules/TaskEither.ts.md b/docs/modules/TaskEither.ts.md index ff73e112a..8838821bf 100644 --- a/docs/modules/TaskEither.ts.md +++ b/docs/modules/TaskEither.ts.md @@ -83,12 +83,6 @@ Added in v2.0.0 - [MonadTask](#monadtask-1) - [MonadThrow](#monadthrow) - [Pointed](#pointed) - - [~~getApplyMonoid~~](#getapplymonoid) - - [~~getApplySemigroup~~](#getapplysemigroup) - - [~~getSemigroup~~](#getsemigroup) - - [~~getTaskValidation~~](#gettaskvalidation) - - [~~taskEitherSeq~~](#taskeitherseq) - - [~~taskEither~~](#taskeither) - [interop](#interop) - [tryCatch](#trycatch) - [tryCatchK](#trycatchk) @@ -162,6 +156,13 @@ Added in v2.0.0 - [traverseReadonlyNonEmptyArrayWithIndexSeq](#traversereadonlynonemptyarraywithindexseq) - [traverseSeqArray](#traverseseqarray) - [traverseSeqArrayWithIndex](#traverseseqarraywithindex) +- [zone of death](#zone-of-death) + - [~~getApplyMonoid~~](#getapplymonoid) + - [~~getApplySemigroup~~](#getapplysemigroup) + - [~~getSemigroup~~](#getsemigroup) + - [~~getTaskValidation~~](#gettaskvalidation) + - [~~taskEitherSeq~~](#taskeitherseq) + - [~~taskEither~~](#taskeither) --- @@ -933,92 +934,6 @@ export declare const Pointed: Pointed2<'TaskEither'> Added in v2.10.0 -## ~~getApplyMonoid~~ - -Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. - -**Signature** - -```ts -export declare const getApplyMonoid: (M: Monoid) => Monoid> -``` - -Added in v2.0.0 - -## ~~getApplySemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getApplySemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (S: Semigroup) => Semigroup> -``` - -Added in v2.0.0 - -## ~~getTaskValidation~~ - -Use [`getApplicativeTaskValidation`](#getapplicativetaskvalidation) and [`getAltTaskValidation`](#getalttaskvalidation) instead. - -**Signature** - -```ts -export declare function getTaskValidation( - SE: Semigroup -): Monad2C & Bifunctor2 & Alt2C & MonadTask2C & MonadThrow2C -``` - -Added in v2.0.0 - -## ~~taskEitherSeq~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `TE.Functor` instead of `TE.taskEitherSeq` -(where `TE` is from `import TE from 'fp-ts/TaskEither'`) - -**Signature** - -```ts -export declare const taskEitherSeq: Monad2<'TaskEither'> & - Bifunctor2<'TaskEither'> & - Alt2<'TaskEither'> & - MonadTask2<'TaskEither'> & - MonadThrow2<'TaskEither'> -``` - -Added in v2.0.0 - -## ~~taskEither~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `TE.Functor` instead of `TE.taskEither` -(where `TE` is from `import TE from 'fp-ts/TaskEither'`) - -**Signature** - -```ts -export declare const taskEither: Monad2<'TaskEither'> & - Bifunctor2<'TaskEither'> & - Alt2<'TaskEither'> & - MonadTask2<'TaskEither'> & - MonadThrow2<'TaskEither'> -``` - -Added in v2.0.0 - # interop ## tryCatch @@ -1907,3 +1822,91 @@ export declare const traverseSeqArrayWithIndex: ( ``` Added in v2.9.0 + +# zone of death + +## ~~getApplyMonoid~~ + +Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. + +**Signature** + +```ts +export declare const getApplyMonoid: (M: Monoid) => Monoid> +``` + +Added in v2.0.0 + +## ~~getApplySemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getApplySemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (S: Semigroup) => Semigroup> +``` + +Added in v2.0.0 + +## ~~getTaskValidation~~ + +Use [`getApplicativeTaskValidation`](#getapplicativetaskvalidation) and [`getAltTaskValidation`](#getalttaskvalidation) instead. + +**Signature** + +```ts +export declare function getTaskValidation( + SE: Semigroup +): Monad2C & Bifunctor2 & Alt2C & MonadTask2C & MonadThrow2C +``` + +Added in v2.0.0 + +## ~~taskEitherSeq~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `TE.Functor` instead of `TE.taskEitherSeq` +(where `TE` is from `import TE from 'fp-ts/TaskEither'`) + +**Signature** + +```ts +export declare const taskEitherSeq: Monad2<'TaskEither'> & + Bifunctor2<'TaskEither'> & + Alt2<'TaskEither'> & + MonadTask2<'TaskEither'> & + MonadThrow2<'TaskEither'> +``` + +Added in v2.0.0 + +## ~~taskEither~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `TE.Functor` instead of `TE.taskEither` +(where `TE` is from `import TE from 'fp-ts/TaskEither'`) + +**Signature** + +```ts +export declare const taskEither: Monad2<'TaskEither'> & + Bifunctor2<'TaskEither'> & + Alt2<'TaskEither'> & + MonadTask2<'TaskEither'> & + MonadThrow2<'TaskEither'> +``` + +Added in v2.0.0 diff --git a/docs/modules/TaskThese.ts.md b/docs/modules/TaskThese.ts.md index d8c2beaa8..90bbf0a0a 100644 --- a/docs/modules/TaskThese.ts.md +++ b/docs/modules/TaskThese.ts.md @@ -28,7 +28,6 @@ Added in v2.4.0 - [fromOption](#fromoption) - [fromTask](#fromtask) - [fromThese](#fromthese) - - [~~toTuple~~](#totuple) - [error handling](#error-handling) - [mapLeft](#mapleft) - [instances](#instances) @@ -43,10 +42,6 @@ Added in v2.4.0 - [getApply](#getapply) - [getChain](#getchain) - [getMonad](#getmonad) - - [~~bifunctorTaskThese~~](#bifunctortaskthese) - - [~~functorTaskThese~~](#functortaskthese) - - [~~getSemigroup~~](#getsemigroup) - - [~~taskThese~~](#taskthese) - [lifting](#lifting) - [fromIOK](#fromiok) - [fromOptionK](#fromoptionk) @@ -78,6 +73,12 @@ Added in v2.4.0 - [traverseReadonlyArrayWithIndexSeq](#traversereadonlyarraywithindexseq) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndexSeq](#traversereadonlynonemptyarraywithindexseq) +- [zone of death](#zone-of-death) + - [~~bifunctorTaskThese~~](#bifunctortaskthese) + - [~~functorTaskThese~~](#functortaskthese) + - [~~getSemigroup~~](#getsemigroup) + - [~~taskThese~~](#taskthese) + - [~~toTuple~~](#totuple) --- @@ -225,18 +226,6 @@ export declare const fromThese: (fa: TH.These) => TaskThese Added in v2.11.0 -## ~~toTuple~~ - -Use [`toTuple2`](#totuple2) instead. - -**Signature** - -```ts -export declare const toTuple: (e: E, a: A) => (fa: TaskThese) => T.Task<[E, A]> -``` - -Added in v2.4.0 - # error handling ## mapLeft @@ -363,56 +352,6 @@ export declare function getMonad(S: Semigroup): Monad2C & MonadTas Added in v2.4.0 -## ~~bifunctorTaskThese~~ - -Use [`Bifunctor`](#bifunctor) instead. - -**Signature** - -```ts -export declare const bifunctorTaskThese: Bifunctor2<'TaskThese'> -``` - -Added in v2.7.0 - -## ~~functorTaskThese~~ - -Use [`Functor`](#functor) instead. - -**Signature** - -```ts -export declare const functorTaskThese: Functor2<'TaskThese'> -``` - -Added in v2.7.0 - -## ~~getSemigroup~~ - -Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. - -**Signature** - -```ts -export declare const getSemigroup: (SE: Semigroup, SA: Semigroup) => Semigroup> -``` - -Added in v2.4.0 - -## ~~taskThese~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `TT.Functor` instead of `TT.taskThese` -(where `TT` is from `import TT from 'fp-ts/TaskThese'`) - -**Signature** - -```ts -export declare const taskThese: Functor2<'TaskThese'> & Bifunctor2<'TaskThese'> -``` - -Added in v2.4.0 - # lifting ## fromIOK @@ -741,3 +680,67 @@ export declare const traverseReadonlyNonEmptyArrayWithIndexSeq: ( ``` Added in v2.11.0 + +# zone of death + +## ~~bifunctorTaskThese~~ + +Use [`Bifunctor`](#bifunctor) instead. + +**Signature** + +```ts +export declare const bifunctorTaskThese: Bifunctor2<'TaskThese'> +``` + +Added in v2.7.0 + +## ~~functorTaskThese~~ + +Use [`Functor`](#functor) instead. + +**Signature** + +```ts +export declare const functorTaskThese: Functor2<'TaskThese'> +``` + +Added in v2.7.0 + +## ~~getSemigroup~~ + +Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. + +**Signature** + +```ts +export declare const getSemigroup: (SE: Semigroup, SA: Semigroup) => Semigroup> +``` + +Added in v2.4.0 + +## ~~taskThese~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `TT.Functor` instead of `TT.taskThese` +(where `TT` is from `import TT from 'fp-ts/TaskThese'`) + +**Signature** + +```ts +export declare const taskThese: Functor2<'TaskThese'> & Bifunctor2<'TaskThese'> +``` + +Added in v2.4.0 + +## ~~toTuple~~ + +Use [`toTuple2`](#totuple2) instead. + +**Signature** + +```ts +export declare const toTuple: (e: E, a: A) => (fa: TaskThese) => T.Task<[E, A]> +``` + +Added in v2.4.0 diff --git a/docs/modules/These.ts.md b/docs/modules/These.ts.md index 883dfd1a6..b7571c501 100644 --- a/docs/modules/These.ts.md +++ b/docs/modules/These.ts.md @@ -45,7 +45,6 @@ Added in v2.0.0 - [getRight](#getright) - [getRightOnly](#getrightonly) - [toTuple2](#totuple2) - - [~~toTuple~~](#totuple) - [error handling](#error-handling) - [mapLeft](#mapleft) - [folding](#folding) @@ -67,7 +66,6 @@ Added in v2.0.0 - [getMonad](#getmonad) - [getSemigroup](#getsemigroup) - [getShow](#getshow) - - [~~these~~](#these) - [lifting](#lifting) - [fromOptionK](#fromoptionk) - [fromPredicate](#frompredicate) @@ -101,6 +99,9 @@ Added in v2.0.0 - [swap](#swap) - [traverseReadonlyArrayWithIndex](#traversereadonlyarraywithindex) - [traverseReadonlyNonEmptyArrayWithIndex](#traversereadonlynonemptyarraywithindex) +- [zone of death](#zone-of-death) + - [~~these~~](#these) + - [~~toTuple~~](#totuple) --- @@ -352,18 +353,6 @@ assert.deepStrictEqual( Added in v2.10.0 -## ~~toTuple~~ - -Use [`toTuple2`](#totuple2) instead. - -**Signature** - -```ts -export declare const toTuple: (e: E, a: A) => (fa: These) => [E, A] -``` - -Added in v2.0.0 - # error handling ## mapLeft @@ -552,20 +541,6 @@ export declare function getShow(SE: Show, SA: Show): Show & Bifunctor2<'These'> & Foldable2<'These'> & Traversable2<'These'> -``` - -Added in v2.0.0 - # lifting ## fromOptionK @@ -878,3 +853,31 @@ export declare const traverseReadonlyNonEmptyArrayWithIndex: ( ``` Added in v2.11.0 + +# zone of death + +## ~~these~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.these` +(where `T` is from `import T from 'fp-ts/These'`) + +**Signature** + +```ts +export declare const these: Functor2<'These'> & Bifunctor2<'These'> & Foldable2<'These'> & Traversable2<'These'> +``` + +Added in v2.0.0 + +## ~~toTuple~~ + +Use [`toTuple2`](#totuple2) instead. + +**Signature** + +```ts +export declare const toTuple: (e: E, a: A) => (fa: These) => [E, A] +``` + +Added in v2.0.0 diff --git a/docs/modules/TheseT.ts.md b/docs/modules/TheseT.ts.md index 0be205756..9d4bfc7ca 100644 --- a/docs/modules/TheseT.ts.md +++ b/docs/modules/TheseT.ts.md @@ -12,10 +12,6 @@ Added in v2.4.0

Table of contents

-- [model](#model) - - [~~TheseT1~~ (type alias)](#theset1-type-alias) - - [~~TheseT2~~ (type alias)](#theset2-type-alias) - - [~~TheseT~~ (interface)](#theset-interface) - [utils](#utils) - [ap](#ap) - [bimap](#bimap) @@ -31,45 +27,17 @@ Added in v2.4.0 - [rightF](#rightf) - [swap](#swap) - [toTuple2](#totuple2) +- [zone of death](#zone-of-death) - [~~TheseM1~~ (interface)](#thesem1-interface) - [~~TheseM2~~ (interface)](#thesem2-interface) - [~~TheseM~~ (interface)](#thesem-interface) + - [~~TheseT1~~ (type alias)](#theset1-type-alias) + - [~~TheseT2~~ (type alias)](#theset2-type-alias) + - [~~TheseT~~ (interface)](#theset-interface) - [~~getTheseM~~](#getthesem) --- -# model - -## ~~TheseT1~~ (type alias) - -**Signature** - -```ts -export type TheseT1 = Kind> -``` - -Added in v2.4.0 - -## ~~TheseT2~~ (type alias) - -**Signature** - -```ts -export type TheseT2 = Kind2> -``` - -Added in v2.4.0 - -## ~~TheseT~~ (interface) - -**Signature** - -```ts -export interface TheseT extends HKT> {} -``` - -Added in v2.4.0 - # utils ## ap @@ -488,6 +456,8 @@ export declare function toTuple2( Added in v2.10.0 +# zone of death + ## ~~TheseM1~~ (interface) **Signature** @@ -590,6 +560,36 @@ export interface TheseM { Added in v2.4.0 +## ~~TheseT1~~ (type alias) + +**Signature** + +```ts +export type TheseT1 = Kind> +``` + +Added in v2.4.0 + +## ~~TheseT2~~ (type alias) + +**Signature** + +```ts +export type TheseT2 = Kind2> +``` + +Added in v2.4.0 + +## ~~TheseT~~ (interface) + +**Signature** + +```ts +export interface TheseT extends HKT> {} +``` + +Added in v2.4.0 + ## ~~getTheseM~~ **Signature** diff --git a/docs/modules/Traced.ts.md b/docs/modules/Traced.ts.md index 1aba6429f..75262ec9c 100644 --- a/docs/modules/Traced.ts.md +++ b/docs/modules/Traced.ts.md @@ -15,7 +15,6 @@ Added in v2.0.0 - [instances](#instances) - [Functor](#functor) - [getComonad](#getcomonad) - - [~~traced~~](#traced) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -29,6 +28,8 @@ Added in v2.0.0 - [listen](#listen) - [listens](#listens) - [tracks](#tracks) +- [zone of death](#zone-of-death) + - [~~traced~~](#traced) --- @@ -54,18 +55,6 @@ export declare function getComonad

(monoid: Monoid

): Comonad2C Added in v2.0.0 -## ~~traced~~ - -Use [`Functor`](#functor) instead. - -**Signature** - -```ts -export declare const traced: Functor2<'Traced'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -176,3 +165,17 @@ export declare function tracks(M: Monoid

, f: (a: A) => P): (wa: Traced< ``` Added in v2.0.0 + +# zone of death + +## ~~traced~~ + +Use [`Functor`](#functor) instead. + +**Signature** + +```ts +export declare const traced: Functor2<'Traced'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Traversable.ts.md b/docs/modules/Traversable.ts.md index 44a7fd762..bc0a3dc28 100644 --- a/docs/modules/Traversable.ts.md +++ b/docs/modules/Traversable.ts.md @@ -58,6 +58,7 @@ Added in v2.0.0 - [Traverse3 (interface)](#traverse3-interface) - [sequence](#sequence) - [traverse](#traverse) +- [zone of death](#zone-of-death) - [~~SequenceComposition11~~ (interface)](#sequencecomposition11-interface) - [~~TraversableComposition11~~ (interface)](#traversablecomposition11-interface) - [~~TraversableComposition~~ (interface)](#traversablecomposition-interface) @@ -597,6 +598,8 @@ export declare function traverse( Added in v2.10.0 +# zone of death + ## ~~SequenceComposition11~~ (interface) **Signature** diff --git a/docs/modules/Tree.ts.md b/docs/modules/Tree.ts.md index 210ce6b70..caf2c744c 100644 --- a/docs/modules/Tree.ts.md +++ b/docs/modules/Tree.ts.md @@ -52,7 +52,6 @@ Added in v2.0.0 - [Traversable](#traversable) - [getEq](#geteq) - [getShow](#getshow) - - [~~tree~~](#tree) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -77,6 +76,8 @@ Added in v2.0.0 - [elem](#elem) - [exists](#exists) - [extend](#extend) +- [zone of death](#zone-of-death) + - [~~tree~~](#tree) --- @@ -458,20 +459,6 @@ export declare function getShow(S: Show): Show> Added in v2.0.0 -## ~~tree~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.tree` -(where `T` is from `import T from 'fp-ts/Tree'`) - -**Signature** - -```ts -export declare const tree: Monad1<'Tree'> & Foldable1<'Tree'> & Traversable1<'Tree'> & Comonad1<'Tree'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -706,3 +693,19 @@ export declare const extend: (f: (wa: Tree) => B) => (wa: Tree) => T ``` Added in v2.0.0 + +# zone of death + +## ~~tree~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.tree` +(where `T` is from `import T from 'fp-ts/Tree'`) + +**Signature** + +```ts +export declare const tree: Monad1<'Tree'> & Foldable1<'Tree'> & Traversable1<'Tree'> & Comonad1<'Tree'> +``` + +Added in v2.0.0 diff --git a/docs/modules/Tuple.ts.md b/docs/modules/Tuple.ts.md index a70b45140..fbc4528d0 100644 --- a/docs/modules/Tuple.ts.md +++ b/docs/modules/Tuple.ts.md @@ -32,13 +32,11 @@ Added in v2.0.0 - [getChain](#getchain) - [getChainRec](#getchainrec) - [getMonad](#getmonad) - - [~~tuple~~](#tuple) - [mapping](#mapping) - [bimap](#bimap) - [flap](#flap) - [mapFst](#mapfst) - [mapSnd](#mapsnd) - - [~~map~~](#map) - [sequencing](#sequencing) - [sequence](#sequence) - [traverse](#traverse) @@ -51,7 +49,10 @@ Added in v2.0.0 - [fst](#fst) - [snd](#snd) - [swap](#swap) +- [zone of death](#zone-of-death) - [~~mapLeft~~](#mapleft) + - [~~map~~](#map) + - [~~tuple~~](#tuple) --- @@ -223,24 +224,6 @@ export declare function getMonad(M: Monoid): Monad2C Added in v2.0.0 -## ~~tuple~~ - -This instance is deprecated, use small, specific instances instead. -For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.tuple` -(where `T` is from `import T from 'fp-ts/Tuple'`) - -**Signature** - -```ts -export declare const tuple: Semigroupoid2<'Tuple'> & - Bifunctor2<'Tuple'> & - Comonad2<'Tuple'> & - Foldable2<'Tuple'> & - Traversable2<'Tuple'> -``` - -Added in v2.0.0 - # mapping ## bimap @@ -293,18 +276,6 @@ export declare const mapSnd: (f: (e: E) => G) => (fa: [A, E]) => [A, G] Added in v2.10.0 -## ~~map~~ - -Use [`mapFst`](#mapfst) instead. - -**Signature** - -```ts -export declare const map: (f: (a: A) => B) => (fa: [A, E]) => [B, E] -``` - -Added in v2.0.0 - # sequencing ## sequence @@ -401,6 +372,8 @@ export declare const swap: (ea: [A, E]) => [E, A] Added in v2.0.0 +# zone of death + ## ~~mapLeft~~ Use [`mapSnd`](#mapsnd) instead. @@ -412,3 +385,33 @@ export declare const mapLeft: (f: (e: E) => G) => (fa: [A, E]) => [A, G ``` Added in v2.0.0 + +## ~~map~~ + +Use [`mapFst`](#mapfst) instead. + +**Signature** + +```ts +export declare const map: (f: (a: A) => B) => (fa: [A, E]) => [B, E] +``` + +Added in v2.0.0 + +## ~~tuple~~ + +This instance is deprecated, use small, specific instances instead. +For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.tuple` +(where `T` is from `import T from 'fp-ts/Tuple'`) + +**Signature** + +```ts +export declare const tuple: Semigroupoid2<'Tuple'> & + Bifunctor2<'Tuple'> & + Comonad2<'Tuple'> & + Foldable2<'Tuple'> & + Traversable2<'Tuple'> +``` + +Added in v2.0.0 diff --git a/docs/modules/ValidationT.ts.md b/docs/modules/ValidationT.ts.md index 738efbb04..409c0eb62 100644 --- a/docs/modules/ValidationT.ts.md +++ b/docs/modules/ValidationT.ts.md @@ -12,7 +12,7 @@ Added in v2.0.0

Table of contents

-- [utils](#utils) +- [zone of death](#zone-of-death) - [~~ValidationM1~~ (interface)](#validationm1-interface) - [~~ValidationM2~~ (interface)](#validationm2-interface) - [~~ValidationM~~ (interface)](#validationm-interface) @@ -23,7 +23,7 @@ Added in v2.0.0 --- -# utils +# zone of death ## ~~ValidationM1~~ (interface) diff --git a/docs/modules/Writer.ts.md b/docs/modules/Writer.ts.md index 6efe0c623..3094de782 100644 --- a/docs/modules/Writer.ts.md +++ b/docs/modules/Writer.ts.md @@ -21,7 +21,6 @@ Added in v2.0.0 - [getChain](#getchain) - [getMonad](#getmonad) - [getPointed](#getpointed) - - [~~writer~~](#writer) - [mapping](#mapping) - [flap](#flap) - [map](#map) @@ -37,8 +36,10 @@ Added in v2.0.0 - [listen](#listen) - [listens](#listens) - [pass](#pass) +- [zone of death](#zone-of-death) - [~~evalWriter~~](#evalwriter) - [~~execWriter~~](#execwriter) + - [~~writer~~](#writer) --- @@ -118,18 +119,6 @@ export declare const getPointed: (M: Monoid) => Pointed2C<'Writer', W> Added in v2.10.0 -## ~~writer~~ - -Use [`Functor`](#functor) instead. - -**Signature** - -```ts -export declare const writer: Functor2<'Writer'> -``` - -Added in v2.0.0 - # mapping ## flap @@ -261,6 +250,8 @@ export declare const pass: (fa: Writer W]>) => Writer(fa: Writer) => W ``` Added in v2.0.0 + +## ~~writer~~ + +Use [`Functor`](#functor) instead. + +**Signature** + +```ts +export declare const writer: Functor2<'Writer'> +``` + +Added in v2.0.0 diff --git a/docs/modules/function.ts.md b/docs/modules/function.ts.md index bf004c207..f39bc9e8d 100644 --- a/docs/modules/function.ts.md +++ b/docs/modules/function.ts.md @@ -18,7 +18,6 @@ Added in v2.0.0 - [getRing](#getring) - [getSemigroup](#getsemigroup) - [getSemiring](#getsemiring) - - [~~getEndomorphismMonoid~~](#getendomorphismmonoid) - [utils](#utils) - [FunctionN (interface)](#functionn-interface) - [Lazy (interface)](#lazy-interface) @@ -42,9 +41,11 @@ Added in v2.0.0 - [tupled](#tupled) - [unsafeCoerce](#unsafecoerce) - [untupled](#untupled) +- [zone of death](#zone-of-death) - [~~Endomorphism~~ (interface)](#endomorphism-interface) - [~~Predicate~~ (interface)](#predicate-interface) - [~~Refinement~~ (interface)](#refinement-interface) + - [~~getEndomorphismMonoid~~](#getendomorphismmonoid) - [~~not~~](#not) --- @@ -146,18 +147,6 @@ export declare const getSemiring: (S: Semiring) => Semiring<(a: A) => B Added in v2.10.0 -## ~~getEndomorphismMonoid~~ - -Use `Endomorphism` module instead. - -**Signature** - -```ts -export declare const getEndomorphismMonoid: () => Monoid> -``` - -Added in v2.10.0 - # utils ## FunctionN (interface) @@ -758,6 +747,8 @@ export declare function untupled, B>(f: (a: A) Added in v2.4.0 +# zone of death + ## ~~Endomorphism~~ (interface) Use `Endomorphism` module instead. @@ -800,6 +791,18 @@ export interface Refinement { Added in v2.0.0 +## ~~getEndomorphismMonoid~~ + +Use `Endomorphism` module instead. + +**Signature** + +```ts +export declare const getEndomorphismMonoid: () => Monoid> +``` + +Added in v2.10.0 + ## ~~not~~ Use `Predicate` module instead. diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md index a553d2b15..0a2f4a941 100644 --- a/docs/modules/index.ts.md +++ b/docs/modules/index.ts.md @@ -121,7 +121,6 @@ Added in v2.0.0 - [stateT](#statet) - [theseT](#theset) - [writerT](#writert) - - [~~void~~](#void) - [utils](#utils) - [boolean](#boolean) - [console](#console) @@ -137,6 +136,8 @@ Added in v2.0.0 - [random](#random) - [string](#string) - [struct](#struct) +- [zone of death](#zone-of-death) + - [~~void~~](#void) --- @@ -1206,16 +1207,6 @@ export declare const writerT: typeof writerT Added in v2.4.0 -## ~~void~~ - -**Signature** - -```ts -export declare const void: typeof void_ -``` - -Added in v2.11.0 - # utils ## boolean @@ -1357,3 +1348,15 @@ export declare const struct: typeof struct ``` Added in v2.10.0 + +# zone of death + +## ~~void~~ + +**Signature** + +```ts +export declare const void: typeof void_ +``` + +Added in v2.11.0 diff --git a/docs/modules/pipeable.ts.md b/docs/modules/pipeable.ts.md index 4b6435d49..f9f18e035 100644 --- a/docs/modules/pipeable.ts.md +++ b/docs/modules/pipeable.ts.md @@ -39,63 +39,72 @@ Added in v2.0.0 - [reduceRightWithIndex](#reducerightwithindex) - [reduceWithIndex](#reducewithindex) - [utils](#utils) + - [~~PipeableAlt3C~~ (interface)](#pipeablealt3c-interface) + - [~~PipeableApply3C~~ (interface)](#pipeableapply3c-interface) + - [~~PipeableBifunctor3C~~ (interface)](#pipeablebifunctor3c-interface) + - [~~PipeableChain3C~~ (interface)](#pipeablechain3c-interface) + - [~~PipeableCompactable3C~~ (interface)](#pipeablecompactable3c-interface) + - [~~PipeableContravariant3C~~ (interface)](#pipeablecontravariant3c-interface) + - [~~PipeableExtend3C~~ (interface)](#pipeableextend3c-interface) + - [~~PipeableFilterable3C~~ (interface)](#pipeablefilterable3c-interface) + - [~~PipeableFilterableWithIndex3C~~ (interface)](#pipeablefilterablewithindex3c-interface) + - [~~PipeableFoldable3C~~ (interface)](#pipeablefoldable3c-interface) + - [~~PipeableFoldableWithIndex3C~~ (interface)](#pipeablefoldablewithindex3c-interface) + - [~~PipeableFunctor3C~~ (interface)](#pipeablefunctor3c-interface) + - [~~PipeableFunctorWithIndex3C~~ (interface)](#pipeablefunctorwithindex3c-interface) + - [~~PipeableMonadThrow3C~~ (interface)](#pipeablemonadthrow3c-interface) + - [~~PipeableProfunctor3C~~ (interface)](#pipeableprofunctor3c-interface) + - [~~PipeableSemigroupoid3C~~ (interface)](#pipeablesemigroupoid3c-interface) + - [~~pipe~~](#pipe) +- [zone of death](#zone-of-death) - [~~PipeableAlt1~~ (interface)](#pipeablealt1-interface) - [~~PipeableAlt2C~~ (interface)](#pipeablealt2c-interface) - [~~PipeableAlt2~~ (interface)](#pipeablealt2-interface) - - [~~PipeableAlt3C~~ (interface)](#pipeablealt3c-interface) - [~~PipeableAlt3~~ (interface)](#pipeablealt3-interface) - [~~PipeableAlt4~~ (interface)](#pipeablealt4-interface) - [~~PipeableAlt~~ (interface)](#pipeablealt-interface) - [~~PipeableApply1~~ (interface)](#pipeableapply1-interface) - [~~PipeableApply2C~~ (interface)](#pipeableapply2c-interface) - [~~PipeableApply2~~ (interface)](#pipeableapply2-interface) - - [~~PipeableApply3C~~ (interface)](#pipeableapply3c-interface) - [~~PipeableApply3~~ (interface)](#pipeableapply3-interface) - [~~PipeableApply4~~ (interface)](#pipeableapply4-interface) - [~~PipeableApply~~ (interface)](#pipeableapply-interface) - [~~PipeableBifunctor2~~ (interface)](#pipeablebifunctor2-interface) - - [~~PipeableBifunctor3C~~ (interface)](#pipeablebifunctor3c-interface) - [~~PipeableBifunctor3~~ (interface)](#pipeablebifunctor3-interface) - [~~PipeableBifunctor4~~ (interface)](#pipeablebifunctor4-interface) - [~~PipeableBifunctor~~ (interface)](#pipeablebifunctor-interface) - [~~PipeableChain1~~ (interface)](#pipeablechain1-interface) - [~~PipeableChain2C~~ (interface)](#pipeablechain2c-interface) - [~~PipeableChain2~~ (interface)](#pipeablechain2-interface) - - [~~PipeableChain3C~~ (interface)](#pipeablechain3c-interface) - [~~PipeableChain3~~ (interface)](#pipeablechain3-interface) - [~~PipeableChain4~~ (interface)](#pipeablechain4-interface) - [~~PipeableChain~~ (interface)](#pipeablechain-interface) - [~~PipeableCompactable1~~ (interface)](#pipeablecompactable1-interface) - [~~PipeableCompactable2C~~ (interface)](#pipeablecompactable2c-interface) - [~~PipeableCompactable2~~ (interface)](#pipeablecompactable2-interface) - - [~~PipeableCompactable3C~~ (interface)](#pipeablecompactable3c-interface) - [~~PipeableCompactable3~~ (interface)](#pipeablecompactable3-interface) - [~~PipeableCompactable4~~ (interface)](#pipeablecompactable4-interface) - [~~PipeableCompactable~~ (interface)](#pipeablecompactable-interface) - [~~PipeableContravariant1~~ (interface)](#pipeablecontravariant1-interface) - [~~PipeableContravariant2C~~ (interface)](#pipeablecontravariant2c-interface) - [~~PipeableContravariant2~~ (interface)](#pipeablecontravariant2-interface) - - [~~PipeableContravariant3C~~ (interface)](#pipeablecontravariant3c-interface) - [~~PipeableContravariant3~~ (interface)](#pipeablecontravariant3-interface) - [~~PipeableContravariant4~~ (interface)](#pipeablecontravariant4-interface) - [~~PipeableContravariant~~ (interface)](#pipeablecontravariant-interface) - [~~PipeableExtend1~~ (interface)](#pipeableextend1-interface) - [~~PipeableExtend2C~~ (interface)](#pipeableextend2c-interface) - [~~PipeableExtend2~~ (interface)](#pipeableextend2-interface) - - [~~PipeableExtend3C~~ (interface)](#pipeableextend3c-interface) - [~~PipeableExtend3~~ (interface)](#pipeableextend3-interface) - [~~PipeableExtend4~~ (interface)](#pipeableextend4-interface) - [~~PipeableExtend~~ (interface)](#pipeableextend-interface) - [~~PipeableFilterable1~~ (interface)](#pipeablefilterable1-interface) - [~~PipeableFilterable2C~~ (interface)](#pipeablefilterable2c-interface) - [~~PipeableFilterable2~~ (interface)](#pipeablefilterable2-interface) - - [~~PipeableFilterable3C~~ (interface)](#pipeablefilterable3c-interface) - [~~PipeableFilterable3~~ (interface)](#pipeablefilterable3-interface) - [~~PipeableFilterable4~~ (interface)](#pipeablefilterable4-interface) - [~~PipeableFilterableWithIndex1~~ (interface)](#pipeablefilterablewithindex1-interface) - [~~PipeableFilterableWithIndex2C~~ (interface)](#pipeablefilterablewithindex2c-interface) - [~~PipeableFilterableWithIndex2~~ (interface)](#pipeablefilterablewithindex2-interface) - - [~~PipeableFilterableWithIndex3C~~ (interface)](#pipeablefilterablewithindex3c-interface) - [~~PipeableFilterableWithIndex3~~ (interface)](#pipeablefilterablewithindex3-interface) - [~~PipeableFilterableWithIndex4~~ (interface)](#pipeablefilterablewithindex4-interface) - [~~PipeableFilterableWithIndex~~ (interface)](#pipeablefilterablewithindex-interface) @@ -103,13 +112,11 @@ Added in v2.0.0 - [~~PipeableFoldable1~~ (interface)](#pipeablefoldable1-interface) - [~~PipeableFoldable2C~~ (interface)](#pipeablefoldable2c-interface) - [~~PipeableFoldable2~~ (interface)](#pipeablefoldable2-interface) - - [~~PipeableFoldable3C~~ (interface)](#pipeablefoldable3c-interface) - [~~PipeableFoldable3~~ (interface)](#pipeablefoldable3-interface) - [~~PipeableFoldable4~~ (interface)](#pipeablefoldable4-interface) - [~~PipeableFoldableWithIndex1~~ (interface)](#pipeablefoldablewithindex1-interface) - [~~PipeableFoldableWithIndex2C~~ (interface)](#pipeablefoldablewithindex2c-interface) - [~~PipeableFoldableWithIndex2~~ (interface)](#pipeablefoldablewithindex2-interface) - - [~~PipeableFoldableWithIndex3C~~ (interface)](#pipeablefoldablewithindex3c-interface) - [~~PipeableFoldableWithIndex3~~ (interface)](#pipeablefoldablewithindex3-interface) - [~~PipeableFoldableWithIndex4~~ (interface)](#pipeablefoldablewithindex4-interface) - [~~PipeableFoldableWithIndex~~ (interface)](#pipeablefoldablewithindex-interface) @@ -117,13 +124,11 @@ Added in v2.0.0 - [~~PipeableFunctor1~~ (interface)](#pipeablefunctor1-interface) - [~~PipeableFunctor2C~~ (interface)](#pipeablefunctor2c-interface) - [~~PipeableFunctor2~~ (interface)](#pipeablefunctor2-interface) - - [~~PipeableFunctor3C~~ (interface)](#pipeablefunctor3c-interface) - [~~PipeableFunctor3~~ (interface)](#pipeablefunctor3-interface) - [~~PipeableFunctor4~~ (interface)](#pipeablefunctor4-interface) - [~~PipeableFunctorWithIndex1~~ (interface)](#pipeablefunctorwithindex1-interface) - [~~PipeableFunctorWithIndex2C~~ (interface)](#pipeablefunctorwithindex2c-interface) - [~~PipeableFunctorWithIndex2~~ (interface)](#pipeablefunctorwithindex2-interface) - - [~~PipeableFunctorWithIndex3C~~ (interface)](#pipeablefunctorwithindex3c-interface) - [~~PipeableFunctorWithIndex3~~ (interface)](#pipeablefunctorwithindex3-interface) - [~~PipeableFunctorWithIndex4~~ (interface)](#pipeablefunctorwithindex4-interface) - [~~PipeableFunctorWithIndex~~ (interface)](#pipeablefunctorwithindex-interface) @@ -131,24 +136,20 @@ Added in v2.0.0 - [~~PipeableMonadThrow1~~ (interface)](#pipeablemonadthrow1-interface) - [~~PipeableMonadThrow2C~~ (interface)](#pipeablemonadthrow2c-interface) - [~~PipeableMonadThrow2~~ (interface)](#pipeablemonadthrow2-interface) - - [~~PipeableMonadThrow3C~~ (interface)](#pipeablemonadthrow3c-interface) - [~~PipeableMonadThrow3~~ (interface)](#pipeablemonadthrow3-interface) - [~~PipeableMonadThrow4~~ (interface)](#pipeablemonadthrow4-interface) - [~~PipeableMonadThrow~~ (interface)](#pipeablemonadthrow-interface) - [~~PipeableProfunctor2C~~ (interface)](#pipeableprofunctor2c-interface) - [~~PipeableProfunctor2~~ (interface)](#pipeableprofunctor2-interface) - - [~~PipeableProfunctor3C~~ (interface)](#pipeableprofunctor3c-interface) - [~~PipeableProfunctor3~~ (interface)](#pipeableprofunctor3-interface) - [~~PipeableProfunctor4~~ (interface)](#pipeableprofunctor4-interface) - [~~PipeableProfunctor~~ (interface)](#pipeableprofunctor-interface) - [~~PipeableSemigroupoid2C~~ (interface)](#pipeablesemigroupoid2c-interface) - [~~PipeableSemigroupoid2~~ (interface)](#pipeablesemigroupoid2-interface) - - [~~PipeableSemigroupoid3C~~ (interface)](#pipeablesemigroupoid3c-interface) - [~~PipeableSemigroupoid3~~ (interface)](#pipeablesemigroupoid3-interface) - [~~PipeableSemigroupoid4~~ (interface)](#pipeablesemigroupoid4-interface) - [~~PipeableSemigroupoid~~ (interface)](#pipeablesemigroupoid-interface) - [~~pipeable~~](#pipeable) - - [~~pipe~~](#pipe) --- @@ -1032,7 +1033,263 @@ export declare function reduceWithIndex( Added in v2.13.0 -# utils +# utils + +## ~~PipeableAlt3C~~ (interface) + +**Signature** + +```ts +export interface PipeableAlt3C { + readonly alt: (that: Lazy>) => (fa: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableApply3C~~ (interface) + +**Signature** + +```ts +export interface PipeableApply3C extends PipeableFunctor3C { + readonly ap: (fa: Kind3) => (fab: Kind3 B>) => Kind3 + readonly apFirst: (fb: Kind3) => (fa: Kind3) => Kind3 + readonly apSecond: (fb: Kind3) => (fa: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableBifunctor3C~~ (interface) + +**Signature** + +```ts +export interface PipeableBifunctor3C { + readonly bimap: (f: (e: E) => G, g: (a: A) => B) => (fa: Kind3) => Kind3 + readonly mapLeft: (f: (e: E) => G) => (fa: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableChain3C~~ (interface) + +**Signature** + +```ts +export interface PipeableChain3C extends PipeableApply3C { + readonly chain: (f: (a: A) => Kind3) => (ma: Kind3) => Kind3 + readonly chainFirst: (f: (a: A) => Kind3) => (ma: Kind3) => Kind3 + readonly flatten: (mma: Kind3>) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableCompactable3C~~ (interface) + +**Signature** + +```ts +export interface PipeableCompactable3C { + readonly compact: (fa: Kind3>) => Kind3 + readonly separate: (fa: Kind3>) => Separated, Kind3> +} +``` + +Added in v2.2.0 + +## ~~PipeableContravariant3C~~ (interface) + +**Signature** + +```ts +export interface PipeableContravariant3C { + readonly contramap: (f: (b: B) => A) => (fa: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableExtend3C~~ (interface) + +**Signature** + +```ts +export interface PipeableExtend3C extends PipeableFunctor3C { + readonly extend: (f: (wa: Kind3) => B) => (wa: Kind3) => Kind3 + readonly duplicate: (wa: Kind3) => Kind3> +} +``` + +Added in v2.2.0 + +## ~~PipeableFilterable3C~~ (interface) + +**Signature** + +```ts +export interface PipeableFilterable3C extends PipeableCompactable3C { + readonly filter: { + (refinement: Refinement): (fa: Kind3) => Kind3 + (predicate: Predicate): (fa: Kind3) => Kind3 + } + readonly filterMap: (f: (a: A) => Option) => (fa: Kind3) => Kind3 + readonly partition: { + (refinement: Refinement): ( + fa: Kind3 + ) => Separated, Kind3> + (predicate: Predicate): (fa: Kind3) => Separated, Kind3> + } + readonly partitionMap: ( + f: (a: A) => Either + ) => (fa: Kind3) => Separated, Kind3> +} +``` + +Added in v2.2.0 + +## ~~PipeableFilterableWithIndex3C~~ (interface) + +**Signature** + +```ts +export interface PipeableFilterableWithIndex3C extends PipeableFilterable3C { + readonly filterWithIndex: { + (refinementWithIndex: RefinementWithIndex): (fa: Kind3) => Kind3 + (predicateWithIndex: PredicateWithIndex): (fa: Kind3) => Kind3 + } + readonly filterMapWithIndex: (f: (i: I, a: A) => Option) => (fa: Kind3) => Kind3 + readonly partitionWithIndex: { + (refinementWithIndex: RefinementWithIndex): ( + fa: Kind3 + ) => Separated, Kind3> + (predicateWithIndex: PredicateWithIndex): ( + fa: Kind3 + ) => Separated, Kind3> + } + readonly partitionMapWithIndex: ( + f: (i: I, a: A) => Either + ) => (fa: Kind3) => Separated, Kind3> +} +``` + +Added in v2.2.0 + +## ~~PipeableFoldable3C~~ (interface) + +**Signature** + +```ts +export interface PipeableFoldable3C { + readonly reduce: (b: B, f: (b: B, a: A) => B) => (fa: Kind3) => B + readonly foldMap: (M: Monoid) => (f: (a: A) => M) => (fa: Kind3) => M + readonly reduceRight: (b: B, f: (a: A, b: B) => B) => (fa: Kind3) => B +} +``` + +Added in v2.2.0 + +## ~~PipeableFoldableWithIndex3C~~ (interface) + +**Signature** + +```ts +export interface PipeableFoldableWithIndex3C extends PipeableFoldable3C { + readonly reduceWithIndex: (b: B, f: (i: I, b: B, a: A) => B) => (fa: Kind3) => B + readonly foldMapWithIndex: (M: Monoid) => (f: (i: I, a: A) => M) => (fa: Kind3) => M + readonly reduceRightWithIndex: (b: B, f: (i: I, a: A, b: B) => B) => (fa: Kind3) => B +} +``` + +Added in v2.2.0 + +## ~~PipeableFunctor3C~~ (interface) + +**Signature** + +```ts +export interface PipeableFunctor3C { + readonly map: (f: (a: A) => B) => (fa: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableFunctorWithIndex3C~~ (interface) + +**Signature** + +```ts +export interface PipeableFunctorWithIndex3C extends PipeableFunctor3C { + readonly mapWithIndex: (f: (i: I, a: A) => B) => (fa: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableMonadThrow3C~~ (interface) + +**Signature** + +```ts +export interface PipeableMonadThrow3C { + readonly fromOption: (onNone: Lazy) => (ma: Option) => Kind3 + readonly fromEither: (ma: Either) => Kind3 + readonly fromPredicate: { + (refinement: Refinement, onFalse: (a: A) => E): (a: A) => Kind3 + (predicate: Predicate, onFalse: (a: A) => E): (a: A) => Kind3 + } + readonly filterOrElse: { + (refinement: Refinement, onFalse: (a: A) => E): ( + ma: Kind3 + ) => Kind3 + (predicate: Predicate, onFalse: (a: A) => E): (ma: Kind3) => Kind3 + } +} +``` + +Added in v2.2.0 + +## ~~PipeableProfunctor3C~~ (interface) + +**Signature** + +```ts +export interface PipeableProfunctor3C extends PipeableFunctor3C { + readonly promap: (f: (d: D) => E, g: (a: A) => B) => (fbc: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~PipeableSemigroupoid3C~~ (interface) + +**Signature** + +```ts +export interface PipeableSemigroupoid3C { + readonly compose: (la: Kind3) => (ab: Kind3) => Kind3 +} +``` + +Added in v2.2.0 + +## ~~pipe~~ + +Use [`pipe`](https://gcanti.github.io/fp-ts/modules/function.ts.html#pipe) from `function` module instead. + +**Signature** + +```ts +export declare const pipe: typeof pipeFromFunctionModule +``` + +Added in v2.0.0 + +# zone of death ## ~~PipeableAlt1~~ (interface) @@ -1070,18 +1327,6 @@ export interface PipeableAlt2 { Added in v2.0.0 -## ~~PipeableAlt3C~~ (interface) - -**Signature** - -```ts -export interface PipeableAlt3C { - readonly alt: (that: Lazy>) => (fa: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableAlt3~~ (interface) **Signature** @@ -1160,20 +1405,6 @@ export interface PipeableApply2 extends PipeableFunctor2 { Added in v2.0.0 -## ~~PipeableApply3C~~ (interface) - -**Signature** - -```ts -export interface PipeableApply3C extends PipeableFunctor3C { - readonly ap: (fa: Kind3) => (fab: Kind3 B>) => Kind3 - readonly apFirst: (fb: Kind3) => (fa: Kind3) => Kind3 - readonly apSecond: (fb: Kind3) => (fa: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableApply3~~ (interface) **Signature** @@ -1231,19 +1462,6 @@ export interface PipeableBifunctor2 { Added in v2.0.0 -## ~~PipeableBifunctor3C~~ (interface) - -**Signature** - -```ts -export interface PipeableBifunctor3C { - readonly bimap: (f: (e: E) => G, g: (a: A) => B) => (fa: Kind3) => Kind3 - readonly mapLeft: (f: (e: E) => G) => (fa: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableBifunctor3~~ (interface) **Signature** @@ -1328,20 +1546,6 @@ export interface PipeableChain2 extends PipeableApply2 { Added in v2.0.0 -## ~~PipeableChain3C~~ (interface) - -**Signature** - -```ts -export interface PipeableChain3C extends PipeableApply3C { - readonly chain: (f: (a: A) => Kind3) => (ma: Kind3) => Kind3 - readonly chainFirst: (f: (a: A) => Kind3) => (ma: Kind3) => Kind3 - readonly flatten: (mma: Kind3>) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableChain3~~ (interface) **Signature** @@ -1427,19 +1631,6 @@ export interface PipeableCompactable2 { Added in v2.0.0 -## ~~PipeableCompactable3C~~ (interface) - -**Signature** - -```ts -export interface PipeableCompactable3C { - readonly compact: (fa: Kind3>) => Kind3 - readonly separate: (fa: Kind3>) => Separated, Kind3> -} -``` - -Added in v2.2.0 - ## ~~PipeableCompactable3~~ (interface) **Signature** @@ -1517,18 +1708,6 @@ export interface PipeableContravariant2 { Added in v2.0.0 -## ~~PipeableContravariant3C~~ (interface) - -**Signature** - -```ts -export interface PipeableContravariant3C { - readonly contramap: (f: (b: B) => A) => (fa: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableContravariant3~~ (interface) **Signature** @@ -1604,19 +1783,6 @@ export interface PipeableExtend2 extends PipeableFunctor2 { Added in v2.0.0 -## ~~PipeableExtend3C~~ (interface) - -**Signature** - -```ts -export interface PipeableExtend3C extends PipeableFunctor3C { - readonly extend: (f: (wa: Kind3) => B) => (wa: Kind3) => Kind3 - readonly duplicate: (wa: Kind3) => Kind3> -} -``` - -Added in v2.2.0 - ## ~~PipeableExtend3~~ (interface) **Signature** @@ -1725,31 +1891,6 @@ export interface PipeableFilterable2 extends PipeableCompactabl Added in v2.0.0 -## ~~PipeableFilterable3C~~ (interface) - -**Signature** - -```ts -export interface PipeableFilterable3C extends PipeableCompactable3C { - readonly filter: { - (refinement: Refinement): (fa: Kind3) => Kind3 - (predicate: Predicate): (fa: Kind3) => Kind3 - } - readonly filterMap: (f: (a: A) => Option) => (fa: Kind3) => Kind3 - readonly partition: { - (refinement: Refinement): ( - fa: Kind3 - ) => Separated, Kind3> - (predicate: Predicate): (fa: Kind3) => Separated, Kind3> - } - readonly partitionMap: ( - f: (a: A) => Either - ) => (fa: Kind3) => Separated, Kind3> -} -``` - -Added in v2.2.0 - ## ~~PipeableFilterable3~~ (interface) **Signature** @@ -1879,33 +2020,6 @@ export interface PipeableFilterableWithIndex2 extends Pipeab Added in v2.0.0 -## ~~PipeableFilterableWithIndex3C~~ (interface) - -**Signature** - -```ts -export interface PipeableFilterableWithIndex3C extends PipeableFilterable3C { - readonly filterWithIndex: { - (refinementWithIndex: RefinementWithIndex): (fa: Kind3) => Kind3 - (predicateWithIndex: PredicateWithIndex): (fa: Kind3) => Kind3 - } - readonly filterMapWithIndex: (f: (i: I, a: A) => Option) => (fa: Kind3) => Kind3 - readonly partitionWithIndex: { - (refinementWithIndex: RefinementWithIndex): ( - fa: Kind3 - ) => Separated, Kind3> - (predicateWithIndex: PredicateWithIndex): ( - fa: Kind3 - ) => Separated, Kind3> - } - readonly partitionMapWithIndex: ( - f: (i: I, a: A) => Either - ) => (fa: Kind3) => Separated, Kind3> -} -``` - -Added in v2.2.0 - ## ~~PipeableFilterableWithIndex3~~ (interface) **Signature** @@ -2056,20 +2170,6 @@ export interface PipeableFoldable2 { Added in v2.0.0 -## ~~PipeableFoldable3C~~ (interface) - -**Signature** - -```ts -export interface PipeableFoldable3C { - readonly reduce: (b: B, f: (b: B, a: A) => B) => (fa: Kind3) => B - readonly foldMap: (M: Monoid) => (f: (a: A) => M) => (fa: Kind3) => M - readonly reduceRight: (b: B, f: (a: A, b: B) => B) => (fa: Kind3) => B -} -``` - -Added in v2.2.0 - ## ~~PipeableFoldable3~~ (interface) **Signature** @@ -2140,20 +2240,6 @@ export interface PipeableFoldableWithIndex2 extends Pipeable Added in v2.0.0 -## ~~PipeableFoldableWithIndex3C~~ (interface) - -**Signature** - -```ts -export interface PipeableFoldableWithIndex3C extends PipeableFoldable3C { - readonly reduceWithIndex: (b: B, f: (i: I, b: B, a: A) => B) => (fa: Kind3) => B - readonly foldMapWithIndex: (M: Monoid) => (f: (i: I, a: A) => M) => (fa: Kind3) => M - readonly reduceRightWithIndex: (b: B, f: (i: I, a: A, b: B) => B) => (fa: Kind3) => B -} -``` - -Added in v2.2.0 - ## ~~PipeableFoldableWithIndex3~~ (interface) **Signature** @@ -2246,18 +2332,6 @@ export interface PipeableFunctor2 { Added in v2.0.0 -## ~~PipeableFunctor3C~~ (interface) - -**Signature** - -```ts -export interface PipeableFunctor3C { - readonly map: (f: (a: A) => B) => (fa: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableFunctor3~~ (interface) **Signature** @@ -2318,18 +2392,6 @@ export interface PipeableFunctorWithIndex2 extends PipeableF Added in v2.0.0 -## ~~PipeableFunctorWithIndex3C~~ (interface) - -**Signature** - -```ts -export interface PipeableFunctorWithIndex3C extends PipeableFunctor3C { - readonly mapWithIndex: (f: (i: I, a: A) => B) => (fa: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableFunctorWithIndex3~~ (interface) **Signature** @@ -2441,29 +2503,6 @@ export interface PipeableMonadThrow2 { Added in v2.0.0 -## ~~PipeableMonadThrow3C~~ (interface) - -**Signature** - -```ts -export interface PipeableMonadThrow3C { - readonly fromOption: (onNone: Lazy) => (ma: Option) => Kind3 - readonly fromEither: (ma: Either) => Kind3 - readonly fromPredicate: { - (refinement: Refinement, onFalse: (a: A) => E): (a: A) => Kind3 - (predicate: Predicate, onFalse: (a: A) => E): (a: A) => Kind3 - } - readonly filterOrElse: { - (refinement: Refinement, onFalse: (a: A) => E): ( - ma: Kind3 - ) => Kind3 - (predicate: Predicate, onFalse: (a: A) => E): (ma: Kind3) => Kind3 - } -} -``` - -Added in v2.2.0 - ## ~~PipeableMonadThrow3~~ (interface) **Signature** @@ -2555,18 +2594,6 @@ export interface PipeableProfunctor2 extends PipeableFunctor2 extends PipeableFunctor3C { - readonly promap: (f: (d: D) => E, g: (a: A) => B) => (fbc: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableProfunctor3~~ (interface) **Signature** @@ -2630,18 +2657,6 @@ export interface PipeableSemigroupoid2 { Added in v2.0.0 -## ~~PipeableSemigroupoid3C~~ (interface) - -**Signature** - -```ts -export interface PipeableSemigroupoid3C { - readonly compose: (la: Kind3) => (ab: Kind3) => Kind3 -} -``` - -Added in v2.2.0 - ## ~~PipeableSemigroupoid3~~ (interface) **Signature** @@ -2885,15 +2900,3 @@ export declare function pipeable( ``` Added in v2.0.0 - -## ~~pipe~~ - -Use [`pipe`](https://gcanti.github.io/fp-ts/modules/function.ts.html#pipe) from `function` module instead. - -**Signature** - -```ts -export declare const pipe: typeof pipeFromFunctionModule -``` - -Added in v2.0.0 diff --git a/src/Applicative.ts b/src/Applicative.ts index 33b069151..cbcc8b293 100644 --- a/src/Applicative.ts +++ b/src/Applicative.ts @@ -122,6 +122,7 @@ export function getApplicativeMonoid(F: Applicative): (M: Monoid) => // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -131,6 +132,7 @@ export interface ApplicativeComposition extends FunctorComposition { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -140,6 +142,7 @@ export interface ApplicativeCompositionHKT1 extends FunctorCo } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -149,6 +152,7 @@ export interface ApplicativeCompositionHKT2 extends FunctorC } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -158,6 +162,7 @@ export interface ApplicativeCompositionHKT2C extends Func } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -167,6 +172,7 @@ export interface ApplicativeComposition11 extend } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -179,6 +185,7 @@ export interface ApplicativeComposition12 exten } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -188,6 +195,7 @@ export interface ApplicativeComposition12C e } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -200,6 +208,7 @@ export interface ApplicativeComposition21 exten } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -209,6 +218,7 @@ export interface ApplicativeComposition2C1 e } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -221,6 +231,7 @@ export interface ApplicativeComposition22 exte } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -235,6 +246,7 @@ export interface ApplicativeComposition22C /** * Use [`ap`](./Apply.ts.html#ap) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Array.ts b/src/Array.ts index 5323e07aa..ad244a083 100644 --- a/src/Array.ts +++ b/src/Array.ts @@ -2908,7 +2908,7 @@ export const apS = /*#__PURE__*/ apS_(Apply) /** * Use `NonEmptyArray` module instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2917,6 +2917,7 @@ export const range = NEA.range /** * Use a new `[]` instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2925,7 +2926,7 @@ export const empty: Array = [] /** * Use `prepend` instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2934,7 +2935,7 @@ export const cons = NEA.cons /** * Use `append` instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2943,6 +2944,7 @@ export const snoc = NEA.snoc /** * Use `prependAll` instead * + * @category zone of death * @since 2.9.0 * @deprecated */ @@ -2953,7 +2955,7 @@ export const prependToAll = prependAll * 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'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/BooleanAlgebra.ts b/src/BooleanAlgebra.ts index c5b1b2f02..bf42341d5 100644 --- a/src/BooleanAlgebra.ts +++ b/src/BooleanAlgebra.ts @@ -65,6 +65,7 @@ export const booleanAlgebraVoid: BooleanAlgebra = { /** * Use [`reverse`](#reverse) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -73,7 +74,7 @@ export const getDualBooleanAlgebra = reverse /** * Use [`BooleanAlgebra`](./boolean.ts.html#booleanalgebra) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -89,7 +90,7 @@ export const booleanAlgebraBoolean: BooleanAlgebra = { /** * Use [`getBooleanAlgebra`](./function.ts.html#getbooleanalgebra) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Bounded.ts b/src/Bounded.ts index 929050142..ed468de23 100644 --- a/src/Bounded.ts +++ b/src/Bounded.ts @@ -59,7 +59,7 @@ export const reverse = (B: Bounded): Bounded => { /** * Use [`Bounded`](./number.ts.html#bounded) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Choice.ts b/src/Choice.ts index f0c6365d6..79798bd94 100644 --- a/src/Choice.ts +++ b/src/Choice.ts @@ -173,6 +173,7 @@ export function fanIn

( /** * Use [`split`](#split) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Compactable.ts b/src/Compactable.ts index 79f7fa2dc..8b2f63456 100644 --- a/src/Compactable.ts +++ b/src/Compactable.ts @@ -189,30 +189,30 @@ export function separate( // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition extends FunctorComposition { readonly compact: (fga: HKT>>) => HKT> readonly separate: (fge: HKT>>) => Separated>, HKT>> } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition11 extends FunctorComposition11 { readonly compact: (fga: Kind>>) => Kind> readonly separate: (fge: Kind>>) => Separated>, Kind>> } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition12 extends FunctorComposition12 { readonly compact: (fga: Kind>>) => Kind> readonly separate: ( @@ -221,10 +221,10 @@ export interface CompactableComposition12 exten } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition12C extends FunctorComposition12C { readonly compact: (fga: Kind>>) => Kind> readonly separate: ( @@ -233,10 +233,10 @@ export interface CompactableComposition12C e } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition21 extends FunctorComposition21 { readonly compact: (fga: Kind2>>) => Kind2> readonly separate: ( @@ -245,10 +245,10 @@ export interface CompactableComposition21 exten } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition2C1 extends FunctorComposition2C1 { readonly compact: (fga: Kind2>>) => Kind2> readonly separate: ( @@ -257,10 +257,10 @@ export interface CompactableComposition2C1 e } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition22 extends FunctorComposition22 { readonly compact: (fga: Kind2>>) => Kind2> readonly separate: ( @@ -269,10 +269,10 @@ export interface CompactableComposition22 exte } /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface CompactableComposition22C extends FunctorComposition22C { readonly compact: (fga: Kind2>>) => Kind2> readonly separate: ( @@ -281,10 +281,10 @@ export interface CompactableComposition22C } /** + * @category zone of death * @since 2.2.0 * @deprecated */ - export interface CompactableComposition23 extends FunctorComposition23 { readonly compact: (fga: Kind2>>) => Kind2> readonly separate: ( @@ -293,10 +293,10 @@ export interface CompactableComposition23 exte } /** + * @category zone of death * @since 2.2.0 * @deprecated */ - export interface CompactableComposition23C extends FunctorComposition23C { readonly compact: (fga: Kind2>>) => Kind2> readonly separate: ( @@ -307,6 +307,7 @@ export interface CompactableComposition23C /** * Use [`compact`](#compact) and [`separate`](#separate) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Const.ts b/src/Const.ts index 0c3b222b9..abceaa723 100644 --- a/src/Const.ts +++ b/src/Const.ts @@ -233,7 +233,7 @@ export const Bifunctor: Bifunctor2 = { * For example if a function needs a `Functor` instance, pass `C.Functor` instead of `C.const_` * (where `C` is from `import C from 'fp-ts/Const'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Either.ts b/src/Either.ts index eebc648c7..4993d9968 100644 --- a/src/Either.ts +++ b/src/Either.ts @@ -1578,6 +1578,7 @@ export const sequenceArray: (as: ReadonlyArray>) => Either {} /** * Use [`parse`](./Json.ts.html#parse) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1615,7 +1618,7 @@ export function parseJSON(s: string, onError: (reason: unknown) => E): Either /** * Use [`stringify`](./Json.ts.html#stringify) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1633,7 +1636,7 @@ export const stringifyJSON = (u: unknown, onError: (reason: unknown) => E): E * For example if a function needs a `Functor` instance, pass `E.Functor` instead of `E.either` * (where `E` is from `import E from 'fp-ts/Either'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1669,7 +1672,7 @@ export const either: Monad2 & * Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values * are concatenated using the provided `Semigroup` * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1679,7 +1682,7 @@ export const getApplySemigroup: (S: Semigroup) => Semigroup(M: Monoid) => Monoid> = /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1699,7 +1702,7 @@ export const getValidationSemigroup = (SE: Semigroup, SA: Semigroup) /** * Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1709,7 +1712,7 @@ export const getValidationMonoid = (SE: Semigroup, MA: Monoid): Mono /** * Use [`getApplicativeValidation`](#getapplicativevalidation) and [`getAltValidation`](#getaltvalidation) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/EitherT.ts b/src/EitherT.ts index 5a21552e6..77473c219 100644 --- a/src/EitherT.ts +++ b/src/EitherT.ts @@ -731,13 +731,14 @@ export function toUnion(F: Functor): (fa: HKT>) => H import URI = E.URI /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ export interface EitherT extends HKT> {} /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -756,13 +757,14 @@ export interface EitherM extends ApplicativeCompositionHKT2 { } /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ export type EitherT1 = Kind> /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -785,17 +787,17 @@ export interface EitherM1 extends ApplicativeComposition12 = Kind2> /** + * @category zone of death * @since 2.0.0 * @deprecated */ - export interface EitherM2 extends ApplicativeComposition22 { readonly chain: (ma: EitherT2, f: (a: A) => EitherT2) => EitherT2 readonly alt: (fa: EitherT2, that: Lazy>) => EitherT2 @@ -818,6 +820,7 @@ export interface EitherM2 extends ApplicativeComposition22 = { /** * Use [`tuple`](#tuple) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -205,6 +206,7 @@ export const getTupleEq: >>( /** * Use [`struct`](#struct) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -213,6 +215,7 @@ export const getStructEq: >(eqs: { [K in k /** * Use [`eqStrict`](#eqstrict) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -223,7 +226,7 @@ export const strictEqual: (a: A, b: A) => boolean = eqStrict.equals * For example if a function needs a `Contravariant` instance, pass `E.Contravariant` instead of `E.eq` * (where `E` is from `import E from 'fp-ts/Eq'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -232,7 +235,7 @@ export const eq: Contravariant1 = Contravariant /** * Use [`Eq`](./boolean.ts.html#eq) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -241,7 +244,7 @@ export const eqBoolean: Eq = eqStrict /** * Use [`Eq`](./string.ts.html#eq) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -250,7 +253,7 @@ export const eqString: Eq = eqStrict /** * Use [`Eq`](./number.ts.html#eq) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -259,7 +262,7 @@ export const eqNumber: Eq = eqStrict /** * Use [`Eq`](./Date.ts.html#eq) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Field.ts b/src/Field.ts index 9b530e305..ba5e5aeee 100644 --- a/src/Field.ts +++ b/src/Field.ts @@ -53,7 +53,7 @@ export function lcm(E: Eq, F: Field): (x: A, y: A) => A { /** * Use [`Field`](./number.ts.html#field) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Filterable.ts b/src/Filterable.ts index e81fc34cd..b482a8d20 100644 --- a/src/Filterable.ts +++ b/src/Filterable.ts @@ -470,6 +470,7 @@ export function partitionMap( // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -487,6 +488,7 @@ export interface FilterableComposition extends FunctorComposition, C } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -506,6 +508,7 @@ export interface FilterableComposition11 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -525,6 +528,7 @@ export interface FilterableComposition12 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -544,6 +548,7 @@ export interface FilterableComposition12C } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -563,6 +568,7 @@ export interface FilterableComposition21 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -582,6 +588,7 @@ export interface FilterableComposition2C1 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -607,6 +614,7 @@ export interface FilterableComposition22 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -629,6 +637,7 @@ export interface FilterableComposition22C } /** + * @category zone of death * @since 2.2.0 * @deprecated */ @@ -663,6 +672,7 @@ export interface FilterableComposition23C * * instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Foldable.ts b/src/Foldable.ts index f2d9e7e60..5cb356151 100644 --- a/src/Foldable.ts +++ b/src/Foldable.ts @@ -329,6 +329,7 @@ export function traverse_( /** * Use [`reduceM`](#reducem) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -371,13 +372,14 @@ export function foldM( /** * Use [`toReadonlyArray`](#toreadonlyarray) instead * - * @category conversions + * @category zone of death * @since 2.8.0 * @deprecated */ export const toArray = toReadonlyArray /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -388,6 +390,7 @@ export interface FoldableComposition { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -398,6 +401,7 @@ export interface FoldableComposition11 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -408,6 +412,7 @@ export interface FoldableComposition12 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -418,6 +423,7 @@ export interface FoldableComposition12C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -428,6 +434,7 @@ export interface FoldableComposition21 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -438,6 +445,7 @@ export interface FoldableComposition2C1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -448,6 +456,7 @@ export interface FoldableComposition22 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -466,6 +475,7 @@ export interface FoldableComposition22C { * * instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/FoldableWithIndex.ts b/src/FoldableWithIndex.ts index ca5da06b2..fbb551035 100644 --- a/src/FoldableWithIndex.ts +++ b/src/FoldableWithIndex.ts @@ -181,6 +181,7 @@ export function reduceRightWithIndex( // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -191,6 +192,7 @@ export interface FoldableWithIndexComposition extends FoldableComp } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -202,6 +204,7 @@ export interface FoldableWithIndexComposition11 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -272,6 +274,7 @@ export interface FunctorCompositionHKT1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -280,6 +283,7 @@ export interface FunctorCompositionHKT2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -288,6 +292,7 @@ export interface FunctorCompositionHKT2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -296,6 +301,7 @@ export interface FunctorComposition11 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -304,6 +310,7 @@ export interface FunctorComposition12 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -312,6 +319,7 @@ export interface FunctorComposition12C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -320,6 +328,7 @@ export interface FunctorComposition21 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -328,6 +337,7 @@ export interface FunctorComposition2C1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -336,6 +346,7 @@ export interface FunctorComposition22 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -344,6 +355,7 @@ export interface FunctorComposition22C { } /** + * @category zone of death * @since 2.2.0 * @deprecated */ @@ -352,6 +364,7 @@ export interface FunctorComposition23 { } /** + * @category zone of death * @since 2.2.0 * @deprecated */ @@ -362,6 +375,7 @@ export interface FunctorComposition23C { /** * Use [`map`](#map) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/FunctorWithIndex.ts b/src/FunctorWithIndex.ts index c7940255f..c3720129e 100644 --- a/src/FunctorWithIndex.ts +++ b/src/FunctorWithIndex.ts @@ -121,6 +121,7 @@ export function mapWithIndex( // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -129,6 +130,7 @@ export interface FunctorWithIndexComposition extends FunctorCompos } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -138,6 +140,7 @@ export interface FunctorWithIndexComposition11 = { export const chainFirst: (f: (a: A) => IO) => (first: IO) => IO = /*#__PURE__*/ chainFirst_(Chain) /** - * @category conversions + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -344,7 +344,7 @@ export const sequenceArray: (arr: ReadonlyArray>) => IO & MonadIO1 & ChainRec1 = { /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -370,7 +370,7 @@ export const getSemigroup: (S: Semigroup) => Semigroup> = /*#__PURE_ /** * Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/IOEither.ts b/src/IOEither.ts index 00164c660..ce24b5ca9 100644 --- a/src/IOEither.ts +++ b/src/IOEither.ts @@ -1073,8 +1073,8 @@ export const sequenceSeqArray: (arr: ReadonlyArray>) => IOE /** * Use [`ApplicativePar`](#applicativepar) instead * + * @category zone of death * @since 2.7.0 - * @category instances * @deprecated */ export const Applicative: Applicative2 = ApplicativePar @@ -1088,7 +1088,7 @@ export const Applicative: Applicative2 = ApplicativePar * For example if a function needs a `Functor` instance, pass `IOE.Functor` instead of `IOE.ioEither` * (where `IOE` is from `import IOE from 'fp-ts/IOEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1108,7 +1108,7 @@ export const ioEither: Monad2 & Bifunctor2 & Alt2 & MonadIO2 /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1118,7 +1118,7 @@ export const getApplySemigroup: (S: Semigroup) => Semigroup(M: Monoid) => Monoid> = /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1138,7 +1138,7 @@ export const getSemigroup = (S: Semigroup): Semigroup> = /** * Use [`getApplicativeIOValidation`](#getapplicativeiovalidation) and [`getAltIOValidation`](#getaltiovalidation). * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Identity.ts b/src/Identity.ts index c03c0af77..3e2df44f7 100644 --- a/src/Identity.ts +++ b/src/Identity.ts @@ -385,7 +385,7 @@ export const apS = /*#__PURE__*/ apS_(Apply) * For example if a function needs a `Functor` instance, pass `I.Functor` instead of `I.identity` * (where `I` is from `import I from 'fp-ts/Identity'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Map.ts b/src/Map.ts index 51fa6d5a7..5632057b7 100644 --- a/src/Map.ts +++ b/src/Map.ts @@ -902,6 +902,7 @@ export const difference = (E: Eq): ((_second: Map) => (first: Map /** * Use a `new Map()` instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -910,6 +911,7 @@ export const empty = new Map() /** * Use [`upsertAt`](#upsertat) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -918,7 +920,7 @@ export const insertAt: (E: Eq) => (k: K, a: A) => (m: Map) => Map /** * Use [`Filterable`](#filterable) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Monoid.ts b/src/Monoid.ts index b532ebc1c..48389cb06 100644 --- a/src/Monoid.ts +++ b/src/Monoid.ts @@ -202,7 +202,7 @@ export const concatAll = (M: Monoid): ((as: ReadonlyArray) => A) => Se. /** * Use [`Monoid`](./void.ts.html#monoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -214,6 +214,7 @@ export const monoidVoid: Monoid = { /** * Use [`tuple`](#tuple) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -224,6 +225,7 @@ export const getTupleMonoid: >>( /** * Use [`struct`](#struct) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -234,6 +236,7 @@ export const getStructMonoid: >(monoids: { /** * Use [`reverse`](#reverse) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -242,7 +245,7 @@ export const getDualMonoid = reverse /** * Use [`max`](#max) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -251,7 +254,7 @@ export const getJoinMonoid = max /** * Use [`min`](#min) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -260,6 +263,7 @@ export const getMeetMonoid = min /** * Use [`concatAll`](#concatall) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -268,7 +272,7 @@ export const fold = concatAll /** * Use [`MonoidAll`](./boolean.ts.html#monoidall) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -280,7 +284,7 @@ export const monoidAll: Monoid = { /** * Use [`MonoidAny`](./boolean.ts.html#monoidany) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -292,7 +296,7 @@ export const monoidAny: Monoid = { /** * Use [`getMonoid`](./function.ts.html#getmonoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -303,7 +307,7 @@ export const getFunctionMonoid: (M: Monoid) => () => Monoid<(a: * * **Note**. The execution order in [`getEndomorphismMonoid`](./function.ts.html#getendomorphismmonoid) is reversed. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -312,7 +316,7 @@ export const getEndomorphismMonoid = (): Monoid> => r /** * Use [`Monoid`](./string.ts.html#monoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -324,7 +328,7 @@ export const monoidString: Monoid = { /** * Use [`MonoidSum`](./number.ts.html#monoidsum) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -336,7 +340,7 @@ export const monoidSum: Monoid = { /** * Use [`MonoidProduct`](./number.ts.html#monoidproduct) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/NonEmptyArray.ts b/src/NonEmptyArray.ts index 8ddca6e27..eb366b2da 100644 --- a/src/NonEmptyArray.ts +++ b/src/NonEmptyArray.ts @@ -1252,6 +1252,7 @@ export const intercalate: (S: Semigroup) => (middle: A) => (as: NonEmptyAr /** * This is just `sort` followed by `group`. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1268,6 +1269,7 @@ export function groupSort(O: Ord): (as: Array) => Array(predicate: Predicate): (as: NonEmptyArray) => Op /** * Use [`filterWithIndex`](./Array.ts.html#filterwithindex) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1292,6 +1295,7 @@ export const filterWithIndex = /** * Use [`unprepend`](#unprepend) instead. * + * @category zone of death * @since 2.9.0 * @deprecated */ @@ -1300,6 +1304,7 @@ export const uncons: (as: NonEmptyArray) => [A, Array] = unprepend /** * Use [`unappend`](#unappend) instead. * + * @category zone of death * @since 2.9.0 * @deprecated */ @@ -1308,7 +1313,7 @@ export const unsnoc: (as: NonEmptyArray) => [Array, A] = unappend /** * Use [`prepend`](./Array.ts.html#prepend) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1322,7 +1327,7 @@ export function cons(head: A, tail?: Array): NonEmptyArray | ((tail: Ar /** * Use [`append`](./Array.ts.html#append) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1331,6 +1336,7 @@ export const snoc = (init: Array, end: A): NonEmptyArray => pipe(init, /** * Use [`prependAll`](#prependall) instead. * + * @category zone of death * @since 2.9.0 * @deprecated */ @@ -1339,6 +1345,7 @@ export const prependToAll = prependAll /** * Use [`concatAll`](#concatall) instead. * + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -1349,7 +1356,7 @@ export const fold: (S: Semigroup) => (fa: NonEmptyArray) => A = RNEA.co * For example if a function needs a `Functor` instance, pass `NEA.Functor` instead of `NEA.nonEmptyArray` * (where `NEA` is from `import NEA from 'fp-ts/NonEmptyArray'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Option.ts b/src/Option.ts index 9a26524fd..30470f399 100644 --- a/src/Option.ts +++ b/src/Option.ts @@ -1327,6 +1327,7 @@ export const sequenceArray: (arr: ReadonlyArray>) => Option(getOption: (a: A) => Option): R /** * Use [`chainNullableK`](#chainnullablek) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1347,7 +1349,7 @@ export const mapNullable = chainNullableK * For example if a function needs a `Functor` instance, pass `O.Functor` instead of `O.option` * (where `O` is from `import O from 'fp-ts/Option'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1384,7 +1386,7 @@ export const option: Monad1 & /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1393,7 +1395,7 @@ export const getApplySemigroup: (S: Semigroup) => Semigroup> = / /** * Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1429,7 +1431,7 @@ export const getApplyMonoid: (M: Monoid) => Monoid> = /*#__PURE_ * assert.deepStrictEqual(M.concat(none, some(2)), some(2)) * assert.deepStrictEqual(M.concat(some(1), some(2)), some(1)) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1465,7 +1467,7 @@ export const getFirstMonoid = (): Monoid> => getMonoid(firs * assert.deepStrictEqual(M.concat(none, some(2)), some(2)) * assert.deepStrictEqual(M.concat(some(1), some(2)), some(2)) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/OptionT.ts b/src/OptionT.ts index 10d796e3c..2705ad574 100644 --- a/src/OptionT.ts +++ b/src/OptionT.ts @@ -557,13 +557,14 @@ export function alt( // ------------------------------------------------------------------------------------- /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ export interface OptionT extends HKT> {} /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -577,13 +578,14 @@ export interface OptionM extends ApplicativeCompositionHKT1 { } /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ export type OptionT1 = Kind> /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -597,13 +599,14 @@ export interface OptionM1 extends ApplicativeComposition11 = Kind2> /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -621,6 +624,7 @@ export interface OptionM2 extends ApplicativeComposition21 extends ApplicativeComposition2C1 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Ord.ts b/src/Ord.ts index 728e0b147..002c90cb3 100644 --- a/src/Ord.ts +++ b/src/Ord.ts @@ -414,6 +414,7 @@ export const between = (O: Ord): ((low: A, hi: A) => (a: A) => boolean) => /** * Use [`tuple`](#tuple) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -424,6 +425,7 @@ export const getTupleOrd: >>( /** * Use [`reverse`](#reverse) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -432,7 +434,7 @@ export const getDualOrd = reverse /** * Use [`Contravariant`](#contravariant) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -451,7 +453,7 @@ const strictOrd = { /** * Use [`Ord`](./boolean.ts.html#ord) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -460,7 +462,7 @@ export const ordBoolean: Ord = strictOrd /** * Use [`Ord`](./string.ts.html#ord) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -469,7 +471,7 @@ export const ordString: Ord = strictOrd /** * Use [`Ord`](./number.ts.html#ord) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -478,7 +480,7 @@ export const ordNumber: Ord = strictOrd /** * Use [`Ord`](./Date.ts.html#ord) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Ordering.ts b/src/Ordering.ts index 6b01867ad..9f2540e8c 100644 --- a/src/Ordering.ts +++ b/src/Ordering.ts @@ -88,6 +88,7 @@ export const sign = (n: number): Ordering => (n <= -1 ? -1 : n >= 1 ? 1 : 0) /** * Use [`reverse`](#reverse) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -96,7 +97,7 @@ export const invert = reverse /** * Use [`Semigroup`](#semigroup) instead * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -105,7 +106,7 @@ export const semigroupOrdering: S.Semigroup = Semigroup /** * Use [`Eq`](#eq) instead * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -114,7 +115,7 @@ export const eqOrdering: E.Eq = Eq /** * Use [`Monoid`](#monoid) instead * - * @category instances + * @category zone of death * @since 2.4.0 * @deprecated */ diff --git a/src/Reader.ts b/src/Reader.ts index d9b5a9c52..570090ea5 100644 --- a/src/Reader.ts +++ b/src/Reader.ts @@ -592,7 +592,7 @@ export const sequenceArray: (arr: ReadonlyArray>) => Reader & Profunctor2 & Category2 & Strong2(S: Semigroup) => Semigroup> = /** * Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/ReaderEither.ts b/src/ReaderEither.ts index 4d9946655..decb8ff1e 100644 --- a/src/ReaderEither.ts +++ b/src/ReaderEither.ts @@ -1009,7 +1009,7 @@ export const sequenceArray: ( * For example if a function needs a `Functor` instance, pass `RE.Functor` instead of `RE.readerEither` * (where `R` is from `import R from 'fp-ts/ReaderEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1028,7 +1028,7 @@ export const readerEither: Monad3 & Bifunctor3 & Alt3 & MonadThro /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1038,7 +1038,7 @@ export const getApplySemigroup: (S: Semigroup) => Semigroup(M: Monoid) => Monoid(S: Semigroup): Semigroup( // ------------------------------------------------------------------------------------- /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -204,6 +204,7 @@ export interface ReaderT { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -220,7 +221,7 @@ export interface ReaderM { } /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -229,6 +230,7 @@ export interface ReaderT1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -245,7 +247,7 @@ export interface ReaderM1 { } /** - * @category model + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -254,6 +256,7 @@ export interface ReaderT2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -270,6 +273,7 @@ export interface ReaderM2 { } /** + * @category zone of death * @since 2.2.0 * @deprecated */ @@ -286,6 +290,7 @@ export interface ReaderM2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -294,6 +299,7 @@ export interface ReaderT3 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -316,6 +322,7 @@ export interface ReaderM3 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/ReaderTask.ts b/src/ReaderTask.ts index 3bdb62c29..36d262fc8 100644 --- a/src/ReaderTask.ts +++ b/src/ReaderTask.ts @@ -708,6 +708,7 @@ export const traverseSeqArray = ( /** * Use `traverseReadonlyArrayWithIndexSeq` instead. * + * @category zone of death * @since 2.10.0 * @deprecated */ @@ -723,7 +724,7 @@ export const sequenceSeqArray: (arr: ReadonlyArray>) => R * For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readerTask` * (where `RT` is from `import RT from 'fp-ts/ReaderTask'`) * - * @category instances + * @category zone of death * @since 2.3.0 * @deprecated */ @@ -742,7 +743,7 @@ export const readerTask: MonadTask2 = { * For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readerTaskSeq` * (where `RT` is from `import RT from 'fp-ts/ReaderTask'`) * - * @category instances + * @category zone of death * @since 2.3.0 * @deprecated */ @@ -760,7 +761,7 @@ export const readerTaskSeq: typeof readerTask = { /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.3.0 * @deprecated */ @@ -770,7 +771,7 @@ export const getSemigroup: (S: Semigroup) => Semigroup /** * Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. * - * @category instances + * @category zone of death * @since 2.3.0 * @deprecated */ @@ -778,6 +779,7 @@ export const getMonoid: (M: Monoid) => Monoid> = /*#__PURE__*/ getApplicativeMonoid(ApplicativeSeq) /** + * @category zone of death * @since 2.4.0 * @deprecated */ diff --git a/src/ReaderTaskEither.ts b/src/ReaderTaskEither.ts index 7ac547b1e..7c4639d83 100644 --- a/src/ReaderTaskEither.ts +++ b/src/ReaderTaskEither.ts @@ -1615,7 +1615,7 @@ export const sequenceSeqArray: ( * For example if a function needs a `Functor` instance, pass `RTE.Functor` instead of `RTE.readerTaskEither` * (where `RTE` is from `import RTE from 'fp-ts/ReaderTaskEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1638,7 +1638,7 @@ export const readerTaskEither: Monad3 & Bifunctor3 & Alt3 & Monad * For example if a function needs a `Functor` instance, pass `RTE.Functor` instead of `RTE.readerTaskEitherSeq` * (where `RTE` is from `import RTE from 'fp-ts/ReaderTaskEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1663,7 +1663,7 @@ export const readerTaskEitherSeq: typeof readerTaskEither = { * Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values * are concatenated using the provided `Semigroup` * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1673,7 +1673,7 @@ export const getApplySemigroup: (S: Semigroup) => Semigroup(M: Monoid) => Monoid( } /** + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/ReadonlyArray.ts b/src/ReadonlyArray.ts index b532c1ca6..9e8c9bbc6 100644 --- a/src/ReadonlyArray.ts +++ b/src/ReadonlyArray.ts @@ -2562,7 +2562,7 @@ export const apS = /*#__PURE__*/ apS_(Apply) /** * Use `ReadonlyNonEmptyArray` module instead. * - * @category constructors + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -2571,7 +2571,7 @@ export const range = RNEA.range /** * Use [`prepend`](#prepend) instead. * - * @category constructors + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -2580,7 +2580,7 @@ export const cons = RNEA.cons /** * Use [`append`](#append) instead. * - * @category constructors + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -2589,6 +2589,7 @@ export const snoc = RNEA.snoc /** * Use [`prependAll`](#prependall) instead. * + * @category zone of death * @since 2.9.0 * @deprecated */ @@ -2599,7 +2600,7 @@ export const prependToAll = prependAll * For example if a function needs a `Functor` instance, pass `RA.Functor` instead of `RA.readonlyArray` * (where `RA` is from `import RA from 'fp-ts/ReadonlyArray'`) * - * @category instances + * @category zone of death * @since 2.5.0 * @deprecated */ diff --git a/src/ReadonlyMap.ts b/src/ReadonlyMap.ts index 87febc360..4114cd901 100644 --- a/src/ReadonlyMap.ts +++ b/src/ReadonlyMap.ts @@ -1192,6 +1192,7 @@ export const difference = ( /** * Use [`upsertAt`](#upsertat) instead. * + @category zone of death * @since 2.5.0 * @deprecated */ @@ -1202,7 +1203,7 @@ export const insertAt: (E: Eq) => (k: K, a: A) => (m: ReadonlyMap * For example if a function needs a `Functor` instance, pass `RM.Functor` instead of `RM.readonlyMap` * (where `RM` is from `import RM from 'fp-ts/ReadonlyMap'`) * - * @category instances + * @category zone of death * @since 2.5.0 * @deprecated */ diff --git a/src/ReadonlyNonEmptyArray.ts b/src/ReadonlyNonEmptyArray.ts index 3027072b7..c71b93ea1 100644 --- a/src/ReadonlyNonEmptyArray.ts +++ b/src/ReadonlyNonEmptyArray.ts @@ -1321,6 +1321,7 @@ export const intercalate = (S: Semigroup): ((middle: A) => (as: ReadonlyNo /** * This is just `sort` followed by `group`. * + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -1337,6 +1338,7 @@ export function groupSort(O: Ord): (as: ReadonlyArray) => ReadonlyArray /** * Use [`filter`](./ReadonlyArray.ts.html#filter) instead. * + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -1354,6 +1356,7 @@ export function filter(predicate: Predicate): (as: ReadonlyNonEmptyArray(as: ReadonlyNonEmptyArray) => readonly [A, ReadonlyA /** * Use [`unappend`](#unappend) instead. * + * @category zone of death * @since 2.10.0 * @deprecated */ @@ -1381,7 +1386,7 @@ export const unsnoc: (as: ReadonlyNonEmptyArray) => readonly [ReadonlyArra /** * Use [`prepend`](./ReadonlyArray.ts.html#prepend) instead. * - * @category constructors + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -1398,7 +1403,7 @@ export function cons( /** * Use [`append`](./ReadonlyArray.ts.html#append) instead. * - * @category constructors + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -1407,6 +1412,7 @@ export const snoc = (init: ReadonlyArray, end: A): ReadonlyNonEmptyArray): (S: Show) => Show(S: Show): Show> @@ -2139,7 +2139,7 @@ export const getDifferenceMagma = (): Magma> => ({ /** * Use `getFoldable` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -2153,7 +2153,7 @@ export const Foldable: Foldable1 = { /** * Use `getFoldableWithIndex` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -2170,7 +2170,7 @@ export const FoldableWithIndex: FoldableWithIndex1 = { /** * Use `getTraversable` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -2187,7 +2187,7 @@ export const Traversable: Traversable1 = { /** * Use `getTraversableWithIndex` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -2212,7 +2212,7 @@ const _wilt = /*#__PURE__*/ wiltDefault(Traversable, Compactable) /** * Use `getWitherable` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -2237,6 +2237,7 @@ export const Witherable: Witherable1 = { /** * Use [`upsertAt`](#upsertat) instead. * + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -2245,6 +2246,7 @@ export const insertAt: (k: string, a: A) => (r: ReadonlyRecord) => /** * Use [`has`](#has) instead. * + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -2258,7 +2260,7 @@ export function hasOwnProperty(this: any, k: string, r?: Reado * For example if a function needs a `Functor` instance, pass `RR.Functor` instead of `RR.readonlyRecord` * (where `RR` is from `import RR from 'fp-ts/ReadonlyRecord'`) * - * @category instances + * @category zone of death * @since 2.5.0 * @deprecated */ diff --git a/src/ReadonlySet.ts b/src/ReadonlySet.ts index 198388d6e..a1250bb09 100644 --- a/src/ReadonlySet.ts +++ b/src/ReadonlySet.ts @@ -600,7 +600,7 @@ export const getDifferenceMagma = (E: Eq): Magma> => ({ /** * Use [`fromReadonlyArray`](#fromreadonlyarray) instead. * - * @category conversions + * @category zone of death * @since 2.5.0 * @deprecated */ diff --git a/src/ReadonlyTuple.ts b/src/ReadonlyTuple.ts index 209ad0c82..ec9db2e4a 100644 --- a/src/ReadonlyTuple.ts +++ b/src/ReadonlyTuple.ts @@ -378,7 +378,7 @@ export const Traversable: Traversable2 = { * For example if a function needs a `Functor` instance, pass `RT.Functor` instead of `RT.readonlyTuple` * (where `RT` is from `import RT from 'fp-ts/ReadonlyTuple'`) * - * @category instances + * @category zone of death * @since 2.5.0 * @deprecated */ diff --git a/src/Record.ts b/src/Record.ts index e3fb7fdd9..c2c1d3198 100644 --- a/src/Record.ts +++ b/src/Record.ts @@ -1320,7 +1320,7 @@ export function getShow(O: Ord): (S: Show) => Show(S: Show): Show> @@ -1641,7 +1641,7 @@ export const getDifferenceMagma = (): Magma> => ({ /** * Use `getFoldable` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -1655,7 +1655,7 @@ export const Foldable: Foldable1 = { /** * Use `getFoldableWithIndex` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -1672,7 +1672,7 @@ export const FoldableWithIndex: FoldableWithIndex1 = { /** * Use `getTraversable` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -1689,7 +1689,7 @@ export const Traversable: Traversable1 = { /** * Use the `getTraversableWithIndex` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -1714,7 +1714,7 @@ const _wilt = /*#__PURE__*/ wiltDefault(Traversable, Compactable) /** * Use `getWitherable` instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -1739,6 +1739,7 @@ export const Witherable: Witherable1 = { /** * Use a new `{}` instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1747,6 +1748,7 @@ export const empty: Record = {} /** * Use [`upsertAt`](#upsertat) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1755,6 +1757,7 @@ export const insertAt: (k: string, a: A) => (r: Record) => Record< /** * Use [`has`](#has) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1765,7 +1768,7 @@ export const hasOwnProperty: (k: string, r: Record * For example if a function needs a `Functor` instance, pass `R.Functor` instead of `R.record` * (where `R` is from `import R from 'fp-ts/Record'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Ring.ts b/src/Ring.ts index 822a85e73..24baec0a6 100644 --- a/src/Ring.ts +++ b/src/Ring.ts @@ -74,6 +74,7 @@ export const negate = /** * Use [`tuple`](#tuple) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -84,7 +85,7 @@ export const getTupleRing: >>( /** * Use [`getRing`](./function.ts.html#getring) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Semigroup.ts b/src/Semigroup.ts index 35272e6e4..9df4f7f58 100644 --- a/src/Semigroup.ts +++ b/src/Semigroup.ts @@ -258,7 +258,7 @@ export const concatAll: (S: Semigroup) => (startWith: A) => (as: ReadonlyA /** * Use `void` module instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -267,7 +267,7 @@ export const semigroupVoid: Semigroup = constant(undefined) /** * Use [`getAssignSemigroup`](./struct.ts.html#getAssignSemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -278,7 +278,7 @@ export const getObjectSemigroup = (): Semigroup => /** * Use [`last`](#last) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -287,7 +287,7 @@ export const getLastSemigroup = last /** * Use [`first`](#first) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -296,6 +296,7 @@ export const getFirstSemigroup = first /** * Use [`tuple`](#tuple) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -306,6 +307,7 @@ export const getTupleSemigroup: >>( /** * Use [`struct`](#struct) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -316,6 +318,7 @@ export const getStructSemigroup: >(semigro /** * Use [`reverse`](#reverse) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -324,7 +327,7 @@ export const getDualSemigroup = reverse /** * Use [`max`](#max) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -333,7 +336,7 @@ export const getJoinSemigroup = max /** * Use [`min`](#min) instead. * - * @category constructors + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -342,6 +345,7 @@ export const getMeetSemigroup = min /** * Use [`intercalate`](#intercalate) instead. * + * @category zone of death * @since 2.5.0 * @deprecated */ @@ -350,6 +354,7 @@ export const getIntercalateSemigroup = intercalate /** * Use [`concatAll`](#concatall) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -365,7 +370,7 @@ export function fold(S: Semigroup): (startWith: A, as?: ReadonlyArray) /** * Use [`SemigroupAll`](./boolean.ts.html#SemigroupAll) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -376,7 +381,7 @@ export const semigroupAll: Semigroup = { /** * Use [`SemigroupAny`](./boolean.ts.html#SemigroupAny) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -387,7 +392,7 @@ export const semigroupAny: Semigroup = { /** * Use [`getSemigroup`](./function.ts.html#getSemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -396,7 +401,7 @@ export const getFunctionSemigroup: (S: Semigroup) => () => Semi /** * Use [`Semigroup`](./string.ts.html#Semigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -407,7 +412,7 @@ export const semigroupString: Semigroup = { /** * Use [`SemigroupSum`](./number.ts.html#SemigroupSum) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -418,7 +423,7 @@ export const semigroupSum: Semigroup = { /** * Use [`SemigroupProduct`](./number.ts.html#SemigroupProduct) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Semiring.ts b/src/Semiring.ts index 7f22465ec..6157d027f 100644 --- a/src/Semiring.ts +++ b/src/Semiring.ts @@ -45,7 +45,7 @@ export interface Semiring { /** * Use [`getSemiring`](./function.ts.html#getsemiring) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Set.ts b/src/Set.ts index 22bf08c7a..dc302e7f5 100644 --- a/src/Set.ts +++ b/src/Set.ts @@ -487,6 +487,7 @@ export const toArray = /** * Use [`isSubset`](#issubset) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Show.ts b/src/Show.ts index f8efc71e5..fb40cceb3 100644 --- a/src/Show.ts +++ b/src/Show.ts @@ -62,6 +62,7 @@ export const tuple = >( /** * Use [`tuple`](#tuple) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -72,6 +73,7 @@ export const getTupleShow: >>( /** * Use [`struct`](#struct) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -81,7 +83,7 @@ export const getStructShow: >(shows: { [K /** * Use [`Show`](./boolean.ts.html#show) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -92,7 +94,7 @@ export const showBoolean: Show = { /** * Use [`Show`](./string.ts.html#show) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -103,7 +105,7 @@ export const showString: Show = { /** * Use [`Show`](./number.ts.html#show) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/State.ts b/src/State.ts index e8cec6ec0..870060e5c 100644 --- a/src/State.ts +++ b/src/State.ts @@ -349,6 +349,7 @@ export const sequenceArray: (arr: ReadonlyArray>) => State(ma: State, s: S) => A = (ma, s) => ma(s)[0] /** * Use [`execute`](#execute) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -367,7 +369,7 @@ export const execState: (ma: State, s: S) => S = (ma, s) => ma(s)[1] * For example if a function needs a `Functor` instance, pass `S.Functor` instead of `S.state` * (where `S` is from `import S from 'fp-ts/State'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/StateReaderTaskEither.ts b/src/StateReaderTaskEither.ts index 772682b92..0e1369827 100644 --- a/src/StateReaderTaskEither.ts +++ b/src/StateReaderTaskEither.ts @@ -1247,7 +1247,7 @@ export const sequenceArray: ( * For example if a function needs a `Functor` instance, pass `SRTE.Functor` instead of `SRTE.stateReaderTaskEither` * (where `SRTE` is from `import SRTE from 'fp-ts/StateReaderTaskEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1270,7 +1270,7 @@ export const stateReaderTaskEither: Monad4 & Bifunctor4 & Alt4 & * For example if a function needs a `Functor` instance, pass `SRTE.Functor` instead of `SRTE.stateReaderTaskEitherSeq` * (where `SRTE` is from `import SRTE from 'fp-ts/StateReaderTaskEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1292,6 +1292,7 @@ export const stateReaderTaskEitherSeq: typeof stateReaderTaskEither = { /** * Use [`evaluate`](#evaluate) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1308,6 +1309,7 @@ export const evalState: (ma: StateReaderTaskEither, s: S /** * Use [`execute`](#execute) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1322,6 +1324,7 @@ export const execState: (ma: StateReaderTaskEither, s: S ) /** + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/StateT.ts b/src/StateT.ts index e54d07c04..5be125c29 100644 --- a/src/StateT.ts +++ b/src/StateT.ts @@ -210,6 +210,7 @@ export function execute(F: Functor): (s: S) => (ma: StateT) // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -229,6 +230,7 @@ export interface StateM { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -248,6 +250,7 @@ export interface StateM1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -267,6 +270,7 @@ export interface StateM2 { } /** + * @category zone of death * @since 2.5.4 * @deprecated */ @@ -286,6 +290,7 @@ export interface StateM2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -311,6 +316,7 @@ export interface StateM3 { } /** + * @category zone of death * @since 2.5.4 * @deprecated */ @@ -333,6 +339,7 @@ export interface StateM3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Store.ts b/src/Store.ts index 257afa583..affcc31d4 100644 --- a/src/Store.ts +++ b/src/Store.ts @@ -162,7 +162,7 @@ export const Comonad: Comonad2 = { * For example if a function needs a `Comonad` instance, pass `S.Comonad` instead of `S.store` * (where `S` is from `import S from 'fp-ts/Store'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Strong.ts b/src/Strong.ts index 77d08b68c..321d03cee 100644 --- a/src/Strong.ts +++ b/src/Strong.ts @@ -163,6 +163,7 @@ export function fanOut( /** * Use [`split`](#split) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -190,6 +191,7 @@ export function splitStrong( /** * Use [`fanOut`](#fanout) instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Task.ts b/src/Task.ts index 848ad362d..1fd1b90fe 100644 --- a/src/Task.ts +++ b/src/Task.ts @@ -313,7 +313,7 @@ export const MonadIO: MonadIO1 = { } /** - * @category conversions + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -555,7 +555,7 @@ export const sequenceSeqArray: (arr: ReadonlyArray>) => Task & MonadTask1 = { * For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.taskSeq` * (where `T` is from `import T from 'fp-ts/Task'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -591,7 +591,7 @@ export const taskSeq: Monad1 & MonadTask1 = { /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -602,7 +602,7 @@ export const getSemigroup: (S: Semigroup) => Semigroup> = /*#__PUR * * Lift a monoid into 'Task', the inner values are concatenated using the provided `Monoid`. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/TaskEither.ts b/src/TaskEither.ts index c8f1ffd2f..50ccd3d07 100644 --- a/src/TaskEither.ts +++ b/src/TaskEither.ts @@ -1442,7 +1442,7 @@ export const sequenceSeqArray: (arr: ReadonlyArray>) => T * For example if a function needs a `Functor` instance, pass `TE.Functor` instead of `TE.taskEither` * (where `TE` is from `import TE from 'fp-ts/TaskEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1465,7 +1465,7 @@ export const taskEither: Monad2 & Bifunctor2 & Alt2 & MonadTask2< * For example if a function needs a `Functor` instance, pass `TE.Functor` instead of `TE.taskEitherSeq` * (where `TE` is from `import TE from 'fp-ts/TaskEither'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1487,7 +1487,7 @@ export const taskEitherSeq: typeof taskEither = { /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1497,7 +1497,7 @@ export const getApplySemigroup: (S: Semigroup) => Semigroup(M: Monoid) => Monoid> = /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1517,7 +1517,7 @@ export const getSemigroup = (S: Semigroup): Semigroup> /** * Use [`getApplicativeTaskValidation`](#getapplicativetaskvalidation) and [`getAltTaskValidation`](#getalttaskvalidation) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/TaskThese.ts b/src/TaskThese.ts index caf224f01..6a3c7ca04 100644 --- a/src/TaskThese.ts +++ b/src/TaskThese.ts @@ -538,7 +538,7 @@ export const traverseReadonlyArrayWithIndexSeq = /** * Use [`Functor`](#functor) instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -550,7 +550,7 @@ export const functorTaskThese: Functor2 = { /** * Use [`Bifunctor`](#bifunctor) instead. * - * @category instances + * @category zone of death * @since 2.7.0 * @deprecated */ @@ -563,8 +563,8 @@ export const bifunctorTaskThese: Bifunctor2 = { /** * Use [`toTuple2`](#totuple2) instead. * + * @category zone of death * @since 2.4.0 - * @category conversions * @deprecated */ export const toTuple = (e: E, a: A): ((fa: TaskThese) => Task<[E, A]>) => @@ -578,7 +578,7 @@ export const toTuple = (e: E, a: A): ((fa: TaskThese) => Task<[E, A] * For example if a function needs a `Functor` instance, pass `TT.Functor` instead of `TT.taskThese` * (where `TT` is from `import TT from 'fp-ts/TaskThese'`) * - * @category instances + * @category zone of death * @since 2.4.0 * @deprecated */ @@ -592,7 +592,7 @@ export const taskThese: Functor2 & Bifunctor2 = { /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * - * @category instances + * @category zone of death * @since 2.4.0 * @deprecated */ diff --git a/src/These.ts b/src/These.ts index 251833569..c12034f2a 100644 --- a/src/These.ts +++ b/src/These.ts @@ -716,8 +716,8 @@ export const toTuple2 = /** * Use [`toTuple2`](#totuple2) instead. * + * @category zone of death * @since 2.0.0 - * @category conversions * @deprecated */ export const toTuple = (e: E, a: A): ((fa: These) => [E, A]) => @@ -792,7 +792,7 @@ export const traverseReadonlyArrayWithIndex = * For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.these` * (where `T` is from `import T from 'fp-ts/These'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/TheseT.ts b/src/TheseT.ts index ea48f9210..073e7bdef 100644 --- a/src/TheseT.ts +++ b/src/TheseT.ts @@ -430,13 +430,14 @@ export function toTuple2( // ------------------------------------------------------------------------------------- /** - * @category model + * @category zone of death * @since 2.4.0 * @deprecated */ export interface TheseT extends HKT> {} /** + * @category zone of death * @since 2.4.0 * @deprecated */ @@ -467,13 +468,14 @@ export interface TheseM { } /** - * @category model + * @category zone of death * @since 2.4.0 * @deprecated */ export type TheseT1 = Kind> /** + * @category zone of death * @since 2.4.0 * @deprecated */ @@ -504,13 +506,14 @@ export interface TheseM1 { } /** - * @category model + * @category zone of death * @since 2.4.0 * @deprecated */ export type TheseT2 = Kind2> /** + * @category zone of death * @since 2.4.0 * @deprecated */ @@ -541,6 +544,7 @@ export interface TheseM2 { } /** + * @category zone of death * @since 2.4.0 * @deprecated */ diff --git a/src/Traced.ts b/src/Traced.ts index 72eb6f2f5..867d08d83 100644 --- a/src/Traced.ts +++ b/src/Traced.ts @@ -129,7 +129,7 @@ export const flap = /*#__PURE__*/ flap_(Functor) /** * Use [`Functor`](#functor) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Traversable.ts b/src/Traversable.ts index dab0abff8..a37ab7644 100644 --- a/src/Traversable.ts +++ b/src/Traversable.ts @@ -532,6 +532,7 @@ export interface PipeableTraverse2 { // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -543,6 +544,7 @@ export interface TraversableComposition extends FoldableComposition, } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -567,6 +569,7 @@ export interface TraverseComposition11 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -585,6 +588,7 @@ export interface SequenceComposition11 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -602,6 +606,7 @@ export interface TraversableComposition11 * * instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Tree.ts b/src/Tree.ts index d87aad179..ebc6f11db 100644 --- a/src/Tree.ts +++ b/src/Tree.ts @@ -621,7 +621,7 @@ export const exists = * For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.tree` * (where `T` is from `import T from 'fp-ts/Tree'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Tuple.ts b/src/Tuple.ts index 5c2abbed0..7c4a4bb78 100644 --- a/src/Tuple.ts +++ b/src/Tuple.ts @@ -344,8 +344,8 @@ export const Traversable: Traversable2 = { /** * Use [`mapFst`](#mapfst) instead. * + * @category zone of death * @since 2.0.0 - * @category mapping * @deprecated */ export const map: (f: (a: A) => B) => (fa: [A, E]) => [B, E] = mapFst @@ -353,8 +353,8 @@ export const map: (f: (a: A) => B) => (fa: [A, E]) => [B, E] = mapFst /** * Use [`mapSnd`](#mapsnd) instead. * + * @category zone of death * @since 2.0.0 - * @caterory error handling * @deprecated */ export const mapLeft: (f: (e: E) => G) => (fa: [A, E]) => [A, G] = mapSnd @@ -364,7 +364,7 @@ export const mapLeft: (f: (e: E) => G) => (fa: [A, E]) => [A, G] = mapS * For example if a function needs a `Functor` instance, pass `T.Functor` instead of `T.tuple` * (where `T` is from `import T from 'fp-ts/Tuple'`) * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/ValidationT.ts b/src/ValidationT.ts index cd952849f..a8a39df47 100644 --- a/src/ValidationT.ts +++ b/src/ValidationT.ts @@ -21,12 +21,14 @@ import Either = E.Either // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ export interface ValidationT extends HKT> {} /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -38,12 +40,14 @@ export interface ValidationM extends ApplicativeCompositionHKT2C = Kind> /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -55,12 +59,14 @@ export interface ValidationM1 extends ApplicativeComposition1 } /** + * @category zone of death * @since 2.0.0 * @deprecated */ export type ValidationT2 = Kind2> /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -78,6 +84,7 @@ export interface ValidationM2 extends ApplicativeComposition /** * Use `EitherT` instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/Writer.ts b/src/Writer.ts index 3876d4c91..ac0f63c00 100644 --- a/src/Writer.ts +++ b/src/Writer.ts @@ -225,6 +225,7 @@ export const execute: (fa: Writer) => W = (fa) => fa()[1] /** * Use [`evaluate`](#evaluate) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -233,6 +234,7 @@ export const evalWriter: (fa: Writer) => A = (fa) => fa()[0] /** * Use [`execute`](#execute) instead * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -241,7 +243,7 @@ export const execWriter: (fa: Writer) => W = (fa) => fa()[1] /** * Use [`Functor`](#functor) instead. * - * @category instances + * @category zone of death * @since 2.0.0 * @deprecated */ diff --git a/src/function.ts b/src/function.ts index 2ea2b044f..fec038c31 100644 --- a/src/function.ts +++ b/src/function.ts @@ -716,6 +716,7 @@ export const SK = (_: A, b: B): B => b /** * Use `Refinement` module instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -726,6 +727,7 @@ export interface Refinement { /** * Use `Predicate` module instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -736,6 +738,7 @@ export interface Predicate { /** * Use `Predicate` module instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -746,6 +749,7 @@ export function not(predicate: Predicate): Predicate { /** * Use `Endomorphism` module instead. * + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -756,7 +760,7 @@ export interface Endomorphism { /** * Use `Endomorphism` module instead. * - * @category instances + * @category zone of death * @since 2.10.0 * @deprecated */ diff --git a/src/index.ts b/src/index.ts index feb6cb091..d217c9848 100644 --- a/src/index.ts +++ b/src/index.ts @@ -691,7 +691,7 @@ export { */ validationT, /** - * @category monad transformers + * @category zone of death * @since 2.11.0 * @deprecated */ diff --git a/src/pipeable.ts b/src/pipeable.ts index c10ca1b33..3c92458e4 100644 --- a/src/pipeable.ts +++ b/src/pipeable.ts @@ -985,6 +985,7 @@ export function compose(F: Semigroupoid): (ea: HKT2) => // ------------------------------------------------------------------------------------- /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -993,6 +994,7 @@ export interface PipeableFunctor { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1001,6 +1003,7 @@ export interface PipeableFunctor1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1009,6 +1012,7 @@ export interface PipeableFunctor2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1017,6 +1021,7 @@ export interface PipeableFunctor2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1033,6 +1038,7 @@ export interface PipeableFunctor3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1041,6 +1047,7 @@ export interface PipeableFunctor4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1049,6 +1056,7 @@ export interface PipeableContravariant { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1057,6 +1065,7 @@ export interface PipeableContravariant1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1065,6 +1074,7 @@ export interface PipeableContravariant2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1073,6 +1083,7 @@ export interface PipeableContravariant2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1089,6 +1100,7 @@ export interface PipeableContravariant3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1097,6 +1109,7 @@ export interface PipeableContravariant4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1105,6 +1118,7 @@ export interface PipeableFunctorWithIndex extends PipeableFunctor { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1113,6 +1127,7 @@ export interface PipeableFunctorWithIndex1 extends PipeableFu } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1121,6 +1136,7 @@ export interface PipeableFunctorWithIndex2 extends PipeableF } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1129,6 +1145,7 @@ export interface PipeableFunctorWithIndex2C extends Pipea } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1145,6 +1162,7 @@ export interface PipeableFunctorWithIndex3C extends Pipea } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1153,6 +1171,7 @@ export interface PipeableFunctorWithIndex4 extends PipeableF } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1163,6 +1182,7 @@ export interface PipeableApply extends PipeableFunctor { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1173,6 +1193,7 @@ export interface PipeableApply1 extends PipeableFunctor1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1183,6 +1204,7 @@ export interface PipeableApply2 extends PipeableFunctor2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1193,6 +1215,7 @@ export interface PipeableApply2C extends PipeableFunctor2C extends PipeableFunctor3C extends PipeableFunctor4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1235,6 +1260,7 @@ export interface PipeableChain extends PipeableApply { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1245,6 +1271,7 @@ export interface PipeableChain1 extends PipeableApply1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1255,6 +1282,7 @@ export interface PipeableChain2 extends PipeableApply2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1265,6 +1293,7 @@ export interface PipeableChain2C extends PipeableApply2C extends PipeableApply3C extends PipeableApply4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1308,6 +1339,7 @@ export interface PipeableExtend extends PipeableFunctor { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1317,6 +1349,7 @@ export interface PipeableExtend1 extends PipeableFunctor1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1326,6 +1359,7 @@ export interface PipeableExtend2 extends PipeableFunctor2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1335,6 +1369,7 @@ export interface PipeableExtend2C extends PipeableFunctor2C< } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1353,6 +1388,7 @@ export interface PipeableExtend3C extends PipeableFunctor3C< } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1364,6 +1400,7 @@ export interface PipeableExtend4 extends PipeableFunctor4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1373,6 +1410,7 @@ export interface PipeableBifunctor { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1382,6 +1420,7 @@ export interface PipeableBifunctor2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1400,6 +1439,7 @@ export interface PipeableBifunctor3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1412,6 +1452,7 @@ export interface PipeableBifunctor4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1422,6 +1463,7 @@ export interface PipeableFoldable { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1432,6 +1474,7 @@ export interface PipeableFoldable1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1442,6 +1485,7 @@ export interface PipeableFoldable2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1452,6 +1496,7 @@ export interface PipeableFoldable2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1472,6 +1517,7 @@ export interface PipeableFoldable3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1482,6 +1528,7 @@ export interface PipeableFoldable4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1492,6 +1539,7 @@ export interface PipeableFoldableWithIndex extends PipeableFoldable { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1502,6 +1550,7 @@ export interface PipeableFoldableWithIndex1 extends PipeableF } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1512,6 +1561,7 @@ export interface PipeableFoldableWithIndex2 extends Pipeable } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1522,6 +1572,7 @@ export interface PipeableFoldableWithIndex2C extends Pipe } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1542,6 +1593,7 @@ export interface PipeableFoldableWithIndex3C extends Pipe } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1552,6 +1604,7 @@ export interface PipeableFoldableWithIndex4 extends Pipeable } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1560,6 +1613,7 @@ export interface PipeableAlt { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1568,6 +1622,7 @@ export interface PipeableAlt1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1576,6 +1631,7 @@ export interface PipeableAlt2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1584,6 +1640,7 @@ export interface PipeableAlt2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1600,6 +1657,7 @@ export interface PipeableAlt3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1608,6 +1666,7 @@ export interface PipeableAlt4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1617,6 +1676,7 @@ export interface PipeableCompactable { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1626,6 +1686,7 @@ export interface PipeableCompactable1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1635,6 +1696,7 @@ export interface PipeableCompactable2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1644,6 +1706,7 @@ export interface PipeableCompactable2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1662,6 +1725,7 @@ export interface PipeableCompactable3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1673,6 +1737,7 @@ export interface PipeableCompactable4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1690,6 +1755,7 @@ export interface PipeableFilterable extends PipeableCompactable { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1707,6 +1773,7 @@ export interface PipeableFilterable1 extends PipeableCompactable } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1726,6 +1793,7 @@ export interface PipeableFilterable2 extends PipeableCompactabl } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1745,6 +1813,7 @@ export interface PipeableFilterable2C extends PipeableCompac } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1787,6 +1856,7 @@ export interface PipeableFilterable3C extends PipeableCompac } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1810,6 +1880,7 @@ export interface PipeableFilterable4 extends PipeableCompactabl } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1831,6 +1902,7 @@ export interface PipeableFilterableWithIndex extends PipeableFilterable } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1852,6 +1924,7 @@ export interface PipeableFilterableWithIndex1 extends Pipeabl } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1875,6 +1948,7 @@ export interface PipeableFilterableWithIndex2 extends Pipeab } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1896,6 +1970,7 @@ export interface PipeableFilterableWithIndex2C extends Pi } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1946,6 +2021,7 @@ export interface PipeableFilterableWithIndex3C extends Pi } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1973,6 +2049,7 @@ export interface PipeableFilterableWithIndex4 extends Pipeab } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1981,6 +2058,7 @@ export interface PipeableProfunctor { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -1989,6 +2067,7 @@ export interface PipeableProfunctor2 extends PipeableFunctor2 extends PipeableFuncto } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2013,6 +2093,7 @@ export interface PipeableProfunctor3C extends PipeableFuncto } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2024,6 +2105,7 @@ export interface PipeableProfunctor4 extends PipeableFunctor4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2040,6 +2123,7 @@ export interface PipeableSemigroupoid2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2048,6 +2132,7 @@ export interface PipeableSemigroupoid2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2064,6 +2149,7 @@ export interface PipeableSemigroupoid3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2072,6 +2158,7 @@ export interface PipeableSemigroupoid4 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2089,6 +2176,7 @@ export interface PipeableMonadThrow { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2106,6 +2194,7 @@ export interface PipeableMonadThrow1 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2123,6 +2212,7 @@ export interface PipeableMonadThrow2 { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2140,6 +2230,7 @@ export interface PipeableMonadThrow2C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2178,6 +2269,7 @@ export interface PipeableMonadThrow3C { } /** + * @category zone of death * @since 2.0.0 * @deprecated */ @@ -2215,6 +2307,7 @@ const isSemigroupoid = (I: any): I is Semigroupoid => typeof I.compose === const isMonadThrow = (I: any): I is MonadThrow => typeof I.throwError === 'function' /** + * @category zone of death * @since 2.0.0 * @deprecated */