OptionInstances | funfix-types

Type class instances provided by default for Option.

Hierarchy

OptionInstances

Implements

Monad<Option<any>>
Eq<Option<any>>
CoflatMap<Option<any>>

Index

Properties

Methods

Properties

followedBy

followedBy: function

Type declaration

- <A, B>(fa: OptionK<A>, fb: OptionK<B>): Option<B>
- Type parameters
  - A
  - B
  Parameters
  - fa: OptionK<A>
  - fb: OptionK<B>
  Returns Option<B>

followedByL

followedByL: function

Type declaration

- <A, B>(fa: OptionK<A>, fb: function): Option<B>
- Type parameters
  - A
  - B
  Parameters
  - fa: OptionK<A>
  - fb: function
    - - (): OptionK<B>
      - Returns OptionK<B>
  Returns Option<B>

forEffect

forEffect: function

Type declaration

- <A, B>(fa: OptionK<A>, fb: OptionK<B>): Option<A>
- Type parameters
  - A
  - B
  Parameters
  - fa: OptionK<A>
  - fb: OptionK<B>
  Returns Option<A>

forEffectL

forEffectL: function

Type declaration

- <A, B>(fa: OptionK<A>, fb: function): Option<A>
- Type parameters
  - A
  - B
  Parameters
  - fa: OptionK<A>
  - fb: function
    - - (): OptionK<B>
      - Returns OptionK<B>
  Returns Option<A>

Static global

global: OptionInstances = new OptionInstances()

Methods

ap

ap<A, B>(fa: OptionK<A>, ff: OptionK<function>): Option<B>

- Defined in instances.ts:54
Type parameters
- A
- B
Parameters
- fa: OptionK<A>
- ff: OptionK<function>
Returns Option<B>

coflatMap

coflatMap<A, B>(fa: OptionK<A>, ff: function): Option<B>

- Defined in instances.ts:78
Type parameters
- A
- B
Parameters
- fa: OptionK<A>
- ff: function
  - - (a: OptionK<A>): B
    - Parameters
      - a: OptionK<A>
      Returns B
Returns Option<B>

coflatten

coflatten<A>(fa: OptionK<A>): Option<Option<A>>

- Defined in instances.ts:82
Type parameters
- A
Parameters
- fa: OptionK<A>
Returns Option<Option<A>>

eqv

eqv(lh: Option<any>, rh: Option<any>): boolean

- Defined in instances.ts:39
Parameters
- lh: Option<any>
- rh: Option<any>
Returns boolean

flatMap

flatMap<A, B>(fa: OptionK<A>, f: function): Option<B>

- Defined in instances.ts:70
Type parameters
- A
- B
Parameters
- fa: OptionK<A>
- f: function
  - - (a: A): OptionK<B>
    - Parameters
      - a: A
      Returns OptionK<B>
Returns Option<B>

map

map<A, B>(fa: OptionK<A>, f: function): Option<B>

- Defined in instances.ts:58
Type parameters
- A
- B
Parameters
- fa: OptionK<A>
- f: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns Option<B>

map2

map2<A, B, Z>(fa: OptionK<A>, fb: OptionK<B>, f: function): Option<Z>

- Defined in instances.ts:62
Type parameters
- A
- B
- Z
Parameters
- fa: OptionK<A>
- fb: OptionK<B>
- f: function
  - - (a: A, b: B): Z
    - Parameters
      - a: A
      - b: B
      Returns Z
Returns Option<Z>

product

product<A, B>(fa: OptionK<A>, fb: OptionK<B>): Option<[A, B]>

- Defined in instances.ts:66
Type parameters
- A
- B
Parameters
- fa: OptionK<A>
- fb: OptionK<B>
Returns Option<[A, B]>

pure

pure<A>(a: A): Option<A>

- Defined in instances.ts:46
Type parameters
- A
Parameters
- a: A
Returns Option<A>

tailRecM

tailRecM<A, B>(a: A, f: function): Option<B>

- Defined in instances.ts:74
Type parameters
- A
- B
Parameters
- a: A
- f: function
  - - (a: A): OptionK<Either<A, B>>
    - Parameters
      - a: A
      Returns OptionK<Either<A, B>>
Returns Option<B>

unit

unit(): Option<void>

- Defined in instances.ts:50
Returns Option<void>

Generated using TypeDoc