Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit b23f8fd

Browse files
committed
docs: renames for the API public surface per alpha-35
1 parent 73d7bd3 commit b23f8fd

File tree

157 files changed

+1032
-3684
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+1032
-3684
lines changed

public/docs/js/latest/api/annotations/Attribute-var.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
h2 Attribute <span class="type">variable</span>
44
p.location-badge.
55
exported from <a href='../annotations'>angular2/annotations</a>
6-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L360-L360">angular2/src/core/annotations/decorators.ts (line 360)</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L391-L391">angular2/src/core/annotations/decorators.ts (line 391)</a>
77

88
:markdown
99
<a href='Attribute-var.html'><code>Attribute</code></a> factory function.

public/docs/js/latest/api/annotations/AttributeFactory-interface.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L236-L287">angular2/src/core/annotations/decorators.ts (line 236)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L243-L294">angular2/src/core/annotations/decorators.ts (line 243)</a>
55

66
:markdown
77
<a href='Attribute-var.html'><code>Attribute</code></a> factory for creating annotations, decorators or DSL.

public/docs/js/latest/api/annotations/Component-var.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
h2 Component <span class="type">variable</span>
44
p.location-badge.
55
exported from <a href='../annotations'>angular2/annotations</a>
6-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L344-L345">angular2/src/core/annotations/decorators.ts (line 344)</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L375-L376">angular2/src/core/annotations/decorators.ts (line 375)</a>
77

88
:markdown
99
<a href='Component-var.html'><code>Component</code></a> factory function.

public/docs/js/latest/api/annotations/ComponentAnnotation-class.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L778-L900">angular2/src/core/annotations_impl/annotations.ts (line 778)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L754-L876">angular2/src/core/annotations_impl/annotations.ts (line 754)</a>
55

66
:markdown
77
Declare reusable UI building blocks for an application.

public/docs/js/latest/api/annotations/ComponentDecorator-interface.jade

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L13-L32">angular2/src/core/annotations/decorators.ts (line 13)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L18-L38">angular2/src/core/annotations/decorators.ts (line 18)</a>
55

66
:markdown
77
Interface for the <a href='Component-var.html'><code>Component</code></a> decorator function.
@@ -21,6 +21,7 @@ p.location-badge.
2121
templateUrl?: string,
2222
template?: string,
2323
directives?: List&lt;Type | any | List&lt;any&gt;&gt;,
24+
pipes?: List&lt;Type | any | List&lt;any&gt;&gt;,
2425
renderer?: string,
2526
styles?: List&lt;string&gt;,
2627
styleUrls?: List&lt;string&gt;,

public/docs/js/latest/api/annotations/ComponentFactory-interface.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L104-L174">angular2/src/core/annotations/decorators.ts (line 104)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L111-L181">angular2/src/core/annotations/decorators.ts (line 111)</a>
55

66
:markdown
77
<a href='ComponentAnnotation-class.html'><code>ComponentAnnotation</code></a> factory for creating annotations, decorators or DSL.

public/docs/js/latest/api/annotations/Directive-var.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
h2 Directive <span class="type">variable</span>
44
p.location-badge.
55
exported from <a href='../annotations'>angular2/annotations</a>
6-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L349-L349">angular2/src/core/annotations/decorators.ts (line 349)</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L380-L380">angular2/src/core/annotations/decorators.ts (line 380)</a>
77

88
:markdown
99
<a href='Directive-var.html'><code>Directive</code></a> factory function.

public/docs/js/latest/api/annotations/DirectiveAnnotation-class.jade

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L4-L778">angular2/src/core/annotations_impl/annotations.ts (line 4)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L4-L754">angular2/src/core/annotations_impl/annotations.ts (line 4)</a>
55

66
:markdown
77
Directives allow you to attach behavior to elements in the DOM.
@@ -471,7 +471,7 @@ p.location-badge.
471471
- `directiveProperty` specifies the component property where the value is written.
472472
- `bindingProperty` specifies the DOM property where the value is read from.
473473

474-
You can include a <a href='https://github.com/%3Cspan%20class="x x-first x-last">../change_detection/Pipe-interface.html'><code>Pipe</code></a> when specifying a `bindingProperty` to allow for data
474+
You can include a <a href='https://github.com/Pipe-%3Cspan%20class="x x-first x-last">var.html'><code>Pipe</code></a> when specifying a `bindingProperty` to allow for data
475475
transformation and structural change detection of the value. These pipes will be evaluated in
476476
the context of this component.
477477

@@ -522,38 +522,14 @@ p.location-badge.
522522
Whenever the `someExpression` expression changes, the `properties` declaration instructs
523523
Angular to update the `Tooltip`'s `text` property.
524524

525-
## Bindings With Pipes
525+
### Bindings With Pipes
526526

527-
You can also use pipes when writing binding definitions for a directive.
528-
529-
For example, we could write a binding that updates the directive on structural changes, rather
530-
than on reference changes, as normally occurs in change detection.
531-
532-
See <a href='../change_detection/Pipe-interface.html'><code>Pipe</code></a> and `KeyValueChanges` documentation for more details.
533-
534-
```
535-
@Directive({
536-
selector: '[class-set]',
537-
properties: [
538-
'classChanges: classSet | keyValDiff'
539-
]
540-
})
541-
class ClassSet {
542-
set classChanges(changes: KeyValueChanges) {
543-
// This will get called every time the `class-set` expressions changes its structure.
544-
}
545-
}
546-
```
547-
548-
The template that this directive is used in may also contain its own pipes. For example:
527+
You can use pipes in bindings, as follows:
549528

550529
```html
551530
<div [class-set]="someExpression | somePipe">
552531
```
553532

554-
In this case, the two pipes compose as if they were inlined: `someExpression | somePipe |
555-
keyValDiff`.
556-
557533

558534

559535

public/docs/js/latest/api/annotations/DirectiveDecorator-interface.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L6-L13">angular2/src/core/annotations/decorators.ts (line 6)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L11-L18">angular2/src/core/annotations/decorators.ts (line 11)</a>
55

66
:markdown
77
Interface for the <a href='Directive-var.html'><code>Directive</code></a> decorator function.

public/docs/js/latest/api/annotations/DirectiveFactory-interface.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L51-L104">angular2/src/core/annotations/decorators.ts (line 51)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L58-L111">angular2/src/core/annotations/decorators.ts (line 58)</a>
55

66
:markdown
77
<a href='Directive-var.html'><code>Directive</code></a> factory for creating annotations, decorators or DSL.

public/docs/js/latest/api/annotations/LifecycleEvent-enum.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L900-L1032">angular2/src/core/annotations_impl/annotations.ts (line 900)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L876-L1008">angular2/src/core/annotations_impl/annotations.ts (line 876)</a>
55

66
:markdown
77
Lifecycle events are guaranteed to be called in the following order:
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
.l-main-section
3+
h2 Pipe <span class="type">variable</span>
4+
p.location-badge.
5+
exported from <a href='../annotations'>angular2/annotations</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L407-L407">angular2/src/core/annotations/decorators.ts (line 407)</a>
7+
8+
:markdown
9+
<a href='Pipe-var.html'><code>Pipe</code></a> factory function.
10+
11+
12+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
2+
p.location-badge.
3+
exported from <a href='../annotations'>angular2/annotations</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/annotations.ts#L1008-L1032">angular2/src/core/annotations_impl/annotations.ts (line 1008)</a>
5+
6+
:markdown
7+
Declare reusable pipe function.
8+
9+
## Example
10+
11+
```
12+
@Pipe({
13+
name: 'lowercase'
14+
})
15+
class Lowercase {
16+
transform(v, args) { return v.toLowerCase(); }
17+
}
18+
```
19+
20+
21+
22+
.l-main-section
23+
h2 Annotations
24+
.l-sub-section
25+
h3.annotation CONST
26+
pre.prettyprint
27+
code.
28+
@CONST()
29+
30+
31+
.l-main-section
32+
h2 Members
33+
.l-sub-section
34+
h3 constructor
35+
36+
37+
pre.prettyprint
38+
code.
39+
constructor({name}: {name: string})
40+
41+
:markdown
42+
43+
44+
45+
46+
47+
48+
.l-sub-section
49+
h3 name
50+
51+
52+
:markdown
53+
54+
55+
56+
57+
58+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
p.location-badge.
3+
exported from <a href='../annotations'>angular2/annotations</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L345-L370">angular2/src/core/annotations/decorators.ts (line 345)</a>
5+
6+
:markdown
7+
<a href='Pipe-var.html'><code>Pipe</code></a> factory for creating decorators.
8+
9+
## Example as TypeScript Decorator
10+
11+
```
12+
import {Pipe} from "angular2/angular2";
13+
14+
@Pipe({...})
15+
class MyPipe {
16+
constructor() {
17+
...
18+
}
19+
20+
transform(v, args) {}
21+
}
22+
```
23+
24+

public/docs/js/latest/api/annotations/Query-var.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
h2 Query <span class="type">variable</span>
44
p.location-badge.
55
exported from <a href='../annotations'>angular2/annotations</a>
6-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L365-L365">angular2/src/core/annotations/decorators.ts (line 365)</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L396-L396">angular2/src/core/annotations/decorators.ts (line 396)</a>
77

88
:markdown
99
<a href='Query-var.html'><code>Query</code></a> factory function.

public/docs/js/latest/api/annotations/QueryFactory-interface.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L287-L338">angular2/src/core/annotations/decorators.ts (line 287)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L294-L345">angular2/src/core/annotations/decorators.ts (line 294)</a>
55

66
:markdown
77
<a href='Query-var.html'><code>Query</code></a> factory for creating annotations, decorators or DSL.

public/docs/js/latest/api/annotations/View-var.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
h2 View <span class="type">variable</span>
44
p.location-badge.
55
exported from <a href='../annotations'>angular2/annotations</a>
6-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L354-L355">angular2/src/core/annotations/decorators.ts (line 354)</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L385-L386">angular2/src/core/annotations/decorators.ts (line 385)</a>
77

88
:markdown
99
<a href='View-var.html'><code>View</code></a> factory function.

public/docs/js/latest/api/annotations/ViewAnnotation-class.jade

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/view.ts#L4-L113">angular2/src/core/annotations_impl/view.ts (line 4)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/view.ts#L4-L117">angular2/src/core/annotations_impl/view.ts (line 4)</a>
55

66
:markdown
77
Declares the available HTML templates for an application.
@@ -53,10 +53,11 @@ p.location-badge.
5353

5454
pre.prettyprint
5555
code.
56-
constructor({templateUrl, template, directives, encapsulation, styles, styleUrls}?: {
56+
constructor({templateUrl, template, directives, pipes, encapsulation, styles, styleUrls}?: {
5757
templateUrl?: string,
5858
template?: string,
5959
directives?: List&lt;Type | any | List&lt;any&gt;&gt;,
60+
pipes?: List&lt;Type | any | List&lt;any&gt;&gt;,
6061
encapsulation?: ViewEncapsulation,
6162
styles?: List&lt;string&gt;,
6263
styleUrls?: List&lt;string&gt;,
@@ -157,6 +158,18 @@ p.location-badge.
157158

158159

159160

161+
.l-sub-section
162+
h3 pipes
163+
164+
165+
:markdown
166+
167+
168+
169+
170+
171+
172+
160173
.l-sub-section
161174
h3 encapsulation
162175

public/docs/js/latest/api/annotations/ViewDecorator-interface.jade

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L32-L51">angular2/src/core/annotations/decorators.ts (line 32)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L38-L58">angular2/src/core/annotations/decorators.ts (line 38)</a>
55

66
:markdown
77
Interface for the <a href='View-var.html'><code>View</code></a> decorator function.
@@ -21,6 +21,7 @@ p.location-badge.
2121
templateUrl?: string,
2222
template?: string,
2323
directives?: List&lt;Type | any | List&lt;any&gt;&gt;,
24+
pipes?: List&lt;Type | any | List&lt;any&gt;&gt;,
2425
renderer?: string,
2526
styles?: List&lt;string&gt;,
2627
styleUrls?: List&lt;string&gt;,

public/docs/js/latest/api/annotations/ViewFactory-interface.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
p.location-badge.
33
exported from <a href='../annotations'>angular2/annotations</a>
4-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L174-L236">angular2/src/core/annotations/decorators.ts (line 174)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L181-L243">angular2/src/core/annotations/decorators.ts (line 181)</a>
55

66
:markdown
77
<a href='ViewAnnotation-class.html'><code>ViewAnnotation</code></a> factory for creating annotations, decorators or DSL.

public/docs/js/latest/api/annotations/ViewQuery-var.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
h2 ViewQuery <span class="type">variable</span>
44
p.location-badge.
55
exported from <a href='../annotations'>angular2/annotations</a>
6-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L371-L371">angular2/src/core/annotations/decorators.ts (line 371)</a>
6+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations/decorators.ts#L402-L402">angular2/src/core/annotations/decorators.ts (line 402)</a>
77

88
:markdown
99
<a href='ViewQuery-var.html'><code>ViewQuery</code></a> factory function.

public/docs/js/latest/api/annotations/_data.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
"title" : "DirectiveAnnotation Class"
1313
},
1414

15+
"PipeAnnotation-class" : {
16+
"title" : "PipeAnnotation Class"
17+
},
18+
1519
"LifecycleEvent-enum" : {
1620
"title" : "LifecycleEvent Enum"
1721
},
@@ -118,5 +122,13 @@
118122

119123
"ViewQuery-var" : {
120124
"title" : "ViewQuery Var"
125+
},
126+
127+
"Pipe-var" : {
128+
"title" : "Pipe Var"
129+
},
130+
131+
"PipeFactory-interface" : {
132+
"title" : "PipeFactory Interface"
121133
}
122134
}

public/docs/js/latest/api/annotations/index.jade

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
p.location-badge.
2-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/annotations.ts#L1-L48">angular2/annotations.ts (line 1)</a>
2+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/annotations.ts#L1-L51">angular2/annotations.ts (line 1)</a>
33

44
ul
55
for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data

0 commit comments

Comments
 (0)