io-ts

• Undeprecate FunctionType, FunctionC, Function

• Undeprecate NeverType, NeverC, never

• Undeprecate AnyType, AnyC, any

• Undeprecate RefinementC, refinement, Integer

• Add refinement overload to allow custom branding, closes #373

Experimental modules require fp-ts@^2.5.0.

• Experimental

  • Codec

    • add readonly combinator

  • Encoder

    • add readonly combinator

• Experimental

  • Schemable

    • (*) add readonly combinator

    • (*) add struct combinator

  • deprecate type in favour of struct

  • deprecate fromType in favour of fromStruct

(*) breaking change

• Experimental

  • (*) make sum safer, closes #523

(*) breaking change

In case of non-string tag values, the respective key must be enclosed in brackets

export const MySum: D.Decoder<
  unknown,
  | {
      type: 1 // non-`string` tag value
      a: string
    }
  | {
      type: 2 // non-`string` tag value
      b: number
    }
> = D.sum('type')({
  [1]: D.type({ type: D.literal(1), a: D.string }),
  [2]: D.type({ type: D.literal(2), b: D.number })
})

• Experimental

  • (*) remove KleisliDecoder module

  • (*) remove KleisliTaskDecoder module

  • (*) remove JsonCodec module

  • (*) remove JsonEncoder module

  • Codec

    • (*) make Codec more general by adding a I type parameter

    • add fromType function

    • add fromPartial function

    • add fromArray function

    • add fromRecord function

    • add fromTuple function

    • add fromSum function

    • add compose function

  • Decoder

    • (*) make Decoder more general by adding a I type parameter

    • add fromRefinement function

    • change fromGuard signature

    • add fromType function

    • add fromPartial function

    • add fromArray function

    • add fromRecord function

    • add fromTuple function

    • add fromSum function

    • add compose function

    • add id function

    • (*) rename functorDecoder instance to Functor

    • (*) rename altDecoder instance to Alt

    • (*) rename and split schemableDecoder

    • add Category instance

    • add InputOf type

  • TaskDecoder

    • (*) make TaskDecoder more general by adding a I type parameter

    • add fromRefinement function

    • change fromDecoder signature

    • add fromType function

    • add fromPartial function

    • add fromArray function

    • add fromRecord function

    • add fromTuple function

    • add fromSum function

    • add compose function

    • add id function

    • (*) rename functorTaskDecoder instance to Functor

    • (*) rename altTaskDecoder instance to Alt

    • (*) rename and split schemableTaskDecoder

    • add Category instance

    • add InputOf type

  • Guard

    • (*) make Guard more general by adding a I type parameter

    • (*) rename schemableGuard

    • add InputOf type

    • add alt function

    • add zero function

    • add compose function

    • add id function

  • Codec

    • (*) rename invariantCodec to Invariant

  • Encoder

    • (*) rename contravariantEncoder to Contravariant

    • (*) rename categoryEncoder to Category

  • Eq

    • (*) rename and split schemableEq

  • Kleisli

    • add id

    • rename type to fromType

    • rename partial to fromPartial

    • rename array to fromArray

    • rename record to fromRecord

    • rename tuple to fromTuple

    • rename sum to fromSum

  • Schemable

    • add Schemable2C, WithUnknownContainers2C, WithUnion2C, WithRefine2C

  • Type

    • (*) rename and split schemableType

(*) breaking change

• Experimental

  • add DecodeError module

  • add FreeSemigroup module

  • add TaskDecoder module

  • add Kleisli module

  • add KleisliDecoder module

  • add KleisliTaskDecoder module

  • (*) remove NaN from number instances

  • (*) remove Tree module

  • (*) make Json type immutable

  • Decoder

    • (*) remove never

    • (*) make parse pipeable and change its parser argument

    • (*) change DecoderError

    • (*) remove withExpected in favour of mapLeftWithInput

  • Guard

    • (*) remove never

  • Schemable

    • (*) better literal signature

    • (*) better union signature

    • (*) make intersections pipeables

    • (*) make refinements pipeables

(*) breaking change