import { getApplicativeMonoid } from './Applicative'; import { ap as ap_, apFirst as apFirst_, apS as apS_, apSecond as apSecond_, getApplySemigroup as getApplySemigroup_ } from './Apply'; import { bind as bind_, chainFirst as chainFirst_ } from './Chain'; import { compact as compact_, separate as separate_ } from './Compactable'; import * as E from './Either'; import * as ET from './EitherT'; import { filter as filter_, filterMap as filterMap_, partition as partition_, partitionMap as partitionMap_ } from './Filterable'; import { chainEitherK as chainEitherK_, chainFirstEitherK as chainFirstEitherK_, chainOptionK as chainOptionK_, filterOrElse as filterOrElse_, fromEitherK as fromEitherK_, fromOption as fromOption_, fromOptionK as fromOptionK_, fromPredicate as fromPredicate_ } from './FromEither'; import { chainFirstIOK as chainFirstIOK_, chainIOK as chainIOK_, fromIOK as fromIOK_ } from './FromIO'; import { flow, identity, pipe, SK } from './function'; import { bindTo as bindTo_, flap as flap_, let as let__ } from './Functor'; import * as _ from './internal'; import * as I from './IO'; // ------------------------------------------------------------------------------------- // constructors // ------------------------------------------------------------------------------------- /** * @category constructors * @since 2.0.0 */ export var left = /*#__PURE__*/ ET.left(I.Pointed); /** * @category constructors * @since 2.0.0 */ export var right = /*#__PURE__*/ ET.right(I.Pointed); /** * @category constructors * @since 2.0.0 */ export var rightIO = /*#__PURE__*/ ET.rightF(I.Functor); /** * @category constructors * @since 2.0.0 */ export var leftIO = /*#__PURE__*/ ET.leftF(I.Functor); // ------------------------------------------------------------------------------------- // conversions // ------------------------------------------------------------------------------------- /** * @category conversions * @since 2.0.0 */ export var fromEither = I.of; /** * @category conversions * @since 2.7.0 */ export var fromIO = rightIO; /** * @category pattern matching * @since 2.10.0 */ export var match = /*#__PURE__*/ ET.match(I.Functor); /** * Less strict version of [`match`](#match). * * The `W` suffix (short for **W**idening) means that the handler return types will be merged. * * @category pattern matching * @since 2.10.0 */ export var matchW = match; /** * The `E` suffix (short for **E**ffect) means that the handlers return an effect (`IO`). * * @category pattern matching * @since 2.10.0 */ export var matchE = /*#__PURE__*/ ET.matchE(I.Monad); /** * Alias of [`matchE`](#matche). * * @category pattern matching * @since 2.0.0 */ export var fold = matchE; /** * Less strict version of [`matchE`](#matche). * * The `W` suffix (short for **W**idening) means that the handler return types will be merged. * * @category pattern matching * @since 2.10.0 */ export var matchEW = matchE; /** * Alias of [`matchEW`](#matchew). * * @category pattern matching * @since 2.10.0 */ export var foldW = matchEW; /** * @category error handling * @since 2.0.0 */ export var getOrElse = /*#__PURE__*/ ET.getOrElse(I.Monad); /** * Less strict version of [`getOrElse`](#getorelse). * * The `W` suffix (short for **W**idening) means that the handler return type will be merged. * * @category error handling * @since 2.6.0 */ export var getOrElseW = getOrElse; /** * Constructs a new `IOEither` from a function that performs a side effect and might throw * * See also [`tryCatchK`](#trycatchk). * * @category interop * @since 2.0.0 */ export var tryCatch = function (f, onThrow) { return function () { return E.tryCatch(f, onThrow); }; }; /** * Converts a function that may throw to one returning a `IOEither`. * * @category interop * @since 2.10.0 */ export var tryCatchK = function (f, onThrow) { return function () { var a = []; for (var _i = 0; _i < arguments.length; _i++) { a[_i] = arguments[_i]; } return tryCatch(function () { return f.apply(void 0, a); }, onThrow); }; }; /** * @category conversions * @since 2.10.0 */ export var toUnion = /*#__PURE__*/ ET.toUnion(I.Functor); // ------------------------------------------------------------------------------------- // combinators // ------------------------------------------------------------------------------------- /** * @category error handling * @since 2.0.0 */ export var orElse = /*#__PURE__*/ ET.orElse(I.Monad); /** * Less strict version of [`orElse`](#orelse). * * The `W` suffix (short for **W**idening) means that the return types will be merged. * * @category error handling * @since 2.10.0 */ export var orElseW = orElse; /** * @category error handling * @since 2.11.0 */ export var orElseFirst = /*#__PURE__*/ ET.orElseFirst(I.Monad); /** * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category error handling * @since 2.11.0 */ export var orElseFirstW = orElseFirst; /** * @category error handling * @since 2.12.0 */ export var orElseFirstIOK = function (onLeft) { return orElseFirst(fromIOK(onLeft)); }; /** * @category error handling * @since 2.11.0 */ export var orLeft = /*#__PURE__*/ ET.orLeft(I.Monad); /** * @since 2.0.0 */ export var swap = /*#__PURE__*/ ET.swap(I.Functor); /* istanbul ignore next */ var _map = function (fa, f) { return pipe(fa, map(f)); }; /* istanbul ignore next */ var _ap = function (fab, fa) { return pipe(fab, ap(fa)); }; var _apSeq = function (fab, fa) { return pipe(fab, chain(function (f) { return pipe(fa, map(f)); })); }; /* istanbul ignore next */ var _chain = function (ma, f) { return pipe(ma, chain(f)); }; /* istanbul ignore next */ var _bimap = function (fa, f, g) { return pipe(fa, bimap(f, g)); }; /* istanbul ignore next */ var _mapLeft = function (fa, f) { return pipe(fa, mapLeft(f)); }; /* istanbul ignore next */ var _alt = function (fa, that) { return pipe(fa, alt(that)); }; /** * `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 mapping * @since 2.0.0 */ export var map = /*#__PURE__*/ ET.map(I.Functor); /** * Map a pair of functions over the two type arguments of the bifunctor. * * @category mapping * @since 2.0.0 */ export var bimap = /*#__PURE__*/ ET.bimap(I.Functor); /** * Map a function over the first type argument of a bifunctor. * * @category error handling * @since 2.0.0 */ export var mapLeft = /*#__PURE__*/ ET.mapLeft(I.Functor); /** * @since 2.0.0 */ export var ap = /*#__PURE__*/ ET.ap(I.Apply); /** * Less strict version of [`ap`](#ap). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @since 2.8.0 */ export var apW = ap; /** * @category constructors * @since 2.8.5 */ export var of = right; /** * Composes computations in sequence, using the return value of one computation to determine the next computation. * * @category sequencing * @since 2.0.0 */ export var chain = /*#__PURE__*/ ET.chain(I.Monad); /** * Less strict version of [`chain`](#chain). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category sequencing * @since 2.6.0 */ export var chainW = chain; /** * Less strict version of [`flatten`](#flatten). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category sequencing * @since 2.11.0 */ export var flattenW = /*#__PURE__*/ chainW(identity); /** * @category sequencing * @since 2.0.0 */ export var flatten = flattenW; /** * Identifies an associative operation on a type constructor. It is similar to `Semigroup`, except that it applies to * types of kind `* -> *`. * * @category error handling * @since 2.0.0 */ export var alt = /*#__PURE__*/ ET.alt(I.Monad); /** * Less strict version of [`alt`](#alt). * * The `W` suffix (short for **W**idening) means that the error and the return types will be merged. * * @category error handling * @since 2.9.0 */ export var altW = alt; /** * @since 2.7.0 */ export var throwError = left; /** * @category type lambdas * @since 2.0.0 */ export var URI = 'IOEither'; /** * The default [`ApplicativePar`](#applicativepar) instance returns the first error, if you want to * get all errors you need to provide a way to concatenate them via a `Semigroup`. * * See [`getApplicativeValidation`](./Either.ts.html#getapplicativevalidation). * * @category error handling * @since 2.7.0 */ export function getApplicativeIOValidation(S) { var ap = ap_(I.Apply, E.getApplicativeValidation(S)); return { URI: URI, _E: undefined, map: _map, ap: function (fab, fa) { return pipe(fab, ap(fa)); }, of: of }; } /** * The default [`Alt`](#alt) instance returns the last error, if you want to * get all errors you need to provide a way to concatenate them via a `Semigroup`. * * See [`getAltValidation`](./Either.ts.html#getaltvalidation). * * @category error handling * @since 2.7.0 */ export function getAltIOValidation(S) { var alt = ET.altValidation(I.Monad, S); return { URI: URI, _E: undefined, map: _map, alt: function (fa, that) { return pipe(fa, alt(that)); } }; } /** * @category filtering * @since 2.10.0 */ export var getCompactable = function (M) { var C = E.getCompactable(M); return { URI: URI, _E: undefined, compact: compact_(I.Functor, C), separate: separate_(I.Functor, C, E.Functor) }; }; /** * @category filtering * @since 2.1.0 */ export function getFilterable(M) { var F = E.getFilterable(M); var C = getCompactable(M); var filter = filter_(I.Functor, F); var filterMap = filterMap_(I.Functor, F); var partition = partition_(I.Functor, F); var partitionMap = partitionMap_(I.Functor, F); return { URI: URI, _E: undefined, map: _map, compact: C.compact, separate: C.separate, filter: function (fa, predicate) { return pipe(fa, filter(predicate)); }, filterMap: function (fa, f) { return pipe(fa, filterMap(f)); }, partition: function (fa, predicate) { return pipe(fa, partition(predicate)); }, partitionMap: function (fa, f) { return pipe(fa, partitionMap(f)); } }; } /** * @category instances * @since 2.7.0 */ export var Functor = { URI: URI, map: _map }; /** * @category mapping * @since 2.10.0 */ export var flap = /*#__PURE__*/ flap_(Functor); /** * @category instances * @since 2.10.0 */ export var Pointed = { URI: URI, of: of }; /** * @category instances * @since 2.7.0 */ export var Bifunctor = { URI: URI, bimap: _bimap, mapLeft: _mapLeft }; /** * Runs computations in parallel. * * @category instances * @since 2.10.0 */ export var ApplyPar = { URI: URI, map: _map, ap: _ap }; /** * Combine two effectful actions, keeping only the result of the first. * * @since 2.0.0 */ export var apFirst = /*#__PURE__*/ apFirst_(ApplyPar); /** * Less strict version of [`apFirst`](#apfirst). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @since 2.12.0 */ export var apFirstW = apFirst; /** * Combine two effectful actions, keeping only the result of the second. * * @since 2.0.0 */ export var apSecond = /*#__PURE__*/ apSecond_(ApplyPar); /** * Less strict version of [`apSecond`](#apsecond). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @since 2.12.0 */ export var apSecondW = apSecond; /** * Runs computations in parallel. * * @category instances * @since 2.8.4 */ export var ApplicativePar = { URI: URI, map: _map, ap: _ap, of: of }; /** * Runs computations sequentially. * * @category instances * @since 2.8.4 */ export var ApplicativeSeq = { URI: URI, map: _map, ap: _apSeq, of: of }; /** * @category instances * @since 2.10.0 */ export var Chain = { URI: URI, map: _map, ap: _ap, chain: _chain }; /** * @category instances * @since 2.7.0 */ export var Monad = { URI: URI, map: _map, ap: _ap, of: of, chain: _chain }; /** * Composes computations in sequence, using the return value of one computation to determine the next computation and * keeping only the result of the first. * * @category sequencing * @since 2.0.0 */ export var chainFirst = /*#__PURE__*/ chainFirst_(Chain); /** * Less strict version of [`chainFirst`](#chainfirst). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category sequencing * @since 2.8.0 */ export var chainFirstW = chainFirst; /** * @category instances * @since 2.7.0 */ export var Alt = { URI: URI, map: _map, alt: _alt }; /** * @category instances * @since 2.7.0 */ export var MonadIO = { URI: URI, map: _map, ap: _ap, of: of, chain: _chain, fromIO: fromIO }; /** * @category instances * @since 2.7.0 */ export var MonadThrow = { URI: URI, map: _map, ap: _ap, of: of, chain: _chain, throwError: throwError }; /** * @category instances * @since 2.10.0 */ export var FromIO = { URI: URI, fromIO: fromIO }; /** * @category lifting * @since 2.10.0 */ export var fromIOK = /*#__PURE__*/ fromIOK_(FromIO); /** * @category sequencing * @since 2.10.0 */ export var chainIOK = /*#__PURE__*/ chainIOK_(FromIO, Chain); /** * @category sequencing * @since 2.10.0 */ export var chainFirstIOK = /*#__PURE__*/ chainFirstIOK_(FromIO, Chain); /** * @category instances * @since 2.10.0 */ export var FromEither = { URI: URI, fromEither: fromEither }; /** * @category conversions * @since 2.0.0 */ export var fromOption = /*#__PURE__*/ fromOption_(FromEither); /** * @category lifting * @since 2.10.0 */ export var fromOptionK = /*#__PURE__*/ fromOptionK_(FromEither); /** * @category sequencing * @since 2.10.0 */ export var chainOptionK = /*#__PURE__*/ chainOptionK_(FromEither, Chain); /** * @category sequencing * @since 2.4.0 */ export var chainEitherK = /*#__PURE__*/ chainEitherK_(FromEither, Chain); /** * Less strict version of [`chainEitherK`](#chaineitherk). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category sequencing * @since 2.6.1 */ export var chainEitherKW = chainEitherK; /** * @category sequencing * @since 2.12.0 */ export var chainFirstEitherK = /*#__PURE__*/ chainFirstEitherK_(FromEither, Chain); /** * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category sequencing * @since 2.12.0 */ export var chainFirstEitherKW = chainFirstEitherK; /** * @category lifting * @since 2.0.0 */ export var fromPredicate = /*#__PURE__*/ fromPredicate_(FromEither); /** * @category filtering * @since 2.0.0 */ export var filterOrElse = /*#__PURE__*/ filterOrElse_(FromEither, Chain); /** * Less strict version of [`filterOrElse`](#filterorelse). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category filtering * @since 2.9.0 */ export var filterOrElseW = filterOrElse; /** * @category lifting * @since 2.4.0 */ export var fromEitherK = /*#__PURE__*/ fromEitherK_(FromEither); // ------------------------------------------------------------------------------------- // utils // ------------------------------------------------------------------------------------- /** * Make sure that a resource is cleaned up in the event of an exception (\*). The release action is called regardless of * whether the body action throws (\*) or returns. * * (\*) i.e. returns a `Left` * * @since 2.0.0 */ export var bracket = function (acquire, use, release) { return bracketW(acquire, use, release); }; /** * Less strict version of [`bracket`](#bracket). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @since 2.12.0 */ export var bracketW = function (acquire, use, release) { return pipe(acquire, chainW(function (a) { return pipe(use(a), I.chain(function (e) { return pipe(release(a, e), chainW(function () { return I.of(e); })); })); })); }; // ------------------------------------------------------------------------------------- // do notation // ------------------------------------------------------------------------------------- /** * @category do notation * @since 2.9.0 */ export var Do = /*#__PURE__*/ of(_.emptyRecord); /** * @category do notation * @since 2.8.0 */ export var bindTo = /*#__PURE__*/ bindTo_(Functor); var let_ = /*#__PURE__*/ let__(Functor); export { /** * @category do notation * @since 2.13.0 */ let_ as let }; /** * @category do notation * @since 2.8.0 */ export var bind = /*#__PURE__*/ bind_(Chain); /** * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category do notation * @since 2.8.0 */ export var bindW = bind; /** * @category do notation * @since 2.8.0 */ export var apS = /*#__PURE__*/ apS_(ApplyPar); /** * Less strict version of [`apS`](#aps). * * The `W` suffix (short for **W**idening) means that the error types will be merged. * * @category do notation * @since 2.8.0 */ export var apSW = apS; /** * @since 2.11.0 */ export var ApT = /*#__PURE__*/ of(_.emptyReadonlyArray); // ------------------------------------------------------------------------------------- // array utils // ------------------------------------------------------------------------------------- /** * Equivalent to `ReadonlyNonEmptyArray#traverseWithIndex(ApplicativePar)`. * * @category traversing * @since 2.11.0 */ export var traverseReadonlyNonEmptyArrayWithIndex = function (f) { return flow(I.traverseReadonlyNonEmptyArrayWithIndex(f), I.map(E.traverseReadonlyNonEmptyArrayWithIndex(SK))); }; /** * Equivalent to `ReadonlyArray#traverseWithIndex(ApplicativePar)`. * * @category traversing * @since 2.11.0 */ export var traverseReadonlyArrayWithIndex = function (f) { var g = traverseReadonlyNonEmptyArrayWithIndex(f); return function (as) { return (_.isNonEmpty(as) ? g(as) : ApT); }; }; /** * Equivalent to `ReadonlyNonEmptyArray#traverseWithIndex(ApplicativeSeq)`. * * @category traversing * @since 2.11.0 */ export var traverseReadonlyNonEmptyArrayWithIndexSeq = function (f) { return function (as) { return function () { var e = f(0, _.head(as))(); if (_.isLeft(e)) { return e; } var out = [e.right]; for (var i = 1; i < as.length; i++) { var e_1 = f(i, as[i])(); if (_.isLeft(e_1)) { return e_1; } out.push(e_1.right); } return _.right(out); }; }; }; /** * Equivalent to `ReadonlyArray#traverseWithIndex(ApplicativeSeq)`. * * @category traversing * @since 2.11.0 */ export var traverseReadonlyArrayWithIndexSeq = function (f) { var g = traverseReadonlyNonEmptyArrayWithIndexSeq(f); return function (as) { return (_.isNonEmpty(as) ? g(as) : ApT); }; }; /** * Equivalent to `ReadonlyArray#traverseWithIndex(Applicative)`. * * @category traversing * @since 2.9.0 */ export var traverseArrayWithIndex = traverseReadonlyArrayWithIndex; /** * Equivalent to `ReadonlyArray#traverse(Applicative)`. * * @category traversing * @since 2.9.0 */ export var traverseArray = function (f) { return traverseReadonlyArrayWithIndex(function (_, a) { return f(a); }); }; /** * Equivalent to `ReadonlyArray#sequence(Applicative)`. * * @category traversing * @since 2.9.0 */ export var sequenceArray = /*#__PURE__*/ traverseArray(identity); /** * Equivalent to `ReadonlyArray#traverseWithIndex(ApplicativeSeq)`. * * @category traversing * @since 2.9.0 */ export var traverseSeqArrayWithIndex = traverseReadonlyArrayWithIndexSeq; /** * Equivalent to `ReadonlyArray#traverse(ApplicativeSeq)`. * * @category traversing * @since 2.9.0 */ export var traverseSeqArray = function (f) { return traverseReadonlyArrayWithIndexSeq(function (_, a) { return f(a); }); }; /** * Equivalent to `ReadonlyArray#sequence(ApplicativeSeq)`. * * @category traversing * @since 2.9.0 */ export var sequenceSeqArray = /*#__PURE__*/ traverseSeqArray(identity); // ------------------------------------------------------------------------------------- // deprecated // ------------------------------------------------------------------------------------- /** * Use [`ApplicativePar`](#applicativepar) instead * * @category zone of death * @since 2.7.0 * @deprecated */ export var Applicative = ApplicativePar; // ------------------------------------------------------------------------------------- // deprecated // ------------------------------------------------------------------------------------- /** * 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'`) * * @category zone of death * @since 2.0.0 * @deprecated */ export var ioEither = { URI: URI, bimap: _bimap, mapLeft: _mapLeft, map: _map, of: of, ap: _ap, chain: _chain, alt: _alt, fromIO: fromIO, throwError: throwError }; /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export var getApplySemigroup = /*#__PURE__*/ getApplySemigroup_(ApplyPar); /** * Use [`getApplicativeMonoid`](./Applicative.ts.html#getapplicativemonoid) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export var getApplyMonoid = /*#__PURE__*/ getApplicativeMonoid(ApplicativePar); /** * Use [`getApplySemigroup`](./Apply.ts.html#getapplysemigroup) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export var getSemigroup = function (S) { return getApplySemigroup_(I.Apply)(E.getSemigroup(S)); }; /** * Use [`getApplicativeIOValidation`](#getapplicativeiovalidation) and [`getAltIOValidation`](#getaltiovalidation). * * @category zone of death * @since 2.0.0 * @deprecated */ export function getIOValidation(SE) { var applicativeIOValidation = getApplicativeIOValidation(SE); var altIOValidation = getAltIOValidation(SE); return { URI: URI, _E: undefined, map: _map, ap: applicativeIOValidation.ap, of: of, chain: _chain, bimap: _bimap, mapLeft: _mapLeft, alt: altIOValidation.alt, fromIO: fromIO, throwError: throwError }; }