Interface StateEventData<S>

Event data for state mutation events.

interface StateEventData<S = unknown> {
    current: S;
    key?: keyof S;
    previous?: S;
    value?: S[keyof S] | Partial<S>;
}

Type Parameters

S = unknown
Instance state type

Index

Properties

current key? previous? value?

Properties

current

current: S

Current state after the change

`Optional`key

key?: keyof S

Key that was set (for single key updates)

`Optional`previous

previous?: S

Previous state before the change

`Optional`value

value?: S[keyof S] | Partial<S>

Value that was set