Class Err<E>

A failed Validation.

Type Parameters

out E

Hierarchy

Validation.Syntax
- Err

Index

Constructors

constructor

new Err<out E>(val): Err<E>
Type Parameters
- out E
Parameters
- val: E
Returns Err<E>
Overrides Syntax.constructor
- Defined in validation.ts:410

Properties

`Readonly` kind

kind: ERR = Kind.ERR

The property that discriminates Validation.

`Readonly` val

val: E

The failure of this Validation.

Methods

[cmb]

[cmb]<E, T>(this, that): Validation<E, T>
If this and that Validation both succeed, combine their successes.
Type Parameters
- E extends Semigroup<E>
- T extends Semigroup<T>
Parameters
- this: Validation<E, T>
- that: Validation<E, T>
Returns Validation<E, T>
Inherited from Syntax.[cmb]
- Defined in validation.ts:329

[cmp]

[cmp]<E, T>(this, that): Ordering
Compare this and that Validation to determine their ordering.
Type Parameters
- E extends Ord<E>
- T extends Ord<T>
Parameters
- this: Validation<E, T>
- that: Validation<E, T>
Returns Ordering

Remarks
When ordered, Err always compares as less than Ok. If the variants are the same, their failures or successes are compared to determine the ordering.
Inherited from Syntax.[cmp]
- Defined in validation.ts:316

[eq]

[eq]<E, T>(this, that): boolean
Compare this and that Validation to determine their equality.
Type Parameters
- E extends Eq<E>
- T extends Eq<T>
Parameters
- this: Validation<E, T>
- that: Validation<E, T>
Returns boolean

Remarks
Two Validation are equal if they are the same variant and their failures or successes are equal.
Inherited from Syntax.[eq]
- Defined in validation.ts:297

and

and<E, T1>(this, that): Validation<E, T1>
If this Validation succeeds, ignore the success and return that Validation.
Type Parameters
- E extends Semigroup<E>
- T1
Parameters
- this: Validation<E, any>
- that: Validation<E, T1>
Returns Validation<E, T1>
Inherited from Syntax.and
- Defined in validation.ts:362

isErr

isErr<E>(this): this is Err<E>
Test whether this Validation has failed.
Type Parameters
- E
Parameters
- this: Validation<E, any>
Returns this is Err<E>
Inherited from Syntax.isErr
- Defined in validation.ts:337

isOk

isOk<T>(this): this is Ok<T>
Test whether this Validation has succeeded.
Type Parameters
- T
Parameters
- this: Validation<any, T>
Returns this is Ok<T>
Inherited from Syntax.isOk
- Defined in validation.ts:342

lmap

lmap<E, T, E1>(this, f): Validation<E1, T>
If this Validation fails, apply a function to map its failure.
Type Parameters
- E
- T
- E1
Parameters
- this: Validation<E, T>
- f: ((val) => E1)
  - - (val): E1
    - Parameters
      
      val: E
      
      Returns E1
Returns Validation<E1, T>
Inherited from Syntax.lmap
- Defined in validation.ts:385

map

map<E, T, T1>(this, f): Validation<E, T1>
If this Validation succeeds, apply a function to map its success.
Type Parameters
- E
- T
- T1
Parameters
- this: Validation<E, T>
- f: ((val) => T1)
  - - (val): T1
    - Parameters
      
      val: T
      
      Returns T1
Returns Validation<E, T1>
Inherited from Syntax.map
- Defined in validation.ts:395

unwrap

unwrap<E, T, T1, T2>(this, unwrapErr, unwrapOk): T1 | T2
Apply one of two functions to extract the failure or success out of this Validation, depending on the variant.
Type Parameters
- E
- T
- T1
- T2
Parameters
- this: Validation<E, T>
- unwrapErr: ((val) => T1)
  - - (val): T1
    - Parameters
      
      val: E
      
      Returns T1
- unwrapOk: ((val) => T2)
  - - (val): T2
    - Parameters
      
      val: T
      
      Returns T2
Returns T1 | T2
Inherited from Syntax.unwrap
- Defined in validation.ts:350

zipWith

zipWith<E, T, T1, T2>(this, that, f): Validation<E, T2>
If this and that Validation succeed, apply a function to combine their successes.
Type Parameters
- E extends Semigroup<E>
- T
- T1
- T2
Parameters
- this: Validation<E, T>
- that: Validation<E, T1>
- f: ((lhs, rhs) => T2)
  - - (lhs, rhs): T2
    - Parameters
      
      lhs: T
      
      rhs: T1
      
      Returns T2
Returns Validation<E, T2>
Inherited from Syntax.zipWith
- Defined in validation.ts:373

Class Err<E>

Type Parameters

out E

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

out E

Parameters

val: E

Returns Err<E>

Properties

Readonly kind

Readonly val

Methods

[cmb]

Type Parameters

E extends Semigroup<E>

T extends Semigroup<T>

Parameters

this: Validation<E, T>

that: Validation<E, T>

Returns Validation<E, T>

[cmp]

Type Parameters

E extends Ord<E>

T extends Ord<T>

Parameters

this: Validation<E, T>

that: Validation<E, T>

Returns Ordering

Remarks

[eq]

Type Parameters

E extends Eq<E>

T extends Eq<T>

Parameters

this: Validation<E, T>

that: Validation<E, T>

Returns boolean

Remarks

and

Type Parameters

E extends Semigroup<E>

T1

Parameters

this: Validation<E, any>

that: Validation<E, T1>

Returns Validation<E, T1>

isErr

Type Parameters

E

Parameters

this: Validation<E, any>

Returns this is Err<E>

isOk

Type Parameters

T

Parameters

this: Validation<any, T>

Returns this is Ok<T>

lmap

Type Parameters

E

T

E1

Parameters

this: Validation<E, T>

f: ((val) => E1)

Parameters

val: E

Returns E1

Returns Validation<E1, T>

map

Type Parameters

E

`Readonly` kind

`Readonly` val