kotlin-node/node.test/MockFunctionContext

MockFunctionContext

sealed external interface MockFunctionContext<F : Function<*>>(source)

The MockFunctionContext class is used to inspect or manipulate the behavior of mocks created via the MockTracker APIs.

Since

v19.1.0, v18.13.0

Properties

calls

abstract val calls: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<node/test/MockFunctionCall<F, *, *>>

A getter that returns a copy of the internal array used to track calls to the mock. Each entry in the array is an object with the following properties.

Functions

callCount

abstract fun callCount(): Double

This function returns the number of times that this mock has been invoked. This function is more efficient than checking ctx.calls.length because ctx.calls is a getter that creates a copy of the internal call tracking array.

mockImplementation

abstract fun mockImplementation(implementation: F)

This function is used to change the behavior of an existing mock.

mockImplementationOnce

abstract fun mockImplementationOnce(implementation: F, onCall: Number = definedExternally)

This function is used to change the behavior of an existing mock for a single invocation. Once invocation onCall has occurred, the mock will revert to whatever behavior it would have used had mockImplementationOnce() not been called.

resetCalls

abstract fun resetCalls()

Resets the call history of the mock function.

restore

abstract fun restore()

Resets the implementation of the mock function to its original behavior. The mock can still be used after calling this function.