io-ts-types/lib/either.d.ts

A collection of codecs and combinators for use with io-ts

/**
 * @since 0.5.0
 */
import { Either } from 'fp-ts/lib/Either'
import * as t from 'io-ts'
/**
 * @since 0.5.18
 */
export declare type LeftOutput<L> = {
  _tag: 'Left'
  left: L
}
/**
 * @since 0.5.18
 */
export declare type RightOutput<R> = {
  _tag: 'Right'
  right: R
}
/**
 * @since 0.5.18
 */
export declare type EitherOutput<L, R> = LeftOutput<L> | RightOutput<R>
/**
 * @since 0.5.0
 */
export interface EitherC<L extends t.Mixed, R extends t.Mixed>
  extends t.Type<Either<t.TypeOf<L>, t.TypeOf<R>>, EitherOutput<t.OutputOf<L>, t.OutputOf<R>>, unknown> {}
/**
 * Given a codec representing a type `L` and a codec representing a type `A`, returns a codec representing `Either<L, A>` that is able to deserialize
 * the JSON representation of an `Either`.
 *
 * @example
 * import { either } from 'io-ts-types/lib/either'
 * import { left, right } from 'fp-ts/lib/Either'
 * import * as t from 'io-ts'
 * import { PathReporter } from 'io-ts/lib/PathReporter'
 *
 * const T = either(t.string, t.number)
 *
 * assert.deepStrictEqual(T.decode(right(1)), right(right(1)))
 * assert.deepStrictEqual(T.decode(left('a')), right(left('a')))
 * assert.deepStrictEqual(PathReporter.report(T.decode(right('a'))), ['Invalid value "a" supplied to : Either<string, number>/1: Right<string>/right: number'])
 *
 * @since 0.5.0
 */
export declare function either<L extends t.Mixed, R extends t.Mixed>(
  leftCodec: L,
  rightCodec: R,
  name?: string
): EitherC<L, R>