Class ZCircusReactHook<T, P>

An implementation of an IZReactHook that wraps the result from @testing-library/react.

Type Parameters

T
P

Implements

IZCircusReactHook<T, P>

Index

Constructors

Methods

current destroy rerender

Constructors

constructor

new ZCircusReactHook<T, P>(
_result: RenderHookResult<T, P>,
): ZCircusReactHook<T, P>
Initializes a new instance of this object.
Type Parameters
- T
- P
Parameters
- _result: RenderHookResult<T, P>
  The render result.
Returns ZCircusReactHook<T, P>
- Defined in driver/circus-react-hook.mts:46

Methods

current

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

Returns Promise<T>
The current value.
Implementation of IZCircusReactHook.current
- Defined in driver/circus-react-hook.mts:53

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>
Implementation of IZCircusReactHook.destroy
- Defined in driver/circus-react-hook.mts:48

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.
Implementation of IZCircusReactHook.rerender
- Defined in driver/circus-react-hook.mts:57