@real-router/types

TypeScript type definitions for Real-Router ecosystem. Provides shared types used by all @real-router/* packages.

Installation

This package is automatically installed as a dependency of @real-router/core. Direct installation is only needed for advanced use cases.

npm install @real-router/types

Usage

// Most users should import types from @real-router/core
import type { Router, State, Params } from "@real-router/core";

// Direct import is available for type-only scenarios
import type { State, Params, NavigationOptions } from "@real-router/types";

Why This Package?

This package solves TypeScript type compatibility issues between @real-router/* packages:

• Single source of truth — all packages share identical type definitions
• No type duplication — types are not inlined into each package's .d.ts
• Module augmentation works — plugins can extend Router interface correctly

Related Packages

• @real-router/core — Core router
• @real-router/react — React bindings
• @real-router/browser-plugin — Browser History API

License

MIT © Oleg Ivanov