Class Left<L, A>

Type parameters

L
A

Hierarchy

Left

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Left(value: L): Left

- Defined in node_modules/fp-ts/lib/Either.d.ts:29
Parameters
- value: L
Returns Left

Properties

_A

_A: A

_L

_L: L

_URI

_URI: URI

_tag

_tag: "Left"

value

value: L

Methods

alt

alt(fy: Either<L, A>): Either<L, A>

- Defined in node_modules/fp-ts/lib/Either.d.ts:36
Parameters
- fy: Either<L, A>
Returns Either<L, A>

ap

ap<B>(fab: Either<L, function>): Either<L, B>

- Defined in node_modules/fp-ts/lib/Either.d.ts:32
Type parameters
- B
Parameters
- fab: Either<L, function>
Returns Either<L, B>

ap_

ap_<B, C>(this: Either<L, function>, fb: Either<L, B>): Either<L, C>

- Defined in node_modules/fp-ts/lib/Either.d.ts:33
Type parameters
- B
- C
Parameters
- this: Either<L, function>
- fb: Either<L, B>
Returns Either<L, C>

bimap

bimap<V, B>(f: function, g: function): Either<V, B>

- Defined in node_modules/fp-ts/lib/Either.d.ts:35
Type parameters
- V
- B
Parameters
- f: function
  - - (l: L): V
    - Parameters
      - l: L
      Returns V
- g: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns Either<V, B>

chain

chain<B>(f: function): Either<L, B>

- Defined in node_modules/fp-ts/lib/Either.d.ts:34
Type parameters
- B
Parameters
- f: function
  - - (a: A): Either<L, B>
    - Parameters
      - a: A
      Returns Either<L, B>
Returns Either<L, B>

equals

equals(SL: Setoid<L>, SA: Setoid<A>): function

- Defined in node_modules/fp-ts/lib/Either.d.ts:46
Parameters
- SL: Setoid<L>
- SA: Setoid<A>
Returns function
- - (fy: Either<L, A>): boolean
  - Parameters
    - fy: Either<L, A>
    Returns boolean

extend

extend<B>(f: function): Either<L, B>

- Defined in node_modules/fp-ts/lib/Either.d.ts:37
Type parameters
- B
Parameters
- f: function
  - - (ea: Either<L, A>): B
    - Parameters
      - ea: Either<L, A>
      Returns B
Returns Either<L, B>

fold

fold<B>(left: function, right: function): B

- Defined in node_modules/fp-ts/lib/Either.d.ts:42
Type parameters
- B
Parameters
- left: function
  - - (l: L): B
    - Parameters
      - l: L
      Returns B
- right: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns B

getOrElse

getOrElse(f: function): A

- Defined in node_modules/fp-ts/lib/Either.d.ts:44
Returns the value from this Right or the given argument if this is a Left

Parameters
- f: function
  - - (l: L): A
    - Parameters
      - l: L
      Returns A
Returns A

getOrElseValue

getOrElseValue(value: A): A

- Defined in node_modules/fp-ts/lib/Either.d.ts:45
Parameters
- value: A
Returns A

inspect

inspect(): string

- Defined in node_modules/fp-ts/lib/Either.d.ts:49
Returns string

map

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

- Defined in node_modules/fp-ts/lib/Either.d.ts:31
Type parameters
- B
Parameters
- f: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns Either<L, B>

mapLeft

mapLeft<M>(f: function): Either<M, A>

- Defined in node_modules/fp-ts/lib/Either.d.ts:47
Type parameters
- M
Parameters
- f: function
  - - (l: L): M
    - Parameters
      - l: L
      Returns M
Returns Either<M, A>

reduce

reduce<B>(f: function, b: B): B

- Defined in node_modules/fp-ts/lib/Either.d.ts:38
Type parameters
- B
Parameters
- f: function
  - - (b: B, a: A): B
    - Parameters
      - b: B
      - a: A
      Returns B
- b: B
Returns B

toOption

toOption(): Option<A>

- Defined in node_modules/fp-ts/lib/Either.d.ts:48
Returns Option<A>

toString

toString(): string

- Defined in node_modules/fp-ts/lib/Either.d.ts:50
Returns string

traverse

traverse<F>(F: Applicative<F>): function
traverse<F>(F: Applicative<F>): function
traverse<F>(F: Applicative<F>): function

- Defined in node_modules/fp-ts/lib/Either.d.ts:39
Type parameters
- F: HKT2S
Parameters
- F: Applicative<F>
Returns function
- - <M, B>(f: function): HKT2As<F, M, Either<L, B>>
  - Type parameters
    - M
    - B
    Parameters
    - f: function
      - (a: A): HKT2<F, M, B>
        
        Parameters
        
        a: A
        
        Returns HKT2<F, M, B>
    Returns HKT2As<F, M, Either<L, B>>
- Defined in node_modules/fp-ts/lib/Either.d.ts:40
Type parameters
- F: HKTS
Parameters
- F: Applicative<F>
Returns function
- - <B>(f: function): HKTAs<F, Either<L, B>>
  - Type parameters
    - B
    Parameters
    - f: function
      - (a: A): HKT<F, B>
        
        Parameters
        
        a: A
        
        Returns HKT<F, B>
    Returns HKTAs<F, Either<L, B>>
- Defined in node_modules/fp-ts/lib/Either.d.ts:41
Type parameters
- F
Parameters
- F: Applicative<F>
Returns function
- - <B>(f: function): HKT<F, Either<L, B>>
  - Type parameters
    - B
    Parameters
    - f: function
      - (a: A): HKT<F, B>
        
        Parameters
        
        a: A
        
        Returns HKT<F, B>
    Returns HKT<F, Either<L, B>>

Generated using TypeDoc