W3cubDocs

/Angular

Pipe

decorator

Decorator that marks a class as pipe and supplies configuration metadata.

Option	Description
`name`	The pipe name to use in template bindings. Typically uses lowerCamelCase because the name cannot contain hyphens.
`pure?`	When true, the pipe is pure, meaning that the `transform()` method is invoked only when its input arguments change. Pipes are pure by default.
`standalone?`	Angular pipes marked as `standalone` do not need to be declared in an NgModule. Such pipes don't depend on any "intermediate context" of an NgModule (ex. configured providers).

Description

A pipe class must implement the PipeTransform interface. For example, if the name is "myPipe", use a template binding expression such as the following:

{{ exp | myPipe }}

The result of the expression is passed to the pipe's transform() method.

A pipe must belong to an NgModule in order for it to be available to a template. To make it a member of an NgModule, list it in the declarations field of the NgModule metadata.

Options

name
The pipe name to use in template bindings. Typically uses lowerCamelCase because the name cannot contain hyphens.
`name: string`

pure
When true, the pipe is pure, meaning that the `transform()` method is invoked only when its input arguments change. Pipes are pure by default.
`pure?: boolean`
If the pipe has internal state (that is, the result depends on state other than its arguments), set `pure` to false. In this case, the pipe is invoked on each change-detection cycle, even if the arguments have not changed.

standalone
Angular pipes marked as `standalone` do not need to be declared in an NgModule. Such pipes don't depend on any "intermediate context" of an NgModule (ex. configured providers).
`standalone?: boolean`
More information about standalone components, directives, and pipes can be found in this guide.

W3cubDocs

Pipe

See also

Description

Options

`name: string`

`pure?: boolean`

`standalone?: boolean`