MockStore<St> class
Creates a Redux store that lets you mock actions/reducers.
The MockStore lets you define mock actions/reducers for specific actions.
For more info, see: https://pub.dartlang.org/packages/async_redux
Constructors
-
MockStore({required St initialState, bool syncStream = false, TestInfoPrinter? testInfoPrinter, List<
ActionObserver< ? actionObservers, List<St> >StateObserver< ? stateObservers, Persistor<St> >St> ? persistor, ModelObserver? modelObserver, ErrorObserver<St> ? errorObserver, WrapError<St> ? wrapError, bool defaultDistinct = true, Map<Type, dynamic> ? mocks})
Properties
- defaultDistinct → bool
-
no setterinherited
- dispatchCount → int
-
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
-
errors
→ Queue<
UserException> -
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- immutableCollectionEquality → CompareBy?
-
If
null
(the default), view-models which are immutable collections will be compared by their default equality.If
CompareBy.byDeepEquals
, view-models which are immutable collections will be compared by their items, one by one (potentially slow comparison).If
CompareBy.byIdentity
, view-models which are immutable collections will be compared by their internals being identical (very fast comparison).no setterinherited - isShutdown → bool
-
no setterinherited
-
mocks
↔ Map<
Type, dynamic> ? -
null
to disable dispatching the action of a certain type.A
MockAction<St>
instance to dispatch that action instead, and provide the original action as a getter to the mocked action.A
ReduxAction<St>
instance to dispatch that mocked action instead.ReduxAction<St> Function(ReduxAction<St>)
to create a mock from the original action.St Function(ReduxAction<St>, St)
orFuture<St> Function(ReduxAction<St>, St)
to modify the state directly.getter/setter pair - modelObserver → ModelObserver?
-
no setterinherited
-
onChange
→ Stream<
St> -
A stream that emits the current state when it changes.
no setterinherited
-
onReduce
→ Stream<
TestInfo< St> > -
Used by the storeTester.
no setterinherited
- reduceCount → int
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → St
-
The current state of the app.
no setterinherited
- stateTimestamp → DateTime
-
The timestamp of the current state in the store, in UTC.
no setterinherited
- testInfoPrinter → TestInfoPrinter?
-
no setterinherited
Methods
-
actionsInProgress(
) → Set< ReduxAction< St> > -
Returns an unmodifiable set of the actions on progress.
inherited
-
addMock(
Type actionType, dynamic mock) → MockStore< St> -
addMocks(
Map< Type, dynamic> mocks) → MockStore<St> -
clearExceptionFor(
Object actionTypeOrList) → void -
Removes the given
actionTypeOrList
from the list of action types that failed.inherited -
clearMocks(
) → MockStore< St> -
createTestInfoSnapshot(
St state, ReduxAction< St> action, Object? error, Object? processedError, {required bool ini}) → void -
inherited
-
defineState(
St state) → void -
Beware: Changes the state directly. Use only for TESTS.
This will not notify the listeners nor complete wait conditions.
inherited
-
deleteStateFromPersistence(
) → Future< void> -
Asks the Persistor to delete the saved state from the local persistence.
inherited
-
dispatch(
ReduxAction< St> action, {bool notify = true}) → FutureOr<ActionStatus> - Dispatches the action, applying its reducer, and possibly changing the store state. The action may be sync or async.
-
dispatchAll(
List< ReduxAction< actions, {bool notify = true}) → List<St> >ReduxAction< St> > -
Dispatches all given
actions
in parallel, applying their reducer, and possibly changing the store state. It returns the same list ofactions
, so that you can instantiate them inline, but still get a list of them.inherited -
dispatchAndWait(
ReduxAction< St> action, {bool notify = true}) → Future<ActionStatus> - 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.
-
dispatchAndWaitAll(
List< ReduxAction< actions, {bool notify = true}) → Future<St> >List< ReduxAction< >St> > -
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.inherited -
dispatchAsync(
ReduxAction< St> action, {bool notify = true}) → Future<ActionStatus> -
dispatchSync(
ReduxAction< St> action, {bool notify = true}) → ActionStatus - Dispatches the action, applying its reducer, and possibly changing the store state. However, if the action is ASYNC, it will throw a StoreException.
-
disposeProps(
[bool predicate({Object? key, Object? value})?]) → void -
The disposeProps method is used to clean up resources associated with the store's
properties, by stopping, closing, ignoring and removing timers, streams, sinks, and futures
that are saved as properties in the store.
inherited
-
exceptionFor(
Object actionTypeOrList) → UserException? -
Returns the UserException of the
actionTypeOrList
that failed.inherited -
getAndRemoveFirstError(
) → UserException? -
Gets the first error from the error queue, and removes it from the queue.
inherited
-
getLastPersistedStateFromPersistor(
) → St? -
Gets, from the Persistor, the last state that was saved to the local persistence.
inherited
-
initTestInfoController(
) → void -
Turns on testing capabilities, if not already.
inherited
-
initTestInfoPrinter(
TestInfoPrinter testInfoPrinter) → void -
Changes the testInfoPrinter.
inherited
-
isFailed(
Object actionOrActionTypeOrList) → bool -
Returns true if an
actionOrActionTypeOrList
failed with an UserException. Note: This method uses the EXACT type inactionOrActionTypeOrList
. Subtypes are not considered.inherited -
isWaiting(
Object actionOrActionTypeOrList) → bool -
You can use isWaiting and pass it
actionOrActionTypeOrList
to check if:inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pausePersistor(
) → void -
Pause the Persistor temporarily.
inherited
-
persistAndPausePersistor(
) → void -
Persists the current state (if it's not yet persisted), then pauses the Persistor
temporarily.
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
-
readStateFromPersistence(
) → Future< St?> -
Asks the Persistor to read the state from the local persistence.
Important: If you use this, you MUST put this state into the store.
The Persistor will assume that's the case, and will not work properly otherwise.
inherited
-
resumePersistor(
) → void -
Resumes persistence by the Persistor,
after calling pausePersistor or persistAndPausePersistor.
inherited
-
saveInitialStateInPersistence(
St initialState) → Future< void> -
Asks the Persistor to save the
initialState
in the local persistence.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
-
shutdown(
) → void -
Call this method to shut down the store.
It won't accept dispatches or change the state anymore.
inherited
-
teardown(
{St? emptyState}) → Future -
Closes down the store so it will no longer be operational.
Only use this if you want to destroy the Store while your app is running.
Do not use this method as a way to stop listening to onChange state changes.
For that purpose, view the onChange documentation.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
waitActionCondition(
bool condition(Set< ReduxAction< actions, ReduxAction<St> >St> ? triggerAction), {bool completeImmediately = false, String completedErrorMessage = "Awaited action condition was already true", int? timeoutMillis}) → Future<(Set< ReduxAction< , ReduxAction<St> >St> ?)> -
Returns a future that completes when some actions meet the given
condition
.inherited -
waitActionType(
Type actionType, {bool completeImmediately = false, int? timeoutMillis}) → Future< ReduxAction< St> ?> -
Returns a future that completes when an action of the given type in NOT in progress
(it's not being dispatched):
inherited
-
waitAllActions(
List< ReduxAction< ? actions, {bool completeImmediately = false, int? timeoutMillis}) → Future<St> >void> -
Returns a future that completes when ALL given
actions
finish dispatching.inherited -
waitAllActionTypes(
List< Type> actionTypes, {bool completeImmediately = false, int? timeoutMillis}) → Future<void> -
Returns a future that completes when ALL actions of the given type are NOT in progress
(none of them is being dispatched):
inherited
-
waitAnyActionTypeFinishes(
List< Type> actionTypes, {int? timeoutMillis}) → Future<ReduxAction< St> > -
Returns a future which will complete when ANY action of the given types FINISHES
dispatching. IMPORTANT: This method is different from the other similar methods, because
it does NOT complete immediately if no action of the given types is in progress. Instead,
it waits until an action of the given types finishes dispatching, even if they
were not yet in progress when the method was called.
inherited
-
waitCondition(
bool condition(St), {bool completeImmediately = true, int? timeoutMillis}) → Future< ReduxAction< St> ?> -
Returns a future which will complete when the given state
condition
is true.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited