Function routerResource

packages/router/src/router_resource.ts:37–68

(source: Resource<T>)

 * during navigation transitions and handling rollback recovery.
 */
export function routerResource<T>(source: Resource<T>): Resource<T> & {reload(): boolean} {
  ngDevMode && assertInInjectionContext(routerResource);
  const injector = inject(Injector);
  const router = injector.get(Router);

  const {snapshot: snapshotSignal, frozenSnapshot} = createTransactionalSnapshot(
    source,
    router,
    injector,
  );

  const res = resourceFromSnapshots(snapshotSignal) as Resource<T> & {reload(): boolean};

  if (typeof (source as any).reload === 'function') {
    res.reload = function (): boolean {
      // If the resource is currently frozen (e.g., during an active navigation transition
      // or while recovering from a cancelled navigation), we reject manual reload requests.
      // Triggering a reload during an active navigation (where the resource may already be
      // reactively loading new parameters behind the scenes) would disrupt the router's resource
      // tracking for the transition. Similarly, during a rollback recovery, the router is
      // already managing the resource reload to restore the previous state.
      if (frozenSnapshot() !== null) {
        return false;
      }
      return (source as any).reload();
    };
  } else {
    res.reload = () => false;
  }

  return res;
}

/**
 * Creates a signal that tracks the resource snapshot and handles transactional behavior