CLI

generate guard

Command
ng generate guard
ng generate g

Creates a new route guard in your project. Route guards are used to control access to parts of your application by checking certain conditions before a route is activated. This schematic generates a new guard with the specified name, type, and options.

Arguments

name

The name for the new route guard. This will be used to create the guard's class and spec files (e.g., my-guard.guard.ts and my-guard.guard.spec.ts).

Value Typestring

Options

flat

Creates the new guard files at the top level of the current project. If set to false, a new folder with the guard's name will be created to contain the files.

Value TypebooleanDefaulttrue
functional

Generate the guard as a function instead of a class. Functional guards can be simpler for basic scenarios.

Value TypebooleanDefaulttrue
implements
AliasguardType

Specifies the type(s) of guard to create. You can choose one or more of the following: CanActivate (controls access to a route), CanActivateChild (controls access to child routes), CanDeactivate (asks for confirmation before leaving a route), CanMatch (determines if a route can be matched).

Value Typearray
project

The name of the project where the guard should be created. If not specified, the CLI will determine the project from the current directory.

Value Typestring
skip-tests

Skip the generation of a unit test file spec.ts for the new guard.

Value TypebooleanDefaultfalse
Jump to details