@nx/nest:interface
Nest Interface Options Schema.
Usage
1nx generate interface ...
2By 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 ...
2Show what will be generated without writing to disk:
1nx g interface ... --dry-run
2Options
name
Required
string
The name of the interface.
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.
nameAndDirectoryFormat
string
Accepted values:
as-provided, derivedWhether 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).
skipFormat
Internal
boolean
Default:
falseSkip formatting files.
flat
Deprecated
boolean
Default:
trueFlag 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.
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 v20.