Class StateUpdate

reflex/state.py:2600–2620

A state update sent to the frontend.

    frozen=True,
)
class StateUpdate:
    """A state update sent to the frontend."""

    # The state delta.
    delta: DeltaMapping = dataclasses.field(default_factory=dict)

    # Events to be added to the event queue.
    events: list[Event] = dataclasses.field(default_factory=list)

    # Deprecated: previously indicated whether the event processing is complete.
    final: bool | None = dataclasses.field(default=None, repr=False)

    def __post_init__(self):
        """Warn if the deprecated `final` attribute is supplied."""
        if self.final is not None:
            console.deprecate(
                feature_name="StateUpdate.final",
                reason="The final attribute is no longer used.",
                deprecation_version="0.9.0",
                removal_version="1.0",
            )


@serializer(to=dict)