Skip to content

Interface: RouteWatcherHandle

API / @xmachines/play-router / RouteWatcherHandle

Defined in: router-bridge-base.ts:70

Narrow interface for the TC39 Signal watcher used by RouterBridgeBase to monitor actor.currentRoute changes.

This interface hides the full Signal.subtle.Watcher surface and exposes only the two operations that RouterBridgeBase actually needs:

  • watch(signal) — arm the watcher on a specific signal
  • unwatch() — stop watching and release resources

Framework adapter subclasses never interact with this handle directly; it is created and managed internally by RouterBridgeBase.

Methods

unwatch()

unwatch(): void;

Defined in: router-bridge-base.ts:74

Stop observing and release the watcher.

Returns

void


watch()

watch(signal): void;

Defined in: router-bridge-base.ts:72

Arm the watcher to observe the given signal.

Parameters

ParameterType
signalComputed<string | null>

Returns

void