WaitAction<St> class

WaitAction and Wait work together to help you create boolean flags that indicate some process is currently running. For this to work your store state must have a Wait field named wait, and then:

The state must have a copy or copyWith method that copies this field as a named parameter. For example:

class AppState {
  final Wait wait;
  AppState({this.wait});
  AppState copy({Wait wait}) => AppState(wait: wait);
  }

OR:

You must use the BuiltValue package https://pub.dev/packages/built_value, which automatically creates a rebuild method.

OR:

You must use the Freezed package https://pub.dev/packages/freezed, which automatically creates the copyWith method.

OR:

Inject your own WaitReducer implementation into WaitAction by replacing the static variable WaitAction.reducer with a callback that changes the wait object as you see fit.

OR:

Don't use the WaitAction, but instead create your own MyWaitAction that uses the Wait object in whatever way you want.

Inheritance

Object
ReduxAction<St>
WaitAction

Constructors

WaitAction.add(Object? flag, {Object? ref, Duration? delay}): Adds a flag that indicates some process is currently running. Optionally, you can also have a flag-reference called ref.
WaitAction.clear([Object? flag]): Clears (removes) the flag, with all its references. Removing the flag indicating some process finished running.
WaitAction.remove(Object? flag, {Object? ref, Duration? delay}): Removes a flag previously added with the add method. Removing the flag indicating some process finished running.

Properties

delay → Duration?: final
dispatch → Dispatch<St>: Dispatches the action, applying its reducer, and possibly changing the store state. The action may be sync or async.
no setterinherited
dispatchAll → List<ReduxAction<St>> Function(List<ReduxAction<St>> actions, {bool notify}): Dispatches all given actions in parallel, applying their reducer, and possibly changing the store state. It returns the same list of actions, so that you can instantiate them inline, but still get a list of them.
no setterinherited
dispatchAndWait → DispatchAndWait<St>: Dispatches the action, applying its reducer, and possibly changing the store state. The action may be sync or async. In both cases, it returns a Future that resolves when the action finishes.
no setterinherited
dispatchAndWaitAll → Future<List<ReduxAction<St>>> Function(List<ReduxAction<St>> actions, {bool notify}): Dispatches all given actions in parallel, applying their reducers, and possibly changing the store state. The actions may be sync or async. It returns a Future that resolves when ALL actions finish.
no setterinherited
dispatchAsync → DispatchAsync<St>: no setterinherited
dispatchSync → DispatchSync<St>: Dispatches the action, applying its reducer, and possibly changing the store state. However, if the action is ASYNC, it will throw a StoreException.
no setterinherited
env → Object?: Gets the store environment. This can be used to create a global value, but scoped to the store. For example, you could have a service locator, here, or a configuration value.
no setterinherited
flag → Object?: final
hashCode → int: The hash code for this object.
no setterinherited
initialState → St: Returns the state as it was when the action was dispatched.
no setterinherited
isFinished → bool: Returns true only if the action finished with no errors. In other words, if the methods before, reduce and after all finished executing without throwing any errors.
no setterinherited
microtask → Future: To wait for the next microtask: await microtask;
no setterinherited
operation → WaitOperation: final
ref → Object?: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state → St: no setterinherited
stateTimestamp → DateTime: no setterinherited
status → ActionStatus: no setterinherited
store → Store<St>: no setterinherited

Methods

abortDispatch() → bool: If abortDispatch returns true, the action will NOT be dispatched: before, reduce and after will not be called, and the action will not be visible to the store observers.
inherited
after() → void: This is an optional method that may be overridden to run during action dispatching, after reduce. If this method throws an error, the error will be swallowed (will not throw). So you should only run code that can't throw errors. It may be synchronous only. Note this method will always be called, even if errors were thrown by before or reduce.
inherited
assertUncompletedFuture() → void: An async reducer (one that returns Future<AppState?>) must never complete without at least one await, because this may result in state changes being lost. It's up to you to make sure all code paths in the reducer pass through at least one await.
inherited
before() → FutureOr<void>: This is an optional method that may be overridden to run during action dispatching, before reduce. If this method throws an error, the reduce method will NOT run, but the method after will. It may be synchronous (returning void) ou async (returning Future<void>). You should NOT return FutureOr.
inherited
clearExceptionFor(Object actionTypeOrList) → void: Removes the given actionTypeOrList from the list of action types that failed.
inherited
exceptionFor(Object actionTypeOrList) → UserException?: Returns the UserException of the actionTypeOrList that failed.
inherited
isFailed(Object actionOrTypeOrList) → bool: Returns true if an actionOrActionTypeOrList failed with an UserException. Note: This method uses the EXACT type in actionOrActionTypeOrList. Subtypes are not considered.
inherited
isSync() → bool: Returns true if the action is SYNC, and false if the action is ASYNC. The action is considered SYNC if the before method, the reduce method, and the wrapReduce methods are all synchronous.
inherited
isWaiting(Object actionOrTypeOrList) → bool: You can use isWaiting to check if:
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
prop<V>(Object? key) → V: Gets a property from the store. This can be used to save global values, but scoped to the store. For example, you could save timers, streams or futures used by actions.
inherited
reduce() → St?: The reduce method is the action reducer. It may read the action state, the store state, and then return a new state (or null if no state change is necessary).
override
runtimeTypeString() → String: Returns the runtimeType, without the generic part.
inherited
setProp(Object? key, Object? value) → void: Sets a property in the store. This can be used to save global values, but scoped to the store. For example, you could save timers, streams or futures used by actions.
inherited
setStore(Store<St> store) → void: inherited
toString() → String: A string representation of this object.
override
waitAllActions(List<ReduxAction<St>> actions, {bool completeImmediately = false}) → Future<void>: Returns a future that completes when ALL given actions finished dispatching. You MUST provide at list one action, or an error will be thrown.
inherited
waitCondition(bool condition(St), {int? timeoutMillis}) → Future<ReduxAction<St>?>: Returns a future which will complete when the given state condition is true. If the condition is already true when the method is called, the future completes immediately.
inherited
wrapError(Object error, StackTrace stackTrace) → Object?: If any error is thrown by reduce or before, you have the chance to further process it by using wrapError. Usually this is used to wrap the error inside of another that better describes the failed action. For example, if some action converts a String into a number, then instead of throwing a FormatException you could do:
inherited
wrapReduce(Reducer<St> reduce) → Reducer<St>: You may wrap the reducer to allow for some pre- or post-processing. For example, if you want to prevent an async reducer to change the current state, if the current state has already changed since when the reducer started:
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

reducer ↔ WaitReducer: Works out-of-the-box for most use cases, but you can inject your own reducer here during your app's initialization, if necessary.
getter/setter pair