/** * The `Applicative` type class extends the `Apply` type class with a `of` function, which can be used to create values * of type `f a` from values of type `a`. * * Where `Apply` provides the ability to lift functions of two or more arguments to functions whose arguments are * wrapped using `f`, and `Functor` provides the ability to lift functions of one argument, `pure` can be seen as the * function which lifts functions of _zero_ arguments. That is, `Applicative` functors support a lifting operation for * any number of function arguments. * * Instances must satisfy the following laws in addition to the `Apply` laws: * * 1. Identity: `A.ap(A.of(a => a), fa) <-> fa` * 2. Homomorphism: `A.ap(A.of(ab), A.of(a)) <-> A.of(ab(a))` * 3. Interchange: `A.ap(fab, A.of(a)) <-> A.ap(A.of(ab => ab(a)), fab)` * * Note. `Functor`'s `map` can be derived: `A.map(x, f) = A.ap(A.of(f), x)` * * @since 2.0.0 */ import { Apply, Apply1, Apply2, Apply2C, Apply3, Apply4, Apply3C } from './Apply' import { FunctorComposition, FunctorCompositionHKT1, FunctorCompositionHKT2, FunctorComposition11, FunctorComposition12, FunctorComposition12C, FunctorComposition21, FunctorComposition22, FunctorComposition22C, FunctorComposition2C1, FunctorCompositionHKT2C } from './Functor' import { HKT, Kind, Kind2, Kind3, Kind4, URIS, URIS2, URIS3, URIS4 } from './HKT' /** * @category type classes * @since 2.0.0 */ export interface Applicative extends Apply { readonly of: (a: A) => HKT } /** * @category type classes * @since 2.0.0 */ export interface Applicative1 extends Apply1 { readonly of: (a: A) => Kind } /** * @category type classes * @since 2.0.0 */ export interface Applicative2 extends Apply2 { readonly of: (a: A) => Kind2 } /** * @category type classes * @since 2.0.0 */ export interface Applicative2C extends Apply2C { readonly of: (a: A) => Kind2 } /** * @category type classes * @since 2.0.0 */ export interface Applicative3 extends Apply3 { readonly of: (a: A) => Kind3 } /** * @category type classes * @since 2.2.0 */ export interface Applicative3C extends Apply3C { readonly of: (a: A) => Kind3 } /** * @category type classes * @since 2.0.0 */ export interface Applicative4 extends Apply4 { readonly of: (a: A) => Kind4 } /** * @since 2.0.0 */ export interface ApplicativeComposition extends FunctorComposition { readonly of: (a: A) => HKT> readonly ap: (fgab: HKT B>>, fga: HKT>) => HKT> } /** * @since 2.0.0 */ export interface ApplicativeCompositionHKT1 extends FunctorCompositionHKT1 { readonly of: (a: A) => HKT> readonly ap: (fgab: HKT B>>, fga: HKT>) => HKT> } /** * @since 2.0.0 */ export interface ApplicativeCompositionHKT2 extends FunctorCompositionHKT2 { readonly of: (a: A) => HKT> readonly ap: (fgab: HKT B>>, fga: HKT>) => HKT> } /** * @since 2.0.0 */ export interface ApplicativeCompositionHKT2C extends FunctorCompositionHKT2C { readonly of: (a: A) => HKT> readonly ap: (fgab: HKT B>>, fga: HKT>) => HKT> } /** * @since 2.0.0 */ export interface ApplicativeComposition11 extends FunctorComposition11 { readonly of: (a: A) => Kind> readonly ap: (fgab: Kind B>>, fga: Kind>) => Kind> } /** * @since 2.0.0 */ export interface ApplicativeComposition12 extends FunctorComposition12 { readonly of: (a: A) => Kind> readonly ap: ( fgab: Kind B>>, fga: Kind> ) => Kind> } /** * @since 2.0.0 */ export interface ApplicativeComposition12C extends FunctorComposition12C { readonly of: (a: A) => Kind> readonly ap: (fgab: Kind B>>, fga: Kind>) => Kind> } /** * @since 2.0.0 */ export interface ApplicativeComposition21 extends FunctorComposition21 { readonly of: (a: A) => Kind2> readonly ap: ( fgab: Kind2 B>>, fga: Kind2> ) => Kind2> } /** * @since 2.0.0 */ export interface ApplicativeComposition2C1 extends FunctorComposition2C1 { readonly of: (a: A) => Kind2> readonly ap: (fgab: Kind2 B>>, fga: Kind2>) => Kind2> } /** * @since 2.0.0 */ export interface ApplicativeComposition22 extends FunctorComposition22 { readonly of: (a: A) => Kind2> readonly ap: ( fgab: Kind2 B>>, fga: Kind2> ) => Kind2> } /** * @since 2.0.0 */ export interface ApplicativeComposition22C extends FunctorComposition22C { readonly of: (a: A) => Kind2> readonly ap: ( fgab: Kind2 B>>, fga: Kind2> ) => Kind2> } /** * Like `Functor`, `Applicative`s compose. If `F` and `G` have `Applicative` instances, then so does `F>` * * @example * import { getApplicativeComposition } from 'fp-ts/Applicative' * import { option, Option, some } from 'fp-ts/Option' * import { task, Task } from 'fp-ts/Task' * * // an Applicative instance for Task> * const A = getApplicativeComposition(task, option) * * const x: Task> = task.of(some(1)) * const y: Task> = task.of(some(2)) * * const sum = (a: number) => (b: number): number => a + b * * A.ap(A.map(x, sum), y)() * .then(result => assert.deepStrictEqual(result, some(3))) * * @since 2.0.0 */ export declare function getApplicativeComposition( F: Applicative2, G: Applicative2C ): ApplicativeComposition22C export declare function getApplicativeComposition( F: Applicative2, G: Applicative2 ): ApplicativeComposition22 export declare function getApplicativeComposition( F: Applicative2, G: Applicative2C ): ApplicativeComposition22C export declare function getApplicativeComposition( F: Applicative2, G: Applicative1 ): ApplicativeComposition21 export declare function getApplicativeComposition( F: Applicative1, G: Applicative2 ): ApplicativeComposition12 export declare function getApplicativeComposition( F: Applicative1, G: Applicative2C ): ApplicativeComposition12C export declare function getApplicativeComposition( F: Applicative1, G: Applicative1 ): ApplicativeComposition11 export declare function getApplicativeComposition( F: Applicative, G: Applicative2 ): ApplicativeCompositionHKT2 export declare function getApplicativeComposition( F: Applicative, G: Applicative2C ): ApplicativeCompositionHKT2C export declare function getApplicativeComposition( F: Applicative, G: Applicative1 ): ApplicativeCompositionHKT1 export declare function getApplicativeComposition( F: Applicative, G: Applicative ): ApplicativeComposition