next
Version:
The React Framework
93 lines (92 loc) • 3.8 kB
TypeScript
import type { StackFrame } from 'next/dist/compiled/stacktrace-parser';
import type { VersionInfo } from '../../../server/dev/parse-version-info';
import type { SupportedErrorEvent } from './ui/container/runtime-error/render-error';
import type { ComponentStackFrame } from './utils/parse-component-stack';
import type { DebugInfo } from './types';
import type { DevIndicatorServerState } from '../../../server/dev/dev-indicator-server-state';
import type { HMR_ACTION_TYPES } from '../../../server/dev/hot-reloader-types';
type FastRefreshState =
/** No refresh in progress. */
{
type: 'idle';
}
/** The refresh process has been triggered, but the new code has not been executed yet. */
| {
type: 'pending';
errors: SupportedErrorEvent[];
};
export interface OverlayState {
nextId: number;
buildError: string | null;
errors: SupportedErrorEvent[];
refreshState: FastRefreshState;
versionInfo: VersionInfo;
notFound: boolean;
staticIndicator: boolean;
showIndicator: boolean;
disableDevIndicator: boolean;
debugInfo: DebugInfo;
routerType: 'pages' | 'app';
}
export declare const ACTION_STATIC_INDICATOR = "static-indicator";
export declare const ACTION_BUILD_OK = "build-ok";
export declare const ACTION_BUILD_ERROR = "build-error";
export declare const ACTION_BEFORE_REFRESH = "before-fast-refresh";
export declare const ACTION_REFRESH = "fast-refresh";
export declare const ACTION_VERSION_INFO = "version-info";
export declare const ACTION_UNHANDLED_ERROR = "unhandled-error";
export declare const ACTION_UNHANDLED_REJECTION = "unhandled-rejection";
export declare const ACTION_DEBUG_INFO = "debug-info";
export declare const ACTION_DEV_INDICATOR = "dev-indicator";
export declare const STORAGE_KEY_THEME = "__nextjs-dev-tools-theme";
export declare const STORAGE_KEY_POSITION = "__nextjs-dev-tools-position";
export declare const STORAGE_KEY_SCALE = "__nextjs-dev-tools-scale";
interface StaticIndicatorAction {
type: typeof ACTION_STATIC_INDICATOR;
staticIndicator: boolean;
}
interface BuildOkAction {
type: typeof ACTION_BUILD_OK;
}
interface BuildErrorAction {
type: typeof ACTION_BUILD_ERROR;
message: string;
}
interface BeforeFastRefreshAction {
type: typeof ACTION_BEFORE_REFRESH;
}
interface FastRefreshAction {
type: typeof ACTION_REFRESH;
}
export interface UnhandledErrorAction {
type: typeof ACTION_UNHANDLED_ERROR;
reason: Error;
frames: StackFrame[];
componentStackFrames?: ComponentStackFrame[];
}
export interface UnhandledRejectionAction {
type: typeof ACTION_UNHANDLED_REJECTION;
reason: Error;
frames: StackFrame[];
}
export interface DebugInfoAction {
type: typeof ACTION_DEBUG_INFO;
debugInfo: any;
}
interface VersionInfoAction {
type: typeof ACTION_VERSION_INFO;
versionInfo: VersionInfo;
}
interface DevIndicatorAction {
type: typeof ACTION_DEV_INDICATOR;
devIndicator: DevIndicatorServerState;
}
export type BusEvent = BuildOkAction | BuildErrorAction | BeforeFastRefreshAction | FastRefreshAction | UnhandledErrorAction | UnhandledRejectionAction | VersionInfoAction | StaticIndicatorAction | DebugInfoAction | DevIndicatorAction;
export declare const INITIAL_OVERLAY_STATE: Omit<OverlayState, 'routerType'>;
export declare function useErrorOverlayReducer(routerType: 'pages' | 'app'): [OverlayState & {
routerType: "pages" | "app";
}, import("react").ActionDispatch<[action: BusEvent]>];
export declare const REACT_REFRESH_FULL_RELOAD: string;
export declare const REACT_REFRESH_FULL_RELOAD_FROM_ERROR = "[Fast Refresh] performing full reload because your application had an unrecoverable error";
export declare function reportInvalidHmrMessage(message: HMR_ACTION_TYPES | MessageEvent<unknown>, err: unknown): void;
export {};