Type alias SignalsBuild<IN, OUT, CONFIG, EFF>

SignalsBuild<IN, OUT, CONFIG, EFF>: ((config: CONFIG) => Signals<IN, OUT, EFF>)

Type Parameters

Type declaration

    • (config: CONFIG): Signals<IN, OUT, EFF>
    • This type defines a function taking some config-object as argument and returning a Signals object, hence the type being used as constructor argument for SignalsFactory. It creates input- and output-ids, as well as effect-ids. It is the reactive counterpart of a class/class-constructor. However, the setup method of the returned Signals only adds signals to the store for the output-ids. For the input-ids, corresponding signals must be setup somewhere else (e.g. via store.connect). If you have a scenario, where setup needs a SignalId that is NOT created by SignalsBuild, then you can pass it via CONFIG. The same holds true for effects (no effects for the generated effect-ids will be added to the store). (see useExistingEffect on how to delegate from a generated effect-id to an existing effect)

      Parameters

      • config: CONFIG

      Returns Signals<IN, OUT, EFF>

Generated using TypeDoc