Class Router

constructor

• new Router(options: RouterOptions): Router

  Create a browser session without downloading the engine.

  Parameters

  • options: RouterOptions

    Dataset, transport, memory, lifecycle and asset settings.

  Returns Router

  Remarks

  Requires a browser location. Call initialize or route to start.

Readonlyoptions

Optionalstartup

cancel

• cancel(): void

  Reject all outstanding operations with CANCELLED, terminate the worker, and discard its memory cache. The Router remains reusable.

  Returns void

diagnostics

• diagnostics(): Promise<Diagnostics>

  Read cumulative tile/cache/heap diagnostics, initializing lazily if necessary. Queues behind active routing. Traces include tile URLs and IDs.

  Returns Promise<Diagnostics>

dispose

• dispose(): Promise<void>

  Permanently close this session, terminate its worker, and reject outstanding operations.

  Returns Promise<void>

initialize

• initialize(): Promise<StartupResult>

  Load the runtime and pinned dataset metadata. Concurrent calls share startup.

  Returns Promise<StartupResult>

  Initialization timings and dataset/native identity.

  Throws

  RoutingError for asset, dataset, network, cancellation or disposed-session failures.

  Remarks

  A failed initialization can be retried on the same Router. An opaque browser worker-load failure or WASM initialization timeout gets at most one shared startup retry in a fresh worker, unless retries is zero or a custom workerFactory is used. Native routing operations are never replayed. Cancellation also stops this startup recovery.

route

• route(
      request: RouteRequest,
      __namedParameters?: { signal?: AbortSignal },
  ): Promise<RouteResult>

  Calculate a road route with the selected profile, initializing lazily and queuing behind other native operations.

  Parameters

  • request: RouteRequest

    Start/end coordinates and the optional profile and matching settings.

  • __namedParameters: { signal?: AbortSignal } = {}

  Returns Promise<RouteResult>

  Complete native JSON, dataset identity and per-route measurements.

  Throws

  RoutingError for invalid input, coverage/no-route, transport or lifecycle failures.

  Remarks

  Aborting the signal terminates the worker and rejects all pending operations, including other queued routes. A subsequent route starts a new worker with an empty cache.