more_horiz
@angular/corecode
Pipe
decorator
Decorator that marks a class as pipe and supplies configuration metadata.
PipesOn this page
API
@Pipe({
name: string;
pure?: boolean | undefined;
standalone?: boolean | undefined;
})name
stringThe pipe name to use in template bindings. Typically uses lowerCamelCase because the name cannot contain hyphens.
pure
boolean | undefinedWhen true, the pipe is pure, meaning that the
transform() method is invoked only when its input arguments
change. Pipes are pure by default.
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
boolean | undefinedAngular 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
Decorator that marks a class as pipe and supplies configuration metadata.
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.
Jump to details