@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
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

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

Options

name

Required
string

The name of the pipe.

directory

string

The directory at which to create the pipe file. When --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.

export

boolean
Default: false

The declaring NgModule exports this pipe.

module

m
string

The filename of the declaring NgModule.

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether to generate the pipe 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).

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: false

Whether the generated pipe is standalone. Note: This is only supported in Angular versions >= 14.1.0.

skipFormat

boolean
Default: false

Skip formatting of files.

flat

Deprecated
boolean
Default: true

When true (the default) creates files at the top level of the project.

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

project

Deprecated
string

The name of the project.

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