Перейти к основному содержимому

assertSagaSucceeded

@mineflow/client-react


@mineflow/client-react / assertSagaSucceeded

Function: assertSagaSucceeded()

function assertSagaSucceeded(status: object): object;

Defined in: client-react/src/hooks.ts:186

Превращает терминально-отказную сагу (failed/compensated) в брошенную SagaFailedError; успешную возвращает как есть. Вынесено отдельной чистой функцией, чтобы поведение покрывалось unit-тестом без рендера хука.

Parameters

ParameterTypeDescription
status{ sagaId: string; steps: object[]; }Финальный статус саги после поллинга.
status.sagaIdstringFormat: uuid Description UUID саги Example 11111111-1111-4111-8111-111111111111
status.stepsobject[]Description Хронология шагов саги в порядке возрастания времени

Returns

Тот же status, если сага успешна.

NameTypeDescriptionDefined in
sagaIdstringFormat: uuid Description UUID саги Example 11111111-1111-4111-8111-111111111111api-client/src/openapi.ts:7046
stepsobject[]Description Хронология шагов саги в порядке возрастания времениapi-client/src/openapi.ts:7048

Throws

SagaFailedError если сага завершилась откатом (failed/compensated).