Type alias EffectResultEvent<Input, Result, Error>

EffectResultEvent<Input, Result, Error>: {
    completed: boolean;
    result: SafeEffectResult<Result, Error>;
    resultInput: Input;
}

Value-type for result events produced by EffectSignals. In case the effect completes after one result, two reult events will be dispatched, one with completed false and one with completed true. This is to handle cases where the effect might send multiple results before completing. Thus, if an effect never completes, all result events will have completed false.

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

  • completed: boolean

    has the effect for the given resultInput completed

  • result: SafeEffectResult<Result, Error>

    the effect result

  • resultInput: Input

    the effect input that lead to the result

Settings

Member Visibility

Theme

Generated using TypeDoc