@nx/nest:interceptor

Nest Interceptor Options Schema.

Usage

1nx generate interceptor ... 2

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

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

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

Options

name

Required
string

The name of the interceptor.

directory

string

Directory where the generated files are placed. when --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.

language

string
Accepted values: js, ts

Nest interceptor language.

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (as-provided) or generate it using the project and directory relative to the workspace root (derived).

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

skipFormat

Internal
boolean
Default: false

Skip formatting files.

flat

Deprecated
boolean
Default: true

Flag to indicate if a directory is created.

Provide the directory option instead and use the as-provided format. It will be removed in Nx v19.

project

pDeprecated
string

The Nest project to target.

Provide The directory option instead and use the as-provided format. the project will be determined from the directory provided. it will be removed in nx v19.