fp-ts

The goal of this release is to make the migration to v2 easier.

Since in v2 data types are no more implemented with classes, chainable APIs will be deprecated (in v1.20.0).

As an alternative, a pipe function is provided, along with suitable data-last top level functions (one for each deprecated method).

Example

Before

import * as O from 'fp-ts/lib/Option'

O.some(1)
  .map(n => n * 2)
  .chain(n => n === 0 ? O.none : O.some(1 / n))
  .filter(n => n > 1)
  .foldL(() => 'ko', () => 'ok')

After

import * as O from 'fp-ts/lib/Option'
import { pipe } from 'fp-ts/lib/pipeable'

pipe(
  O.some(1),
  O.map(n => n * 2),
  O.chain(n === 0 ? O.none : O.some(1 / n)),
  O.filter(n => n > 1),
  O.fold(() => 'ko', () => 'ok')
)

Custom tslint rule

In order to make easier to spot all the occurrences of chainable APIs without depending on @deprecated, which would force you to migrate in one shot, a custom tslint rule is provided (@obsolete).

Configuration

Add the following lines to your tslint.json to turn the @obsolete rule on:

{
+  "rulesDirectory": ["./node_modules/fp-ts/rules"],
   "rules": {
+    "obsolete": true
   }
}

• New Feature

  • add Eq module

  • backport top level data-last functions from v2

  • backport pipeable module form v2

  • backport pipe function form v2

  • backport flow function form v2

  • Array

    • add isNonEmpty

  • IOEither

    • add foldIO and foldIOEither

  • Record

    • add record instance

    • add mapWithIndex

    • add reduceWithIndex

    • add foldMapWithIndex

    • add reduceRightWithIndex

    • add hasOwnProperty

  • Map

    • backport updateAt

    • backport modifyAt

  • Ord

    • make Ord a contravariant functor

• Bug Fix

  • fix MonadThrow definition

  • TraversableWithIndex

    • fix TraverseWithIndex2 definition

    • fix TraverseWithIndex2C definition

• Deprecations

  • HKT

    • deprecate URI2HKT<n> in favour of URItoKind<n>

    • deprecate Type<n> in favour of Kind<n>

  • deprecate Setoid in favour of Eq

  • Applicative

    • deprecate when

    • deprecate getMonoid

  • Apply

    • deprecate applyFirst, use pipeable's apFirst

    • deprecate applySecond, use pipeable's apSecond

  • Array

    • deprecate catOptions in favour of compact

    • deprecate mapOptions in favour of filterMap

    • deprecate uncurried filter in favour of curried, data-last filter

    • deprecate uncurried partition in favour of curried, data-last partition

    • deprecate uncurried partitionMap in favour of curried, data-last partitionMap

    • deprecate fold / foldL in favour of foldLeft

    • deprecate foldr in favour of foldRight

    • deprecate take in favour of takeLeft

    • deprecate takeEnd in favour of takeRight

    • deprecate takeWhile in favour of takeLeftWhile

    • deprecate span in favour of spanLeft

    • deprecate drop in favour of dropLeft

    • deprecate dropEnd in favour of dropRight

    • deprecate dropWhile in favour of dropLeftWhile

    • deprecate uncurried findIndex in favour of curried, data-last findIndex

    • deprecate uncurried findFirst in favour of curried, data-last findFirst

    • deprecate uncurried findFirstMap in favour of curried, data-last findFirstMap

    • deprecate uncurried findLast in favour of curried, data-last findLast

    • deprecate uncurried findLastMap in favour of curried, data-last findLastMap

    • deprecate uncurried findLastIndex in favour of curried, data-last findLastIndex

    • deprecate uncurried insertAt in favour of curried, data-last insertAt

    • deprecate uncurried updateAt in favour of curried, data-last updateAt

    • deprecate uncurried deleteAt in favour of curried, data-last deleteAt

    • deprecate uncurried modifyAt in favour of curried, data-last modifyAt

    • deprecate uncurried rotate in favour of curried, data-last rotate

    • deprecate uncurried chop in favour of curried, data-last chop

    • deprecate split in favour of splitAt

    • deprecate uncurried chunksOf in favour of curried, data-last chunksOf

  • Chain

    • deprecate flatten, use pipeable's flatten

  • Const

    • deprecate Const constructor in favour of make

  • Contravariant

    • deprecate lift, use pipeable's contramap

  • Exception module is deprecated

  • Extend

    • deprecate duplicate, use pipeable's duplicate

  • Foldable2v

    • deprecate fold

    • deprecate sequence_, use traverse_

    • deprecate oneOf

    • deprecate sum

    • deprecate product

    • deprecate elem

    • deprecate findFirst

    • deprecate min

    • deprecate max

    • deprecate toArray

  • Free module is deprecated

  • FreeGroup module is deprecated

  • function

    • deprecate Function* types, use FunctionN

    • deprecate Kleisli type

    • deprecate Cokleisli type

    • deprecate concat function, use Array's getSemigroup

    • deprecate compose function in favour of flow

    • deprecate pipe function in favour of flow

    • deprecate curried function

    • deprecate curry function

    • deprecate toString function, use Show type class

    • deprecate apply function

    • deprecate applyFlipped function

    • deprecate constIdentity function

    • deprecate phantom

    • deprecate or

    • deprecate and

    • deprecate on

    • deprecate BinaryOperator

  • Functor

    • deprecate lift, use pipeable's map

    • deprecate voidRight

    • deprecate voidLeft

    • deprecate flap

  • Validation

    • deprecate Validation module in favour of Either's:

      • getValidation

      • getValidationSemigroup

      • getValidationMonoid

  • Either

    • deprecate getCompactable, getFilterable in favour of getWitherable

  • IOEither

    • deprecate right in favour of rightIO

    • deprecate left in favour of leftIO

    • deprecate fromLeft in favour of left2v

    • add right2v

  • IxIO module is deprecated

  • IxMonad module is deprecated

  • Map

    • deprecate insert in favour of insertAt

    • deprecate remove in favour of deleteAt

  • MonadThrow

    • deprecate fromOption

    • deprecate fromEither

  • Monoid

    • deprecate getArrayMonoid in favour of Array's getMonoid

  • Monoidal module is deprecated

  • NonEmptyArray

    • deprecate uncurried groupBy in favour of curried, data-last groupBy

    • deprecate findFirst in favour of Array's findFirst

    • deprecate findLast in favour of Array's findLast

    • deprecate findIndex in favour of Array's findIndex

    • deprecate findLastIndex in favour of Array's findLastIndex

    • deprecate uncurried insertAt in favour of curried, data-last insertAt

    • deprecate uncurried updateAt in favour of curried, data-last updateAt

    • deprecate uncurried modifyAt in favour of curried, data-last modifyAt

    • deprecate uncurried filter in favour of curried, data-last filter

    • deprecate uncurried filterWithIndex in favour of curried, data-last filterWithIndex

  • Ord

    • deprecate lessThan in favour of lt

    • deprecate greaterThan in favour of gt

    • deprecate lessThanOrEq in favour of leq

    • deprecate greaterThanOrEq in favour of geq

    • swap contramap arguments

  • Pair module is deprecated

  • Profunctor

    • deprecate lmap function

    • deprecate rmap function

  • ReaderTaskEither

    • deprecate right in favour of rightTask

    • deprecate left in favour of leftTask

    • deprecate fromReader in favour of rightReader

    • deprecate fromIO in favour of rightIO

    • deprecate fromLeft in favour of left2v

    • add right2v

  • Record

    • deprecate uncurried collect in favour of curried, data-last collect

    • deprecate insert in favour of insertAt

    • deprecate remove in favour of deleteAt

    • deprecate uncurried pop in favour of curried, data-last pop

    • deprecate mapWithKey in favour of mapWithIndex

    • deprecate reduceWithKey in favour of reduceWithIndex

    • deprecate foldMapWithKey in favour of foldMapWithIndex

    • deprecate foldrWithKey in favour of reduceRightWithIndex

    • deprecate traverseWithKey in favour of traverseWithIndex

    • deprecate traverse in favour of traverse2v

    • deprecate uncurried filterWithIndex in favour of curried, data-last filterWithIndex

    • deprecate uncurried partitionMap in favour of curried, data-last partitionMap

    • deprecate uncurried partition in favour of curried, data-last partition

    • deprecate wither in favour of record.wither

    • deprecate wilt in favour of record.wilt

    • deprecate uncurried filterMap in favour of curried, data-last filterMap

    • deprecate uncurried partitionMapWithKey in favour of curried, data-last partitionMapWithIndex

    • deprecate uncurried partitionWithKey in favour of curried, data-last partitionWithIndex

    • deprecate uncurried filterMapWithKey in favour of curried, data-last filterMapWithIndex

    • deprecate uncurried filter in favour of curried, data-last filter

    • deprecate uncurried map in favour of curried, data-last map

    • deprecate uncurried foldMap in favour of curried, data-last foldMap

    • deprecate foldr in favour of reduceRight

  • StrMap module is deprecated

  • Task

    • deprecate delay in favour of delay2v

  • TaskEither

    • deprecate right in favour of rightTask

    • deprecate left in favour of leftTask

    • deprecate fromIO in favour of rightIO

    • deprecate fromLeft in favour of left2v

    • add right2v

  • These

    • deprecate this_ in favour of left

    • deprecate that in favour of right

    • deprecate fromThese in favour of toTuple

    • deprecate theseLeft in favour of getLeft

    • deprecate theseRight in favour of getRight

    • deprecate isThis in favour of isLeft

    • deprecate isThat in favour of isRight

    • deprecate thisOrBoth in favour of leftOrBoth

    • deprecate thatOrBoth in favour of rightOrBoth

    • deprecate theseThis in favour of getLeftOnly

    • deprecate theseThat in favour of getRightOnly

  • Trace module is deprecated

  • Validation module is deprecated, use Either's getValidation

  • Writer

    • deprecate listens in favour of listens2v

    • deprecate censor in favour of censor2v

  • Zipper module is deprecated