Module result

Index

Classes

Interfaces

ResultType

Type aliases

Functions

Type aliases

AsyncResult

AsyncResult<T, E>: Promise<Result<T, E>>

Alias for Promise<Result<T, E>>

see: Result

Type parameters

T = unknown

Type of successful result
E = Error

Type of error result

Result

Result<T, E>: SuccessResult<T> | FailureResult<E>

A result that is either a SuccessResult or FailureResult

Type parameters

T = unknown

Type of successful result
E = Error

Type of error result

Functions

failure

failure<E>(error: E): FailureResult<E>

Utility function for creating a FailureResult instance

Type parameters
- E = Error
Parameters
- error: E
Returns FailureResult<E>

success

success<T>(result: T): SuccessResult<T>

Utility function for creating a SuccessResult instance

Type parameters
- T
Parameters
- result: T
Returns SuccessResult<T>

Generated using TypeDoc