Skip to content

docs: type the external redirect guard #33887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crisbeto merged 1 commit into from
Sep 29, 2026
Merged

docs: type the external redirect guard #33887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/src/app/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*/

import {Component} from '@angular/core';
import {Route, Routes} from '@angular/router';
import {CanActivateFn, Route, Routes} from '@angular/router';
import {canActivateComponentSidenav} from './pages/component-sidenav/component-sidenav-can-load-guard';

@Component({template: ''})
Expand Down Expand Up @@ -95,14 +95,16 @@ function adevRedirect(path: string) {
}

function externalRedirect(target: string | (() => string)): Partial<Route> {
// Typed explicitly, because `canActivate` also accepts deprecated class-based guards. Any function
// matches that type as well, so an inline guard wouldn't have its return value type checked.
const redirect: CanActivateFn = () => {
window.location.href = typeof target === 'string' ? target : target();
return false;
};

return {
// The router requires a `component`.
component: RedirectPlaceholder,
canActivate: [
() => {
window.location.href = typeof target === 'string' ? target : target();
return false;
},
],
canActivate: [redirect],
};
}
Loading