@dwp/govuk-casa
Version:
A framework for building GOVUK Collect-And-Submit-Applications
35 lines (34 loc) • 1.33 kB
TypeScript
/**
* Generate a URL pointing at a particular waypoint.
*
* @memberof module:@dwp/govuk-casa
* @example
* // generates: /path/details?edit&editorigin=%2Fsomewhere%2Felse
* waypointUrl({
* mountUrl: "/path/",
* waypoint: "details",
* edit: true,
* editOrigin: "/somewhere/else",
* });
*
* @param {object} obj Options
* @param {string} [obj.waypoint] Waypoint. Default is `""`
* @param {string} [obj.mountUrl] Mount URL. Default is `"/"`
* @param {JourneyContext} [obj.journeyContext] JourneyContext
* @param {boolean} [obj.edit] Turn edit mode on or off. Default is `false`
* @param {string} [obj.editOrigin] Edit mode original URL
* @param {boolean} [obj.skipTo] Skip to this waypoint from the current one
* @param {string} [obj.routeName] Plan route name; next | prev. Default is
* `next`
* @returns {string} URL
*/
export default function waypointUrl({ waypoint, mountUrl, journeyContext, edit, editOrigin, skipTo, routeName, }?: {
waypoint?: string | undefined;
mountUrl?: string | undefined;
journeyContext?: import("./JourneyContext").default | undefined;
edit?: boolean | undefined;
editOrigin?: string | undefined;
skipTo?: boolean | undefined;
routeName?: string | undefined;
}): string;
export type JourneyContext = import("./index").JourneyContext;