FlatMapLaws | funfix-types

Type class laws defined for FlatMap.

This is an abstract definition. In order to use it in unit testing, the implementor must think of a strategy to evaluate the truthiness of the returned Equiv values.

Even though in TypeScript the Funfix library is using classes to express these laws, when implementing this class it is recommended that you implement it as a mixin using implements, instead of extending it directly with extends. See TypeScript: Mixins for details and note that we already have applyMixins defined.

We are doing this in order to support multiple inheritance and to avoid inheriting any static members. In the Flow definitions (e.g. .js.flow files) for Funfix these classes are defined with interface, as they are meant to be interfaces that sometimes have default implementations and not classes.

Type parameters

Hierarchy

FlatMapLaws

Implements

ApplyLaws<F>

Implemented by

MonadLaws

Index

Properties

Methods

Properties

F

F: FlatMap<F>

The Apply designated instance for F, to be tested.

applyComposition

applyComposition: function

Mixed in from ApplyLaws.applyComposition.

Type declaration

- <A, B, C>(fa: HK<F, A>, fab: HK<F, function>, fbc: HK<F, function>): Equiv<HK<F, C>>
- Type parameters
  - A
  - B
  - C
  Parameters
  - fa: HK<F, A>
  - fab: HK<F, function>
  - fbc: HK<F, function>
  Returns Equiv<HK<F, C>>

applyMap2Consistency

applyMap2Consistency: function

Mixed in from ApplyLaws.applyMap2Consistency.

Type declaration

- <A, B>(fa: HK<F, A>, f: HK<F, function>): Equiv<HK<F, B>>
- Type parameters
  - A
  - B
  Parameters
  - fa: HK<F, A>
  - f: HK<F, function>
  Returns Equiv<HK<F, B>>

applyProductConsistency

applyProductConsistency: function

Mixed in from ApplyLaws.applyProductConsistency.

Type declaration

- <A, B>(fa: HK<F, A>, f: HK<F, function>): Equiv<HK<F, B>>
- Type parameters
  - A
  - B
  Parameters
  - fa: HK<F, A>
  - f: HK<F, function>
  Returns Equiv<HK<F, B>>

covariantComposition

covariantComposition: function

Mixed-in from FunctorLaws.covariantComposition.

Type declaration

- <A, B, C>(fa: HK<F, A>, f: function, g: function): Equiv<HK<F, C>>
- Type parameters
  - A
  - B
  - C
  Parameters
  - fa: HK<F, A>
  - f: function
    - - (a: A): B
      - Parameters
        
        a: A
        
        Returns B
  - g: function
    - - (b: B): C
      - Parameters
        
        b: B
        
        Returns C
  Returns Equiv<HK<F, C>>

covariantIdentity

covariantIdentity: function

Mixed-in from FunctorLaws.covariantIdentity.

Type declaration

- <A>(fa: HK<F, A>): Equiv<HK<F, A>>
- Type parameters
  - A
  Parameters
  - fa: HK<F, A>
  Returns Equiv<HK<F, A>>

Methods

flatMapAssociativity

flatMapAssociativity<A, B, C>(fa: HK<F, A>, f: function, g: function): Equiv<HK<F, C>>

- Defined in monad.ts:248
```
 fa.flatMap(f).flatMap(g) <-> fa.flatMap(a => f(a).flatMap(g))
```
Type parameters
- A
- B
- C
Parameters
- fa: HK<F, A>
- f: function
  - - (a: A): HK<F, B>
    - Parameters
      - a: A
      Returns HK<F, B>
- g: function
  - - (b: B): HK<F, C>
    - Parameters
      - b: B
      Returns HK<F, C>
Returns Equiv<HK<F, C>>

flatMapConsistentApply

flatMapConsistentApply<A, B>(fa: HK<F, A>, fab: HK<F, function>): Equiv<HK<F, B>>

- Defined in monad.ts:261
```
fab.ap(fa) <-> fab.flatMap(f => fa.map(f))
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- fab: HK<F, function>
Returns Equiv<HK<F, B>>

followedByConsistency

followedByConsistency<A, B>(fa: HK<F, A>, fb: HK<F, B>): Equiv<HK<F, B>>

- Defined in monad.ts:274
```
fa.followedBy(fb) <-> fa.flatMap(_ => fb)
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- fb: HK<F, B>
Returns Equiv<HK<F, B>>

followedByLConsistency

followedByLConsistency<A, B>(fa: HK<F, A>, fb: HK<F, B>): Equiv<HK<F, B>>

- Defined in monad.ts:287
```
fa.followedBy(() => fb) <-> fa.flatMap(_ => fb)
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- fb: HK<F, B>
Returns Equiv<HK<F, B>>

forEffectConsistency

forEffectConsistency<A, B>(fa: HK<F, A>, fb: HK<F, B>): Equiv<HK<F, A>>

- Defined in monad.ts:300
```
fa.forEffect(fb) <-> fa.flatMap(a => fb.map(_ => a))
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- fb: HK<F, B>
Returns Equiv<HK<F, A>>

forEffectLConsistency

forEffectLConsistency<A, B>(fa: HK<F, A>, fb: HK<F, B>): Equiv<HK<F, A>>

- Defined in monad.ts:313
```
fa.forEffectL(() => fb) <-> fa.flatMap(a => fb.map(_ => a))
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- fb: HK<F, B>
Returns Equiv<HK<F, A>>

tailRecMConsistentFlatMap

tailRecMConsistentFlatMap<A>(a: A, f: function): Equiv<HK<F, A>>

- Defined in monad.ts:321
Type parameters
- A
Parameters
- a: A
- f: function
  - - (a: A): HK<F, A>
    - Parameters
      - a: A
      Returns HK<F, A>
Returns Equiv<HK<F, A>>

Generated using TypeDoc

Type parameters

F

Hierarchy

Implements

Implemented by

Index

Properties

Methods

Properties

F

applyComposition

Type declaration

Type parameters

A

B

C

Parameters

fa: HK<F, A>

fab: HK<F, function>

fbc: HK<F, function>

Returns Equiv<HK<F, C>>

applyMap2Consistency

Type declaration

Type parameters

A

B

Parameters

fa: HK<F, A>

f: HK<F, function>

Returns Equiv<HK<F, B>>

applyProductConsistency

Type declaration

Type parameters

A

B

Parameters

fa: HK<F, A>

f: HK<F, function>

Returns Equiv<HK<F, B>>

covariantComposition

Type declaration

Type parameters

A

B

C

Parameters

fa: HK<F, A>

f: function

Parameters

a: A

Returns B

g: function

Parameters

b: B

Returns C

Returns Equiv<HK<F, C>>

covariantIdentity

Type declaration

Type parameters

A

Parameters

fa: HK<F, A>

Returns Equiv<HK<F, A>>

Methods

flatMapAssociativity

Type parameters

A

B

C

Parameters

fa: HK<F, A>

f: function

Parameters

a: A

Returns HK<F, B>

g: function

Parameters

b: B

Returns HK<F, C>

Returns Equiv<HK<F, C>>