PrimFailure | @quenk/preconditions

PrimFailure is the failure

Type parameters

A

Hierarchy

PrimFailure

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PrimFailure(message: string, value?: A, context?: Context): PrimFailure

- Defined in result/failure/index.ts:113
Parameters
- message: string
- Optional value: A
- Default value context: Context = {}
Returns PrimFailure

Properties

context

context: Context

message

message: string

Optional value

value: A

Methods

explain

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

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

toError

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

- Defined in result/failure/index.ts:160
Parameters
- Default value templates: ErrorTemplates = {}
- Default value context: Context = {}
Returns Error

Static create

create<A>(message: string, value: A, ctx?: Context): PrimFailure<A>

- Defined in result/failure/index.ts:120
Type parameters
- A
Parameters
- message: string
- value: A
- Default value ctx: Context = {}
Returns PrimFailure<A>

Generated using TypeDoc