diff --git a/packages/docs/api/enums/ErrorTypes.md b/packages/docs/api/enums/ErrorTypes.md deleted file mode 100644 index 70a03ff2c..000000000 --- a/packages/docs/api/enums/ErrorTypes.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / ErrorTypes - -# Enumeration: ErrorTypes - -Flags so we can combine them when checking for multiple errors. This is the internal version of -[NavigationFailureType](NavigationFailureType.md). - -## Enumeration Members - -### MATCHER\_NOT\_FOUND - -• **MATCHER\_NOT\_FOUND** = ``1`` - -___ - -### NAVIGATION\_ABORTED - -• **NAVIGATION\_ABORTED** = ``4`` - -___ - -### NAVIGATION\_CANCELLED - -• **NAVIGATION\_CANCELLED** = ``8`` - -___ - -### NAVIGATION\_DUPLICATED - -• **NAVIGATION\_DUPLICATED** = ``16`` - -___ - -### NAVIGATION\_GUARD\_REDIRECT - -• **NAVIGATION\_GUARD\_REDIRECT** = ``2`` diff --git a/packages/docs/api/enums/NavigationFailureType.md b/packages/docs/api/enums/NavigationFailureType.md deleted file mode 100644 index e7ccd2416..000000000 --- a/packages/docs/api/enums/NavigationFailureType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationFailureType - -# Enumeration: NavigationFailureType - -Enumeration with all possible types for navigation failures. Can be passed to -[isNavigationFailure](../index.md#isNavigationFailure) to check for specific failures. - -## Enumeration Members - -### aborted - -• **aborted** = ``4`` - -An aborted navigation is a navigation that failed because a navigation -guard returned `false` or called `next(false)` - -___ - -### cancelled - -• **cancelled** = ``8`` - -A cancelled navigation is a navigation that failed because a more recent -navigation finished started (not necessarily finished). - -___ - -### duplicated - -• **duplicated** = ``16`` - -A duplicated navigation is a navigation that failed because it was -initiated while already being at the exact same location. diff --git a/packages/docs/api/index.md b/packages/docs/api/index.md deleted file mode 100644 index 3625e4fb3..000000000 --- a/packages/docs/api/index.md +++ /dev/null @@ -1,1004 +0,0 @@ ---- -editLink: false ---- - -API Documentation - -# API Documentation - -## Enumerations - -- [ErrorTypes](enums/ErrorTypes.md) -- [NavigationFailureType](enums/NavigationFailureType.md) - -## Interfaces - -- [HistoryState](interfaces/HistoryState.md) -- [LocationAsRelativeRaw](interfaces/LocationAsRelativeRaw.md) -- [MatcherLocation](interfaces/MatcherLocation.md) -- [MatcherLocationAsPath](interfaces/MatcherLocationAsPath.md) -- [NavigationFailure](interfaces/NavigationFailure.md) -- [NavigationGuard](interfaces/NavigationGuard.md) -- [NavigationGuardNext](interfaces/NavigationGuardNext.md) -- [NavigationGuardWithThis](interfaces/NavigationGuardWithThis.md) -- [NavigationHookAfter](interfaces/NavigationHookAfter.md) -- [NavigationRedirectError](interfaces/NavigationRedirectError.md) -- [RouteLocationAsPathGeneric](interfaces/RouteLocationAsPathGeneric.md) -- [RouteLocationAsPathTyped](interfaces/RouteLocationAsPathTyped.md) -- [RouteLocationAsRelativeGeneric](interfaces/RouteLocationAsRelativeGeneric.md) -- [RouteLocationAsRelativeTyped](interfaces/RouteLocationAsRelativeTyped.md) -- [RouteLocationGeneric](interfaces/RouteLocationGeneric.md) -- [RouteLocationMatched](interfaces/RouteLocationMatched.md) -- [RouteLocationNamedRaw](interfaces/RouteLocationNamedRaw.md) -- [RouteLocationNormalizedGeneric](interfaces/RouteLocationNormalizedGeneric.md) -- [RouteLocationNormalizedLoadedGeneric](interfaces/RouteLocationNormalizedLoadedGeneric.md) -- [RouteLocationNormalizedLoadedTyped](interfaces/RouteLocationNormalizedLoadedTyped.md) -- [RouteLocationNormalizedTyped](interfaces/RouteLocationNormalizedTyped.md) -- [RouteLocationOptions](interfaces/RouteLocationOptions.md) -- [RouteLocationPathRaw](interfaces/RouteLocationPathRaw.md) -- [RouteLocationResolvedGeneric](interfaces/RouteLocationResolvedGeneric.md) -- [RouteLocationResolvedTyped](interfaces/RouteLocationResolvedTyped.md) -- [RouteLocationTyped](interfaces/RouteLocationTyped.md) -- [RouteMeta](interfaces/RouteMeta.md) -- [RouteQueryAndHash](interfaces/RouteQueryAndHash.md) -- [RouteRecordInfo](interfaces/RouteRecordInfo.md) -- [RouteRecordMultipleViews](interfaces/RouteRecordMultipleViews.md) -- [RouteRecordMultipleViewsWithChildren](interfaces/RouteRecordMultipleViewsWithChildren.md) -- [RouteRecordNormalized](interfaces/RouteRecordNormalized.md) -- [RouteRecordRedirect](interfaces/RouteRecordRedirect.md) -- [RouteRecordSingleView](interfaces/RouteRecordSingleView.md) -- [RouteRecordSingleViewWithChildren](interfaces/RouteRecordSingleViewWithChildren.md) -- [Router](interfaces/Router.md) -- [RouterHistory](interfaces/RouterHistory.md) -- [RouterLinkProps](interfaces/RouterLinkProps.md) -- [RouterMatcher](interfaces/RouterMatcher.md) -- [RouterOptions](interfaces/RouterOptions.md) -- [RouterScrollBehavior](interfaces/RouterScrollBehavior.md) -- [RouterViewProps](interfaces/RouterViewProps.md) -- [TypesConfig](interfaces/TypesConfig.md) -- [UseLinkOptions](interfaces/UseLinkOptions.md) -- [UseLinkReturn](interfaces/UseLinkReturn.md) -- [\_PathParserOptions](interfaces/PathParserOptions.md) -- [\_RouteLocationBase](interfaces/RouteLocationBase.md) -- [\_RouteRecordBase](interfaces/RouteRecordBase.md) -- [\_RouterLinkI](interfaces/RouterLinkI.md) - -## Type Aliases - -### LocationQuery - -Ƭ **LocationQuery**: `Record`\<`string`, [`LocationQueryValue`](index.md#LocationQueryValue) \| [`LocationQueryValue`](index.md#LocationQueryValue)[]\> - -Normalized query object that appears in [RouteLocationNormalized](index.md#RouteLocationNormalized) - -___ - -### LocationQueryRaw - -Ƭ **LocationQueryRaw**: `Record`\<`string` \| `number`, [`LocationQueryValueRaw`](index.md#LocationQueryValueRaw) \| [`LocationQueryValueRaw`](index.md#LocationQueryValueRaw)[]\> - -Loose [LocationQuery](index.md#LocationQuery) object that can be passed to functions like -[Router.push](interfaces/Router.md#push) and [Router.replace](interfaces/Router.md#replace) or anywhere when creating a -[RouteLocationRaw](index.md#RouteLocationRaw) - -___ - -### LocationQueryValue - -Ƭ **LocationQueryValue**: `string` \| ``null`` - -Possible values in normalized [LocationQuery](index.md#LocationQuery). `null` renders the query -param but without an `=`. - -**`Example`** - -``` -?isNull&isEmpty=&other=other -gives -`{ isNull: null, isEmpty: '', other: 'other' }`. -``` - -___ - -### LocationQueryValueRaw - -Ƭ **LocationQueryValueRaw**: [`LocationQueryValue`](index.md#LocationQueryValue) \| `number` \| `undefined` - -Possible values when defining a query. - -___ - -### NavigationGuardNextCallback - -Ƭ **NavigationGuardNextCallback**: (`vm`: `ComponentPublicInstance`) => `unknown` - -Callback that can be passed to `next()` in `beforeRouteEnter()` guards. - -#### Type declaration - -▸ (`vm`): `unknown` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `vm` | `ComponentPublicInstance` | - -##### Returns - -`unknown` - -___ - -### NavigationGuardReturn - -Ƭ **NavigationGuardReturn**: `void` \| `Error` \| `boolean` \| [`RouteLocationRaw`](index.md#RouteLocationRaw) - -Return types for a Navigation Guard. Based on `TypesConfig` - -**`See`** - -[TypesConfig](interfaces/TypesConfig.md) - -___ - -### ParamValue - -Ƭ **ParamValue**\<`isRaw`\>: ``true`` extends `isRaw` ? `string` \| `number` : `string` - -Utility type for raw and non raw params like :id - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `isRaw` | extends `boolean` | - -___ - -### ParamValueOneOrMore - -Ƭ **ParamValueOneOrMore**\<`isRaw`\>: [[`ParamValue`](index.md#ParamValue)\<`isRaw`\>, ...ParamValue\[]] - -Utility type for raw and non raw params like :id+ - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `isRaw` | extends `boolean` | - -___ - -### ParamValueZeroOrMore - -Ƭ **ParamValueZeroOrMore**\<`isRaw`\>: ``true`` extends `isRaw` ? [`ParamValue`](index.md#ParamValue)\<`isRaw`\>[] \| `undefined` \| ``null`` : [`ParamValue`](index.md#ParamValue)\<`isRaw`\>[] \| `undefined` - -Utility type for raw and non raw params like :id* - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `isRaw` | extends `boolean` | - -___ - -### ParamValueZeroOrOne - -Ƭ **ParamValueZeroOrOne**\<`isRaw`\>: ``true`` extends `isRaw` ? `string` \| `number` \| ``null`` \| `undefined` : `string` - -Utility type for raw and non raw params like :id? - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `isRaw` | extends `boolean` | - -___ - -### PathParserOptions - -Ƭ **PathParserOptions**: `Pick`\<[`_PathParserOptions`](interfaces/PathParserOptions.md), ``"end"`` \| ``"sensitive"`` \| ``"strict"``\> - -___ - -### RouteComponent - -Ƭ **RouteComponent**: `Component` \| `DefineComponent` - -Allowed Component in [RouteLocationMatched](interfaces/RouteLocationMatched.md) - -___ - -### RouteLocation - -Ƭ **RouteLocation**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationGeneric`](interfaces/RouteLocationGeneric.md) : [`RouteLocationTypedList`](index.md#RouteLocationTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -[RouteLocationRaw](index.md#RouteLocationRaw) resolved using the matcher - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationAsPath - -Ƭ **RouteLocationAsPath**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationAsPathGeneric`](interfaces/RouteLocationAsPathGeneric.md) : [`RouteLocationAsPathTypedList`](index.md#RouteLocationAsPathTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -Route location as an object with a `path` property. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationAsPathTypedList - -Ƭ **RouteLocationAsPathTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationAsPathTyped\ } - -List of all possible [RouteLocationAsPath](index.md#RouteLocationAsPath) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteLocationAsRelative - -Ƭ **RouteLocationAsRelative**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationAsRelativeGeneric`](interfaces/RouteLocationAsRelativeGeneric.md) : [`RouteLocationAsRelativeTypedList`](index.md#RouteLocationAsRelativeTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -Route location relative to the current location. It accepts other properties than `path` like `params`, `query` and -`hash` to conveniently change them. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationAsRelativeTypedList - -Ƭ **RouteLocationAsRelativeTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationAsRelativeTyped\ } - -List of all possible [RouteLocationAsRelative](index.md#RouteLocationAsRelative) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteLocationAsString - -Ƭ **RouteLocationAsString**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? `string` : `_LiteralUnion`\<[`RouteLocationAsStringTypedList`](index.md#RouteLocationAsStringTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`], `string`\> - -Same as [RouteLocationAsPath](index.md#RouteLocationAsPath) but as a string literal. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationAsStringTyped - -Ƭ **RouteLocationAsStringTyped**\<`RouteMap`, `Name`\>: `RouteMap`[`Name`][``"path"``] - -Helper to generate a type safe version of the [RouteLocationAsString](index.md#RouteLocationAsString) type. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` = keyof `RouteMap` | - -___ - -### RouteLocationAsStringTypedList - -Ƭ **RouteLocationAsStringTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationAsStringTyped\ } - -List of all possible [RouteLocationAsString](index.md#RouteLocationAsString) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteLocationNormalized - -Ƭ **RouteLocationNormalized**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationNormalizedGeneric`](interfaces/RouteLocationNormalizedGeneric.md) : [`RouteLocationNormalizedTypedList`](index.md#RouteLocationNormalizedTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -Similar to [RouteLocation](index.md#RouteLocation) but its -[`matched` property](interfaces/RouteLocationNormalizedTyped.md#matched) cannot contain redirect records - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationNormalizedLoaded - -Ƭ **RouteLocationNormalizedLoaded**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationNormalizedLoadedGeneric`](interfaces/RouteLocationNormalizedLoadedGeneric.md) : [`RouteLocationNormalizedLoadedTypedList`](index.md#RouteLocationNormalizedLoadedTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -Similar to [RouteLocationNormalized](index.md#RouteLocationNormalized) but its `components` do not contain any function to lazy load components. -In other words, it's ready to be rendered by ``. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationNormalizedLoadedTypedList - -Ƭ **RouteLocationNormalizedLoadedTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationNormalizedLoadedTyped\ } - -List of all possible [RouteLocationNormalizedLoaded](index.md#RouteLocationNormalizedLoaded) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteLocationNormalizedTypedList - -Ƭ **RouteLocationNormalizedTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationNormalizedTyped\ } - -List of all possible [RouteLocationNormalized](index.md#RouteLocationNormalized) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteLocationRaw - -Ƭ **RouteLocationRaw**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationAsString`](index.md#RouteLocationAsString) \| [`RouteLocationAsRelativeGeneric`](interfaces/RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](interfaces/RouteLocationAsPathGeneric.md) : `_LiteralUnion`\<[`RouteLocationAsStringTypedList`](index.md#RouteLocationAsStringTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`], `string`\> \| [`RouteLocationAsRelativeTypedList`](index.md#RouteLocationAsRelativeTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] \| [`RouteLocationAsPathTypedList`](index.md#RouteLocationAsPathTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -Route location that can be passed to `router.push()` and other user-facing APIs. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationResolved - -Ƭ **RouteLocationResolved**\<`Name`\>: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteLocationResolvedGeneric`](interfaces/RouteLocationResolvedGeneric.md) : [`RouteLocationResolvedTypedList`](index.md#RouteLocationResolvedTypedList)\<[`RouteMap`](index.md#RouteMap)\>[`Name`] - -Route location resolved with [`router.resolve()`](interfaces/Router.md). - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteLocationResolvedTypedList - -Ƭ **RouteLocationResolvedTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationResolvedTyped\ } - -List of all possible [RouteLocationResolved](index.md#RouteLocationResolved) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteLocationTypedList - -Ƭ **RouteLocationTypedList**\<`RouteMap`\>: \{ [N in keyof RouteMap]: RouteLocationTyped\ } - -List of all possible [RouteLocation](index.md#RouteLocation) indexed by the route name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](index.md#RouteMapGeneric) = [`RouteMapGeneric`](index.md#RouteMapGeneric) | - -___ - -### RouteMap - -Ƭ **RouteMap**: [`TypesConfig`](interfaces/TypesConfig.md) extends `Record`\<``"RouteNamedMap"``, infer RouteNamedMap\> ? `RouteNamedMap` : [`RouteMapGeneric`](index.md#RouteMapGeneric) - -Convenience type to get the typed RouteMap or a generic one if not provided. It is extracted from the [TypesConfig](interfaces/TypesConfig.md) if it exists, it becomes [RouteMapGeneric](index.md#RouteMapGeneric) otherwise. - -___ - -### RouteMapGeneric - -Ƭ **RouteMapGeneric**: `Record`\<`string` \| `symbol`, [`RouteRecordInfo`](interfaces/RouteRecordInfo.md)\> - -Generic version of the `RouteMap`. - -___ - -### RouteParamValue - -Ƭ **RouteParamValue**: `string` - -___ - -### RouteParamValueRaw - -Ƭ **RouteParamValueRaw**: [`RouteParamValue`](index.md#RouteParamValue) \| `number` \| ``null`` \| `undefined` - -___ - -### RouteParams - -Ƭ **RouteParams**\<`Name`\>: [`RouteMap`](index.md#RouteMap)[`Name`][``"params"``] - -Generate a type safe params for a route location. Requires the name of the route to be passed as a generic. - -**`See`** - -[RouteParamsGeneric](index.md#RouteParamsGeneric) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteParamsGeneric - -Ƭ **RouteParamsGeneric**: `Record`\<`string`, [`RouteParamValue`](index.md#RouteParamValue) \| [`RouteParamValue`](index.md#RouteParamValue)[]\> - -___ - -### RouteParamsRaw - -Ƭ **RouteParamsRaw**\<`Name`\>: [`RouteMap`](index.md#RouteMap)[`Name`][``"paramsRaw"``] - -Generate a type safe raw params for a route location. Requires the name of the route to be passed as a generic. - -**`See`** - -[RouteParamsRaw](index.md#RouteParamsRaw) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -___ - -### RouteParamsRawGeneric - -Ƭ **RouteParamsRawGeneric**: `Record`\<`string`, [`RouteParamValueRaw`](index.md#RouteParamValueRaw) \| `Exclude`\<[`RouteParamValueRaw`](index.md#RouteParamValueRaw), ``null`` \| `undefined`\>[]\> - -___ - -### RouteRecord - -Ƭ **RouteRecord**: [`RouteRecordNormalized`](interfaces/RouteRecordNormalized.md) - -Normalized version of a [route record](index.md#RouteRecord). - -___ - -### RouteRecordName - -Ƭ **RouteRecordName**: [`RouteMapGeneric`](index.md#RouteMapGeneric) extends [`RouteMap`](index.md#RouteMap) ? [`RouteRecordNameGeneric`](index.md#RouteRecordNameGeneric) : keyof [`RouteMap`](index.md#RouteMap) - -Possible values for a route record **after normalization** - -NOTE: since `RouteRecordName` is a type, it evaluates too early and it's often the generic version [RouteRecordNameGeneric](index.md#RouteRecordNameGeneric). If you need a typed version of all of the names of routes, use [`keyof RouteMap`](index.md#RouteMap) - -___ - -### RouteRecordNameGeneric - -Ƭ **RouteRecordNameGeneric**: `string` \| `symbol` \| `undefined` - -Generic version of [RouteRecordName](index.md#RouteRecordName). - -___ - -### RouteRecordRaw - -Ƭ **RouteRecordRaw**: [`RouteRecordSingleView`](interfaces/RouteRecordSingleView.md) \| [`RouteRecordSingleViewWithChildren`](interfaces/RouteRecordSingleViewWithChildren.md) \| [`RouteRecordMultipleViews`](interfaces/RouteRecordMultipleViews.md) \| [`RouteRecordMultipleViewsWithChildren`](interfaces/RouteRecordMultipleViewsWithChildren.md) \| [`RouteRecordRedirect`](interfaces/RouteRecordRedirect.md) - -___ - -### RouteRecordRedirectOption - -Ƭ **RouteRecordRedirectOption**: [`RouteLocationRaw`](index.md#RouteLocationRaw) \| (`to`: [`RouteLocation`](index.md#RouteLocation)) => [`RouteLocationRaw`](index.md#RouteLocationRaw) - -___ - -### \_Awaitable - -Ƭ **\_Awaitable**\<`T`\>: `T` \| `PromiseLike`\<`T`\> - -Maybe a promise maybe not - -#### Type parameters - -| Name | -| :------ | -| `T` | - -___ - -### \_RouteRecordProps - -Ƭ **\_RouteRecordProps**\<`Name`\>: `boolean` \| `Record`\<`string`, `any`\> \| (`to`: [`RouteLocationNormalized`](index.md#RouteLocationNormalized)\<`Name`\>) => `Record`\<`string`, `any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](index.md#RouteMap) = keyof [`RouteMap`](index.md#RouteMap) | - -## Variables - -### RouterLink - -• `Const` **RouterLink**: [`_RouterLinkI`](interfaces/RouterLinkI.md) - -Component to render a link that triggers a navigation on click. - -___ - -### RouterView - -• `Const` **RouterView**: () => \{ `$props`: `AllowedComponentProps` & `ComponentCustomProps` & `VNodeProps` & [`RouterViewProps`](interfaces/RouterViewProps.md) ; `$slots`: \{ `default?`: (`__namedParameters`: \{ `Component`: `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\> ; `route`: [`RouteLocationNormalizedLoadedGeneric`](interfaces/RouteLocationNormalizedLoadedGeneric.md) }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\>[] } } - -Component to display the current route the user is at. - -#### Type declaration - -• **new RouterView**(): `Object` - -Component to display the current route the user is at. - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `$props` | `AllowedComponentProps` & `ComponentCustomProps` & `VNodeProps` & [`RouterViewProps`](interfaces/RouterViewProps.md) | -| `$slots` | \{ `default?`: (`__namedParameters`: \{ `Component`: `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\> ; `route`: [`RouteLocationNormalizedLoadedGeneric`](interfaces/RouteLocationNormalizedLoadedGeneric.md) }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\>[] } | -| `$slots.default?` | (`__namedParameters`: \{ `Component`: `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\> ; `route`: [`RouteLocationNormalizedLoadedGeneric`](interfaces/RouteLocationNormalizedLoadedGeneric.md) }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\>[] | - -___ - -### START\_LOCATION - -• `Const` **START\_LOCATION**: [`RouteLocationNormalizedLoaded`](index.md#RouteLocationNormalizedLoaded) - -Initial route location where the router is. Can be used in navigation guards -to differentiate the initial navigation. - -**`Example`** - -```js -import { START_LOCATION } from 'vue-router' - -router.beforeEach((to, from) => { - if (from === START_LOCATION) { - // initial navigation - } -}) -``` - -___ - -### matchedRouteKey - -• `Const` **matchedRouteKey**: `InjectionKey`\<`ComputedRef`\<`undefined` \| [`RouteRecordNormalized`](interfaces/RouteRecordNormalized.md)\>\> - -RouteRecord being rendered by the closest ancestor Router View. Used for -`onBeforeRouteUpdate` and `onBeforeRouteLeave`. rvlm stands for Router View -Location Matched - -___ - -### routeLocationKey - -• `Const` **routeLocationKey**: `InjectionKey`\<[`RouteLocationNormalizedLoadedGeneric`](interfaces/RouteLocationNormalizedLoadedGeneric.md)\> - -Allows overriding the current route returned by `useRoute` in tests. rl -stands for route location - -___ - -### routerKey - -• `Const` **routerKey**: `InjectionKey`\<[`Router`](interfaces/Router.md)\> - -Allows overriding the router instance returned by `useRouter` in tests. r -stands for router - -___ - -### routerViewLocationKey - -• `Const` **routerViewLocationKey**: `InjectionKey`\<`Ref`\<[`RouteLocationNormalizedLoadedGeneric`](interfaces/RouteLocationNormalizedLoadedGeneric.md)\>\> - -Allows overriding the current route used by router-view. Internally this is -used when the `route` prop is passed. - -___ - -### viewDepthKey - -• `Const` **viewDepthKey**: `InjectionKey`\<`number` \| `Ref`\<`number`\>\> - -Allows overriding the router view depth to control which component in -`matched` is rendered. rvd stands for Router View Depth - -## Functions - -### createMemoryHistory - -▸ **createMemoryHistory**(`base?`): [`RouterHistory`](interfaces/RouterHistory.md) - -Creates an in-memory based history. The main purpose of this history is to handle SSR. It starts in a special location that is nowhere. -It's up to the user to replace that location with the starter location by either calling `router.push` or `router.replace`. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `base` | `string` | `''` | Base applied to all urls, defaults to '/' | - -#### Returns - -[`RouterHistory`](interfaces/RouterHistory.md) - -a history object that can be passed to the router constructor - -___ - -### createRouter - -▸ **createRouter**(`options`): [`Router`](interfaces/Router.md) - -Creates a Router instance that can be used by a Vue app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`RouterOptions`](interfaces/RouterOptions.md) | [RouterOptions](interfaces/RouterOptions.md) | - -#### Returns - -[`Router`](interfaces/Router.md) - -___ - -### createRouterMatcher - -▸ **createRouterMatcher**(`routes`, `globalOptions`): [`RouterMatcher`](interfaces/RouterMatcher.md) - -Creates a Router Matcher. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `routes` | readonly [`RouteRecordRaw`](index.md#RouteRecordRaw)[] | array of initial routes | -| `globalOptions` | [`PathParserOptions`](index.md#PathParserOptions) | global route options | - -#### Returns - -[`RouterMatcher`](interfaces/RouterMatcher.md) - -___ - -### createWebHashHistory - -▸ **createWebHashHistory**(`base?`): [`RouterHistory`](interfaces/RouterHistory.md) - -Creates a hash history. Useful for web applications with no host (e.g. `file://`) or when configuring a server to -handle any URL is not possible. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `base?` | `string` | optional base to provide. Defaults to `location.pathname + location.search` If there is a `` tag in the `head`, its value will be ignored in favor of this parameter **but note it affects all the history.pushState() calls**, meaning that if you use a `` tag, it's `href` value **has to match this parameter** (ignoring anything after the `#`). | - -#### Returns - -[`RouterHistory`](interfaces/RouterHistory.md) - -**`Example`** - -```js -// at https://example.com/folder -createWebHashHistory() // gives a url of `https://example.com/folder#` -createWebHashHistory('/folder/') // gives a url of `https://example.com/folder/#` -// if the `#` is provided in the base, it won't be added by `createWebHashHistory` -createWebHashHistory('/folder/#/app/') // gives a url of `https://example.com/folder/#/app/` -// you should avoid doing this because it changes the original url and breaks copying urls -createWebHashHistory('/other-folder/') // gives a url of `https://example.com/other-folder/#` - -// at file:///usr/etc/folder/index.html -// for locations with no `host`, the base is ignored -createWebHashHistory('/iAmIgnored') // gives a url of `file:///usr/etc/folder/index.html#` -``` - -___ - -### createWebHistory - -▸ **createWebHistory**(`base?`): [`RouterHistory`](interfaces/RouterHistory.md) - -Creates an HTML5 history. Most common history for single page applications. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `string` | - -#### Returns - -[`RouterHistory`](interfaces/RouterHistory.md) - -___ - -### isNavigationFailure - -▸ **isNavigationFailure**(`error`, `type?`): error is NavigationRedirectError - -Check if an object is a [NavigationFailure](interfaces/NavigationFailure.md). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `error` | `any` | possible [NavigationFailure](interfaces/NavigationFailure.md) | -| `type?` | [`NAVIGATION_GUARD_REDIRECT`](enums/ErrorTypes.md#NAVIGATION_GUARD_REDIRECT) | optional types to check for | - -#### Returns - -error is NavigationRedirectError - -**`Example`** - -```js -import { isNavigationFailure, NavigationFailureType } from 'vue-router' - -router.afterEach((to, from, failure) => { - // Any kind of navigation failure - if (isNavigationFailure(failure)) { - // ... - } - // Only duplicated navigations - if (isNavigationFailure(failure, NavigationFailureType.duplicated)) { - // ... - } - // Aborted or canceled navigations - if (isNavigationFailure(failure, NavigationFailureType.aborted | NavigationFailureType.canceled)) { - // ... - } -}) -``` - -▸ **isNavigationFailure**(`error`, `type?`): error is NavigationFailure - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `any` | -| `type?` | [`ErrorTypes`](enums/ErrorTypes.md) \| [`NavigationFailureType`](enums/NavigationFailureType.md) | - -#### Returns - -error is NavigationFailure - -___ - -### loadRouteLocation - -▸ **loadRouteLocation**(`route`): `Promise`\<[`RouteLocationNormalizedLoaded`](index.md#RouteLocationNormalizedLoaded)\> - -Ensures a route is loaded, so it can be passed as o prop to ``. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `route` | [`RouteLocationNormalizedGeneric`](interfaces/RouteLocationNormalizedGeneric.md) \| [`RouteLocationGeneric`](interfaces/RouteLocationGeneric.md) | resolved route to load | - -#### Returns - -`Promise`\<[`RouteLocationNormalizedLoaded`](index.md#RouteLocationNormalizedLoaded)\> - -___ - -### onBeforeRouteLeave - -▸ **onBeforeRouteLeave**(`leaveGuard`): `void` - -Add a navigation guard that triggers whenever the component for the current -location is about to be left. Similar to beforeRouteLeave but can be -used in any component. The guard is removed when the component is unmounted. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `leaveGuard` | [`NavigationGuard`](interfaces/NavigationGuard.md) | [NavigationGuard](interfaces/NavigationGuard.md) | - -#### Returns - -`void` - -___ - -### onBeforeRouteUpdate - -▸ **onBeforeRouteUpdate**(`updateGuard`): `void` - -Add a navigation guard that triggers whenever the current location is about -to be updated. Similar to beforeRouteUpdate but can be used in any -component. The guard is removed when the component is unmounted. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `updateGuard` | [`NavigationGuard`](interfaces/NavigationGuard.md) | [NavigationGuard](interfaces/NavigationGuard.md) | - -#### Returns - -`void` - -___ - -### parseQuery - -▸ **parseQuery**(`search`): [`LocationQuery`](index.md#LocationQuery) - -Transforms a queryString into a [LocationQuery](index.md#LocationQuery) object. Accept both, a -version with the leading `?` and without Should work as URLSearchParams - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `search` | `string` | search string to parse | - -#### Returns - -[`LocationQuery`](index.md#LocationQuery) - -a query object - -___ - -### stringifyQuery - -▸ **stringifyQuery**(`query`): `string` - -Stringifies a [LocationQueryRaw](index.md#LocationQueryRaw) object. Like `URLSearchParams`, it -doesn't prepend a `?` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `query` | [`LocationQueryRaw`](index.md#LocationQueryRaw) | query object to stringify | - -#### Returns - -`string` - -string version of the query without the leading `?` - -___ - -### useLink - -▸ **useLink**\<`Name`\>(`props`): [`UseLinkReturn`](interfaces/UseLinkReturn.md)\<`Name`\> - -Returns the internal behavior of a [RouterLink](index.md#RouterLink) without the rendering part. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends `string` \| `symbol` = `string` \| `symbol` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `props` | [`UseLinkOptions`](interfaces/UseLinkOptions.md)\<`Name`\> | a `to` location and an optional `replace` flag | - -#### Returns - -[`UseLinkReturn`](interfaces/UseLinkReturn.md)\<`Name`\> - -___ - -### useRoute - -▸ **useRoute**\<`Name`\>(`_name?`): [`RouteLocationNormalizedLoaded`](index.md#RouteLocationNormalizedLoaded)\<`Name`\> - -Returns the current route location. Equivalent to using `$route` inside -templates. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends `string` \| `symbol` = `string` \| `symbol` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_name?` | `Name` | - -#### Returns - -[`RouteLocationNormalizedLoaded`](index.md#RouteLocationNormalizedLoaded)\<`Name`\> - -___ - -### useRouter - -▸ **useRouter**(): [`Router`](interfaces/Router.md) - -Returns the router instance. Equivalent to using `$router` inside -templates. - -#### Returns - -[`Router`](interfaces/Router.md) diff --git a/packages/docs/api/interfaces/HistoryState.md b/packages/docs/api/interfaces/HistoryState.md deleted file mode 100644 index ab0ffc718..000000000 --- a/packages/docs/api/interfaces/HistoryState.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / HistoryState - -# Interface: HistoryState - -Allowed HTML history.state - -## Indexable - -▪ [x: `number`]: `HistoryStateValue` diff --git a/packages/docs/api/interfaces/LocationAsRelativeRaw.md b/packages/docs/api/interfaces/LocationAsRelativeRaw.md deleted file mode 100644 index 41bdde049..000000000 --- a/packages/docs/api/interfaces/LocationAsRelativeRaw.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / LocationAsRelativeRaw - -# Interface: LocationAsRelativeRaw - -## Hierarchy - -- **`LocationAsRelativeRaw`** - - ↳ [`RouteLocationNamedRaw`](RouteLocationNamedRaw.md) - -## Properties - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -___ - -### params - -• `Optional` **params**: [`RouteParamsRawGeneric`](../index.md#RouteParamsRawGeneric) - -___ - -### path - -• `Optional` **path**: `undefined` - -Ignored path property since we are dealing with a relative location. Only `undefined` is allowed. diff --git a/packages/docs/api/interfaces/MatcherLocation.md b/packages/docs/api/interfaces/MatcherLocation.md deleted file mode 100644 index 6e6ed70aa..000000000 --- a/packages/docs/api/interfaces/MatcherLocation.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / MatcherLocation - -# Interface: MatcherLocation - -Normalized/resolved Route location that returned by the matcher. - -## Properties - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecord](../index.md#RouteRecord) containing components as they were -passed when adding records. It can also contain redirect records. This -can't be used directly - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -___ - -### name - -• **name**: ``null`` \| [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name of the matched record - -___ - -### params - -• **params**: [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) - -Object of decoded params extracted from the `path`. - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. diff --git a/packages/docs/api/interfaces/MatcherLocationAsPath.md b/packages/docs/api/interfaces/MatcherLocationAsPath.md deleted file mode 100644 index f2a039c2b..000000000 --- a/packages/docs/api/interfaces/MatcherLocationAsPath.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / MatcherLocationAsPath - -# Interface: MatcherLocationAsPath - -## Hierarchy - -- **`MatcherLocationAsPath`** - - ↳ [`RouteLocationPathRaw`](RouteLocationPathRaw.md) - -## Properties - -### path - -• **path**: `string` diff --git a/packages/docs/api/interfaces/NavigationFailure.md b/packages/docs/api/interfaces/NavigationFailure.md deleted file mode 100644 index 2c15e371c..000000000 --- a/packages/docs/api/interfaces/NavigationFailure.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationFailure - -# Interface: NavigationFailure - -Extended Error that contains extra information regarding a failed navigation. - -## Hierarchy - -- `Error` - - ↳ **`NavigationFailure`** - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -___ - -### from - -• **from**: [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) - -Route location we were navigating from - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -___ - -### to - -• **to**: [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) - -Route location we were navigating to - -___ - -### type - -• **type**: [`NAVIGATION_ABORTED`](../enums/ErrorTypes.md#NAVIGATION_ABORTED) \| [`NAVIGATION_CANCELLED`](../enums/ErrorTypes.md#NAVIGATION_CANCELLED) \| [`NAVIGATION_DUPLICATED`](../enums/ErrorTypes.md#NAVIGATION_DUPLICATED) - -Type of the navigation. One of [NavigationFailureType](../enums/NavigationFailureType.md) diff --git a/packages/docs/api/interfaces/NavigationGuard.md b/packages/docs/api/interfaces/NavigationGuard.md deleted file mode 100644 index 9a769972f..000000000 --- a/packages/docs/api/interfaces/NavigationGuard.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationGuard - -# Interface: NavigationGuard - -Navigation Guard. - -## Callable - -### NavigationGuard - -▸ **NavigationGuard**(`to`, `from`, `next`): [`_Awaitable`](../index.md#_Awaitable)\<[`NavigationGuardReturn`](../index.md#NavigationGuardReturn)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `to` | [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) | -| `from` | [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) | -| `next` | [`NavigationGuardNext`](NavigationGuardNext.md) | - -#### Returns - -[`_Awaitable`](../index.md#_Awaitable)\<[`NavigationGuardReturn`](../index.md#NavigationGuardReturn)\> diff --git a/packages/docs/api/interfaces/NavigationGuardNext.md b/packages/docs/api/interfaces/NavigationGuardNext.md deleted file mode 100644 index 6e45e228b..000000000 --- a/packages/docs/api/interfaces/NavigationGuardNext.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationGuardNext - -# Interface: NavigationGuardNext - -`next()` callback passed to navigation guards. - -## Callable - -### NavigationGuardNext - -▸ **NavigationGuardNext**(): `void` - -#### Returns - -`void` - -### NavigationGuardNext - -▸ **NavigationGuardNext**(`error`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | - -#### Returns - -`void` - -### NavigationGuardNext - -▸ **NavigationGuardNext**(`location`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `location` | `string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) | - -#### Returns - -`void` - -### NavigationGuardNext - -▸ **NavigationGuardNext**(`valid`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `valid` | `undefined` \| `boolean` | - -#### Returns - -`void` - -### NavigationGuardNext - -▸ **NavigationGuardNext**(`cb`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cb` | [`NavigationGuardNextCallback`](../index.md#NavigationGuardNextCallback) | - -#### Returns - -`void` diff --git a/packages/docs/api/interfaces/NavigationGuardWithThis.md b/packages/docs/api/interfaces/NavigationGuardWithThis.md deleted file mode 100644 index 9c527cc60..000000000 --- a/packages/docs/api/interfaces/NavigationGuardWithThis.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationGuardWithThis - -# Interface: NavigationGuardWithThis\ - -Navigation Guard with a type parameter for `this`. - -**`See`** - -[TypesConfig](TypesConfig.md) - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Callable - -### NavigationGuardWithThis - -▸ **NavigationGuardWithThis**(`this`, `to`, `from`, `next`): [`_Awaitable`](../index.md#_Awaitable)\<[`NavigationGuardReturn`](../index.md#NavigationGuardReturn)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `this` | `T` | -| `to` | [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) | -| `from` | [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) | -| `next` | [`NavigationGuardNext`](NavigationGuardNext.md) | - -#### Returns - -[`_Awaitable`](../index.md#_Awaitable)\<[`NavigationGuardReturn`](../index.md#NavigationGuardReturn)\> diff --git a/packages/docs/api/interfaces/NavigationHookAfter.md b/packages/docs/api/interfaces/NavigationHookAfter.md deleted file mode 100644 index a797b51eb..000000000 --- a/packages/docs/api/interfaces/NavigationHookAfter.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationHookAfter - -# Interface: NavigationHookAfter - -Navigation hook triggered after a navigation is settled. - -## Callable - -### NavigationHookAfter - -▸ **NavigationHookAfter**(`to`, `from`, `failure?`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `to` | [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) | -| `from` | [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) | -| `failure?` | `void` \| [`NavigationFailure`](NavigationFailure.md) | - -#### Returns - -`unknown` diff --git a/packages/docs/api/interfaces/NavigationRedirectError.md b/packages/docs/api/interfaces/NavigationRedirectError.md deleted file mode 100644 index b0403d3b9..000000000 --- a/packages/docs/api/interfaces/NavigationRedirectError.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / NavigationRedirectError - -# Interface: NavigationRedirectError - -Internal error used to detect a redirection. - -## Hierarchy - -- `Omit`\<[`NavigationFailure`](NavigationFailure.md), ``"to"`` \| ``"type"``\> - - ↳ **`NavigationRedirectError`** - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Omit.cause - -___ - -### from - -• **from**: [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) - -Route location we were navigating from - -#### Inherited from - -Omit.from - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Omit.message - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Omit.name - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Omit.stack - -___ - -### to - -• **to**: `string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) - -___ - -### type - -• **type**: [`NAVIGATION_GUARD_REDIRECT`](../enums/ErrorTypes.md#NAVIGATION_GUARD_REDIRECT) diff --git a/packages/docs/api/interfaces/PathParserOptions.md b/packages/docs/api/interfaces/PathParserOptions.md deleted file mode 100644 index 51c2563e5..000000000 --- a/packages/docs/api/interfaces/PathParserOptions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / \_PathParserOptions - -# Interface: \_PathParserOptions - -## Properties - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -___ - -### start - -• `Optional` **start**: `boolean` - -Should the RegExp match from the beginning by prepending a `^` to it. - -**`Default Value`** - -`true` - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` diff --git a/packages/docs/api/interfaces/RouteLocationAsPathGeneric.md b/packages/docs/api/interfaces/RouteLocationAsPathGeneric.md deleted file mode 100644 index 8e7980386..000000000 --- a/packages/docs/api/interfaces/RouteLocationAsPathGeneric.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationAsPathGeneric - -# Interface: RouteLocationAsPathGeneric - -Generic version of [RouteLocationAsPath](../index.md#RouteLocationAsPath). It is used when no [RouteMap](../index.md#RouteMap) is provided. - -## Hierarchy - -- [`RouteQueryAndHash`](RouteQueryAndHash.md) - -- [`RouteLocationOptions`](RouteLocationOptions.md) - - ↳ **`RouteLocationAsPathGeneric`** - - ↳↳ [`RouteLocationAsPathTyped`](RouteLocationAsPathTyped.md) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[force](RouteLocationOptions.md#force) - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[hash](RouteQueryAndHash.md#hash) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[query](RouteQueryAndHash.md#query) - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[replace](RouteLocationOptions.md#replace) - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[state](RouteLocationOptions.md#state) diff --git a/packages/docs/api/interfaces/RouteLocationAsPathTyped.md b/packages/docs/api/interfaces/RouteLocationAsPathTyped.md deleted file mode 100644 index 17b81286e..000000000 --- a/packages/docs/api/interfaces/RouteLocationAsPathTyped.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationAsPathTyped - -# Interface: RouteLocationAsPathTyped\ - -Helper to generate a type safe version of the [RouteLocationAsPath](../index.md#RouteLocationAsPath) type. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](../index.md#RouteMapGeneric) = [`RouteMapGeneric`](../index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` = keyof `RouteMap` | - -## Hierarchy - -- [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) - - ↳ **`RouteLocationAsPathTyped`** - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -#### Inherited from - -[RouteLocationAsPathGeneric](RouteLocationAsPathGeneric.md).[force](RouteLocationAsPathGeneric.md#force) - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Inherited from - -[RouteLocationAsPathGeneric](RouteLocationAsPathGeneric.md).[hash](RouteLocationAsPathGeneric.md#hash) - -___ - -### path - -• **path**: `_LiteralUnion`\<`RouteMap`[`Name`][``"path"``]\> - -Percentage encoded pathname section of the URL. - -#### Overrides - -[RouteLocationAsPathGeneric](RouteLocationAsPathGeneric.md).[path](RouteLocationAsPathGeneric.md#path) - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) - -#### Inherited from - -[RouteLocationAsPathGeneric](RouteLocationAsPathGeneric.md).[query](RouteLocationAsPathGeneric.md#query) - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -#### Inherited from - -[RouteLocationAsPathGeneric](RouteLocationAsPathGeneric.md).[replace](RouteLocationAsPathGeneric.md#replace) - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state - -#### Inherited from - -[RouteLocationAsPathGeneric](RouteLocationAsPathGeneric.md).[state](RouteLocationAsPathGeneric.md#state) diff --git a/packages/docs/api/interfaces/RouteLocationAsRelativeGeneric.md b/packages/docs/api/interfaces/RouteLocationAsRelativeGeneric.md deleted file mode 100644 index e413c72f0..000000000 --- a/packages/docs/api/interfaces/RouteLocationAsRelativeGeneric.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationAsRelativeGeneric - -# Interface: RouteLocationAsRelativeGeneric - -Generic version of [RouteLocationAsRelative](../index.md#RouteLocationAsRelative). It is used when no [RouteMap](../index.md#RouteMap) is provided. - -## Hierarchy - -- [`RouteQueryAndHash`](RouteQueryAndHash.md) - -- [`RouteLocationOptions`](RouteLocationOptions.md) - - ↳ **`RouteLocationAsRelativeGeneric`** - - ↳↳ [`RouteLocationAsRelativeTyped`](RouteLocationAsRelativeTyped.md) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[force](RouteLocationOptions.md#force) - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[hash](RouteQueryAndHash.md#hash) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -___ - -### params - -• `Optional` **params**: [`RouteParamsRawGeneric`](../index.md#RouteParamsRawGeneric) - -___ - -### path - -• `Optional` **path**: `undefined` - -A relative path to the current location. This property should be removed - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[query](RouteQueryAndHash.md#query) - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[replace](RouteLocationOptions.md#replace) - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[state](RouteLocationOptions.md#state) diff --git a/packages/docs/api/interfaces/RouteLocationAsRelativeTyped.md b/packages/docs/api/interfaces/RouteLocationAsRelativeTyped.md deleted file mode 100644 index 05078fe8b..000000000 --- a/packages/docs/api/interfaces/RouteLocationAsRelativeTyped.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationAsRelativeTyped - -# Interface: RouteLocationAsRelativeTyped\ - -Helper to generate a type safe version of the [RouteLocationAsRelative](../index.md#RouteLocationAsRelative) type. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](../index.md#RouteMapGeneric) = [`RouteMapGeneric`](../index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` = keyof `RouteMap` | - -## Hierarchy - -- [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) - - ↳ **`RouteLocationAsRelativeTyped`** - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -#### Inherited from - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[force](RouteLocationAsRelativeGeneric.md#force) - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Inherited from - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[hash](RouteLocationAsRelativeGeneric.md#hash) - -___ - -### name - -• `Optional` **name**: `Extract`\<`Name`, `string` \| `symbol`\> - -#### Overrides - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[name](RouteLocationAsRelativeGeneric.md#name) - -___ - -### params - -• `Optional` **params**: `RouteMap`[`Name`][``"paramsRaw"``] - -#### Overrides - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[params](RouteLocationAsRelativeGeneric.md#params) - -___ - -### path - -• `Optional` **path**: `undefined` - -A relative path to the current location. This property should be removed - -#### Inherited from - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[path](RouteLocationAsRelativeGeneric.md#path) - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) - -#### Inherited from - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[query](RouteLocationAsRelativeGeneric.md#query) - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -#### Inherited from - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[replace](RouteLocationAsRelativeGeneric.md#replace) - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state - -#### Inherited from - -[RouteLocationAsRelativeGeneric](RouteLocationAsRelativeGeneric.md).[state](RouteLocationAsRelativeGeneric.md#state) diff --git a/packages/docs/api/interfaces/RouteLocationBase.md b/packages/docs/api/interfaces/RouteLocationBase.md deleted file mode 100644 index b26cfe81a..000000000 --- a/packages/docs/api/interfaces/RouteLocationBase.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / \_RouteLocationBase - -# Interface: \_RouteLocationBase - -Base properties for a normalized route location. - -## Hierarchy - -- `Pick`\<[`MatcherLocation`](MatcherLocation.md), ``"name"`` \| ``"path"`` \| ``"params"`` \| ``"meta"``\> - - ↳ **`_RouteLocationBase`** - - ↳↳ [`RouteLocationGeneric`](RouteLocationGeneric.md) - - ↳↳ [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -Pick.meta - -___ - -### name - -• **name**: ``null`` \| [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name of the matched record - -#### Inherited from - -Pick.name - -___ - -### params - -• **params**: [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) - -Object of decoded params extracted from the `path`. - -#### Inherited from - -Pick.params - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -Pick.path - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. diff --git a/packages/docs/api/interfaces/RouteLocationGeneric.md b/packages/docs/api/interfaces/RouteLocationGeneric.md deleted file mode 100644 index 534be974a..000000000 --- a/packages/docs/api/interfaces/RouteLocationGeneric.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationGeneric - -# Interface: RouteLocationGeneric - -Generic version of [RouteLocation](../index.md#RouteLocation). It is used when no [RouteMap](../index.md#RouteMap) is provided. - -## Hierarchy - -- [`_RouteLocationBase`](RouteLocationBase.md) - - ↳ **`RouteLocationGeneric`** - - ↳↳ [`RouteLocationTyped`](RouteLocationTyped.md) - - ↳↳ [`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[fullPath](RouteLocationBase.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[hash](RouteLocationBase.md#hash) - -___ - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecord](../index.md#RouteRecord) containing components as they were -passed when adding records. It can also contain redirect records. This -can't be used directly. **This property is non-enumerable**. - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[meta](RouteLocationBase.md#meta) - -___ - -### name - -• **name**: ``null`` \| [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name of the matched record - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[name](RouteLocationBase.md#name) - -___ - -### params - -• **params**: [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) - -Object of decoded params extracted from the `path`. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[params](RouteLocationBase.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[path](RouteLocationBase.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[query](RouteLocationBase.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[redirectedFrom](RouteLocationBase.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationMatched.md b/packages/docs/api/interfaces/RouteLocationMatched.md deleted file mode 100644 index 7bc60f858..000000000 --- a/packages/docs/api/interfaces/RouteLocationMatched.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationMatched - -# Interface: RouteLocationMatched - -Normalized version of a [route record](../index.md#RouteRecord). - -## Hierarchy - -- [`RouteRecordNormalized`](RouteRecordNormalized.md) - - ↳ **`RouteLocationMatched`** - -## Properties - -### aliasOf - -• **aliasOf**: `undefined` \| [`RouteRecordNormalized`](RouteRecordNormalized.md) - -Defines if this record is the alias of another one. This property is -`undefined` if the record is the original one. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[aliasOf](RouteRecordNormalized.md#aliasOf) - -___ - -### beforeEnter - -• **beforeEnter**: `undefined` \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Registered beforeEnter guards - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[beforeEnter](RouteRecordNormalized.md#beforeEnter) - -___ - -### children - -• **children**: [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Nested route records. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[children](RouteRecordNormalized.md#children) - -___ - -### components - -• **components**: `undefined` \| ``null`` \| `Record`\<`string`, [`RouteComponent`](../index.md#RouteComponent)\> - -Components to display when the URL matches this route. Allow using named views. - -#### Overrides - -[RouteRecordNormalized](RouteRecordNormalized.md).[components](RouteRecordNormalized.md#components) - -___ - -### enterCallbacks - -• **enterCallbacks**: `Record`\<`string`, [`NavigationGuardNextCallback`](../index.md#NavigationGuardNextCallback)[]\> - -Registered beforeRouteEnter callbacks passed to `next` or returned in guards - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[enterCallbacks](RouteRecordNormalized.md#enterCallbacks) - -___ - -### instances - -• **instances**: `Record`\<`string`, `undefined` \| ``null`` \| `ComponentPublicInstance`\> - -Mounted route component instances -Having the instances on the record mean beforeRouteUpdate and -beforeRouteLeave guards can only be invoked with the latest mounted app -instance if there are multiple application instances rendering the same -view, basically duplicating the content on the page, which shouldn't happen -in practice. It will work if multiple apps are rendering different named -views. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[instances](RouteRecordNormalized.md#instances) - -___ - -### leaveGuards - -• **leaveGuards**: `Set`\<[`NavigationGuard`](NavigationGuard.md)\> - -Registered leave guards - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[leaveGuards](RouteRecordNormalized.md#leaveGuards) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[meta](RouteRecordNormalized.md#meta) - -___ - -### name - -• **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[name](RouteRecordNormalized.md#name) - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[path](RouteRecordNormalized.md#path) - -___ - -### props - -• **props**: `Record`\<`string`, [`_RouteRecordProps`](../index.md#_RouteRecordProps)\> - -Allow passing down params as props to the component rendered by -`router-view`. Should be an object with the same keys as `components` or a -boolean to be applied to every component. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[props](RouteRecordNormalized.md#props) - -___ - -### redirect - -• **redirect**: `undefined` \| [`RouteRecordRedirectOption`](../index.md#RouteRecordRedirectOption) - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[redirect](RouteRecordNormalized.md#redirect) - -___ - -### updateGuards - -• **updateGuards**: `Set`\<[`NavigationGuard`](NavigationGuard.md)\> - -Registered update guards - -#### Inherited from - -[RouteRecordNormalized](RouteRecordNormalized.md).[updateGuards](RouteRecordNormalized.md#updateGuards) diff --git a/packages/docs/api/interfaces/RouteLocationNamedRaw.md b/packages/docs/api/interfaces/RouteLocationNamedRaw.md deleted file mode 100644 index 9883d02aa..000000000 --- a/packages/docs/api/interfaces/RouteLocationNamedRaw.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationNamedRaw - -# Interface: RouteLocationNamedRaw - -Route Location that can infer the necessary params based on the name. - -## Hierarchy - -- [`RouteQueryAndHash`](RouteQueryAndHash.md) - -- [`LocationAsRelativeRaw`](LocationAsRelativeRaw.md) - -- [`RouteLocationOptions`](RouteLocationOptions.md) - - ↳ **`RouteLocationNamedRaw`** - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[force](RouteLocationOptions.md#force) - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[hash](RouteQueryAndHash.md#hash) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -#### Inherited from - -[LocationAsRelativeRaw](LocationAsRelativeRaw.md).[name](LocationAsRelativeRaw.md#name) - -___ - -### params - -• `Optional` **params**: [`RouteParamsRawGeneric`](../index.md#RouteParamsRawGeneric) - -#### Inherited from - -[LocationAsRelativeRaw](LocationAsRelativeRaw.md).[params](LocationAsRelativeRaw.md#params) - -___ - -### path - -• `Optional` **path**: `undefined` - -Ignored path property since we are dealing with a relative location. Only `undefined` is allowed. - -#### Inherited from - -[LocationAsRelativeRaw](LocationAsRelativeRaw.md).[path](LocationAsRelativeRaw.md#path) - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[query](RouteQueryAndHash.md#query) - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[replace](RouteLocationOptions.md#replace) - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[state](RouteLocationOptions.md#state) diff --git a/packages/docs/api/interfaces/RouteLocationNormalizedGeneric.md b/packages/docs/api/interfaces/RouteLocationNormalizedGeneric.md deleted file mode 100644 index ac25d6dbc..000000000 --- a/packages/docs/api/interfaces/RouteLocationNormalizedGeneric.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationNormalizedGeneric - -# Interface: RouteLocationNormalizedGeneric - -Generic version of [RouteLocationNormalized](../index.md#RouteLocationNormalized) that is used when no [RouteMap](../index.md#RouteMap) is provided. - -## Hierarchy - -- [`_RouteLocationBase`](RouteLocationBase.md) - - ↳ **`RouteLocationNormalizedGeneric`** - - ↳↳ [`RouteLocationNormalizedTyped`](RouteLocationNormalizedTyped.md) - - ↳↳ [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[fullPath](RouteLocationBase.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[hash](RouteLocationBase.md#hash) - -___ - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecordNormalized](RouteRecordNormalized.md) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[meta](RouteLocationBase.md#meta) - -___ - -### name - -• **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name of the matched record - -#### Overrides - -[_RouteLocationBase](RouteLocationBase.md).[name](RouteLocationBase.md#name) - -___ - -### params - -• **params**: [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) - -Object of decoded params extracted from the `path`. - -#### Overrides - -[_RouteLocationBase](RouteLocationBase.md).[params](RouteLocationBase.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[path](RouteLocationBase.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[query](RouteLocationBase.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[_RouteLocationBase](RouteLocationBase.md).[redirectedFrom](RouteLocationBase.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationNormalizedLoadedGeneric.md b/packages/docs/api/interfaces/RouteLocationNormalizedLoadedGeneric.md deleted file mode 100644 index 45c28e7cf..000000000 --- a/packages/docs/api/interfaces/RouteLocationNormalizedLoadedGeneric.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationNormalizedLoadedGeneric - -# Interface: RouteLocationNormalizedLoadedGeneric - -Generic version of [RouteLocationNormalizedLoaded](../index.md#RouteLocationNormalizedLoaded) that is used when no [RouteMap](../index.md#RouteMap) is provided. - -## Hierarchy - -- [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) - - ↳ **`RouteLocationNormalizedLoadedGeneric`** - - ↳↳ [`RouteLocationNormalizedLoadedTyped`](RouteLocationNormalizedLoadedTyped.md) - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[fullPath](RouteLocationNormalizedGeneric.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[hash](RouteLocationNormalizedGeneric.md#hash) - -___ - -### matched - -• **matched**: [`RouteLocationMatched`](RouteLocationMatched.md)[] - -Array of [RouteLocationMatched](RouteLocationMatched.md) containing only plain components (any -lazy-loaded components have been loaded and were replaced inside the -`components` object) so it can be directly used to display routes. It -cannot contain redirect records either. **This property is non-enumerable**. - -#### Overrides - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[matched](RouteLocationNormalizedGeneric.md#matched) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[meta](RouteLocationNormalizedGeneric.md#meta) - -___ - -### name - -• **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name of the matched record - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[name](RouteLocationNormalizedGeneric.md#name) - -___ - -### params - -• **params**: [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) - -Object of decoded params extracted from the `path`. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[params](RouteLocationNormalizedGeneric.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[path](RouteLocationNormalizedGeneric.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[query](RouteLocationNormalizedGeneric.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[redirectedFrom](RouteLocationNormalizedGeneric.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationNormalizedLoadedTyped.md b/packages/docs/api/interfaces/RouteLocationNormalizedLoadedTyped.md deleted file mode 100644 index e09690e08..000000000 --- a/packages/docs/api/interfaces/RouteLocationNormalizedLoadedTyped.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationNormalizedLoadedTyped - -# Interface: RouteLocationNormalizedLoadedTyped\ - -Helper to generate a type safe version of the [RouteLocationNormalizedLoaded](../index.md#RouteLocationNormalizedLoaded) type. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](../index.md#RouteMapGeneric) = [`RouteMapGeneric`](../index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` = keyof `RouteMap` | - -## Hierarchy - -- [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) - - ↳ **`RouteLocationNormalizedLoadedTyped`** - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[fullPath](RouteLocationNormalizedLoadedGeneric.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[hash](RouteLocationNormalizedLoadedGeneric.md#hash) - -___ - -### matched - -• **matched**: [`RouteLocationMatched`](RouteLocationMatched.md)[] - -Array of [RouteLocationMatched](RouteLocationMatched.md) containing only plain components (any -lazy-loaded components have been loaded and were replaced inside the -`components` object) so it can be directly used to display routes. It -cannot contain redirect records either. **This property is non-enumerable**. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[matched](RouteLocationNormalizedLoadedGeneric.md#matched) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[meta](RouteLocationNormalizedLoadedGeneric.md#meta) - -___ - -### name - -• **name**: `Extract`\<`Name`, `string` \| `symbol`\> - -Name of the matched record - -#### Overrides - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[name](RouteLocationNormalizedLoadedGeneric.md#name) - -___ - -### params - -• **params**: `RouteMap`[`Name`][``"params"``] - -Object of decoded params extracted from the `path`. - -#### Overrides - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[params](RouteLocationNormalizedLoadedGeneric.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[path](RouteLocationNormalizedLoadedGeneric.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[query](RouteLocationNormalizedLoadedGeneric.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[RouteLocationNormalizedLoadedGeneric](RouteLocationNormalizedLoadedGeneric.md).[redirectedFrom](RouteLocationNormalizedLoadedGeneric.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationNormalizedTyped.md b/packages/docs/api/interfaces/RouteLocationNormalizedTyped.md deleted file mode 100644 index 58ff01b6c..000000000 --- a/packages/docs/api/interfaces/RouteLocationNormalizedTyped.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationNormalizedTyped - -# Interface: RouteLocationNormalizedTyped\ - -Helper to generate a type safe version of the [RouteLocationNormalized](../index.md#RouteLocationNormalized) type. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](../index.md#RouteMapGeneric) = [`RouteMapGeneric`](../index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` = keyof `RouteMap` | - -## Hierarchy - -- [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) - - ↳ **`RouteLocationNormalizedTyped`** - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[fullPath](RouteLocationNormalizedGeneric.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[hash](RouteLocationNormalizedGeneric.md#hash) - -___ - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecordNormalized](RouteRecordNormalized.md) - -#### Overrides - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[matched](RouteLocationNormalizedGeneric.md#matched) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[meta](RouteLocationNormalizedGeneric.md#meta) - -___ - -### name - -• **name**: `Extract`\<`Name`, `string` \| `symbol`\> - -Name of the matched record - -#### Overrides - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[name](RouteLocationNormalizedGeneric.md#name) - -___ - -### params - -• **params**: `RouteMap`[`Name`][``"params"``] - -Object of decoded params extracted from the `path`. - -#### Overrides - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[params](RouteLocationNormalizedGeneric.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[path](RouteLocationNormalizedGeneric.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[query](RouteLocationNormalizedGeneric.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[RouteLocationNormalizedGeneric](RouteLocationNormalizedGeneric.md).[redirectedFrom](RouteLocationNormalizedGeneric.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationOptions.md b/packages/docs/api/interfaces/RouteLocationOptions.md deleted file mode 100644 index d64f6c606..000000000 --- a/packages/docs/api/interfaces/RouteLocationOptions.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationOptions - -# Interface: RouteLocationOptions - -Common options for all navigation methods. - -## Hierarchy - -- **`RouteLocationOptions`** - - ↳ [`RouteLocationNamedRaw`](RouteLocationNamedRaw.md) - - ↳ [`RouteLocationPathRaw`](RouteLocationPathRaw.md) - - ↳ [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) - - ↳ [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state diff --git a/packages/docs/api/interfaces/RouteLocationPathRaw.md b/packages/docs/api/interfaces/RouteLocationPathRaw.md deleted file mode 100644 index 631aa06b8..000000000 --- a/packages/docs/api/interfaces/RouteLocationPathRaw.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationPathRaw - -# Interface: RouteLocationPathRaw - -Route Location that can infer the possible paths. - -## Hierarchy - -- [`RouteQueryAndHash`](RouteQueryAndHash.md) - -- [`MatcherLocationAsPath`](MatcherLocationAsPath.md) - -- [`RouteLocationOptions`](RouteLocationOptions.md) - - ↳ **`RouteLocationPathRaw`** - -## Properties - -### force - -• `Optional` **force**: `boolean` - -Triggers the navigation even if the location is the same as the current one. -Note this will also add a new entry to the history unless `replace: true` -is passed. - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[force](RouteLocationOptions.md#force) - -___ - -### hash - -• `Optional` **hash**: `string` - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[hash](RouteQueryAndHash.md#hash) - -___ - -### path - -• **path**: `string` - -#### Inherited from - -[MatcherLocationAsPath](MatcherLocationAsPath.md).[path](MatcherLocationAsPath.md#path) - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) - -#### Inherited from - -[RouteQueryAndHash](RouteQueryAndHash.md).[query](RouteQueryAndHash.md#query) - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Replace the entry in the history instead of pushing a new entry - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[replace](RouteLocationOptions.md#replace) - -___ - -### state - -• `Optional` **state**: [`HistoryState`](HistoryState.md) - -State to save using the History API. This cannot contain any reactive -values and some primitives like Symbols are forbidden. More info at -https://developer.mozilla.org/en-US/docs/Web/API/History/state - -#### Inherited from - -[RouteLocationOptions](RouteLocationOptions.md).[state](RouteLocationOptions.md#state) diff --git a/packages/docs/api/interfaces/RouteLocationResolvedGeneric.md b/packages/docs/api/interfaces/RouteLocationResolvedGeneric.md deleted file mode 100644 index 842c9a04f..000000000 --- a/packages/docs/api/interfaces/RouteLocationResolvedGeneric.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationResolvedGeneric - -# Interface: RouteLocationResolvedGeneric - -Generic version of [RouteLocationResolved](../index.md#RouteLocationResolved). It is used when no [RouteMap](../index.md#RouteMap) is provided. - -## Hierarchy - -- [`RouteLocationGeneric`](RouteLocationGeneric.md) - - ↳ **`RouteLocationResolvedGeneric`** - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[fullPath](RouteLocationGeneric.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[hash](RouteLocationGeneric.md#hash) - -___ - -### href - -• **href**: `string` - -Resolved `href` for the route location that will be set on the ``. - -___ - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecord](../index.md#RouteRecord) containing components as they were -passed when adding records. It can also contain redirect records. This -can't be used directly. **This property is non-enumerable**. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[matched](RouteLocationGeneric.md#matched) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[meta](RouteLocationGeneric.md#meta) - -___ - -### name - -• **name**: ``null`` \| [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name of the matched record - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[name](RouteLocationGeneric.md#name) - -___ - -### params - -• **params**: [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) - -Object of decoded params extracted from the `path`. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[params](RouteLocationGeneric.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[path](RouteLocationGeneric.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[query](RouteLocationGeneric.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[redirectedFrom](RouteLocationGeneric.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationResolvedTyped.md b/packages/docs/api/interfaces/RouteLocationResolvedTyped.md deleted file mode 100644 index 8089756c3..000000000 --- a/packages/docs/api/interfaces/RouteLocationResolvedTyped.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationResolvedTyped - -# Interface: RouteLocationResolvedTyped\ - -Helper to generate a type safe version of the [RouteLocationResolved](../index.md#RouteLocationResolved) type. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](../index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` | - -## Hierarchy - -- [`RouteLocationTyped`](RouteLocationTyped.md)\<`RouteMap`, `Name`\> - - ↳ **`RouteLocationResolvedTyped`** - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[fullPath](RouteLocationTyped.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[hash](RouteLocationTyped.md#hash) - -___ - -### href - -• **href**: `string` - -Resolved `href` for the route location that will be set on the ``. - -___ - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecord](../index.md#RouteRecord) containing components as they were -passed when adding records. It can also contain redirect records. This -can't be used directly. **This property is non-enumerable**. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[matched](RouteLocationTyped.md#matched) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[meta](RouteLocationTyped.md#meta) - -___ - -### name - -• **name**: `Extract`\<`Name`, `string` \| `symbol`\> - -Name of the matched record - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[name](RouteLocationTyped.md#name) - -___ - -### params - -• **params**: `RouteMap`[`Name`][``"params"``] - -Object of decoded params extracted from the `path`. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[params](RouteLocationTyped.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[path](RouteLocationTyped.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[query](RouteLocationTyped.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[RouteLocationTyped](RouteLocationTyped.md).[redirectedFrom](RouteLocationTyped.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteLocationTyped.md b/packages/docs/api/interfaces/RouteLocationTyped.md deleted file mode 100644 index 9d0debb4a..000000000 --- a/packages/docs/api/interfaces/RouteLocationTyped.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteLocationTyped - -# Interface: RouteLocationTyped\ - -Helper to generate a type safe version of the [RouteLocation](../index.md#RouteLocation) type. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `RouteMap` | extends [`RouteMapGeneric`](../index.md#RouteMapGeneric) | -| `Name` | extends keyof `RouteMap` | - -## Hierarchy - -- [`RouteLocationGeneric`](RouteLocationGeneric.md) - - ↳ **`RouteLocationTyped`** - - ↳↳ [`RouteLocationResolvedTyped`](RouteLocationResolvedTyped.md) - -## Properties - -### fullPath - -• **fullPath**: `string` - -The whole location including the `search` and `hash`. This string is -percentage encoded. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[fullPath](RouteLocationGeneric.md#fullPath) - -___ - -### hash - -• **hash**: `string` - -Hash of the current location. If present, starts with a `#`. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[hash](RouteLocationGeneric.md#hash) - -___ - -### matched - -• **matched**: [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Array of [RouteRecord](../index.md#RouteRecord) containing components as they were -passed when adding records. It can also contain redirect records. This -can't be used directly. **This property is non-enumerable**. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[matched](RouteLocationGeneric.md#matched) - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Merged `meta` properties from all the matched route records. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[meta](RouteLocationGeneric.md#meta) - -___ - -### name - -• **name**: `Extract`\<`Name`, `string` \| `symbol`\> - -Name of the matched record - -#### Overrides - -[RouteLocationGeneric](RouteLocationGeneric.md).[name](RouteLocationGeneric.md#name) - -___ - -### params - -• **params**: `RouteMap`[`Name`][``"params"``] - -Object of decoded params extracted from the `path`. - -#### Overrides - -[RouteLocationGeneric](RouteLocationGeneric.md).[params](RouteLocationGeneric.md#params) - -___ - -### path - -• **path**: `string` - -Percentage encoded pathname section of the URL. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[path](RouteLocationGeneric.md#path) - -___ - -### query - -• **query**: [`LocationQuery`](../index.md#LocationQuery) - -Object representation of the `search` property of the current location. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[query](RouteLocationGeneric.md#query) - -___ - -### redirectedFrom - -• **redirectedFrom**: `undefined` \| [`RouteLocationGeneric`](RouteLocationGeneric.md) - -Contains the location we were initially trying to access before ending up -on the current location. - -#### Inherited from - -[RouteLocationGeneric](RouteLocationGeneric.md).[redirectedFrom](RouteLocationGeneric.md#redirectedFrom) diff --git a/packages/docs/api/interfaces/RouteMeta.md b/packages/docs/api/interfaces/RouteMeta.md deleted file mode 100644 index 0c2a36e4f..000000000 --- a/packages/docs/api/interfaces/RouteMeta.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteMeta - -# Interface: RouteMeta - -Interface to type `meta` fields in route records. - -**`Example`** - -```ts -// typings.d.ts or router.ts -import 'vue-router'; - -declare module 'vue-router' { - interface RouteMeta { - requiresAuth?: boolean - } -} -``` - -## Hierarchy - -- `Record`\<`string` \| `number` \| `symbol`, `unknown`\> - - ↳ **`RouteMeta`** diff --git a/packages/docs/api/interfaces/RouteQueryAndHash.md b/packages/docs/api/interfaces/RouteQueryAndHash.md deleted file mode 100644 index b501ff5ab..000000000 --- a/packages/docs/api/interfaces/RouteQueryAndHash.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteQueryAndHash - -# Interface: RouteQueryAndHash - -## Hierarchy - -- **`RouteQueryAndHash`** - - ↳ [`RouteLocationNamedRaw`](RouteLocationNamedRaw.md) - - ↳ [`RouteLocationPathRaw`](RouteLocationPathRaw.md) - - ↳ [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) - - ↳ [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) - -## Properties - -### hash - -• `Optional` **hash**: `string` - -___ - -### query - -• `Optional` **query**: [`LocationQueryRaw`](../index.md#LocationQueryRaw) diff --git a/packages/docs/api/interfaces/RouteRecordBase.md b/packages/docs/api/interfaces/RouteRecordBase.md deleted file mode 100644 index 7fb4d708a..000000000 --- a/packages/docs/api/interfaces/RouteRecordBase.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / \_RouteRecordBase - -# Interface: \_RouteRecordBase - -Internal type for common properties among all kind of [RouteRecordRaw](../index.md#RouteRecordRaw). - -## Hierarchy - -- [`PathParserOptions`](../index.md#PathParserOptions) - - ↳ **`_RouteRecordBase`** - - ↳↳ [`RouteRecordSingleView`](RouteRecordSingleView.md) - - ↳↳ [`RouteRecordSingleViewWithChildren`](RouteRecordSingleViewWithChildren.md) - - ↳↳ [`RouteRecordMultipleViews`](RouteRecordMultipleViews.md) - - ↳↳ [`RouteRecordMultipleViewsWithChildren`](RouteRecordMultipleViewsWithChildren.md) - - ↳↳ [`RouteRecordRedirect`](RouteRecordRedirect.md) - -## Properties - -### alias - -• `Optional` **alias**: `string` \| `string`[] - -Aliases for the record. Allows defining extra paths that will behave like a -copy of the record. Allows having paths shorthands like `/users/:id` and -`/u/:id`. All `alias` and `path` values must share the same params. - -___ - -### beforeEnter - -• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Before Enter guard specific to this record. Note `beforeEnter` has no -effect if the record has a `redirect` property. - -___ - -### children - -• `Optional` **children**: [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Array of nested routes. - -___ - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -PathParserOptions.end - -___ - -### meta - -• `Optional` **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -**`Example`** - -```ts -`/users/:id` matches `/users/1` as well as `/users/posva`. -``` - -___ - -### props - -• `Optional` **props**: [`_RouteRecordProps`](../index.md#_RouteRecordProps) \| `Record`\<`string`, [`_RouteRecordProps`](../index.md#_RouteRecordProps)\> - -Allow passing down params as props to the component rendered by `router-view`. - -___ - -### redirect - -• `Optional` **redirect**: [`RouteRecordRedirectOption`](../index.md#RouteRecordRedirectOption) - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -PathParserOptions.sensitive - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -PathParserOptions.strict diff --git a/packages/docs/api/interfaces/RouteRecordInfo.md b/packages/docs/api/interfaces/RouteRecordInfo.md deleted file mode 100644 index fa078d760..000000000 --- a/packages/docs/api/interfaces/RouteRecordInfo.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordInfo - -# Interface: RouteRecordInfo\ - -Helper type to define a Typed `RouteRecord` - -**`See`** - -[RouteRecord](../index.md#RouteRecord) - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends `string` \| `symbol` = `string` | -| `Path` | extends `string` = `string` | -| `ParamsRaw` | extends [`RouteParamsRawGeneric`](../index.md#RouteParamsRawGeneric) = [`RouteParamsRawGeneric`](../index.md#RouteParamsRawGeneric) | -| `Params` | extends [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) = [`RouteParamsGeneric`](../index.md#RouteParamsGeneric) | -| `Meta` | extends [`RouteMeta`](RouteMeta.md) = [`RouteMeta`](RouteMeta.md) | - -## Properties - -### meta - -• **meta**: `Meta` - -___ - -### name - -• **name**: `Name` - -___ - -### params - -• **params**: `Params` - -___ - -### paramsRaw - -• **paramsRaw**: `ParamsRaw` - -___ - -### path - -• **path**: `Path` diff --git a/packages/docs/api/interfaces/RouteRecordMultipleViews.md b/packages/docs/api/interfaces/RouteRecordMultipleViews.md deleted file mode 100644 index 9d8d475be..000000000 --- a/packages/docs/api/interfaces/RouteRecordMultipleViews.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordMultipleViews - -# Interface: RouteRecordMultipleViews - -Route Record defining multiple named components with the `components` option. - -## Hierarchy - -- [`_RouteRecordBase`](RouteRecordBase.md) - - ↳ **`RouteRecordMultipleViews`** - -## Properties - -### alias - -• `Optional` **alias**: `string` \| `string`[] - -Aliases for the record. Allows defining extra paths that will behave like a -copy of the record. Allows having paths shorthands like `/users/:id` and -`/u/:id`. All `alias` and `path` values must share the same params. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[alias](RouteRecordBase.md#alias) - -___ - -### beforeEnter - -• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Before Enter guard specific to this record. Note `beforeEnter` has no -effect if the record has a `redirect` property. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[beforeEnter](RouteRecordBase.md#beforeEnter) - -___ - -### children - -• `Optional` **children**: `undefined` - -Array of nested routes. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[children](RouteRecordBase.md#children) - -___ - -### component - -• `Optional` **component**: `undefined` - -___ - -### components - -• **components**: `Record`\<`string`, `RawRouteComponent`\> - -Components to display when the URL matches this route. Allow using named views. - -___ - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[end](RouteRecordBase.md#end) - -___ - -### meta - -• `Optional` **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[meta](RouteRecordBase.md#meta) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[name](RouteRecordBase.md#name) - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -**`Example`** - -```ts -`/users/:id` matches `/users/1` as well as `/users/posva`. -``` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[path](RouteRecordBase.md#path) - -___ - -### props - -• `Optional` **props**: `boolean` \| `Record`\<`string`, [`_RouteRecordProps`](../index.md#_RouteRecordProps)\> - -Allow passing down params as props to the component rendered by -`router-view`. Should be an object with the same keys as `components` or a -boolean to be applied to every component. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[props](RouteRecordBase.md#props) - -___ - -### redirect - -• `Optional` **redirect**: `undefined` - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[redirect](RouteRecordBase.md#redirect) - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[sensitive](RouteRecordBase.md#sensitive) - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[strict](RouteRecordBase.md#strict) diff --git a/packages/docs/api/interfaces/RouteRecordMultipleViewsWithChildren.md b/packages/docs/api/interfaces/RouteRecordMultipleViewsWithChildren.md deleted file mode 100644 index 1c8f55b7a..000000000 --- a/packages/docs/api/interfaces/RouteRecordMultipleViewsWithChildren.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordMultipleViewsWithChildren - -# Interface: RouteRecordMultipleViewsWithChildren - -Route Record defining multiple named components with the `components` option and children. - -## Hierarchy - -- [`_RouteRecordBase`](RouteRecordBase.md) - - ↳ **`RouteRecordMultipleViewsWithChildren`** - -## Properties - -### alias - -• `Optional` **alias**: `string` \| `string`[] - -Aliases for the record. Allows defining extra paths that will behave like a -copy of the record. Allows having paths shorthands like `/users/:id` and -`/u/:id`. All `alias` and `path` values must share the same params. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[alias](RouteRecordBase.md#alias) - -___ - -### beforeEnter - -• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Before Enter guard specific to this record. Note `beforeEnter` has no -effect if the record has a `redirect` property. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[beforeEnter](RouteRecordBase.md#beforeEnter) - -___ - -### children - -• **children**: [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Array of nested routes. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[children](RouteRecordBase.md#children) - -___ - -### component - -• `Optional` **component**: `undefined` - -___ - -### components - -• `Optional` **components**: ``null`` \| `Record`\<`string`, `RawRouteComponent`\> - -Components to display when the URL matches this route. Allow using named views. - -___ - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[end](RouteRecordBase.md#end) - -___ - -### meta - -• `Optional` **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[meta](RouteRecordBase.md#meta) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[name](RouteRecordBase.md#name) - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -**`Example`** - -```ts -`/users/:id` matches `/users/1` as well as `/users/posva`. -``` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[path](RouteRecordBase.md#path) - -___ - -### props - -• `Optional` **props**: `boolean` \| `Record`\<`string`, [`_RouteRecordProps`](../index.md#_RouteRecordProps)\> - -Allow passing down params as props to the component rendered by -`router-view`. Should be an object with the same keys as `components` or a -boolean to be applied to every component. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[props](RouteRecordBase.md#props) - -___ - -### redirect - -• `Optional` **redirect**: [`RouteRecordRedirectOption`](../index.md#RouteRecordRedirectOption) - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[redirect](RouteRecordBase.md#redirect) - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[sensitive](RouteRecordBase.md#sensitive) - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[strict](RouteRecordBase.md#strict) diff --git a/packages/docs/api/interfaces/RouteRecordNormalized.md b/packages/docs/api/interfaces/RouteRecordNormalized.md deleted file mode 100644 index 6e08887e6..000000000 --- a/packages/docs/api/interfaces/RouteRecordNormalized.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordNormalized - -# Interface: RouteRecordNormalized - -Normalized version of a [route record](../index.md#RouteRecord). - -## Hierarchy - -- **`RouteRecordNormalized`** - - ↳ [`RouteLocationMatched`](RouteLocationMatched.md) - -## Properties - -### aliasOf - -• **aliasOf**: `undefined` \| [`RouteRecordNormalized`](RouteRecordNormalized.md) - -Defines if this record is the alias of another one. This property is -`undefined` if the record is the original one. - -___ - -### beforeEnter - -• **beforeEnter**: `undefined` \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Registered beforeEnter guards - -___ - -### children - -• **children**: [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Nested route records. - -___ - -### components - -• **components**: `undefined` \| ``null`` \| `Record`\<`string`, `RawRouteComponent`\> - -Components to display when the URL matches this route. Allow using named views. - -___ - -### enterCallbacks - -• **enterCallbacks**: `Record`\<`string`, [`NavigationGuardNextCallback`](../index.md#NavigationGuardNextCallback)[]\> - -Registered beforeRouteEnter callbacks passed to `next` or returned in guards - -___ - -### instances - -• **instances**: `Record`\<`string`, `undefined` \| ``null`` \| `ComponentPublicInstance`\> - -Mounted route component instances -Having the instances on the record mean beforeRouteUpdate and -beforeRouteLeave guards can only be invoked with the latest mounted app -instance if there are multiple application instances rendering the same -view, basically duplicating the content on the page, which shouldn't happen -in practice. It will work if multiple apps are rendering different named -views. - -___ - -### leaveGuards - -• **leaveGuards**: `Set`\<[`NavigationGuard`](NavigationGuard.md)\> - -Registered leave guards - -___ - -### meta - -• **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -___ - -### name - -• **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -___ - -### props - -• **props**: `Record`\<`string`, [`_RouteRecordProps`](../index.md#_RouteRecordProps)\> - -Allow passing down params as props to the component rendered by -`router-view`. Should be an object with the same keys as `components` or a -boolean to be applied to every component. - -___ - -### redirect - -• **redirect**: `undefined` \| [`RouteRecordRedirectOption`](../index.md#RouteRecordRedirectOption) - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -___ - -### updateGuards - -• **updateGuards**: `Set`\<[`NavigationGuard`](NavigationGuard.md)\> - -Registered update guards diff --git a/packages/docs/api/interfaces/RouteRecordRedirect.md b/packages/docs/api/interfaces/RouteRecordRedirect.md deleted file mode 100644 index 4129a36ab..000000000 --- a/packages/docs/api/interfaces/RouteRecordRedirect.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordRedirect - -# Interface: RouteRecordRedirect - -Route Record that defines a redirect. Cannot have `component` or `components` -as it is never rendered. - -## Hierarchy - -- [`_RouteRecordBase`](RouteRecordBase.md) - - ↳ **`RouteRecordRedirect`** - -## Properties - -### alias - -• `Optional` **alias**: `string` \| `string`[] - -Aliases for the record. Allows defining extra paths that will behave like a -copy of the record. Allows having paths shorthands like `/users/:id` and -`/u/:id`. All `alias` and `path` values must share the same params. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[alias](RouteRecordBase.md#alias) - -___ - -### beforeEnter - -• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Before Enter guard specific to this record. Note `beforeEnter` has no -effect if the record has a `redirect` property. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[beforeEnter](RouteRecordBase.md#beforeEnter) - -___ - -### children - -• `Optional` **children**: [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Array of nested routes. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[children](RouteRecordBase.md#children) - -___ - -### component - -• `Optional` **component**: `undefined` - -___ - -### components - -• `Optional` **components**: `undefined` - -___ - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[end](RouteRecordBase.md#end) - -___ - -### meta - -• `Optional` **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[meta](RouteRecordBase.md#meta) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[name](RouteRecordBase.md#name) - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -**`Example`** - -```ts -`/users/:id` matches `/users/1` as well as `/users/posva`. -``` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[path](RouteRecordBase.md#path) - -___ - -### props - -• `Optional` **props**: `undefined` - -Allow passing down params as props to the component rendered by `router-view`. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[props](RouteRecordBase.md#props) - -___ - -### redirect - -• **redirect**: [`RouteRecordRedirectOption`](../index.md#RouteRecordRedirectOption) - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[redirect](RouteRecordBase.md#redirect) - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[sensitive](RouteRecordBase.md#sensitive) - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[strict](RouteRecordBase.md#strict) diff --git a/packages/docs/api/interfaces/RouteRecordSingleView.md b/packages/docs/api/interfaces/RouteRecordSingleView.md deleted file mode 100644 index 7d6691808..000000000 --- a/packages/docs/api/interfaces/RouteRecordSingleView.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordSingleView - -# Interface: RouteRecordSingleView - -Route Record defining one single component with the `component` option. - -## Hierarchy - -- [`_RouteRecordBase`](RouteRecordBase.md) - - ↳ **`RouteRecordSingleView`** - -## Properties - -### alias - -• `Optional` **alias**: `string` \| `string`[] - -Aliases for the record. Allows defining extra paths that will behave like a -copy of the record. Allows having paths shorthands like `/users/:id` and -`/u/:id`. All `alias` and `path` values must share the same params. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[alias](RouteRecordBase.md#alias) - -___ - -### beforeEnter - -• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Before Enter guard specific to this record. Note `beforeEnter` has no -effect if the record has a `redirect` property. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[beforeEnter](RouteRecordBase.md#beforeEnter) - -___ - -### children - -• `Optional` **children**: `undefined` - -Array of nested routes. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[children](RouteRecordBase.md#children) - -___ - -### component - -• **component**: `RawRouteComponent` - -Component to display when the URL matches this route. - -___ - -### components - -• `Optional` **components**: `undefined` - -___ - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[end](RouteRecordBase.md#end) - -___ - -### meta - -• `Optional` **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[meta](RouteRecordBase.md#meta) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[name](RouteRecordBase.md#name) - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -**`Example`** - -```ts -`/users/:id` matches `/users/1` as well as `/users/posva`. -``` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[path](RouteRecordBase.md#path) - -___ - -### props - -• `Optional` **props**: [`_RouteRecordProps`](../index.md#_RouteRecordProps) - -Allow passing down params as props to the component rendered by `router-view`. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[props](RouteRecordBase.md#props) - -___ - -### redirect - -• `Optional` **redirect**: `undefined` - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[redirect](RouteRecordBase.md#redirect) - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[sensitive](RouteRecordBase.md#sensitive) - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[strict](RouteRecordBase.md#strict) diff --git a/packages/docs/api/interfaces/RouteRecordSingleViewWithChildren.md b/packages/docs/api/interfaces/RouteRecordSingleViewWithChildren.md deleted file mode 100644 index cc71c714f..000000000 --- a/packages/docs/api/interfaces/RouteRecordSingleViewWithChildren.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouteRecordSingleViewWithChildren - -# Interface: RouteRecordSingleViewWithChildren - -Route Record defining one single component with a nested view. - -## Hierarchy - -- [`_RouteRecordBase`](RouteRecordBase.md) - - ↳ **`RouteRecordSingleViewWithChildren`** - -## Properties - -### alias - -• `Optional` **alias**: `string` \| `string`[] - -Aliases for the record. Allows defining extra paths that will behave like a -copy of the record. Allows having paths shorthands like `/users/:id` and -`/u/:id`. All `alias` and `path` values must share the same params. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[alias](RouteRecordBase.md#alias) - -___ - -### beforeEnter - -• `Optional` **beforeEnter**: [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> \| [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\>[] - -Before Enter guard specific to this record. Note `beforeEnter` has no -effect if the record has a `redirect` property. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[beforeEnter](RouteRecordBase.md#beforeEnter) - -___ - -### children - -• **children**: [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Array of nested routes. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[children](RouteRecordBase.md#children) - -___ - -### component - -• `Optional` **component**: ``null`` \| `RawRouteComponent` - -Component to display when the URL matches this route. - -___ - -### components - -• `Optional` **components**: `undefined` - -___ - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[end](RouteRecordBase.md#end) - -___ - -### meta - -• `Optional` **meta**: [`RouteMeta`](RouteMeta.md) - -Arbitrary data attached to the record. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[meta](RouteRecordBase.md#meta) - -___ - -### name - -• `Optional` **name**: [`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric) - -Name for the route record. Must be unique. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[name](RouteRecordBase.md#name) - -___ - -### path - -• **path**: `string` - -Path of the record. Should start with `/` unless the record is the child of -another record. - -**`Example`** - -```ts -`/users/:id` matches `/users/1` as well as `/users/posva`. -``` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[path](RouteRecordBase.md#path) - -___ - -### props - -• `Optional` **props**: [`_RouteRecordProps`](../index.md#_RouteRecordProps) - -Allow passing down params as props to the component rendered by `router-view`. - -#### Overrides - -[_RouteRecordBase](RouteRecordBase.md).[props](RouteRecordBase.md#props) - -___ - -### redirect - -• `Optional` **redirect**: [`RouteRecordRedirectOption`](../index.md#RouteRecordRedirectOption) - -Where to redirect if the route is directly matched. The redirection happens -before any navigation guard and triggers a new navigation with the new -target location. - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[redirect](RouteRecordBase.md#redirect) - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[sensitive](RouteRecordBase.md#sensitive) - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -[_RouteRecordBase](RouteRecordBase.md).[strict](RouteRecordBase.md#strict) diff --git a/packages/docs/api/interfaces/Router.md b/packages/docs/api/interfaces/Router.md deleted file mode 100644 index 0e33a2d04..000000000 --- a/packages/docs/api/interfaces/Router.md +++ /dev/null @@ -1,428 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / Router - -# Interface: Router - -Router instance. - -## Properties - -### currentRoute - -• `Readonly` **currentRoute**: `Ref`\<[`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md)\> - -Current [RouteLocationNormalized](../index.md#RouteLocationNormalized) - -___ - -### listening - -• **listening**: `boolean` - -Allows turning off the listening of history events. This is a low level api for micro-frontend. - -___ - -### options - -• `Readonly` **options**: [`RouterOptions`](RouterOptions.md) - -Original options object passed to create the Router - -## Methods - -### addRoute - -▸ **addRoute**(`parentName`, `route`): () => `void` - -Add a new [route record](../index.md#RouteRecordRaw) as the child of an existing route. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `parentName` | `NonNullable`\<[`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric)\> | Parent Route Record where `route` should be appended at | -| `route` | [`RouteRecordRaw`](../index.md#RouteRecordRaw) | Route Record to add | - -#### Returns - -`fn` - -▸ (): `void` - -##### Returns - -`void` - -▸ **addRoute**(`route`): () => `void` - -Add a new [route record](../index.md#RouteRecordRaw) to the router. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `route` | [`RouteRecordRaw`](../index.md#RouteRecordRaw) | Route Record to add | - -#### Returns - -`fn` - -▸ (): `void` - -##### Returns - -`void` - -___ - -### afterEach - -▸ **afterEach**(`guard`): () => `void` - -Add a navigation hook that is executed after every navigation. Returns a -function that removes the registered hook. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guard` | [`NavigationHookAfter`](NavigationHookAfter.md) | navigation hook to add | - -#### Returns - -`fn` - -a function that removes the registered hook - -▸ (): `void` - -##### Returns - -`void` - -**`Example`** - -```js -router.afterEach((to, from, failure) => { - if (isNavigationFailure(failure)) { - console.log('failed navigation', failure) - } -}) -``` - -___ - -### back - -▸ **back**(): `void` - -Go back in history if possible by calling `history.back()`. Equivalent to -`router.go(-1)`. - -#### Returns - -`void` - -___ - -### beforeEach - -▸ **beforeEach**(`guard`): () => `void` - -Add a navigation guard that executes before any navigation. Returns a -function that removes the registered guard. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guard` | [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> | navigation guard to add | - -#### Returns - -`fn` - -▸ (): `void` - -##### Returns - -`void` - -___ - -### beforeResolve - -▸ **beforeResolve**(`guard`): () => `void` - -Add a navigation guard that executes before navigation is about to be -resolved. At this state all component have been fetched and other -navigation guards have been successful. Returns a function that removes the -registered guard. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `guard` | [`NavigationGuardWithThis`](NavigationGuardWithThis.md)\<`undefined`\> | navigation guard to add | - -#### Returns - -`fn` - -a function that removes the registered guard - -▸ (): `void` - -##### Returns - -`void` - -**`Example`** - -```js -router.beforeResolve(to => { - if (to.meta.requiresAuth && !isAuthenticated) return false -}) -``` - -___ - -### clearRoutes - -▸ **clearRoutes**(): `void` - -Delete all routes from the router matcher. - -#### Returns - -`void` - -___ - -### forward - -▸ **forward**(): `void` - -Go forward in history if possible by calling `history.forward()`. -Equivalent to `router.go(1)`. - -#### Returns - -`void` - -___ - -### getRoutes - -▸ **getRoutes**(): [`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -Get a full list of all the [route records](../index.md#RouteRecord). - -#### Returns - -[`RouteRecordNormalized`](RouteRecordNormalized.md)[] - -___ - -### go - -▸ **go**(`delta`): `void` - -Allows you to move forward or backward through the history. Calls -`history.go()`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `delta` | `number` | The position in the history to which you want to move, relative to the current page | - -#### Returns - -`void` - -___ - -### hasRoute - -▸ **hasRoute**(`name`): `boolean` - -Checks if a route with a given name exists - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `NonNullable`\<[`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric)\> | Name of the route to check | - -#### Returns - -`boolean` - -___ - -### install - -▸ **install**(`app`): `void` - -Called automatically by `app.use(router)`. Should not be called manually by -the user. This will trigger the initial navigation when on client side. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `app` | `App`\<`any`\> | Application that uses the router | - -#### Returns - -`void` - -___ - -### isReady - -▸ **isReady**(): `Promise`\<`void`\> - -Returns a Promise that resolves when the router has completed the initial -navigation, which means it has resolved all async enter hooks and async -components that are associated with the initial route. If the initial -navigation already happened, the promise resolves immediately. - -This is useful in server-side rendering to ensure consistent output on both -the server and the client. Note that on server side, you need to manually -push the initial location while on client side, the router automatically -picks it up from the URL. - -#### Returns - -`Promise`\<`void`\> - -___ - -### onError - -▸ **onError**(`handler`): () => `void` - -Adds an error handler that is called every time a non caught error happens -during navigation. This includes errors thrown synchronously and -asynchronously, errors returned or passed to `next` in any navigation -guard, and errors occurred when trying to resolve an async component that -is required to render a route. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `handler` | `_ErrorListener` | error handler to register | - -#### Returns - -`fn` - -▸ (): `void` - -##### Returns - -`void` - -___ - -### push - -▸ **push**(`to`): `Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\> - -Programmatically navigate to a new URL by pushing an entry in the history -stack. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | `string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) | Route location to navigate to | - -#### Returns - -`Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\> - -___ - -### removeRoute - -▸ **removeRoute**(`name`): `void` - -Remove an existing route by its name. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `NonNullable`\<[`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric)\> | Name of the route to remove | - -#### Returns - -`void` - -___ - -### replace - -▸ **replace**(`to`): `Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\> - -Programmatically navigate to a new URL by replacing the current entry in -the history stack. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | `string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) | Route location to navigate to | - -#### Returns - -`Promise`\<`undefined` \| `void` \| [`NavigationFailure`](NavigationFailure.md)\> - -___ - -### resolve - -▸ **resolve**\<`Name`\>(`to`, `currentLocation?`): [`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) - -Returns the [normalized version](../index.md#RouteLocation) of a -[route location](../index.md#RouteLocationRaw). Also includes an `href` property -that includes any existing `base`. By default, the `currentLocation` used is -`router.currentRoute` and should only be overridden in advanced use cases. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends `string` \| `symbol` = `string` \| `symbol` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`RouteLocationAsRelativeTyped`](RouteLocationAsRelativeTyped.md)\<[`RouteMapGeneric`](../index.md#RouteMapGeneric), `Name`\> | Raw route location to resolve | -| `currentLocation?` | [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) | Optional current location to resolve against | - -#### Returns - -[`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) - -▸ **resolve**(`to`, `currentLocation?`): [`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `to` | `string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) | -| `currentLocation?` | [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) | - -#### Returns - -[`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) diff --git a/packages/docs/api/interfaces/RouterHistory.md b/packages/docs/api/interfaces/RouterHistory.md deleted file mode 100644 index 8108fd93e..000000000 --- a/packages/docs/api/interfaces/RouterHistory.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouterHistory - -# Interface: RouterHistory - -Interface implemented by History implementations that can be passed to the -router as Router.history - -## Properties - -### base - -• `Readonly` **base**: `string` - -Base path that is prepended to every url. This allows hosting an SPA at a -sub-folder of a domain like `example.com/sub-folder` by having a `base` of -`/sub-folder` - -___ - -### location - -• `Readonly` **location**: `string` - -Current History location - -___ - -### state - -• `Readonly` **state**: [`HistoryState`](HistoryState.md) - -Current History state - -## Methods - -### createHref - -▸ **createHref**(`location`): `string` - -Generates the corresponding href to be used in an anchor tag. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `location` | `string` | history location that should create an href | - -#### Returns - -`string` - -___ - -### destroy - -▸ **destroy**(): `void` - -Clears any event listener attached by the history implementation. - -#### Returns - -`void` - -___ - -### go - -▸ **go**(`delta`, `triggerListeners?`): `void` - -Traverses history in a given direction. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `delta` | `number` | distance to travel. If delta is \< 0, it will go back, if it's \> 0, it will go forward by that amount of entries. | -| `triggerListeners?` | `boolean` | whether this should trigger listeners attached to the history | - -#### Returns - -`void` - -**`Example`** - -```js -myHistory.go(-1) // equivalent to window.history.back() -myHistory.go(1) // equivalent to window.history.forward() -``` - -___ - -### listen - -▸ **listen**(`callback`): () => `void` - -Attach a listener to the History implementation that is triggered when the -navigation is triggered from outside (like the Browser back and forward -buttons) or when passing `true` to RouterHistory.back and -RouterHistory.forward - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `callback` | `NavigationCallback` | listener to attach | - -#### Returns - -`fn` - -a callback to remove the listener - -▸ (): `void` - -##### Returns - -`void` - -___ - -### push - -▸ **push**(`to`, `data?`): `void` - -Navigates to a location. In the case of an HTML5 History implementation, -this will call `history.pushState` to effectively change the URL. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | `string` | location to push | -| `data?` | [`HistoryState`](HistoryState.md) | optional [HistoryState](HistoryState.md) to be associated with the navigation entry | - -#### Returns - -`void` - -___ - -### replace - -▸ **replace**(`to`, `data?`): `void` - -Same as [RouterHistory.push](RouterHistory.md#push) but performs a `history.replaceState` -instead of `history.pushState` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | `string` | location to set | -| `data?` | [`HistoryState`](HistoryState.md) | optional [HistoryState](HistoryState.md) to be associated with the navigation entry | - -#### Returns - -`void` diff --git a/packages/docs/api/interfaces/RouterLinkI.md b/packages/docs/api/interfaces/RouterLinkI.md deleted file mode 100644 index 2a047e345..000000000 --- a/packages/docs/api/interfaces/RouterLinkI.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / \_RouterLinkI - -# Interface: \_RouterLinkI - -Typed version of the `RouterLink` component. Its generic defaults to the typed router, so it can be inferred -automatically for JSX. - -## Constructors - -### constructor - -• **new _RouterLinkI**(): `Object` - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `$props` | `AllowedComponentProps` & `ComponentCustomProps` & `VNodeProps` & [`RouterLinkProps`](RouterLinkProps.md) | -| `$slots` | \{ `default?`: (`__namedParameters`: \{ `href`: `string` ; `isActive`: `boolean` ; `isExactActive`: `boolean` ; `route`: [`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) ; `navigate`: (`e?`: `MouseEvent`) => `Promise`\<`void` \| [`NavigationFailure`](NavigationFailure.md)\> }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\>[] } | -| `$slots.default?` | (`__namedParameters`: \{ `href`: `string` ; `isActive`: `boolean` ; `isExactActive`: `boolean` ; `route`: [`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md) ; `navigate`: (`e?`: `MouseEvent`) => `Promise`\<`void` \| [`NavigationFailure`](NavigationFailure.md)\> }) => `VNode`\<`RendererNode`, `RendererElement`, \{ `[key: string]`: `any`; }\>[] | - -## Properties - -### useLink - -• **useLink**: \(`props`: [`UseLinkOptions`](UseLinkOptions.md)\<`Name`\>) => [`UseLinkReturn`](UseLinkReturn.md)\<`Name`\> - -Access to `useLink()` without depending on using vue-router - -#### Type declaration - -▸ \<`Name`\>(`props`): [`UseLinkReturn`](UseLinkReturn.md)\<`Name`\> - -Access to `useLink()` without depending on using vue-router - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends `string` \| `symbol` = `string` \| `symbol` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `props` | [`UseLinkOptions`](UseLinkOptions.md)\<`Name`\> | - -##### Returns - -[`UseLinkReturn`](UseLinkReturn.md)\<`Name`\> diff --git a/packages/docs/api/interfaces/RouterLinkProps.md b/packages/docs/api/interfaces/RouterLinkProps.md deleted file mode 100644 index f046e51aa..000000000 --- a/packages/docs/api/interfaces/RouterLinkProps.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouterLinkProps - -# Interface: RouterLinkProps - -## Hierarchy - -- `RouterLinkOptions` - - ↳ **`RouterLinkProps`** - -## Properties - -### activeClass - -• `Optional` **activeClass**: `string` - -Class to apply when the link is active - -___ - -### ariaCurrentValue - -• `Optional` **ariaCurrentValue**: ``"time"`` \| ``"location"`` \| ``"page"`` \| ``"step"`` \| ``"date"`` \| ``"true"`` \| ``"false"`` - -Value passed to the attribute `aria-current` when the link is exact active. - -**`Default Value`** - -`'page'` - -___ - -### custom - -• `Optional` **custom**: `boolean` - -Whether RouterLink should not wrap its content in an `a` tag. Useful when -using `v-slot` to create a custom RouterLink - -___ - -### exactActiveClass - -• `Optional` **exactActiveClass**: `string` - -Class to apply when the link is exact active - -___ - -### replace - -• `Optional` **replace**: `boolean` - -Calls `router.replace` instead of `router.push`. - -#### Inherited from - -RouterLinkOptions.replace - -___ - -### to - -• **to**: `string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) - -Route Location the link should navigate to when clicked on. - -#### Inherited from - -RouterLinkOptions.to diff --git a/packages/docs/api/interfaces/RouterMatcher.md b/packages/docs/api/interfaces/RouterMatcher.md deleted file mode 100644 index bc18a13d0..000000000 --- a/packages/docs/api/interfaces/RouterMatcher.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouterMatcher - -# Interface: RouterMatcher - -Internal RouterMatcher - -## Properties - -### addRoute - -• **addRoute**: (`record`: [`RouteRecordRaw`](../index.md#RouteRecordRaw), `parent?`: `RouteRecordMatcher`) => () => `void` - -#### Type declaration - -▸ (`record`, `parent?`): () => `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `record` | [`RouteRecordRaw`](../index.md#RouteRecordRaw) | -| `parent?` | `RouteRecordMatcher` | - -##### Returns - -`fn` - -▸ (): `void` - -##### Returns - -`void` - -___ - -### clearRoutes - -• **clearRoutes**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -___ - -### getRecordMatcher - -• **getRecordMatcher**: (`name`: `NonNullable`\<[`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric)\>) => `undefined` \| `RouteRecordMatcher` - -#### Type declaration - -▸ (`name`): `undefined` \| `RouteRecordMatcher` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `NonNullable`\<[`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric)\> | - -##### Returns - -`undefined` \| `RouteRecordMatcher` - -___ - -### getRoutes - -• **getRoutes**: () => `RouteRecordMatcher`[] - -#### Type declaration - -▸ (): `RouteRecordMatcher`[] - -##### Returns - -`RouteRecordMatcher`[] - -___ - -### resolve - -• **resolve**: (`location`: `MatcherLocationRaw`, `currentLocation`: [`MatcherLocation`](MatcherLocation.md)) => [`MatcherLocation`](MatcherLocation.md) - -Resolves a location. Gives access to the route record that corresponds to the actual path as well as filling the corresponding params objects - -**`Param`** - -MatcherLocationRaw to resolve to a url - -**`Param`** - -MatcherLocation of the current location - -#### Type declaration - -▸ (`location`, `currentLocation`): [`MatcherLocation`](MatcherLocation.md) - -Resolves a location. Gives access to the route record that corresponds to the actual path as well as filling the corresponding params objects - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `location` | `MatcherLocationRaw` | MatcherLocationRaw to resolve to a url | -| `currentLocation` | [`MatcherLocation`](MatcherLocation.md) | MatcherLocation of the current location | - -##### Returns - -[`MatcherLocation`](MatcherLocation.md) - -## Methods - -### removeRoute - -▸ **removeRoute**(`matcher`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `matcher` | `RouteRecordMatcher` | - -#### Returns - -`void` - -▸ **removeRoute**(`name`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `NonNullable`\<[`RouteRecordNameGeneric`](../index.md#RouteRecordNameGeneric)\> | - -#### Returns - -`void` diff --git a/packages/docs/api/interfaces/RouterOptions.md b/packages/docs/api/interfaces/RouterOptions.md deleted file mode 100644 index f431256df..000000000 --- a/packages/docs/api/interfaces/RouterOptions.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouterOptions - -# Interface: RouterOptions - -Options to initialize a [Router](Router.md) instance. - -## Hierarchy - -- [`PathParserOptions`](../index.md#PathParserOptions) - - ↳ **`RouterOptions`** - -## Properties - -### end - -• `Optional` **end**: `boolean` - -Should the RegExp match until the end by appending a `$` to it. - -**`Default Value`** - -`true` - -#### Inherited from - -PathParserOptions.end - -___ - -### history - -• **history**: [`RouterHistory`](RouterHistory.md) - -History implementation used by the router. Most web applications should use -`createWebHistory` but it requires the server to be properly configured. -You can also use a _hash_ based history with `createWebHashHistory` that -does not require any configuration on the server but isn't handled at all -by search engines and does poorly on SEO. - -**`Example`** - -```js -createRouter({ - history: createWebHistory(), - // other options... -}) -``` - -___ - -### linkActiveClass - -• `Optional` **linkActiveClass**: `string` - -Default class applied to active [RouterLink](../index.md#RouterLink). If none is provided, -`router-link-active` will be applied. - -___ - -### linkExactActiveClass - -• `Optional` **linkExactActiveClass**: `string` - -Default class applied to exact active [RouterLink](../index.md#RouterLink). If none is provided, -`router-link-exact-active` will be applied. - -___ - -### parseQuery - -• `Optional` **parseQuery**: (`search`: `string`) => [`LocationQuery`](../index.md#LocationQuery) - -Custom implementation to parse a query. See its counterpart, -[RouterOptions.stringifyQuery](RouterOptions.md#stringifyQuery). - -**`Example`** - -Let's say you want to use the [qs package](https://github.com/ljharb/qs) -to parse queries, you can provide both `parseQuery` and `stringifyQuery`: -```js -import qs from 'qs' - -createRouter({ - // other options... - parseQuery: qs.parse, - stringifyQuery: qs.stringify, -}) -``` - -#### Type declaration - -▸ (`search`): [`LocationQuery`](../index.md#LocationQuery) - -Custom implementation to parse a query. See its counterpart, -[RouterOptions.stringifyQuery](RouterOptions.md#stringifyQuery). - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `search` | `string` | - -##### Returns - -[`LocationQuery`](../index.md#LocationQuery) - -**`Example`** - -Let's say you want to use the [qs package](https://github.com/ljharb/qs) -to parse queries, you can provide both `parseQuery` and `stringifyQuery`: -```js -import qs from 'qs' - -createRouter({ - // other options... - parseQuery: qs.parse, - stringifyQuery: qs.stringify, -}) -``` - -___ - -### routes - -• **routes**: readonly [`RouteRecordRaw`](../index.md#RouteRecordRaw)[] - -Initial list of routes that should be added to the router. - -___ - -### scrollBehavior - -• `Optional` **scrollBehavior**: [`RouterScrollBehavior`](RouterScrollBehavior.md) - -Function to control scrolling when navigating between pages. Can return a -Promise to delay scrolling. Check ScrollBehavior. - -**`Example`** - -```js -function scrollBehavior(to, from, savedPosition) { - // `to` and `from` are both route locations - // `savedPosition` can be null if there isn't one -} -``` - -___ - -### sensitive - -• `Optional` **sensitive**: `boolean` - -Makes the RegExp case-sensitive. - -**`Default Value`** - -`false` - -#### Inherited from - -PathParserOptions.sensitive - -___ - -### strict - -• `Optional` **strict**: `boolean` - -Whether to disallow a trailing slash or not. - -**`Default Value`** - -`false` - -#### Inherited from - -PathParserOptions.strict - -___ - -### stringifyQuery - -• `Optional` **stringifyQuery**: (`query`: [`LocationQueryRaw`](../index.md#LocationQueryRaw)) => `string` - -Custom implementation to stringify a query object. Should not prepend a leading `?`. -[parseQuery](RouterOptions.md#parseQuery) counterpart to handle query parsing. - -#### Type declaration - -▸ (`query`): `string` - -Custom implementation to stringify a query object. Should not prepend a leading `?`. -[parseQuery](RouterOptions.md#parseQuery) counterpart to handle query parsing. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `query` | [`LocationQueryRaw`](../index.md#LocationQueryRaw) | - -##### Returns - -`string` diff --git a/packages/docs/api/interfaces/RouterScrollBehavior.md b/packages/docs/api/interfaces/RouterScrollBehavior.md deleted file mode 100644 index 802e5e5f7..000000000 --- a/packages/docs/api/interfaces/RouterScrollBehavior.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouterScrollBehavior - -# Interface: RouterScrollBehavior - -Type of the `scrollBehavior` option that can be passed to `createRouter`. - -## Callable - -### RouterScrollBehavior - -▸ **RouterScrollBehavior**(`to`, `from`, `savedPosition`): `Awaitable`\<``false`` \| `void` \| `ScrollPosition`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) | Route location where we are navigating to | -| `from` | [`RouteLocationNormalizedLoadedGeneric`](RouteLocationNormalizedLoadedGeneric.md) | Route location where we are navigating from | -| `savedPosition` | ``null`` \| `_ScrollPositionNormalized` | saved position if it exists, `null` otherwise | - -#### Returns - -`Awaitable`\<``false`` \| `void` \| `ScrollPosition`\> diff --git a/packages/docs/api/interfaces/RouterViewProps.md b/packages/docs/api/interfaces/RouterViewProps.md deleted file mode 100644 index af5477d4e..000000000 --- a/packages/docs/api/interfaces/RouterViewProps.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / RouterViewProps - -# Interface: RouterViewProps - -## Properties - -### name - -• `Optional` **name**: `string` - -___ - -### route - -• `Optional` **route**: [`RouteLocationNormalizedGeneric`](RouteLocationNormalizedGeneric.md) diff --git a/packages/docs/api/interfaces/TypesConfig.md b/packages/docs/api/interfaces/TypesConfig.md deleted file mode 100644 index 09961cd04..000000000 --- a/packages/docs/api/interfaces/TypesConfig.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / TypesConfig - -# Interface: TypesConfig - -Allows customizing existing types of the router that are used globally like `$router`, ``, etc. **ONLY FOR INTERNAL USAGE**. - -- `$router` - the router instance -- `$route` - the current route location -- `beforeRouteEnter` - Page component option -- `beforeRouteUpdate` - Page component option -- `beforeRouteLeave` - Page component option -- `RouterLink` - RouterLink Component -- `RouterView` - RouterView Component diff --git a/packages/docs/api/interfaces/UseLinkOptions.md b/packages/docs/api/interfaces/UseLinkOptions.md deleted file mode 100644 index 3db657f34..000000000 --- a/packages/docs/api/interfaces/UseLinkOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / UseLinkOptions - -# Interface: UseLinkOptions\ - -Options passed to [useLink](../index.md#useLink). - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](../index.md#RouteMap) = keyof [`RouteMap`](../index.md#RouteMap) | - -## Properties - -### replace - -• `Optional` **replace**: `MaybeRef`\<`undefined` \| `boolean`\> - -___ - -### to - -• **to**: `MaybeRef`\<`string` \| [`RouteLocationAsRelativeGeneric`](RouteLocationAsRelativeGeneric.md) \| [`RouteLocationAsPathGeneric`](RouteLocationAsPathGeneric.md) \| [`RouteLocationAsRelativeTyped`](RouteLocationAsRelativeTyped.md)\<[`RouteMapGeneric`](../index.md#RouteMapGeneric), `Name`\>\> diff --git a/packages/docs/api/interfaces/UseLinkReturn.md b/packages/docs/api/interfaces/UseLinkReturn.md deleted file mode 100644 index 533fd8bd1..000000000 --- a/packages/docs/api/interfaces/UseLinkReturn.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -editLink: false ---- - -[API Documentation](../index.md) / UseLinkReturn - -# Interface: UseLinkReturn\ - -Return type of [useLink](../index.md#useLink). - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Name` | extends keyof [`RouteMap`](../index.md#RouteMap) = keyof [`RouteMap`](../index.md#RouteMap) | - -## Properties - -### href - -• **href**: `ComputedRef`\<`string`\> - -___ - -### isActive - -• **isActive**: `ComputedRef`\<`boolean`\> - -___ - -### isExactActive - -• **isExactActive**: `ComputedRef`\<`boolean`\> - -___ - -### route - -• **route**: `ComputedRef`\<[`RouteLocationResolvedGeneric`](RouteLocationResolvedGeneric.md)\> - -## Methods - -### navigate - -▸ **navigate**(`e?`): `Promise`\<`void` \| [`NavigationFailure`](NavigationFailure.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `MouseEvent` | - -#### Returns - -`Promise`\<`void` \| [`NavigationFailure`](NavigationFailure.md)\>