Type alias EffectSignals<Input, Result, Error>

EffectSignals<Input, Result, Error>: Signals<EffectInputSignals<Input>, EffectOutputSignals<Input, Result, Error>, EffectFactoryEffects<Input, Result, Error>>

This type specifies generic effect signals. EffectSignals generically handle side-effects (hence, are an abstraction over side-effects). They fulfill the following requirements:

1.) The produced CombinedEffectResult<Input, Result, Error> behavior must be lazy, hence, as long as it is not subscribed,
no effect will be triggered (so subscribing just results, or completedResults will not trigger the effect).
2.) Unhandled effect errors are caught and will lead to an EffectError<UnhandledEffectError>.
3.) In addition to the combined-behavior, also event-streams for EffectResultEvent and EffectCompletedResultEvent are provided. This is important
in cases where e.g. an effect success should be used to trigger something else (e.g. close a popup), but you cannot use the result
behavior, because it would mean to always subscribe the result. In contrast, subscription of the an rsult-event-stream will NOT
subscribe the effect.

See the documentation for EffectConfiguration for further configuration of EffectSignals.

Type Parameters

  • Input

    specifies the input type for the effect

  • Result

    specifies the result type of the effect

  • Error

    specifies the error type of the effect

Generated using TypeDoc