Go to repository

Interface FinishedExpectation

This interface represents an expectation after a matcher has been executed and the result can be accessed.

interface FinishedExpectation {
    andDo(action: (() => void)): void;
    andDoOr(actionIfTrue: (() => void), actionIfFalse: (() => void)): void;
    getResult(): boolean;
    orDo(action: (() => void)): void;
    orThrow(error: Error): void;
    orYield<T>(value: T): T;
}

Implemented by

Methods

andDo andDoOr getResult orDo orThrow orYield

Methods

andDo

andDo(action): void

If the result of the expectation is true, run the given function.

Parameters

  • action: (() => void)
      • (): void

      • Returns void

Returns void

andDoOr

andDoOr(actionIfTrue, actionIfFalse): void

If the result of the expectation is true, run the first of the functions, if false, run the second one.

Parameters

  • actionIfTrue: (() => void)
      • (): void

      • Returns void

  • actionIfFalse: (() => void)
      • (): void

      • Returns void

Returns void

getResult

getResult(): boolean

Return's the result of the expectancy as a boolean.

Returns boolean

true if the value satisfied the expectation, falseotherwise.

orDo

orDo(action): void

If the result of the expectation is false, run the given function.

Parameters

  • action: (() => void)
      • (): void

      • Returns void

Returns void

orThrow

orThrow(error): void

If the result of the expectation is false, throw the given error.

Parameters

Returns void

orYield

orYield<T>(value): T

If the result of the expectation is false, return the given value.

Type Parameters

  • T

Parameters

  • value: T

Returns T

Settings

Member Visibility

On This Page

Methods