@nx/angularSee schema

@nx/angular:pipe

Creates an Angular pipe.

Usage

1nx generate pipe ... 2
1nx g p ... #same 2

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

You can specify the collection explicitly as follows:

1nx g @nx/angular:pipe ... 2

Show what will be generated without writing to disk:

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

Examples

Generate a pipe with the exported symbol matching the file name. It results in the pipe FooPipe at mylib/src/lib/foo.pipe.ts:

1nx g @nx/angular:pipe mylib/src/lib/foo.pipe.ts 2

Generate a pipe without providing the file extension. It results in the pipe FooPipe at mylib/src/lib/foo.pipe.ts:

1nx g @nx/angular:pipe mylib/src/lib/foo 2

Generate a pipe with the exported symbol different from the file name. It results in the pipe CustomPipe at mylib/src/lib/foo.pipe.ts:

1nx g @nx/angular:pipe mylib/src/lib/foo --name=custom 2

Options

path

Required
string

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

export

boolean
Default: false

The declaring NgModule exports this pipe.

module

m
string

The filename of the declaring NgModule.

name

string

The pipe symbol name. Defaults to the last segment of the file path.

skipTests

boolean
Default: false

Do not create "spec.ts" test files for the new pipe.

skipImport

boolean
Default: false

Do not import this pipe into the owning NgModule.

standalone

boolean
Default: true

Whether the generated pipe is standalone.

skipFormat

boolean
Default: false

Skip formatting of files.