/** * ```ts * type Either = Left | Right * ``` * * Represents a value of one of two possible types (a disjoint union). * * An instance of `Either` is either an instance of `Left` or `Right`. * * A common use of `Either` is as an alternative to `Option` for dealing with possible missing values. In this usage, * `None` is replaced with a `Left` which can contain useful information. `Right` takes the place of `Some`. Convention * dictates that `Left` is used for failure and `Right` is used for success. * * @since 2.0.0 */ import { Alt2, Alt2C } from './Alt' import { Applicative2, Applicative2C } from './Applicative' import { Bifunctor2 } from './Bifunctor' import { ChainRec2, ChainRec2C } from './ChainRec' import { Eq } from './Eq' import { Extend2 } from './Extend' import { Foldable2 } from './Foldable' import { Lazy, Predicate, Refinement } from './function' import { Functor2 } from './Functor' import { Monad2, Monad2C } from './Monad' import { MonadThrow2, MonadThrow2C } from './MonadThrow' import { Monoid } from './Monoid' import { Option } from './Option' import { Semigroup } from './Semigroup' import { Show } from './Show' import { PipeableTraverse2, Traversable2 } from './Traversable' import { Witherable2C } from './Witherable' import { Filterable2C } from './Filterable' /** * @category model * @since 2.0.0 */ export interface Left { readonly _tag: 'Left' readonly left: E } /** * @category model * @since 2.0.0 */ export interface Right { readonly _tag: 'Right' readonly right: A } /** * @category model * @since 2.0.0 */ export declare type Either = Left | Right /** * Returns `true` if the either is an instance of `Left`, `false` otherwise. * * @category guards * @since 2.0.0 */ export declare const isLeft: (ma: Either) => ma is Left /** * Returns `true` if the either is an instance of `Right`, `false` otherwise. * * @category guards * @since 2.0.0 */ export declare const isRight: (ma: Either) => ma is Right /** * Constructs a new `Either` holding a `Left` value. This usually represents a failure, due to the right-bias of this * structure. * * @category constructors * @since 2.0.0 */ export declare const left: (e: E) => Either /** * Constructs a new `Either` holding a `Right` value. This usually represents a successful value due to the right bias * of this structure. * * @category constructors * @since 2.0.0 */ export declare const right: (a: A) => Either /** * Takes a default and a nullable value, if the value is not nully, turn it into a `Right`, if the value is nully use * the provided default as a `Left`. * * @example * import { fromNullable, left, right } from 'fp-ts/Either' * * const parse = fromNullable('nully') * * assert.deepStrictEqual(parse(1), right(1)) * assert.deepStrictEqual(parse(null), left('nully')) * * @category constructors * @since 2.0.0 */ export declare function fromNullable(e: E): (a: A) => Either> /** * Constructs a new `Either` from a function that might throw. * * @example * import { Either, left, right, tryCatch } from 'fp-ts/Either' * * const unsafeHead = (as: Array): A => { * if (as.length > 0) { * return as[0] * } else { * throw new Error('empty array') * } * } * * const head = (as: Array): Either => { * return tryCatch(() => unsafeHead(as), e => (e instanceof Error ? e : new Error('unknown error'))) * } * * assert.deepStrictEqual(head([]), left(new Error('empty array'))) * assert.deepStrictEqual(head([1, 2, 3]), right(1)) * * @category constructors * @since 2.0.0 */ export declare function tryCatch(f: Lazy, onError: (e: unknown) => E): Either /** * Copied from https://github.com/Microsoft/TypeScript/issues/1897#issuecomment-338650717 * * @since 2.6.7 */ export declare type Json = boolean | number | string | null | JsonArray | JsonRecord /** * @since 2.6.7 */ export interface JsonRecord { readonly [key: string]: Json } /** * @since 2.6.7 */ export interface JsonArray extends ReadonlyArray {} /** * Converts a JavaScript Object Notation (JSON) string into an object. * * @example * import { parseJSON, toError, right, left } from 'fp-ts/Either' * * assert.deepStrictEqual(parseJSON('{"a":1}', toError), right({ a: 1 })) * assert.deepStrictEqual(parseJSON('{"a":}', toError), left(new SyntaxError('Unexpected token } in JSON at position 5'))) * * @category constructors * @since 2.0.0 */ export declare function parseJSON(s: string, onError: (reason: unknown) => E): Either /** * Converts a JavaScript value to a JavaScript Object Notation (JSON) string. * * @example * import * as E from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual(E.stringifyJSON({ a: 1 }, E.toError), E.right('{"a":1}')) * const circular: any = { ref: null } * circular.ref = circular * assert.deepStrictEqual( * pipe( * E.stringifyJSON(circular, E.toError), * E.mapLeft(e => e.message.includes('Converting circular structure to JSON')) * ), * E.left(true) * ) * * @category constructors * @since 2.0.0 */ export declare function stringifyJSON(u: unknown, onError: (reason: unknown) => E): Either /** * Derivable from `MonadThrow`. * * @example * import { fromOption, left, right } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * import { none, some } from 'fp-ts/Option' * * assert.deepStrictEqual( * pipe( * some(1), * fromOption(() => 'error') * ), * right(1) * ) * assert.deepStrictEqual( * pipe( * none, * fromOption(() => 'error') * ), * left('error') * ) * * @category constructors * @since 2.0.0 */ export declare const fromOption: (onNone: Lazy) => (ma: Option) => Either /** * Derivable from `MonadThrow`. * * @example * import { fromPredicate, left, right } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual( * pipe( * 1, * fromPredicate( * (n) => n > 0, * () => 'error' * ) * ), * right(1) * ) * assert.deepStrictEqual( * pipe( * -1, * fromPredicate( * (n) => n > 0, * () => 'error' * ) * ), * left('error') * ) * * @category constructors * @since 2.0.0 */ export declare const fromPredicate: { (refinement: Refinement, onFalse: (a: A) => E): (a: A) => Either (predicate: Predicate, onFalse: (a: A) => E): (a: A) => Either } /** * Takes two functions and an `Either` value, if the value is a `Left` the inner value is applied to the first function, * if the value is a `Right` the inner value is applied to the second function. * * @example * import { fold, left, right } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * * function onLeft(errors: Array): string { * return `Errors: ${errors.join(', ')}` * } * * function onRight(value: number): string { * return `Ok: ${value}` * } * * assert.strictEqual( * pipe( * right(1), * fold(onLeft, onRight) * ), * 'Ok: 1' * ) * assert.strictEqual( * pipe( * left(['error 1', 'error 2']), * fold(onLeft, onRight) * ), * 'Errors: error 1, error 2' * ) * * @category destructors * @since 2.0.0 */ export declare function fold(onLeft: (e: E) => B, onRight: (a: A) => B): (ma: Either) => B /** * Less strict version of [`getOrElse`](#getOrElse). * * @category destructors * @since 2.6.0 */ export declare const getOrElseW: (onLeft: (e: E) => B) => (ma: Either) => B | A /** * Returns the wrapped value if it's a `Right` or a default value if is a `Left`. * * @example * import { getOrElse, left, right } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual( * pipe( * right(1), * getOrElse(() => 0) * ), * 1 * ) * assert.deepStrictEqual( * pipe( * left('error'), * getOrElse(() => 0) * ), * 0 * ) * * @category destructors * @since 2.0.0 */ export declare const getOrElse: (onLeft: (e: E) => A) => (ma: Either) => A /** * @category combinators * @since 2.9.0 */ export declare function fromNullableK( e: E ): , B>(f: (...a: A) => B | null | undefined) => (...a: A) => Either> /** * @category combinators * @since 2.9.0 */ export declare function chainNullableK( e: E ): (f: (a: A) => B | null | undefined) => (ma: Either) => Either> /** * Returns a `Right` if is a `Left` (and vice versa). * * @category combinators * @since 2.0.0 */ export declare function swap(ma: Either): Either /** * Useful for recovering from errors. * * @category combinators * @since 2.0.0 */ export declare function orElse(onLeft: (e: E) => Either): (ma: Either) => Either /** * Less strict version of [`filterOrElse`](#filterOrElse). * * @since 2.9.0 */ export declare const filterOrElseW: { (refinement: Refinement, onFalse: (a: A) => E2): ( ma: Either ) => Either (predicate: Predicate, onFalse: (a: A) => E2): (ma: Either) => Either } /** * Derivable from `MonadThrow`. * * @example * import { filterOrElse, left, right } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual( * pipe( * right(1), * filterOrElse( * (n) => n > 0, * () => 'error' * ) * ), * right(1) * ) * assert.deepStrictEqual( * pipe( * right(-1), * filterOrElse( * (n) => n > 0, * () => 'error' * ) * ), * left('error') * ) * assert.deepStrictEqual( * pipe( * left('a'), * filterOrElse( * (n) => n > 0, * () => 'error' * ) * ), * left('a') * ) * * @category combinators * @since 2.0.0 */ export declare const filterOrElse: { (refinement: Refinement, onFalse: (a: A) => E): (ma: Either) => Either (predicate: Predicate, onFalse: (a: A) => E): (ma: Either) => Either } /** * `map` can be used to turn functions `(a: A) => B` into functions `(fa: F) => F` whose argument and return types * use the type constructor `F` to represent some computational context. * * @category Functor * @since 2.0.0 */ export declare const map: (f: (a: A) => B) => (fa: Either) => Either /** * Map a pair of functions over the two type arguments of the bifunctor. * * @category Bifunctor * @since 2.0.0 */ export declare const bimap: (f: (e: E) => G, g: (a: A) => B) => (fa: Either) => Either /** * Map a function over the first type argument of a bifunctor. * * @category Bifunctor * @since 2.0.0 */ export declare const mapLeft: (f: (e: E) => G) => (fa: Either) => Either /** * Less strict version of [`ap`](#ap). * * @category Apply * @since 2.8.0 */ export declare const apW: (fa: Either) => (fab: Either B>) => Either /** * Apply a function to an argument under a type constructor. * * @category Apply * @since 2.0.0 */ export declare const ap: (fa: Either) => (fab: Either B>) => Either /** * Combine two effectful actions, keeping only the result of the first. * * Derivable from `Apply`. * * @category combinators * @since 2.0.0 */ export declare const apFirst: (fb: Either) => (fa: Either) => Either /** * Combine two effectful actions, keeping only the result of the second. * * Derivable from `Apply`. * * @category combinators * @since 2.0.0 */ export declare const apSecond: (fb: Either) => (fa: Either) => Either /** * Wrap a value into the type constructor. * * Equivalent to [`right`](#right). * * @example * import * as E from 'fp-ts/Either' * * assert.deepStrictEqual(E.of('a'), E.right('a')) * * @category Applicative * @since 2.7.0 */ export declare const of: Applicative2['of'] /** * Less strict version of [`chain`](#chain). * * @category Monad * @since 2.6.0 */ export declare const chainW: (f: (a: A) => Either) => (ma: Either) => Either /** * Composes computations in sequence, using the return value of one computation to determine the next computation. * * @category Monad * @since 2.0.0 */ export declare const chain: (f: (a: A) => Either) => (ma: Either) => Either /** * Less strict version of [`chainFirst`](#chainFirst) * * Derivable from `Monad`. * * @category combinators * @since 2.8.0 */ export declare const chainFirstW: (f: (a: A) => Either) => (ma: Either) => Either /** * Composes computations in sequence, using the return value of one computation to determine the next computation and * keeping only the result of the first. * * Derivable from `Monad`. * * @category combinators * @since 2.0.0 */ export declare const chainFirst: (f: (a: A) => Either) => (ma: Either) => Either /** * The `flatten` function is the conventional monad join operator. It is used to remove one level of monadic structure, projecting its bound argument into the outer level. * * Derivable from `Monad`. * * @example * import * as E from 'fp-ts/Either' * * assert.deepStrictEqual(E.flatten(E.right(E.right('a'))), E.right('a')) * assert.deepStrictEqual(E.flatten(E.right(E.left('e'))), E.left('e')) * assert.deepStrictEqual(E.flatten(E.left('e')), E.left('e')) * * @category combinators * @since 2.0.0 */ export declare const flatten: (mma: Either>) => Either /** * Less strict version of [`alt`](#alt). * * @category Alt * @since 2.9.0 */ export declare const altW: (that: Lazy>) => (fa: Either) => Either /** * Identifies an associative operation on a type constructor. It is similar to `Semigroup`, except that it applies to * types of kind `* -> *`. * * @category Alt * @since 2.0.0 */ export declare const alt: (that: Lazy>) => (fa: Either) => Either /** * @category Extend * @since 2.0.0 */ export declare const extend: (f: (wa: Either) => B) => (wa: Either) => Either /** * Derivable from `Extend`. * * @category combinators * @since 2.0.0 */ export declare const duplicate: (ma: Either) => Either> /** * Left-associative fold of a structure. * * @example * import { pipe } from 'fp-ts/function' * import * as E from 'fp-ts/Either' * * const startWith = 'prefix' * const concat = (a: string, b: string) => `${a}:${b}` * * assert.deepStrictEqual( * pipe(E.right('a'), E.reduce(startWith, concat)), * 'prefix:a', * ) * * assert.deepStrictEqual( * pipe(E.left('e'), E.reduce(startWith, concat)), * 'prefix', * ) * * @category Foldable * @since 2.0.0 */ export declare const reduce: (b: B, f: (b: B, a: A) => B) => (fa: Either) => B /** * Map each element of the structure to a monoid, and combine the results. * * @example * import { pipe } from 'fp-ts/function'; * import * as E from 'fp-ts/Either' * import { monoidString } from 'fp-ts/Monoid' * * const yell = (a: string) => `${a}!` * * assert.deepStrictEqual( * pipe(E.right('a'), E.foldMap(monoidString)(yell)), * 'a!', * ) * * assert.deepStrictEqual( * pipe(E.left('e'), E.foldMap(monoidString)(yell)), * monoidString.empty, * ) * * @category Foldable * @since 2.0.0 */ export declare const foldMap: (M: Monoid) => (f: (a: A) => M) => (fa: Either) => M /** * Right-associative fold of a structure. * * @example * import { pipe } from 'fp-ts/function' * import * as E from 'fp-ts/Either' * * const startWith = 'postfix' * const concat = (a: string, b: string) => `${a}:${b}` * * assert.deepStrictEqual( * pipe(E.right('a'), E.reduceRight(startWith, concat)), * 'a:postfix', * ) * * assert.deepStrictEqual( * pipe(E.left('e'), E.reduceRight(startWith, concat)), * 'postfix', * ) * * @category Foldable * @since 2.0.0 */ export declare const reduceRight: (b: B, f: (a: A, b: B) => B) => (fa: Either) => B /** * Map each element of a structure to an action, evaluate these actions from left to right, and collect the results. * * @example * import { pipe } from 'fp-ts/function' * import * as A from 'fp-ts/Array' * import * as E from 'fp-ts/Either' * import * as O from 'fp-ts/Option' * * assert.deepStrictEqual( * pipe(E.right(['a']), E.traverse(O.option)(A.head)), * O.some(E.right('a')), * ) * * assert.deepStrictEqual( * pipe(E.right([]), E.traverse(O.option)(A.head)), * O.none, * ) * * @category Traversable * @since 2.6.3 */ export declare const traverse: PipeableTraverse2 /** * Evaluate each monadic action in the structure from left to right, and collect the results. * * @example * import { pipe } from 'fp-ts/function' * import * as E from 'fp-ts/Either' * import * as O from 'fp-ts/Option' * * assert.deepStrictEqual( * pipe(E.right(O.some('a')), E.sequence(O.option)), * O.some(E.right('a')), * ) * * assert.deepStrictEqual( * pipe(E.right(O.none), E.sequence(O.option)), * O.none * ) * * @category Traversable * @since 2.6.3 */ export declare const sequence: Traversable2['sequence'] /** * @category MonadThrow * @since 2.6.3 */ export declare const throwError: MonadThrow2['throwError'] /** * @category instances * @since 2.0.0 */ export declare const URI = 'Either' /** * @category instances * @since 2.0.0 */ export declare type URI = typeof URI declare module './HKT' { interface URItoKind2 { readonly [URI]: Either } } /** * @category instances * @since 2.0.0 */ export declare function getShow(SE: Show, SA: Show): Show> /** * @category instances * @since 2.0.0 */ export declare function getEq(EL: Eq, EA: Eq): Eq> /** * Semigroup returning the left-most non-`Left` value. If both operands are `Right`s then the inner values are * concatenated using the provided `Semigroup` * * @example * import { getSemigroup, left, right } from 'fp-ts/Either' * import { semigroupSum } from 'fp-ts/Semigroup' * * const S = getSemigroup(semigroupSum) * assert.deepStrictEqual(S.concat(left('a'), left('b')), left('a')) * assert.deepStrictEqual(S.concat(left('a'), right(2)), right(2)) * assert.deepStrictEqual(S.concat(right(1), left('b')), right(1)) * assert.deepStrictEqual(S.concat(right(1), right(2)), right(3)) * * @category instances * @since 2.0.0 */ export declare function getSemigroup(S: Semigroup): Semigroup> /** * Semigroup returning the left-most `Left` value. If both operands are `Right`s then the inner values * are concatenated using the provided `Semigroup` * * @example * import { getApplySemigroup, left, right } from 'fp-ts/Either' * import { semigroupSum } from 'fp-ts/Semigroup' * * const S = getApplySemigroup(semigroupSum) * assert.deepStrictEqual(S.concat(left('a'), left('b')), left('a')) * assert.deepStrictEqual(S.concat(left('a'), right(2)), left('a')) * assert.deepStrictEqual(S.concat(right(1), left('b')), left('b')) * assert.deepStrictEqual(S.concat(right(1), right(2)), right(3)) * * @category instances * @since 2.0.0 */ export declare function getApplySemigroup(S: Semigroup): Semigroup> /** * @category instances * @since 2.0.0 */ export declare function getApplyMonoid(M: Monoid): Monoid> /** * Builds a `Filterable` instance for `Either` given `Monoid` for the left side * * @category instances * @since 3.0.0 */ export declare function getFilterable(M: Monoid): Filterable2C /** * Builds `Witherable` instance for `Either` given `Monoid` for the left side * * @category instances * @since 2.0.0 */ export declare function getWitherable(M: Monoid): Witherable2C /** * @category instances * @since 2.7.0 */ export declare function getApplicativeValidation(SE: Semigroup): Applicative2C /** * @category instances * @since 2.7.0 */ export declare function getAltValidation(SE: Semigroup): Alt2C /** * @category instances * @since 2.0.0 */ export declare function getValidation( SE: Semigroup ): Monad2C & Foldable2 & Traversable2 & Bifunctor2 & Alt2C & Extend2 & ChainRec2C & MonadThrow2C /** * @category instances * @since 2.0.0 */ export declare function getValidationSemigroup(SE: Semigroup, SA: Semigroup): Semigroup> /** * @category instances * @since 2.7.0 */ export declare const Functor: Functor2 /** * @category instances * @since 2.7.0 */ export declare const Applicative: Applicative2 /** * @category instances * @since 2.7.0 */ export declare const Monad: Monad2 /** * @category instances * @since 2.7.0 */ export declare const Foldable: Foldable2 /** * @category instances * @since 2.7.0 */ export declare const Traversable: Traversable2 /** * @category instances * @since 2.7.0 */ export declare const Bifunctor: Bifunctor2 /** * @category instances * @since 2.7.0 */ export declare const Alt: Alt2 /** * @category instances * @since 2.7.0 */ export declare const Extend: Extend2 /** * @category instances * @since 2.7.0 */ export declare const ChainRec: ChainRec2 /** * @category instances * @since 2.7.0 */ export declare const MonadThrow: MonadThrow2 /** * @category instances * @since 2.0.0 */ export declare function getValidationMonoid(SE: Semigroup, SA: Monoid): Monoid> /** * @category instances * @since 2.0.0 */ export declare const either: Monad2 & Foldable2 & Traversable2 & Bifunctor2 & Alt2 & Extend2 & ChainRec2 & MonadThrow2 /** * Default value for the `onError` argument of `tryCatch` * * @since 2.0.0 */ export declare function toError(e: unknown): Error /** * @since 2.0.0 */ export declare function elem(E: Eq): (a: A, ma: Either) => boolean /** * Returns `false` if `Left` or returns the result of the application of the given predicate to the `Right` value. * * @example * import { exists, left, right } from 'fp-ts/Either' * * const gt2 = exists((n: number) => n > 2) * * assert.strictEqual(gt2(left('a')), false) * assert.strictEqual(gt2(right(1)), false) * assert.strictEqual(gt2(right(3)), true) * * @since 2.0.0 */ export declare function exists(predicate: Predicate): (ma: Either) => boolean /** * @since 2.9.0 */ export declare const Do: Either /** * @since 2.8.0 */ export declare const bindTo: (name: N) => (fa: Either) => Either /** * @since 2.8.0 */ export declare const bindW: ( name: Exclude, f: (a: A) => Either ) => (fa: Either) => Either /** * @since 2.8.0 */ export declare const bind: ( name: Exclude, f: (a: A) => Either ) => ( fa: Either ) => Either< E, { [K in keyof A | N]: K extends keyof A ? A[K] : B } > /** * @since 2.8.0 */ export declare const apSW: ( name: Exclude, fb: Either ) => (fa: Either) => Either /** * @since 2.8.0 */ export declare const apS: ( name: Exclude, fb: Either ) => ( fa: Either ) => Either< E, { [K in keyof A | N]: K extends keyof A ? A[K] : B } > /** * * @since 2.9.0 */ export declare const traverseArrayWithIndex: ( f: (index: number, a: A) => Either ) => (arr: readonly A[]) => Either /** * map an array using provided function to Either then transform to Either of the array * this function have the same behavior of `A.traverse(E.either)` but it's optimized and perform better * * @example * * * import { traverseArray, left, right, fromPredicate } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * import * as A from 'fp-ts/Array' * * const arr = A.range(0, 10) * assert.deepStrictEqual( * pipe( * arr, * traverseArray((x) => right(x)) * ), * right(arr) * ) * assert.deepStrictEqual( * pipe( * arr, * traverseArray( * fromPredicate( * (x) => x > 5, * () => 'a' * ) * ) * ), * left('a') * ) * @since 2.9.0 */ export declare const traverseArray: ( f: (a: A) => Either ) => (arr: ReadonlyArray) => Either> /** * convert an array of either to an either of array * this function have the same behavior of `A.sequence(E.either)` but it's optimized and perform better * * @example * * import { sequenceArray, left, right } from 'fp-ts/Either' * import { pipe } from 'fp-ts/function' * import * as A from 'fp-ts/Array' * * const arr = A.range(0, 10) * assert.deepStrictEqual(pipe(arr, A.map(right), sequenceArray), right(arr)) * assert.deepStrictEqual(pipe(arr, A.map(right), A.cons(left('Error')), sequenceArray), left('Error')) * * @since 2.9.0 */ export declare const sequenceArray: (arr: ReadonlyArray>) => Either>