Class Transition
publicA 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.
abort Transition public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:82
- 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.
catch (onRejection, label) Promise public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:54
- 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.
debugAbortStack
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:178
- 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.
debugCreationStack
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:170
- 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.
finally (callback, label) Promise public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:68
- 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.
followRedirects Promise public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:157
- 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 (method) Transition public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:102
- 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).
retry Transition public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:91
- 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.
then (onFulfilled, onRejected, label) Promise public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:37
- 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.
trigger (ignoreFailure, name) public
Defined in packages/@ember/-internals/routing/lib/system/transition.ts:123
- 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