iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(update): fixes to enums since template updated

This commit is contained in:
Naomi Black 2015-08-03 14:20:38 -07:00
parent 20b627c33a
commit fa9567189f
14 changed files with 69 additions and 639 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,166 +1,13 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/annotations_impl/annotations.ts#L900-L1037">angular2/src/core/annotations_impl/annotations.ts (line 900)</a>
:markdown
Lifecycle events are guaranteed to be called in the following order:
- `onChange` (optional if any bindings have changed),
- `onInit` (optional after the first check only),
- `onCheck`,
- `onAllChangesDone`
.l-main-section
h2 Members
.l-sub-section
h3 onDestroy
:markdown
Notify a directive whenever a <a href='View-var.html'><code>View</code></a> that contains it is destroyed.
```
@Directive({
...,
lifecycle: [LifecycleEvent.onDestroy]
})
class ClassSet {
onDestroy() {
// invoked to notify directive of the containing view destruction.
}
}
```
.l-sub-section
h3 onChange
:markdown
Notify a directive when any of its bindings have changed.
This method is called right after the directive's bindings have been checked,
and before any of its children's bindings have been checked.
It is invoked only if at least one of the directive's bindings has changed.
:
```
@Directive({
selector: '[class-set]',
properties: [
'propA',
'propB'
],
lifecycle: [LifecycleEvent.onChange]
})
class ClassSet {
propA;
propB;
onChange(changes:{[idx: string, PropertyUpdate]}) {
// This will get called after any of the properties have been updated.
if (changes['propA']) {
// if propA was updated
}
if (changes['propA']) {
// if propB was updated
}
}
}
```
.l-sub-section
h3 onCheck
:markdown
Notify a directive when it has been checked.
This method is called right after the directive's bindings have been checked,
and before any of its children's bindings have been checked.
It is invoked every time even when none of the directive's bindings has changed.
:
```
@Directive({
selector: '[class-set]',
lifecycle: [LifecycleEvent.onCheck]
})
class ClassSet {
onCheck() {
}
}
```
.l-sub-section
h3 onInit
:markdown
Notify a directive when it has been checked the first itme.
This method is called right after the directive's bindings have been checked,
and before any of its children's bindings have been checked.
It is invoked only once.
:
```
@Directive({
selector: '[class-set]',
lifecycle: [LifecycleEvent.onInit]
})
class ClassSet {
onInit() {
}
}
```
.l-sub-section
h3 onAllChangesDone
:markdown
Notify a directive when the bindings of all its children have been checked (whether they have
changed or not).
:
```
@Directive({
selector: '[class-set]',
lifecycle: [LifecycleEvent.onAllChangesDone]
})
class ClassSet {
onAllChangesDone() {
}
}
```
<h1>angular2/annotations/LifecycleEvent</h1>
<h2>(enum)</h2>
<div>
<p>Lifecycle events are guaranteed to be called in the following order:</p>
<ul>
<li><code>onChange</code> (optional if any bindings have changed),</li>
<li><code>onInit</code> (optional after the first check only),</li>
<li><code>onCheck</code>,</li>
<li><code>onAllChangesDone</code></li>
</ul>
</div>

7
public/docs/js/latest/api/annotations/OnAllChangesDone-interface.jade
View File

@ -1,11 +1,12 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L27-L33">angular2/src/core/compiler/interfaces.ts (line 27)</a>
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>
:markdown
Defines lifecycle method [onAllChangesDone ] called when the bindings of all its children have
been changed.
Defines lifecycle method
<a href='annotations/LifeCycleEvent#onAllChangesDone'>`LifeCycleEvent.onAllChangesDone`</a>
called when the bindings of all its children have been changed.
.l-main-section

4
public/docs/js/latest/api/annotations/OnChange-interface.jade
View File

@ -4,8 +4,8 @@ p.location-badge.
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>
:markdown
Defines lifecycle method [onChange] called after all of component's bound
properties are updated.
Defines lifecycle method <a href='annotations/LifeCycleEvent#onChange'>`LifeCycleEvent.onChange`</a>
called after all of component's bound properties are updated.
.l-main-section

5
public/docs/js/latest/api/annotations/OnCheck-interface.jade
View File

@ -1,10 +1,11 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L17-L22">angular2/src/core/compiler/interfaces.ts (line 17)</a>
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>
:markdown
Defines lifecycle method [onCheck] called when a directive is being checked.
Defines lifecycle method <a href='annotations/LifeCycleEvent#onCheck'>`LifeCycleEvent.onCheck`</a>
called when a directive is being checked.
.l-main-section

5
public/docs/js/latest/api/annotations/OnDestroy-interface.jade
View File

@ -1,10 +1,11 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L12-L17">angular2/src/core/compiler/interfaces.ts (line 12)</a>
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>
:markdown
Defines lifecycle method [onDestroy] called when a directive is being destroyed.
Defines lifecycle method <a href='annotations/LifeCycleEvent#onDestroy'>`LifeCycleEvent.onDestroy`</a>
called when a directive is being destroyed.
.l-main-section

5
public/docs/js/latest/api/annotations/OnInit-interface.jade
View File

@ -1,10 +1,11 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/core/compiler/interfaces.ts#L22-L27">angular2/src/core/compiler/interfaces.ts (line 22)</a>
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>
:markdown
Defines lifecycle method [onInit] called when a directive is being checked the first time.
Defines lifecycle method <a href='annotations/LifeCycleEvent#onInit'>`LifeCycleEvent.onInit`</a>
called when a directive is being checked the first time.
.l-main-section

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

@ -74,7 +74,7 @@ p.location-badge.
:markdown
Specifies an inline template for an angular component.
Specifies a template URL for an angular component.
NOTE: either `templateUrl` or `template` should be used, but not both.
@ -89,7 +89,7 @@ p.location-badge.
:markdown
Specifies a template URL for an angular component.
Specifies an inline template for an angular component.
NOTE: either `templateUrl` or `template` should be used, but not both.

53
public/docs/js/latest/api/annotations/ViewEncapsulation-enum.jade
View File

@ -1,50 +1,7 @@
p.location-badge.
exported from <a href='../annotations'>angular2/annotations</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/render/api.ts#L274-L293">angular2/src/render/api.ts (line 274)</a>
:markdown
How the template and styles of a view should be encapsulated.
.l-main-section
h2 Members
.l-sub-section
h3 EMULATED
:markdown
Emulate scoping of styles by preprocessing the style rules
and adding additional attributes to elements. This is the default.
.l-sub-section
h3 NATIVE
:markdown
Uses the native mechanism of the renderer. For the DOM this means creating a ShadowRoot.
.l-sub-section
h3 NONE
:markdown
Don't scope the template nor the styles.
<h1>angular2/annotations/ViewEncapsulation</h1>
<h2>(enum)</h2>
<div>
<p>How the template and styles of a view should be encapsulated.</p>
</div>

89
public/docs/js/latest/api/http/ReadyStates-enum.jade
View File

@ -1,84 +1,9 @@
p.location-badge.
exported from <a href='../http'>angular2/http</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/http/enums.ts#L55-L68">angular2/src/http/enums.ts (line 55)</a>
:markdown
All possible states in which a connection can be, based on
[States](http://www.w3.org/TR/XMLHttpRequest/#states) from the `XMLHttpRequest` spec, but with an
additional "CANCELLED" state.
.l-main-section
h2 Members
.l-sub-section
h3 UNSENT
:markdown
.l-sub-section
h3 OPEN
:markdown
.l-sub-section
h3 HEADERS_RECEIVED
:markdown
.l-sub-section
h3 LOADING
:markdown
.l-sub-section
h3 DONE
:markdown
.l-sub-section
h3 CANCELLED
:markdown
<h1>angular2/http/ReadyStates</h1>
<h2>(enum)</h2>
<div>
<p>All possible states in which a connection can be, based on
<a href="http://www.w3.org/TR/XMLHttpRequest/#states">States</a> from the <code>XMLHttpRequest</code> spec, but with an
additional &quot;CANCELLED&quot; state.</p>
</div>

87
public/docs/js/latest/api/http/RequestCacheOpts-enum.jade
View File

@ -1,83 +1,8 @@
p.location-badge.
exported from <a href='../http'>angular2/http</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/http/enums.ts#L11-L24">angular2/src/http/enums.ts (line 11)</a>
:markdown
Acceptable cache option to be associated with a <a href='Request-class.html'><code>Request</code></a>, based on
[RequestCache](https://fetch.spec.whatwg.org/#requestcache) from the Fetch spec.
.l-main-section
h2 Members
.l-sub-section
h3 Default
:markdown
.l-sub-section
h3 NoStore
:markdown
.l-sub-section
h3 Reload
:markdown
.l-sub-section
h3 NoCache
:markdown
.l-sub-section
h3 ForceCache
:markdown
.l-sub-section
h3 OnlyIfCached
:markdown
<h1>angular2/http/RequestCacheOpts</h1>
<h2>(enum)</h2>
<div>
<p>Acceptable cache option to be associated with a <a href='Request-class.html'><code>Request</code></a>, based on
<a href="https://fetch.spec.whatwg.org/#requestcache">RequestCache</a> from the Fetch spec.</p>
</div>

51
public/docs/js/latest/api/http/RequestCredentialsOpts-enum.jade
View File

@ -1,47 +1,8 @@
p.location-badge.
exported from <a href='../http'>angular2/http</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/http/enums.ts#L24-L34">angular2/src/http/enums.ts (line 24)</a>
:markdown
Acceptable credentials option to be associated with a <a href='Request-class.html'><code>Request</code></a>, based on
[RequestCredentials](https://fetch.spec.whatwg.org/#requestcredentials) from the Fetch spec.
.l-main-section
h2 Members
.l-sub-section
h3 Omit
:markdown
.l-sub-section
h3 SameOrigin
:markdown
.l-sub-section
h3 Include
:markdown
<h1>angular2/http/RequestCredentialsOpts</h1>
<h2>(enum)</h2>
<div>
<p>Acceptable credentials option to be associated with a <a href='Request-class.html'><code>Request</code></a>, based on
<a href="https://fetch.spec.whatwg.org/#requestcredentials">RequestCredentials</a> from the Fetch spec.</p>
</div>

97
public/docs/js/latest/api/http/RequestMethods-enum.jade
View File

@ -1,94 +1,7 @@
p.location-badge.
exported from <a href='../http'>angular2/http</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/http/enums.ts#L34-L47">angular2/src/http/enums.ts (line 34)</a>
:markdown
Supported http methods.
.l-main-section
h2 Members
.l-sub-section
h3 GET
:markdown
.l-sub-section
h3 POST
:markdown
.l-sub-section
h3 PUT
:markdown
.l-sub-section
h3 DELETE
:markdown
.l-sub-section
h3 OPTIONS
:markdown
.l-sub-section
h3 HEAD
:markdown
.l-sub-section
h3 PATCH
:markdown
<h1>angular2/http/RequestMethods</h1>
<h2>(enum)</h2>
<div>
<p>Supported http methods.</p>
</div>

51
public/docs/js/latest/api/http/RequestModesOpts-enum.jade
View File

@ -1,47 +1,8 @@
p.location-badge.
exported from <a href='../http'>angular2/http</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/http/enums.ts#L1-L11">angular2/src/http/enums.ts (line 1)</a>
:markdown
Acceptable origin modes to be associated with a <a href='Request-class.html'><code>Request</code></a>, based on
[RequestMode](https://fetch.spec.whatwg.org/#requestmode) from the Fetch spec.
.l-main-section
h2 Members
.l-sub-section
h3 Cors
:markdown
.l-sub-section
h3 NoCors
:markdown
.l-sub-section
h3 SameOrigin
:markdown
<h1>angular2/http/RequestModesOpts</h1>
<h2>(enum)</h2>
<div>
<p>Acceptable origin modes to be associated with a <a href='Request-class.html'><code>Request</code></a>, based on
<a href="https://fetch.spec.whatwg.org/#requestmode">RequestMode</a> from the Fetch spec.</p>
</div>

75
public/docs/js/latest/api/http/ResponseTypes-enum.jade
View File

@ -1,71 +1,8 @@
p.location-badge.
exported from <a href='../http'>angular2/http</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.33/modules/angular2/src/http/enums.ts#L68-L80">angular2/src/http/enums.ts (line 68)</a>
:markdown
Acceptable response types to be associated with a <a href='Response-class.html'><code>Response</code></a>, based on
[ResponseType](https://fetch.spec.whatwg.org/#responsetype) from the Fetch spec.
.l-main-section
h2 Members
.l-sub-section
h3 Basic
:markdown
.l-sub-section
h3 Cors
:markdown
.l-sub-section
h3 Default
:markdown
.l-sub-section
h3 Error
:markdown
.l-sub-section
h3 Opaque
:markdown
<h1>angular2/http/ResponseTypes</h1>
<h2>(enum)</h2>
<div>
<p>Acceptable response types to be associated with a <a href='Response-class.html'><code>Response</code></a>, based on
<a href="https://fetch.spec.whatwg.org/#responsetype">ResponseType</a> from the Fetch spec.</p>
</div>