/** * The `Apply` class provides the `ap` which is used to apply a function to an argument under a type constructor. * * `Apply` can be used to lift functions of two or more arguments to work on values wrapped with the type constructor * `f`. * * Instances must satisfy the following law in addition to the `Functor` laws: * * 1. Associative composition: `F.ap(F.ap(F.map(fbc, bc => ab => a => bc(ab(a))), fab), fa) <-> F.ap(fbc, F.ap(fab, fa))` * * Formally, `Apply` represents a strong lax semi-monoidal endofunctor. * * @example * import * as O from 'fp-ts/Option' * import { pipe } from 'fp-ts/function' * * const f = (a: string) => (b: number) => (c: boolean) => a + String(b) + (c ? 'true' : 'false') * const fa: O.Option = O.some('s') * const fb: O.Option = O.some(1) * const fc: O.Option = O.some(true) * * assert.deepStrictEqual( * pipe( * // lift a function * O.some(f), * // apply the first argument * O.ap(fa), * // apply the second argument * O.ap(fb), * // apply the third argument * O.ap(fc) * ), * O.some('s1true') * ) * * @since 2.0.0 */ import { Functor, Functor1, Functor2, Functor2C, Functor3, Functor4, Functor3C } from './Functor' import { HKT, Kind, Kind2, Kind3, Kind4, URIS, URIS2, URIS3, URIS4 } from './HKT' /** * @category type classes * @since 2.0.0 */ export interface Apply extends Functor { readonly ap: (fab: HKT B>, fa: HKT) => HKT } /** * @category type classes * @since 2.0.0 */ export interface Apply1 extends Functor1 { readonly ap: (fab: Kind B>, fa: Kind) => Kind } /** * @category type classes * @since 2.0.0 */ export interface Apply2 extends Functor2 { readonly ap: (fab: Kind2 B>, fa: Kind2) => Kind2 } /** * @category type classes * @since 2.0.0 */ export interface Apply2C extends Functor2C { readonly ap: (fab: Kind2 B>, fa: Kind2) => Kind2 } /** * @category type classes * @since 2.0.0 */ export interface Apply3 extends Functor3 { readonly ap: (fab: Kind3 B>, fa: Kind3) => Kind3 } /** * @category type classes * @since 2.2.0 */ export interface Apply3C extends Functor3C { readonly ap: (fab: Kind3 B>, fa: Kind3) => Kind3 } /** * @category type classes * @since 2.0.0 */ export interface Apply4 extends Functor4 { readonly ap: (fab: Kind4 B>, fa: Kind4) => Kind4 } /** * Tuple sequencing, i.e., take a tuple of monadic actions and does them from left-to-right, returning the resulting tuple. * * @example * import { sequenceT } from 'fp-ts/Apply' * import { option, some, none } from 'fp-ts/Option' * * const sequenceTOption = sequenceT(option) * assert.deepStrictEqual(sequenceTOption(some(1)), some([1])) * assert.deepStrictEqual(sequenceTOption(some(1), some('2')), some([1, '2'])) * assert.deepStrictEqual(sequenceTOption(some(1), some('2'), none), none) * * @since 2.0.0 */ export declare function sequenceT( F: Apply4 ): >>( ...t: T & { readonly 0: Kind4 } ) => Kind4< F, S, R, E, { [K in keyof T]: [T[K]] extends [Kind4] ? A : never } > export declare function sequenceT( F: Apply3 ): >>( ...t: T & { readonly 0: Kind3 } ) => Kind3< F, R, E, { [K in keyof T]: [T[K]] extends [Kind3] ? A : never } > export declare function sequenceT( F: Apply3C ): >>( ...t: T & { readonly 0: Kind3 } ) => Kind3< F, R, E, { [K in keyof T]: [T[K]] extends [Kind3] ? A : never } > export declare function sequenceT( F: Apply2 ): >>( ...t: T & { readonly 0: Kind2 } ) => Kind2< F, E, { [K in keyof T]: [T[K]] extends [Kind2] ? A : never } > export declare function sequenceT( F: Apply2C ): >>( ...t: T & { readonly 0: Kind2 } ) => Kind2< F, E, { [K in keyof T]: [T[K]] extends [Kind2] ? A : never } > export declare function sequenceT( F: Apply1 ): >>( ...t: T & { readonly 0: Kind } ) => Kind< F, { [K in keyof T]: [T[K]] extends [Kind] ? A : never } > export declare function sequenceT( F: Apply ): >>( ...t: T & { readonly 0: HKT } ) => HKT< F, { [K in keyof T]: [T[K]] extends [HKT] ? A : never } > declare type EnforceNonEmptyRecord = keyof R extends never ? never : R /** * Like `Apply.sequenceT` but works with structs instead of tuples. * * @example * import { either, right, left } from 'fp-ts/Either' * import { sequenceS } from 'fp-ts/Apply' * * const ado = sequenceS(either) * * assert.deepStrictEqual( * ado({ * a: right(1), * b: right(true) * }), * right({ a: 1, b: true }) * ) * assert.deepStrictEqual( * ado({ * a: right(1), * b: left('error') * }), * left('error') * ) * * @since 2.0.0 */ export declare function sequenceS( F: Apply4 ): >>( r: EnforceNonEmptyRecord & Record> ) => Kind4< F, S, R, E, { [K in keyof NER]: [NER[K]] extends [Kind4] ? A : never } > export declare function sequenceS( F: Apply3 ): >>( r: EnforceNonEmptyRecord & Record> ) => Kind3< F, R, E, { [K in keyof NER]: [NER[K]] extends [Kind3] ? A : never } > export declare function sequenceS( F: Apply3C ): >>( r: EnforceNonEmptyRecord & Record> ) => Kind3< F, R, E, { [K in keyof NER]: [NER[K]] extends [Kind3] ? A : never } > export declare function sequenceS( F: Apply2 ): >>( r: EnforceNonEmptyRecord & Record> ) => Kind2< F, E, { [K in keyof NER]: [NER[K]] extends [Kind2] ? A : never } > export declare function sequenceS( F: Apply2C ): >>( r: EnforceNonEmptyRecord ) => Kind2< F, E, { [K in keyof NER]: [NER[K]] extends [Kind2] ? A : never } > export declare function sequenceS( F: Apply1 ): >>( r: EnforceNonEmptyRecord ) => Kind< F, { [K in keyof NER]: [NER[K]] extends [Kind] ? A : never } > export declare function sequenceS( F: Apply ): >>( r: EnforceNonEmptyRecord ) => HKT< F, { [K in keyof NER]: [NER[K]] extends [HKT] ? A : never } > export {}