Put class

Creates an Effect description that instructs the middleware to schedule the dispatching of an action to the store. This dispatch may not be immediate since other tasks might lie ahead in the saga task queue or still be in progress.

You can, however, expect the store to be updated in the current stack frame (i.e. by the next line of code after yield Put(action)) unless you have other Redux middlewares with asynchronous flows that delay the propagation of the action.

Downstream errors (e.g. from the reducer) will be bubbled up.

If a channel is provided then action will be put to the provided channel. Then effect is blocking if the put is not buffered but immediately consumed by takers. If an error is thrown in any of these takers it will bubble back into the saga.

If resolve is true then effect is blocking (if Future is returned from dispatch it will wait for its resolution) and will bubble up errors from downstream.

Inheritance

• Object
• Effect
• EffectWithResult
• Put

Implementers

• PutResolve

Constructors

Put(dynamic action, {Channel? channel, bool resolve = false, Result? result})

Creates an instance of a Put effect.

Properties

action → dynamic

Action object to dispatch.

final

channel → Channel?

Channel to dispatch action.

final

hashCode → int

The hash code for this object.

no setter, inherited

resolve → bool

If true effect will block until resolve.

final

result ↔ Result?

Result after effect is resolved.

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getDefinition() → Map<String, dynamic>

Returns all properties of effect as a dictionary object

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited