"result/index" | @quenk/preconditions

Index

Type aliases

Result

Functions

fail
succeed

Type aliases

Result

Result<A, B>: Either<Failure<A>, B>

Result of a precondition type.

A precondition either fails or provides a new value.

Type parameters

A
B

Functions

Const fail

fail<A, B>(msg: string, value: A, ctx?: Context): Result<A, B>

- Defined in result/index.ts:15
fail constructs a new failed Result using the parameters supplied to create a new Failure instance.

Type parameters
- A
- B
Parameters
- msg: string
- value: A
- Default value ctx: Context = {}
Returns Result<A, B>

Const succeed

succeed<A, B>(b: B): Result<A, B>

- Defined in result/index.ts:23
succeed constructs a successful Result wraping the final version of the value in the right side of an Either.

Type parameters
- A
- B
Parameters
- b: B
Returns Result<A, B>

Generated using TypeDoc