import * as React from 'react'; import { type NavigationAction, type NavigationState, type ParamListBase, type Router } from '../routers'; import { type NavigationHelpers, PrivateValueStore } from './types'; import type { NavigationEventEmitter } from './useEventEmitter'; type Options = { id: string | undefined; onAction: (action: NavigationAction) => boolean; onUnhandledAction: (action: NavigationAction) => void; getState: () => State; emitter: NavigationEventEmitter; router: Router; stateRef: React.RefObject; }; /** * Navigation object with helper methods to be used by a navigator. * This object includes methods for common actions as well as methods the parent screen's navigation object. */ export declare function useNavigationHelpers void>, Action extends NavigationAction, EventMap extends Record>({ id: navigatorId, onAction, onUnhandledAction, getState, emitter, router, stateRef, }: Options): { dispatch(action: Readonly<{ type: string; payload?: object; source?: string; target?: string; }> | ((state: Readonly[]; type: string; stale: false; }>>) => Readonly<{ type: string; payload?: object; source?: string; target?: string; }>)): void; navigate(...args: RouteName extends unknown ? [screen: RouteName, params?: object | undefined, options?: { merge?: boolean; pop?: boolean; } | undefined] : never): void; navigate(options: RouteName extends unknown ? { name: RouteName; params: object | undefined; path?: string; merge?: boolean; pop?: boolean; } : never): void; navigateDeprecated(...args: RouteName extends unknown ? [screen: RouteName, params?: object | undefined] : never): void; navigateDeprecated(options: RouteName extends unknown ? { name: RouteName; params: object | undefined; merge?: boolean; } : never): void; preload(...args: RouteName extends unknown ? [screen: RouteName, params?: object | undefined] : never): void; reset(state: Readonly<{ key: string; index: number; routeNames: string[]; history?: unknown[]; routes: import(".").NavigationRoute[]; type: string; stale: false; }> | import(".").PartialState[]; type: string; stale: false; }>>): void; goBack(): void; isFocused(): boolean; canGoBack(): boolean; getId(): string | undefined; getParent | undefined>(id?: string): T; getState(): Readonly<{ key: string; index: number; routeNames: string[]; history?: unknown[]; routes: import(".").NavigationRoute[]; type: string; stale: false; }>; } & PrivateValueStore<[ParamListBase, unknown, unknown]> & import("./types").EventEmitter & { setParams(params: Partial): void; replaceParams(params: object | undefined): void; } & ActionHelpers; export {}; //# sourceMappingURL=useNavigationHelpers.d.ts.map