expo-router/build/global-state/types.d.ts

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

import type { RedirectConfig } from '../getRoutesCore';
import type { NavigationState, PartialState, useStateForPath } from '../react-navigation/native';
import type { SingularOptions } from '../useScreens';
export type StoreRedirects = readonly [RegExp, RedirectConfig, boolean];
export type ReactNavigationState = NavigationState | PartialState<NavigationState>;
export type FocusedRouteState = NonNullable<ReturnType<typeof useStateForPath>>;
export type LinkToOptions = {
    event?: string;
    /**
     * Opts this operation into or out of React transitions. Every operation in a queued batch must
     * allow transitions for the batch to use one.
     *
     * @experimental
     */
    inTransition?: boolean;
    /**
     * Relative URL references are either relative to the directory or the document. By default, relative paths are relative to the document.
     * @see: [MDN's documentation on Resolving relative references to a URL](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references).
     */
    relativeToDirectory?: boolean;
    /**
     * Include the anchor when navigating to a new navigator
     */
    withAnchor?: boolean;
    /**
     * When navigating in a Stack, remove all screen from the history that match the singular condition
     *
     * If used with `push`, the history will be filtered even if no navigation occurs.
     */
    dangerouslySingular?: SingularOptions;
    __internal__PreviewKey?: string;
    __internal__previewId?: string;
    __internal__popToNavigator?: boolean;
};
export type NavigationOptions = Omit<LinkToOptions, 'event' | '__internal__popToNavigator'>;
export type TransitionOptions = Pick<LinkToOptions, 'inTransition'>;
export type NavigationTransitionMode = 'always' | 'never' | 'preload-only';