Skip to main content Link Search Menu Expand Document (external link)
core

SemiApplicative overview

Added in v1.0.0

Table of contents

lifting

getSemigroup

Lift a Semigroup into ‘F’, the inner values are combined using the provided Semigroup.

Signature

export declare const getSemigroup: <F extends TypeLambda>(
  F: SemiApplicative<F>
) => <A, R, O, E>(S: Semigroup<A>) => Semigroup<Kind<F, R, O, E, A>>

Added in v1.0.0

lift2

Lifts a binary function into F.

Signature

export declare const lift2: <F extends TypeLambda>(
  F: SemiApplicative<F>
) => <A, B, C>(
  f: (a: A, b: B) => C
) => {
  <R2, O2, E2>(that: Kind<F, R2, O2, E2, B>): <R1, O1, E1>(
    self: Kind<F, R1, O1, E1, A>
  ) => Kind<F, R1 & R2, O2 | O1, E2 | E1, C>
  <R1, O1, E1, R2, O2, E2>(self: Kind<F, R1, O1, E1, A>, that: Kind<F, R2, O2, E2, B>): Kind<
    F,
    R1 & R2,
    O1 | O2,
    E1 | E2,
    C
  >
}

Added in v1.0.0

type class

SemiApplicative (interface)

Signature

export interface SemiApplicative<F extends TypeLambda> extends SemiProduct<F>, Covariant<F> {}

Added in v1.0.0

utils

andThen

Signature

export declare const andThen: <F extends TypeLambda>(
  F: SemiApplicative<F>
) => {
  <R2, O2, E2, B>(that: Kind<F, R2, O2, E2, B>): <R1, O1, E1, _>(
    self: Kind<F, R1, O1, E1, _>
  ) => Kind<F, R1 & R2, O2 | O1, E2 | E1, B>
  <R1, O1, E1, _, R2, O2, E2, B>(self: Kind<F, R1, O1, E1, _>, that: Kind<F, R2, O2, E2, B>): Kind<
    F,
    R1 & R2,
    O1 | O2,
    E1 | E2,
    B
  >
}

Added in v1.0.0

andThenDiscard

Signature

export declare const andThenDiscard: <F extends TypeLambda>(
  F: SemiApplicative<F>
) => {
  <R2, O2, E2, _>(that: Kind<F, R2, O2, E2, _>): <R1, O1, E1, A>(
    self: Kind<F, R1, O1, E1, A>
  ) => Kind<F, R1 & R2, O2 | O1, E2 | E1, A>
  <R1, O1, E1, A, R2, O2, E2, _>(self: Kind<F, R1, O1, E1, A>, that: Kind<F, R2, O2, E2, _>): Kind<
    F,
    R1 & R2,
    O1 | O2,
    E1 | E2,
    A
  >
}

Added in v1.0.0

ap

Signature

export declare const ap: <F extends TypeLambda>(
  F: SemiApplicative<F>
) => {
  <R2, O2, E2, A>(that: Kind<F, R2, O2, E2, A>): <R1, O1, E1, B>(
    self: Kind<F, R1, O1, E1, (a: A) => B>
  ) => Kind<F, R1 & R2, O2 | O1, E2 | E1, B>
  <R1, O1, E1, A, B, R2, O2, E2>(self: Kind<F, R1, O1, E1, (a: A) => B>, that: Kind<F, R2, O2, E2, A>): Kind<
    F,
    R1 & R2,
    O1 | O2,
    E1 | E2,
    B
  >
}

Added in v1.0.0

zipWith

Zips two F values together using a provided function, returning a new F of the result.

Signature

export declare const zipWith: <F extends TypeLambda>(
  F: SemiApplicative<F>
) => {
  <R2, O2, E2, B, A, C>(that: Kind<F, R2, O2, E2, B>, f: (a: A, b: B) => C): <R1, O1, E1>(
    self: Kind<F, R1, O1, E1, A>
  ) => Kind<F, R1 & R2, O2 | O1, E2 | E1, C>
  <R1, O1, E1, A, R2, O2, E2, B, C>(
    self: Kind<F, R1, O1, E1, A>,
    that: Kind<F, R2, O2, E2, B>,
    f: (a: A, b: B) => C
  ): Kind<F, R1 & R2, O1 | O2, E1 | E2, C>
}

Added in v1.0.0