docs: clarify pipe naming (#31806)

PR Close #31806
This commit is contained in:
Judy Bogart
2019-07-23 11:27:56 -07:00
committed by Kara Erickson
parent f90c7a9df0
commit 695f322dc1
2 changed files with 8 additions and 1 deletions

View File

@ -589,6 +589,8 @@ export interface PipeDecorator {
* to a template. To make it a member of an NgModule,
* list it in the `declarations` field of the `NgModule` metadata.
*
* @see [Style Guide: Pipe Names](guide/styleguide#02-09)
*
*/
(obj: Pipe): TypeDecorator;
@ -606,7 +608,8 @@ export interface PipeDecorator {
export interface Pipe {
/**
* The pipe name to use in template bindings.
*
* Typically uses [lowerCamelCase](guide/glossary#case-types)
* because the name cannot contain hyphens.
*/
name: string;