ArrayFailure | @quenk/preconditions

ArrayFailure represents the failed results of applying a precondition to one or more elements of an array.

Type parameters

A

Hierarchy

ArrayFailure

Implements

Failure<A[]>

Index

Constructors

constructor

Properties

Accessors

context

Methods

Constructors

constructor

new ArrayFailure(failures: Failures<A>, value: A[], contexts?: Contexts): ArrayFailure

- Defined in result/failure/array.ts:18
Parameters
- failures: Failures<A>
- value: A[]
- Default value contexts: Contexts = {}
Returns ArrayFailure

Properties

contexts

contexts: Contexts

failures

failures: Failures<A>

message

message: string = "array"

value

value: A[]

Accessors

context

get context(): Context

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

Methods

explain

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

- Defined in result/failure/array.ts:39
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/array.ts:48
Parameters
- Default value templates: ErrorTemplates = {}
- Default value context: Context = {}
Returns Error

Static create

create<A>(errs: Failures<A>, val: A[], ctx: Contexts): ArrayFailure<A>

- Defined in result/failure/array.ts:33
Type parameters
- A
Parameters
- errs: Failures<A>
- val: A[]
- ctx: Contexts
Returns ArrayFailure<A>

Generated using TypeDoc