Type alias CombinedEffectResult<Input, Result, Error>

CombinedEffectResult<Input, Result, Error>: {
    currentInput: Input | NoValueType;
    result: SafeEffectResult<Result, Error> | NoValueType;
    resultInput: Input | NoValueType;
    resultPending: boolean;
}

Value-type for the combined derived behavior produced by 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

Type declaration

  • currentInput: Input | NoValueType

    The current input (which might differ from the resultInput), or NO_VALUE, if no input was received yet

  • result: SafeEffectResult<Result, Error> | NoValueType

    The current effect-result, or NO_VALUE if no result was received yet, or the effect produced an error

  • resultInput: Input | NoValueType

    The input that produced the current effect-result, or NO_VALUE, if initial result or no result received yet

  • resultPending: boolean

    Indicates whether the effect is currently running. In case of a factory without trigger, this will be true whenever one or multiple of the following conditions are met: currentInput !== resultInput, or an invalidation event has been sent, or the effect has sent a result, but has not yet completed. In case of a factory with result-trigger, in addition to the previous criteria, a trigegr event must have been received.

Settings

Member Visibility

Theme

Generated using TypeDoc