pulse_x library

Classes

PulseStreamBuilder<V, VM extends PulseXStreamViewModel<V>>

PulseXArguments<T>

PulseXBuilder<V, VM extends PulseXBaseViewModel<V>>

PulseXFutureBuilder<V extends PulseXState, VM extends PulseXFutureViewModel<V>>

PulseXFutureViewModel<V extends PulseXState>

An abstract PulseXFutureViewModel that holds generic type V. PulseXFutureViewModel is used when dealing with API calls, It provides you with four states - initial state, loading state, loaded state, error state You can update PulseXState via changeState method If you wanna check the current state, use status getter method which returns PulseXStatus enum PulseXFutureViewModel extends PulseXBaseViewModel so that a single value can be used When value is replaced with something that is not equal to the old value as evaluated by the equality operator ==, this class notifies its listeners.

PulseXInjector

Very simple and easy to use service locator You register your object creation factory or an instance of an object with register, or registerLazySingleton And retrieve the desired object using find or call your locator as function as its a callable class

PulseXListViewModel<V>

PulseXListViewModel is intended for List data type of generic type V If you wanna add value to the list, use addValue method To remove value from the list, use removeValue method

PulseXMapViewModel<K, V>

PulseXMapViewModel is intended for Map data type of generic type V If you wanna add value to the Map, use addValue method with key & value To remove value from the list, use removeValue method with key When removing value from the Map, if key is not present in the Map PulseX will throw keyNotFoundError To empty Map, use clear method

PulseXNavigator

Navigation service using global navigator key

PulseXReaction<V extends PulseXState>

PulseXSetViewModel<V>

PulseXSetViewModel is intended for Set data type of generic type V If you wanna add value to set, use addValue method To remove value from set, use removeValue method

PulseXState<T>

Multiple future states occurred when using with FutureViewModel

PulseXStateManager<VM extends PulseXBaseViewModel>

PulseXStateManager extends InheritedWidget to manage state across the widget tree

PulseXStreamStateManager<VM extends PulseXStreamViewModel>

PulseXStreamStateManager extends InheritedWidget to manage stream data state across the widget tree

PulseXStreamViewModel<V>

An abstract PulseXStreamViewModel that holds generic type V. PulseXStreamViewModel extends ChangeNotifier You don't need to care about StreamController and Stream, PulseX will automatically handle them If you wanna add data to Stream via sink, use addValue method You can pause, resume or update stream by calling method pause & resume & update NOTE: be sure to call dispose method to avoid memory leak

PulseXViewModel<V>

An abstract PulseXViewModel that holds generic type V. PulseXBaseViewModel is intended for simple data types such as String, int, double, etc PulseXBaseViewModel extends PulseXBaseViewModel When value is replaced with something that is not equal to the old value as evaluated by the equality operator ==, this class notifies its listeners.

Enums

PulseXStatus