Skip to content

ui-router-effect / errorRef

Function: errorRef() ​

ts
function errorRef(router): SubscriptionRef<Rejection | undefined>;

Defined in: ui-router-effect/src/transition-refs.ts:80

The failed-transition ref for a router — one per router instance, attached lazily, sharing pendingRef's onStart hook.

It holds the newest transition's failure as core's Rejection, and undefined otherwise. Only a RejectType.ERROR rejection, such as a resolve that throws, sets it; superseded, redirected, aborted and ignored transitions leave it undefined, as does a success. The next transition clears it as it starts, and a superseded transition that fails late never sets it. Kept out of RouteSnapshot.

Parameters ​

ParameterType
routerUIRouter

Returns ​

SubscriptionRef<Rejection | undefined>