From b9a53c023d1ceda1f64f58da9118a59cc03addf7 Mon Sep 17 00:00:00 2001 From: Naomi Black Date: Tue, 11 Aug 2015 17:09:57 -0700 Subject: [PATCH] docs: renames for the API public surface per alpha-35 --- .../latest/api/annotations/Attribute-var.jade | 2 +- .../AttributeFactory-interface.jade | 2 +- .../latest/api/annotations/Component-var.jade | 2 +- .../ComponentAnnotation-class.jade | 2 +- .../ComponentDecorator-interface.jade | 3 +- .../ComponentFactory-interface.jade | 2 +- .../latest/api/annotations/Directive-var.jade | 2 +- .../DirectiveAnnotation-class.jade | 32 +-- .../DirectiveDecorator-interface.jade | 2 +- .../DirectiveFactory-interface.jade | 2 +- .../api/annotations/LifecycleEvent-enum.jade | 2 +- .../js/latest/api/annotations/Pipe-var.jade | 12 + .../api/annotations/PipeAnnotation-class.jade | 58 +++++ .../annotations/PipeFactory-interface.jade | 24 ++ .../js/latest/api/annotations/Query-var.jade | 2 +- .../annotations/QueryFactory-interface.jade | 2 +- .../js/latest/api/annotations/View-var.jade | 2 +- .../api/annotations/ViewAnnotation-class.jade | 17 +- .../annotations/ViewDecorator-interface.jade | 3 +- .../annotations/ViewFactory-interface.jade | 2 +- .../latest/api/annotations/ViewQuery-var.jade | 2 +- .../docs/js/latest/api/annotations/_data.json | 12 + .../docs/js/latest/api/annotations/index.jade | 2 +- .../api/change_detection/BasePipe-class.jade | 78 ------ .../ChangeDetector-interface.jade | 14 +- .../api/change_detection/NullPipe-class.jade | 53 ---- .../NullPipeFactory-class.jade | 51 ---- .../api/change_detection/Pipe-interface.jade | 75 ------ .../PipeFactory-interface.jade | 42 ---- .../PipeOnDestroy-interface.jade | 44 ++++ .../PipeTransform-interface.jade | 36 +++ .../api/change_detection/Pipes-class.jade | 84 ------- .../change_detection/WrappedValue-class.jade | 15 +- .../js/latest/api/change_detection/_data.json | 28 +-- .../change_detection/defaultPipes-const.jade | 11 - .../js/latest/api/change_detection/index.jade | 2 +- ...en-const.jade => APP_COMPONENT-const.jade} | 2 +- .../latest/api/core/ApplicationRef-class.jade | 2 +- .../js/latest/api/core/Compiler-class.jade | 4 +- .../latest/api/core/IQueryList-interface.jade | 79 ------ .../js/latest/api/core/QueryList-class.jade | 72 +++++- .../api/core/RenderElementRef-interface.jade | 40 --- public/docs/js/latest/api/core/_data.json | 12 +- public/docs/js/latest/api/core/index.jade | 2 +- .../docs/js/latest/api/di/Binding-class.jade | 2 +- .../api/di/BindingWithVisibility-class.jade | 4 +- .../api/di/DependencyProvider-interface.jade | 2 +- .../docs/js/latest/api/di/Injector-class.jade | 34 ++- .../docs/js/latest/api/di/PRIVATE-const.jade | 11 - .../docs/js/latest/api/di/PUBLIC-const.jade | 11 - .../api/di/PUBLIC_AND_PRIVATE-const.jade | 11 - .../js/latest/api/di/ProtoInjector-class.jade | 2 +- ...dValue-const.jade => UNDEFINED-const.jade} | 2 +- .../js/latest/api/di/Visibility-enum.jade | 45 ++++ public/docs/js/latest/api/di/_data.json | 16 +- public/docs/js/latest/api/di/index.jade | 2 +- ...-const.jade => CORE_DIRECTIVES-const.jade} | 4 +- ...CSSClass-class.jade => NgClass-class.jade} | 20 +- .../api/directives/NgNonBindable-class.jade | 2 +- .../docs/js/latest/api/directives/_data.json | 8 +- .../docs/js/latest/api/directives/index.jade | 2 +- ...es-const.jade => FORM_BINDINGS-const.jade} | 2 +- ...-const.jade => FORM_DIRECTIVES-const.jade} | 2 +- .../latest/api/forms/FormBuilder-class.jade | 4 +- .../api/forms/NgControlGroup-class.jade | 2 +- .../latest/api/forms/NgControlName-class.jade | 4 +- .../js/latest/api/forms/NgForm-class.jade | 2 +- .../latest/api/forms/NgFormControl-class.jade | 4 +- .../latest/api/forms/NgFormModel-class.jade | 4 +- .../js/latest/api/forms/NgModel-class.jade | 2 +- public/docs/js/latest/api/forms/_data.json | 8 +- .../api/http/BaseRequestOptions-class.jade | 50 ---- .../js/latest/api/http/Connection-class.jade | 62 ----- .../api/http/ConnectionBackend-class.jade | 44 ---- .../js/latest/api/http/Headers-class.jade | 196 --------------- .../docs/js/latest/api/http/Http-class.jade | 222 ----------------- .../api/http/IRequestOptions-interface.jade | 95 -------- .../api/http/IResponseOptions-interface.jade | 83 ------- .../latest/api/http/JSONPBackend-class.jade | 50 ---- .../docs/js/latest/api/http/Jsonp-class.jade | 54 ----- .../js/latest/api/http/MockBackend-class.jade | 205 ---------------- .../latest/api/http/MockConnection-class.jade | 159 ------------ .../js/latest/api/http/ReadyStates-enum.jade | 84 ------- .../js/latest/api/http/Request-class.jade | 127 ---------- .../api/http/RequestCacheOpts-enum.jade | 83 ------- .../api/http/RequestCredentialsOpts-enum.jade | 47 ---- .../latest/api/http/RequestMethods-enum.jade | 94 -------- .../api/http/RequestModesOpts-enum.jade | 47 ---- .../latest/api/http/RequestOptions-class.jade | 138 ----------- .../js/latest/api/http/Response-class.jade | 227 ------------------ .../api/http/ResponseOptions-class.jade | 119 --------- .../latest/api/http/ResponseTypes-enum.jade | 71 ------ .../api/http/URLSearchParams-class.jade | 146 ----------- .../js/latest/api/http/XHRBackend-class.jade | 73 ------ .../latest/api/http/XHRConnection-class.jade | 85 ------- public/docs/js/latest/api/http/_data.json | 122 ---------- .../latest/api/http/httpInjectables-var.jade | 25 -- public/docs/js/latest/api/http/index.jade | 11 - .../latest/api/http/jsonpInjectables-var.jade | 11 - .../js/latest/api/pipes/AsyncPipe-class.jade | 35 +-- .../latest/api/pipes/CurrencyPipe-class.jade | 16 +- .../latest/api/pipes/DEFAULT_PIPES-const.jade | 11 + .../api/pipes/DEFAULT_PIPES_TOKEN-const.jade | 11 + .../js/latest/api/pipes/DatePipe-class.jade | 32 ++- .../latest/api/pipes/DecimalPipe-class.jade | 16 +- .../js/latest/api/pipes/JsonPipe-class.jade | 32 ++- .../latest/api/pipes/LimitToPipe-class.jade | 35 +-- .../latest/api/pipes/LowerCasePipe-class.jade | 38 +-- .../latest/api/pipes/PercentPipe-class.jade | 16 +- .../latest/api/pipes/UpperCasePipe-class.jade | 38 +-- public/docs/js/latest/api/pipes/_data.json | 8 + public/docs/js/latest/api/pipes/index.jade | 2 +- ...en-const.jade => APP_BASE_HREF-const.jade} | 2 +- .../latest/api/router/AsyncRoute-class.jade | 2 +- .../AuxRoute-class.jade} | 33 +-- .../js/latest/api/router/CanActivate-var.jade | 22 +- .../api/router/CanDeactivate-interface.jade | 23 +- .../latest/api/router/CanReuse-interface.jade | 27 ++- .../router/ComponentInstruction-class.jade | 129 ++++++++++ .../latest/api/router/Instruction-class.jade | 79 ++---- .../api/router/OnActivate-interface.jade | 25 +- .../api/router/OnDeactivate-interface.jade | 25 +- .../latest/api/router/OnReuse-interface.jade | 26 +- .../OpaqueToken-class.jade} | 14 +- .../js/latest/api/router/Redirect-class.jade | 14 +- .../latest/api/router/RootRouter-class.jade | 2 +- .../latest/api/router/RouteParams-class.jade | 2 +- .../api/router/RouteRegistry-class.jade | 6 +- .../js/latest/api/router/Router-class.jade | 20 +- .../latest/api/router/RouterLink-class.jade | 2 +- .../latest/api/router/RouterOutlet-class.jade | 14 +- .../js/latest/api/router/Type-interface.jade | 11 + .../Url-class.jade} | 22 +- public/docs/js/latest/api/router/_data.json | 24 +- public/docs/js/latest/api/router/index.jade | 2 +- .../api/router/routerDirectives-const.jade | 2 +- .../api/router/routerInjectables-var.jade | 2 +- .../api/test/AsyncTestCompleter-class.jade | 2 +- .../test/FunctionWithParamTokens-class.jade | 2 +- .../test/GuinessCompatibleSpy-interface.jade | 2 +- .../js/latest/api/test/IS_DARTIUM-var.jade | 11 - .../latest/api/test/NgMatchers-interface.jade | 18 +- .../js/latest/api/test/SpyObject-class.jade | 2 +- .../api/test/TestComponentBuilder-class.jade | 2 +- public/docs/js/latest/api/test/_data.json | 4 - .../latest/api/test/beforeEach-function.jade | 2 +- .../api/test/beforeEachBindings-function.jade | 2 +- .../api/test/createTestInjector-function.jade | 2 +- .../latest/api/test/ddescribe-function.jade | 2 +- .../js/latest/api/test/describe-function.jade | 2 +- .../docs/js/latest/api/test/expect-var.jade | 2 +- .../docs/js/latest/api/test/iit-function.jade | 2 +- .../js/latest/api/test/inject-function.jade | 2 +- .../api/test/isInInnerZone-function.jade | 2 +- .../docs/js/latest/api/test/it-function.jade | 2 +- .../latest/api/test/xdescribe-function.jade | 2 +- .../docs/js/latest/api/test/xit-function.jade | 2 +- 157 files changed, 1057 insertions(+), 3709 deletions(-) create mode 100644 public/docs/js/latest/api/annotations/Pipe-var.jade create mode 100644 public/docs/js/latest/api/annotations/PipeAnnotation-class.jade create mode 100644 public/docs/js/latest/api/annotations/PipeFactory-interface.jade delete mode 100644 public/docs/js/latest/api/change_detection/BasePipe-class.jade delete mode 100644 public/docs/js/latest/api/change_detection/NullPipe-class.jade delete mode 100644 public/docs/js/latest/api/change_detection/NullPipeFactory-class.jade delete mode 100644 public/docs/js/latest/api/change_detection/Pipe-interface.jade delete mode 100644 public/docs/js/latest/api/change_detection/PipeFactory-interface.jade create mode 100644 public/docs/js/latest/api/change_detection/PipeOnDestroy-interface.jade create mode 100644 public/docs/js/latest/api/change_detection/PipeTransform-interface.jade delete mode 100644 public/docs/js/latest/api/change_detection/Pipes-class.jade delete mode 100644 public/docs/js/latest/api/change_detection/defaultPipes-const.jade rename public/docs/js/latest/api/core/{appComponentTypeToken-const.jade => APP_COMPONENT-const.jade} (91%) delete mode 100644 public/docs/js/latest/api/core/IQueryList-interface.jade delete mode 100644 public/docs/js/latest/api/core/RenderElementRef-interface.jade delete mode 100644 public/docs/js/latest/api/di/PRIVATE-const.jade delete mode 100644 public/docs/js/latest/api/di/PUBLIC-const.jade delete mode 100644 public/docs/js/latest/api/di/PUBLIC_AND_PRIVATE-const.jade rename public/docs/js/latest/api/di/{undefinedValue-const.jade => UNDEFINED-const.jade} (83%) create mode 100644 public/docs/js/latest/api/di/Visibility-enum.jade rename public/docs/js/latest/api/directives/{coreDirectives-const.jade => CORE_DIRECTIVES-const.jade} (89%) rename public/docs/js/latest/api/directives/{CSSClass-class.jade => NgClass-class.jade} (80%) rename public/docs/js/latest/api/forms/{formInjectables-const.jade => FORM_BINDINGS-const.jade} (82%) rename public/docs/js/latest/api/forms/{formDirectives-const.jade => FORM_DIRECTIVES-const.jade} (88%) delete mode 100644 public/docs/js/latest/api/http/BaseRequestOptions-class.jade delete mode 100644 public/docs/js/latest/api/http/Connection-class.jade delete mode 100644 public/docs/js/latest/api/http/ConnectionBackend-class.jade delete mode 100644 public/docs/js/latest/api/http/Headers-class.jade delete mode 100644 public/docs/js/latest/api/http/Http-class.jade delete mode 100644 public/docs/js/latest/api/http/IRequestOptions-interface.jade delete mode 100644 public/docs/js/latest/api/http/IResponseOptions-interface.jade delete mode 100644 public/docs/js/latest/api/http/JSONPBackend-class.jade delete mode 100644 public/docs/js/latest/api/http/Jsonp-class.jade delete mode 100644 public/docs/js/latest/api/http/MockBackend-class.jade delete mode 100644 public/docs/js/latest/api/http/MockConnection-class.jade delete mode 100644 public/docs/js/latest/api/http/ReadyStates-enum.jade delete mode 100644 public/docs/js/latest/api/http/Request-class.jade delete mode 100644 public/docs/js/latest/api/http/RequestCacheOpts-enum.jade delete mode 100644 public/docs/js/latest/api/http/RequestCredentialsOpts-enum.jade delete mode 100644 public/docs/js/latest/api/http/RequestMethods-enum.jade delete mode 100644 public/docs/js/latest/api/http/RequestModesOpts-enum.jade delete mode 100644 public/docs/js/latest/api/http/RequestOptions-class.jade delete mode 100644 public/docs/js/latest/api/http/Response-class.jade delete mode 100644 public/docs/js/latest/api/http/ResponseOptions-class.jade delete mode 100644 public/docs/js/latest/api/http/ResponseTypes-enum.jade delete mode 100644 public/docs/js/latest/api/http/URLSearchParams-class.jade delete mode 100644 public/docs/js/latest/api/http/XHRBackend-class.jade delete mode 100644 public/docs/js/latest/api/http/XHRConnection-class.jade delete mode 100644 public/docs/js/latest/api/http/_data.json delete mode 100644 public/docs/js/latest/api/http/httpInjectables-var.jade delete mode 100644 public/docs/js/latest/api/http/index.jade delete mode 100644 public/docs/js/latest/api/http/jsonpInjectables-var.jade create mode 100644 public/docs/js/latest/api/pipes/DEFAULT_PIPES-const.jade create mode 100644 public/docs/js/latest/api/pipes/DEFAULT_PIPES_TOKEN-const.jade rename public/docs/js/latest/api/router/{appBaseHrefToken-const.jade => APP_BASE_HREF-const.jade} (83%) rename public/docs/js/latest/api/{http/BaseResponseOptions-class.jade => router/AuxRoute-class.jade} (53%) create mode 100644 public/docs/js/latest/api/router/ComponentInstruction-class.jade rename public/docs/js/latest/api/{http/BrowserXhr-class.jade => router/OpaqueToken-class.jade} (59%) create mode 100644 public/docs/js/latest/api/router/Type-interface.jade rename public/docs/js/latest/api/{http/JSONPConnection-class.jade => router/Url-class.jade} (60%) delete mode 100644 public/docs/js/latest/api/test/IS_DARTIUM-var.jade diff --git a/public/docs/js/latest/api/annotations/Attribute-var.jade b/public/docs/js/latest/api/annotations/Attribute-var.jade index 7c3c9f6b87..1b66965e81 100644 --- a/public/docs/js/latest/api/annotations/Attribute-var.jade +++ b/public/docs/js/latest/api/annotations/Attribute-var.jade @@ -3,7 +3,7 @@ h2 Attribute variable p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 360) + defined in angular2/src/core/annotations/decorators.ts (line 391) :markdown Attribute factory function. diff --git a/public/docs/js/latest/api/annotations/AttributeFactory-interface.jade b/public/docs/js/latest/api/annotations/AttributeFactory-interface.jade index eaf7d3f3fb..c90a44cd49 100644 --- a/public/docs/js/latest/api/annotations/AttributeFactory-interface.jade +++ b/public/docs/js/latest/api/annotations/AttributeFactory-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 236) + defined in angular2/src/core/annotations/decorators.ts (line 243) :markdown Attribute factory for creating annotations, decorators or DSL. diff --git a/public/docs/js/latest/api/annotations/Component-var.jade b/public/docs/js/latest/api/annotations/Component-var.jade index f12cd774ee..de44bd2b83 100644 --- a/public/docs/js/latest/api/annotations/Component-var.jade +++ b/public/docs/js/latest/api/annotations/Component-var.jade @@ -3,7 +3,7 @@ h2 Component variable p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 344) + defined in angular2/src/core/annotations/decorators.ts (line 375) :markdown Component factory function. diff --git a/public/docs/js/latest/api/annotations/ComponentAnnotation-class.jade b/public/docs/js/latest/api/annotations/ComponentAnnotation-class.jade index 932be72c2b..9737b7075b 100644 --- a/public/docs/js/latest/api/annotations/ComponentAnnotation-class.jade +++ b/public/docs/js/latest/api/annotations/ComponentAnnotation-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations_impl/annotations.ts (line 778) + defined in angular2/src/core/annotations_impl/annotations.ts (line 754) :markdown Declare reusable UI building blocks for an application. diff --git a/public/docs/js/latest/api/annotations/ComponentDecorator-interface.jade b/public/docs/js/latest/api/annotations/ComponentDecorator-interface.jade index 9b47da039c..2a6cf0da19 100644 --- a/public/docs/js/latest/api/annotations/ComponentDecorator-interface.jade +++ b/public/docs/js/latest/api/annotations/ComponentDecorator-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 13) + defined in angular2/src/core/annotations/decorators.ts (line 18) :markdown Interface for the Component decorator function. @@ -21,6 +21,7 @@ p.location-badge. templateUrl?: string, template?: string, directives?: List<Type | any | List<any>>, + pipes?: List<Type | any | List<any>>, renderer?: string, styles?: List<string>, styleUrls?: List<string>, diff --git a/public/docs/js/latest/api/annotations/ComponentFactory-interface.jade b/public/docs/js/latest/api/annotations/ComponentFactory-interface.jade index 1e7221a172..c65de71f00 100644 --- a/public/docs/js/latest/api/annotations/ComponentFactory-interface.jade +++ b/public/docs/js/latest/api/annotations/ComponentFactory-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 104) + defined in angular2/src/core/annotations/decorators.ts (line 111) :markdown ComponentAnnotation factory for creating annotations, decorators or DSL. diff --git a/public/docs/js/latest/api/annotations/Directive-var.jade b/public/docs/js/latest/api/annotations/Directive-var.jade index 10250b88fd..be0573e7cb 100644 --- a/public/docs/js/latest/api/annotations/Directive-var.jade +++ b/public/docs/js/latest/api/annotations/Directive-var.jade @@ -3,7 +3,7 @@ h2 Directive variable p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 349) + defined in angular2/src/core/annotations/decorators.ts (line 380) :markdown Directive factory function. diff --git a/public/docs/js/latest/api/annotations/DirectiveAnnotation-class.jade b/public/docs/js/latest/api/annotations/DirectiveAnnotation-class.jade index f87078017a..29f7b437ef 100644 --- a/public/docs/js/latest/api/annotations/DirectiveAnnotation-class.jade +++ b/public/docs/js/latest/api/annotations/DirectiveAnnotation-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations_impl/annotations.ts (line 4) + defined in angular2/src/core/annotations_impl/annotations.ts (line 4) :markdown Directives allow you to attach behavior to elements in the DOM. @@ -471,7 +471,7 @@ p.location-badge. - `directiveProperty` specifies the component property where the value is written. - `bindingProperty` specifies the DOM property where the value is read from. - You can include a Pipe when specifying a `bindingProperty` to allow for data + You can include a Pipe when specifying a `bindingProperty` to allow for data transformation and structural change detection of the value. These pipes will be evaluated in the context of this component. @@ -522,38 +522,14 @@ p.location-badge. Whenever the `someExpression` expression changes, the `properties` declaration instructs Angular to update the `Tooltip`'s `text` property. - ## Bindings With Pipes + ### Bindings With Pipes - You can also use pipes when writing binding definitions for a directive. - - For example, we could write a binding that updates the directive on structural changes, rather - than on reference changes, as normally occurs in change detection. - - See Pipe and `KeyValueChanges` documentation for more details. - - ``` - @Directive({ - selector: '[class-set]', - properties: [ - 'classChanges: classSet | keyValDiff' - ] - }) - class ClassSet { - set classChanges(changes: KeyValueChanges) { - // This will get called every time the `class-set` expressions changes its structure. - } - } - ``` - - The template that this directive is used in may also contain its own pipes. For example: + You can use pipes in bindings, as follows: ```html
``` - In this case, the two pipes compose as if they were inlined: `someExpression | somePipe | - keyValDiff`. - diff --git a/public/docs/js/latest/api/annotations/DirectiveDecorator-interface.jade b/public/docs/js/latest/api/annotations/DirectiveDecorator-interface.jade index eeb4145232..f8a00113c1 100644 --- a/public/docs/js/latest/api/annotations/DirectiveDecorator-interface.jade +++ b/public/docs/js/latest/api/annotations/DirectiveDecorator-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 6) + defined in angular2/src/core/annotations/decorators.ts (line 11) :markdown Interface for the Directive decorator function. diff --git a/public/docs/js/latest/api/annotations/DirectiveFactory-interface.jade b/public/docs/js/latest/api/annotations/DirectiveFactory-interface.jade index 25f61b2833..d6964aa4ca 100644 --- a/public/docs/js/latest/api/annotations/DirectiveFactory-interface.jade +++ b/public/docs/js/latest/api/annotations/DirectiveFactory-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 51) + defined in angular2/src/core/annotations/decorators.ts (line 58) :markdown Directive factory for creating annotations, decorators or DSL. diff --git a/public/docs/js/latest/api/annotations/LifecycleEvent-enum.jade b/public/docs/js/latest/api/annotations/LifecycleEvent-enum.jade index 20c6b7b548..7e31ec7e7d 100644 --- a/public/docs/js/latest/api/annotations/LifecycleEvent-enum.jade +++ b/public/docs/js/latest/api/annotations/LifecycleEvent-enum.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations_impl/annotations.ts (line 900) + defined in angular2/src/core/annotations_impl/annotations.ts (line 876) :markdown Lifecycle events are guaranteed to be called in the following order: diff --git a/public/docs/js/latest/api/annotations/Pipe-var.jade b/public/docs/js/latest/api/annotations/Pipe-var.jade new file mode 100644 index 0000000000..0e4b7b53b2 --- /dev/null +++ b/public/docs/js/latest/api/annotations/Pipe-var.jade @@ -0,0 +1,12 @@ + +.l-main-section + h2 Pipe variable + p.location-badge. + exported from angular2/annotations + defined in angular2/src/core/annotations/decorators.ts (line 407) + + :markdown + Pipe factory function. + + + diff --git a/public/docs/js/latest/api/annotations/PipeAnnotation-class.jade b/public/docs/js/latest/api/annotations/PipeAnnotation-class.jade new file mode 100644 index 0000000000..871ff93952 --- /dev/null +++ b/public/docs/js/latest/api/annotations/PipeAnnotation-class.jade @@ -0,0 +1,58 @@ + +p.location-badge. + exported from angular2/annotations + defined in angular2/src/core/annotations_impl/annotations.ts (line 1008) + +:markdown + Declare reusable pipe function. + + ## Example + + ``` + @Pipe({ + name: 'lowercase' + }) + class Lowercase { + transform(v, args) { return v.toLowerCase(); } + } + ``` + + + +.l-main-section + h2 Annotations + .l-sub-section + h3.annotation CONST + pre.prettyprint + code. + @CONST() + + +.l-main-section + h2 Members + .l-sub-section + h3 constructor + + + pre.prettyprint + code. + constructor({name}: {name: string}) + + :markdown + + + + + + + .l-sub-section + h3 name + + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/annotations/PipeFactory-interface.jade b/public/docs/js/latest/api/annotations/PipeFactory-interface.jade new file mode 100644 index 0000000000..02059e2aaf --- /dev/null +++ b/public/docs/js/latest/api/annotations/PipeFactory-interface.jade @@ -0,0 +1,24 @@ + +p.location-badge. + exported from angular2/annotations + defined in angular2/src/core/annotations/decorators.ts (line 345) + +:markdown + Pipe factory for creating decorators. + + ## Example as TypeScript Decorator + + ``` + import {Pipe} from "angular2/angular2"; + + @Pipe({...}) + class MyPipe { + constructor() { + ... + } + + transform(v, args) {} + } + ``` + + diff --git a/public/docs/js/latest/api/annotations/Query-var.jade b/public/docs/js/latest/api/annotations/Query-var.jade index a2b12fd3a5..4eeb57656c 100644 --- a/public/docs/js/latest/api/annotations/Query-var.jade +++ b/public/docs/js/latest/api/annotations/Query-var.jade @@ -3,7 +3,7 @@ h2 Query variable p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 365) + defined in angular2/src/core/annotations/decorators.ts (line 396) :markdown Query factory function. diff --git a/public/docs/js/latest/api/annotations/QueryFactory-interface.jade b/public/docs/js/latest/api/annotations/QueryFactory-interface.jade index 610967928a..66f50c931e 100644 --- a/public/docs/js/latest/api/annotations/QueryFactory-interface.jade +++ b/public/docs/js/latest/api/annotations/QueryFactory-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 287) + defined in angular2/src/core/annotations/decorators.ts (line 294) :markdown Query factory for creating annotations, decorators or DSL. diff --git a/public/docs/js/latest/api/annotations/View-var.jade b/public/docs/js/latest/api/annotations/View-var.jade index fd6f0d47e5..91dedc9073 100644 --- a/public/docs/js/latest/api/annotations/View-var.jade +++ b/public/docs/js/latest/api/annotations/View-var.jade @@ -3,7 +3,7 @@ h2 View variable p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 354) + defined in angular2/src/core/annotations/decorators.ts (line 385) :markdown View factory function. diff --git a/public/docs/js/latest/api/annotations/ViewAnnotation-class.jade b/public/docs/js/latest/api/annotations/ViewAnnotation-class.jade index 852134ce12..3cd5cb20ce 100644 --- a/public/docs/js/latest/api/annotations/ViewAnnotation-class.jade +++ b/public/docs/js/latest/api/annotations/ViewAnnotation-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations_impl/view.ts (line 4) + defined in angular2/src/core/annotations_impl/view.ts (line 4) :markdown Declares the available HTML templates for an application. @@ -53,10 +53,11 @@ p.location-badge. pre.prettyprint code. - constructor({templateUrl, template, directives, encapsulation, styles, styleUrls}?: { + constructor({templateUrl, template, directives, pipes, encapsulation, styles, styleUrls}?: { templateUrl?: string, template?: string, directives?: List<Type | any | List<any>>, + pipes?: List<Type | any | List<any>>, encapsulation?: ViewEncapsulation, styles?: List<string>, styleUrls?: List<string>, @@ -157,6 +158,18 @@ p.location-badge. + .l-sub-section + h3 pipes + + + :markdown + + + + + + + .l-sub-section h3 encapsulation diff --git a/public/docs/js/latest/api/annotations/ViewDecorator-interface.jade b/public/docs/js/latest/api/annotations/ViewDecorator-interface.jade index 08e5d691df..dfba91e4f1 100644 --- a/public/docs/js/latest/api/annotations/ViewDecorator-interface.jade +++ b/public/docs/js/latest/api/annotations/ViewDecorator-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 32) + defined in angular2/src/core/annotations/decorators.ts (line 38) :markdown Interface for the View decorator function. @@ -21,6 +21,7 @@ p.location-badge. templateUrl?: string, template?: string, directives?: List<Type | any | List<any>>, + pipes?: List<Type | any | List<any>>, renderer?: string, styles?: List<string>, styleUrls?: List<string>, diff --git a/public/docs/js/latest/api/annotations/ViewFactory-interface.jade b/public/docs/js/latest/api/annotations/ViewFactory-interface.jade index daaccc1747..536a268b42 100644 --- a/public/docs/js/latest/api/annotations/ViewFactory-interface.jade +++ b/public/docs/js/latest/api/annotations/ViewFactory-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 174) + defined in angular2/src/core/annotations/decorators.ts (line 181) :markdown ViewAnnotation factory for creating annotations, decorators or DSL. diff --git a/public/docs/js/latest/api/annotations/ViewQuery-var.jade b/public/docs/js/latest/api/annotations/ViewQuery-var.jade index 0b054ed686..4fbff8c464 100644 --- a/public/docs/js/latest/api/annotations/ViewQuery-var.jade +++ b/public/docs/js/latest/api/annotations/ViewQuery-var.jade @@ -3,7 +3,7 @@ h2 ViewQuery variable p.location-badge. exported from angular2/annotations - defined in angular2/src/core/annotations/decorators.ts (line 371) + defined in angular2/src/core/annotations/decorators.ts (line 402) :markdown ViewQuery factory function. diff --git a/public/docs/js/latest/api/annotations/_data.json b/public/docs/js/latest/api/annotations/_data.json index 72bd4e985a..f2dd03b8e4 100644 --- a/public/docs/js/latest/api/annotations/_data.json +++ b/public/docs/js/latest/api/annotations/_data.json @@ -12,6 +12,10 @@ "title" : "DirectiveAnnotation Class" }, + "PipeAnnotation-class" : { + "title" : "PipeAnnotation Class" + }, + "LifecycleEvent-enum" : { "title" : "LifecycleEvent Enum" }, @@ -118,5 +122,13 @@ "ViewQuery-var" : { "title" : "ViewQuery Var" + }, + + "Pipe-var" : { + "title" : "Pipe Var" + }, + + "PipeFactory-interface" : { + "title" : "PipeFactory Interface" } } \ No newline at end of file diff --git a/public/docs/js/latest/api/annotations/index.jade b/public/docs/js/latest/api/annotations/index.jade index 732ec112dd..ea0da3f744 100644 --- a/public/docs/js/latest/api/annotations/index.jade +++ b/public/docs/js/latest/api/annotations/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/annotations.ts (line 1) + defined in angular2/annotations.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/change_detection/BasePipe-class.jade b/public/docs/js/latest/api/change_detection/BasePipe-class.jade deleted file mode 100644 index 0d650b27a4..0000000000 --- a/public/docs/js/latest/api/change_detection/BasePipe-class.jade +++ /dev/null @@ -1,78 +0,0 @@ - -p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/pipe.ts (line 58) - -:markdown - Provides default implementation of `supports` and `onDestroy` method. - - #Example - - ``` - class DoublePipe extends BasePipe { - transform(value) { - return `${value}${value}`; - } - } - ``` - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation CONST - pre.prettyprint - code. - @CONST() - - -.l-main-section - h2 Members - .l-sub-section - h3 supports - - - pre.prettyprint - code. - supports(obj: any) - - :markdown - - - - - - - - .l-sub-section - h3 onDestroy - - - pre.prettyprint - code. - onDestroy() - - :markdown - - - - - - - - .l-sub-section - h3 transform - - - pre.prettyprint - code. - transform(value: any, args: List<any>) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/change_detection/ChangeDetector-interface.jade b/public/docs/js/latest/api/change_detection/ChangeDetector-interface.jade index 3b2563d4cd..93c97561bf 100644 --- a/public/docs/js/latest/api/change_detection/ChangeDetector-interface.jade +++ b/public/docs/js/latest/api/change_detection/ChangeDetector-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/change_detection - defined in angular2/src/change_detection/interfaces.ts (line 48) + defined in angular2/src/change_detection/interfaces.ts (line 49) :markdown @@ -32,6 +32,18 @@ p.location-badge. + .l-sub-section + h3 ref + + + :markdown + + + + + + + .l-sub-section h3 addChild diff --git a/public/docs/js/latest/api/change_detection/NullPipe-class.jade b/public/docs/js/latest/api/change_detection/NullPipe-class.jade deleted file mode 100644 index 437adde964..0000000000 --- a/public/docs/js/latest/api/change_detection/NullPipe-class.jade +++ /dev/null @@ -1,53 +0,0 @@ - -p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/null_pipe.ts (line 10) - -:markdown - - -.l-main-section - h2 Members - .l-sub-section - h3 called - - - :markdown - - - - - - - - .l-sub-section - h3 supports - - - pre.prettyprint - code. - supports(obj: any) - - :markdown - - - - - - - - .l-sub-section - h3 transform - - - pre.prettyprint - code. - transform(value: any, args?: List<any>) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/change_detection/NullPipeFactory-class.jade b/public/docs/js/latest/api/change_detection/NullPipeFactory-class.jade deleted file mode 100644 index 7652efc9cd..0000000000 --- a/public/docs/js/latest/api/change_detection/NullPipeFactory-class.jade +++ /dev/null @@ -1,51 +0,0 @@ - -p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/null_pipe.ts (line 3) - -:markdown - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation CONST - pre.prettyprint - code. - @CONST() - - -.l-main-section - h2 Members - .l-sub-section - h3 supports - - - pre.prettyprint - code. - supports(obj: any) - - :markdown - - - - - - - - .l-sub-section - h3 create - - - pre.prettyprint - code. - create(cdRef: ChangeDetectorRef) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/change_detection/Pipe-interface.jade b/public/docs/js/latest/api/change_detection/Pipe-interface.jade deleted file mode 100644 index 41174ad845..0000000000 --- a/public/docs/js/latest/api/change_detection/Pipe-interface.jade +++ /dev/null @@ -1,75 +0,0 @@ - -p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/pipe.ts (line 28) - -:markdown - An interface which all pipes must implement. - - #Example - - ``` - class DoublePipe implements Pipe { - supports(obj) { - return true; - } - - onDestroy() {} - - transform(value, args = []) { - return `${value}${value}`; - } - } - ``` - - -.l-main-section - h2 Members - .l-sub-section - h3 supports - - - pre.prettyprint - code. - supports(obj: any) - - :markdown - Query if a pipe supports a particular object instance. - - - - - - - - .l-sub-section - h3 onDestroy - - - pre.prettyprint - code. - onDestroy() - - :markdown - - - - - - - - .l-sub-section - h3 transform - - - pre.prettyprint - code. - transform(value: any, args: List<any>) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/change_detection/PipeFactory-interface.jade b/public/docs/js/latest/api/change_detection/PipeFactory-interface.jade deleted file mode 100644 index e75a6c4010..0000000000 --- a/public/docs/js/latest/api/change_detection/PipeFactory-interface.jade +++ /dev/null @@ -1,42 +0,0 @@ - -p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/pipe.ts (line 78) - -:markdown - - - -.l-main-section - h2 Members - .l-sub-section - h3 supports - - - pre.prettyprint - code. - supports(obs: any) - - :markdown - - - - - - - - .l-sub-section - h3 create - - - pre.prettyprint - code. - create(cdRef: ChangeDetectorRef) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/change_detection/PipeOnDestroy-interface.jade b/public/docs/js/latest/api/change_detection/PipeOnDestroy-interface.jade new file mode 100644 index 0000000000..a27ac90abe --- /dev/null +++ b/public/docs/js/latest/api/change_detection/PipeOnDestroy-interface.jade @@ -0,0 +1,44 @@ + +p.location-badge. + exported from angular2/change_detection + defined in angular2/src/change_detection/pipe_transform.ts (line 16) + +:markdown + An interface that stateful pipes should implement. + + #Example + + ``` + class StatefulPipe implements PipeTransform, PipeOnDestroy { + connection; + + onDestroy() { + this.connection.release(); + } + + transform(value, args = []) { + this.connection = createConnection(); + // ... + return someValue; + } + } + ``` + + +.l-main-section + h2 Members + .l-sub-section + h3 onDestroy + + + pre.prettyprint + code. + onDestroy() + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/change_detection/PipeTransform-interface.jade b/public/docs/js/latest/api/change_detection/PipeTransform-interface.jade new file mode 100644 index 0000000000..a6c274d44a --- /dev/null +++ b/public/docs/js/latest/api/change_detection/PipeTransform-interface.jade @@ -0,0 +1,36 @@ + +p.location-badge. + exported from angular2/change_detection + defined in angular2/src/change_detection/pipe_transform.ts (line 1) + +:markdown + An interface which all pipes must implement. + + #Example + + ``` + class DoublePipe implements PipeTransform { + transform(value, args = []) { + return `${value}${value}`; + } + } + ``` + + +.l-main-section + h2 Members + .l-sub-section + h3 transform + + + pre.prettyprint + code. + transform(value: any, args: List<any>) + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/change_detection/Pipes-class.jade b/public/docs/js/latest/api/change_detection/Pipes-class.jade deleted file mode 100644 index 641379c18c..0000000000 --- a/public/docs/js/latest/api/change_detection/Pipes-class.jade +++ /dev/null @@ -1,84 +0,0 @@ - -p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/pipes.ts (line 6) - -:markdown - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - - .l-sub-section - h3.annotation CONST - pre.prettyprint - code. - @CONST() - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(config: StringMap<string, PipeFactory[]>) - - :markdown - - - - - - - .l-sub-section - h3 config - - - :markdown - Map of Pipe names to PipeFactory lists used to configure the - Pipes registry. - - #Example - - ``` - var pipesConfig = { - 'json': [jsonPipeFactory] - } - @Component({ - viewBindings: [ - bind(Pipes).toValue(new Pipes(pipesConfig)) - ] - }) - ``` - - - - - - - - .l-sub-section - h3 get - - - pre.prettyprint - code. - get(type: string, obj: any, cdRef?: ChangeDetectorRef, existingPipe?: Pipe) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/change_detection/WrappedValue-class.jade b/public/docs/js/latest/api/change_detection/WrappedValue-class.jade index 286e34f344..6ec68e6889 100644 --- a/public/docs/js/latest/api/change_detection/WrappedValue-class.jade +++ b/public/docs/js/latest/api/change_detection/WrappedValue-class.jade @@ -1,14 +1,25 @@ p.location-badge. exported from angular2/change_detection - defined in angular2/src/change_detection/pipes/pipe.ts (line 2) + defined in angular2/src/change_detection/change_detection_util.ts (line 5) :markdown - Indicates that the result of a Pipe transformation has changed even though the reference + Indicates that the result of a Pipe 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. + Example: + + ``` + if (this._latestValue === this._latestReturnedValue) { + return this._latestReturnedValue; + } else { + this._latestReturnedValue = this._latestValue; + return WrappedValue.wrap(this._latestValue); // this will force update + } + ``` + .l-main-section h2 Members diff --git a/public/docs/js/latest/api/change_detection/_data.json b/public/docs/js/latest/api/change_detection/_data.json index a347479a6f..d59e36df26 100644 --- a/public/docs/js/latest/api/change_detection/_data.json +++ b/public/docs/js/latest/api/change_detection/_data.json @@ -52,16 +52,12 @@ "title" : "WrappedValue Class" }, - "defaultPipes-const" : { - "title" : "defaultPipes Const" + "PipeTransform-interface" : { + "title" : "PipeTransform Interface" }, - "Pipe-interface" : { - "title" : "Pipe Interface" - }, - - "Pipes-class" : { - "title" : "Pipes Class" + "PipeOnDestroy-interface" : { + "title" : "PipeOnDestroy Interface" }, "IterableDiffers-class" : { @@ -86,21 +82,5 @@ "KeyValueDifferFactory-interface" : { "title" : "KeyValueDifferFactory Interface" - }, - - "PipeFactory-interface" : { - "title" : "PipeFactory Interface" - }, - - "BasePipe-class" : { - "title" : "BasePipe Class" - }, - - "NullPipe-class" : { - "title" : "NullPipe Class" - }, - - "NullPipeFactory-class" : { - "title" : "NullPipeFactory Class" } } \ No newline at end of file diff --git a/public/docs/js/latest/api/change_detection/defaultPipes-const.jade b/public/docs/js/latest/api/change_detection/defaultPipes-const.jade deleted file mode 100644 index 5d988c0862..0000000000 --- a/public/docs/js/latest/api/change_detection/defaultPipes-const.jade +++ /dev/null @@ -1,11 +0,0 @@ - -.l-main-section - h2 defaultPipes variable - p.location-badge. - exported from angular2/change_detection - defined in angular2/src/change_detection/change_detection.ts (line 129) - - :markdown - - - diff --git a/public/docs/js/latest/api/change_detection/index.jade b/public/docs/js/latest/api/change_detection/index.jade index b5564bd476..5029aaeb06 100644 --- a/public/docs/js/latest/api/change_detection/index.jade +++ b/public/docs/js/latest/api/change_detection/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/change_detection.ts (line 1) + defined in angular2/change_detection.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/core/appComponentTypeToken-const.jade b/public/docs/js/latest/api/core/APP_COMPONENT-const.jade similarity index 91% rename from public/docs/js/latest/api/core/appComponentTypeToken-const.jade rename to public/docs/js/latest/api/core/APP_COMPONENT-const.jade index e44a25ee57..17d1cc0992 100644 --- a/public/docs/js/latest/api/core/appComponentTypeToken-const.jade +++ b/public/docs/js/latest/api/core/APP_COMPONENT-const.jade @@ -1,6 +1,6 @@ .l-main-section - h2 appComponentTypeToken variable + h2 APP_COMPONENT variable p.location-badge. exported from angular2/core defined in angular2/src/core/application_tokens.ts (line 25) diff --git a/public/docs/js/latest/api/core/ApplicationRef-class.jade b/public/docs/js/latest/api/core/ApplicationRef-class.jade index 9b38891a70..9c6d7c6372 100644 --- a/public/docs/js/latest/api/core/ApplicationRef-class.jade +++ b/public/docs/js/latest/api/core/ApplicationRef-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/core - defined in angular2/src/core/application_common.ts (line 337) + defined in angular2/src/core/application_common.ts (line 338) :markdown Represents a Angular's representation of an Application. diff --git a/public/docs/js/latest/api/core/Compiler-class.jade b/public/docs/js/latest/api/core/Compiler-class.jade index 0a462efe95..64639a945d 100644 --- a/public/docs/js/latest/api/core/Compiler-class.jade +++ b/public/docs/js/latest/api/core/Compiler-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/core - defined in angular2/src/core/compiler/compiler.ts (line 61) + defined in angular2/src/core/compiler/compiler.ts (line 64) :markdown ## URL Resolution @@ -42,7 +42,7 @@ p.location-badge. pre.prettyprint code. - constructor(reader: DirectiveResolver, cache: CompilerCache, viewResolver: ViewResolver, componentUrlMapper: ComponentUrlMapper, urlResolver: UrlResolver, render:RenderCompiler, protoViewFactory: ProtoViewFactory, appUrl: AppRootUrl) + constructor(_directiveResolver: DirectiveResolver, _pipeResolver: PipeResolver, _defaultPipes: Type[], _compilerCache: CompilerCache, _viewResolver: ViewResolver, _componentUrlMapper: ComponentUrlMapper, _urlResolver: UrlResolver, _render:RenderCompiler, _protoViewFactory: ProtoViewFactory, appUrl: AppRootUrl) :markdown diff --git a/public/docs/js/latest/api/core/IQueryList-interface.jade b/public/docs/js/latest/api/core/IQueryList-interface.jade deleted file mode 100644 index cf083b1535..0000000000 --- a/public/docs/js/latest/api/core/IQueryList-interface.jade +++ /dev/null @@ -1,79 +0,0 @@ - -p.location-badge. - exported from angular2/core - defined in angular2/src/core/compiler/interface_query.ts (line 1) - -:markdown - An iterable live list of components in the Light DOM. - - Injectable Objects that contains a live list of child directives in the light DOM of a directive. - The directives are kept in depth-first pre-order traversal of the DOM. - - The `QueryList` is iterable, therefore it can be used in both javascript code with `for..of` loop - as well as in - template with `*ng-for="of"` directive. - - NOTE: In the future this class will implement an `Observable` interface. For now it uses a plain - list of observable - callbacks. - - # Example: - - Assume that `` component would like to get a list its children which are `` - components as shown in this - example: - - ```html - - ... - {{o.text}} - - ``` - - In the above example the list of `` elements needs to get a list of `` elements so - that it could render - tabs with the correct titles and in the correct order. - - A possible solution would be for a `` to inject `` component and then register itself - with `` - component's on `hydrate` and deregister on `dehydrate` event. While a reasonable approach, this - would only work - partialy since `*ng-for` could rearrange the list of `` components which would not be - reported to `` - component and thus the list of `` components would be out of sync with respect to the list - of `` elements. - - A preferred solution is to inject a `QueryList` which is a live list of directives in the - component`s light DOM. - - ```javascript - @Component({ - selector: 'tabs' - }) - @View({ - template: ` -
    -
  • {{pane.title}}
    • -
- - ` - }) - class Tabs { - panes: QueryList - - constructor(@Query(Pane) panes:QueryList) { - this.panes = panes; - } - } - - @Component({ - selector: 'pane', - properties: ['title'] - }) - @View(...) - class Pane { - title:string; - } - ``` - - diff --git a/public/docs/js/latest/api/core/QueryList-class.jade b/public/docs/js/latest/api/core/QueryList-class.jade index 25c2aa3ddf..6a04dc1a58 100644 --- a/public/docs/js/latest/api/core/QueryList-class.jade +++ b/public/docs/js/latest/api/core/QueryList-class.jade @@ -1,14 +1,78 @@ p.location-badge. exported from angular2/core - defined in angular2/src/core/compiler/query_list.ts (line 2) + defined in angular2/src/core/compiler/query_list.ts (line 1) :markdown - Injectable Objects that contains a live list of child directives in the light Dom of a directive. + An iterable and observable live list of components in the DOM. + + A QueryList contains a live list of child directives in the DOM of a directive. The directives are kept in depth-first pre-order traversal of the DOM. - In the future this class will implement an Observable interface. - For now it uses a plain list of observable callbacks. + The `QueryList` is iterable, therefore it can be used in both javascript code with `for..of` loop + as well as in template with `*ng-for="of"` directive. + + QueryList is updated as part of the change-detection cycle of a directive. Since change detection + happens after construction of a directive, QueryList will always be empty when observed in the + constructor. + + + NOTE: In the future this class will implement an `Observable` interface. For now it uses a plain + list of observable callbacks. + + # Example: + + Assume that `` component would like to get a list its children which are `` + components as shown in this example: + + ```html + + ... + {{o.text}} + + ``` + + In the above example the list of `` elements needs to get a list of `` elements so + that it could render tabs with the correct titles and in the correct order. + + A possible solution would be for a `` to inject `` component and then register itself + with `` component's on `hydrate` and deregister on `dehydrate` event. While a reasonable + approach, this would only work partialy since `*ng-for` could rearrange the list of `` + components which would not be reported to `` component and thus the list of `` + components would be out of sync with respect to the list of `` elements. + + A preferred solution is to inject a `QueryList` which is a live list of directives in the + component`s light DOM. + + ```javascript + @Component({ + selector: 'tabs' + }) + @View({ + template: ` +
    +
  • {{pane.title}}
    • +
+ + ` + }) + class Tabs { + panes: QueryList + + constructor(@Query(Pane) panes:QueryList) { + this.panes = panes; + } + } + + @Component({ + selector: 'pane', + properties: ['title'] + }) + @View(...) + class Pane { + title:string; + } + ``` .l-main-section diff --git a/public/docs/js/latest/api/core/RenderElementRef-interface.jade b/public/docs/js/latest/api/core/RenderElementRef-interface.jade deleted file mode 100644 index 6c441c65f7..0000000000 --- a/public/docs/js/latest/api/core/RenderElementRef-interface.jade +++ /dev/null @@ -1,40 +0,0 @@ - -p.location-badge. - exported from angular2/core - defined in angular2/src/render/api.ts (line 377) - -:markdown - Abstract reference to the element which can be marshaled across web-worker boundary. - - This interface is used by the Renderer API. - - -.l-main-section - h2 Members - .l-sub-section - h3 renderView - - - :markdown - Reference to the `RenderViewRef` where the `RenderElementRef` is inside of. - - - - - - - - .l-sub-section - h3 renderBoundElementIndex - - - :markdown - Index of the element inside the `RenderViewRef`. - - This is used internally by the Angular framework to locate elements. - - - - - - diff --git a/public/docs/js/latest/api/core/_data.json b/public/docs/js/latest/api/core/_data.json index d5089abf10..569c6e0d4a 100644 --- a/public/docs/js/latest/api/core/_data.json +++ b/public/docs/js/latest/api/core/_data.json @@ -4,8 +4,8 @@ "intro" : "Define angular core API here." }, - "appComponentTypeToken-const" : { - "title" : "appComponentTypeToken Const" + "APP_COMPONENT-const" : { + "title" : "APP_COMPONENT Const" }, "ApplicationRef-class" : { @@ -40,10 +40,6 @@ "title" : "AppViewManager Class" }, - "IQueryList-interface" : { - "title" : "IQueryList Interface" - }, - "QueryList-class" : { "title" : "QueryList Class" }, @@ -64,10 +60,6 @@ "title" : "TemplateRef Class" }, - "RenderElementRef-interface" : { - "title" : "RenderElementRef Interface" - }, - "ViewRef-class" : { "title" : "ViewRef Class" }, diff --git a/public/docs/js/latest/api/core/index.jade b/public/docs/js/latest/api/core/index.jade index eee6570f2d..d4fc0a637e 100644 --- a/public/docs/js/latest/api/core/index.jade +++ b/public/docs/js/latest/api/core/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/core.ts (line 1) + defined in angular2/core.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/di/Binding-class.jade b/public/docs/js/latest/api/di/Binding-class.jade index 56587d1ce6..4890535811 100644 --- a/public/docs/js/latest/api/di/Binding-class.jade +++ b/public/docs/js/latest/api/di/Binding-class.jade @@ -4,7 +4,7 @@ p.location-badge. defined in angular2/src/di/binding.ts (line 36) :markdown - Describes how the Injector should instantiate a given token. + Describes how_ the Injector should instantiate a given token. See bind. diff --git a/public/docs/js/latest/api/di/BindingWithVisibility-class.jade b/public/docs/js/latest/api/di/BindingWithVisibility-class.jade index 89df5f72b1..a64c72abf8 100644 --- a/public/docs/js/latest/api/di/BindingWithVisibility-class.jade +++ b/public/docs/js/latest/api/di/BindingWithVisibility-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di - defined in angular2/src/di/injector.ts (line 352) + defined in angular2/src/di/injector.ts (line 360) :markdown @@ -14,7 +14,7 @@ p.location-badge. pre.prettyprint code. - constructor(binding: ResolvedBinding, visibility: number) + constructor(binding: ResolvedBinding, visibility: Visibility) :markdown diff --git a/public/docs/js/latest/api/di/DependencyProvider-interface.jade b/public/docs/js/latest/api/di/DependencyProvider-interface.jade index 98bc8a73be..68e3953440 100644 --- a/public/docs/js/latest/api/di/DependencyProvider-interface.jade +++ b/public/docs/js/latest/api/di/DependencyProvider-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di - defined in angular2/src/di/injector.ts (line 358) + defined in angular2/src/di/injector.ts (line 366) :markdown Used to provide dependencies that cannot be easily expressed as bindings. diff --git a/public/docs/js/latest/api/di/Injector-class.jade b/public/docs/js/latest/api/di/Injector-class.jade index fff6c8011f..e8af092d74 100644 --- a/public/docs/js/latest/api/di/Injector-class.jade +++ b/public/docs/js/latest/api/di/Injector-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di - defined in angular2/src/di/injector.ts (line 365) + defined in angular2/src/di/injector.ts (line 373) :markdown A dependency injection container used for resolving dependencies. @@ -190,6 +190,38 @@ p.location-badge. + .l-sub-section + h3 resolveAndInstantiate + + + pre.prettyprint + code. + resolveAndInstantiate(binding: Type | Binding) + + :markdown + Resolves a binding and instantiates an object in the context of the injector. + + + + + + + .l-sub-section + h3 instantiateResolved + + + pre.prettyprint + code. + instantiateResolved(binding: ResolvedBinding) + + :markdown + Instantiates an object using a resolved bindin in the context of the injector. + + + + + + .l-sub-section h3 displayName diff --git a/public/docs/js/latest/api/di/PRIVATE-const.jade b/public/docs/js/latest/api/di/PRIVATE-const.jade deleted file mode 100644 index 402e0f2c3b..0000000000 --- a/public/docs/js/latest/api/di/PRIVATE-const.jade +++ /dev/null @@ -1,11 +0,0 @@ - -.l-main-section - h2 PRIVATE variable - p.location-badge. - exported from angular2/di - defined in angular2/src/di/injector.ts (line 22) - - :markdown - - - diff --git a/public/docs/js/latest/api/di/PUBLIC-const.jade b/public/docs/js/latest/api/di/PUBLIC-const.jade deleted file mode 100644 index 5258180743..0000000000 --- a/public/docs/js/latest/api/di/PUBLIC-const.jade +++ /dev/null @@ -1,11 +0,0 @@ - -.l-main-section - h2 PUBLIC variable - p.location-badge. - exported from angular2/di - defined in angular2/src/di/injector.ts (line 21) - - :markdown - - - diff --git a/public/docs/js/latest/api/di/PUBLIC_AND_PRIVATE-const.jade b/public/docs/js/latest/api/di/PUBLIC_AND_PRIVATE-const.jade deleted file mode 100644 index e158983d61..0000000000 --- a/public/docs/js/latest/api/di/PUBLIC_AND_PRIVATE-const.jade +++ /dev/null @@ -1,11 +0,0 @@ - -.l-main-section - h2 PUBLIC_AND_PRIVATE variable - p.location-badge. - exported from angular2/di - defined in angular2/src/di/injector.ts (line 23) - - :markdown - - - diff --git a/public/docs/js/latest/api/di/ProtoInjector-class.jade b/public/docs/js/latest/api/di/ProtoInjector-class.jade index 9f8b37045f..bf1590c124 100644 --- a/public/docs/js/latest/api/di/ProtoInjector-class.jade +++ b/public/docs/js/latest/api/di/ProtoInjector-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/di - defined in angular2/src/di/injector.ts (line 167) + defined in angular2/src/di/injector.ts (line 175) :markdown diff --git a/public/docs/js/latest/api/di/undefinedValue-const.jade b/public/docs/js/latest/api/di/UNDEFINED-const.jade similarity index 83% rename from public/docs/js/latest/api/di/undefinedValue-const.jade rename to public/docs/js/latest/api/di/UNDEFINED-const.jade index b916cc985b..147c48547e 100644 --- a/public/docs/js/latest/api/di/undefinedValue-const.jade +++ b/public/docs/js/latest/api/di/UNDEFINED-const.jade @@ -1,6 +1,6 @@ .l-main-section - h2 undefinedValue variable + h2 UNDEFINED variable p.location-badge. exported from angular2/di defined in angular2/src/di/injector.ts (line 19) diff --git a/public/docs/js/latest/api/di/Visibility-enum.jade b/public/docs/js/latest/api/di/Visibility-enum.jade new file mode 100644 index 0000000000..6ebefe1f54 --- /dev/null +++ b/public/docs/js/latest/api/di/Visibility-enum.jade @@ -0,0 +1,45 @@ + +p.location-badge. + exported from angular2/di + defined in angular2/src/di/injector.ts (line 19) + +:markdown + + +.l-main-section + h2 Members + .l-sub-section + h3 Public + + + :markdown + + + + + + + + .l-sub-section + h3 Private + + + :markdown + + + + + + + + .l-sub-section + h3 PublicAndPrivate + + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/di/_data.json b/public/docs/js/latest/api/di/_data.json index 50ba8b86a1..eb9956557e 100644 --- a/public/docs/js/latest/api/di/_data.json +++ b/public/docs/js/latest/api/di/_data.json @@ -60,20 +60,12 @@ "title" : "DependencyProvider Interface" }, - "PUBLIC_AND_PRIVATE-const" : { - "title" : "PUBLIC_AND_PRIVATE Const" + "Visibility-enum" : { + "title" : "Visibility Enum" }, - "PUBLIC-const" : { - "title" : "PUBLIC Const" - }, - - "PRIVATE-const" : { - "title" : "PRIVATE Const" - }, - - "undefinedValue-const" : { - "title" : "undefinedValue Const" + "UNDEFINED-const" : { + "title" : "UNDEFINED Const" }, "Binding-class" : { diff --git a/public/docs/js/latest/api/di/index.jade b/public/docs/js/latest/api/di/index.jade index 5fe0b1f7f0..121d8e3528 100644 --- a/public/docs/js/latest/api/di/index.jade +++ b/public/docs/js/latest/api/di/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/di.ts (line 1) + defined in angular2/di.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/directives/coreDirectives-const.jade b/public/docs/js/latest/api/directives/CORE_DIRECTIVES-const.jade similarity index 89% rename from public/docs/js/latest/api/directives/coreDirectives-const.jade rename to public/docs/js/latest/api/directives/CORE_DIRECTIVES-const.jade index f294e8a95f..10f54d8b7c 100644 --- a/public/docs/js/latest/api/directives/coreDirectives-const.jade +++ b/public/docs/js/latest/api/directives/CORE_DIRECTIVES-const.jade @@ -1,9 +1,9 @@ .l-main-section - h2 coreDirectives variable + h2 CORE_DIRECTIVES variable p.location-badge. exported from angular2/directives - defined in angular2/directives.ts (line 62) + defined in angular2/directives.ts (line 63) :markdown A collection of the Angular core directives that are likely to be used in each and every Angular diff --git a/public/docs/js/latest/api/directives/CSSClass-class.jade b/public/docs/js/latest/api/directives/NgClass-class.jade similarity index 80% rename from public/docs/js/latest/api/directives/CSSClass-class.jade rename to public/docs/js/latest/api/directives/NgClass-class.jade index 67049c3a3b..0df1a10df2 100644 --- a/public/docs/js/latest/api/directives/CSSClass-class.jade +++ b/public/docs/js/latest/api/directives/NgClass-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/directives - defined in angular2/src/directives/class.ts (line 11) + defined in angular2/src/directives/ng_class.ts (line 11) :markdown Adds and removes CSS classes based on an {expression} value. @@ -18,7 +18,7 @@ p.location-badge. # Example: ``` -
+
Please check errors.
``` @@ -32,9 +32,9 @@ p.location-badge. pre.prettyprint code. @Directive({ - selector: '[class]', + selector: '[ng-class]', lifecycle: [LifecycleEvent.onCheck, LifecycleEvent.onDestroy], - properties: ['rawClass: class'] + properties: ['rawClass: ng-class', 'initialClasses: class'] }) @@ -55,6 +55,18 @@ p.location-badge. + .l-sub-section + h3 initialClasses + + + :markdown + + + + + + + .l-sub-section h3 rawClass diff --git a/public/docs/js/latest/api/directives/NgNonBindable-class.jade b/public/docs/js/latest/api/directives/NgNonBindable-class.jade index b95ab32e66..bf3177cde9 100644 --- a/public/docs/js/latest/api/directives/NgNonBindable-class.jade +++ b/public/docs/js/latest/api/directives/NgNonBindable-class.jade @@ -13,7 +13,7 @@ p.location-badge. ```
Normal: {{1 + 2}}
// output "Normal: 3" -
Ignored: {{1 + 2}}
// output "Ignored: {{1 + 2}}" +
Ignored: {{1 + 2}}
// output "Ignored: {{1 + 2}}" ``` diff --git a/public/docs/js/latest/api/directives/_data.json b/public/docs/js/latest/api/directives/_data.json index 8373747733..7baf03e6d7 100644 --- a/public/docs/js/latest/api/directives/_data.json +++ b/public/docs/js/latest/api/directives/_data.json @@ -4,12 +4,12 @@ "intro" : "Common directives shipped with Angular." }, - "coreDirectives-const" : { - "title" : "coreDirectives Const" + "CORE_DIRECTIVES-const" : { + "title" : "CORE_DIRECTIVES Const" }, - "CSSClass-class" : { - "title" : "CSSClass Class" + "NgClass-class" : { + "title" : "NgClass Class" }, "NgFor-class" : { diff --git a/public/docs/js/latest/api/directives/index.jade b/public/docs/js/latest/api/directives/index.jade index 59b9b612a4..f18ef0ec3c 100644 --- a/public/docs/js/latest/api/directives/index.jade +++ b/public/docs/js/latest/api/directives/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/directives.ts (line 1) + defined in angular2/directives.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/forms/formInjectables-const.jade b/public/docs/js/latest/api/forms/FORM_BINDINGS-const.jade similarity index 82% rename from public/docs/js/latest/api/forms/formInjectables-const.jade rename to public/docs/js/latest/api/forms/FORM_BINDINGS-const.jade index f23cb7ce74..f19b0d27e9 100644 --- a/public/docs/js/latest/api/forms/formInjectables-const.jade +++ b/public/docs/js/latest/api/forms/FORM_BINDINGS-const.jade @@ -1,6 +1,6 @@ .l-main-section - h2 formInjectables variable + h2 FORM_BINDINGS variable p.location-badge. exported from angular2/forms defined in angular2/forms.ts (line 42) diff --git a/public/docs/js/latest/api/forms/formDirectives-const.jade b/public/docs/js/latest/api/forms/FORM_DIRECTIVES-const.jade similarity index 88% rename from public/docs/js/latest/api/forms/formDirectives-const.jade rename to public/docs/js/latest/api/forms/FORM_DIRECTIVES-const.jade index 1dc38d2ec8..93cf337a6e 100644 --- a/public/docs/js/latest/api/forms/formDirectives-const.jade +++ b/public/docs/js/latest/api/forms/FORM_DIRECTIVES-const.jade @@ -1,6 +1,6 @@ .l-main-section - h2 formDirectives variable + h2 FORM_DIRECTIVES variable p.location-badge. exported from angular2/forms defined in angular2/src/forms/directives.ts (line 38) diff --git a/public/docs/js/latest/api/forms/FormBuilder-class.jade b/public/docs/js/latest/api/forms/FormBuilder-class.jade index c3e5fa5e22..009c059e79 100644 --- a/public/docs/js/latest/api/forms/FormBuilder-class.jade +++ b/public/docs/js/latest/api/forms/FormBuilder-class.jade @@ -10,7 +10,7 @@ p.location-badge. ``` import {Component, View, bootstrap} from 'angular2/angular2'; - import {FormBuilder, Validators, formDirectives, ControlGroup} from 'angular2/forms'; + import {FormBuilder, Validators, FORM_DIRECTIVES, ControlGroup} from 'angular2/forms'; @Component({ selector: 'login-comp', @@ -30,7 +30,7 @@ p.location-badge. `, directives: [ - formDirectives + FORM_DIRECTIVES ] }) class LoginComp { diff --git a/public/docs/js/latest/api/forms/NgControlGroup-class.jade b/public/docs/js/latest/api/forms/NgControlGroup-class.jade index 653188ea00..3a36761b36 100644 --- a/public/docs/js/latest/api/forms/NgControlGroup-class.jade +++ b/public/docs/js/latest/api/forms/NgControlGroup-class.jade @@ -16,7 +16,7 @@ p.location-badge. ``` @Component({selector: "signup-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: `
diff --git a/public/docs/js/latest/api/forms/NgControlName-class.jade b/public/docs/js/latest/api/forms/NgControlName-class.jade index 1a345c2518..068f74aaeb 100644 --- a/public/docs/js/latest/api/forms/NgControlName-class.jade +++ b/public/docs/js/latest/api/forms/NgControlName-class.jade @@ -17,7 +17,7 @@ p.location-badge. ``` @Component({selector: "login-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: ` Login @@ -40,7 +40,7 @@ p.location-badge. ``` @Component({selector: "login-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: ` Login diff --git a/public/docs/js/latest/api/forms/NgForm-class.jade b/public/docs/js/latest/api/forms/NgForm-class.jade index 258e759d6d..9920e3f33b 100644 --- a/public/docs/js/latest/api/forms/NgForm-class.jade +++ b/public/docs/js/latest/api/forms/NgForm-class.jade @@ -11,7 +11,7 @@ p.location-badge. ``` @Component({selector: "signup-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: `
diff --git a/public/docs/js/latest/api/forms/NgFormControl-class.jade b/public/docs/js/latest/api/forms/NgFormControl-class.jade index d708de2930..c91f41f1a2 100644 --- a/public/docs/js/latest/api/forms/NgFormControl-class.jade +++ b/public/docs/js/latest/api/forms/NgFormControl-class.jade @@ -17,7 +17,7 @@ p.location-badge. ``` @Component({selector: "login-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: "" }) class LoginComp { @@ -35,7 +35,7 @@ p.location-badge. ``` @Component({selector: "login-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: "" }) class LoginComp { diff --git a/public/docs/js/latest/api/forms/NgFormModel-class.jade b/public/docs/js/latest/api/forms/NgFormModel-class.jade index a76c02aa58..a951104a76 100644 --- a/public/docs/js/latest/api/forms/NgFormModel-class.jade +++ b/public/docs/js/latest/api/forms/NgFormModel-class.jade @@ -15,7 +15,7 @@ p.location-badge. ``` @Component({selector: "login-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: "" + "Login " + "Password " + @@ -44,7 +44,7 @@ p.location-badge. ``` @Component({selector: "login-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: "" + "Login " + "Password " + diff --git a/public/docs/js/latest/api/forms/NgModel-class.jade b/public/docs/js/latest/api/forms/NgModel-class.jade index 6cdbeb1263..cd425f22d5 100644 --- a/public/docs/js/latest/api/forms/NgModel-class.jade +++ b/public/docs/js/latest/api/forms/NgModel-class.jade @@ -10,7 +10,7 @@ p.location-badge. ``` @Component({selector: "search-comp"}) @View({ - directives: [formDirectives], + directives: [FORM_DIRECTIVES], template: ` `}) diff --git a/public/docs/js/latest/api/forms/_data.json b/public/docs/js/latest/api/forms/_data.json index 83fad1c6a2..6cce8b6977 100644 --- a/public/docs/js/latest/api/forms/_data.json +++ b/public/docs/js/latest/api/forms/_data.json @@ -80,8 +80,8 @@ "title" : "SelectControlValueAccessor Class" }, - "formDirectives-const" : { - "title" : "formDirectives Const" + "FORM_DIRECTIVES-const" : { + "title" : "FORM_DIRECTIVES Const" }, "Validators-class" : { @@ -100,7 +100,7 @@ "title" : "FormBuilder Class" }, - "formInjectables-const" : { - "title" : "formInjectables Const" + "FORM_BINDINGS-const" : { + "title" : "FORM_BINDINGS Const" } } \ No newline at end of file diff --git a/public/docs/js/latest/api/http/BaseRequestOptions-class.jade b/public/docs/js/latest/api/http/BaseRequestOptions-class.jade deleted file mode 100644 index 841cc5f32e..0000000000 --- a/public/docs/js/latest/api/http/BaseRequestOptions-class.jade +++ /dev/null @@ -1,50 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/base_request_options.ts (line 62) - -:markdown - Injectable version of RequestOptions, with overridable default values. - - #Example - - ``` - import {Http, BaseRequestOptions, Request} from 'angular2/http'; - ... - class MyComponent { - constructor(baseRequestOptions:BaseRequestOptions, http:Http) { - var options = baseRequestOptions.merge({body: 'foobar', url: 'https://foo'}); - var request = new Request(options); - http.request(request).subscribe(res => this.bars = res.json()); - } - } - - ``` - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor() - - :markdown - - - - - diff --git a/public/docs/js/latest/api/http/Connection-class.jade b/public/docs/js/latest/api/http/Connection-class.jade deleted file mode 100644 index a6459eff6c..0000000000 --- a/public/docs/js/latest/api/http/Connection-class.jade +++ /dev/null @@ -1,62 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/interfaces.ts (line 25) - -:markdown - Abstract class from which real connections are derived. - - -.l-main-section - h2 Members - .l-sub-section - h3 readyState - - - :markdown - - - - - - - - .l-sub-section - h3 request - - - :markdown - - - - - - - - .l-sub-section - h3 response - - - :markdown - - - - - - - - .l-sub-section - h3 dispose - - - pre.prettyprint - code. - dispose() - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/ConnectionBackend-class.jade b/public/docs/js/latest/api/http/ConnectionBackend-class.jade deleted file mode 100644 index 0698b51b34..0000000000 --- a/public/docs/js/latest/api/http/ConnectionBackend-class.jade +++ /dev/null @@ -1,44 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/interfaces.ts (line 14) - -:markdown - Abstract class from which real backends are derived. - - The primary purpose of a `ConnectionBackend` is to create new connections to fulfill a given - Request. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor() - - :markdown - - - - - - - .l-sub-section - h3 createConnection - - - pre.prettyprint - code. - createConnection(request: any) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/Headers-class.jade b/public/docs/js/latest/api/http/Headers-class.jade deleted file mode 100644 index 2142aed520..0000000000 --- a/public/docs/js/latest/api/http/Headers-class.jade +++ /dev/null @@ -1,196 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/headers.ts (line 16) - -:markdown - Polyfill for [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers/Headers), as - specified in the [Fetch Spec](https://fetch.spec.whatwg.org/#headers-class). The only known - difference from the spec is the lack of an `entries` method. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(headers?: Headers | StringMap<string, any>) - - :markdown - - - - - - - .l-sub-section - h3 append - - - pre.prettyprint - code. - append(name: string, value: string) - - :markdown - Appends a header to existing list of header values for a given header name. - - - - - - - - .l-sub-section - h3 delete - - - pre.prettyprint - code. - delete(name: string) - - :markdown - Deletes all header values for the given name. - - - - - - - - .l-sub-section - h3 forEach - - - pre.prettyprint - code. - forEach(fn: Function) - - :markdown - - - - - - - - .l-sub-section - h3 get - - - pre.prettyprint - code. - get(header: string) - - :markdown - Returns first header that matches given name. - - - - - - - - .l-sub-section - h3 has - - - pre.prettyprint - code. - has(header: string) - - :markdown - Check for existence of header by given name. - - - - - - - - .l-sub-section - h3 keys - - - pre.prettyprint - code. - keys() - - :markdown - Provides names of set headers - - - - - - - - .l-sub-section - h3 set - - - pre.prettyprint - code. - set(header: string, value: string | List<string>) - - :markdown - Sets or overrides header value for given name. - - - - - - - - .l-sub-section - h3 values - - - pre.prettyprint - code. - values() - - :markdown - Returns values of all headers. - - - - - - - - .l-sub-section - h3 getAll - - - pre.prettyprint - code. - getAll(header: string) - - :markdown - Returns list of header values for a given name. - - - - - - - - .l-sub-section - h3 entries - - - pre.prettyprint - code. - entries() - - :markdown - This method is not implemented. - - - - - - diff --git a/public/docs/js/latest/api/http/Http-class.jade b/public/docs/js/latest/api/http/Http-class.jade deleted file mode 100644 index cc43ea9458..0000000000 --- a/public/docs/js/latest/api/http/Http-class.jade +++ /dev/null @@ -1,222 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/http.ts (line 32) - -:markdown - Performs http requests using `XMLHttpRequest` as the default backend. - - `Http` is available as an injectable class, with methods to perform http requests. Calling - `request` returns an EventEmitter which will emit a single Response when a - response is received. - - - ## Breaking Change - - Previously, methods of `Http` would return an RxJS Observable directly. For now, - the `toRx()` method of EventEmitter needs to be called in order to get the RxJS - Subject. `EventEmitter` does not provide combinators like `map`, and has different semantics for - subscribing/observing. This is temporary; the result of all `Http` method calls will be either an - Observable - or Dart Stream when [issue #2794](https://github.com/angular/angular/issues/2794) is resolved. - - #Example - - ``` - import {Http, httpInjectables} from 'angular2/http'; - @Component({selector: 'http-app', viewBindings: [httpInjectables]}) - @View({templateUrl: 'people.html'}) - class PeopleComponent { - constructor(http: Http) { - http.get('people.json') - //Get the RxJS Subject - .toRx() - // Call map on the response observable to get the parsed people object - .map(res => res.json()) - // Subscribe to the observable to get the parsed people object and attach it to the - // component - .subscribe(people => this.people = people); - } - } - ``` - - To use the EventEmitter returned by `Http`, simply pass a generator (See "interface - Generator" in the Async Generator spec: https://github.com/jhusain/asyncgenerator) to the - `observer` method of the returned emitter, with optional methods of `next`, `throw`, and `return`. - - #Example - - ``` - http.get('people.json').observer({next: (value) => this.people = people}); - ``` - - The default construct used to perform requests, `XMLHttpRequest`, is abstracted as a "Backend" ( - XHRBackend in this case), which could be mocked with dependency injection by replacing - the XHRBackend binding, as in the following example: - - #Example - - ``` - import {MockBackend, BaseRequestOptions, Http} from 'angular2/http'; - var injector = Injector.resolveAndCreate([ - BaseRequestOptions, - MockBackend, - bind(Http).toFactory( - function(backend, defaultOptions) { - return new Http(backend, defaultOptions); - }, - [MockBackend, BaseRequestOptions]) - ]); - var http = injector.get(Http); - http.get('request-from-mock-backend.json').toRx().subscribe((res:Response) => doSomething(res)); - ``` - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(_backend: ConnectionBackend, _defaultOptions: RequestOptions) - - :markdown - - - - - - - .l-sub-section - h3 request - - - pre.prettyprint - code. - request(url: string | Request, options?: IRequestOptions) - - :markdown - Performs any type of http request. First argument is required, and can either be a url or - a Request instance. If the first argument is a url, an optional RequestOptions - object can be provided as the 2nd argument. The options object will be merged with the values - of BaseRequestOptions before performing the request. - - - - - - - - .l-sub-section - h3 get - - - pre.prettyprint - code. - get(url: string, options?: IRequestOptions) - - :markdown - Performs a request with `get` http method. - - - - - - - - .l-sub-section - h3 post - - - pre.prettyprint - code. - post(url: string, body: string, options?: IRequestOptions) - - :markdown - Performs a request with `post` http method. - - - - - - - - .l-sub-section - h3 put - - - pre.prettyprint - code. - put(url: string, body: string, options?: IRequestOptions) - - :markdown - Performs a request with `put` http method. - - - - - - - - .l-sub-section - h3 delete - - - pre.prettyprint - code. - delete(url: string, options?: IRequestOptions) - - :markdown - Performs a request with `delete` http method. - - - - - - - - .l-sub-section - h3 patch - - - pre.prettyprint - code. - patch(url: string, body: string, options?: IRequestOptions) - - :markdown - Performs a request with `patch` http method. - - - - - - - - .l-sub-section - h3 head - - - pre.prettyprint - code. - head(url: string, options?: IRequestOptions) - - :markdown - Performs a request with `head` http method. - - - - - - diff --git a/public/docs/js/latest/api/http/IRequestOptions-interface.jade b/public/docs/js/latest/api/http/IRequestOptions-interface.jade deleted file mode 100644 index 283d087965..0000000000 --- a/public/docs/js/latest/api/http/IRequestOptions-interface.jade +++ /dev/null @@ -1,95 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/interfaces.ts (line 35) - -:markdown - Interface for options to construct a Request, based on - [RequestInit](https://fetch.spec.whatwg.org/#requestinit) from the Fetch spec. - - -.l-main-section - h2 Members - .l-sub-section - h3 url? - - - :markdown - - - - - - - - .l-sub-section - h3 method? - - - :markdown - - - - - - - - .l-sub-section - h3 headers? - - - :markdown - - - - - - - - .l-sub-section - h3 body? - - - :markdown - - - - - - - - .l-sub-section - h3 mode? - - - :markdown - - - - - - - - .l-sub-section - h3 credentials? - - - :markdown - - - - - - - - .l-sub-section - h3 cache? - - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/IResponseOptions-interface.jade b/public/docs/js/latest/api/http/IResponseOptions-interface.jade deleted file mode 100644 index 6506a5f5ad..0000000000 --- a/public/docs/js/latest/api/http/IResponseOptions-interface.jade +++ /dev/null @@ -1,83 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/interfaces.ts (line 50) - -:markdown - Interface for options to construct a Response, based on - [ResponseInit](https://fetch.spec.whatwg.org/#responseinit) from the Fetch spec. - - -.l-main-section - h2 Members - .l-sub-section - h3 body? - - - :markdown - - - - - - - - .l-sub-section - h3 status? - - - :markdown - - - - - - - - .l-sub-section - h3 statusText? - - - :markdown - - - - - - - - .l-sub-section - h3 headers? - - - :markdown - - - - - - - - .l-sub-section - h3 type? - - - :markdown - - - - - - - - .l-sub-section - h3 url? - - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/JSONPBackend-class.jade b/public/docs/js/latest/api/http/JSONPBackend-class.jade deleted file mode 100644 index 5e0a753709..0000000000 --- a/public/docs/js/latest/api/http/JSONPBackend-class.jade +++ /dev/null @@ -1,50 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/jsonp_backend.ts (line 89) - -:markdown - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(_browserJSONP: BrowserJsonp, _baseResponseOptions: ResponseOptions) - - :markdown - - - - - - - .l-sub-section - h3 createConnection - - - pre.prettyprint - code. - createConnection(request: Request) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/Jsonp-class.jade b/public/docs/js/latest/api/http/Jsonp-class.jade deleted file mode 100644 index 683e824c16..0000000000 --- a/public/docs/js/latest/api/http/Jsonp-class.jade +++ /dev/null @@ -1,54 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/http.ts (line 178) - -:markdown - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(backend: ConnectionBackend, defaultOptions: RequestOptions) - - :markdown - - - - - - - .l-sub-section - h3 request - - - pre.prettyprint - code. - request(url: string | Request, options?: IRequestOptions) - - :markdown - Performs any type of http request. First argument is required, and can either be a url or - a Request instance. If the first argument is a url, an optional RequestOptions - object can be provided as the 2nd argument. The options object will be merged with the values - of BaseRequestOptions before performing the request. - - - - - - diff --git a/public/docs/js/latest/api/http/MockBackend-class.jade b/public/docs/js/latest/api/http/MockBackend-class.jade deleted file mode 100644 index 11203b7133..0000000000 --- a/public/docs/js/latest/api/http/MockBackend-class.jade +++ /dev/null @@ -1,205 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/mock_backend.ts (line 99) - -:markdown - A mock backend for testing the Http service. - - This class can be injected in tests, and should be used to override bindings - to other backends, such as XHRBackend. - - #Example - - ``` - import {MockBackend, DefaultOptions, Http} from 'angular2/http'; - it('should get some data', inject([AsyncTestCompleter], (async) => { - var connection; - var injector = Injector.resolveAndCreate([ - MockBackend, - bind(Http).toFactory((backend, defaultOptions) => { - return new Http(backend, defaultOptions) - }, [MockBackend, DefaultOptions])]); - var http = injector.get(Http); - var backend = injector.get(MockBackend); - //Assign any newly-created connection to local variable - backend.connections.subscribe(c => connection = c); - http.request('data.json').subscribe((res) => { - expect(res.text()).toBe('awesome'); - async.done(); - }); - connection.mockRespond(new Response('awesome')); - })); - ``` - - This method only exists in the mock implementation, not in real Backends. - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - - .l-sub-section - h3.annotation IMPLEMENTS - pre.prettyprint - code. - @IMPLEMENTS(ConnectionBackend) - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor() - - :markdown - - - - - - - .l-sub-section - h3 connections - - - :markdown - EventEmitter - of MockConnection instances that have been created by this backend. Can be subscribed - to in order to respond to connections. - - #Example - - ``` - import {MockBackend, Http, BaseRequestOptions} from 'angular2/http'; - import {Injector} from 'angular2/di'; - - it('should get a response', () => { - var connection; //this will be set when a new connection is emitted from the backend. - var text; //this will be set from mock response - var injector = Injector.resolveAndCreate([ - MockBackend, - bind(Http).toFactory(backend, options) { - return new Http(backend, options); - }, [MockBackend, BaseRequestOptions]]); - var backend = injector.get(MockBackend); - var http = injector.get(Http); - backend.connections.subscribe(c => connection = c); - http.request('something.json').subscribe(res => { - text = res.text(); - }); - connection.mockRespond(new Response({body: 'Something'})); - expect(text).toBe('Something'); - }); - ``` - - This property only exists in the mock implementation, not in real Backends. - - - - - - - - .l-sub-section - h3 connectionsArray - - - :markdown - An array representation of `connections`. This array will be updated with each connection that - is created by this backend. - - This property only exists in the mock implementation, not in real Backends. - - - - - - - - .l-sub-section - h3 pendingConnections - - - :markdown - EventEmitter of MockConnection instances that haven't yet been resolved (i.e. - with a `readyState` - less than 4). Used internally to verify that no connections are pending via the - `verifyNoPendingRequests` method. - - This property only exists in the mock implementation, not in real Backends. - - - - - - - - .l-sub-section - h3 verifyNoPendingRequests - - - pre.prettyprint - code. - verifyNoPendingRequests() - - :markdown - Checks all connections, and raises an exception if any connection has not received a response. - - This method only exists in the mock implementation, not in real Backends. - - - - - - - - .l-sub-section - h3 resolveAllConnections - - - pre.prettyprint - code. - resolveAllConnections() - - :markdown - Can be used in conjunction with `verifyNoPendingRequests` to resolve any not-yet-resolve - connections, if it's expected that there are connections that have not yet received a response. - - This method only exists in the mock implementation, not in real Backends. - - - - - - - - .l-sub-section - h3 createConnection - - - pre.prettyprint - code. - createConnection(req: Request) - - :markdown - Creates a new MockConnection. This is equivalent to calling `new - MockConnection()`, except that it also will emit the new `Connection` to the `connections` - emitter of this `MockBackend` instance. This method will usually only be used by tests - against the framework itself, not by end-users. - - - - - - diff --git a/public/docs/js/latest/api/http/MockConnection-class.jade b/public/docs/js/latest/api/http/MockConnection-class.jade deleted file mode 100644 index 5c96354ddc..0000000000 --- a/public/docs/js/latest/api/http/MockConnection-class.jade +++ /dev/null @@ -1,159 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/mock_backend.ts (line 8) - -:markdown - Mock Connection to represent a Connection for tests. - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation IMPLEMENTS - pre.prettyprint - code. - @IMPLEMENTS(Connection) - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(req: Request) - - :markdown - - - - - - - .l-sub-section - h3 readyState - - - :markdown - Describes the state of the connection, based on `XMLHttpRequest.readyState`, but with - additional states. For example, state 5 indicates an aborted connection. - - - - - - - - .l-sub-section - h3 request - - - :markdown - Request instance used to create the connection. - - - - - - - - .l-sub-section - h3 response - - - :markdown - EventEmitter of Response. Can be subscribed to in order to be notified when a - response is available. - - - - - - - - .l-sub-section - h3 dispose - - - pre.prettyprint - code. - dispose() - - :markdown - Changes the `readyState` of the connection to a custom state of 5 (cancelled). - - - - - - - - .l-sub-section - h3 mockRespond - - - pre.prettyprint - code. - mockRespond(res: Response) - - :markdown - Sends a mock response to the connection. This response is the value that is emitted to the - EventEmitter returned by Http. - - #Example - - ``` - var connection; - backend.connections.subscribe(c => connection = c); - http.request('data.json').subscribe(res => console.log(res.text())); - connection.mockRespond(new Response('fake response')); //logs 'fake response' - ``` - - - - - - - - .l-sub-section - h3 mockDownload - - - pre.prettyprint - code. - mockDownload(res: Response) - - :markdown - Not yet implemented! - - Sends the provided Response to the `downloadObserver` of the `Request` - associated with this connection. - - - - - - - - .l-sub-section - h3 mockError - - - pre.prettyprint - code. - mockError(err?: Error) - - :markdown - Emits the provided error object as an error to the Response EventEmitter - returned - from Http. - - - - - - diff --git a/public/docs/js/latest/api/http/ReadyStates-enum.jade b/public/docs/js/latest/api/http/ReadyStates-enum.jade deleted file mode 100644 index 8b35561614..0000000000 --- a/public/docs/js/latest/api/http/ReadyStates-enum.jade +++ /dev/null @@ -1,84 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/enums.ts (line 55) - -: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 - - - - - - diff --git a/public/docs/js/latest/api/http/Request-class.jade b/public/docs/js/latest/api/http/Request-class.jade deleted file mode 100644 index 14c2e216cf..0000000000 --- a/public/docs/js/latest/api/http/Request-class.jade +++ /dev/null @@ -1,127 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/static_request.ts (line 10) - -:markdown - Creates `Request` instances from provided values. - - The Request's interface is inspired by the Request constructor defined in the [Fetch - Spec](https://fetch.spec.whatwg.org/#request-class), - but is considered a static value whose body can be accessed many times. There are other - differences in the implementation, but this is the most significant. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(requestOptions: RequestOptions) - - :markdown - - - - - - - .l-sub-section - h3 method - - - :markdown - Http method with which to perform the request. - - Defaults to GET. - - - - - - - - .l-sub-section - h3 mode - - - :markdown - - - - - - - - .l-sub-section - h3 credentials - - - :markdown - - - - - - - - .l-sub-section - h3 headers - - - :markdown - Headers object based on the `Headers` class in the [Fetch - Spec](https://fetch.spec.whatwg.org/#headers-class). Headers class reference. - - - - - - - - .l-sub-section - h3 url - - - :markdown - Url of the remote resource - - - - - - - - .l-sub-section - h3 cache - - - :markdown - - - - - - - - .l-sub-section - h3 text - - - pre.prettyprint - code. - text() - - :markdown - Returns the request's body as string, assuming that body exists. If body is undefined, return - empty - string. - - - - - - diff --git a/public/docs/js/latest/api/http/RequestCacheOpts-enum.jade b/public/docs/js/latest/api/http/RequestCacheOpts-enum.jade deleted file mode 100644 index e483c58de7..0000000000 --- a/public/docs/js/latest/api/http/RequestCacheOpts-enum.jade +++ /dev/null @@ -1,83 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/enums.ts (line 11) - -:markdown - Acceptable cache option to be associated with a Request, 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 - - - - - - diff --git a/public/docs/js/latest/api/http/RequestCredentialsOpts-enum.jade b/public/docs/js/latest/api/http/RequestCredentialsOpts-enum.jade deleted file mode 100644 index a470e5ec7d..0000000000 --- a/public/docs/js/latest/api/http/RequestCredentialsOpts-enum.jade +++ /dev/null @@ -1,47 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/enums.ts (line 24) - -:markdown - Acceptable credentials option to be associated with a Request, 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 - - - - - - diff --git a/public/docs/js/latest/api/http/RequestMethods-enum.jade b/public/docs/js/latest/api/http/RequestMethods-enum.jade deleted file mode 100644 index 36672d5b9a..0000000000 --- a/public/docs/js/latest/api/http/RequestMethods-enum.jade +++ /dev/null @@ -1,94 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/enums.ts (line 34) - -: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 - - - - - - diff --git a/public/docs/js/latest/api/http/RequestModesOpts-enum.jade b/public/docs/js/latest/api/http/RequestModesOpts-enum.jade deleted file mode 100644 index dba372557a..0000000000 --- a/public/docs/js/latest/api/http/RequestModesOpts-enum.jade +++ /dev/null @@ -1,47 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/enums.ts (line 1) - -:markdown - Acceptable origin modes to be associated with a Request, 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 - - - - - - diff --git a/public/docs/js/latest/api/http/RequestOptions-class.jade b/public/docs/js/latest/api/http/RequestOptions-class.jade deleted file mode 100644 index 5af78fd510..0000000000 --- a/public/docs/js/latest/api/http/RequestOptions-class.jade +++ /dev/null @@ -1,138 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/base_request_options.ts (line 5) - -:markdown - Creates a request options object similar to the `RequestInit` description - in the [Fetch - Spec](https://fetch.spec.whatwg.org/#requestinit) to be optionally provided when instantiating a - Request. - - All values are null by default. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor({method, headers, body, mode, credentials, cache, url}?: IRequestOptions) - - :markdown - - - - - - - .l-sub-section - h3 method - - - :markdown - Http method with which to execute the request. - - Defaults to "GET". - - - - - - - - .l-sub-section - h3 headers - - - :markdown - Headers object based on the `Headers` class in the [Fetch - Spec](https://fetch.spec.whatwg.org/#headers-class). - - - - - - - - .l-sub-section - h3 body - - - :markdown - Body to be used when creating the request. - - - - - - - - .l-sub-section - h3 mode - - - :markdown - - - - - - - - .l-sub-section - h3 credentials - - - :markdown - - - - - - - - .l-sub-section - h3 cache - - - :markdown - - - - - - - - .l-sub-section - h3 url - - - :markdown - - - - - - - - .l-sub-section - h3 merge - - - pre.prettyprint - code. - merge(options?: IRequestOptions) - - :markdown - Creates a copy of the `RequestOptions` instance, using the optional input as values to override - existing values. - - - - - - diff --git a/public/docs/js/latest/api/http/Response-class.jade b/public/docs/js/latest/api/http/Response-class.jade deleted file mode 100644 index 71965dfe46..0000000000 --- a/public/docs/js/latest/api/http/Response-class.jade +++ /dev/null @@ -1,227 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/static_response.ts (line 5) - -:markdown - Creates `Response` instances from provided values. - - Though this object isn't - usually instantiated by end-users, it is the primary object interacted with when it comes time to - add data to a view. - - #Example - - ``` - http.request('my-friends.txt').subscribe(response => this.friends = response.text()); - ``` - - The Response's interface is inspired by the Response constructor defined in the [Fetch - Spec](https://fetch.spec.whatwg.org/#response-class), but is considered a static value whose body - can be accessed many times. There are other differences in the implementation, but this is the - most significant. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(responseOptions: ResponseOptions) - - :markdown - - - - - - - .l-sub-section - h3 type - - - :markdown - One of "basic", "cors", "default", "error, or "opaque". - - Defaults to "default". - - - - - - - - .l-sub-section - h3 ok - - - :markdown - True if the response's status is within 200-299 - - - - - - - - .l-sub-section - h3 url - - - :markdown - URL of response. - - Defaults to empty string. - - - - - - - - .l-sub-section - h3 status - - - :markdown - Status code returned by server. - - Defaults to 200. - - - - - - - - .l-sub-section - h3 statusText - - - :markdown - Text representing the corresponding reason phrase to the `status`, as defined in [ietf rfc 2616 - section 6.1.1](https://tools.ietf.org/html/rfc2616#section-6.1.1) - - Defaults to "OK" - - - - - - - - .l-sub-section - h3 bytesLoaded - - - :markdown - Non-standard property - - Denotes how many of the response body's bytes have been loaded, for example if the response is - the result of a progress event. - - - - - - - - .l-sub-section - h3 totalBytes - - - :markdown - Non-standard property - - Denotes how many bytes are expected in the final response body. - - - - - - - - .l-sub-section - h3 headers - - - :markdown - Headers object based on the `Headers` class in the [Fetch - Spec](https://fetch.spec.whatwg.org/#headers-class). - - - - - - - - .l-sub-section - h3 blob - - - pre.prettyprint - code. - blob() - - :markdown - Not yet implemented - - - - - - - - .l-sub-section - h3 json - - - pre.prettyprint - code. - json() - - :markdown - Attempts to return body as parsed `JSON` object, or raises an exception. - - - - - - - - .l-sub-section - h3 text - - - pre.prettyprint - code. - text() - - :markdown - Returns the body as a string, presuming `toString()` can be called on the response body. - - - - - - - - .l-sub-section - h3 arrayBuffer - - - pre.prettyprint - code. - arrayBuffer() - - :markdown - Not yet implemented - - - - - - diff --git a/public/docs/js/latest/api/http/ResponseOptions-class.jade b/public/docs/js/latest/api/http/ResponseOptions-class.jade deleted file mode 100644 index d4fa9e1220..0000000000 --- a/public/docs/js/latest/api/http/ResponseOptions-class.jade +++ /dev/null @@ -1,119 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/base_response_options.ts (line 5) - -:markdown - Creates a response options object similar to the - [ResponseInit](https://fetch.spec.whatwg.org/#responseinit) description - in the Fetch - Spec to be optionally provided when instantiating a - Response. - - All values are null by default. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor({body, status, headers, statusText, type, url}?: IResponseOptions) - - :markdown - - - - - - - .l-sub-section - h3 body - - - :markdown - - - - - - - - .l-sub-section - h3 status - - - :markdown - - - - - - - - .l-sub-section - h3 headers - - - :markdown - - - - - - - - .l-sub-section - h3 statusText - - - :markdown - - - - - - - - .l-sub-section - h3 type - - - :markdown - - - - - - - - .l-sub-section - h3 url - - - :markdown - - - - - - - - .l-sub-section - h3 merge - - - pre.prettyprint - code. - merge(options?: IResponseOptions) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/ResponseTypes-enum.jade b/public/docs/js/latest/api/http/ResponseTypes-enum.jade deleted file mode 100644 index 79ba6c78a9..0000000000 --- a/public/docs/js/latest/api/http/ResponseTypes-enum.jade +++ /dev/null @@ -1,71 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/enums.ts (line 68) - -:markdown - Acceptable response types to be associated with a Response, 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 - - - - - - diff --git a/public/docs/js/latest/api/http/URLSearchParams-class.jade b/public/docs/js/latest/api/http/URLSearchParams-class.jade deleted file mode 100644 index 1c27f1dc89..0000000000 --- a/public/docs/js/latest/api/http/URLSearchParams-class.jade +++ /dev/null @@ -1,146 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/url_search_params.ts (line 22) - -:markdown - Map-like representation of url search parameters, based on - [URLSearchParams](https://url.spec.whatwg.org/#urlsearchparams) in the url living standard. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(rawParams: string) - - :markdown - - - - - - - .l-sub-section - h3 paramsMap - - - :markdown - - - - - - - - .l-sub-section - h3 rawParams - - - :markdown - - - - - - - - .l-sub-section - h3 has - - - pre.prettyprint - code. - has(param: string) - - :markdown - - - - - - - - .l-sub-section - h3 get - - - pre.prettyprint - code. - get(param: string) - - :markdown - - - - - - - - .l-sub-section - h3 getAll - - - pre.prettyprint - code. - getAll(param: string) - - :markdown - - - - - - - - .l-sub-section - h3 append - - - pre.prettyprint - code. - append(param: string, val: string) - - :markdown - - - - - - - - .l-sub-section - h3 toString - - - pre.prettyprint - code. - toString() - - :markdown - - - - - - - - .l-sub-section - h3 delete - - - pre.prettyprint - code. - delete(param: string) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/XHRBackend-class.jade b/public/docs/js/latest/api/http/XHRBackend-class.jade deleted file mode 100644 index 880e853cab..0000000000 --- a/public/docs/js/latest/api/http/XHRBackend-class.jade +++ /dev/null @@ -1,73 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/xhr_backend.ts (line 75) - -:markdown - Creates XHRConnection instances. - - This class would typically not be used by end users, but could be - overridden if a different backend implementation should be used, - such as in a node backend. - - #Example - - ``` - import {Http, MyNodeBackend, httpInjectables, BaseRequestOptions} from 'angular2/http'; - @Component({ - viewBindings: [ - httpInjectables, - bind(Http).toFactory((backend, options) => { - return new Http(backend, options); - }, [MyNodeBackend, BaseRequestOptions])] - }) - class MyComponent { - constructor(http:Http) { - http('people.json').subscribe(res => this.people = res.json()); - } - } - ``` - - - -.l-main-section - h2 Annotations - .l-sub-section - h3.annotation Injectable - pre.prettyprint - code. - @Injectable() - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(_browserXHR: BrowserXhr, _baseResponseOptions: ResponseOptions) - - :markdown - - - - - - - .l-sub-section - h3 createConnection - - - pre.prettyprint - code. - createConnection(request: Request) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/http/XHRConnection-class.jade b/public/docs/js/latest/api/http/XHRConnection-class.jade deleted file mode 100644 index 0be1671907..0000000000 --- a/public/docs/js/latest/api/http/XHRConnection-class.jade +++ /dev/null @@ -1,85 +0,0 @@ - -p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/xhr_backend.ts (line 9) - -:markdown - Creates connections using `XMLHttpRequest`. Given a fully-qualified - request, an `XHRConnection` will immediately create an `XMLHttpRequest` object and send the - request. - - This class would typically not be created or interacted with directly inside applications, though - the MockConnection may be interacted with in tests. - - -.l-main-section - h2 Members - .l-sub-section - h3 constructor - - - pre.prettyprint - code. - constructor(req: Request, browserXHR: BrowserXhr, baseResponseOptions?: ResponseOptions) - - :markdown - - - - - - - .l-sub-section - h3 request - - - :markdown - - - - - - - - .l-sub-section - h3 response - - - :markdown - Response EventEmitter which emits a single Response value on load event of - `XMLHttpRequest`. - - - - - - - - .l-sub-section - h3 readyState - - - :markdown - - - - - - - - .l-sub-section - h3 dispose - - - pre.prettyprint - code. - dispose() - - :markdown - Calls abort on the underlying XMLHttpRequest. - - - - - - diff --git a/public/docs/js/latest/api/http/_data.json b/public/docs/js/latest/api/http/_data.json deleted file mode 100644 index c8494fdf3a..0000000000 --- a/public/docs/js/latest/api/http/_data.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "index" : { - "title" : "Http", - "intro" : "The http module provides services to perform http requests. To get started, see the Httpclass." - }, - - "MockConnection-class" : { - "title" : "MockConnection Class" - }, - - "MockBackend-class" : { - "title" : "MockBackend Class" - }, - - "Request-class" : { - "title" : "Request Class" - }, - - "Response-class" : { - "title" : "Response Class" - }, - - "IRequestOptions-interface" : { - "title" : "IRequestOptions Interface" - }, - - "IResponseOptions-interface" : { - "title" : "IResponseOptions Interface" - }, - - "Connection-class" : { - "title" : "Connection Class" - }, - - "ConnectionBackend-class" : { - "title" : "ConnectionBackend Class" - }, - - "BrowserXhr-class" : { - "title" : "BrowserXhr Class" - }, - - "BaseRequestOptions-class" : { - "title" : "BaseRequestOptions Class" - }, - - "RequestOptions-class" : { - "title" : "RequestOptions Class" - }, - - "BaseResponseOptions-class" : { - "title" : "BaseResponseOptions Class" - }, - - "ResponseOptions-class" : { - "title" : "ResponseOptions Class" - }, - - "XHRBackend-class" : { - "title" : "XHRBackend Class" - }, - - "XHRConnection-class" : { - "title" : "XHRConnection Class" - }, - - "JSONPBackend-class" : { - "title" : "JSONPBackend Class" - }, - - "JSONPConnection-class" : { - "title" : "JSONPConnection Class" - }, - - "Http-class" : { - "title" : "Http Class" - }, - - "Jsonp-class" : { - "title" : "Jsonp Class" - }, - - "Headers-class" : { - "title" : "Headers Class" - }, - - "ResponseTypes-enum" : { - "title" : "ResponseTypes Enum" - }, - - "ReadyStates-enum" : { - "title" : "ReadyStates Enum" - }, - - "RequestMethods-enum" : { - "title" : "RequestMethods Enum" - }, - - "RequestCredentialsOpts-enum" : { - "title" : "RequestCredentialsOpts Enum" - }, - - "RequestCacheOpts-enum" : { - "title" : "RequestCacheOpts Enum" - }, - - "RequestModesOpts-enum" : { - "title" : "RequestModesOpts Enum" - }, - - "URLSearchParams-class" : { - "title" : "URLSearchParams Class" - }, - - "httpInjectables-var" : { - "title" : "httpInjectables Var" - }, - - "jsonpInjectables-var" : { - "title" : "jsonpInjectables Var" - } -} \ No newline at end of file diff --git a/public/docs/js/latest/api/http/httpInjectables-var.jade b/public/docs/js/latest/api/http/httpInjectables-var.jade deleted file mode 100644 index a4b1093cd2..0000000000 --- a/public/docs/js/latest/api/http/httpInjectables-var.jade +++ /dev/null @@ -1,25 +0,0 @@ - -.l-main-section - h2 httpInjectables variable - p.location-badge. - exported from angular2/http - defined in angular2/http.ts (line 64) - - :markdown - Provides a basic set of injectables to use the Http service in any application. - - #Example - - ``` - import {httpInjectables, Http} from 'angular2/http'; - @Component({selector: 'http-app', viewBindings: [httpInjectables]}) - @View({template: '{{data}}'}) - class MyApp { - constructor(http:Http) { - http.request('data.txt').subscribe(res => this.data = res.text()); - } - } - ``` - - - diff --git a/public/docs/js/latest/api/http/index.jade b/public/docs/js/latest/api/http/index.jade deleted file mode 100644 index bcc3f8acea..0000000000 --- a/public/docs/js/latest/api/http/index.jade +++ /dev/null @@ -1,11 +0,0 @@ -p.location-badge. - defined in angular2/http.ts (line 1) - -ul - for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data - if slug != 'index' - - var url = "/docs/" + current.path[1] + "/" + current.path[2] + "/" + current.path[3] + "/" + current.path[4] + "/" + slug + ".html" - - li.c8 - != partial("../../../../../_includes/_hover-card", {name: page.title, url: url }) - diff --git a/public/docs/js/latest/api/http/jsonpInjectables-var.jade b/public/docs/js/latest/api/http/jsonpInjectables-var.jade deleted file mode 100644 index 247bd0b2ca..0000000000 --- a/public/docs/js/latest/api/http/jsonpInjectables-var.jade +++ /dev/null @@ -1,11 +0,0 @@ - -.l-main-section - h2 jsonpInjectables variable - p.location-badge. - exported from angular2/http - defined in angular2/http.ts (line 73) - - :markdown - - - diff --git a/public/docs/js/latest/api/pipes/AsyncPipe-class.jade b/public/docs/js/latest/api/pipes/AsyncPipe-class.jade index 04b8e2d762..d1753c1c2b 100644 --- a/public/docs/js/latest/api/pipes/AsyncPipe-class.jade +++ b/public/docs/js/latest/api/pipes/AsyncPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/async_pipe.ts (line 28) + defined in angular2/src/pipes/async_pipe.ts (line 33) :markdown Implements async bindings to Observable and Promise. @@ -28,6 +28,23 @@ p.location-badge. ``` + +.l-main-section + h2 Annotations + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'async'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section @@ -45,22 +62,6 @@ p.location-badge. - .l-sub-section - h3 supports - - - pre.prettyprint - code. - supports(obj: any) - - :markdown - - - - - - - .l-sub-section h3 onDestroy diff --git a/public/docs/js/latest/api/pipes/CurrencyPipe-class.jade b/public/docs/js/latest/api/pipes/CurrencyPipe-class.jade index 4c100fa0e4..62903355d0 100644 --- a/public/docs/js/latest/api/pipes/CurrencyPipe-class.jade +++ b/public/docs/js/latest/api/pipes/CurrencyPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/number_pipe.ts (line 102) + defined in angular2/src/pipes/number_pipe.ts (line 111) :markdown Formats a number as local currency. @@ -27,6 +27,20 @@ p.location-badge. @CONST() + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'currency'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section diff --git a/public/docs/js/latest/api/pipes/DEFAULT_PIPES-const.jade b/public/docs/js/latest/api/pipes/DEFAULT_PIPES-const.jade new file mode 100644 index 0000000000..9ada8ba6a1 --- /dev/null +++ b/public/docs/js/latest/api/pipes/DEFAULT_PIPES-const.jade @@ -0,0 +1,11 @@ + +.l-main-section + h2 DEFAULT_PIPES variable + p.location-badge. + exported from angular2/pipes + defined in angular2/src/pipes/default_pipes.ts (line 26) + + :markdown + + + diff --git a/public/docs/js/latest/api/pipes/DEFAULT_PIPES_TOKEN-const.jade b/public/docs/js/latest/api/pipes/DEFAULT_PIPES_TOKEN-const.jade new file mode 100644 index 0000000000..fc654ce8f0 --- /dev/null +++ b/public/docs/js/latest/api/pipes/DEFAULT_PIPES_TOKEN-const.jade @@ -0,0 +1,11 @@ + +.l-main-section + h2 DEFAULT_PIPES_TOKEN variable + p.location-badge. + exported from angular2/pipes + defined in angular2/src/pipes/default_pipes.ts (line 24) + + :markdown + + + diff --git a/public/docs/js/latest/api/pipes/DatePipe-class.jade b/public/docs/js/latest/api/pipes/DatePipe-class.jade index 4afb8080d6..ce5e124f1f 100644 --- a/public/docs/js/latest/api/pipes/DatePipe-class.jade +++ b/public/docs/js/latest/api/pipes/DatePipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/date_pipe.ts (line 16) + defined in angular2/src/pipes/date_pipe.ts (line 21) :markdown Formats a date value to a string based on the requested format. @@ -68,6 +68,20 @@ p.location-badge. @CONST() + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'date'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section @@ -101,19 +115,3 @@ p.location-badge. - - .l-sub-section - h3 create - - - pre.prettyprint - code. - create(cdRef: ChangeDetectorRef) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/pipes/DecimalPipe-class.jade b/public/docs/js/latest/api/pipes/DecimalPipe-class.jade index 26ada351f9..0b56b44231 100644 --- a/public/docs/js/latest/api/pipes/DecimalPipe-class.jade +++ b/public/docs/js/latest/api/pipes/DecimalPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/number_pipe.ts (line 52) + defined in angular2/src/pipes/number_pipe.ts (line 57) :markdown Formats a number as local text. i.e. group sizing and seperator and other locale-specific @@ -39,6 +39,20 @@ p.location-badge. @CONST() + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'number'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section diff --git a/public/docs/js/latest/api/pipes/JsonPipe-class.jade b/public/docs/js/latest/api/pipes/JsonPipe-class.jade index 6d7101743f..0785e487da 100644 --- a/public/docs/js/latest/api/pipes/JsonPipe-class.jade +++ b/public/docs/js/latest/api/pipes/JsonPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/json_pipe.ts (line 3) + defined in angular2/src/pipes/json_pipe.ts (line 6) :markdown Implements json transforms to any object. @@ -37,6 +37,20 @@ p.location-badge. @CONST() + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'json'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section @@ -54,19 +68,3 @@ p.location-badge. - - .l-sub-section - h3 create - - - pre.prettyprint - code. - create(cdRef: ChangeDetectorRef) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/pipes/LimitToPipe-class.jade b/public/docs/js/latest/api/pipes/LimitToPipe-class.jade index 8406700e83..995ddc6db9 100644 --- a/public/docs/js/latest/api/pipes/LimitToPipe-class.jade +++ b/public/docs/js/latest/api/pipes/LimitToPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/limit_to_pipe.ts (line 12) + defined in angular2/src/pipes/limit_to_pipe.ts (line 16) :markdown Creates a new List or String containing only a prefix/suffix of the @@ -43,6 +43,23 @@ p.location-badge. {{ 'abcdefghij' | limitTo: -100 }} // output is 'abcdefghij' + +.l-main-section + h2 Annotations + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'limitTo'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section @@ -76,19 +93,3 @@ p.location-badge. - - .l-sub-section - h3 onDestroy - - - pre.prettyprint - code. - onDestroy() - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/pipes/LowerCasePipe-class.jade b/public/docs/js/latest/api/pipes/LowerCasePipe-class.jade index de019d88dd..ece8d2dc93 100644 --- a/public/docs/js/latest/api/pipes/LowerCasePipe-class.jade +++ b/public/docs/js/latest/api/pipes/LowerCasePipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/lowercase_pipe.ts (line 3) + defined in angular2/src/pipes/lowercase_pipe.ts (line 8) :markdown Implements lowercase transforms to text. @@ -34,24 +34,22 @@ p.location-badge. @CONST() -.l-main-section - h2 Members .l-sub-section - h3 supports - - + h3.annotation Pipe pre.prettyprint code. - supports(str: any) - - :markdown - - - + @Pipe({name: 'lowercase'}) + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() +.l-main-section + h2 Members .l-sub-section h3 transform @@ -67,19 +65,3 @@ p.location-badge. - - .l-sub-section - h3 create - - - pre.prettyprint - code. - create(cdRef: ChangeDetectorRef) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/pipes/PercentPipe-class.jade b/public/docs/js/latest/api/pipes/PercentPipe-class.jade index 6af2ea8c59..10825271ed 100644 --- a/public/docs/js/latest/api/pipes/PercentPipe-class.jade +++ b/public/docs/js/latest/api/pipes/PercentPipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/number_pipe.ts (line 85) + defined in angular2/src/pipes/number_pipe.ts (line 92) :markdown Formats a number as local percent. @@ -23,6 +23,20 @@ p.location-badge. @CONST() + .l-sub-section + h3.annotation Pipe + pre.prettyprint + code. + @Pipe({name: 'percent'}) + + + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() + + .l-main-section h2 Members .l-sub-section diff --git a/public/docs/js/latest/api/pipes/UpperCasePipe-class.jade b/public/docs/js/latest/api/pipes/UpperCasePipe-class.jade index b61b64c5ef..876bec4ad3 100644 --- a/public/docs/js/latest/api/pipes/UpperCasePipe-class.jade +++ b/public/docs/js/latest/api/pipes/UpperCasePipe-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/pipes - defined in angular2/src/change_detection/pipes/uppercase_pipe.ts (line 3) + defined in angular2/src/pipes/uppercase_pipe.ts (line 7) :markdown Implements uppercase transforms to text. @@ -34,24 +34,22 @@ p.location-badge. @CONST() -.l-main-section - h2 Members .l-sub-section - h3 supports - - + h3.annotation Pipe pre.prettyprint code. - supports(str: any) - - :markdown - - - + @Pipe({name: 'uppercase'}) + .l-sub-section + h3.annotation Injectable + pre.prettyprint + code. + @Injectable() +.l-main-section + h2 Members .l-sub-section h3 transform @@ -67,19 +65,3 @@ p.location-badge. - - .l-sub-section - h3 create - - - pre.prettyprint - code. - create(cdRef: ChangeDetectorRef) - - :markdown - - - - - - diff --git a/public/docs/js/latest/api/pipes/_data.json b/public/docs/js/latest/api/pipes/_data.json index 8757f17ef9..22bcc9f99b 100644 --- a/public/docs/js/latest/api/pipes/_data.json +++ b/public/docs/js/latest/api/pipes/_data.json @@ -38,5 +38,13 @@ "LimitToPipe-class" : { "title" : "LimitToPipe Class" + }, + + "DEFAULT_PIPES_TOKEN-const" : { + "title" : "DEFAULT_PIPES_TOKEN Const" + }, + + "DEFAULT_PIPES-const" : { + "title" : "DEFAULT_PIPES Const" } } \ No newline at end of file diff --git a/public/docs/js/latest/api/pipes/index.jade b/public/docs/js/latest/api/pipes/index.jade index 1a84385743..f7fd8d82e2 100644 --- a/public/docs/js/latest/api/pipes/index.jade +++ b/public/docs/js/latest/api/pipes/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/pipes.ts (line 1) + defined in angular2/pipes.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/router/appBaseHrefToken-const.jade b/public/docs/js/latest/api/router/APP_BASE_HREF-const.jade similarity index 83% rename from public/docs/js/latest/api/router/appBaseHrefToken-const.jade rename to public/docs/js/latest/api/router/APP_BASE_HREF-const.jade index 1e93d40d5d..615723b207 100644 --- a/public/docs/js/latest/api/router/appBaseHrefToken-const.jade +++ b/public/docs/js/latest/api/router/APP_BASE_HREF-const.jade @@ -1,6 +1,6 @@ .l-main-section - h2 appBaseHrefToken variable + h2 APP_BASE_HREF variable p.location-badge. exported from angular2/router defined in angular2/src/router/location.ts (line 7) diff --git a/public/docs/js/latest/api/router/AsyncRoute-class.jade b/public/docs/js/latest/api/router/AsyncRoute-class.jade index a86843ac78..443616475d 100644 --- a/public/docs/js/latest/api/router/AsyncRoute-class.jade +++ b/public/docs/js/latest/api/router/AsyncRoute-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/route_config_impl.ts (line 35) + defined in angular2/src/router/route_config_impl.ts (line 50) :markdown diff --git a/public/docs/js/latest/api/http/BaseResponseOptions-class.jade b/public/docs/js/latest/api/router/AuxRoute-class.jade similarity index 53% rename from public/docs/js/latest/api/http/BaseResponseOptions-class.jade rename to public/docs/js/latest/api/router/AuxRoute-class.jade index f1a9d94e94..9b75b03074 100644 --- a/public/docs/js/latest/api/http/BaseResponseOptions-class.jade +++ b/public/docs/js/latest/api/router/AuxRoute-class.jade @@ -1,20 +1,19 @@ p.location-badge. - exported from angular2/http - defined in angular2/src/http/base_response_options.ts (line 44) + exported from angular2/router + defined in angular2/src/router/route_config_impl.ts (line 35) :markdown - Injectable version of ResponseOptions, with overridable default values. .l-main-section h2 Annotations .l-sub-section - h3.annotation Injectable + h3.annotation CONST pre.prettyprint code. - @Injectable() + @CONST() .l-main-section @@ -25,7 +24,7 @@ p.location-badge. pre.prettyprint code. - constructor() + constructor({path, component, as}: {path: string, component: Type, as?: string}) :markdown @@ -35,7 +34,7 @@ p.location-badge. .l-sub-section - h3 body + h3 path :markdown @@ -47,7 +46,7 @@ p.location-badge. .l-sub-section - h3 status + h3 component :markdown @@ -59,7 +58,7 @@ p.location-badge. .l-sub-section - h3 headers + h3 as :markdown @@ -71,7 +70,7 @@ p.location-badge. .l-sub-section - h3 statusText + h3 loader :markdown @@ -83,19 +82,7 @@ p.location-badge. .l-sub-section - h3 type - - - :markdown - - - - - - - - .l-sub-section - h3 url + h3 redirectTo :markdown diff --git a/public/docs/js/latest/api/router/CanActivate-var.jade b/public/docs/js/latest/api/router/CanActivate-var.jade index 3c03b65772..b0339a786e 100644 --- a/public/docs/js/latest/api/router/CanActivate-var.jade +++ b/public/docs/js/latest/api/router/CanActivate-var.jade @@ -3,9 +3,29 @@ h2 CanActivate variable p.location-badge. exported from angular2/router - defined in angular2/src/router/lifecycle_annotations.ts (line 19) + defined in angular2/src/router/lifecycle_annotations.ts (line 41) :markdown + Defines route lifecycle method [canActivate], which is called by the router to determine + if a component can be instantiated as part of a navigation. + + Note that unlike other lifecycle hooks, this one uses an annotation rather than an interface. + This is because [canActivate] is called before the component is instantiated. + + If `canActivate` returns or resolves to `false`, the navigation is cancelled. + + If `canActivate` throws or rejects, the navigation is also cancelled. + + ## Example + ``` + @Directive({ + selector: 'control-panel-cmp' + }) + @CanActivate(() => checkIfUserIsLoggedIn()) + class ControlPanelCmp { + // ... + } + ``` diff --git a/public/docs/js/latest/api/router/CanDeactivate-interface.jade b/public/docs/js/latest/api/router/CanDeactivate-interface.jade index dee07a651f..fc7a75d571 100644 --- a/public/docs/js/latest/api/router/CanDeactivate-interface.jade +++ b/public/docs/js/latest/api/router/CanDeactivate-interface.jade @@ -1,10 +1,27 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/interfaces.ts (line 36) + defined in angular2/src/router/interfaces.ts (line 115) :markdown - Defines route lifecycle method [canDeactivate] + Defines route lifecycle method [canDeactivate], which is called by the router to determine + if a component can be removed as part of a navigation. + + If `canDeactivate` returns or resolves to `false`, the navigation is cancelled. + + If `canDeactivate` throws or rejects, the navigation is also cancelled. + + ## Example + ``` + @Directive({ + selector: 'my-cmp' + }) + class MyCmp implements CanDeactivate { + canDeactivate(next, prev) { + return askUserIfTheyAreSureTheyWantToQuit(); + } + } + ``` .l-main-section @@ -15,7 +32,7 @@ p.location-badge. pre.prettyprint code. - canDeactivate(nextInstruction: Instruction, prevInstruction: Instruction) + canDeactivate(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction) :markdown diff --git a/public/docs/js/latest/api/router/CanReuse-interface.jade b/public/docs/js/latest/api/router/CanReuse-interface.jade index 61de93bd4f..f58702271b 100644 --- a/public/docs/js/latest/api/router/CanReuse-interface.jade +++ b/public/docs/js/latest/api/router/CanReuse-interface.jade @@ -1,10 +1,31 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/interfaces.ts (line 29) + defined in angular2/src/router/interfaces.ts (line 87) :markdown - Defines route lifecycle method [canReuse] + Defines route lifecycle method [canReuse], which is called by the router to determine whether a + component should be reused across routes, or whether to destroy and instantiate a new component. + + If `canReuse` returns or resolves to `true`, the component instance will be reused. + + If `canReuse` throws or rejects, the navigation will be cancelled. + + ## Example + ``` + @Directive({ + selector: 'my-cmp' + }) + class MyCmp implements CanReuse, OnReuse { + canReuse(next, prev) { + return next.params.id == prev.params.id; + } + + onReuse(next, prev) { + this.id = next.params.id; + } + } + ``` .l-main-section @@ -15,7 +36,7 @@ p.location-badge. pre.prettyprint code. - canReuse(nextInstruction: Instruction, prevInstruction: Instruction) + canReuse(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction) :markdown diff --git a/public/docs/js/latest/api/router/ComponentInstruction-class.jade b/public/docs/js/latest/api/router/ComponentInstruction-class.jade new file mode 100644 index 0000000000..19516a3e99 --- /dev/null +++ b/public/docs/js/latest/api/router/ComponentInstruction-class.jade @@ -0,0 +1,129 @@ + +p.location-badge. + exported from angular2/router + defined in angular2/src/router/instruction.ts (line 78) + +:markdown + A `ComponentInstruction` represents the route state for a single component. An `Instruction` is + composed of a tree of these `ComponentInstruction`s. + + `ComponentInstructions` is a public API. Instances of `ComponentInstruction` are passed + to route lifecycle hooks, like CanActivate. + + +.l-main-section + h2 Members + .l-sub-section + h3 constructor + + + pre.prettyprint + code. + constructor(urlPath: string, urlParams: List<string>, _recognizer: PathRecognizer, params?: StringMap<string, any>) + + :markdown + + + + + + + .l-sub-section + h3 reuse + + + :markdown + + + + + + + + .l-sub-section + h3 urlPath + + + :markdown + + + + + + + + .l-sub-section + h3 urlParams + + + :markdown + + + + + + + + .l-sub-section + h3 params + + + :markdown + + + + + + + + .l-sub-section + h3 componentType + + + :markdown + + + + + + + + .l-sub-section + h3 resolveComponentType + + + pre.prettyprint + code. + resolveComponentType() + + :markdown + + + + + + + + .l-sub-section + h3 specificity + + + :markdown + + + + + + + + .l-sub-section + h3 terminal + + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/router/Instruction-class.jade b/public/docs/js/latest/api/router/Instruction-class.jade index 613cd9ba0a..9b60b693a7 100644 --- a/public/docs/js/latest/api/router/Instruction-class.jade +++ b/public/docs/js/latest/api/router/Instruction-class.jade @@ -1,10 +1,13 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/instruction.ts (line 17) + defined in angular2/src/router/instruction.ts (line 19) :markdown - An `Instruction` represents the component hierarchy of the application based on a given route + `Instruction` is a tree of `ComponentInstructions`, with all the information needed + to transition each component in the app to a given route, including all auxiliary routes. + + This is a public API. .l-main-section @@ -15,7 +18,7 @@ p.location-badge. pre.prettyprint code. - constructor(component: any, capturedUrl: string, _recognizer: PathRecognizer, child?: Instruction, _params?: StringMap<string, any>) + constructor(component: ComponentInstruction, child: Instruction, auxInstruction: StringMap<string, Instruction>) :markdown @@ -24,42 +27,6 @@ p.location-badge. - .l-sub-section - h3 accumulatedUrl - - - :markdown - - - - - - - - .l-sub-section - h3 reuse - - - :markdown - - - - - - - - .l-sub-section - h3 specificity - - - :markdown - - - - - - - .l-sub-section h3 component @@ -72,18 +39,6 @@ p.location-badge. - .l-sub-section - h3 capturedUrl - - - :markdown - - - - - - - .l-sub-section h3 child @@ -97,13 +52,25 @@ p.location-badge. .l-sub-section - h3 params + h3 auxInstruction - pre.prettyprint - code. - params() - + :markdown + + + + + + + + .l-sub-section + h3 replaceChild + + + pre.prettyprint + code. + replaceChild(child: Instruction) + :markdown diff --git a/public/docs/js/latest/api/router/OnActivate-interface.jade b/public/docs/js/latest/api/router/OnActivate-interface.jade index 83ffc60154..e079796488 100644 --- a/public/docs/js/latest/api/router/OnActivate-interface.jade +++ b/public/docs/js/latest/api/router/OnActivate-interface.jade @@ -1,10 +1,29 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/interfaces.ts (line 7) + defined in angular2/src/router/interfaces.ts (line 7) :markdown - Defines route lifecycle method [onActivate] + Defines route lifecycle method [onActivate], which is called by the router at the end of a + successful route navigation. + + For a single component's navigation, only one of either [onActivate] or [onReuse] will be called, + depending on the result of [canReuse]. + + If `onActivate` returns a promise, the route change will wait until the promise settles to + instantiate and activate child components. + + ## Example + ``` + @Directive({ + selector: 'my-cmp' + }) + class MyCmp implements OnActivate { + onActivate(next, prev) { + this.log = 'Finished navigating from ' + prev.urlPath + ' to ' + next.urlPath; + } + } + ``` .l-main-section @@ -15,7 +34,7 @@ p.location-badge. pre.prettyprint code. - onActivate(nextInstruction: Instruction, prevInstruction: Instruction) + onActivate(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction) :markdown diff --git a/public/docs/js/latest/api/router/OnDeactivate-interface.jade b/public/docs/js/latest/api/router/OnDeactivate-interface.jade index 9fd350a311..478f21ce91 100644 --- a/public/docs/js/latest/api/router/OnDeactivate-interface.jade +++ b/public/docs/js/latest/api/router/OnDeactivate-interface.jade @@ -1,10 +1,29 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/interfaces.ts (line 22) + defined in angular2/src/router/interfaces.ts (line 61) :markdown - Defines route lifecycle method [onDeactivate] + Defines route lifecycle method [onDeactivate], which is called by the router before destroying + a component as part of a route change. + + If `onDeactivate` returns a promise, the route change will wait until the promise settles. + + ## Example + ``` + @Directive({ + selector: 'my-cmp' + }) + class MyCmp implements CanReuse, OnReuse { + canReuse() { + return true; + } + + onReuse(next, prev) { + this.params = next.params; + } + } + ``` .l-main-section @@ -15,7 +34,7 @@ p.location-badge. pre.prettyprint code. - onDeactivate(nextInstruction: Instruction, prevInstruction: Instruction) + onDeactivate(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction) :markdown diff --git a/public/docs/js/latest/api/router/OnReuse-interface.jade b/public/docs/js/latest/api/router/OnReuse-interface.jade index 16dc9d2c55..66dca93428 100644 --- a/public/docs/js/latest/api/router/OnReuse-interface.jade +++ b/public/docs/js/latest/api/router/OnReuse-interface.jade @@ -1,10 +1,30 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/interfaces.ts (line 15) + defined in angular2/src/router/interfaces.ts (line 34) :markdown - Defines route lifecycle method [onReuse] + Defines route lifecycle method [onReuse], which is called by the router at the end of a + successful route navigation when [canReuse] is implemented and returns or resolves to true. + + For a single component's navigation, only one of either [onActivate] or [onReuse] will be called, + depending on the result of [canReuse]. + + ## Example + ``` + @Directive({ + selector: 'my-cmp' + }) + class MyCmp implements CanReuse, OnReuse { + canReuse() { + return true; + } + + onReuse(next, prev) { + this.params = next.params; + } + } + ``` .l-main-section @@ -15,7 +35,7 @@ p.location-badge. pre.prettyprint code. - onReuse(nextInstruction: Instruction, prevInstruction: Instruction) + onReuse(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction) :markdown diff --git a/public/docs/js/latest/api/http/BrowserXhr-class.jade b/public/docs/js/latest/api/router/OpaqueToken-class.jade similarity index 59% rename from public/docs/js/latest/api/http/BrowserXhr-class.jade rename to public/docs/js/latest/api/router/OpaqueToken-class.jade index 070ba898ea..51bcce3dfc 100644 --- a/public/docs/js/latest/api/http/BrowserXhr-class.jade +++ b/public/docs/js/latest/api/router/OpaqueToken-class.jade @@ -1,7 +1,7 @@ p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/browser_xhr.ts (line 1) + exported from angular2/router + defined in angular2/src/di/opaque_token.ts (line 1) :markdown @@ -10,10 +10,10 @@ p.location-badge. .l-main-section h2 Annotations .l-sub-section - h3.annotation Injectable + h3.annotation CONST pre.prettyprint code. - @Injectable() + @CONST() .l-main-section @@ -24,7 +24,7 @@ p.location-badge. pre.prettyprint code. - constructor() + constructor(desc: string) :markdown @@ -34,12 +34,12 @@ p.location-badge. .l-sub-section - h3 build + h3 toString pre.prettyprint code. - build() + toString() :markdown diff --git a/public/docs/js/latest/api/router/Redirect-class.jade b/public/docs/js/latest/api/router/Redirect-class.jade index 7098909899..de8bab57e7 100644 --- a/public/docs/js/latest/api/router/Redirect-class.jade +++ b/public/docs/js/latest/api/router/Redirect-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/route_config_impl.ts (line 47) + defined in angular2/src/router/route_config_impl.ts (line 62) :markdown @@ -68,3 +68,15 @@ p.location-badge. + + .l-sub-section + h3 loader + + + :markdown + + + + + + diff --git a/public/docs/js/latest/api/router/RootRouter-class.jade b/public/docs/js/latest/api/router/RootRouter-class.jade index 09e4d3ed19..bc0b802cf3 100644 --- a/public/docs/js/latest/api/router/RootRouter-class.jade +++ b/public/docs/js/latest/api/router/RootRouter-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/router.ts (line 284) + defined in angular2/src/router/router.ts (line 320) :markdown diff --git a/public/docs/js/latest/api/router/RouteParams-class.jade b/public/docs/js/latest/api/router/RouteParams-class.jade index 29f53de01b..3f98fbd14b 100644 --- a/public/docs/js/latest/api/router/RouteParams-class.jade +++ b/public/docs/js/latest/api/router/RouteParams-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/instruction.ts (line 11) + defined in angular2/src/router/instruction.ts (line 13) :markdown diff --git a/public/docs/js/latest/api/router/RouteRegistry-class.jade b/public/docs/js/latest/api/router/RouteRegistry-class.jade index 221140d553..566fe7aec1 100644 --- a/public/docs/js/latest/api/router/RouteRegistry-class.jade +++ b/public/docs/js/latest/api/router/RouteRegistry-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/route_registry.ts (line 26) + defined in angular2/src/router/route_registry.ts (line 38) :markdown The RouteRegistry holds route configurations for each component in an Angular app. @@ -27,7 +27,7 @@ p.location-badge. pre.prettyprint code. - config(parentComponent: any, config: RouteDefinition, isRootLevelRoute?: boolean) + config(parentComponent: any, config: RouteDefinition) :markdown Given a component and a configuration object, add the route to this registry @@ -44,7 +44,7 @@ p.location-badge. pre.prettyprint code. - configFromComponent(component: any, isRootComponent?: boolean) + configFromComponent(component: any) :markdown Reads the annotations of a component and configures the registry based on them diff --git a/public/docs/js/latest/api/router/Router-class.jade b/public/docs/js/latest/api/router/Router-class.jade index bb616e18cb..f7de5c7b02 100644 --- a/public/docs/js/latest/api/router/Router-class.jade +++ b/public/docs/js/latest/api/router/Router-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/router.ts (line 22) + defined in angular2/src/router/router.ts (line 22) :markdown # Router @@ -180,6 +180,24 @@ p.location-badge. + .l-sub-section + h3 navigateInstruction + + + pre.prettyprint + code. + navigateInstruction(instruction: Instruction, _skipLocationChange?: boolean) + + :markdown + Navigate via the provided instruction. Returns a promise that resolves when navigation is + complete. + + + + + + + .l-sub-section h3 commit diff --git a/public/docs/js/latest/api/router/RouterLink-class.jade b/public/docs/js/latest/api/router/RouterLink-class.jade index f626da9a3f..6339c5c89e 100644 --- a/public/docs/js/latest/api/router/RouterLink-class.jade +++ b/public/docs/js/latest/api/router/RouterLink-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/router_link.ts (line 5) + defined in angular2/src/router/router_link.ts (line 6) :markdown The RouterLink directive lets you link to specific parts of your app. diff --git a/public/docs/js/latest/api/router/RouterOutlet-class.jade b/public/docs/js/latest/api/router/RouterOutlet-class.jade index 2e307bba6a..e859635d6a 100644 --- a/public/docs/js/latest/api/router/RouterOutlet-class.jade +++ b/public/docs/js/latest/api/router/RouterOutlet-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/router - defined in angular2/src/router/router_outlet.ts (line 12) + defined in angular2/src/router/router_outlet.ts (line 12) :markdown A router outlet is a placeholder that Angular dynamically fills based on the application's route. @@ -52,6 +52,18 @@ p.location-badge. + .l-sub-section + h3 name + + + :markdown + + + + + + + .l-sub-section h3 commit diff --git a/public/docs/js/latest/api/router/Type-interface.jade b/public/docs/js/latest/api/router/Type-interface.jade new file mode 100644 index 0000000000..8bacdb156b --- /dev/null +++ b/public/docs/js/latest/api/router/Type-interface.jade @@ -0,0 +1,11 @@ + +p.location-badge. + exported from angular2/router + defined in angular2/src/facade/lang.ts (line 5) + +:markdown + Runtime representation of a type. + + In JavaScript a Type is a constructor function. + + diff --git a/public/docs/js/latest/api/http/JSONPConnection-class.jade b/public/docs/js/latest/api/router/Url-class.jade similarity index 60% rename from public/docs/js/latest/api/http/JSONPConnection-class.jade rename to public/docs/js/latest/api/router/Url-class.jade index df330c83c7..6f27ae5d15 100644 --- a/public/docs/js/latest/api/http/JSONPConnection-class.jade +++ b/public/docs/js/latest/api/router/Url-class.jade @@ -1,7 +1,7 @@ p.location-badge. - exported from angular2/http - defined in angular2/src/http/backends/jsonp_backend.ts (line 9) + exported from angular2/router + defined in angular2/src/router/url_parser.ts (line 8) :markdown @@ -14,7 +14,7 @@ p.location-badge. pre.prettyprint code. - constructor(req: Request, _dom: BrowserJsonp, baseResponseOptions?: ResponseOptions) + constructor(path: string, child?: Url, auxiliary?: List<Url>, params?: StringMap<string, any>) :markdown @@ -24,7 +24,7 @@ p.location-badge. .l-sub-section - h3 readyState + h3 path :markdown @@ -36,7 +36,7 @@ p.location-badge. .l-sub-section - h3 request + h3 child :markdown @@ -48,7 +48,7 @@ p.location-badge. .l-sub-section - h3 response + h3 auxiliary :markdown @@ -60,7 +60,7 @@ p.location-badge. .l-sub-section - h3 baseResponseOptions + h3 params :markdown @@ -72,12 +72,12 @@ p.location-badge. .l-sub-section - h3 finished + h3 toString pre.prettyprint code. - finished(data?: any) + toString() :markdown @@ -88,12 +88,12 @@ p.location-badge. .l-sub-section - h3 dispose + h3 segmentToString pre.prettyprint code. - dispose() + segmentToString() :markdown diff --git a/public/docs/js/latest/api/router/_data.json b/public/docs/js/latest/api/router/_data.json index 1c633a7ebb..fc15e65460 100644 --- a/public/docs/js/latest/api/router/_data.json +++ b/public/docs/js/latest/api/router/_data.json @@ -44,8 +44,8 @@ "title" : "Location Class" }, - "appBaseHrefToken-const" : { - "title" : "appBaseHrefToken Const" + "APP_BASE_HREF-const" : { + "title" : "APP_BASE_HREF Const" }, "Pipeline-class" : { @@ -80,6 +80,22 @@ "title" : "Instruction Class" }, + "ComponentInstruction-class" : { + "title" : "ComponentInstruction Class" + }, + + "Url-class" : { + "title" : "Url Class" + }, + + "OpaqueToken-class" : { + "title" : "OpaqueToken Class" + }, + + "Type-interface" : { + "title" : "Type Interface" + }, + "routerDirectives-const" : { "title" : "routerDirectives Const" }, @@ -96,6 +112,10 @@ "title" : "Redirect Class" }, + "AuxRoute-class" : { + "title" : "AuxRoute Class" + }, + "AsyncRoute-class" : { "title" : "AsyncRoute Class" }, diff --git a/public/docs/js/latest/api/router/index.jade b/public/docs/js/latest/api/router/index.jade index 9770e381b4..0ad6357100 100644 --- a/public/docs/js/latest/api/router/index.jade +++ b/public/docs/js/latest/api/router/index.jade @@ -1,5 +1,5 @@ p.location-badge. - defined in angular2/router.ts (line 1) + defined in angular2/router.ts (line 1) ul for page, slug in public.docs[current.path[1]][current.path[2]][current.path[3]][current.path[4]]._data diff --git a/public/docs/js/latest/api/router/routerDirectives-const.jade b/public/docs/js/latest/api/router/routerDirectives-const.jade index 7e3b790fce..30e04daf59 100644 --- a/public/docs/js/latest/api/router/routerDirectives-const.jade +++ b/public/docs/js/latest/api/router/routerDirectives-const.jade @@ -3,7 +3,7 @@ h2 routerDirectives variable p.location-badge. exported from angular2/router - defined in angular2/router.ts (line 37) + defined in angular2/router.ts (line 39) :markdown diff --git a/public/docs/js/latest/api/router/routerInjectables-var.jade b/public/docs/js/latest/api/router/routerInjectables-var.jade index 975bfbea31..858c0449c5 100644 --- a/public/docs/js/latest/api/router/routerInjectables-var.jade +++ b/public/docs/js/latest/api/router/routerInjectables-var.jade @@ -3,7 +3,7 @@ h2 routerInjectables variable p.location-badge. exported from angular2/router - defined in angular2/router.ts (line 39) + defined in angular2/router.ts (line 41) :markdown diff --git a/public/docs/js/latest/api/test/AsyncTestCompleter-class.jade b/public/docs/js/latest/api/test/AsyncTestCompleter-class.jade index 41b63a460c..9d75b0c747 100644 --- a/public/docs/js/latest/api/test/AsyncTestCompleter-class.jade +++ b/public/docs/js/latest/api/test/AsyncTestCompleter-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 36) + defined in angular2/src/test_lib/test_lib.ts (line 34) :markdown diff --git a/public/docs/js/latest/api/test/FunctionWithParamTokens-class.jade b/public/docs/js/latest/api/test/FunctionWithParamTokens-class.jade index 3c6e5cf403..fc30d37cfb 100644 --- a/public/docs/js/latest/api/test/FunctionWithParamTokens-class.jade +++ b/public/docs/js/latest/api/test/FunctionWithParamTokens-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_injector.ts (line 194) + defined in angular2/src/test_lib/test_injector.ts (line 195) :markdown diff --git a/public/docs/js/latest/api/test/GuinessCompatibleSpy-interface.jade b/public/docs/js/latest/api/test/GuinessCompatibleSpy-interface.jade index f39a84c298..2878c1277d 100644 --- a/public/docs/js/latest/api/test/GuinessCompatibleSpy-interface.jade +++ b/public/docs/js/latest/api/test/GuinessCompatibleSpy-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 301) + defined in angular2/src/test_lib/test_lib.ts (line 314) :markdown diff --git a/public/docs/js/latest/api/test/IS_DARTIUM-var.jade b/public/docs/js/latest/api/test/IS_DARTIUM-var.jade deleted file mode 100644 index 5086f7c8f1..0000000000 --- a/public/docs/js/latest/api/test/IS_DARTIUM-var.jade +++ /dev/null @@ -1,11 +0,0 @@ - -.l-main-section - h2 IS_DARTIUM variable - p.location-badge. - exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 36) - - :markdown - - - diff --git a/public/docs/js/latest/api/test/NgMatchers-interface.jade b/public/docs/js/latest/api/test/NgMatchers-interface.jade index ecaaa58719..7ed5515609 100644 --- a/public/docs/js/latest/api/test/NgMatchers-interface.jade +++ b/public/docs/js/latest/api/test/NgMatchers-interface.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 19) + defined in angular2/src/test_lib/test_lib.ts (line 19) :markdown @@ -88,6 +88,22 @@ p.location-badge. + .l-sub-section + h3 toHaveCssClass + + + pre.prettyprint + code. + toHaveCssClass(expected: any) + + :markdown + + + + + + + .l-sub-section h3 toImplement diff --git a/public/docs/js/latest/api/test/SpyObject-class.jade b/public/docs/js/latest/api/test/SpyObject-class.jade index fbee2d413e..94e8d31bab 100644 --- a/public/docs/js/latest/api/test/SpyObject-class.jade +++ b/public/docs/js/latest/api/test/SpyObject-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 312) + defined in angular2/src/test_lib/test_lib.ts (line 325) :markdown diff --git a/public/docs/js/latest/api/test/TestComponentBuilder-class.jade b/public/docs/js/latest/api/test/TestComponentBuilder-class.jade index c957e21f35..33cbfb2a55 100644 --- a/public/docs/js/latest/api/test/TestComponentBuilder-class.jade +++ b/public/docs/js/latest/api/test/TestComponentBuilder-class.jade @@ -1,7 +1,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_component_builder.ts (line 43) + defined in angular2/src/test_lib/test_component_builder.ts (line 43) :markdown Builds a RootTestComponent for use in component level tests. diff --git a/public/docs/js/latest/api/test/_data.json b/public/docs/js/latest/api/test/_data.json index b3a6bfa88e..2b68c5c7d5 100644 --- a/public/docs/js/latest/api/test/_data.json +++ b/public/docs/js/latest/api/test/_data.json @@ -24,10 +24,6 @@ "title" : "expect Var" }, - "IS_DARTIUM-var" : { - "title" : "IS_DARTIUM Var" - }, - "AsyncTestCompleter-class" : { "title" : "AsyncTestCompleter Class" }, diff --git a/public/docs/js/latest/api/test/beforeEach-function.jade b/public/docs/js/latest/api/test/beforeEach-function.jade index 21e667f6b9..1c06702ce8 100644 --- a/public/docs/js/latest/api/test/beforeEach-function.jade +++ b/public/docs/js/latest/api/test/beforeEach-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 97) + defined in angular2/src/test_lib/test_lib.ts (line 95) :markdown diff --git a/public/docs/js/latest/api/test/beforeEachBindings-function.jade b/public/docs/js/latest/api/test/beforeEachBindings-function.jade index f697bdb105..9ccfced4bc 100644 --- a/public/docs/js/latest/api/test/beforeEachBindings-function.jade +++ b/public/docs/js/latest/api/test/beforeEachBindings-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 111) + defined in angular2/src/test_lib/test_lib.ts (line 109) :markdown Allows overriding default bindings defined in test_injector.js. diff --git a/public/docs/js/latest/api/test/createTestInjector-function.jade b/public/docs/js/latest/api/test/createTestInjector-function.jade index 9db0deab78..6d53ed0752 100644 --- a/public/docs/js/latest/api/test/createTestInjector-function.jade +++ b/public/docs/js/latest/api/test/createTestInjector-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_injector.ts (line 156) + defined in angular2/src/test_lib/test_injector.ts (line 157) :markdown diff --git a/public/docs/js/latest/api/test/ddescribe-function.jade b/public/docs/js/latest/api/test/ddescribe-function.jade index 928135c056..85c7253943 100644 --- a/public/docs/js/latest/api/test/ddescribe-function.jade +++ b/public/docs/js/latest/api/test/ddescribe-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 89) + defined in angular2/src/test_lib/test_lib.ts (line 87) :markdown diff --git a/public/docs/js/latest/api/test/describe-function.jade b/public/docs/js/latest/api/test/describe-function.jade index da3f9a88fb..19793c5f30 100644 --- a/public/docs/js/latest/api/test/describe-function.jade +++ b/public/docs/js/latest/api/test/describe-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 85) + defined in angular2/src/test_lib/test_lib.ts (line 83) :markdown diff --git a/public/docs/js/latest/api/test/expect-var.jade b/public/docs/js/latest/api/test/expect-var.jade index 3635b6af8d..a0ea9ff51a 100644 --- a/public/docs/js/latest/api/test/expect-var.jade +++ b/public/docs/js/latest/api/test/expect-var.jade @@ -3,7 +3,7 @@ h2 expect variable p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 33) + defined in angular2/src/test_lib/test_lib.ts (line 34) :markdown diff --git a/public/docs/js/latest/api/test/iit-function.jade b/public/docs/js/latest/api/test/iit-function.jade index b65cfcca07..27577f3f52 100644 --- a/public/docs/js/latest/api/test/iit-function.jade +++ b/public/docs/js/latest/api/test/iit-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 169) + defined in angular2/src/test_lib/test_lib.ts (line 167) :markdown diff --git a/public/docs/js/latest/api/test/inject-function.jade b/public/docs/js/latest/api/test/inject-function.jade index 02a059ff98..872159f967 100644 --- a/public/docs/js/latest/api/test/inject-function.jade +++ b/public/docs/js/latest/api/test/inject-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_injector.ts (line 161) + defined in angular2/src/test_lib/test_injector.ts (line 162) :markdown Allows injecting dependencies in `beforeEach()` and `it()`. diff --git a/public/docs/js/latest/api/test/isInInnerZone-function.jade b/public/docs/js/latest/api/test/isInInnerZone-function.jade index 388895971e..6431dde83f 100644 --- a/public/docs/js/latest/api/test/isInInnerZone-function.jade +++ b/public/docs/js/latest/api/test/isInInnerZone-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 395) + defined in angular2/src/test_lib/test_lib.ts (line 408) :markdown diff --git a/public/docs/js/latest/api/test/it-function.jade b/public/docs/js/latest/api/test/it-function.jade index f803b05581..56f07df411 100644 --- a/public/docs/js/latest/api/test/it-function.jade +++ b/public/docs/js/latest/api/test/it-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 161) + defined in angular2/src/test_lib/test_lib.ts (line 159) :markdown diff --git a/public/docs/js/latest/api/test/xdescribe-function.jade b/public/docs/js/latest/api/test/xdescribe-function.jade index f7551866d9..a19d2bcf2f 100644 --- a/public/docs/js/latest/api/test/xdescribe-function.jade +++ b/public/docs/js/latest/api/test/xdescribe-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 93) + defined in angular2/src/test_lib/test_lib.ts (line 91) :markdown diff --git a/public/docs/js/latest/api/test/xit-function.jade b/public/docs/js/latest/api/test/xit-function.jade index 8497cf3922..51c3cf093f 100644 --- a/public/docs/js/latest/api/test/xit-function.jade +++ b/public/docs/js/latest/api/test/xit-function.jade @@ -10,7 +10,7 @@ p.location-badge. exported from angular2/test - defined in angular2/src/test_lib/test_lib.ts (line 165) + defined in angular2/src/test_lib/test_lib.ts (line 163) :markdown