Type alias EffectInputSignals<Input>

EffectInputSignals<Input>: {
    input: DerivedId<Input>;
    invalidate: EventId<undefined>;
    trigger: EventId<undefined>;
}

Type specifying the input EffectSignals (the corresponding signal-sources are NOT added to the store by the EffectSignals-setup, but by whoever uses the signals, e.g. by extendSetup or fmap or just using dispatch). The EffectSignalsFactory gives you the guarantee, that invalidate-events are NOT missed, even while the combined-behavior is not subscribed.

Type Parameters

  • Input

    specifies the input type for the effect

Type declaration

  • input: DerivedId<Input>

    Behavior being consumed by EffectSignals as input (see EffectConfiguration on how to configure your factory to subscribe the corresponding behavior eagerly)

  • invalidate: EventId<undefined>

    Event that can be dispatched to trigger re-evaluation of the current input under the given effect

  • trigger: EventId<undefined>

    Event that can be dispatched to trigger the given effect. This event has only meaning, if withTrigger is configured (see EffectConfiguration), else dispatching it is a no-op.

Generated using TypeDoc