result

Index

Interfaces

Type aliases

Result

Namespaces

Result

Functions

Type aliases

Result<T, E>: Ok<T> | Err<E>

Union of success or failure

type Result<T, E> = Ok<T> | Err<E>

Type parameters

Functions

ok

ok<T>(res: T): Ok<T>

- Defined in result.ts:17
Make a Ok<T>

Type parameters
- T
Parameters
- res: T
Returns Ok<T>

err

err<E>(err: E): Err<E>

- Defined in result.ts:21
Make a Err<E>

Type parameters
- E
Parameters
- err: E
Returns Err<E>

isOk

isOk<T>(v?: any): v is Ok<T>

- Defined in result.ts:26
Check value is OK<T>

Type parameters
- T
Parameters
- Optional v: any
Returns v is Ok<T>

isErr

isErr<E>(v?: any): v is Err<E>

- Defined in result.ts:30
Check value is Err<E>

Type parameters
- E
Parameters
- Optional v: any
Returns v is Err<E>

isResult

isResult<T, E>(v?: any): v is Result<T, E>

- Defined in result.ts:34
Check value is Result<T, E>

Type parameters
- T
- E
Parameters
- Optional v: any
Returns v is Result<T, E>

getOk

getOk<T>(v: Ok<T>): T
getOk<E>(v: Err<E>): undefined
getOk<T, E>(v: Result<T, E>): Voidable<T>
getOk<T, E>(v?: undefined): undefined
getOk<T, E>(v?: null): null
getOk<T, E>(v?: None): None
getOk<T, E>(v?: Maybe<Result<T, E>>): Voidable<T>

- Defined in result.ts:39
Get T in Ok<T>

Type parameters
- T
Parameters
- v: Ok<T>
Returns T
- Defined in result.ts:41
Get nothing

Type parameters
- E
Parameters
- v: Err<E>
Returns undefined
- Defined in result.ts:43
Get T in Result<T, E>

Type parameters
- T
- E
Parameters
- v: Result<T, E>
Returns Voidable<T>
- Defined in result.ts:45
Get nothing

Type parameters
- T
- E
Parameters
- Optional v: undefined
Returns undefined
- Defined in result.ts:47
Get nothing

Type parameters
- T
- E
Parameters
- Optional v: null
Returns null
- Defined in result.ts:49
Get nothing

Type parameters
- T
- E
Parameters
- Optional v: None
Returns None
- Defined in result.ts:51
Get T in Result<T, E>

Type parameters
- T
- E
Parameters
- Optional v: Maybe<Result<T, E>>
Returns Voidable<T>

getErr

getErr<E>(v: Err<E>): E
getErr<T>(v: Ok<T>): undefined
getErr<T, E>(v: Result<T, E>): Voidable<E>
getErr<T, E>(v?: undefined): undefined
getErr<T, E>(v?: null): null
getErr<T, E>(v?: None): None
getErr<T, E>(v?: Maybe<Result<T, E>>): Voidable<E>

- Defined in result.ts:56
Get E in Err<E>

Type parameters
- E
Parameters
- v: Err<E>
Returns E
- Defined in result.ts:58
Get nothing

Type parameters
- T
Parameters
- v: Ok<T>
Returns undefined
- Defined in result.ts:60
Get E in Result<T, E>

Type parameters
- T
- E
Parameters
- v: Result<T, E>
Returns Voidable<E>
- Defined in result.ts:62
Get nothing

Type parameters
- T
- E
Parameters
- Optional v: undefined
Returns undefined
- Defined in result.ts:64
Get nothing

Type parameters
- T
- E
Parameters
- Optional v: null
Returns null
- Defined in result.ts:66
Get nothing

Type parameters
- T
- E
Parameters
- Optional v: None
Returns None
- Defined in result.ts:68
Get E in Result<T, E>

Type parameters
- T
- E
Parameters
- Optional v: Maybe<Result<T, E>>
Returns Voidable<E>

mapOk

mapOk<T, E, U>(v: Result<T, E>, f: (val: T) => U): Result<U, E>

- Defined in result.ts:73
Type parameters
- T
- E
- U
Parameters
- v: Result<T, E>
- f: (val: T) => U
  - - (val: T): U
    - Parameters
      - val: T
      Returns U
Returns Result<U, E>

mapErr

mapErr<T, E, U>(v: Result<T, E>, f: (val: E) => U): Result<T, U>

- Defined in result.ts:79
Type parameters
- T
- E
- U
Parameters
- v: Result<T, E>
- f: (val: E) => U
  - - (val: E): U
    - Parameters
      - val: E
      Returns U
Returns Result<T, U>

Index

Interfaces

Type aliases

Namespaces

Functions

Type aliases

Result

Type parameters

T

E

Functions

ok

Type parameters

T

Parameters

res: T

Returns Ok<T>

err

Type parameters

E

Parameters

err: E

Returns Err<E>

isOk

Type parameters

T

Parameters

Optional v: any

Returns v is Ok<T>

isErr

Type parameters

E

Parameters

Optional v: any

Returns v is Err<E>

isResult

Type parameters

T

E

Parameters

Optional v: any

Returns v is Result<T, E>

getOk

Type parameters

T

Parameters

v: Ok<T>

Returns T

Type parameters

E

Parameters

v: Err<E>

Returns undefined

Type parameters

T

E

Parameters

v: Result<T, E>

Returns Voidable<T>

Type parameters

T

E

Parameters

Optional v: undefined

Returns undefined

Type parameters

T

E

Parameters

Optional v: null

Returns null

Type parameters

T

E

Parameters

Optional v: None

Returns None

Type parameters

T

E