ComonadLaws | funfix-types

Type class laws defined for Comonad.

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

ComonadLaws

Implements

CoflatMapLaws<F>

Index

Properties

Methods

Properties

F

F: Comonad<F>

The Comonad designated instance for F, to be tested.

coflatMapAssociativity

coflatMapAssociativity: function

Mixed-in from CoflatMapLaws.coflatMapAssociativity.

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: HK<F, A>): B
      - Parameters
        
        a: HK<F, A>
        
        Returns B
  - g: function
    - - (b: HK<F, B>): C
      - Parameters
        
        b: HK<F, B>
        
        Returns C
  Returns Equiv<HK<F, C>>

coflatMapIdentity

coflatMapIdentity: function

Mixed-in from CoflatMapLaws.coflatMapIdentity.

Type declaration

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

coflattenCoherence

coflattenCoherence: function

Mixed-in from CoflatMapLaws.coflattenCoherence.

Type declaration

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

coflattenThroughMap

coflattenThroughMap: function

Mixed-in from CoflatMapLaws.coflattenThroughMap.

Type declaration

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

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

comonadLeftIdentity

comonadLeftIdentity<A>(fa: HK<F, A>): Equiv<HK<F, A>>

- Defined in comonad.ts:439
```
fa.coflatMap(_.extract) <-> fa
```
Type parameters
- A
Parameters
- fa: HK<F, A>
Returns Equiv<HK<F, A>>

comonadRightIdentity

comonadRightIdentity<A, B>(fa: HK<F, A>, f: function): Equiv<B>

- Defined in comonad.ts:452
```
fa.coflatMap(f).extract <-> f(fa)
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- f: function
  - - (a: HK<F, A>): B
    - Parameters
      - a: HK<F, A>
      Returns B
Returns Equiv<B>

extractCoflattenIdentity

extractCoflattenIdentity<A>(fa: HK<F, A>): Equiv<HK<F, A>>

- Defined in comonad.ts:400
```
fa.coflatten.extract <-> fa
```
Type parameters
- A
Parameters
- fa: HK<F, A>
Returns Equiv<HK<F, A>>

mapCoflatMapCoherence

mapCoflatMapCoherence<A, B>(fa: HK<F, A>, f: function): Equiv<HK<F, B>>

- Defined in comonad.ts:426
```
fa.map(f) <-> fa.coflatMap(fa0 => f(fa0.extract))
```
Type parameters
- A
- B
Parameters
- fa: HK<F, A>
- f: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns Equiv<HK<F, B>>

mapCoflattenIdentity

mapCoflattenIdentity<A>(fa: HK<F, A>): Equiv<HK<F, A>>

- Defined in comonad.ts:413
```
fa.coflatten.map(_.extract) <-> fa
```
Type parameters
- A
Parameters
- fa: HK<F, A>
Returns Equiv<HK<F, A>>

Generated using TypeDoc

Type parameters

F

Hierarchy

Implements

Index

Properties

Methods

Properties

F

coflatMapAssociativity

Type declaration

Type parameters

A

B

C

Parameters

fa: HK<F, A>

f: function

Parameters

a: HK<F, A>

Returns B

g: function

Parameters

b: HK<F, B>

Returns C

Returns Equiv<HK<F, C>>

coflatMapIdentity

Type declaration

Type parameters

A

Parameters

fa: HK<F, A>

Returns Equiv<HK<F, HK<F, A>>>

coflattenCoherence

Type declaration

Type parameters

A

B

Parameters

fa: HK<F, A>

f: function

Parameters

a: HK<F, A>

Returns B

Returns Equiv<HK<F, B>>

coflattenThroughMap

Type declaration

Type parameters

A

Parameters

fa: HK<F, A>

Returns Equiv<HK<F, HK<F, HK<F, A>>>>

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

comonadLeftIdentity

Type parameters

A