@uirouter/core
Version:
UI-Router Core: Framework agnostic, State-based routing for JavaScript Single Page Apps
119 lines • 4.81 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Rejection = exports.RejectType = void 0;
var common_1 = require("../common/common");
var strings_1 = require("../common/strings");
var hof_1 = require("../common/hof");
/** An enum for Transition Rejection reasons */
var RejectType;
(function (RejectType) {
/**
* A new transition superseded this one.
*
* While this transition was running, a new transition started.
* This transition is cancelled because it was superseded by new transition.
*/
RejectType[RejectType["SUPERSEDED"] = 2] = "SUPERSEDED";
/**
* The transition was aborted
*
* The transition was aborted by a hook which returned `false`
*/
RejectType[RejectType["ABORTED"] = 3] = "ABORTED";
/**
* The transition was invalid
*
* The transition was never started because it was invalid
*/
RejectType[RejectType["INVALID"] = 4] = "INVALID";
/**
* The transition was ignored
*
* The transition was ignored because it would have no effect.
*
* Either:
*
* - The transition is targeting the current state and parameter values
* - The transition is targeting the same state and parameter values as the currently running transition.
*/
RejectType[RejectType["IGNORED"] = 5] = "IGNORED";
/**
* The transition errored.
*
* This generally means a hook threw an error or returned a rejected promise
*/
RejectType[RejectType["ERROR"] = 6] = "ERROR";
})(RejectType || (RejectType = {}));
exports.RejectType = RejectType;
/** @internal */
var id = 0;
var Rejection = /** @class */ (function () {
function Rejection(type, message, detail) {
/** @internal */
this.$id = id++;
this.type = type;
this.message = message;
this.detail = detail;
}
/** Returns true if the obj is a rejected promise created from the `asPromise` factory */
Rejection.isRejectionPromise = function (obj) {
return obj && typeof obj.then === 'function' && hof_1.is(Rejection)(obj._transitionRejection);
};
/** Returns a Rejection due to transition superseded */
Rejection.superseded = function (detail, options) {
var message = 'The transition has been superseded by a different transition';
var rejection = new Rejection(RejectType.SUPERSEDED, message, detail);
if (options && options.redirected) {
rejection.redirected = true;
}
return rejection;
};
/** Returns a Rejection due to redirected transition */
Rejection.redirected = function (detail) {
return Rejection.superseded(detail, { redirected: true });
};
/** Returns a Rejection due to invalid transition */
Rejection.invalid = function (detail) {
var message = 'This transition is invalid';
return new Rejection(RejectType.INVALID, message, detail);
};
/** Returns a Rejection due to ignored transition */
Rejection.ignored = function (detail) {
var message = 'The transition was ignored';
return new Rejection(RejectType.IGNORED, message, detail);
};
/** Returns a Rejection due to aborted transition */
Rejection.aborted = function (detail) {
var message = 'The transition has been aborted';
return new Rejection(RejectType.ABORTED, message, detail);
};
/** Returns a Rejection due to aborted transition */
Rejection.errored = function (detail) {
var message = 'The transition errored';
return new Rejection(RejectType.ERROR, message, detail);
};
/**
* Returns a Rejection
*
* Normalizes a value as a Rejection.
* If the value is already a Rejection, returns it.
* Otherwise, wraps and returns the value as a Rejection (Rejection type: ERROR).
*
* @returns `detail` if it is already a `Rejection`, else returns an ERROR Rejection.
*/
Rejection.normalize = function (detail) {
return hof_1.is(Rejection)(detail) ? detail : Rejection.errored(detail);
};
Rejection.prototype.toString = function () {
var detailString = function (d) { return (d && d.toString !== Object.prototype.toString ? d.toString() : strings_1.stringify(d)); };
var detail = detailString(this.detail);
var _a = this, $id = _a.$id, type = _a.type, message = _a.message;
return "Transition Rejection($id: " + $id + " type: " + type + ", message: " + message + ", detail: " + detail + ")";
};
Rejection.prototype.toPromise = function () {
return common_1.extend(common_1.silentRejection(this), { _transitionRejection: this });
};
return Rejection;
}());
exports.Rejection = Rejection;
//# sourceMappingURL=rejectFactory.js.map