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

docs(api): update API docs to head

This commit is contained in:
Naomi Black 2015-05-18 17:39:04 -07:00
parent 92f82d1114
commit 9d30e6da41
28 changed files with 152 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
public/docs/js/latest/api/annotations/_data.json
View File

@ -1,7 +1,7 @@
{ {
"index" : { "index" : {
"title" : "Annotations", "title" : "Annotations",
"intro" : "Annotations provide the additional information that Angular requires in order to run your application. This module contains <a href='Component-class.html'><code>Component</code></a>, <a href='Directive-class.html'><code>Directive</code></a>, and <a href='View-class.html'><code>View</code></a> annotations, as well as <a href='Parent-class.html'><code>Parent</code></a> and <a href='Ancestor-class.html'><code>Ancestor</code></a> annotations that are used by Angular to resolve dependencies." "intro" : "Annotations provide the additional information that Angular requires in order to run your application. This modulecontains <a href='Component-class.html'><code>Component</code></a>, <a href='Directive-class.html'><code>Directive</code></a>, and <a href='View-class.html'><code>View</code></a> annotations, as well as <a href='Parent-class.html'><code>Parent</code></a> and <a href='Ancestor-class.html'><code>Ancestor</code></a> annotations that areused by Angular to resolve dependencies."
}, },
"Directive-class" : { "Directive-class" : {
@ -43,4 +43,4 @@
"Ancestor-class" : { "Ancestor-class" : {
"title" : "Ancestor Class" "title" : "Ancestor Class"
} }
} }

2
public/docs/js/latest/api/change_detection/ChangeDetection-class.jade
View File

@ -32,7 +32,7 @@ p.location-badge.
pre.prettyprint pre.prettyprint
code. code.
createProtoChangeDetector(name:string, changeControlStrategy:string=DEFAULT) createProtoChangeDetector(name:string, bindingRecords:List, variableBindings:List, directiveRecords:List, changeControlStrategy:string=DEFAULT)
:markdown :markdown

4
public/docs/js/latest/api/change_detection/DynamicChangeDetection-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/change_detection.html">angular2/change_detection</a> exported from <a href="/angular2/change_detection.html">angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/change_detection.js#L55">angular2/src/change_detection/change_detection.js (line 55)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/change_detection.js#L59">angular2/src/change_detection/change_detection.js (line 59)</a>
:markdown :markdown
Implements change detection that does not require `eval()`. Implements change detection that does not require `eval()`.
@ -30,7 +30,7 @@ p.location-badge.
pre.prettyprint pre.prettyprint
code. code.
createProtoChangeDetector(name:string, changeControlStrategy:string = DEFAULT) createProtoChangeDetector(name:string, bindingRecords:List&lt;BindingRecord&gt;, variableBindings:List&lt;string&gt;, directiveRecords:List&lt;DirectiveRecord&gt;, changeControlStrategy:string = DEFAULT)
:markdown :markdown

4
public/docs/js/latest/api/change_detection/JitChangeDetection-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/change_detection.html">angular2/change_detection</a> exported from <a href="/angular2/change_detection.html">angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/change_detection.js#L76">angular2/src/change_detection/change_detection.js (line 76)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/change_detection.js#L81">angular2/src/change_detection/change_detection.js (line 81)</a>
:markdown :markdown
Implements faster change detection, by generating source code. Implements faster change detection, by generating source code.
@ -30,7 +30,7 @@ p.location-badge.
pre.prettyprint pre.prettyprint
code. code.
createProtoChangeDetector(name:string, changeControlStrategy:string = DEFAULT) createProtoChangeDetector(name:string, bindingRecords:List&lt;BindingRecord&gt;, variableBindings:List&lt;string&gt;, directiveRecords:List&lt;DirectiveRecord&gt;, changeControlStrategy:string = DEFAULT)
:markdown :markdown

2
public/docs/js/latest/api/core/ViewContainerRef-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/core.html">angular2/core</a> exported from <a href="/angular2/core.html">angular2/core</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/view_container_ref.js#L12">angular2/src/core/compiler/view_container_ref.js (line 12)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/view_container_ref.js#L11">angular2/src/core/compiler/view_container_ref.js (line 11)</a>
:markdown :markdown

2
public/docs/js/latest/api/di_annotations/DependencyAnnotation-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a> exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations.js#L110">angular2/src/di/annotations.js (line 110)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations_impl.js#L110">angular2/src/di/annotations_impl.js (line 110)</a>
:markdown :markdown
`DependencyAnnotation` is used by the framework to extend DI. `DependencyAnnotation` is used by the framework to extend DI.

2
public/docs/js/latest/api/di_annotations/Inject-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a> exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations.js#L13">angular2/src/di/annotations.js (line 13)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations_impl.js#L13">angular2/src/di/annotations_impl.js (line 13)</a>
:markdown :markdown
A parameter annotation that specifies a dependency. A parameter annotation that specifies a dependency.

2
public/docs/js/latest/api/di_annotations/InjectLazy-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a> exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations.js#L55">angular2/src/di/annotations.js (line 55)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations_impl.js#L55">angular2/src/di/annotations_impl.js (line 55)</a>
:markdown :markdown
A parameter annotation that creates a synchronous lazy dependency. A parameter annotation that creates a synchronous lazy dependency.

2
public/docs/js/latest/api/di_annotations/InjectPromise-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a> exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations.js#L34">angular2/src/di/annotations.js (line 34)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations_impl.js#L34">angular2/src/di/annotations_impl.js (line 34)</a>
:markdown :markdown
A parameter annotation that specifies a `Promise` of a dependency. A parameter annotation that specifies a `Promise` of a dependency.

2
public/docs/js/latest/api/di_annotations/Injectable-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a> exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations.js#L134">angular2/src/di/annotations.js (line 134)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations_impl.js#L134">angular2/src/di/annotations_impl.js (line 134)</a>
:markdown :markdown
A marker annotation that marks a class as available to `Injector` for creation. Used by tooling for A marker annotation that marks a class as available to `Injector` for creation. Used by tooling for

2
public/docs/js/latest/api/di_annotations/Optional-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a> exported from <a href="/angular2/di_annotations.html">angular2/di_annotations</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations.js#L77">angular2/src/di/annotations.js (line 77)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/di/annotations_impl.js#L77">angular2/src/di/annotations_impl.js (line 77)</a>
:markdown :markdown
A parameter annotation that marks a dependency as optional. <a href='../di/Injector-class.html'><code>Injector</code></a> provides `null` if the dependency is not A parameter annotation that marks a dependency as optional. <a href='../di/Injector-class.html'><code>Injector</code></a> provides `null` if the dependency is not

14
public/docs/js/latest/api/pipes/AsyncPipeFactory-class.jade
View File

@ -8,6 +8,20 @@ p.location-badge.
.l-main-section .l-main-section
h2 Members h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor()
:markdown
.l-sub-section .l-sub-section
h3 create h3 create

2
public/docs/js/latest/api/pipes/CollectionChangeRecord-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a> exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/iterable_changes.js#L509">angular2/src/change_detection/pipes/iterable_changes.js (line 509)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/iterable_changes.js#L515">angular2/src/change_detection/pipes/iterable_changes.js (line 515)</a>
:markdown :markdown

2
public/docs/js/latest/api/pipes/IterableChanges-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a> exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/iterable_changes.js#L31">angular2/src/change_detection/pipes/iterable_changes.js (line 31)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/iterable_changes.js#L37">angular2/src/change_detection/pipes/iterable_changes.js (line 37)</a>
:markdown :markdown

2
public/docs/js/latest/api/pipes/KVChangeRecord-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a> exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/keyvalue_changes.js#L360">angular2/src/change_detection/pipes/keyvalue_changes.js (line 360)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/keyvalue_changes.js#L365">angular2/src/change_detection/pipes/keyvalue_changes.js (line 365)</a>
:markdown :markdown

2
public/docs/js/latest/api/pipes/KeyValueChanges-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a> exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/keyvalue_changes.js#L21">angular2/src/change_detection/pipes/keyvalue_changes.js (line 21)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/keyvalue_changes.js#L26">angular2/src/change_detection/pipes/keyvalue_changes.js (line 26)</a>
:markdown :markdown

14
public/docs/js/latest/api/pipes/KeyValueChangesFactory-class.jade
View File

@ -7,6 +7,20 @@ p.location-badge.
.l-main-section .l-main-section
h2 Members h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor()
:markdown
.l-sub-section .l-sub-section
h3 create h3 create

2
public/docs/js/latest/api/pipes/NullPipe-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a> exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/null_pipe.js#L19">angular2/src/change_detection/pipes/null_pipe.js (line 19)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/null_pipe.js#L24">angular2/src/change_detection/pipes/null_pipe.js (line 24)</a>
:markdown :markdown

14
public/docs/js/latest/api/pipes/NullPipeFactory-class.jade
View File

@ -7,6 +7,20 @@ p.location-badge.
.l-main-section .l-main-section
h2 Members h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor()
:markdown
.l-sub-section .l-sub-section
h3 create h3 create

2
public/docs/js/latest/api/pipes/Pipe-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a> exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/pipe.js#L52">angular2/src/change_detection/pipes/pipe.js (line 52)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/pipe.js#L54">angular2/src/change_detection/pipes/pipe.js (line 54)</a>
:markdown :markdown
An interface for extending the list of pipes known to Angular. An interface for extending the list of pipes known to Angular.

53
public/docs/js/latest/api/pipes/WrappedValue-class.jade Normal file
View File

@ -0,0 +1,53 @@
p.location-badge.
exported from <a href="/angular2/pipes.html">angular2/pipes</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/change_detection/pipes/pipe.js#L9">angular2/src/change_detection/pipes/pipe.js (line 9)</a>
:markdown
Indicates that the result of a <a href='Pipe-class.html'><code>Pipe</code></a> transformation has changed even though the reference has not changed.
The wrapped value will be unwrapped by change detection, and the unwrapped value will be stored.
.l-main-section
h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor(wrapped:any)
:markdown
.l-sub-section
h3 wrap
pre.prettyprint
code.
wrap(value:any)
:markdown
.l-sub-section
h3 wrapped
:markdown

4
public/docs/js/latest/api/pipes/_data.json
View File

@ -52,6 +52,10 @@
"title" : "NullPipe Class" "title" : "NullPipe Class"
}, },
"WrappedValue-class" : {
"title" : "WrappedValue Class"
},
"Pipe-class" : { "Pipe-class" : {
"title" : "Pipe Class" "title" : "Pipe Class"
} }

39
public/docs/js/latest/api/router/Router-class.jade
View File

@ -1,10 +1,10 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/router.html">angular2/router</a> exported from <a href="/angular2/router.html">angular2/router</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/router/router.js#L18">angular2/src/router/router.js (line 18)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/router/router.js#L19">angular2/src/router/router.js (line 19)</a>
:markdown :markdown
## Router # Router
The router is responsible for mapping URLs to components. The router is responsible for mapping URLs to components.
You can see the state of the router by inspecting the read-only field `router.navigating`. You can see the state of the router by inspecting the read-only field `router.navigating`.
@ -18,7 +18,7 @@ p.location-badge.
pre.prettyprint pre.prettyprint
code. code.
constructor(registry:RouteRegistry, pipeline:Pipeline, parent:Router = null, name = &#39;/&#39;) constructor(registry:RouteRegistry, pipeline:Pipeline, location:Location, parent:Router, hostComponent)
:markdown :markdown
@ -64,16 +64,25 @@ p.location-badge.
pre.prettyprint pre.prettyprint
code. code.
config(path:string, component, alias:string=null) config(config:any)
:markdown :markdown
Update the routing configuration and trigger a navigation. Update the routing configuration and trigger a navigation.
### Usage # Usage
``` ```
router.config('/', SomeCmp); router.config({ 'path': '/', 'component': IndexCmp});
```
Or:
```
router.config([
{ 'path': '/', 'component': IndexComp },
{ 'path': '/user/:id', 'component': UserComp },
]);
``` ```
@ -97,13 +106,9 @@ p.location-badge.
.l-sub-section .l-sub-section
h3 getRoot h3 hostComponent
pre.prettyprint
code.
getRoot()
:markdown :markdown
@ -124,18 +129,6 @@ p.location-badge.
.l-sub-section
h3 name
:markdown
.l-sub-section .l-sub-section
h3 navigate h3 navigate

4
public/docs/js/latest/api/router/_data.json
View File

@ -4,6 +4,10 @@
"intro" : "Maps application URLs into application states, to support deep-linking and navigation." "intro" : "Maps application URLs into application states, to support deep-linking and navigation."
}, },
"routerInjectables-var" : {
"title" : "routerInjectables Var"
},
"Router-class" : { "Router-class" : {
"title" : "Router Class" "title" : "Router Class"
}, },

9
public/docs/js/latest/api/router/routerInjectables-var.jade Normal file
View File

@ -0,0 +1,9 @@
.l-main-section
h2 routerInjectables <span class="type">variable</span>
p.location-badge.
exported from <a href="/angular2/router.html">angular2/router</a>
:markdown

4
public/docs/js/latest/api/view/Compiler-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/view.html">angular2/view</a> exported from <a href="/angular2/view.html">angular2/view</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/compiler.js#L47">angular2/src/core/compiler/compiler.js (line 47)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/compiler.js#L48">angular2/src/core/compiler/compiler.js (line 48)</a>
:markdown :markdown
@ -13,7 +13,7 @@ p.location-badge.
pre.prettyprint pre.prettyprint
code. code.
constructor(reader: DirectiveMetadataReader, cache:CompilerCache, templateResolver: TemplateResolver, componentUrlMapper: ComponentUrlMapper, urlResolver: UrlResolver, renderer: renderApi.Renderer, protoViewFactory: ProtoViewFactory) constructor(reader: DirectiveMetadataReader, cache:CompilerCache, templateResolver: TemplateResolver, componentUrlMapper: ComponentUrlMapper, urlResolver: UrlResolver, render: renderApi.RenderCompiler, protoViewFactory: ProtoViewFactory)
:markdown :markdown

2
public/docs/js/latest/api/view/ComponentRef-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/view.html">angular2/view</a> exported from <a href="/angular2/view.html">angular2/view</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/dynamic_component_loader.js#L10">angular2/src/core/compiler/dynamic_component_loader.js (line 10)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/dynamic_component_loader.js#L11">angular2/src/core/compiler/dynamic_component_loader.js (line 11)</a>
:markdown :markdown

2
public/docs/js/latest/api/view/DynamicComponentLoader-class.jade
View File

@ -1,7 +1,7 @@
p.location-badge. p.location-badge.
exported from <a href="/angular2/view.html">angular2/view</a> exported from <a href="/angular2/view.html">angular2/view</a>
defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/dynamic_component_loader.js#L37">angular2/src/core/compiler/dynamic_component_loader.js (line 37)</a> defined in <a href="https://github.com/angular/angular/tree/master/modules/angular2/src/core/compiler/dynamic_component_loader.js#L38">angular2/src/core/compiler/dynamic_component_loader.js (line 38)</a>
:markdown :markdown
Service for dynamically loading a Component into an arbitrary position in the internal Angular Service for dynamically loading a Component into an arbitrary position in the internal Angular