Interface Ok<T, E>

An Ok instance is the successful variant instance of the Result type, representing a successful outcome from an operation which may fail. For a full discussion, see the module docs.

Typeparam

T The type wrapped in this Ok variant of Result.

Typeparam

E The type which would be wrapped in an Err variant of Result.

Type Parameters

Hierarchy

Omit<ResultImpl<T, E>, "error" | "cast">
- Ok

Index

Properties

isErr isOk value variant

Methods

and andThen ap cast equals map mapErr mapOr mapOrElse match or orElse toJSON toString unwrapOr unwrapOrElse

Properties

isErr

isErr: false

isOk

isOk: true

value

value: T

The wrapped value

`Readonly` variant

variant: "Ok"

Ok is always Variant.Ok.

Methods

and

and(mAnd): Result<U, E>
Method variant for and
Type Parameters
- U
Parameters
- mAnd: Result<U, E>
Returns Result<U, E>
Inherited from Omit.and
- Defined in result.ts:181

andThen

andThen(andThenFn): Result<U, E>
Method variant for andThen
Type Parameters
- U
Parameters
- andThenFn: ((t) => Result<U, E>)
 - - (t): Result<U, E>
 - Parameters
 
 t: T
 
 Returns Result<U, E>
Returns Result<U, E>
Inherited from Omit.andThen
- Defined in result.ts:187

ap

ap<A, B>(this, r): Result<B, E>
Method variant for ap
Type Parameters
- A
- B
Parameters
- this: Result<((a) => B), E>
- r: Result<A, E>
Returns Result<B, E>
Inherited from Omit.ap
- Defined in result.ts:224

cast

cast<F>(): Result<T, F>
Type Parameters
- F
Returns Result<T, F>
- Defined in result.ts:248

equals

equals(comparison): boolean
Method variant for equals
Parameters
- comparison: Result<T, E>
Returns boolean
Inherited from Omit.equals
- Defined in result.ts:213

map

map(mapFn): Result<U, E>
Method variant for map
Type Parameters
- U
Parameters
- mapFn: ((t) => U)
 - - (t): U
 - Parameters
 
 t: T
 
 Returns U
Returns Result<U, E>
Inherited from Omit.map
- Defined in result.ts:146

mapErr

mapErr<F>(mapErrFn): Result<T, F>
Method variant for mapErr
Type Parameters
- F
Parameters
- mapErrFn: ((e) => F)
 - - (e): F
 - Parameters
 
 e: E
 
 Returns F
Returns Result<T, F>
Inherited from Omit.mapErr
- Defined in result.ts:166

mapOr

mapOr(orU, mapFn): U
Method variant for mapOr
Type Parameters
- U
Parameters
- orU: U
- mapFn: ((t) => U)
  - - (t): U
    - Parameters
      
      t: T
      
      Returns U
Returns U
Inherited from Omit.mapOr
- Defined in result.ts:151

mapOrElse

mapOrElse(orElseFn, mapFn): U
Method variant for mapOrElse
Type Parameters
- U
Parameters
- orElseFn: ((err) => U)
  - - (err): U
    - Parameters
      
      err: E
      
      Returns U
- mapFn: ((t) => U)
  - - (t): U
    - Parameters
      
      t: T
      
      Returns U
Returns U
Inherited from Omit.mapOrElse
- Defined in result.ts:156

match

match(matcher): U
Method variant for match
Type Parameters
- U
Parameters
- matcher: Matcher<T, E, U>
Returns U
Inherited from Omit.match
- Defined in result.ts:161

or

or<F>(orResult): Result<T, F>
Method variant for or
Type Parameters
- F
Parameters
- orResult: Result<T, F>
Returns Result<T, F>
Inherited from Omit.or
- Defined in result.ts:171

orElse

orElse<F>(orElseFn): Result<T, F>
Method variant for orElse
Type Parameters
- F
Parameters
- orElseFn: ((err) => Result<T, F>)
 - - (err): Result<T, F>
 - Parameters
 
 err: E
 
 Returns Result<T, F>
Returns Result<T, F>
Inherited from Omit.orElse
- Defined in result.ts:176

toJSON

toJSON(): ResultJSON<T, E>
Method variant for toJSON

Returns ResultJSON<T, E>
Inherited from Omit.toJSON
- Defined in result.ts:207

toString

toString(): string
Method variant for toString

Returns string
Inherited from Omit.toString
- Defined in result.ts:202

unwrapOr

unwrapOr(defaultValue): T | U
Method variant for unwrapOr
Type Parameters
- U = T
Parameters
- defaultValue: U
Returns T | U
Inherited from Omit.unwrapOr
- Defined in result.ts:192

unwrapOrElse

unwrapOrElse(elseFn): T | U
Method variant for unwrapOrElse
Type Parameters
- U
Parameters
- elseFn: ((error) => U)
  - - (error): U
    - Parameters
      
      error: E
      
      Returns U
Returns T | U
Inherited from Omit.unwrapOrElse
- Defined in result.ts:197

Interface Ok<T, E>

Typeparam

Typeparam

Type Parameters

T

E

Hierarchy

Index

Properties

Methods

Properties

isErr

isOk

value

Readonly variant

Methods

and

Type Parameters

U

Parameters

mAnd: Result<U, E>

Returns Result<U, E>

andThen

Type Parameters

U

Parameters

andThenFn: ((t) => Result<U, E>)

Parameters

t: T

Returns Result<U, E>

Returns Result<U, E>

ap

Type Parameters

A

B

Parameters

this: Result<((a) => B), E>

r: Result<A, E>

Returns Result<B, E>

cast

Type Parameters

F

Returns Result<T, F>

equals

Parameters

comparison: Result<T, E>

Returns boolean

map

Type Parameters

U

Parameters

mapFn: ((t) => U)

Parameters

t: T

Returns U

Returns Result<U, E>

mapErr

Type Parameters

F

Parameters

mapErrFn: ((e) => F)

Parameters

e: E

Returns F

Returns Result<T, F>

mapOr

Type Parameters

U

Parameters

orU: U

mapFn: ((t) => U)

Parameters

t: T

Returns U

Returns U

mapOrElse

Type Parameters

U

Parameters

orElseFn: ((err) => U)

`Readonly` variant