RecordFailure | @quenk/preconditions

RecordFailure contains information about a precondition that failed when applied to an object.

Type parameters

A

Hierarchy

RecordFailure

Implements

Failure<Record<A>>

Index

Constructors

constructor

Properties

Accessors

context

Methods

Constructors

constructor

new RecordFailure(failures: Failures<A>, value: Record<A>, contexts?: Contexts): RecordFailure

- Defined in result/failure/record.ts:18
Parameters
- failures: Failures<A>
- value: Record<A>
- Default value contexts: Contexts = {}
Returns RecordFailure

Properties

contexts

contexts: Contexts

failures

failures: Failures<A>

message

message: string = "object"

value

value: Record<A>

Accessors

context

get context(): Context

- Defined in result/failure/record.ts:27
Returns Context

Methods

explain

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

- Defined in result/failure/record.ts:42
Parameters
- Default value templates: ErrorTemplates = {}
- Default value c: Context = {}
Returns Explanation

toError

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

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

Static create

create<A>(errs: Failures<A>, val: Record<A>, ctxs?: Contexts): RecordFailure<A>

- Defined in result/failure/record.ts:33
Type parameters
- A
Parameters
- errs: Failures<A>
- val: Record<A>
- Default value ctxs: Contexts = {}
Returns RecordFailure<A>

Generated using TypeDoc