refactor(core): rename ngPipeDef to ɵpipe (#33142)

Pipe defs are not considered public API, so the property
that contains them should be prefixed with Angular's marker
for "private" ('ɵ') to discourage apps from relying on def
APIs directly.

This commit adds the prefix and shortens the name from
ngPipeDef to pipe. This is because property names
cannot be minified by Uglify without turning on property
mangling (which most apps have turned off) and are thus
size-sensitive.

PR Close #33142
This commit is contained in:
Kara Erickson
2019-10-11 19:19:59 -07:00
committed by Miško Hevery
parent f433d6604b
commit d62eff7316
17 changed files with 50 additions and 52 deletions

View File

@ -40,7 +40,7 @@ the decorator can be thought of as parameters to a class transformer that
transforms the class by generating definitions based on the decorator
parameters. An `@Component` decorator transforms the class by adding
a `ɵcmp` static property, `@Directive` adds `ɵdir`,
`@Pipe` adds `ngPipeDef`, etc. In most cases values supplied to the
`@Pipe` adds `ɵpipe`, etc. In most cases values supplied to the
decorator is sufficient to generate the definition. However, in the case of
interpreting the template, the compiler needs to know the selector defined for
each component, directive and pipe that are in scope of the template. The
@ -65,22 +65,22 @@ class:
| field | destination |
|---------------------|-----------------------|
| `type` | implicit |
| `isComponent` | `ɵcmp` |
| `isComponent` | `ɵcmp` |
| `selector` | `ngModuleScope` |
| `exportAs` | `ɵdir` |
| `inputs` | `ɵdir` |
| `outputs` | `ɵdir` |
| `hostListeners` | `ɵdir` |
| `hostProperties` | `ɵdir` |
| `hostAttributes` | `ɵdir` |
| `exportAs` | `ɵdir` |
| `inputs` | `ɵdir` |
| `outputs` | `ɵdir` |
| `hostListeners` | `ɵdir` |
| `hostProperties` | `ɵdir` |
| `hostAttributes` | `ɵdir` |
| `providers` | `ngInjectorDef` |
| `viewProviders` | `ɵcmp` |
| `queries` | `ɵdir` |
| `viewProviders` | `ɵcmp` |
| `queries` | `ɵdir` |
| `guards` | not used |
| `viewQueries` | `ɵcmp` |
| `viewQueries` | `ɵcmp` |
| `entryComponents` | not used |
| `changeDetection` | `ɵcmp` |
| `template` | `ɵcmp` |
| `changeDetection` | `ɵcmp` |
| `template` | `ɵcmp` |
| `componentViewType` | not used |
| `renderType` | not used |
| `componentFactory` | not used |
@ -98,7 +98,7 @@ For `CompilePipeSummary` the table looks like:
|---------------------|-----------------------|
| `type` | implicit |
| `name` | `ngModuleScope` |
| `pure` | `ngPipeDef` |
| `pure` | `ɵpipe` |
The only pieces of information that are not generated into the definition are
the directive selector and the pipe name as they go into the module scope.
@ -239,7 +239,7 @@ export class MyDirective {
The metadata for a pipe is transformed by:
1. Removing the `@Pipe` directive.
2. Add `"ngPipeDef": {}` static field.
2. Add `"ɵpipe": {}` static field.
3. Add `"ngSelector": <name-value>` static field.
##### example
@ -256,7 +256,7 @@ export class MyPipe implements PipeTransform {
```js
export class MyPipe {
transform(...) ...
static ngPipeDef = ɵɵdefinePipe({...});
static ɵpipe = ɵɵdefinePipe({...});
}
```
@ -269,7 +269,7 @@ export class MyPipe {
"MyPipe": {
"__symbolic": "class",
"statics": {
"ngPipeDef": {},
"ɵpipe": {},
"ngSelector": "myPipe"
}
}

View File

@ -206,7 +206,7 @@ export class ConstantPool {
case DefinitionKind.Injector:
return 'ngInjectorDef';
case DefinitionKind.Pipe:
return 'ngPipeDef';
return 'ɵpipe';
}
error(`Unknown definition kind ${kind}`);
return '<unknown>';