honeymoose/Angular-Cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(api): more updates for harp 0.17.0

Browse Source
This commit is contained in:
Naomi Black
2015-07-28 13:41:07 -07:00
parent 9169409c21
commit 111cbe8bce
233 changed files with 1364 additions and 3453 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/docs/js/latest/api/annotations/AttributeAnnotation-class.jade
+10 -3
View File
@@ -30,6 +30,16 @@ p.location-badge.
```
.l-main-section
h2 Annotations
.l-sub-section
h3.annotation CONST
pre.prettyprint
code.
@CONST()
.l-main-section
h2 Members
.l-sub-section
@@ -52,7 +62,6 @@ p.location-badge.
:markdown
@@ -65,7 +74,6 @@ p.location-badge.
:markdown
@@ -82,7 +90,6 @@ p.location-badge.
toString()
:markdown
public/docs/js/latest/api/annotations/ClassDefinition-interface.jade
-2
View File
@@ -14,7 +14,6 @@ p.location-badge.
:markdown
Optional argument for specifying the superclass.
@@ -28,7 +27,6 @@ p.location-badge.
:markdown
Required constructor function for a class.
The function may be optionally wrapped in an `Array`, in which case additional parameter
public/docs/js/latest/api/annotations/ComponentAnnotation-class.jade
+12 -3
View File
@@ -15,7 +15,8 @@ p.location-badge.
- creates a shadow DOM for the component.
- loads the selected template into the shadow DOM.
- creates all the injectable objects configured with `hostInjector` and `viewInjector`.
All template expressions and statements are then evaluated against the component instance.
For details on the `@View` annotation, see <a href='View-var.html'><code>View</code></a>.
@@ -39,6 +40,16 @@ p.location-badge.
```
.l-main-section
h2 Annotations
.l-sub-section
h3.annotation CONST
pre.prettyprint
code.
@CONST()
.l-main-section
h2 Members
.l-sub-section
@@ -73,7 +84,6 @@ p.location-badge.
:markdown
Defines the used change detection strategy.
When a component is instantiated, Angular creates a change detector, which is responsible for
@@ -95,7 +105,6 @@ p.location-badge.
:markdown
Defines the set of injectable objects that are visible to its view dom children.
## Simple Example
public/docs/js/latest/api/annotations/ComponentDecorator-interface.jade
-1
View File
@@ -27,7 +27,6 @@ p.location-badge.
})
:markdown
Chain <a href='View-var.html'><code>View</code></a> annotation.
public/docs/js/latest/api/annotations/DirectiveAnnotation-class.jade
+10 -8
View File
@@ -382,6 +382,16 @@ p.location-badge.
view occurs on the second `<li></li>` which is a sibling to the `<template>` element.
.l-main-section
h2 Annotations
.l-sub-section
h3.annotation CONST
pre.prettyprint
code.
@CONST()
.l-main-section
h2 Members
.l-sub-section
@@ -416,7 +426,6 @@ p.location-badge.
:markdown
The CSS selector that triggers the instantiation of a directive.
Angular only allows directives to trigger on CSS selectors that do not cross element
@@ -458,7 +467,6 @@ p.location-badge.
:markdown
Enumerates the set of properties that accept data binding for a directive.
The `properties` property defines a set of `directiveProperty` to `bindingProperty`
@@ -561,7 +569,6 @@ p.location-badge.
:markdown
Enumerates the set of emitted events.
## Syntax
@@ -614,7 +621,6 @@ p.location-badge.
:markdown
Specifiy the events, actions, properties and attributes related to the host element.
## Events
@@ -750,7 +756,6 @@ p.location-badge.
:markdown
Specifies which lifecycle should be notified to the directive.
See <a href='LifecycleEvent-enum.html'><code>LifecycleEvent</code></a> for details.
@@ -766,7 +771,6 @@ p.location-badge.
:markdown
If set to false the compiler does not compile the children of this directive.
@@ -780,7 +784,6 @@ p.location-badge.
:markdown
Defines the set of injectable objects that are visible to a Directive and its light dom
children.
@@ -821,7 +824,6 @@ p.location-badge.
:markdown
Defines the name that can be used in the template to assign this directive to a variable.
## Simple Example
public/docs/js/latest/api/annotations/OnAllChangesDone-interface.jade
-1
View File
@@ -19,7 +19,6 @@ p.location-badge.
onAllChangesDone()
:markdown
public/docs/js/latest/api/annotations/OnChange-interface.jade
-1
View File
@@ -19,7 +19,6 @@ p.location-badge.
onChange(changes: StringMap&lt;string, any&gt;)
:markdown
public/docs/js/latest/api/annotations/OnCheck-interface.jade
-1
View File
@@ -18,7 +18,6 @@ p.location-badge.
onCheck()
:markdown
public/docs/js/latest/api/annotations/OnDestroy-interface.jade
-1
View File
@@ -18,7 +18,6 @@ p.location-badge.
onDestroy()
:markdown
public/docs/js/latest/api/annotations/OnInit-interface.jade
-1
View File
@@ -18,7 +18,6 @@ p.location-badge.
onInit()
:markdown
public/docs/js/latest/api/annotations/QueryAnnotation-class.jade
+10 -6
View File
@@ -9,6 +9,16 @@ p.location-badge.
See <a href='../core/QueryList-class.html'><code>QueryList</code></a> for usage and example.
.l-main-section
h2 Annotations
.l-sub-section
h3.annotation CONST
pre.prettyprint
code.
@CONST()
.l-main-section
h2 Members
.l-sub-section
@@ -31,7 +41,6 @@ p.location-badge.
:markdown
@@ -44,7 +53,6 @@ p.location-badge.
:markdown
@@ -57,7 +65,6 @@ p.location-badge.
:markdown
@@ -70,7 +77,6 @@ p.location-badge.
:markdown
@@ -83,7 +89,6 @@ p.location-badge.
:markdown
@@ -100,7 +105,6 @@ p.location-badge.
toString()
:markdown
public/docs/js/latest/api/annotations/TypeDecorator-interface.jade
-2
View File
@@ -33,7 +33,6 @@ p.location-badge.
:markdown
Storage for the accumulated annotations so far used by the DSL syntax.
Used by <a href='Class-function.html'><code>Class</code></a> to annotate the generated class.
@@ -53,7 +52,6 @@ p.location-badge.
Class(obj: ClassDefinition)
:markdown
Generate a class from the definition and annotate it with <a href='TypeDecorator-interface.html#annotations'><code>TypeDecorator</code></a>.
public/docs/js/latest/api/annotations/ViewAnnotation-class.jade
+10 -6
View File
@@ -35,6 +35,16 @@ p.location-badge.
```
.l-main-section
h2 Annotations
.l-sub-section
h3.annotation CONST
pre.prettyprint
code.
@CONST()
.l-main-section
h2 Members
.l-sub-section
@@ -64,7 +74,6 @@ p.location-badge.
:markdown
Specifies an inline template for an angular component.
NOTE: either `templateUrl` or `template` should be used, but not both.
@@ -80,7 +89,6 @@ p.location-badge.
:markdown
Specifies a template URL for an angular component.
NOTE: either `templateUrl` or `template` should be used, but not both.
@@ -96,7 +104,6 @@ p.location-badge.
:markdown
Specifies stylesheet URLs for an angular component.
@@ -110,7 +117,6 @@ p.location-badge.
:markdown
Specifies an inline stylesheet for an angular component.
@@ -124,7 +130,6 @@ p.location-badge.
:markdown
Specifies a list of directives that can be used within a template.
Directives must be listed explicitly to provide proper component encapsulation.
@@ -157,7 +162,6 @@ p.location-badge.
:markdown
Specify a custom renderer for this View.
If this is set, neither `template`, `templateUrl`, `styles`, `styleUrls` nor `directives` are
used.
public/docs/js/latest/api/annotations/ViewDecorator-interface.jade
-1
View File
@@ -27,7 +27,6 @@ p.location-badge.
})
:markdown
Chain <a href='View-var.html'><code>View</code></a> annotation.
public/docs/js/latest/api/change_detection/AST-class.jade
-90
View File
@@ -1,90 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/parser/ast.ts#L3-L15">angular2/src/change_detection/parser/ast.ts (line 3)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 eval
pre.prettyprint
code.
eval(context: any, locals: Locals)
:markdown
.l-sub-section
h3 isAssignable
:markdown
.l-sub-section
h3 assign
pre.prettyprint
code.
assign(context: any, locals: Locals, value: any)
:markdown
.l-sub-section
h3 visit
pre.prettyprint
code.
visit(visitor: AstVisitor)
:markdown
.l-sub-section
h3 toString
pre.prettyprint
code.
toString()
:markdown
public/docs/js/latest/api/change_detection/ASTWithSource-class.jade
-144
View File
@@ -1,144 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/parser/ast.ts#L310-L326">angular2/src/change_detection/parser/ast.ts (line 310)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor(ast: AST, source: string, location: string)
:markdown
.l-sub-section
h3 ast
:markdown
.l-sub-section
h3 source
:markdown
.l-sub-section
h3 location
:markdown
.l-sub-section
h3 eval
pre.prettyprint
code.
eval(context: any, locals: Locals)
:markdown
.l-sub-section
h3 isAssignable
:markdown
.l-sub-section
h3 assign
pre.prettyprint
code.
assign(context: any, locals: Locals, value: any)
:markdown
.l-sub-section
h3 visit
pre.prettyprint
code.
visit(visitor: AstVisitor)
:markdown
.l-sub-section
h3 toString
pre.prettyprint
code.
toString()
:markdown
public/docs/js/latest/api/change_detection/AccessMember-class.jade
-140
View File
@@ -1,140 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/parser/ast.ts#L75-L107">angular2/src/change_detection/parser/ast.ts (line 75)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor(receiver: AST, name: string, getter: Function, setter: Function)
:markdown
.l-sub-section
h3 receiver
:markdown
.l-sub-section
h3 name
:markdown
.l-sub-section
h3 getter
:markdown
.l-sub-section
h3 setter
:markdown
.l-sub-section
h3 eval
pre.prettyprint
code.
eval(context: any, locals: Locals)
:markdown
.l-sub-section
h3 isAssignable
:markdown
.l-sub-section
h3 assign
pre.prettyprint
code.
assign(context: any, locals: Locals, value: any)
:markdown
.l-sub-section
h3 visit
pre.prettyprint
code.
visit(visitor: AstVisitor)
:markdown
public/docs/js/latest/api/change_detection/AstTransformer-class.jade
-332
View File
File diff suppressed because it is too large Load Diff
public/docs/js/latest/api/change_detection/BasePipe-class.jade
+13 -6
View File
@@ -1,15 +1,15 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/pipes/pipe.ts#L55-L75">angular2/src/change_detection/pipes/pipe.ts (line 55)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/pipes/pipe.ts#L58-L78">angular2/src/change_detection/pipes/pipe.ts (line 58)</a>
:markdown
Provides default implementation of supports and onDestroy.
Provides default implementation of `supports` and `onDestroy` method.
#Example
```
class DoublePipe extends BasePipe {*
class DoublePipe extends BasePipe {
transform(value) {
return `${value}${value}`;
}
@@ -17,6 +17,16 @@ p.location-badge.
```
.l-main-section
h2 Annotations
.l-sub-section
h3.annotation CONST
pre.prettyprint
code.
@CONST()
.l-main-section
h2 Members
.l-sub-section
@@ -28,7 +38,6 @@ p.location-badge.
supports(obj: any)
:markdown
@@ -45,7 +54,6 @@ p.location-badge.
onDestroy()
:markdown
@@ -62,7 +70,6 @@ p.location-badge.
transform(value: any, args: List&lt;any&gt;)
:markdown
public/docs/js/latest/api/change_detection/BindingRecord-class.jade
-294
View File
@@ -1,294 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/binding_record.ts#L12-L113">angular2/src/change_detection/binding_record.ts (line 12)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor(mode: string, implicitReceiver: any, ast: AST, elementIndex: number, propertyName: string, propertyUnit: string, setter: SetterFn, lifecycleEvent: string, directiveRecord: DirectiveRecord)
:markdown
.l-sub-section
h3 mode
:markdown
.l-sub-section
h3 implicitReceiver
:markdown
.l-sub-section
h3 ast
:markdown
.l-sub-section
h3 elementIndex
:markdown
.l-sub-section
h3 propertyName
:markdown
.l-sub-section
h3 propertyUnit
:markdown
.l-sub-section
h3 setter
:markdown
.l-sub-section
h3 lifecycleEvent
:markdown
.l-sub-section
h3 directiveRecord
:markdown
.l-sub-section
h3 callOnChange
pre.prettyprint
code.
callOnChange()
:markdown
.l-sub-section
h3 isOnPushChangeDetection
pre.prettyprint
code.
isOnPushChangeDetection()
:markdown
.l-sub-section
h3 isDirective
pre.prettyprint
code.
isDirective()
:markdown
.l-sub-section
h3 isDirectiveLifecycle
pre.prettyprint
code.
isDirectiveLifecycle()
:markdown
.l-sub-section
h3 isElementProperty
pre.prettyprint
code.
isElementProperty()
:markdown
.l-sub-section
h3 isElementAttribute
pre.prettyprint
code.
isElementAttribute()
:markdown
.l-sub-section
h3 isElementClass
pre.prettyprint
code.
isElementClass()
:markdown
.l-sub-section
h3 isElementStyle
pre.prettyprint
code.
isElementStyle()
:markdown
.l-sub-section
h3 isTextNode
pre.prettyprint
code.
isTextNode()
:markdown
public/docs/js/latest/api/change_detection/CHECKED-var.jade → public/docs/js/latest/api/change_detection/CHECKED-const.jade
View File
public/docs/js/latest/api/change_detection/CHECK_ALWAYS-var.jade → public/docs/js/latest/api/change_detection/CHECK_ALWAYS-const.jade
View File
public/docs/js/latest/api/change_detection/CHECK_ONCE-var.jade → public/docs/js/latest/api/change_detection/CHECK_ONCE-const.jade
View File
public/docs/js/latest/api/change_detection/ChangeDetection-class.jade
-49
View File
@@ -1,49 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/interfaces.ts#L5-L37">angular2/src/change_detection/interfaces.ts (line 5)</a>
:markdown
Interface used by Angular to control the change detection strategy for an application.
Angular implements the following change detection strategies by default:
- <a href='DynamicChangeDetection-class.html'><code>DynamicChangeDetection</code></a>: slower, but does not require `eval()`.
- <a href='JitChangeDetection-class.html'><code>JitChangeDetection</code></a>: faster, but requires `eval()`.
In JavaScript, you should always use `JitChangeDetection`, unless you are in an environment that
has
[CSP](https://developer.mozilla.org/en-US/docs/Web/Security/CSP), such as a Chrome Extension.
In Dart, use `DynamicChangeDetection` during development. The Angular transformer generates an
analog to the
`JitChangeDetection` strategy at compile time.
See: <a href='DynamicChangeDetection-class.html'><code>DynamicChangeDetection</code></a>, <a href='JitChangeDetection-class.html'><code>JitChangeDetection</code></a>,
<a href='PreGeneratedChangeDetection-class.html'><code>PreGeneratedChangeDetection</code></a>
# Example
```javascript
bootstrap(MyApp, [bind(ChangeDetection).toClass(DynamicChangeDetection)]);
```
.l-main-section
h2 Members
.l-sub-section
h3 createProtoChangeDetector
pre.prettyprint
code.
createProtoChangeDetector(definition: ChangeDetectorDefinition)
:markdown
public/docs/js/latest/api/change_detection/ChangeDetectionError-class.jade
+6 -3
View File
@@ -1,9 +1,12 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/exceptions.ts#L9-L19">angular2/src/change_detection/exceptions.ts (line 9)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/exceptions.ts#L18-L36">angular2/src/change_detection/exceptions.ts (line 18)</a>
:markdown
Thrown when an expression evaluation raises an exception.
This error wraps the original exception, this is done to attach expression location information.
.l-main-section
@@ -14,7 +17,7 @@ p.location-badge.
pre.prettyprint
code.
constructor(proto: ProtoRecord, originalException: any, originalStack: any)
constructor(proto: ProtoRecord, originalException: any, originalStack: any, context: any)
:markdown
@@ -28,7 +31,7 @@ p.location-badge.
:markdown
Location of the expression.
public/docs/js/latest/api/change_detection/ChangeDetector-interface.jade
-205
View File
@@ -1,205 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/interfaces.ts#L42-L59">angular2/src/change_detection/interfaces.ts (line 42)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 parent
:markdown
.l-sub-section
h3 mode
:markdown
.l-sub-section
h3 addChild
pre.prettyprint
code.
addChild(cd: ChangeDetector)
:markdown
.l-sub-section
h3 addShadowDomChild
pre.prettyprint
code.
addShadowDomChild(cd: ChangeDetector)
:markdown
.l-sub-section
h3 removeChild
pre.prettyprint
code.
removeChild(cd: ChangeDetector)
:markdown
.l-sub-section
h3 removeShadowDomChild
pre.prettyprint
code.
removeShadowDomChild(cd: ChangeDetector)
:markdown
.l-sub-section
h3 remove
pre.prettyprint
code.
remove()
:markdown
.l-sub-section
h3 hydrate
pre.prettyprint
code.
hydrate(context: any, locals: Locals, directives: any, pipes: any)
:markdown
.l-sub-section
h3 dehydrate
pre.prettyprint
code.
dehydrate()
:markdown
.l-sub-section
h3 markPathToRootAsCheckOnce
pre.prettyprint
code.
markPathToRootAsCheckOnce()
:markdown
.l-sub-section
h3 detectChanges
pre.prettyprint
code.
detectChanges()
:markdown
.l-sub-section
h3 checkNoChanges
pre.prettyprint
code.
checkNoChanges()
:markdown
public/docs/js/latest/api/change_detection/ChangeDetectorDefinition-class.jade
-89
View File
@@ -1,89 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/interfaces.ts#L61-L67">angular2/src/change_detection/interfaces.ts (line 61)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 constructor
pre.prettyprint
code.
constructor(id: string, strategy: string, variableNames: List&lt;string&gt;, bindingRecords: List&lt;BindingRecord&gt;, directiveRecords: List&lt;DirectiveRecord&gt;)
:markdown
.l-sub-section
h3 id
:markdown
.l-sub-section
h3 strategy
:markdown
.l-sub-section
h3 variableNames
:markdown
.l-sub-section
h3 bindingRecords
:markdown
.l-sub-section
h3 directiveRecords
:markdown
public/docs/js/latest/api/change_detection/ChangeDetectorRef-class.jade
+2 -7
View File
@@ -1,14 +1,13 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/change_detector_ref.ts#L2-L37">angular2/src/change_detection/change_detector_ref.ts (line 2)</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/change_detector_ref.ts#L2-L39">angular2/src/change_detection/change_detector_ref.ts (line 2)</a>
:markdown
Controls change detection.
<a href='ChangeDetectorRef-class.html'><code>ChangeDetectorRef</code></a> allows requesting checks for detectors that rely on observables. It
also allows detaching and
attaching change detector subtrees.
also allows detaching and attaching change detector subtrees.
.l-main-section
@@ -23,7 +22,6 @@ p.location-badge.
:markdown
@@ -37,7 +35,6 @@ p.location-badge.
requestCheck()
:markdown
Request to check all ON_PUSH ancestors.
@@ -55,7 +52,6 @@ p.location-badge.
detach()
:markdown
Detaches the change detector from the change detector tree.
The detached change detector will not be checked until it is reattached.
@@ -75,7 +71,6 @@ p.location-badge.
reattach()
:markdown
Reattach the change detector to the change detector tree.
This also requests a check of this change detector. This reattached change detector will be
public/docs/js/latest/api/change_detection/ChangeDispatcher-interface.jade
-43
View File
@@ -1,43 +0,0 @@
p.location-badge.
exported from <a href='../change_detection'>angular2/change_detection</a>
defined in <a href="https://github.com/angular/angular/tree/2.0.0-alpha.32/modules/angular2/src/change_detection/interfaces.ts#L37-L42">angular2/src/change_detection/interfaces.ts (line 37)</a>
:markdown
.l-main-section
h2 Members
.l-sub-section
h3 notifyOnBinding
pre.prettyprint
code.
notifyOnBinding(bindingRecord: BindingRecord, value: any)
:markdown
.l-sub-section
h3 notifyOnAllChangesDone
pre.prettyprint
code.
notifyOnAllChangesDone()
:markdown
public/docs/js/latest/api/change_detection/DEFAULT-var.jade → public/docs/js/latest/api/change_detection/DEFAULT-const.jade
View File

Some files were not shown because too many files have changed in this diff Show More