Innovenergy_trunk/frontend/node_modules/fp-ts/lib/Choice.d.ts

175 lines
6.8 KiB
TypeScript

/**
* The `Choice` class extends `Profunctor` with combinators for working with
* sum types.
*
* `left` and `right` lift values in a `Profunctor` to act on the `Left` and
* `Right` components of a sum, respectively.
*
* Looking at `Choice` through the intuition of inputs and outputs
* yields the following type signature:
*
* ```purescript
* left :: forall input output a. p input output -> p (Either input a) (Either output a)
* right :: forall input output a. p input output -> p (Either a input) (Either a output)
* ```
*
* If we specialize the profunctor `p` to the `function` arrow, we get the following type
* signatures:
*
* ```purescript
* left :: forall input output a. (input -> output) -> (Either input a) -> (Either output a)
* right :: forall input output a. (input -> output) -> (Either a input) -> (Either a output)
* ```
*
* When the `profunctor` is `Function` application, `left` allows you to map a function over the
* left side of an `Either`, and `right` maps it over the right side (same as `map` would do).
*
* Adapted from https://github.com/purescript/purescript-profunctor/blob/master/src/Data/Profunctor/Choice.purs
*
* @since 2.0.0
*/
import { Either } from './Either'
import { HKT2, Kind2, Kind3, URIS2, URIS3, URIS4, Kind4 } from './HKT'
import { Profunctor, Profunctor2, Profunctor3, Profunctor4 } from './Profunctor'
import { Category, Category2, Category3, Category4 } from './Category'
/**
* @category model
* @since 2.0.0
*/
export interface Choice<F> extends Profunctor<F> {
readonly left: <A, B, C>(pab: HKT2<F, A, B>) => HKT2<F, Either<A, C>, Either<B, C>>
readonly right: <A, B, C>(pbc: HKT2<F, B, C>) => HKT2<F, Either<A, B>, Either<A, C>>
}
/**
* @category model
* @since 2.0.0
*/
export interface Choice2<F extends URIS2> extends Profunctor2<F> {
readonly left: <A, B, C>(pab: Kind2<F, A, B>) => Kind2<F, Either<A, C>, Either<B, C>>
readonly right: <A, B, C>(pbc: Kind2<F, B, C>) => Kind2<F, Either<A, B>, Either<A, C>>
}
/**
* @category model
* @since 2.0.0
*/
export interface Choice3<F extends URIS3> extends Profunctor3<F> {
readonly left: <R, A, B, C>(pab: Kind3<F, R, A, B>) => Kind3<F, R, Either<A, C>, Either<B, C>>
readonly right: <R, A, B, C>(pbc: Kind3<F, R, B, C>) => Kind3<F, R, Either<A, B>, Either<A, C>>
}
/**
* @category model
* @since 2.0.0
*/
export interface Choice4<F extends URIS4> extends Profunctor4<F> {
readonly left: <S, R, A, B, C>(pab: Kind4<F, S, R, A, B>) => Kind4<F, S, R, Either<A, C>, Either<B, C>>
readonly right: <S, R, A, B, C>(pbc: Kind4<F, S, R, B, C>) => Kind4<F, S, R, Either<A, B>, Either<A, C>>
}
/**
* Compose a value acting on a sum from two values, each acting on one of
* the components of the sum.
*
* Specializing `split` to function application would look like this:
*
* ```purescript
* split :: forall a b c d. (a -> b) -> (c -> d) -> (Either a c) -> (Either b d)
* ```
*
* We take two functions, `f` and `g`, and we transform them into a single function which
* takes an `Either`and maps `f` over the left side and `g` over the right side. Just like
* `bimap` would do for the `Bifunctor` instance of `Either`.
*
* @since 2.10.0
*/
export declare function split<P extends URIS4>(
P: Choice4<P>,
C: Category4<P>
): <S, R, A, B, C, D>(
pab: Kind4<P, S, R, A, B>,
pcd: Kind4<P, S, R, C, D>
) => Kind4<P, S, R, Either<A, C>, Either<B, D>>
export declare function split<P extends URIS3>(
P: Choice3<P>,
C: Category3<P>
): <R, A, B, C, D>(pab: Kind3<P, R, A, B>, pcd: Kind3<P, R, C, D>) => Kind3<P, R, Either<A, C>, Either<B, D>>
export declare function split<P extends URIS2>(
P: Choice2<P>,
C: Category2<P>
): <A, B, C, D>(pab: Kind2<P, A, B>, pcd: Kind2<P, C, D>) => Kind2<P, Either<A, C>, Either<B, D>>
export declare function split<P>(
P: Choice<P>,
C: Category<P>
): <A, B, C, D>(pab: HKT2<P, A, B>, pcd: HKT2<P, C, D>) => HKT2<P, Either<A, C>, Either<B, D>>
/**
* Compose a value which eliminates a sum from two values, each eliminating
* one side of the sum.
*
* This combinator is useful when assembling values from smaller components,
* because it provides a way to support two different types of input.
*
* Specializing `fanIn` to function application would look like this:
*
* ```purescript
* fanIn :: forall a b c d. (a -> c) -> (b -> c) -> Either a b -> c
* ```
*
* We take two functions, `f` and `g`, which both return the same type `c` and we transform them into a
* single function which takes an `Either` value with the parameter type of `f` on the left side and
* the parameter type of `g` on the right side. The function then runs either `f` or `g`, depending on
* whether the `Either` value is a `Left` or a `Right`.
* This allows us to bundle two different computations which both have the same result type into one
* function which will run the appropriate computation based on the parameter supplied in the `Either` value.
*
* @since 2.10.0
*/
export declare function fanIn<P extends URIS4>(
P: Choice4<P>,
C: Category4<P>
): <S, R, A, B, C>(pac: Kind4<P, S, R, A, C>, pbc: Kind4<P, S, R, B, C>) => Kind4<P, S, R, Either<A, B>, C>
export declare function fanIn<P extends URIS3>(
P: Choice3<P>,
C: Category3<P>
): <R, A, B, C>(pac: Kind3<P, R, A, C>, pbc: Kind3<P, R, B, C>) => Kind3<P, R, Either<A, B>, C>
export declare function fanIn<P extends URIS2>(
P: Choice2<P>,
C: Category2<P>
): <A, B, C>(pac: Kind2<P, A, C>, pbc: Kind2<P, B, C>) => Kind2<P, Either<A, B>, C>
export declare function fanIn<P>(
P: Choice<P>,
C: Category<P>
): <A, B, C>(pac: HKT2<P, A, C>, pbc: HKT2<P, B, C>) => HKT2<P, Either<A, B>, C>
/**
* Use [`split`](#split) instead.
*
* @category zone of death
* @since 2.0.0
* @deprecated
*/
export declare function splitChoice<F extends URIS3>(
F: Category3<F> & Choice3<F>
): <R, A, B, C, D>(pab: Kind3<F, R, A, B>, pcd: Kind3<F, R, C, D>) => Kind3<F, R, Either<A, C>, Either<B, D>>
/** @deprecated */
export declare function splitChoice<F extends URIS2>(
F: Category2<F> & Choice2<F>
): <A, B, C, D>(pab: Kind2<F, A, B>, pcd: Kind2<F, C, D>) => Kind2<F, Either<A, C>, Either<B, D>>
/** @deprecated */
export declare function splitChoice<F>(
F: Category<F> & Choice<F>
): <A, B, C, D>(pab: HKT2<F, A, B>, pcd: HKT2<F, C, D>) => HKT2<F, Either<A, C>, Either<B, D>>
/**
* Use [`fanIn`](#fanIn) instead.
*
* @since 2.0.0
* @deprecated
*/
export declare function fanin<F extends URIS3>(
F: Category3<F> & Choice3<F>
): <R, A, B, C>(pac: Kind3<F, R, A, C>, pbc: Kind3<F, R, B, C>) => Kind3<F, R, Either<A, B>, C>
/** @deprecated */
export declare function fanin<F extends URIS2>(
F: Category2<F> & Choice2<F>
): <A, B, C>(pac: Kind2<F, A, C>, pbc: Kind2<F, B, C>) => Kind2<F, Either<A, B>, C>
/** @deprecated */
export declare function fanin<F>(
F: Category<F> & Choice<F>
): <A, B, C>(pac: HKT2<F, A, C>, pbc: HKT2<F, B, C>) => HKT2<F, Either<A, B>, C>