Interface IZCircusReactHook<T, P>

Represents a driver for a react hook.

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

Type Parameters

T
P

Hierarchy (View Summary)

IZCircusDestroy
- IZCircusReactHook

Implemented by

ZCircusReactHook

Index

Properties

Methods

current rerender

Properties

`Optional`destroy

destroy?: () => Promise<void>

Destroys the session.

This releases all memory and items used by this object. If nothing is used, then this may do nothing.

Methods

current

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

Returns Promise<T>
The current value.
- Defined in cirque-du-react/src/driver/circus-react-hook.mts:14

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 cirque-du-react/src/driver/circus-react-hook.mts:22