Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExpectationStatus<T>

The class ExpectationStatus is the type of the return value when an expectation is resolved. It serves two purposes:

  • they can be used to present a reporting about input's contract of modules
  • in case of FulfilledExpectation it includes the normalized value of the data

ExpectationStatus has a tree structure, the same way expectations have (complex 'expectations' are built from combinations of children expectations).

See Contract for a contextual discussion about expectations, status, and normalized values.

Type parameters

  • T

    The type of FulfilledExpectation.value, i.e. the type of the expectation return's value (normalized value) when the expectation is fulfilled

Hierarchy

Index

Constructors

constructor

Properties

Readonly children

children: ExpectationStatus<T>[]

Readonly expectation

expectation: IExpectation<T>

Readonly fromValue

fromValue: unknown

Readonly succeeded

succeeded: boolean

Readonly value

value: T

Generated using TypeDoc