66 lines
3.8 KiB
Plaintext
66 lines
3.8 KiB
Plaintext
import { FromPathOption, NavigateOptions, PathParamOptions, SearchParamOptions, ToPathOption } from './link.js';
|
|
import { Redirect } from './redirect.js';
|
|
import { RouteIds } from './routeInfo.js';
|
|
import { AnyRouter, RegisteredRouter } from './router.js';
|
|
import { UseParamsResult } from './useParams.js';
|
|
import { UseSearchResult } from './useSearch.js';
|
|
import { Constrain, ConstrainLiteral } from './utils.js';
|
|
export type ValidateFromPath<TRouter extends AnyRouter = RegisteredRouter, TFrom = string> = FromPathOption<TRouter, TFrom>;
|
|
export type ValidateToPath<TRouter extends AnyRouter = RegisteredRouter, TTo extends string | undefined = undefined, TFrom extends string = string> = ToPathOption<TRouter, TFrom, TTo>;
|
|
export type ValidateSearch<TRouter extends AnyRouter = RegisteredRouter, TTo extends string | undefined = undefined, TFrom extends string = string> = SearchParamOptions<TRouter, TFrom, TTo>;
|
|
export type ValidateParams<TRouter extends AnyRouter = RegisteredRouter, TTo extends string | undefined = undefined, TFrom extends string = string> = PathParamOptions<TRouter, TFrom, TTo>;
|
|
/**
|
|
* @internal
|
|
*/
|
|
export type InferFrom<TOptions, TDefaultFrom extends string = string> = TOptions extends {
|
|
from: infer TFrom extends string;
|
|
} ? TFrom : TDefaultFrom;
|
|
/**
|
|
* @internal
|
|
*/
|
|
export type InferTo<TOptions> = TOptions extends {
|
|
to: infer TTo extends string;
|
|
} ? TTo : undefined;
|
|
/**
|
|
* @internal
|
|
*/
|
|
export type InferMaskTo<TOptions> = TOptions extends {
|
|
mask: {
|
|
to: infer TTo extends string;
|
|
};
|
|
} ? TTo : '';
|
|
export type InferMaskFrom<TOptions> = TOptions extends {
|
|
mask: {
|
|
from: infer TFrom extends string;
|
|
};
|
|
} ? TFrom : string;
|
|
export type ValidateNavigateOptions<TRouter extends AnyRouter = RegisteredRouter, TOptions = unknown, TDefaultFrom extends string = string> = Constrain<TOptions, NavigateOptions<TRouter, InferFrom<TOptions, TDefaultFrom>, InferTo<TOptions>, InferMaskFrom<TOptions>, InferMaskTo<TOptions>>>;
|
|
export type ValidateNavigateOptionsArray<TRouter extends AnyRouter = RegisteredRouter, TOptions extends ReadonlyArray<any> = ReadonlyArray<unknown>, TDefaultFrom extends string = string> = {
|
|
[K in keyof TOptions]: ValidateNavigateOptions<TRouter, TOptions[K], TDefaultFrom>;
|
|
};
|
|
export type ValidateRedirectOptions<TRouter extends AnyRouter = RegisteredRouter, TOptions = unknown, TDefaultFrom extends string = string> = Constrain<TOptions, Redirect<TRouter, InferFrom<TOptions, TDefaultFrom>, InferTo<TOptions>, InferMaskFrom<TOptions>, InferMaskTo<TOptions>>>;
|
|
export type ValidateRedirectOptionsArray<TRouter extends AnyRouter = RegisteredRouter, TOptions extends ReadonlyArray<any> = ReadonlyArray<unknown>, TDefaultFrom extends string = string> = {
|
|
[K in keyof TOptions]: ValidateRedirectOptions<TRouter, TOptions[K], TDefaultFrom>;
|
|
};
|
|
export type ValidateId<TRouter extends AnyRouter = RegisteredRouter, TId extends string = string> = ConstrainLiteral<TId, RouteIds<TRouter['routeTree']>>;
|
|
/**
|
|
* @internal
|
|
*/
|
|
export type InferStrict<TOptions> = TOptions extends {
|
|
strict: infer TStrict extends boolean;
|
|
} ? TStrict : true;
|
|
/**
|
|
* @internal
|
|
*/
|
|
export type InferShouldThrow<TOptions> = TOptions extends {
|
|
shouldThrow: infer TShouldThrow extends boolean;
|
|
} ? TShouldThrow : true;
|
|
/**
|
|
* @internal
|
|
*/
|
|
export type InferSelected<TOptions> = TOptions extends {
|
|
select: (...args: Array<any>) => infer TSelected;
|
|
} ? TSelected : unknown;
|
|
export type ValidateUseSearchResult<TOptions, TRouter extends AnyRouter = RegisteredRouter> = UseSearchResult<TRouter, InferFrom<TOptions>, InferStrict<TOptions>, InferSelected<TOptions>>;
|
|
export type ValidateUseParamsResult<TOptions, TRouter extends AnyRouter = RegisteredRouter> = Constrain<TOptions, UseParamsResult<TRouter, InferFrom<TOptions>, InferStrict<TOptions>, InferSelected<TOptions>>>;
|