@kitbag/router 0.22.2 → 0.22.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/compositions/useQueryValue.d.ts +1 -1
- package/dist/compositions/useRoute.d.ts +2 -4
- package/dist/compositions/useRoute.spec-d.d.ts +1 -0
- package/dist/guards/routes.d.ts +1 -1
- package/dist/kitbag-router.js +1537 -1517
- package/dist/kitbag-router.umd.cjs +3 -3
- package/dist/services/combineHash.d.ts +4 -3
- package/dist/services/combinePath.d.ts +8 -12
- package/dist/services/combineQuery.d.ts +8 -12
- package/dist/services/combineUrl.d.ts +2 -1
- package/dist/services/createRouteHooks.d.ts +2 -1
- package/dist/services/createRouterCallbackContext.d.ts +2 -29
- package/dist/services/createRouterHistory.d.ts +1 -1
- package/dist/services/createRouterReject.d.ts +2 -2
- package/dist/services/createVueAppStore.d.ts +2 -1
- package/dist/services/getParamsForString.d.ts +2 -1
- package/dist/services/params.d.ts +5 -4
- package/dist/services/paramsFinder.d.ts +3 -3
- package/dist/services/routeRegex.d.ts +2 -5
- package/dist/services/urlParser.d.ts +3 -2
- package/dist/services/withParams.d.ts +65 -10
- package/dist/types/createRouteOptions.d.ts +5 -5
- package/dist/types/params.d.ts +2 -7
- package/dist/types/url.d.ts +11 -17
- package/dist/types/utilities.d.ts +0 -1
- package/dist/utilities/array.d.ts +0 -1
- package/dist/utilities/testHelpers.d.ts +246 -90
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ Type safe router for Vue.js
|
|
|
20
20
|
|
|
21
21
|
## Getting Started
|
|
22
22
|
|
|
23
|
-
Get Started with our [documentation](https://kitbag-router.netlify.app/)
|
|
23
|
+
Get Started with our [documentation](https://kitbag-router.netlify.app/).
|
|
24
24
|
|
|
25
25
|
## Installation
|
|
26
26
|
|
|
@@ -2,7 +2,7 @@ import { Ref, MaybeRefOrGetter, InjectionKey } from 'vue';
|
|
|
2
2
|
import { Router } from '../types/router';
|
|
3
3
|
import { Param } from '../types/paramTypes';
|
|
4
4
|
import { ExtractParamType } from '../types/params';
|
|
5
|
-
|
|
5
|
+
type UseQueryValue<T> = {
|
|
6
6
|
value: Ref<T | null>;
|
|
7
7
|
values: Ref<T[]>;
|
|
8
8
|
remove: () => void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { InjectionKey } from 'vue';
|
|
2
|
-
import { IsRouteOptions } from '../guards/routes';
|
|
2
|
+
import { IsRouteOptions, RouteWithMatch } from '../guards/routes';
|
|
3
3
|
import { Router, RouterRouteName } from '../types/router';
|
|
4
4
|
type UseRouteFunction<TRouter extends Router> = {
|
|
5
5
|
(): TRouter['route'];
|
|
@@ -8,9 +8,7 @@ type UseRouteFunction<TRouter extends Router> = {
|
|
|
8
8
|
}): TRouter['route'] & {
|
|
9
9
|
name: TRouteName;
|
|
10
10
|
};
|
|
11
|
-
<TRouteName extends RouterRouteName<TRouter>>(routeName: TRouteName, options?: IsRouteOptions): TRouter['route']
|
|
12
|
-
name: `${TRouteName}${string}`;
|
|
13
|
-
};
|
|
11
|
+
<TRouteName extends RouterRouteName<TRouter>>(routeName: TRouteName, options?: IsRouteOptions): RouteWithMatch<TRouter['route'], TRouteName>;
|
|
14
12
|
};
|
|
15
13
|
export declare function createUseRoute<TRouter extends Router>(routerKey: InjectionKey<TRouter>): UseRouteFunction<TRouter>;
|
|
16
14
|
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/guards/routes.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import { InjectionKey } from 'vue';
|
|
|
4
4
|
export type IsRouteOptions = {
|
|
5
5
|
exact?: boolean;
|
|
6
6
|
};
|
|
7
|
-
type RouteWithMatch<TRoute extends RouterRoute, TRouteName extends TRoute['name']> = TRoute extends RouterRoute ? TRouteName extends TRoute['matches'][number]['name'] ? TRoute : never : never;
|
|
7
|
+
export type RouteWithMatch<TRoute extends RouterRoute, TRouteName extends TRoute['name']> = TRoute extends RouterRoute ? TRouteName extends TRoute['matches'][number]['name'] ? TRoute : never : never;
|
|
8
8
|
type IsRouteFunction<TRouter extends Router> = {
|
|
9
9
|
/**
|
|
10
10
|
* A type guard for determining if a value is a valid RouterRoute.
|