Class Transition

public

A Transition is a thennable (a Promise-like object) that represents an attempt to transition to another route. It can be aborted, either explicitly via abort or by attempting another transition while a previous one is still underway. An aborted transition can also be retry()d later.

A Transition is not user-constructible; the only legal way to get one is in a Route hook or a RouterService.on() callback. However, you can import the type by using import type syntax with TypeScript or import() in JSDoc comments.

Show:

returns
Transition

this transition

Aborts the Transition. Note you can also implicitly abort a transition by initiating another transition while a previous one is underway.

onRejection
Function
label
String

optional string for labeling the promise. Useful for tooling.

returns
Promise

Forwards to the internal promise property which you can use in situations where you want to pass around a thennable, but not the Transition itself.

returns

string

In non-production builds, this function will return the stack that this Transition was aborted within (or undefined if the Transition has not been aborted yet). In production builds, this function will not be present.

returns

string

In non-production builds, this function will return the stack that this Transition was created within. In production builds, this function will not be present.

callback
Function
label
String

optional string for labeling the promise. Useful for tooling.

returns
Promise

Forwards to the internal promise property which you can use in situations where you want to pass around a thennable, but not the Transition itself.

returns
Promise

a promise that fulfills with the same value that the final redirecting transition fulfills with

Transitions are aborted and their promises rejected when redirects occur; this method returns a promise that will follow any redirects that occur and fulfill with the value fulfilled by any redirecting transitions that occur.

method
String

the type of URL-changing method to use at the end of a transition. Accepted values are 'replace', falsy values, or any other non-falsy value (which is interpreted as an updateURL transition).

returns
Transition

this transition

Sets the URL-changing method to be employed at the end of a successful transition. By default, a new Transition will just use updateURL, but passing 'replace' to this method will cause the URL to update using 'replaceWith' instead. Omitting a parameter will disable the URL change, allowing for transitions that don't update the URL at completion (this is also used for handleURL, since the URL has already changed before the transition took place).

returns
Transition

new transition

Retries a previously-aborted transition (making sure to abort the transition if it's still active). Returns a new transition that represents the new attempt to transition.

onFulfilled
Function
onRejected
Function
label
String

optional string for labeling the promise. Useful for tooling.

returns
Promise

A standard promise hook that resolves if the Transition succeeds and rejects if it fails/redirects/aborts.

Forwards to the internal promise property which you can use in situations where you want to pass around a thennable, but not the Transition itself.

ignoreFailure
Boolean

a boolean specifying whether unhandled events throw an error

name
String

the name of the event to fire

Fires an event on the current list of resolved/resolving handlers within this transition. Useful for firing events on route hierarchies that haven't fully been entered yet. Note: This method is also aliased as send