FullExpectation | @gobstones/gobstones-core

The expectation class is the class that is actually instantiated for any expectation. It implements all interfaces for expectations, even the finished expectation ones.

Hierarchy (view full)

AbstractFinishedExpectation
- FullExpectation

Constructors

constructor

new FullExpectation(element): FullExpectation

Create a new expectation for the given element.

Parameters

element: unknown
The element to query to.

Properties

Protected

element

element: unknown

The querying element of this expectation.

Protected

isNot

isNot: boolean

true if this expectation is a negated expectation, that is, the not property was accessed.

Protected

result

result: boolean

The current result of this expectation. Undefined until the first matcher is run.

Protected

states

states: MatcherCall[]

An array of the matchers run in this expectation.

Accessors

not

get not(): this

Returns this

Inherit Doc

Expectation.not

Methods

allToSatisfy

allToSatisfy(criteria): FullExpectation & FinishedExpectation

Parameters

criteria: ((item: unknown) => boolean)
- - (item): boolean
  - Parameters
    - item: unknown
    Returns boolean

Returns FullExpectation & FinishedExpectation

Inherit Doc

ArrayExpectation.allToSatisfy

amountToSatisfy

amountToSatisfy(count, criteria): FullExpectation & FinishedExpectation

Parameters

count: number
criteria: ((item: unknown) => boolean)
- - (item): boolean
  - Parameters
    - item: unknown
    Returns boolean

Returns FullExpectation & FinishedExpectation

Inherit Doc

ArrayExpectation.amountToSatisfy

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(actionWhenTrue, actionWhenFalse): void

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

Parameters

actionWhenTrue: (() => void)
- - (): void
  - Returns void
actionWhenFalse: (() => void)
- - (): void
  - Returns void

Returns void

anyToSatisfy

anyToSatisfy(criteria): FullExpectation & FinishedExpectation

Parameters

criteria: ((item: unknown) => boolean)
- - (item): boolean
  - Parameters
    - item: unknown
    Returns boolean

Returns FullExpectation & FinishedExpectation

Inherit Doc

ArrayExpectation.anyToSatisfy

asArray

asArray<E>(): ArrayExpectation<E>

Type Parameters

Type Parameters

Inherit Doc

Expectation.asObject

asString

asString(): StringExpectation

Inherit Doc

Expectation.asString

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

error: Error

Returns void

orYield

orYield<T>(value): T

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

Type Parameters

Parameters

value: T

Returns T

Protected

runMatcher

runMatcher(matcherName, args, sparse?): this

Run a matcher with the given name, passing the querying element as a first argument, and all additional given arguments. The result of running the matcher is stores, and a new state is pushed to this particular matcher.

Parameters

matcherName: string
The matcher name to run
args: unknown[]
The arguments to pass to the matcher
sparse: boolean = true

Returns this

Protected

setResult

setResult(value): void

Set the given value as the result of this expectation. The result is directly set, when no previous result existed, or joined with a logic conjunction with the previous result if a value already exists.