expo-router/build/typed-routes/types.d.ts

Expo Router is a file-based router for React Native and web applications.

/**
 * The main routing type for Expo Router.
 *
 * @internal
 * @hidden
 */
export declare namespace ExpoRouter {
    interface __routes {
    }
}
export type HrefObject = {
    /** The path of the route. */
    pathname: string;
    /** Optional parameters for the route. */
    params?: UnknownInputParams;
};
/**
 * @hidden
 */
export type HrefInputParamsObject = {
    /** The path of the route. */
    pathname: string;
    /** Optional input parameters for the route. */
    params?: UnknownInputParams;
};
/**
 * @hidden
 */
export type HrefOutputParamsObject = {
    /** The path of the route */
    pathname: string;
    /** Optional output parameters for the route */
    params?: UnknownOutputParams;
};
export type RelativePathString = `./${string}` | `../${string}` | '..';
export type SearchOrHash = `?${string}` | `#${string}`;
export type ExternalPathString = `${string}:${string}` | `//${string}`;
export type RoutePath = Exclude<Extract<Href, object>['pathname'], // Use the HrefObject, as it doesn't have query params
// Use the HrefObject, as it doesn't have query params
RelativePathString | ExternalPathString>;
/**
 * The main routing type for Expo Router. It includes all available routes with strongly
 * typed parameters. It can either be:
 * - **string**: A full path like `/profile/settings` or a relative path like `../settings`.
 * - **object**: An object with a `pathname` and optional `params`. The `pathname` can be
 * a full path like `/profile/settings` or a relative path like `../settings`.
 * The params can be an object of key-value pairs.
 *
 * An Href can either be a string or an object.
 */
export type Href<T extends ExpoRouter.__routes = ExpoRouter.__routes> = T extends {
    href: any;
} ? T['href'] : string | HrefObject;
export type HrefInputParams<T extends ExpoRouter.__routes = ExpoRouter.__routes> = T extends {
    hrefInputParams: any;
} ? T['hrefInputParams'] : HrefInputParamsObject;
export type HrefOutputParams<T extends ExpoRouter.__routes = ExpoRouter.__routes> = T extends {
    hrefOutputParams: any;
} ? T['hrefOutputParams'] : HrefOutputParamsObject;
/**
 * @hidden
 */
export type RouteInputParams<T> = HrefInputParams extends infer U ? U extends {
    pathname: string;
    params?: infer Params;
} ? T extends U['pathname'] ? Params : never : never : never;
/**
 * @hidden
 */
export type RouteOutputParams<T> = HrefOutputParams extends infer U ? U extends {
    pathname: string;
    params?: infer Params;
} ? T extends U['pathname'] ? Params : never : never : never;
export type { RouteOutputParams as RouteParams };
/**
 * Routes can have known inputs (e.g query params).
 * Unlike outputs, inputs can be `undefined` or `null`.
 *
 * @hidden
 */
export type UnknownInputParams = Record<string, string | number | undefined | null | (string | number)[]>;
/**
 * Routes can have unknown outputs (e.g query params).
 * Unlike inputs, outputs can't be `null`.
 *
 * @hidden
 */
export type UnknownOutputParams = Record<string, string | string[] | undefined>;
/**
 * Return only the RoutePart of a string. If the string has multiple parts return never
 *
 * string   | type
 *| ---------|------|
 *| 123      | 123 |
 *| /123/abc | never |
 *| 123?abc  | never |
 *| ./123    | never |
 *| /123     | never |
 *| 123/../  | never |
 *
 * @hidden
 */
export type SingleRoutePart<S extends string | object> = S extends object ? never : S extends `${string}/${string}` ? never : S extends `${string}${SearchOrHash}` ? never : S extends '' ? never : S extends `(${string})` ? never : S extends `[${string}]` ? never : S;
/**
 * @hidden
 */
export type RouteSegments<HrefOrSegments> = HrefOrSegments extends string[] ? HrefOrSegments : HrefOrSegments extends `.${string}` ? never : HrefOrSegments extends `` ? never : HrefOrSegments extends `/${infer PartA}` ? RouteSegments<PartA> : HrefOrSegments extends `${infer PartA}?${string}` ? RouteSegments<PartA> : HrefOrSegments extends `${infer PartA}#${string}` ? RouteSegments<PartA> : HrefOrSegments extends `${infer PartA}/${infer PartB}` ? [PartA, ...RouteSegments<PartB>] : [HrefOrSegments];