ModifiedFailure | @quenk/preconditions

ModifiedFailure is used in situations where a precondition is composite and we need to modify the value to be the original left one.

Type parameters

A
B

Hierarchy

ModifiedFailure

Implements

Failure<A>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ModifiedFailure(value: A, previous: Failure<B>): ModifiedFailure

- Defined in result/failure/index.ts:172
Parameters
- value: A
- previous: Failure<B>
Returns ModifiedFailure

Properties

previous

previous: Failure<B>

value

value: A

Accessors

context

get context(): Context

- Defined in result/failure/index.ts:182
Returns Context

message

get message(): string

- Defined in result/failure/index.ts:176
Returns string

Methods

explain

explain(templates?: ErrorTemplates, ctx?: Context): Explanation

- Defined in result/failure/index.ts:194
Parameters
- Default value templates: ErrorTemplates = {}
- Default value ctx: Context = {}
Returns Explanation

toError

toError(templates?: ErrorTemplates, context?: Context): Error

Implementation of Failure.toError
- Defined in result/failure/index.ts:200
Parameters
- Default value templates: ErrorTemplates = {}
- Default value context: Context = {}
Returns Error

Static create

create<A, B>(value: A, previous: Failure<B>): ModifiedFailure<A, B>

- Defined in result/failure/index.ts:188
Type parameters
- A
- B
Parameters
- value: A
- previous: Failure<B>
Returns ModifiedFailure<A, B>

Generated using TypeDoc