@nx/nest:guard

Nest Guard Options Schema.

Usage

1nx generate guard ... 2

By default, Nx will search for guard in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/nest:guard ... 2

Show what will be generated without writing to disk:

1nx g guard ... --dry-run 2

Examples

Generate the guard FooGuard at myapp/src/app/foo.guard.ts:

1nx g @nx/nest:guard myapp/src/app/foo.guard.ts 2

Generate the guard without providing the file extension. It results in the guard FooGuard at myapp/src/app/foo.guard.ts:

1nx g @nx/nest:guard myapp/src/app/foo 2

Options

path

Required
string

The file path to the guard. Relative to the current working directory.

language

string
Accepted values: js, ts

Nest guard language.

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

skipFormat

Internal
boolean
Default: false

Skip formatting files.