EitherInstances | funfix-types

Type class instances provided by default for Either.

Type parameters

L

Hierarchy

EitherInstances

Implements

Monad<Either<L, any>>
Eq<Either<L, any>>
CoflatMap<Either<L, any>>

Index

Properties

Methods

Properties

followedBy

followedBy: function

Type declaration

- <A, B>(fa: EitherK<L, A>, fb: EitherK<L, B>): Either<L, B>
- Type parameters
  - A
  - B
  Parameters
  - fa: EitherK<L, A>
  - fb: EitherK<L, B>
  Returns Either<L, B>

followedByL

followedByL: function

Type declaration

- <A, B>(fa: EitherK<L, A>, fb: function): Either<L, B>
- Type parameters
  - A
  - B
  Parameters
  - fa: EitherK<L, A>
  - fb: function
    - - (): EitherK<L, B>
      - Returns EitherK<L, B>
  Returns Either<L, B>

forEffect

forEffect: function

Type declaration

- <A, B>(fa: EitherK<L, A>, fb: EitherK<L, B>): Either<L, A>
- Type parameters
  - A
  - B
  Parameters
  - fa: EitherK<L, A>
  - fb: EitherK<L, B>
  Returns Either<L, A>

forEffectL

forEffectL: function

Type declaration

- <A, B>(fa: EitherK<L, A>, fb: function): Either<L, A>
- Type parameters
  - A
  - B
  Parameters
  - fa: EitherK<L, A>
  - fb: function
    - - (): EitherK<L, B>
      - Returns EitherK<L, B>
  Returns Either<L, A>

Static global

global: EitherInstances<any> = new EitherInstances()

Methods

ap

ap<A, B>(fa: EitherK<L, A>, ff: EitherK<L, function>): Either<L, B>

- Defined in instances.ts:237
Type parameters
- A
- B
Parameters
- fa: EitherK<L, A>
- ff: EitherK<L, function>
Returns Either<L, B>

coflatMap

coflatMap<A, B>(fa: EitherK<L, A>, ff: function): Either<L, B>

- Defined in instances.ts:266
Type parameters
- A
- B
Parameters
- fa: EitherK<L, A>
- ff: function
  - - (a: EitherK<L, A>): B
    - Parameters
      - a: EitherK<L, A>
      Returns B
Returns Either<L, B>

coflatten

coflatten<A>(fa: EitherK<L, A>): Either<L, Either<L, A>>

- Defined in instances.ts:270
Type parameters
- A
Parameters
- fa: EitherK<L, A>
Returns Either<L, Either<L, A>>

eqv

eqv(lh: Either<L, any>, rh: Either<L, any>): boolean

- Defined in instances.ts:218
Parameters
- lh: Either<L, any>
- rh: Either<L, any>
Returns boolean

flatMap

flatMap<A, B>(fa: HK<Either<L, any>, A>, f: function): HK<Either<L, any>, B>

- Defined in instances.ts:258
Type parameters
- A
- B
Parameters
- fa: HK<Either<L, any>, A>
- f: function
  - - (a: A): HK<Either<L, any>, B>
    - Parameters
      - a: A
      Returns HK<Either<L, any>, B>
Returns HK<Either<L, any>, B>

map

map<A, B>(fa: EitherK<L, A>, f: function): Either<L, B>

- Defined in instances.ts:243
Type parameters
- A
- B
Parameters
- fa: EitherK<L, A>
- f: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns Either<L, B>

map2

map2<A, B, Z>(fa: EitherK<L, A>, fb: EitherK<L, B>, f: function): Either<L, Z>

- Defined in instances.ts:247
Type parameters
- A
- B
- Z
Parameters
- fa: EitherK<L, A>
- fb: EitherK<L, B>
- f: function
  - - (a: A, b: B): Z
    - Parameters
      - a: A
      - b: B
      Returns Z
Returns Either<L, Z>

product

product<A, B>(fa: EitherK<L, A>, fb: EitherK<L, B>): Either<L, [A, B]>

- Defined in instances.ts:251
Type parameters
- A
- B
Parameters
- fa: EitherK<L, A>
- fb: EitherK<L, B>
Returns Either<L, [A, B]>

pure

pure<A>(a: A): Either<L, A>

- Defined in instances.ts:229
Type parameters
- A
Parameters
- a: A
Returns Either<L, A>

tailRecM

tailRecM<A, B>(a: A, f: function): HK<Either<L, any>, B>

- Defined in instances.ts:262
Type parameters
- A
- B
Parameters
- a: A
- f: function
  - - (a: A): HK<Either<L, any>, Either<A, B>>
    - Parameters
      - a: A
      Returns HK<Either<L, any>, Either<A, B>>
Returns HK<Either<L, any>, B>

unit

unit(): Either<L, void>

- Defined in instances.ts:233
Returns Either<L, void>

Generated using TypeDoc