Function destroyDetachedRouteHandle

packages/router/src/route_reuse_strategy.ts:48–59

(handle: DetachedRouteHandle)

 * @see [Manually destroying detached route handles](guide/routing/customizing-route-behavior#manually-destroying-detached-route-handles)
 */
export function destroyDetachedRouteHandle(handle: DetachedRouteHandle): void {
  const internalHandle = handle as DetachedRouteHandleInternal;
  if (internalHandle && internalHandle.componentRef) {
    internalHandle.componentRef.destroy();
    // It is critical to destroy the `_localInjector` here. When a route is detached
    // by the `RouteReuseStrategy`, the `_localInjector` is retained because the
    // ActivatedRoute object is stored and can be attached later.
    // When the developer drops the handle (e.g., deciding not to reuse it),
    // they must manually invoke `destroyDetachedRouteHandle` to prevent a memory leak.
    internalHandle.route.value._localInjector?.destroy();
  }
}

export interface ExperimentalRouteReuseStrategy {
  shouldDestroyInjector?(route: Route): boolean;