@nx/nest:interface

Nest Interface Options Schema.

Usage

1nx generate interface ... 2

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

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

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

Options

path

Required
string

Path where the interface will be generated.

name

string

The name of the interface.

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 v20.