Interface: WindowLike

API / @xmachines/play-router / WindowLike

Defined in: types.ts:394

Minimal window interface required by adapters that subscribe to DOM events (e.g. hashchange). Injectable for SSR and testing — pass a mock instead of the global window when the DOM is unavailable.

Defined structurally (no Window reference) so this package compiles without the DOM lib.

Example

// Normal usage — global window (default)
connectRouter({ actor, routeMap });

// SSR / test — injected mock
const mockWin: WindowLike = { addEventListener: vi.fn(), removeEventListener: vi.fn() };
connectRouter({ actor, routeMap, window: mockWin });

Methods

addEventListener()

addEventListener(type, listener): void;

Defined in: types.ts:395

Parameters

Parameter	Type
type	string
listener	(event) => void

Returns

void

---

removeEventListener()

removeEventListener(type, listener): void;

Defined in: types.ts:396

Parameters

Parameter	Type
type	string
listener	(event) => void

Returns

void