Class Result<T, E>

Type Parameters

Index

Constructors

constructor

Methods

err expect inspect inspectErr isErr isErrAnd isOk isOkAnd map mapErr mapOr match ok unwrap

Constructors

`Protected`constructor

new Result<T, E>(val?: T, err?: E): Result<T, E>
Protected
you shouldn't call this in your code. use Ok or Err instead
Type Parameters
- T
- E
Parameters
- Optionalval: T
- Optionalerr: E
Returns Result<T, E>
- Defined in src/lib/result.ts:15

Methods

err

err(): null | E
beware that it consumes the result

Returns null | E
contained Err value or null.

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:180

expect

expect(msg: string): NonNullable<T>
beware it consumes the result
Parameters
- msg: string
Returns NonNullable<T>
contained Ok.

Throws
panics with custom message, or if the result was already consumed.
- Defined in src/lib/result.ts:89

inspect

inspect<F>(fn: (okVal: Readonly<NonNullable<T>>) => F): Result<T, E>
run some code on the Ok value (if no Err) without consuming or transforming the result.
Type Parameters
- F
Parameters
- fn: (okVal: Readonly<NonNullable<T>>) => F
  a pure function to be applied to the contained Ok
Returns Result<T, E>
the original result

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:143

inspectErr

inspectErr<F>(fn: (errVal: Readonly<NonNullable<E>>) => F): Result<T, E>
run some code on the Err value (if no Ok) without consuming or transforming the result.
Type Parameters
- F
Parameters
- fn: (errVal: Readonly<NonNullable<E>>) => F
  a pure function to be applied to the contained Err
Returns Result<T, E>
the original result

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:157

isErr

isErr(): boolean
Returns boolean
if error occurred

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:69

isErrAnd

isErrAnd(
fn: (errValue: Readonly<undefined | NonNullable<E>>) => boolean,
): boolean
Parameters
- fn: (errValue: Readonly<undefined | NonNullable<E>>) => boolean
  a pure function to be applied once on the Err value
Returns boolean
false if Result was an Ok without executing the provided function or true if Result was Err and the provided function returns true when applied to the Err value

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:79

isOk

isOk(): boolean
Returns boolean
if no error occurred

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:50

isOkAnd

isOkAnd(fn: (okVal: Readonly<NonNullable<T>>) => boolean): boolean
Parameters
- fn: (okVal: Readonly<NonNullable<T>>) => boolean
  a pure function to be applied once on the Ok value
Returns boolean
false if Result was an Err without executing the provided function or true if Result was Ok and the provided function returns true when applied to the Ok value

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:60

map

map<U>(fn: (okVal: NonNullable<T>) => NonNullable<U>): Result<U, E>
transform the Ok value without consumption
Type Parameters
- U
Parameters
- fn: (okVal: NonNullable<T>) => NonNullable<U>
  function to be applied on the contained Ok value
Returns Result<U, E>
the Result after applying the provided function to the contained Ok, leaving the Err untouched

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:103

mapErr

mapErr<F>(
fn: (errValue: undefined | NonNullable<E>) => undefined | NonNullable<F>,
): Result<T, F>
transform the Err value without consumption
Type Parameters
- F
Parameters
- fn: (errValue: undefined | NonNullable<E>) => undefined | NonNullable<F>
  function to be applied on the contained Err value
Returns Result<T, F>
the Result after applying the provided function to the contained Err, leaving the Ok untouched

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:129

mapOr

mapOr<U>(defaultVal: U, fn: (okVal: NonNullable<T>) => U): U
transforms the Ok value or returns the defaultVal if Err without consumption
Type Parameters
- U
Parameters
- defaultVal: U
  value to return if Result was Err
- fn: (okVal: NonNullable<T>) => U
  function to be applied on the contained Ok value
Returns U
mapped Ok value or the default value

Throws
panics if the result was already consumed
- Defined in src/lib/result.ts:118

match

match<U, F>(
okArm?: (okVal: NonNullable<T>) => U,
errArm?: (errVal: undefined | NonNullable<E>) => F,
): void | U | F
Type Parameters
- U
- F
Parameters
- OptionalokArm: (okVal: NonNullable<T>) => U
  a function to consume the Ok value
- OptionalerrArm: (errVal: undefined | NonNullable<E>) => F
  a function to consume the Err value
Returns void | U | F
the return of okArm if it was Ok or the return of errArm
- Defined in src/lib/result.ts:30

ok

ok(): null | T
beware it consumes the result

Returns null | T
contained Ok value or null.

Throws
panics if the result was already consumed.
- Defined in src/lib/result.ts:169

unwrap

unwrap(): NonNullable<T>
Returns NonNullable<T>
value wrapped in Ok

Throws
panics if an error occurred, or the result was already consumed
- Defined in src/lib/result.ts:42

Class Result<T, E>

Type Parameters

Index

Constructors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns Result<T, E>

Methods

err

Returns null | E

Throws

expect

Parameters

Returns NonNullable<T>

Throws

inspect

Type Parameters

Parameters

Returns Result<T, E>

Throws

inspectErr

Type Parameters

Parameters

Returns Result<T, E>

Throws

isErr

Returns boolean

Throws

isErrAnd

Parameters

Returns boolean

Throws

isOk

Returns boolean

Throws

isOkAnd

Parameters

Returns boolean

Throws

map

Type Parameters

Parameters

Returns Result<U, E>

Throws

mapErr

Type Parameters

Parameters

Returns Result<T, F>

Throws

mapOr

Type Parameters

Parameters

Returns U

Throws

match

Type Parameters

Parameters

Returns void | U | F

ok

Returns null | T

Throws

unwrap

Returns NonNullable<T>

Throws

Settings

On This Page

`Protected`constructor