Type Alias StoreOptions<TState>

type StoreOptions<TState extends object> = {
    onAttach?: StoreEventHandler<TState>;
    onDetach?: StoreEventHandler<TState>;
    onLoad?: StoreEventHandler<TState>;
    onStateChange?: StoreEventHandler<TState>;
    resetOnDetach?: boolean;
}

Type Parameters

TState extends object

Index

Properties

onAttach? onDetach? onLoad? onStateChange? resetOnDetach?

Properties

`Optional`onAttach

onAttach?: StoreEventHandler<TState>

Invoked when the store is subscribed to.

`Optional`onDetach

onDetach?: StoreEventHandler<TState>

Invoked when the store is unsubscribed from.

`Optional`onLoad

onLoad?: StoreEventHandler<TState>

Invoked when the store is created.

`Optional`onStateChange

onStateChange?: StoreEventHandler<TState>

Invoked whenever the state changes.

`Optional`resetOnDetach

resetOnDetach?: boolean

Whether to reset the state to the initial state when the store is detached.