Interface IZCircusReactHook<T, P>

Represents a driver for a react hook.

interface IZCircusReactHook<T, P> {
    current(): Promise<T>;
    destroy(): Promise<void>;
    rerender(props?: P): Promise<T>;
}

Type Parameters

T
P

Implemented by

ZCircusReactHook

Index

Methods

current destroy rerender

Methods

current

current(): Promise<T>
Returns the current state of the data.

Returns Promise<T>
The current value.
- Defined in driver/circus-react-hook.mts:24

destroy

destroy(): Promise<void>
Destroys the hook.

This call is optional. Hooks will be destroyed automatically when the test framework is unmounted. This is useful for testing use cases of a hook after the parent component has been unmounted.

Returns Promise<void>
- Defined in driver/circus-react-hook.mts:16

rerender

rerender(props?: P): Promise<T>
Rerenders the underlying hook and gives the results.
Parameters
- Optionalprops: P
Returns Promise<T>
The current value after the render.
- Defined in driver/circus-react-hook.mts:32