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

Commit 5fbd16f

Browse files
committed
docs(alpha-34): API update fixes enums again and updates docs to v35
1 parent fa95671 commit 5fbd16f

File tree

272 files changed

+1411
-813
lines changed

Some content is hidden

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

272 files changed

+1411
-813
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.33/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#L360-L360">angular2/src/core/annotations/decorators.ts (line 360)</a>
77

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

public/docs/js/latest/api/annotations/AttributeAnnotation-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.33/modules/angular2/src/core/annotations_impl/di.ts#L3-L44">angular2/src/core/annotations_impl/di.ts (line 3)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/di.ts#L3-L44">angular2/src/core/annotations_impl/di.ts (line 3)</a>
55

66
:markdown
77
Specifies that a constant attribute value should be injected.

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.33/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#L236-L287">angular2/src/core/annotations/decorators.ts (line 236)</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/Class-function.jade

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

1111
p.location-badge.
1212
exported from <a href='../annotations'>angular2/annotations</a>
13-
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/util/decorators.ts#L119-L226">angular2/src/util/decorators.ts (line 119)</a>
13+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/util/decorators.ts#L119-L226">angular2/src/util/decorators.ts (line 119)</a>
1414

1515
:markdown
1616
Provides a way for expressing ES6 classes with parameter annotations in ES5.

public/docs/js/latest/api/annotations/ClassDefinition-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.33/modules/angular2/src/util/decorators.ts#L1-L22">angular2/src/util/decorators.ts (line 1)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/util/decorators.ts#L1-L22">angular2/src/util/decorators.ts (line 1)</a>
55

66
:markdown
77
Declares the interface to be used with <a href='Class-function.html'><code>Class</code></a>.

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.33/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#L344-L345">angular2/src/core/annotations/decorators.ts (line 344)</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.33/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#L778-L900">angular2/src/core/annotations_impl/annotations.ts (line 778)</a>
55

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

public/docs/js/latest/api/annotations/ComponentDecorator-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.33/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#L13-L32">angular2/src/core/annotations/decorators.ts (line 13)</a>
55

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

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.33/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#L104-L174">angular2/src/core/annotations/decorators.ts (line 104)</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.33/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#L349-L349">angular2/src/core/annotations/decorators.ts (line 349)</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: 2 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.33/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-L778">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.
@@ -529,7 +529,7 @@ p.location-badge.
529529
For example, we could write a binding that updates the directive on structural changes, rather
530530
than on reference changes, as normally occurs in change detection.
531531

532-
See <a href='https://github.com/change_detection/Pipe-interface.html'><code>Pipe</code></a> and <a href='https://github.com/pipes/%3C/span%3EKeyValueChanges%3Cspan%20class="x x-first x-last">-class.html'><code>KeyValueChanges</code></a> documentation for more details.
532+
See <a href='https://github.com/change_detection/Pipe-interface.html'><code>Pipe</code></a> and `KeyValueChanges` documentation for more details.
533533

534534
```
535535
@Directive({

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.33/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#L6-L13">angular2/src/core/annotations/decorators.ts (line 6)</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.33/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#L51-L104">angular2/src/core/annotations/decorators.ts (line 51)</a>
55

66
:markdown
77
<a href='Directive-var.html'><code>Directive</code></a> factory for creating annotations, decorators or DSL.
Lines changed: 175 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,176 @@
11

2-
<h1>angular2/annotations/LifecycleEvent</h1>
3-
<h2>(enum)</h2>
4-
<div>
5-
<p>Lifecycle events are guaranteed to be called in the following order:</p>
6-
<ul>
7-
<li><code>onChange</code> (optional if any bindings have changed),</li>
8-
<li><code>onInit</code> (optional after the first check only),</li>
9-
<li><code>onCheck</code>,</li>
10-
<li><code>onAllChangesDone</code></li>
11-
</ul>
12-
13-
</div>
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#L900-L1032">angular2/src/core/annotations_impl/annotations.ts (line 900)</a>
5+
6+
:markdown
7+
Lifecycle events are guaranteed to be called in the following order:
8+
- `onChange` (optional if any bindings have changed),
9+
- `onInit` (optional after the first check only),
10+
- `onCheck`,
11+
- `onAllChangesDone`
12+
13+
14+
.l-main-section
15+
h2 Members
16+
.l-sub-section
17+
h3 onDestroy
18+
19+
20+
:markdown
21+
Notify a directive whenever a <a href='View-var.html'><code>View</code></a> that contains it is destroyed.
22+
23+
24+
25+
```
26+
@Directive({
27+
...,
28+
lifecycle: [LifecycleEvent.onDestroy]
29+
})
30+
class ClassSet {
31+
onDestroy() {
32+
// invoked to notify directive of the containing view destruction.
33+
}
34+
}
35+
```
36+
37+
38+
39+
40+
41+
42+
43+
.l-sub-section
44+
h3 onChange
45+
46+
47+
:markdown
48+
Notify a directive when any of its bindings have changed.
49+
50+
This method is called right after the directive's bindings have been checked,
51+
and before any of its children's bindings have been checked.
52+
53+
It is invoked only if at least one of the directive's bindings has changed.
54+
55+
:
56+
57+
```
58+
@Directive({
59+
selector: '[class-set]',
60+
properties: [
61+
'propA',
62+
'propB'
63+
],
64+
lifecycle: [LifecycleEvent.onChange]
65+
})
66+
class ClassSet {
67+
propA;
68+
propB;
69+
onChange(changes:{[idx: string, PropertyUpdate]}) {
70+
// This will get called after any of the properties have been updated.
71+
if (changes['propA']) {
72+
// if propA was updated
73+
}
74+
if (changes['propA']) {
75+
// if propB was updated
76+
}
77+
}
78+
}
79+
```
80+
81+
82+
83+
84+
85+
86+
87+
.l-sub-section
88+
h3 onCheck
89+
90+
91+
:markdown
92+
Notify a directive when it has been checked.
93+
94+
This method is called right after the directive's bindings have been checked,
95+
and before any of its children's bindings have been checked.
96+
97+
It is invoked every time even when none of the directive's bindings has changed.
98+
99+
100+
101+
```
102+
@Directive({
103+
selector: '[class-set]',
104+
lifecycle: [LifecycleEvent.onCheck]
105+
})
106+
class ClassSet {
107+
onCheck() {
108+
}
109+
}
110+
```
111+
112+
113+
114+
115+
116+
117+
118+
.l-sub-section
119+
h3 onInit
120+
121+
122+
:markdown
123+
Notify a directive when it has been checked the first itme.
124+
125+
This method is called right after the directive's bindings have been checked,
126+
and before any of its children's bindings have been checked.
127+
128+
It is invoked only once.
129+
130+
131+
132+
```
133+
@Directive({
134+
selector: '[class-set]',
135+
lifecycle: [LifecycleEvent.onInit]
136+
})
137+
class ClassSet {
138+
onInit() {
139+
}
140+
}
141+
```
142+
143+
144+
145+
146+
147+
148+
149+
.l-sub-section
150+
h3 onAllChangesDone
151+
152+
153+
:markdown
154+
Notify a directive when the bindings of all its children have been checked (whether they have
155+
changed or not).
156+
157+
158+
159+
```
160+
@Directive({
161+
selector: '[class-set]',
162+
lifecycle: [LifecycleEvent.onAllChangesDone]
163+
})
164+
class ClassSet {
165+
166+
onAllChangesDone() {
167+
}
168+
169+
}
170+
```
171+
172+
173+
174+
175+
176+

public/docs/js/latest/api/annotations/OnAllChangesDone-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.33/modules/angular2/src/core/compiler/interfaces.ts#L30-L37">angular2/src/core/compiler/interfaces.ts (line 30)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L30-L37">angular2/src/core/compiler/interfaces.ts (line 30)</a>
55

66
:markdown
77
Defines lifecycle method

public/docs/js/latest/api/annotations/OnChange-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.33/modules/angular2/src/core/compiler/interfaces.ts#L7-L12">angular2/src/core/compiler/interfaces.ts (line 7)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L7-L12">angular2/src/core/compiler/interfaces.ts (line 7)</a>
55

66
:markdown
77
Defines lifecycle method <a href='annotations/LifeCycleEvent#onChange'>`LifeCycleEvent.onChange`</a>

public/docs/js/latest/api/annotations/OnCheck-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.33/modules/angular2/src/core/compiler/interfaces.ts#L18-L24">angular2/src/core/compiler/interfaces.ts (line 18)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L18-L24">angular2/src/core/compiler/interfaces.ts (line 18)</a>
55

66
:markdown
77
Defines lifecycle method <a href='annotations/LifeCycleEvent#onCheck'>`LifeCycleEvent.onCheck`</a>

public/docs/js/latest/api/annotations/OnDestroy-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.33/modules/angular2/src/core/compiler/interfaces.ts#L12-L18">angular2/src/core/compiler/interfaces.ts (line 12)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L12-L18">angular2/src/core/compiler/interfaces.ts (line 12)</a>
55

66
:markdown
77
Defines lifecycle method <a href='annotations/LifeCycleEvent#onDestroy'>`LifeCycleEvent.onDestroy`</a>

public/docs/js/latest/api/annotations/OnInit-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.33/modules/angular2/src/core/compiler/interfaces.ts#L24-L30">angular2/src/core/compiler/interfaces.ts (line 24)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/compiler/interfaces.ts#L24-L30">angular2/src/core/compiler/interfaces.ts (line 24)</a>
55

66
:markdown
77
Defines lifecycle method <a href='annotations/LifeCycleEvent#onInit'>`LifeCycleEvent.onInit`</a>

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.33/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#L365-L365">angular2/src/core/annotations/decorators.ts (line 365)</a>
77

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

public/docs/js/latest/api/annotations/QueryAnnotation-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.33/modules/angular2/src/core/annotations_impl/di.ts#L44-L69">angular2/src/core/annotations_impl/di.ts (line 44)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/core/annotations_impl/di.ts#L44-L69">angular2/src/core/annotations_impl/di.ts (line 44)</a>
55

66
:markdown
77
Specifies that a <a href='../core/QueryList-class.html'><code>QueryList</code></a> should be injected.

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.33/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#L287-L338">angular2/src/core/annotations/decorators.ts (line 287)</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/TypeDecorator-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.33/modules/angular2/src/util/decorators.ts#L22-L69">angular2/src/util/decorators.ts (line 22)</a>
4+
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.34/modules/angular2/src/util/decorators.ts#L22-L69">angular2/src/util/decorators.ts (line 22)</a>
55

66
:markdown
77
An interface implemented by all Angular type decorators, which allows them to be used as ES7

0 commit comments

Comments
 (0)