...
- * ...
- * ```
- *
- * Whenever the `someExpression` expression changes, the `properties` declaration instructs
- * Angular to update the `Tooltip`'s `text` property.
- *
- * ### Bindings With Pipes
- *
- * You can use pipes in bindings, as follows:
- *
- * ```html
- *
- * ```
- */
- properties: string[];
-
-
- /**
- * Enumerates the set of emitted events.
- *
- * ## Syntax
- *
- * ```
- * @Component({
- * events: ['statusChange']
- * })
- * class TaskComponent {
- * statusChange: EventEmitter;
- *
- * constructor() {
- * this.statusChange = new EventEmitter();
- * }
- *
- * onComplete() {
- * this.statusChange.next('completed');
- * }
- * }
- * ```
- *
- * Use `propertyName: eventName` when the event emitter property name is different from the name
- * of the emitted event:
- *
- * ```
- * @Component({
- * events: ['status: statusChange']
- * })
- * class TaskComponent {
- * status: EventEmitter;
- *
- * constructor() {
- * this.status = new EventEmitter();
- * }
- *
- * onComplete() {
- * this.status.next('completed');
- * }
- * }
- * ```
- */
- events: string[];
-
-
- /**
- * Specifiy the events, actions, properties and attributes related to the host element.
- *
- * ## Events
- *
- * Specifies which DOM hostListeners a directive listens to via a set of `(event)` to `method`
- * key-value pairs:
- *
- * - `event1`: the DOM event that the directive listens to.
- * - `statement`: the statement to execute when the event occurs.
- * If the evalutation of the statement returns `false`, then `preventDefault`is applied on the DOM
- * event.
- *
- * To listen to global events, a target must be added to the event name.
- * The target can be `window`, `document` or `body`.
- *
- * When writing a directive event binding, you can also refer to the following local variables:
- * - `$event`: Current event object which triggered the event.
- * - `$target`: The source of the event. This will be either a DOM element or an Angular
- * directive. (will be implemented in later release)
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * host: {
- * '(event1)': 'onMethod1(arguments)',
- * '(target:event2)': 'onMethod2(arguments)',
- * ...
- * }
- * }
- * ```
- *
- * ## Basic Event Binding:
- *
- * Suppose you want to write a directive that reacts to `change` events in the DOM and on
- * `resize` events in window.
- * You would define the event binding as follows:
- *
- * ```
- * @Directive({
- * selector: 'input',
- * host: {
- * '(change)': 'onChange($event)',
- * '(window:resize)': 'onResize($event)'
- * }
- * })
- * class InputDirective {
- * onChange(event:Event) {
- * // invoked when the input element fires the 'change' event
- * }
- * onResize(event:Event) {
- * // invoked when the window fires the 'resize' event
- * }
- * }
- * ```
- *
- * ## Properties
- *
- * Specifies which DOM properties a directives updates.
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * selector: 'input',
- * host: {
- * '[prop]': 'expression'
- * }
- * })
- * class InputDirective {
- * value:string;
- * }
- * ```
- *
- * In this example the prop property of the host element is updated with the expression value
- * every time it changes.
- *
- * ## Attributes
- *
- * Specifies static attributes that should be propagated to a host element. Attributes specified
- * in `hostAttributes` are propagated only if a given attribute is not present on a host element.
- *
- * ## Syntax
- *
- * ```
- * @Directive({
- * selector: '[my-button]',
- * host: {
- * 'role': 'button'
- * }
- * })
- * class MyButton {
- * }
- * ```
- *
- * In this example using `my-button` directive (ex.: `
`) on a host element
- * (here: `
` ) will ensure that this element will get the "button" role.
- */
- host: StringMap
;
-
-
- /**
- * Specifies which lifecycle should be notified to the directive.
- *
- * See {@link LifecycleEvent} for details.
- */
- lifecycle: LifecycleEvent[];
-
-
- /**
- * If set to false the compiler does not compile the children of this directive.
- */
- compileChildren: boolean;
-
-
- /**
- * Defines the set of injectable objects that are visible to a Directive and its light dom
- * children.
- *
- * ## Simple Example
- *
- * Here is an example of a class that can be injected:
- *
- * ```
- * class Greeter {
- * greet(name:string) {
- * return 'Hello ' + name + '!';
- * }
- * }
- *
- * @Directive({
- * selector: 'greet',
- * bindings: [
- * Greeter
- * ]
- * })
- * class HelloWorld {
- * greeter:Greeter;
- *
- * constructor(greeter:Greeter) {
- * this.greeter = greeter;
- * }
- * }
- * ```
- */
- bindings: any[];
-
-
- /**
- * Defines the name that can be used in the template to assign this directive to a variable.
- *
- * ## Simple Example
- *
- * ```
- * @Directive({
- * selector: 'child-dir',
- * exportAs: 'child'
- * })
- * class ChildDir {
- * }
- *
- * @Component({
- * selector: 'main',
- * })
- * @View({
- * template: ` `,
- * directives: [ChildDir]
- * })
- * class MainComponent {
- * }
- *
- * ```
- */
- exportAs: string;
- }
-
-
- /**
- * Declare reusable pipe function.
- *
- * ## Example
- *
- * ```
- * @Pipe({
- * name: 'lowercase'
- * })
- * class Lowercase {
- * transform(v, args) { return v.toLowerCase(); }
- * }
- * ```
- */
- class PipeMetadata extends InjectableMetadata {
-
- name: string;
- }
-
-
- /**
- * Lifecycle events are guaranteed to be called in the following order:
- * - `OnChanges` (if any bindings have changed),
- * - `OnInit` (after the first check only),
- * - `DoCheck`,
- * - `AfterContentChecked`
- * - `AfterContentChecked`
- * - `OnDestroy` (at the very end before destruction)
- */
- enum LifecycleEvent {
-
-
- /**
- * Notify a directive when it has been checked the first time.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked only once.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.OnInit]
- * })
- * class ClassSet {
- * onInit() {
- * }
- * }
- * ```
- */
- OnInit,
-
-
- /**
- * Notify a directive whenever a {@link ViewMetadata} that contains it is destroyed.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * ...,
- * lifecycle: [LifecycleEvent.OnDestroy]
- * })
- * class ClassSet {
- * onDestroy() {
- * // invoked to notify directive of the containing view destruction.
- * }
- * }
- * ```
- */
- OnDestroy,
-
-
- /**
- * Notify a directive when any of its bindings have changed.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked only if at least one of the directive's bindings has changed.
- *
- * ## Example:
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * properties: [
- * 'propA',
- * 'propB'
- * ],
- * lifecycle: [LifecycleEvent.OnChanges]
- * })
- * class ClassSet {
- * propA;
- * propB;
- * onChanges(changes:{[idx: string, PropertyUpdate]}) {
- * // This will get called after any of the properties have been updated.
- * if (changes['propA']) {
- * // if propA was updated
- * }
- * if (changes['propA']) {
- * // if propB was updated
- * }
- * }
- * }
- * ```
- */
- OnChanges,
-
-
- /**
- * Notify a directive when it has been checked.
- *
- * This method is called right after the directive's bindings have been checked,
- * and before any of its children's bindings have been checked.
- *
- * It is invoked every time even when none of the directive's bindings has changed.
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.DoCheck]
- * })
- * class ClassSet {
- * doCheck() {
- * }
- * }
- * ```
- */
- DoCheck,
-
-
- /**
- * Notify a directive when the bindings of all its content children have been checked the first
- * time (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterContentInit]
- * })
- * class ClassSet {
- *
- * afterContentInit() {
- * }
- *
- * }
- * ```
- */
- AfterContentInit,
-
-
- /**
- * Notify a directive when the bindings of all its content children have been checked (whether
- * they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterContentChecked]
- * })
- * class ClassSet {
- *
- * afterContentChecked() {
- * }
- *
- * }
- * ```
- */
- AfterContentChecked,
-
-
- /**
- * Notify a directive when the bindings of all its view children have been checked the first time
- * (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterViewInit]
- * })
- * class ClassSet {
- *
- * afterViewInit() {
- * }
- *
- * }
- * ```
- */
- AfterViewInit,
-
-
- /**
- * Notify a directive when the bindings of all its view children have been checked (whether they
- * have changed or not).
- *
- * ## Example
- *
- * ```
- * @Directive({
- * selector: '[class-set]',
- * lifecycle: [LifecycleEvent.AfterViewChecked]
- * })
- * class ClassSet {
- *
- * afterViewChecked() {
- * }
- *
- * }
- * ```
- */
- AfterViewChecked
- }
-
-
- /**
- * Declares the available HTML templates for an application.
- *
- * Each angular component requires a single `@Component` and at least one `@View` annotation. The
- * `@View` annotation specifies the HTML template to use, and lists the directives that are active
- * within the template.
- *
- * When a component is instantiated, the template is loaded into the component's shadow root, and
- * the expressions and statements in the template are evaluated against the component.
- *
- * For details on the `@Component` annotation, see {@link ComponentMetadata}.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!',
- * directives: [GreetUser, Bold]
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ViewMetadata {
-
-
- /**
- * Specifies a template URL for an angular component.
- *
- * NOTE: either `templateUrl` or `template` should be used, but not both.
- */
- templateUrl: string;
-
-
- /**
- * Specifies an inline template for an angular component.
- *
- * NOTE: either `templateUrl` or `template` should be used, but not both.
- */
- template: string;
-
-
- /**
- * Specifies stylesheet URLs for an angular component.
- */
- styleUrls: string[];
-
-
- /**
- * Specifies an inline stylesheet for an angular component.
- */
- styles: string[];
-
-
- /**
- * Specifies a list of directives that can be used within a template.
- *
- * Directives must be listed explicitly to provide proper component encapsulation.
- *
- * ## Example
- *
- * ```javascript
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * directives: [For]
- * template: '
- * '
- * })
- * class MyComponent {
- * }
- * ```
- */
- directives: Array;
-
- pipes: Array;
-
-
- /**
- * Specify how the template and the styles should be encapsulated.
- * The default is {@link ViewEncapsulation#Emulated `ViewEncapsulation.Emulated`} if the view
- * has styles,
- * otherwise {@link ViewEncapsulation#None `ViewEncapsulation.None`}.
- */
- encapsulation: ViewEncapsulation;
- }
-
-
- /**
- * How the template and styles of a view should be encapsulated.
- */
- enum ViewEncapsulation {
-
-
- /**
- * Emulate scoping of styles by preprocessing the style rules
- * and adding additional attributes to elements. This is the default.
- */
- Emulated,
-
-
- /**
- * Uses the native mechanism of the renderer. For the DOM this means creating a ShadowRoot.
- */
- Native,
-
-
- /**
- * Don't scope the template nor the styles.
- */
- None
- }
-
-
- /**
- * Specifies that a {@link QueryList} should be injected.
- *
- * See {@link QueryList} for usage and example.
- */
- class QueryMetadata extends DependencyMetadata {
-
- descendants: boolean;
-
- isViewQuery: any;
-
- selector: any;
-
- isVarBindingQuery: boolean;
-
- varBindings: string[];
-
- toString(): string;
- }
-
-
- /**
- * Specifies that a constant attribute value should be injected.
- *
- * The directive can inject constant string literals of host element attributes.
- *
- * ## Example
- *
- * Suppose we have an ` ` element and want to know its `type`.
- *
- * ```html
- *
- * ```
- *
- * A decorator can inject string literal `text` like so:
- *
- * ```javascript
- * @Directive({
- * selector: `input'
- * })
- * class InputDirective {
- * constructor(@Attribute('type') type) {
- * // type would be `text` in this example
- * }
- * }
- * ```
- */
- class AttributeMetadata extends DependencyMetadata {
-
- attributeName: string;
-
- token: any;
-
- toString(): string;
- }
-
-
- /**
- * {@link AttributeMetadata} factory function.
- */
- var Attribute : AttributeFactory ;
-
-
- /**
- * {@link AttributeMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Attribute, Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor(@Attribute('title') title: string) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: [new ng.Attribute('title'), function(title) {
- * ...
- * }]
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function(title) {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * MyComponent.parameters = [
- * [new ng.Attribute('title')]
- * ]
- * ```
- */
- interface AttributeFactory {
-
- new(name: string): AttributeMetadata;
-
-
- (name: string): TypeDecorator;
-
- }
-
-
- /**
- * {@link ComponentMetadata} factory function.
- */
- var Component : ComponentFactory ;
-
-
- /**
- * Interface for the {@link ComponentMetadata} decorator function.
- *
- * See {@link ComponentFactory}.
- */
- interface ComponentDecorator extends TypeDecorator {
-
-
- /**
- * Chain {@link ViewMetadata} annotation.
- */
- View(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array,
- pipes?: Array,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
-
-
- /**
- * {@link ComponentAnnotation} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function() {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * ```
- */
- interface ComponentFactory {
-
- new(obj: {
- selector?: string,
- properties?: string[],
- events?: string[],
- host?: StringMap,
- lifecycle?: LifecycleEvent[],
- bindings?: any[],
- exportAs?: string,
- compileChildren?: boolean,
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentMetadata;
-
-
- (obj: {
- selector?: string,
- properties?: string[],
- events?: string[],
- host?: StringMap,
- lifecycle?: LifecycleEvent[],
- bindings?: any[],
- exportAs?: string,
- compileChildren?: boolean,
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentDecorator;
-
- }
-
-
- /**
- * {@link DirectiveMetadata} factory function.
- */
- var Directive : DirectiveFactory ;
-
-
- /**
- * Interface for the {@link DirectiveMetadata} decorator function.
- *
- * See {@link DirectiveFactory}.
- */
- interface DirectiveDecorator extends TypeDecorator {
- }
-
-
- /**
- * {@link DirectiveMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Directive} from "angular2/angular2";
- *
- * @Directive({...})
- * class MyDirective {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyDirective = ng
- * .Directive({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyDirective = function() {
- * ...
- * };
- *
- * MyDirective.annotations = [
- * new ng.Directive({...})
- * ]
- * ```
- */
- interface DirectiveFactory {
-
- new(obj: {
- selector?: string, properties?: string[], events?: string[], host?: StringMap,
- lifecycle?: LifecycleEvent[], bindings?: any[], exportAs?: string,
- compileChildren?: boolean;
- }): DirectiveMetadata;
-
-
- (obj: {
- selector?: string, properties?: string[], events?: string[], host?: StringMap,
- lifecycle?: LifecycleEvent[], bindings?: any[], exportAs?: string,
- compileChildren?: boolean;
- }): DirectiveDecorator;
-
- }
-
-
- /**
- * {@link ViewMetadata} factory function.
- */
- var View : ViewFactory ;
-
-
- /**
- * Interface for the {@link ViewMetadata} decorator function.
- *
- * See {@link ViewFactory}.
- */
- interface ViewDecorator extends TypeDecorator {
-
-
- /**
- * Chain {@link ViewMetadata} annotation.
- */
- View(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array,
- pipes?: Array,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
- }
-
-
- /**
- * {@link ViewAnnotation} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor() {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: function() {
- * ...
- * }
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function() {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * ```
- */
- interface ViewFactory {
-
- new(obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewMetadata;
-
-
- (obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
-
- }
-
-
- /**
- * {@link QueryMetadata} factory function.
- */
- var Query : QueryFactory ;
-
-
- /**
- * {@link QueryMetadata} factory for creating annotations, decorators or DSL.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Query, QueryList, Component, View} from "angular2/angular2";
- *
- * @Component({...})
- * @View({...})
- * class MyComponent {
- * constructor(@Query(SomeType) queryList: QueryList) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example as ES5 DSL
- *
- * ```
- * var MyComponent = ng
- * .Component({...})
- * .View({...})
- * .Class({
- * constructor: [new ng.Query(SomeType), function(queryList) {
- * ...
- * }]
- * })
- * ```
- *
- * ## Example as ES5 annotation
- *
- * ```
- * var MyComponent = function(queryList) {
- * ...
- * };
- *
- * MyComponent.annotations = [
- * new ng.Component({...}),
- * new ng.View({...})
- * ]
- * MyComponent.parameters = [
- * [new ng.Query(SomeType)]
- * ]
- * ```
- */
- interface QueryFactory {
-
- new(selector: Type | string, {descendants}?: {descendants?: boolean}): QueryMetadata;
-
-
- (selector: Type | string, {descendants}?: {descendants?: boolean}): ParameterDecorator;
-
- }
-
-
- /**
- * {@link di/ViewQueryMetadata} factory function.
- */
- var ViewQuery : QueryFactory ;
-
-
- /**
- * {@link PipeMetadata} factory function.
- */
- var Pipe : PipeFactory ;
-
-
- /**
- * {@link PipeMetadata} factory for creating decorators.
- *
- * ## Example as TypeScript Decorator
- *
- * ```
- * import {Pipe} from "angular2/angular2";
- *
- * @Pipe({...})
- * class MyPipe {
- * constructor() {
- * ...
- * }
- *
- * transform(v, args) {}
- * }
- * ```
- */
- interface PipeFactory {
-
- new(obj: {
- name: string,
- }): any;
-
-
- (obj: {name: string}): any;
-
- }
-
-
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterContentInit `LifeCycleEvent.afterContentInit`}
- * called when the bindings of all its content children have been checked the first time.
- */
- interface AfterContentInit {
-
- afterContentInit(): void;
- }
-
-
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterContentChecked `LifeCycleEvent.afterContentChecked`}
- * called when the bindings of all its content children have been checked.
- */
- interface AfterContentChecked {
-
- afterContentChecked(): void;
- }
-
-
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterViewInit `LifeCycleEvent.afterViewInit`}
- * called when the bindings of all its view children have been checked the first time.
- */
- interface AfterViewInit {
-
- afterViewInit(): void;
- }
-
-
- /**
- * Defines lifecycle method
- * {@link metadata/LifeCycleEvent#AfterViewChecked `LifeCycleEvent.afterViewChecked`}
- * called when the bindings of all its view children have been checked.
- */
- interface AfterViewChecked {
-
- afterViewChecked(): void;
- }
-
-
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnChanges `LifeCycleEvent.OnChanges`}
- * called after all of component's bound properties are updated.
- */
- interface OnChanges {
-
- onChanges(changes: StringMap): void;
- }
-
-
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnDestroy `LifeCycleEvent.OnDestroy`}
- * called when a directive is being destroyed.
- */
- interface OnDestroy {
-
- onDestroy(): void;
- }
-
-
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#OnInit `LifeCycleEvent.OnInit`}
- * called when a directive is being checked the first time.
- */
- interface OnInit {
-
- onInit(): void;
- }
-
-
- /**
- * Defines lifecycle method {@link metadata/LifeCycleEvent#DoCheck `LifeCycleEvent.DoCheck`}
- * called when a directive is being checked.
- */
- interface DoCheck {
-
- doCheck(): boolean;
- }
-
-
- /**
- * Provides a way for expressing ES6 classes with parameter annotations in ES5.
- *
- * ## Basic Example
- *
- * ```
- * var Greeter = ng.Class({
- * constructor: function(name) {
- * this.name = name;
- * },
- *
- * greet: function() {
- * alert('Hello ' + this.name + '!');
- * }
- * });
- * ```
- *
- * is equivalent to ES6:
- *
- * ```
- * class Greeter {
- * constructor(name) {
- * this.name = name;
- * }
- *
- * greet() {
- * alert('Hello ' + this.name + '!');
- * }
- * }
- * ```
- *
- * or equivalent to ES5:
- *
- * ```
- * var Greeter = function (name) {
- * this.name = name;
- * }
- *
- * Greeter.prototype.greet = function () {
- * alert('Hello ' + this.name + '!');
- * }
- * ```
- *
- * ## Example with parameter annotations
- *
- * ```
- * var MyService = neg.Class({
- * constructor: [String, [new Query(), QueryList], function(name, queryList) {
- * ...
- * }];
- * });
- * ```
- *
- * is equivalent to ES6:
- *
- * ```
- * class MyService {
- * constructor(name: string, @Query() queryList: QueryList) {
- * ...
- * }
- * }
- * ```
- *
- * ## Example with inheritance
- *
- * ```
- * var Shape = ng.Class({
- * constructor: (color) {
- * this.color = color;
- * }
- * });
- *
- * var Square = ng.Class({
- * extends: Shape,
- * constructor: function(color, size) {
- * Shape.call(this, color);
- * this.size = size;
- * }
- * });
- * ```
- */
- function Class(clsDef: ClassDefinition) : Type ;
-
-
- /**
- * Declares the interface to be used with {@link Class}.
- */
- interface ClassDefinition {
-
-
- /**
- * Optional argument for specifying the superclass.
- */
- extends?: Type;
-
-
- /**
- * Required constructor function for a class.
- *
- * The function may be optionally wrapped in an `Array`, in which case additional parameter
- * annotations may be specified.
- * The number of arguments and the number of parameter annotations must match.
- *
- * See {@link Class} for example of usage.
- */
- constructor: (Function | any[]);
- }
-
-
- /**
- * An interface implemented by all Angular type decorators, which allows them to be used as ES7
- * decorators as well as
- * Angular DSL syntax.
- *
- * DSL syntax:
- *
- * ```
- * var MyClass = ng
- * .Component({...})
- * .View({...})
- * .Class({...});
- * ```
- *
- * ES7 syntax:
- *
- * ```
- * @ng.Component({...})
- * @ng.View({...})
- * class MyClass {...}
- * ```
- */
- interface TypeDecorator {
-
-
- /**
- * Invoke as ES7 decorator.
- */
- (type: T): T;
-
-
-
- /**
- * Storage for the accumulated annotations so far used by the DSL syntax.
- *
- * Used by {@link Class} to annotate the generated class.
- */
- annotations: any[];
-
-
- /**
- * Generate a class from the definition and annotate it with {@link TypeDecorator#annotations}.
- */
- Class(obj: ClassDefinition): Type;
- }
-
- enum ChangeDetectionStrategy {
-
-
- /**
- * `CheckedOnce` means that after calling detectChanges the mode of the change detector
- * will become `Checked`.
- */
- CheckOnce,
-
-
- /**
- * `Checked` means that the change detector should be skipped until its mode changes to
- * `CheckOnce`.
- */
- Checked,
-
-
- /**
- * `CheckAlways` means that after calling detectChanges the mode of the change detector
- * will remain `CheckAlways`.
- */
- CheckAlways,
-
-
- /**
- * `Detached` means that the change detector sub tree is not a part of the main tree and
- * should be skipped.
- */
- Detached,
-
-
- /**
- * `OnPush` means that the change detector's mode will be set to `CheckOnce` during hydration.
- */
- OnPush,
-
-
- /**
- * `Default` means that the change detector's mode will be set to `CheckAlways` during hydration.
- */
- Default,
-
-
- /**
- * This is an experimental feature. Works only in Dart.
- */
- OnPushObserve
- }
-
-
- /**
- * An error thrown if application changes model breaking the top-down data flow.
- *
- * Angular expects that the data flows from top (root) component to child (leaf) components.
- * This is known as directed acyclic graph. This allows Angular to only execute change detection
- * once and prevents loops in change detection data flow.
- *
- * This exception is only thrown in dev mode.
- */
- class ExpressionChangedAfterItHasBeenCheckedException extends BaseException {
- }
-
-
- /**
- * Thrown when an expression evaluation raises an exception.
- *
- * This error wraps the original exception, this is done to attach expression location information.
- */
- class ChangeDetectionError extends BaseException {
-
-
- /**
- * Location of the expression.
- */
- location: string;
- }
-
- interface ChangeDetector {
-
- parent: ChangeDetector;
-
- mode: ChangeDetectionStrategy;
-
- ref: ChangeDetectorRef;
-
- addChild(cd: ChangeDetector): void;
-
- addShadowDomChild(cd: ChangeDetector): void;
-
- removeChild(cd: ChangeDetector): void;
-
- removeShadowDomChild(cd: ChangeDetector): void;
-
- remove(): void;
-
- hydrate(context: any, locals: Locals, directives: any, pipes: any): void;
-
- dehydrate(): void;
-
- markPathToRootAsCheckOnce(): void;
-
- handleEvent(eventName: string, elIndex: number, locals: Locals): void;
-
- detectChanges(): void;
-
- checkNoChanges(): void;
- }
-
- class Locals {
-
- parent: Locals;
-
- current: Map;
-
- contains(name: string): boolean;
-
- get(name: string): any;
-
- set(name: string, value: any): void;
-
- clearValues(): void;
- }
-
-
- /**
- * Controls change detection.
- *
- * {@link ChangeDetectorRef} allows requesting checks for detectors that rely on observables. It
- * also allows detaching and attaching change detector subtrees.
- */
- interface ChangeDetectorRef {
-
-
- /**
- * Request to check all OnPush ancestors.
- */
- markForCheck(): void;
-
-
- /**
- * Detaches the change detector from the change detector tree.
- *
- * The detached change detector will not be checked until it is reattached.
- */
- detach(): void;
-
-
- /**
- * Reattach the change detector to the change detector tree.
- *
- * This also requests a check of this change detector. This reattached change detector will be
- * checked during the next change detection run.
- */
- reattach(): void;
- }
-
-
- /**
- * Indicates that the result of a {@link PipeMetadata} 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
- * }
- * ```
- */
- class WrappedValue {
-
- static wrap(value: any): WrappedValue;
-
- wrapped: any;
- }
-
-
- /**
- * An interface which all pipes must implement.
- *
- * #Example
- *
- * ```
- * class DoublePipe implements PipeTransform {
- * transform(value, args = []) {
- * return `${value}${value}`;
- * }
- * }
- * ```
- */
- interface PipeTransform {
-
- transform(value: any, args: any[]): any;
- }
-
-
- /**
- * 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;
- * }
- * }
- * ```
- */
- interface PipeOnDestroy {
-
- onDestroy(): void;
- }
-
-
- /**
- * A repository of different iterable diffing strategies used by NgFor, NgClass, and others.
- */
- class IterableDiffers {
-
- static create(factories: IterableDifferFactory[], parent?: IterableDiffers): IterableDiffers;
-
-
- /**
- * Takes an array of {@link IterableDifferFactory} and returns a binding used to extend the
- * inherited {@link IterableDiffers} instance with the provided factories and return a new
- * {@link IterableDiffers} instance.
- *
- * The following example shows how to extend an existing list of factories,
- * which will only be applied to the injector for this component and its children.
- * This step is all that's required to make a new {@link IterableDiffer} available.
- *
- * # Example
- *
- * ```
- * @Component({
- * viewBindings: [
- * IterableDiffers.extend([new ImmutableListDiffer()])
- * ]
- * })
- * ```
- */
- static extend(factories: IterableDifferFactory[]): Binding;
-
- factories: IterableDifferFactory[];
-
- find(iterable: Object): IterableDifferFactory;
- }
-
- interface IterableDiffer {
-
- diff(object: Object): any;
-
- onDestroy(): void;
- }
-
-
- /**
- * Provides a factory for {@link IterableDiffer}.
- */
- interface IterableDifferFactory {
-
- supports(objects: Object): boolean;
-
- create(cdRef: ChangeDetectorRef): IterableDiffer;
- }
-
-
- /**
- * A repository of different Map diffing strategies used by NgClass, NgStyle, and others.
- */
- class KeyValueDiffers {
-
- static create(factories: KeyValueDifferFactory[], parent?: KeyValueDiffers): KeyValueDiffers;
-
-
- /**
- * Takes an array of {@link KeyValueDifferFactory} and returns a binding used to extend the
- * inherited {@link KeyValueDiffers} instance with the provided factories and return a new
- * {@link KeyValueDiffers} instance.
- *
- * The following example shows how to extend an existing list of factories,
- * which will only be applied to the injector for this component and its children.
- * This step is all that's required to make a new {@link KeyValueDiffer} available.
- *
- * # Example
- *
- * ```
- * @Component({
- * viewBindings: [
- * KeyValueDiffers.extend([new ImmutableMapDiffer()])
- * ]
- * })
- * ```
- */
- static extend(factories: KeyValueDifferFactory[]): Binding;
-
- factories: KeyValueDifferFactory[];
-
- find(kv: Object): KeyValueDifferFactory;
- }
-
- interface KeyValueDiffer {
-
- diff(object: Object): void;
-
- onDestroy(): void;
- }
-
-
- /**
- * Provides a factory for {@link KeyValueDiffer}.
- */
- interface KeyValueDifferFactory {
-
- supports(objects: Object): boolean;
-
- create(cdRef: ChangeDetectorRef): KeyValueDiffer;
- }
-
-
- /**
- * An opaque token representing the application root type in the {@link Injector}.
- *
- * ```
- * @Component(...)
- * @View(...)
- * class MyApp {
- * ...
- * }
- *
- * bootstrap(MyApp).then((appRef:ApplicationRef) {
- * expect(appRef.injector.get(appComponentTypeToken)).toEqual(MyApp);
- * });
- *
- * ```
- */
- const APP_COMPONENT : OpaqueToken ;
-
-
- /**
- * Runtime representation of a type.
- *
- * In JavaScript a Type is a constructor function.
- */
- interface Type extends Function {
-
- new(...args: any[]): any;
-
- }
-
-
- /**
- * Represents a Angular's representation of an Application.
- *
- * `ApplicationRef` represents a running application instance. Use it to retrieve the host
- * component, injector,
- * or dispose of an application.
- */
- interface ApplicationRef {
-
-
- /**
- * Returns the current {@link ComponentMetadata} type.
- */
- hostComponentType: Type;
-
-
- /**
- * Returns the current {@link ComponentMetadata} instance.
- */
- hostComponent: any;
-
-
- /**
- * Dispose (un-load) the application.
- */
- dispose(): void;
-
-
- /**
- * Returns the root application {@link Injector}.
- */
- injector: Injector;
- }
-
-
- /**
- * Specifies app root url for the application.
- *
- * Used by the {@link Compiler} when resolving HTML and CSS template URLs.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class AppRootUrl {
-
-
- /**
- * Returns the base URL of the currently running application.
- */
- value: any;
- }
-
-
- /**
- * Used by the {@link Compiler} when resolving HTML and CSS template URLs.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class UrlResolver {
-
-
- /**
- * Resolves the `url` given the `baseUrl`:
- * - when the `url` is null, the `baseUrl` is returned,
- * - if `url` is relative ('path/to/here', './path/to/here'), the resolved url is a combination of
- * `baseUrl` and `url`,
- * - if `url` is absolute (it has a scheme: 'http://', 'https://' or start with '/'), the `url` is
- * returned as is (ignoring the `baseUrl`)
- *
- * @param {string} baseUrl
- * @param {string} url
- * @returns {string} the resolved URL
- */
- resolve(baseUrl: string, url: string): string;
- }
-
-
- /**
- * Resolve a `Type` from a {@link ComponentMetadata} into a URL.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class ComponentUrlMapper {
-
-
- /**
- * Returns the base URL to the component source file.
- * The returned URL could be:
- * - an absolute URL,
- * - a path relative to the application
- */
- getUrl(component: Type): string;
- }
-
-
- /**
- * Resolve a `Type` for {@link DirectiveMetadata}.
- *
- * This interface can be overridden by the application developer to create custom behavior.
- *
- * See {@link Compiler}
- */
- class DirectiveResolver {
-
-
- /**
- * Return {@link DirectiveMetadata} for a given `Type`.
- */
- resolve(type: Type): DirectiveMetadata;
- }
-
-
- /**
- * ## URL Resolution
- *
- * ```
- * var appRootUrl: AppRootUrl = ...;
- * var componentUrlMapper: ComponentUrlMapper = ...;
- * var urlResolver: UrlResolver = ...;
- *
- * var componentType: Type = ...;
- * var componentAnnotation: ComponentAnnotation = ...;
- * var viewAnnotation: ViewAnnotation = ...;
- *
- * // Resolving a URL
- *
- * var url = viewAnnotation.templateUrl;
- * var componentUrl = componentUrlMapper.getUrl(componentType);
- * var componentResolvedUrl = urlResolver.resolve(appRootUrl.value, componentUrl);
- * var templateResolvedUrl = urlResolver.resolve(componetResolvedUrl, url);
- * ```
- */
- interface Compiler {
-
- compileInHost(componentTypeOrBinding: Type | Binding): Promise;
- }
-
-
- /**
- * Entry point for creating, moving views in the view hierarchy and destroying views.
- * This manager contains all recursion and delegates to helper methods
- * in AppViewManagerUtils and the Renderer, so unit tests get simpler.
- */
- interface AppViewManager {
-
-
- /**
- * Returns a {@link ViewContainerRef} at the {@link ElementRef} location.
- */
- getViewContainer(location: ElementRef): ViewContainerRef;
-
-
- /**
- * Return the first child element of the host element view.
- */
- getHostElement(hostViewRef: HostViewRef): ElementRef;
-
-
- /**
- * Returns an ElementRef for the element with the given variable name
- * in the current view.
- *
- * - `hostLocation`: {@link ElementRef} of any element in the View which defines the scope of
- * search.
- * - `variableName`: Name of the variable to locate.
- * - Returns {@link ElementRef} of the found element or null. (Throws if not found.)
- */
- getNamedElementInComponentView(hostLocation: ElementRef, variableName: string): ElementRef;
-
-
- /**
- * Returns the component instance for a given element.
- *
- * The component is the execution context as seen by an expression at that {@link ElementRef}
- * location.
- */
- getComponent(hostLocation: ElementRef): any;
-
-
- /**
- * Load component view into existing element.
- *
- * Use this if a host element is already in the DOM and it is necessary to upgrade
- * the element into Angular component by attaching a view but reusing the existing element.
- *
- * - `hostProtoViewRef`: {@link ProtoViewRef} Proto view to use in creating a view for this
- * component.
- * - `overrideSelector`: (optional) selector to use in locating the existing element to load
- * the view into. If not specified use the selector in the component definition of the
- * `hostProtoView`.
- * - injector: {@link Injector} to use as parent injector for the view.
- *
- * See {@link AppViewManager#destroyRootHostView}.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- *
- * }
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent ( )
- * `
- * })
- * class MyApp {
- * viewRef: ng.ViewRef;
- *
- * constructor(public appViewManager: ng.AppViewManager, compiler: ng.Compiler) {
- * compiler.compileInHost(ChildComponent).then((protoView: ng.ProtoViewRef) => {
- * this.viewRef = appViewManager.createRootHostView(protoView, 'some-component', null);
- * })
- * }
- *
- * onDestroy() {
- * this.appViewManager.destroyRootHostView(this.viewRef);
- * this.viewRef = null;
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- */
- createRootHostView(hostProtoViewRef: ProtoViewRef, overrideSelector: string, injector: Injector): HostViewRef;
-
-
- /**
- * Remove the View created with {@link AppViewManager#createRootHostView}.
- */
- destroyRootHostView(hostViewRef: HostViewRef): void;
-
-
- /**
- * See {@link AppViewManager#destroyViewInContainer}.
- */
- createEmbeddedViewInContainer(viewContainerLocation: ElementRef, atIndex: number, templateRef: TemplateRef): ViewRef;
-
-
- /**
- * See {@link AppViewManager#destroyViewInContainer}.
- */
- createHostViewInContainer(viewContainerLocation: ElementRef, atIndex: number, protoViewRef: ProtoViewRef, imperativelyCreatedInjector: ResolvedBinding[]): HostViewRef;
-
-
- /**
- * See {@link AppViewManager#createViewInContainer}.
- */
- destroyViewInContainer(viewContainerLocation: ElementRef, atIndex: number): void;
-
-
- /**
- * See {@link AppViewManager#detachViewInContainer}.
- */
- attachViewInContainer(viewContainerLocation: ElementRef, atIndex: number, viewRef: ViewRef): ViewRef;
-
-
- /**
- * See {@link AppViewManager#attachViewInContainer}.
- */
- detachViewInContainer(viewContainerLocation: ElementRef, atIndex: number): ViewRef;
- }
-
-
- /**
- * 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.
- *
- * 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: `
- *
- *
- * `
- * })
- * class Tabs {
- * panes: QueryList
- *
- * constructor(@Query(Pane) panes:QueryList) {
- * this.panes = panes;
- * }
- * }
- *
- * @Component({
- * selector: 'pane',
- * properties: ['title']
- * })
- * @View(...)
- * class Pane {
- * title:string;
- * }
- * ```
- */
- class QueryList {
-
- reset(newList: T[]): void;
-
- add(obj: T): void;
-
- fireCallbacks(): void;
-
- onChange(callback: () => void): void;
-
- removeCallback(callback: () => void): void;
-
- toString(): string;
-
- length: number;
-
- first: T;
-
- last: T;
-
- map(fn: (item: T) => U): U[];
- }
-
-
- /**
- * Service for dynamically loading a Component into an arbitrary position in the internal Angular
- * application tree.
- */
- class DynamicComponentLoader {
-
-
- /**
- * Loads a root component that is placed at the first element that matches the component's
- * selector.
- *
- * - `typeOrBinding` `Type` \ {@link Binding} - representing the component to load.
- * - `overrideSelector` (optional) selector to load the component at (or use
- * `@Component.selector`) The selector can be anywhere (i.e. outside the current component.)
- * - `injector` {@link Injector} - optional injector to use for the component.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent ( )
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, injector: ng.Injector) {
- * dynamicComponentLoader.loadAsRoot(ChildComponent, '#child', injector);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- *
- * Parent (
- *
- * Child
- *
- * )
- *
- * ```
- */
- loadAsRoot(typeOrBinding: Type | Binding, overrideSelector: string, injector: Injector): Promise;
-
-
- /**
- * Loads a component into the component view of the provided ElementRef next to the element
- * with the given name.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (
)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- *
- * Parent (
- *
- * Child
- * )
- *
- * ```
- */
- loadIntoLocation(typeOrBinding: Type | Binding, hostLocation: ElementRef, anchorName: string, bindings?: ResolvedBinding[]): Promise;
-
-
- /**
- * Loads a component next to the provided ElementRef.
- *
- * The loaded component receives injection normally as a hosted view.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `Parent`
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * Parent
- * Child
- * ```
- */
- loadNextToLocation(typeOrBinding: Type | Binding, location: ElementRef, bindings?: ResolvedBinding[]): Promise;
- }
-
-
- /**
- * Provides access to explicitly trigger change detection in an application.
- *
- * By default, `Zone` triggers change detection in Angular on each virtual machine (VM) turn. When
- * testing, or in some
- * limited application use cases, a developer can also trigger change detection with the
- * `lifecycle.tick()` method.
- *
- * Each Angular application has a single `LifeCycle` instance.
- *
- * # Example
- *
- * This is a contrived example, since the bootstrap automatically runs inside of the `Zone`, which
- * invokes
- * `lifecycle.tick()` on your behalf.
- *
- * ```javascript
- * bootstrap(MyApp).then((ref:ComponentRef) => {
- * var lifeCycle = ref.injector.get(LifeCycle);
- * var myApp = ref.instance;
- *
- * ref.doSomething();
- * lifecycle.tick();
- * });
- * ```
- */
- class LifeCycle {
-
-
- /**
- * @private
- */
- registerWith(zone: NgZone, changeDetector?: ChangeDetector): void;
-
-
- /**
- * Invoke this method to explicitly process change detection and its side-effects.
- *
- * In development mode, `tick()` also performs a second change detection cycle to ensure that no
- * further
- * changes are detected. If additional changes are picked up during this second cycle, bindings
- * in
- * the app have
- * side-effects that cannot be resolved in a single change detection pass. In this case, Angular
- * throws an error,
- * since an Angular application can only have one change detection pass during which all change
- * detection must
- * complete.
- */
- tick(): void;
- }
-
-
- /**
- * Reference to the element.
- *
- * Represents an opaque reference to the underlying element. The element is a DOM ELement in
- * a Browser, but may represent other types on other rendering platforms. In the browser the
- * `ElementRef` can be sent to the web-worker. Web Workers can not have references to the
- * DOM Elements.
- */
- class ElementRef implements RenderElementRef {
-
-
- /**
- * Reference to the {@link ViewRef} where the `ElementRef` is inside of.
- */
- parentView: ViewRef;
-
-
- /**
- * Index of the element inside the {@link ViewRef}.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- boundElementIndex: number;
-
-
- /**
- * Index of the element inside the `RenderViewRef`.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- renderBoundElementIndex: number;
-
- renderView: RenderViewRef;
-
-
- /**
- * Returns the native Element implementation.
- *
- * In the browser this represents the DOM Element.
- *
- * The `nativeElement` can be used as an escape hatch when direct DOM manipulation is needed. Use
- * this with caution, as it creates tight coupling between your application and the Browser, which
- * will not work in WebWorkers.
- *
- * NOTE: This method will return null in the webworker scenario!
- */
- nativeElement: any;
- }
-
-
- /**
- * Reference to a template within a component.
- *
- * Represents an opaque reference to the underlying template that can
- * be instantiated using the {@link ViewContainerRef}.
- */
- class TemplateRef {
-
-
- /**
- * The location of the template
- */
- elementRef: ElementRef;
-
- protoViewRef: ProtoViewRef;
-
-
- /**
- * Whether this template has a local variable with the given name
- */
- hasLocal(name: string): boolean;
- }
-
-
- /**
- * A reference to an Angular View.
- *
- * A View is a fundamental building block of Application UI. A View is the smallest set of
- * elements which are created and destroyed together. A View can change properties on the elements
- * within the view, but it can not change the structure of those elements.
- *
- * To change structure of the elements, the Views can contain zero or more {@link ViewContainerRef}s
- * which allow the views to be nested.
- *
- * ## Example
- *
- * Given this template
- *
- * ```
- * Count: {{items.length}}
- *
- * ```
- *
- * The above example we have two {@link ProtoViewRef}s:
- *
- * Outter {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- *
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * {{item}}
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- *
- * The outter/inner {@link ProtoViewRef}s are then assembled into views like so:
- *
- * ```
- *
- * Count: 2
- *
- *
- * first
- * second
- *
- *
- * ```
- */
- interface ViewRef extends HostViewRef {
-
-
- /**
- * Return `RenderViewRef`
- */
- render: RenderViewRef;
-
-
- /**
- * Return `RenderFragmentRef`
- */
- renderFragment: RenderFragmentRef;
-
-
- /**
- * Set local variable in a view.
- *
- * - `contextName` - Name of the local variable in a view.
- * - `value` - Value for the local variable in a view.
- */
- setLocal(contextName: string, value: any): void;
- }
-
- interface HostViewRef {
- }
-
-
- /**
- * A reference to an Angular ProtoView.
- *
- * A ProtoView is a reference to a template for easy creation of views.
- * (See {@link AppViewManager#createViewInContainer `AppViewManager#createViewInContainer`} and
- * {@link AppViewManager#createRootHostView `AppViewManager#createRootHostView`}).
- *
- * A `ProtoView` is a factory for creating `View`s.
- *
- * ## Example
- *
- * Given this template
- *
- * ```
- * Count: {{items.length}}
- *
- * ```
- *
- * The above example we have two {@link ProtoViewRef}s:
- *
- * Outter {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- *
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * {{item}}
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- */
- interface ProtoViewRef {
- }
-
-
- /**
- * A location where {@link ViewRef}s can be attached.
- *
- * A `ViewContainerRef` represents a location in a {@link ViewRef} where other child
- * {@link ViewRef}s can be inserted. Adding and removing views is the only way of structurally
- * changing the rendered DOM of the application.
- */
- interface ViewContainerRef {
-
- viewManager: AppViewManager;
-
- element: ElementRef;
-
-
- /**
- * Remove all {@link ViewRef}s at current location.
- */
- clear(): void;
-
-
- /**
- * Return a {@link ViewRef} at specific index.
- */
- get(index: number): ViewRef;
-
-
- /**
- * Returns number of {@link ViewRef}s currently attached at this location.
- */
- length: number;
-
-
- /**
- * Create and insert a {@link ViewRef} into the view-container.
- *
- * - `protoViewRef` (optional) {@link ProtoViewRef} - The `ProtoView` to use for creating
- * `View` to be inserted at this location. If `ViewContainer` is created at a location
- * of inline template, then `protoViewRef` is the `ProtoView` of the template.
- * - `atIndex` (optional) `number` - location of insertion point. (Or at the end if unspecified.)
- * - `context` (optional) {@link ElementRef} - Context (for expression evaluation) from the
- * {@link ElementRef} location. (Or current context if unspecified.)
- * - `bindings` (optional) Array of {@link ResolvedBinding} - Used for configuring
- * `ElementInjector`.
- *
- * Returns newly created {@link ViewRef}.
- */
- createEmbeddedView(templateRef: TemplateRef, atIndex?: number): ViewRef;
-
- createHostView(protoViewRef?: ProtoViewRef, atIndex?: number, dynamicallyCreatedBindings?: ResolvedBinding[]): HostViewRef;
-
-
- /**
- * Insert a {@link ViewRef} at specefic index.
- *
- * The index is location at which the {@link ViewRef} should be attached. If omitted it is
- * inserted at the end.
- *
- * Returns the inserted {@link ViewRef}.
- */
- insert(viewRef: ViewRef, atIndex?: number): ViewRef;
-
-
- /**
- * Return the index of already inserted {@link ViewRef}.
- */
- indexOf(viewRef: ViewRef): number;
-
-
- /**
- * Remove a {@link ViewRef} at specific index.
- *
- * If the index is omitted last {@link ViewRef} is removed.
- */
- remove(atIndex?: number): void;
-
-
- /**
- * The method can be used together with insert to implement a view move, i.e.
- * moving the dom nodes while the directives in the view stay intact.
- */
- detach(atIndex?: number): ViewRef;
- }
-
-
- /**
- * Angular's reference to a component instance.
- *
- * `ComponentRef` represents a component instance lifecycle and meta information.
- */
- interface ComponentRef {
-
-
- /**
- * Location of the component host element.
- */
- location: ElementRef;
-
-
- /**
- * Instance of component.
- */
- instance: any;
-
-
- /**
- * Returns the host {@link ViewRef}.
- */
- hostView: HostViewRef;
-
-
- /**
- * Dispose of the component instance.
- */
- dispose(): void;
- }
-
-
- /**
- * A wrapper around zones that lets you schedule tasks after it has executed a task.
- *
- * The wrapper maintains an "inner" and an "mount" `Zone`. The application code will executes
- * in the "inner" zone unless `runOutsideAngular` is explicitely called.
- *
- * A typical application will create a singleton `NgZone`. The outer `Zone` is a fork of the root
- * `Zone`. The default `onTurnDone` runs the Angular change detection.
- */
- class NgZone {
-
-
- /**
- * Sets the zone hook that is called just before Angular event turn starts.
- * It is called once per browser event.
- */
- overrideOnTurnStart(onTurnStartFn: Function): void;
-
-
- /**
- * Sets the zone hook that is called immediately after Angular processes
- * all pending microtasks.
- */
- overrideOnTurnDone(onTurnDoneFn: Function): void;
-
-
- /**
- * Sets the zone hook that is called immediately after the last turn in
- * an event completes. At this point Angular will no longer attempt to
- * sync the UI. Any changes to the data model will not be reflected in the
- * DOM. `onEventDoneFn` is executed outside Angular zone.
- *
- * This hook is useful for validating application state (e.g. in a test).
- */
- overrideOnEventDone(onEventDoneFn: Function, opt_waitForAsync: boolean): void;
-
-
- /**
- * Sets the zone hook that is called when an error is uncaught in the
- * Angular zone. The first argument is the error. The second argument is
- * the stack trace.
- */
- overrideOnErrorHandler(errorHandlingFn: Function): void;
-
-
- /**
- * Runs `fn` in the inner zone and returns whatever it returns.
- *
- * In a typical app where the inner zone is the Angular zone, this allows one to make use of the
- * Angular's auto digest mechanism.
- *
- * ```
- * var zone: NgZone = [ref to the application zone];
- *
- * zone.run(() => {
- * // the change detection will run after this function and the microtasks it enqueues have
- * executed.
- * });
- * ```
- */
- run(fn: () => any): any;
-
-
- /**
- * Runs `fn` in the outer zone and returns whatever it returns.
- *
- * In a typical app where the inner zone is the Angular zone, this allows one to escape Angular's
- * auto-digest mechanism.
- *
- * ```
- * var zone: NgZone = [ref to the application zone];
- *
- * zone.runOutsideAngular(() => {
- * element.onClick(() => {
- * // Clicking on the element would not trigger the change detection
- * });
- * });
- * ```
- */
- runOutsideAngular(fn: () => any): any;
- }
-
- class Observable {
-
- observer(generator: any): Object;
- }
-
-
- /**
- * Use Rx.Observable but provides an adapter to make it work as specified here:
- * https://github.com/jhusain/observable-spec
- *
- * Once a reference implementation of the spec is available, switch to it.
- */
- class EventEmitter extends Observable {
-
- observer(generator: any): Rx.IDisposable;
-
- toRx(): Rx.Observable;
-
- next(value: any): void;
-
- throw(error: any): void;
-
- return(value?: any): void;
- }
-
-
- /**
- * A parameter metadata that specifies a dependency.
- *
- * ```
- * class AComponent {
- * constructor(@Inject(MyService) aService:MyService) {}
- * }
- * ```
- */
- class InjectMetadata {
-
- token: any;
-
- toString(): string;
- }
-
-
- /**
- * A parameter metadata that marks a dependency as optional. {@link Injector} provides `null` if
- * the dependency is not found.
- *
- * ```
- * class AComponent {
- * constructor(@Optional() aService:MyService) {
- * this.aService = aService;
- * }
- * }
- * ```
- */
- class OptionalMetadata {
-
- toString(): string;
- }
-
-
- /**
- * A marker metadata that marks a class as available to `Injector` for creation. Used by tooling
- * for generating constructor stubs.
- *
- * ```
- * class NeedsService {
- * constructor(svc:UsefulService) {}
- * }
- *
- * @Injectable
- * class UsefulService {}
- * ```
- */
- class InjectableMetadata {
- }
-
-
- /**
- * Specifies that an injector should retrieve a dependency from itself.
- *
- * ## Example
- *
- * ```
- * class Dependency {
- * }
- *
- * class NeedsDependency {
- * constructor(public @Self() dependency:Dependency) {}
- * }
- *
- * var inj = Injector.resolveAndCreate([Dependency, NeedsDependency]);
- * var nd = inj.get(NeedsDependency);
- * expect(nd.dependency).toBeAnInstanceOf(Dependency);
- * ```
- */
- class SelfMetadata {
-
- toString(): string;
- }
-
-
- /**
- * Specifies that an injector should retrieve a dependency from any injector until reaching the
- * closest host.
- *
- * ## Example
- *
- * ```
- * class Dependency {
- * }
- *
- * class NeedsDependency {
- * constructor(public @Host() dependency:Dependency) {}
- * }
- *
- * var parent = Injector.resolveAndCreate([
- * bind(Dependency).toClass(HostDependency)
- * ]);
- * var child = parent.resolveAndCreateChild([]);
- * var grandChild = child.resolveAndCreateChild([NeedsDependency, Depedency]);
- * var nd = grandChild.get(NeedsDependency);
- * expect(nd.dependency).toBeAnInstanceOf(HostDependency);
- * ```
- */
- class HostMetadata {
-
- toString(): string;
- }
-
-
- /**
- * Specifies that the dependency resolution should start from the parent injector.
- *
- * ## Example
- *
- *
- * ```
- * class Service {}
- *
- * class ParentService implements Service {
- * }
- *
- * class ChildService implements Service {
- * constructor(public @SkipSelf() parentService:Service) {}
- * }
- *
- * var parent = Injector.resolveAndCreate([
- * bind(Service).toClass(ParentService)
- * ]);
- * var child = parent.resolveAndCreateChild([
- * bind(Service).toClass(ChildSerice)
- * ]);
- * var s = child.get(Service);
- * expect(s).toBeAnInstanceOf(ChildService);
- * expect(s.parentService).toBeAnInstanceOf(ParentService);
- * ```
- */
- class SkipSelfMetadata {
-
- toString(): string;
- }
-
-
- /**
- * `DependencyMetadata is used by the framework to extend DI.
- *
- * Only metadata implementing `DependencyMetadata` are added to the list of dependency
- * properties.
- *
- * For example:
- *
- * ```
- * class Exclude extends DependencyMetadata {}
- * class NotDependencyProperty {}
- *
- * class AComponent {
- * constructor(@Exclude @NotDependencyProperty aService:AService) {}
- * }
- * ```
- *
- * will create the following dependency:
- *
- * ```
- * new Dependency(Key.get(AService), [new Exclude()])
- * ```
- *
- * The framework can use `new Exclude()` to handle the `aService` dependency
- * in a specific way.
- */
- class DependencyMetadata {
-
- token: any;
- }
-
-
- /**
- * Allows to refer to references which are not yet defined.
- *
- * This situation arises when the key which we need te refer to for the purposes of DI is declared,
- * but not yet defined.
- *
- * ## Example:
- *
- * ```
- * class Door {
- * // Incorrect way to refer to a reference which is defined later.
- * // This fails because `Lock` is undefined at this point.
- * constructor(lock:Lock) { }
- *
- * // Correct way to refer to a reference which is defined later.
- * // The reference needs to be captured in a closure.
- * constructor(@Inject(forwardRef(() => Lock)) lock:Lock) { }
- * }
- *
- * // Only at this point the lock is defined.
- * class Lock {
- * }
- * ```
- */
- function forwardRef(forwardRefFn: ForwardRefFn) : Type ;
-
-
- /**
- * Lazily retrieve the reference value.
- *
- * See: {@link forwardRef}
- */
- function resolveForwardRef(type: any) : any ;
-
- interface ForwardRefFn {
-
- (): any;
-
- }
-
-
- /**
- * A dependency injection container used for resolving dependencies.
- *
- * An `Injector` is a replacement for a `new` operator, which can automatically resolve the
- * constructor dependencies.
- * In typical use, application code asks for the dependencies in the constructor and they are
- * resolved by the `Injector`.
- *
- * ## Example:
- *
- * Suppose that we want to inject an `Engine` into class `Car`, we would define it like this:
- *
- * ```javascript
- * class Engine {
- * }
- *
- * class Car {
- * constructor(@Inject(Engine) engine) {
- * }
- * }
- *
- * ```
- *
- * Next we need to write the code that creates and instantiates the `Injector`. We then ask for the
- * `root` object, `Car`, so that the `Injector` can recursively build all of that object's
- * dependencies.
- *
- * ```javascript
- * main() {
- * var injector = Injector.resolveAndCreate([Car, Engine]);
- *
- * // Get a reference to the `root` object, which will recursively instantiate the tree.
- * var car = injector.get(Car);
- * }
- * ```
- * Notice that we don't use the `new` operator because we explicitly want to have the `Injector`
- * resolve all of the object's dependencies automatically.
- */
- class Injector {
-
-
- /**
- * Turns a list of binding definitions into an internal resolved list of resolved bindings.
- *
- * A resolution is a process of flattening multiple nested lists and converting individual
- * bindings into a list of {@link ResolvedBinding}s. The resolution can be cached by `resolve`
- * for the {@link Injector} for performance-sensitive code.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more bindings.
- *
- * The returned list is sparse, indexed by `id` for the {@link Key}. It is generally not useful to
- * application code
- * other than for passing it to {@link Injector} functions that require resolved binding lists,
- * such as
- * `fromResolvedBindings` and `createChildFromResolved`.
- */
- static resolve(bindings: Array): ResolvedBinding[];
-
-
- /**
- * Resolves bindings and creates an injector based on those bindings. This function is slower than
- * the corresponding `fromResolvedBindings` because it needs to resolve bindings first. See
- * `resolve`
- * for the {@link Injector}.
- *
- * Prefer `fromResolvedBindings` in performance-critical code that creates lots of injectors.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more
- * bindings.
- * @param `depProvider`
- */
- static resolveAndCreate(bindings: Array, depProvider?: DependencyProvider): Injector;
-
-
- /**
- * Creates an injector from previously resolved bindings. This bypasses resolution and flattening.
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * @param `bindings` A sparse list of {@link ResolvedBinding}s. See `resolve` for the
- * {@link Injector}.
- * @param `depProvider`
- */
- static fromResolvedBindings(bindings: ResolvedBinding[], depProvider?: DependencyProvider): Injector;
-
-
- /**
- * Returns debug information about the injector.
- *
- * This information is included into exceptions thrown by the injector.
- */
- debugContext(): any;
-
-
- /**
- * Retrieves an instance from the injector.
- *
- * @param `token`: usually the `Type` of an object. (Same as the token used while setting up a
- * binding).
- * @returns an instance represented by the token. Throws if not found.
- */
- get(token: any): any;
-
-
- /**
- * Retrieves an instance from the injector.
- *
- * @param `token`: usually a `Type`. (Same as the token used while setting up a binding).
- * @returns an instance represented by the token. Returns `null` if not found.
- */
- getOptional(token: any): any;
-
-
- /**
- * Retrieves an instance from the injector.
- *
- * @param `index`: index of an instance.
- * @returns an instance represented by the index. Throws if not found.
- */
- getAt(index: number): any;
-
-
- /**
- * Direct parent of this injector.
- */
- parent: Injector;
-
-
- /**
- * Internal. Do not use.
- *
- * We return `any` not to export the InjectorStrategy type.
- */
- internalStrategy: any;
-
-
- /**
- * Creates a child injector and loads a new set of bindings into it.
- *
- * A resolution is a process of flattening multiple nested lists and converting individual
- * bindings into a list of {@link ResolvedBinding}s. The resolution can be cached by `resolve`
- * for the {@link Injector} for performance-sensitive code.
- *
- * @param `bindings` can be a list of `Type`, {@link Binding}, {@link ResolvedBinding}, or a
- * recursive list of more bindings.
- * @param `depProvider`
- */
- resolveAndCreateChild(bindings: Array, depProvider?: DependencyProvider): Injector;
-
-
- /**
- * Creates a child injector and loads a new set of {@link ResolvedBinding}s into it.
- *
- * @param `bindings`: A sparse list of {@link ResolvedBinding}s.
- * See `resolve` for the {@link Injector}.
- * @param `depProvider`
- * @returns a new child {@link Injector}.
- */
- createChildFromResolved(bindings: ResolvedBinding[], depProvider?: DependencyProvider): Injector;
-
-
- /**
- * Resolves a binding and instantiates an object in the context of the injector.
- *
- * @param `binding`: either a type or a binding.
- * @returns an object created using binding.
- */
- resolveAndInstantiate(binding: Type | Binding): any;
-
-
- /**
- * Instantiates an object using a resolved bindin in the context of the injector.
- *
- * @param `binding`: a resolved binding
- * @returns an object created using binding.
- */
- instantiateResolved(binding: ResolvedBinding): any;
-
- displayName: string;
-
- toString(): string;
- }
-
- class ProtoInjector {
-
- numberOfBindings: number;
-
- getBindingAtIndex(index: number): any;
- }
-
- class BindingWithVisibility {
-
- binding: ResolvedBinding;
-
- visibility: Visibility;
-
- getKeyId(): number;
- }
-
-
- /**
- * Used to provide dependencies that cannot be easily expressed as bindings.
- */
- interface DependencyProvider {
-
- getDependency(injector: Injector, binding: ResolvedBinding, dependency: Dependency): any;
- }
-
- enum Visibility {
-
- Public,
-
- Private,
-
- PublicAndPrivate
- }
-
- const UNDEFINED : Object ;
-
-
- /**
- * Describes how_ the {@link Injector} should instantiate a given token.
- *
- * See {@link bind}.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(String, { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- class Binding {
-
-
- /**
- * Token used when retrieving this binding. Usually the `Type`.
- */
- token: any;
-
-
- /**
- * Binds an interface to an implementation / subclass.
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toClass: Car })
- * ]);
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toAlias: Car })
- * ]);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toClass: Type;
-
-
- /**
- * Binds a key to a value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(String, { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- toValue: any;
-
-
- /**
- * Binds a key to the alias for an existing key.
- *
- * An alias means that {@link Injector} returns the same instance as if the alias token was used.
- * This is in contrast to `toClass` where a separate instance of `toClass` is returned.
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toAlias: Car })
- * ]);
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * new Binding(Vehicle, { toClass: Car })
- * ]);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toAlias: any;
-
-
- /**
- * Binds a key to a function which computes the value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * dependencies: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- toFactory: Function;
-
-
- /**
- * Used in conjunction with `toFactory` and specifies a set of dependencies
- * (as `token`s) which should be injected into the factory function.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * dependencies: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- dependencies: any[];
-
-
- /**
- * Converts the {@link Binding} into {@link ResolvedBinding}.
- *
- * {@link Injector} internally only uses {@link ResolvedBinding}, {@link Binding} contains
- * convenience binding syntax.
- */
- resolve(): ResolvedBinding;
- }
-
-
- /**
- * Helper class for the {@link bind} function.
- */
- class BindingBuilder {
-
- token: any;
-
-
- /**
- * Binds an interface to an implementation / subclass.
- *
- * ## Example
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toClass(Car)
- * ]);
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toAlias(Car)
- * ]);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toClass(type: Type): Binding;
-
-
- /**
- * Binds a key to a value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * bind(String).toValue('Hello')
- * ]);
- *
- * expect(injector.get(String)).toEqual('Hello');
- * ```
- */
- toValue(value: any): Binding;
-
-
- /**
- * Binds a key to the alias for an existing key.
- *
- * An alias means that we will return the same instance as if the alias token was used. (This is
- * in contrast to `toClass` where a separate instance of `toClass` will be returned.)
- *
- * ## Example
- *
- * Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy
- * comparison.
- *
- * ```javascript
- *
- * class Vehicle {}
- *
- * class Car extends Vehicle {}
- *
- * var injectorAlias = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toAlias(Car)
- * ]);
- * var injectorClass = Injector.resolveAndCreate([
- * Car,
- * bind(Vehicle).toClass(Car)
- * ]);
- *
- * expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
- * expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
- *
- * expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
- * expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
- * ```
- */
- toAlias(aliasToken: /*Type*/ any): Binding;
-
-
- /**
- * Binds a key to a function which computes the value.
- *
- * ## Example
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * bind(Number).toFactory(() => { return 1+2; }),
- * bind(String).toFactory((v) => { return "Value: " + v; }, [Number])
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- */
- toFactory(factoryFunction: Function, dependencies?: any[]): Binding;
- }
-
-
- /**
- * An internal resolved representation of a {@link Binding} used by the {@link Injector}.
- *
- * A {@link Binding} is resolved when it has a factory function. Binding to a class, alias, or
- * value, are just convenience methods, as {@link Injector} only operates on calling factory
- * functions.
- */
- class ResolvedBinding {
-
-
- /**
- * A key, usually a `Type`.
- */
- key: Key;
-
-
- /**
- * Factory function which can return an instance of an object represented by a key.
- */
- factory: Function;
-
-
- /**
- * Arguments (dependencies) to the `factory` function.
- */
- dependencies: Dependency[];
- }
-
-
- /**
- * @private
- */
- class Dependency {
-
- static fromKey(key: Key): Dependency;
-
- key: Key;
-
- optional: boolean;
-
- lowerBoundVisibility: any;
-
- upperBoundVisibility: any;
-
- properties: any[];
- }
-
-
- /**
- * Provides an API for imperatively constructing {@link Binding}s.
- *
- * This is only relevant for JavaScript. See {@link BindingBuilder}.
- *
- * ## Example
- *
- * ```javascript
- * bind(MyInterface).toClass(MyClass)
- *
- * ```
- */
- function bind(token: any) : BindingBuilder ;
-
-
- /**
- * A unique object used for retrieving items from the {@link Injector}.
- *
- * Keys have:
- * - a system-wide unique `id`.
- * - a `token`, usually the `Type` of the instance.
- *
- * Keys are used internally by the {@link Injector} because their system-wide unique `id`s allow the
- * injector to index in arrays rather than looking up items in maps.
- */
- class Key {
-
-
- /**
- * Retrieves a `Key` for a token.
- */
- static get(token: Object): Key;
-
-
- /**
- * @returns the number of keys registered in the system.
- */
- static numberOfKeys: number;
-
- token: Object;
-
- id: number;
-
- displayName: string;
- }
-
-
- /**
- * @private
- */
- class KeyRegistry {
-
- get(token: Object): Key;
-
- numberOfKeys: number;
- }
-
-
- /**
- * Type literals is a Dart-only feature. This is here only so we can x-compile
- * to multiple languages.
- */
- class TypeLiteral {
-
- type: any;
- }
-
-
- /**
- * Thrown when trying to retrieve a dependency by `Key` from {@link Injector}, but the
- * {@link Injector} does not have a {@link Binding} for {@link Key}.
- */
- class NoBindingError extends AbstractBindingError {
- }
-
-
- /**
- * Base class for all errors arising from misconfigured bindings.
- */
- class AbstractBindingError extends BaseException {
-
- name: string;
-
- message: string;
-
- keys: Key[];
-
- injectors: Injector[];
-
- constructResolvingMessage: Function;
-
- addKey(injector: Injector, key: Key): void;
-
- context: any;
-
- toString(): string;
- }
-
-
- /**
- * Thrown when dependencies form a cycle.
- *
- * ## Example:
- *
- * ```javascript
- * class A {
- * constructor(b:B) {}
- * }
- * class B {
- * constructor(a:A) {}
- * }
- * ```
- *
- * Retrieving `A` or `B` throws a `CyclicDependencyError` as the graph above cannot be constructed.
- */
- class CyclicDependencyError extends AbstractBindingError {
- }
-
-
- /**
- * Thrown when a constructing type returns with an Error.
- *
- * The `InstantiationError` class contains the original error plus the dependency graph which caused
- * this object to be instantiated.
- */
- class InstantiationError extends AbstractBindingError {
-
- causeKey: Key;
- }
-
-
- /**
- * Thrown when an object other then {@link Binding} (or `Type`) is passed to {@link Injector}
- * creation.
- */
- class InvalidBindingError extends BaseException {
-
- message: string;
-
- toString(): string;
- }
-
-
- /**
- * Thrown when the class has no annotation information.
- *
- * Lack of annotation information prevents the {@link Injector} from determining which dependencies
- * need to be injected into the constructor.
- */
- class NoAnnotationError extends BaseException {
-
- name: string;
-
- message: string;
-
- toString(): string;
- }
-
-
- /**
- * Thrown when getting an object by index.
- */
- class OutOfBoundsError extends BaseException {
-
- message: string;
-
- toString(): string;
- }
-
- class OpaqueToken {
-
- toString(): string;
- }
-
-
- /**
- * Factory for creating {@link InjectMetadata}.
- */
- interface InjectFactory {
-
- new(token: any): InjectMetadata;
-
-
- (token: any): any;
-
- }
-
-
- /**
- * Factory for creating {@link OptionalMetadata}.
- */
- interface OptionalFactory {
-
- new(): OptionalMetadata;
-
-
- (): any;
-
- }
-
-
- /**
- * Factory for creating {@link InjectableMetadata}.
- */
- interface InjectableFactory {
-
- new(): InjectableMetadata;
-
-
- (): any;
-
- }
-
-
- /**
- * Factory for creating {@link SelfMetadata}.
- */
- interface SelfFactory {
-
- new(): SelfMetadata;
-
-
- (): any;
-
- }
-
-
- /**
- * Factory for creating {@link HostMetadata}.
- */
- interface HostFactory {
-
- new(): HostMetadata;
-
-
- (): any;
-
- }
-
-
- /**
- * Factory for creating {@link SkipSelfMetadata}.
- */
- interface SkipSelfFactory {
-
- new(): SkipSelfMetadata;
-
-
- (): any;
-
- }
-
-
- /**
- * Factory for creating {@link InjectMetadata}.
- */
- var Inject : InjectFactory ;
-
-
- /**
- * Factory for creating {@link OptionalMetadata}.
- */
- var Optional : OptionalFactory ;
-
-
- /**
- * Factory for creating {@link InjectableMetadata}.
- */
- var Injectable : InjectableFactory ;
-
-
- /**
- * Factory for creating {@link SelfMetadata}.
- */
- var Self : SelfFactory ;
-
-
- /**
- * Factory for creating {@link HostMetadata}.
- */
- var Host : HostFactory ;
-
-
- /**
- * Factory for creating {@link SkipSelfMetadata}.
- */
- var SkipSelf : SkipSelfFactory ;
-
-
- /**
- * A collection of the Angular core directives that are likely to be used in each and every Angular
- * application.
- *
- * This collection can be used to quickly enumerate all the built-in directives in the `@View`
- * annotation. For example,
- * instead of writing:
- *
- * ```
- * import {NgClass, NgIf, NgFor, NgSwitch, NgSwitchWhen, NgSwitchDefault} from 'angular2/angular2';
- * import {OtherDirective} from 'myDirectives';
- *
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * templateUrl: 'myComponent.html',
- * directives: [NgClass, NgIf, NgFor, NgSwitch, NgSwitchWhen, NgSwitchDefault, OtherDirective]
- * })
- * export class MyComponent {
- * ...
- * }
- * ```
- * one could import all the core directives at once:
- *
- * ```
- * import {CORE_DIRECTIVES} from 'angular2/angular2';
- * import {OtherDirective} from 'myDirectives';
- *
- * @Component({
- * selector: 'my-component'
- * })
- * @View({
- * templateUrl: 'myComponent.html',
- * directives: [CORE_DIRECTIVES, OtherDirective]
- * })
- * export class MyComponent {
- * ...
- * }
- * ```
- */
- const CORE_DIRECTIVES : Type[] ;
-
-
- /**
- * Adds and removes CSS classes based on an {expression} value.
- *
- * The result of expression is used to add and remove CSS classes using the following logic,
- * based on expression's value type:
- * - {string} - all the CSS classes (space - separated) are added
- * - {Array} - all the CSS classes (Array elements) are added
- * - {Object} - each key corresponds to a CSS class name while values
- * are interpreted as {boolean} expression. If a given expression
- * evaluates to {true} a corresponding CSS class is added - otherwise
- * it is removed.
- *
- * # Example:
- *
- * ```
- * 0}">
- * Please check errors.
- *
- * ```
- */
- class NgClass {
-
- initialClasses: any;
-
- rawClass: any;
-
- doCheck(): void;
-
- onDestroy(): void;
- }
-
-
- /**
- * The `NgFor` directive instantiates a template once per item from an iterable. The context for
- * each instantiated template inherits from the outer context with the given loop variable set
- * to the current item from the iterable.
- *
- * It is possible to alias the `index` to a local variable that will be set to the current loop
- * iteration in the template context.
- *
- * When the contents of the iterator changes, `NgFor` makes the corresponding changes to the DOM:
- *
- * * When an item is added, a new instance of the template is added to the DOM.
- * * When an item is removed, its template instance is removed from the DOM.
- * * When items are reordered, their respective templates are reordered in the DOM.
- *
- * # Example
- *
- * ```
- *
- *
- * Error {{i}} of {{errors.length}}: {{error.message}}
- *
- *
- * ```
- *
- * # Syntax
- *
- * - `... `
- * - `... `
- * - `... `
- */
- class NgFor {
-
- static bulkRemove(tuples: RecordViewTuple[], viewContainer: ViewContainerRef): RecordViewTuple[];
-
- static bulkInsert(tuples: RecordViewTuple[], viewContainer: ViewContainerRef, templateRef: TemplateRef): RecordViewTuple[];
-
- viewContainer: ViewContainerRef;
-
- templateRef: TemplateRef;
-
- iterableDiffers: IterableDiffers;
-
- cdr: ChangeDetectorRef;
-
- ngForOf: any;
-
- doCheck(): void;
- }
-
- class RecordViewTuple {
-
- view: ViewRef;
-
- record: any;
- }
-
-
- /**
- * Removes or recreates a portion of the DOM tree based on an {expression}.
- *
- * If the expression assigned to `ng-if` evaluates to a false value then the element
- * is removed from the DOM, otherwise a clone of the element is reinserted into the DOM.
- *
- * # Example:
- *
- * ```
- * 0" class="error">
- *
- * {{errorCount}} errors detected
- *
- * ```
- *
- * # Syntax
- *
- * - `...
`
- * - `...
`
- * - `...
`
- */
- class NgIf {
-
- ngIf: any;
- }
-
-
- /**
- * The `NgNonBindable` directive tells Angular not to compile or bind the contents of the current
- * DOM element. This is useful if the element contains what appears to be Angular directives and
- * bindings but which should be ignored by Angular. This could be the case if you have a site that
- * displays snippets of code, for instance.
- *
- * Example:
- *
- * ```
- * Normal: {{1 + 2}}
// output "Normal: 3"
- * Ignored: {{1 + 2}}
// output "Ignored: {{1 + 2}}"
- * ```
- */
- class NgNonBindable {
- }
-
-
- /**
- * Adds or removes styles based on an {expression}.
- *
- * When the expression assigned to `ng-style` evaluates to an object, the corresponding element
- * styles are updated. Style names to update are taken from the object keys and values - from the
- * corresponding object values.
- *
- * # Example:
- *
- * ```
- *
- * ```
- *
- * In the above example the `text-align` style will be updated based on the `alignExp` value
- * changes.
- *
- * # Syntax
- *
- * - `
`
- * - `
`
- */
- class NgStyle {
-
- rawStyle: any;
-
- doCheck(): void;
- }
-
- class SwitchView {
-
- create(): void;
-
- destroy(): void;
- }
-
-
- /**
- * The `NgSwitch` directive is used to conditionally swap DOM structure on your template based on a
- * scope expression.
- * Elements within `NgSwitch` but without `NgSwitchWhen` or `NgSwitchDefault` directives will be
- * preserved at the location as specified in the template.
- *
- * `NgSwitch` simply chooses nested elements and makes them visible based on which element matches
- * the value obtained from the evaluated expression. In other words, you define a container element
- * (where you place the directive), place an expression on the **`[ng-switch]="..."` attribute**),
- * define any inner elements inside of the directive and place a `[ng-switch-when]` attribute per
- * element.
- * The when attribute is used to inform NgSwitch which element to display when the expression is
- * evaluated. If a matching expression is not found via a when attribute then an element with the
- * default attribute is displayed.
- *
- * # Example:
- *
- * ```
- *
- * ...
- * ...
- * ...
- *
- * ```
- */
- class NgSwitch {
-
- ngSwitch: any;
- }
-
-
- /**
- * Defines a case statement as an expression.
- *
- * If multiple `NgSwitchWhen` match the `NgSwitch` value, all of them are displayed.
- *
- * Example:
- *
- * ```
- * // match against a context variable
- * ...
- *
- * // match against a constant string
- * ...
- * ```
- */
- class NgSwitchWhen {
-
- ngSwitchWhen: any;
- }
-
-
- /**
- * Defines a default case statement.
- *
- * Default case statements are displayed when no `NgSwitchWhen` match the `ng-switch` value.
- *
- * Example:
- *
- * ```
- * ...
- * ```
- */
- class NgSwitchDefault {
- }
-
-
- /**
- * Omitting from external API doc as this is really an abstract internal concept.
- */
- class AbstractControl {
-
- validator: Function;
-
- value: any;
-
- status: string;
-
- valid: boolean;
-
- errors: StringMap;
-
- pristine: boolean;
-
- dirty: boolean;
-
- touched: boolean;
-
- untouched: boolean;
-
- valueChanges: Observable;
-
- markAsTouched(): void;
-
- markAsDirty({onlySelf}?: {onlySelf?: boolean}): void;
-
- setParent(parent: ControlGroup | ControlArray): void;
-
- updateValidity({onlySelf}?: {onlySelf?: boolean}): void;
-
- updateValueAndValidity({onlySelf, emitEvent}?: {onlySelf?: boolean, emitEvent?: boolean}): void;
-
- find(path: Array| string): AbstractControl;
-
- getError(errorCode: string, path?: string[]): any;
-
- hasError(errorCode: string, path?: string[]): boolean;
- }
-
-
- /**
- * Defines a part of a form that cannot be divided into other controls.
- *
- * `Control` is one of the three fundamental building blocks used to define forms in Angular, along
- * with
- * {@link ControlGroup} and {@link ControlArray}.
- */
- class Control extends AbstractControl {
-
- updateValue(value: any, {onlySelf, emitEvent, emitModelToViewChange}?:
- {onlySelf?: boolean, emitEvent?: boolean, emitModelToViewChange?: boolean}): void;
-
- registerOnChange(fn: Function): void;
- }
-
-
- /**
- * Defines a part of a form, of fixed length, that can contain other controls.
- *
- * A ControlGroup aggregates the values and errors of each {@link Control} in the group. Thus, if
- * one of the controls
- * in a group is invalid, the entire group is invalid. Similarly, if a control changes its value,
- * the entire group
- * changes as well.
- *
- * `ControlGroup` is one of the three fundamental building blocks used to define forms in Angular,
- * along with
- * {@link Control} and {@link ControlArray}. {@link ControlArray} can also contain other controls,
- * but is of variable
- * length.
- */
- class ControlGroup extends AbstractControl {
-
- controls: StringMap;
-
- addControl(name: string, c: AbstractControl): void;
-
- removeControl(name: string): void;
-
- include(controlName: string): void;
-
- exclude(controlName: string): void;
-
- contains(controlName: string): boolean;
- }
-
-
- /**
- * Defines a part of a form, of variable length, that can contain other controls.
- *
- * A `ControlArray` aggregates the values and errors of each {@link Control} in the group. Thus, if
- * one of the controls
- * in a group is invalid, the entire group is invalid. Similarly, if a control changes its value,
- * the entire group
- * changes as well.
- *
- * `ControlArray` is one of the three fundamental building blocks used to define forms in Angular,
- * along with {@link Control} and {@link ControlGroup}. {@link ControlGroup} can also contain
- * other controls, but is of fixed length.
- */
- class ControlArray extends AbstractControl {
-
- controls: AbstractControl[];
-
- at(index: number): AbstractControl;
-
- push(control: AbstractControl): void;
-
- insert(index: number, control: AbstractControl): void;
-
- removeAt(index: number): void;
-
- length: number;
- }
-
- class AbstractControlDirective {
-
- control: AbstractControl;
-
- value: any;
-
- valid: boolean;
-
- errors: StringMap;
-
- pristine: boolean;
-
- dirty: boolean;
-
- touched: boolean;
-
- untouched: boolean;
- }
-
-
- /**
- * An interface that {@link NgFormModel} and {@link NgForm} implement.
- *
- * Only used by the forms module.
- */
- interface Form {
-
- addControl(dir: NgControl): void;
-
- removeControl(dir: NgControl): void;
-
- getControl(dir: NgControl): Control;
-
- addControlGroup(dir: NgControlGroup): void;
-
- removeControlGroup(dir: NgControlGroup): void;
-
- getControlGroup(dir: NgControlGroup): ControlGroup;
-
- updateModel(dir: NgControl, value: any): void;
- }
-
-
- /**
- * A directive that contains a group of [NgControl].
- *
- * Only used by the forms module.
- */
- class ControlContainer extends AbstractControlDirective {
-
- name: string;
-
- formDirective: Form;
-
- path: string[];
- }
-
-
- /**
- * Creates and binds a control with a specified name to a DOM element.
- *
- * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
- *
- * # Example
- *
- * In this example, we create the login and password controls.
- * We can work with each control separately: check its validity, get its value, listen to its
- * changes.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- *
- * `})
- * class LoginComp {
- * onLogIn(value) {
- * // value === {login: 'some login', password: 'some password'}
- * }
- * }
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- *
- * `})
- * class LoginComp {
- * credentials: {login:string, password:string};
- *
- * onLogIn() {
- * // this.credentials.login === "some login"
- * // this.credentials.password === "some password"
- * }
- * }
- * ```
- */
- class NgControlName extends NgControl {
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- ngValidators: QueryList;
-
- onChanges(c: StringMap): void;
-
- onDestroy(): void;
-
- viewToModelUpdate(newValue: any): void;
-
- path: string[];
-
- formDirective: any;
-
- control: Control;
-
- validator: Function;
- }
-
-
- /**
- * Binds an existing control to a DOM element.
- *
- * # Example
- *
- * In this example, we bind the control to an input element. When the value of the input element
- * changes, the value of
- * the control will reflect that change. Likewise, if the value of the control changes, the input
- * element reflects that
- * change.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: " "
- * })
- * class LoginComp {
- * loginControl:Control;
- *
- * constructor() {
- * this.loginControl = new Control('');
- * }
- * }
- *
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: " "
- * })
- * class LoginComp {
- * loginControl:Control;
- * login:string;
- *
- * constructor() {
- * this.loginControl = new Control('');
- * }
- * }
- * ```
- */
- class NgFormControl extends NgControl {
-
- form: Control;
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- ngValidators: QueryList;
-
- onChanges(c: StringMap): void;
-
- path: string[];
-
- control: Control;
-
- validator: Function;
-
- viewToModelUpdate(newValue: any): void;
- }
-
-
- /**
- * Binds a domain model to the form.
- *
- * # Example
- * ```
- * @Component({selector: "search-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- *
- * `})
- * class SearchComp {
- * searchQuery: string;
- * }
- * ```
- */
- class NgModel extends NgControl {
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- ngValidators: QueryList;
-
- onChanges(c: StringMap): void;
-
- control: Control;
-
- path: string[];
-
- validator: Function;
-
- viewToModelUpdate(newValue: any): void;
- }
-
-
- /**
- * An abstract class that all control directive extend.
- *
- * It binds a {@link Control} object to a DOM element.
- */
- class NgControl extends AbstractControlDirective {
-
- name: string;
-
- valueAccessor: ControlValueAccessor;
-
- validator: Function;
-
- path: string[];
-
- viewToModelUpdate(newValue: any): void;
- }
-
-
- /**
- * Creates and binds a control group to a DOM element.
- *
- * This directive can only be used as a child of {@link NgForm} or {@link NgFormModel}.
- *
- * # Example
- *
- * In this example, we create the credentials and personal control groups.
- * We can work with each group separately: check its validity, get its value, listen to its changes.
- *
- * ```
- * @Component({selector: "signup-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- *
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgControlGroup extends ControlContainer {
-
- onInit(): void;
-
- onDestroy(): void;
-
- control: ControlGroup;
-
- path: string[];
-
- formDirective: Form;
- }
-
-
- /**
- * Binds an existing control group to a DOM element.
- *
- * # Example
- *
- * In this example, we bind the control group to the form element, and we bind the login and
- * password controls to the
- * login and password elements.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: ""
- * })
- * class LoginComp {
- * loginForm:ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin() {
- * // this.loginForm.value
- * }
- * }
- *
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: ""
- * })
- * class LoginComp {
- * credentials:{login:string, password:string}
- * loginForm:ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin() {
- * // this.credentials.login === 'some login'
- * // this.credentials.password === 'some password'
- * }
- * }
- * ```
- */
- class NgFormModel extends ControlContainer implements Form {
-
- form: ControlGroup;
-
- directives: NgControl[];
-
- ngSubmit: any;
-
- onChanges(_: any): void;
-
- formDirective: Form;
-
- control: ControlGroup;
-
- path: string[];
-
- addControl(dir: NgControl): void;
-
- getControl(dir: NgControl): Control;
-
- removeControl(dir: NgControl): void;
-
- addControlGroup(dir: NgControlGroup): void;
-
- removeControlGroup(dir: NgControlGroup): void;
-
- getControlGroup(dir: NgControlGroup): ControlGroup;
-
- updateModel(dir: NgControl, value: any): void;
-
- onSubmit(): boolean;
- }
-
-
- /**
- * Creates and binds a form object to a DOM element.
- *
- * # Example
- *
- * ```
- * @Component({selector: "signup-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- *
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgForm extends ControlContainer implements Form {
-
- form: ControlGroup;
-
- ngSubmit: any;
-
- formDirective: Form;
-
- control: ControlGroup;
-
- path: string[];
-
- controls: StringMap;
-
- addControl(dir: NgControl): void;
-
- getControl(dir: NgControl): Control;
-
- removeControl(dir: NgControl): void;
-
- addControlGroup(dir: NgControlGroup): void;
-
- removeControlGroup(dir: NgControlGroup): void;
-
- getControlGroup(dir: NgControlGroup): ControlGroup;
-
- updateModel(dir: NgControl, value: any): void;
-
- onSubmit(): boolean;
- }
-
-
- /**
- * A bridge between a control and a native element.
- *
- * Please see {@link DefaultValueAccessor} for more information.
- */
- interface ControlValueAccessor {
-
- writeValue(obj: any): void;
-
- registerOnChange(fn: any): void;
-
- registerOnTouched(fn: any): void;
- }
-
-
- /**
- * The default accessor for writing a value and listening to changes that is used by the
- * {@link NgModel}, {@link NgFormControl}, and {@link NgControlName} directives.
- *
- * # Example
- * ```
- *
- * ```
- */
- class DefaultValueAccessor implements ControlValueAccessor {
-
- cd: NgControl;
-
- onChange: any;
-
- onTouched: any;
-
- renderer: Renderer;
-
- elementRef: ElementRef;
-
- writeValue(value: any): void;
-
- ngClassUntouched: boolean;
-
- ngClassTouched: boolean;
-
- ngClassPristine: boolean;
-
- ngClassDirty: boolean;
-
- ngClassValid: boolean;
-
- ngClassInvalid: boolean;
-
- registerOnChange(fn: (_: any) => void): void;
-
- registerOnTouched(fn: () => void): void;
- }
-
-
- /**
- * The accessor for writing a value and listening to changes on a checkbox input element.
- *
- * # Example
- * ```
- *
- * ```
- */
- class CheckboxControlValueAccessor implements ControlValueAccessor {
-
- cd: NgControl;
-
- onChange: any;
-
- onTouched: any;
-
- renderer: Renderer;
-
- elementRef: ElementRef;
-
- writeValue(value: any): void;
-
- ngClassUntouched: boolean;
-
- ngClassTouched: boolean;
-
- ngClassPristine: boolean;
-
- ngClassDirty: boolean;
-
- ngClassValid: boolean;
-
- ngClassInvalid: boolean;
-
- registerOnChange(fn: (_: any) => {}): void;
-
- registerOnTouched(fn: () => {}): void;
- }
-
-
- /**
- * Marks as dynamic, so Angular can be notified when options change.
- *
- * #Example:
- *
- * ```
- *
- *
- *
- * ```
- */
- class NgSelectOption {
- }
-
-
- /**
- * The accessor for writing a value and listening to changes on a select element.
- */
- class SelectControlValueAccessor implements ControlValueAccessor {
-
- cd: NgControl;
-
- value: string;
-
- onChange: any;
-
- onTouched: any;
-
- renderer: Renderer;
-
- elementRef: ElementRef;
-
- writeValue(value: any): void;
-
- ngClassUntouched: boolean;
-
- ngClassTouched: boolean;
-
- ngClassPristine: boolean;
-
- ngClassDirty: boolean;
-
- ngClassValid: boolean;
-
- ngClassInvalid: boolean;
-
- registerOnChange(fn: () => any): void;
-
- registerOnTouched(fn: () => any): void;
- }
-
-
- /**
- * A list of all the form directives used as part of a `@View` annotation.
- *
- * This is a shorthand for importing them each individually.
- */
- const FORM_DIRECTIVES : Type[] ;
-
-
- /**
- * Provides a set of validators used by form controls.
- *
- * # Example
- *
- * ```
- * var loginControl = new Control("", Validators.required)
- * ```
- */
- class Validators {
-
- static required(c:Control): StringMap;
-
- static nullValidator(c: any): StringMap;
-
- static compose(validators: Function[]): Function;
-
- static group(c:ControlGroup): StringMap;
-
- static array(c:ControlArray): StringMap;
- }
-
- class NgValidator {
-
- validator: Function;
- }
-
- class NgRequiredValidator extends NgValidator {
-
- validator: Function;
- }
-
-
- /**
- * Creates a form object from a user-specified configuration.
- *
- * # Example
- *
- * ```
- * import {Component, View, bootstrap} from 'angular2/angular2';
- * import {FormBuilder, Validators, FORM_DIRECTIVES, ControlGroup} from 'angular2/forms';
- *
- * @Component({
- * selector: 'login-comp',
- * viewBindings: [
- * FormBuilder
- * ]
- * })
- * @View({
- * template: `
- *
- * `,
- * directives: [
- * FORM_DIRECTIVES
- * ]
- * })
- * class LoginComp {
- * loginForm: ControlGroup;
- *
- * constructor(builder: FormBuilder) {
- * this.loginForm = builder.group({
- * login: ["", Validators.required],
- *
- * passwordRetry: builder.group({
- * password: ["", Validators.required],
- * passwordConfirmation: ["", Validators.required]
- * })
- * });
- * }
- * }
- *
- * bootstrap(LoginComp)
- * ```
- *
- * This example creates a {@link ControlGroup} that consists of a `login` {@link Control}, and a
- * nested
- * {@link ControlGroup} that defines a `password` and a `passwordConfirmation` {@link Control}:
- *
- * ```
- * var loginForm = builder.group({
- * login: ["", Validators.required],
- *
- * passwordRetry: builder.group({
- * password: ["", Validators.required],
- * passwordConfirmation: ["", Validators.required]
- * })
- * });
- *
- * ```
- */
- class FormBuilder {
-
- group(controlsConfig: StringMap, extra?: StringMap): ControlGroup;
-
- control(value: Object, validator?: Function): Control;
-
- array(controlsConfig: any[], validator?: Function): ControlArray;
- }
-
- const FORM_BINDINGS : Type[] ;
-
- class RenderDirectiveMetadata {
-
- static DIRECTIVE_TYPE: any;
-
- static COMPONENT_TYPE: any;
-
- static create({id, selector, compileChildren, events, host, properties, readAttributes, type,
- callOnDestroy, callOnChanges, callDoCheck, callOnInit, callAfterContentInit,
- callAfterContentChecked, callAfterViewInit, callAfterViewChecked, changeDetection,
- exportAs}: {
- id?: string,
- selector?: string,
- compileChildren?: boolean,
- events?: string[],
- host?: Map,
- properties?: string[],
- readAttributes?: string[],
- type?: number,
- callOnDestroy?: boolean,
- callOnChanges?: boolean,
- callDoCheck?: boolean,
- callOnInit?: boolean,
- callAfterContentInit?: boolean,
- callAfterContentChecked?: boolean,
- callAfterViewInit?: boolean,
- callAfterViewChecked?: boolean,
- changeDetection?: ChangeDetectionStrategy,
- exportAs?: string
- }): RenderDirectiveMetadata;
-
- id: any;
-
- selector: string;
-
- compileChildren: boolean;
-
- events: string[];
-
- properties: string[];
-
- readAttributes: string[];
-
- type: number;
-
- callOnDestroy: boolean;
-
- callOnChanges: boolean;
-
- callDoCheck: boolean;
-
- callOnInit: boolean;
-
- callAfterContentInit: boolean;
-
- callAfterContentChecked: boolean;
-
- callAfterViewInit: boolean;
-
- callAfterViewChecked: boolean;
-
- changeDetection: ChangeDetectionStrategy;
-
- exportAs: string;
-
- hostListeners: Map;
-
- hostProperties: Map;
-
- hostAttributes: Map;
- }
-
- class DomRenderer extends Renderer {
-
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
-
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
-
- destroyView(viewRef: RenderViewRef): void;
-
- getNativeElementSync(location: RenderElementRef): any;
-
- getRootNodes(fragment: RenderFragmentRef): Node[];
-
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
-
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
-
- detachFragment(fragmentRef: RenderFragmentRef): void;
-
- hydrateView(viewRef: RenderViewRef): void;
-
- dehydrateView(viewRef: RenderViewRef): void;
-
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
-
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
-
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
-
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
-
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
-
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
-
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: any): void;
- }
-
-
- /**
- * A dispatcher for all events happening in a view.
- */
- interface RenderEventDispatcher {
-
-
- /**
- * Called when an event was triggered for a on-* attribute on an element.
- * @param {Map} locals Locals to be used to evaluate the
- * event expressions
- * @return {boolean} False if `preventDefault` should be called on the DOM event.
- */
- dispatchRenderEvent(elementIndex: number, eventName: string, locals: Map): boolean;
- }
-
- class Renderer {
-
-
- /**
- * Creates a root host view that includes the given element.
- * Note that the fragmentCount needs to be passed in so that we can create a result
- * synchronously even when dealing with webworkers!
- *
- * @param {RenderProtoViewRef} hostProtoViewRef a RenderProtoViewRef of type
- * ProtoViewDto.HOST_VIEW_TYPE
- * @param {any} hostElementSelector css selector for the host element (will be queried against the
- * main document)
- * @return {RenderViewWithFragments} the created view including fragments
- */
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
-
-
- /**
- * Creates a regular view out of the given ProtoView.
- * Note that the fragmentCount needs to be passed in so that we can create a result
- * synchronously even when dealing with webworkers!
- */
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
-
-
- /**
- * Destroys the given view after it has been dehydrated and detached
- */
- destroyView(viewRef: RenderViewRef): void;
-
-
- /**
- * Attaches a fragment after another fragment.
- */
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
-
-
- /**
- * Attaches a fragment after an element.
- */
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
-
-
- /**
- * Detaches a fragment.
- */
- detachFragment(fragmentRef: RenderFragmentRef): void;
-
-
- /**
- * Hydrates a view after it has been attached. Hydration/dehydration is used for reusing views
- * inside of the view pool.
- */
- hydrateView(viewRef: RenderViewRef): void;
-
-
- /**
- * Dehydrates a view after it has been attached. Hydration/dehydration is used for reusing views
- * inside of the view pool.
- */
- dehydrateView(viewRef: RenderViewRef): void;
-
-
- /**
- * Returns the native element at the given location.
- * Attention: In a WebWorker scenario, this should always return null!
- */
- getNativeElementSync(location: RenderElementRef): any;
-
-
- /**
- * Sets a property on an element.
- */
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
-
-
- /**
- * Sets an attribute on an element.
- */
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
-
-
- /**
- * Sets a class on an element.
- */
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
-
-
- /**
- * Sets a style on an element.
- */
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
-
-
- /**
- * Calls a method on an element.
- */
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
-
-
- /**
- * Sets the value of a text node.
- */
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
-
-
- /**
- * Sets the dispatcher for all events of the given view
- */
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: RenderEventDispatcher): void;
- }
-
-
- /**
- * Abstract reference to the element which can be marshaled across web-worker boundary.
- *
- * This interface is used by the Renderer API.
- */
- interface RenderElementRef {
-
-
- /**
- * Reference to the `RenderViewRef` where the `RenderElementRef` is inside of.
- */
- renderView: RenderViewRef;
-
-
- /**
- * Index of the element inside the `RenderViewRef`.
- *
- * This is used internally by the Angular framework to locate elements.
- */
- renderBoundElementIndex: number;
- }
-
- class RenderViewRef {
- }
-
- class RenderProtoViewRef {
- }
-
- class RenderFragmentRef {
- }
-
- class RenderViewWithFragments {
-
- viewRef: RenderViewRef;
-
- fragmentRefs: RenderFragmentRef[];
- }
-
- class ViewDefinition {
-
- componentId: string;
-
- templateAbsUrl: string;
-
- template: string;
-
- directives: RenderDirectiveMetadata[];
-
- styleAbsUrls: string[];
-
- styles: string[];
-
- encapsulation: ViewEncapsulation;
- }
-
- const DOCUMENT : OpaqueToken ;
-
-
- /**
- * A unique id (string) for an angular application.
- */
- const APP_ID : OpaqueToken ;
-
-
- /**
- * Defines when a compiled template should be stored as a string
- * rather than keeping its Nodes to preserve memory.
- */
- const MAX_IN_MEMORY_ELEMENTS_PER_TEMPLATE : OpaqueToken ;
-
-
- /**
- * Create trace scope.
- *
- * Scopes must be strictly nested and are analogous to stack frames, but
- * do not have to follow the stack frames. Instead it is recommended that they follow logical
- * nesting. You may want to use
- * [Event
- * Signatures](http://google.github.io/tracing-framework/instrumenting-code.html#custom-events)
- * as they are defined in WTF.
- *
- * Used to mark scope entry. The return value is used to leave the scope.
- *
- * var myScope = wtfCreateScope('MyClass#myMethod(ascii someVal)');
- *
- * someMethod() {
- * var s = myScope('Foo'); // 'Foo' gets stored in tracing UI
- * // DO SOME WORK HERE
- * return wtfLeave(s, 123); // Return value 123
- * }
- *
- * Note, adding try-finally block around the work to ensure that `wtfLeave` gets called can
- * negatively impact the performance of your application. For this reason we recommend that
- * you don't add them to ensure that `wtfLeave` gets called. In production `wtfLeave` is a noop and
- * so try-finally block has no value. When debugging perf issues, skipping `wtfLeave`, do to
- * exception, will produce incorrect trace, but presence of exception signifies logic error which
- * needs to be fixed before the app should be profiled. Add try-finally only when you expect that
- * an exception is expected during normal execution while profiling.
- */
- var wtfCreateScope : WtfScopeFn ;
-
-
- /**
- * Used to mark end of Scope.
- *
- * - `scope` to end.
- * - `returnValue` (optional) to be passed to the WTF.
- *
- * Returns the `returnValue for easy chaining.
- */
- var wtfLeave : (scope: any, returnValue?: T) => T ;
-
-
- /**
- * Used to mark Async start. Async are similar to scope but they don't have to be strictly nested.
- * The return value is used in the call to [endAsync]. Async ranges only work if WTF has been
- * enabled.
- *
- * someMethod() {
- * var s = wtfStartTimeRange('HTTP:GET', 'some.url');
- * var future = new Future.delay(5).then((_) {
- * wtfEndTimeRange(s);
- * });
- * }
- */
- var wtfStartTimeRange : (rangeType: string, action: string) => any ;
-
-
- /**
- * Ends a async time range operation.
- * [range] is the return value from [wtfStartTimeRange] Async ranges only work if WTF has been
- * enabled.
- */
- var wtfEndTimeRange : (range: any) => void ;
-
- interface WtfScopeFn {
-
- (arg0?: any, arg1?: any): any;
-
- }
-
- var ChangeDetectorRef: InjectableReference;
-
- var ApplicationRef: InjectableReference;
-
- var Compiler: InjectableReference;
-
- var AppViewManager: InjectableReference;
-
- var ViewRef: InjectableReference;
-
- var ProtoViewRef: InjectableReference;
-
- var ViewContainerRef: InjectableReference;
-
- var ComponentRef: InjectableReference;
-
-}
-
-declare module "angular2/angular2" {
- export = ng;
-}
-
-
-declare module ngWorker {
-
- /**
- * Declare reusable UI building blocks for an application.
- *
- * Each Angular component requires a single `@Component` and at least one `@View` annotation. The
- * `@Component`
- * annotation specifies when a component is instantiated, and which properties and hostListeners it
- * binds to.
- *
- * When a component is instantiated, Angular
- * - creates a shadow DOM for the component.
- * - loads the selected template into the shadow DOM.
- * - creates all the injectable objects configured with `bindings` and `viewBindings`.
- *
- * All template expressions and statements are then evaluated against the component instance.
- *
- * For details on the `@View` annotation, see {@link ViewMetadata}.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!'
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ComponentMetadata extends DirectiveMetadata {
-
-
- /**
- * Defines the used change detection strategy.
- *
- * When a component is instantiated, Angular creates a change detector, which is responsible for
- * propagating the component's bindings.
- *
- * The `changeDetection` property defines, whether the change detection will be checked every time
- * or only when the component tells it to do so.
- */
- changeDetection: ChangeDetectionStrategy;
-
-
- /**
- * Defines the set of injectable objects that are visible to its view dom children.
- *
- * ## Simple Example
- *
- * Here is an example of a class that can be injected:
- *
- * ```
- * class Greeter {
- * greet(name:string) {
- * return 'Hello ' + name + '!';
- * }
- * }
- *
- * @Directive({
- * selector: 'needs-greeter'
- * })
- * class NeedsGreeter {
- * greeter:Greeter;
- *
- * constructor(greeter:Greeter) {
- * this.greeter = greeter;
- * }
- * }
- *
- * @Component({
- * selector: 'greet',
- * viewBindings: [
- * Greeter
- * ]
- * })
- * @View({
- * template: ` `,
- * directives: [NeedsGreeter]
- * })
- * class HelloWorld {
- * }
- *
- * ```
- */
- viewBindings: any[];
- }
-
-
- /**
- * Directives allow you to attach behavior to elements in the DOM.
- *
- * {@link DirectiveMetadata}s with an embedded view are called {@link ComponentMetadata}s.
- *
- * A directive consists of a single directive annotation and a controller class. When the
- * directive's `selector` matches
- * elements in the DOM, the following steps occur:
- *
- * 1. For each directive, the `ElementInjector` attempts to resolve the directive's constructor
- * arguments.
- * 2. Angular instantiates directives for each matched element using `ElementInjector` in a
- * depth-first order,
- * as declared in the HTML.
- *
- * ## Understanding How Injection Works
- *
- * There are three stages of injection resolution.
- * - *Pre-existing Injectors*:
- * - The terminal {@link Injector} cannot resolve dependencies. It either throws an error or, if
- * the dependency was
- * specified as `@Optional`, returns `null`.
- * - The platform injector resolves browser singleton resources, such as: cookies, title,
- * location, and others.
- * - *Component Injectors*: Each component instance has its own {@link Injector}, and they follow
- * the same parent-child hierarchy
- * as the component instances in the DOM.
- * - *Element Injectors*: Each component instance has a Shadow DOM. Within the Shadow DOM each
- * element has an `ElementInjector`
- * which follow the same parent-child hierarchy as the DOM elements themselves.
- *
- * When a template is instantiated, it also must instantiate the corresponding directives in a
- * depth-first order. The
- * current `ElementInjector` resolves the constructor dependencies for each directive.
- *
- * Angular then resolves dependencies as follows, according to the order in which they appear in the
- * {@link ViewMetadata}:
- *
- * 1. Dependencies on the current element
- * 2. Dependencies on element injectors and their parents until it encounters a Shadow DOM boundary
- * 3. Dependencies on component injectors and their parents until it encounters the root component
- * 4. Dependencies on pre-existing injectors
- *
- *
- * The `ElementInjector` can inject other directives, element-specific special objects, or it can
- * delegate to the parent
- * injector.
- *
- * To inject other directives, declare the constructor parameter as:
- * - `directive:DirectiveType`: a directive on the current element only
- * - `@Host() directive:DirectiveType`: any directive that matches the type between the current
- * element and the
- * Shadow DOM root.
- * - `@Query(DirectiveType) query:QueryList`: A live collection of direct child
- * directives.
- * - `@QueryDescendants(DirectiveType) query:QueryList`: A live collection of any
- * child directives.
- *
- * To inject element-specific special objects, declare the constructor parameter as:
- * - `element: ElementRef` to obtain a reference to logical element in the view.
- * - `viewContainer: ViewContainerRef` to control child template instantiation, for
- * {@link DirectiveMetadata} directives only
- * - `bindingPropagation: BindingPropagation` to control change detection in a more granular way.
- *
- * ## Example
- *
- * The following example demonstrates how dependency injection resolves constructor arguments in
- * practice.
- *
- *
- * Assume this HTML template:
- *
- * ```
- *
- * ```
- *
- * With the following `dependency` decorator and `SomeService` injectable class.
- *
- * ```
- * @Injectable()
- * class SomeService {
- * }
- *
- * @Directive({
- * selector: '[dependency]',
- * properties: [
- * 'id: dependency'
- * ]
- * })
- * class Dependency {
- * id:string;
- * }
- * ```
- *
- * Let's step through the different ways in which `MyDirective` could be declared...
- *
- *
- * ### No injection
- *
- * Here the constructor is declared with no arguments, therefore nothing is injected into
- * `MyDirective`.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor() {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with no dependencies.
- *
- *
- * ### Component-level injection
- *
- * Directives can inject any injectable instance from the closest component injector or any of its
- * parents.
- *
- * Here, the constructor declares a parameter, `someService`, and injects the `SomeService` type
- * from the parent
- * component's injector.
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(someService: SomeService) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a dependency on `SomeService`.
- *
- *
- * ### Injecting a directive from the current element
- *
- * Directives can inject other directives declared on the current element.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(dependency: Dependency) {
- * expect(dependency.id).toEqual(3);
- * }
- * }
- * ```
- * This directive would be instantiated with `Dependency` declared at the same element, in this case
- * `dependency="3"`.
- *
- * ### Injecting a directive from any ancestor elements
- *
- * Directives can inject other directives declared on any ancestor element (in the current Shadow
- * DOM), i.e. on the current element, the
- * parent element, or its parents.
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Host() dependency: Dependency) {
- * expect(dependency.id).toEqual(2);
- * }
- * }
- * ```
- *
- * `@Host` checks the current element, the parent, as well as its parents recursively. If
- * `dependency="2"` didn't
- * exist on the direct parent, this injection would
- * have returned
- * `dependency="1"`.
- *
- *
- * ### Injecting a live collection of direct child directives
- *
- *
- * A directive can also query for other child directives. Since parent directives are instantiated
- * before child directives, a directive can't simply inject the list of child directives. Instead,
- * the directive injects a {@link QueryList}, which updates its contents as children are added,
- * removed, or moved by a directive that uses a {@link ViewContainerRef} such as a `ng-for`, an
- * `ng-if`, or an `ng-switch`.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Query(Dependency) dependencies:QueryList) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a {@link QueryList} which contains `Dependency` 4 and
- * 6. Here, `Dependency` 5 would not be included, because it is not a direct child.
- *
- * ### Injecting a live collection of descendant directives
- *
- * By passing the descendant flag to `@Query` above, we can include the children of the child
- * elements.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Query(Dependency, {descendants: true}) dependencies:QueryList) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a Query which would contain `Dependency` 4, 5 and 6.
- *
- * ### Optional injection
- *
- * The normal behavior of directives is to return an error when a specified dependency cannot be
- * resolved. If you
- * would like to inject `null` on unresolved dependency instead, you can annotate that dependency
- * with `@Optional()`.
- * This explicitly permits the author of a template to treat some of the surrounding directives as
- * optional.
- *
- * ```
- * @Directive({ selector: '[my-directive]' })
- * class MyDirective {
- * constructor(@Optional() dependency:Dependency) {
- * }
- * }
- * ```
- *
- * This directive would be instantiated with a `Dependency` directive found on the current element.
- * If none can be
- * found, the injector supplies `null` instead of throwing an error.
- *
- * ## Example
- *
- * Here we use a decorator directive to simply define basic tool-tip behavior.
- *
- * ```
- * @Directive({
- * selector: '[tooltip]',
- * properties: [
- * 'text: tooltip'
- * ],
- * host: {
- * '(mouseenter)': 'onMouseEnter()',
- * '(mouseleave)': 'onMouseLeave()'
- * }
- * })
- * class Tooltip{
- * text:string;
- * overlay:Overlay; // NOT YET IMPLEMENTED
- * overlayManager:OverlayManager; // NOT YET IMPLEMENTED
- *
- * constructor(overlayManager:OverlayManager) {
- * this.overlay = overlay;
- * }
- *
- * onMouseEnter() {
- * // exact signature to be determined
- * this.overlay = this.overlayManager.open(text, ...);
- * }
- *
- * onMouseLeave() {
- * this.overlay.close();
- * this.overlay = null;
- * }
- * }
- * ```
- * In our HTML template, we can then add this behavior to a `` or any other element with the
- * `tooltip` selector,
- * like so:
- *
- * ```
- *
- * ```
- *
- * Directives can also control the instantiation, destruction, and positioning of inline template
- * elements:
- *
- * A directive uses a {@link ViewContainerRef} to instantiate, insert, move, and destroy views at
- * runtime.
- * The {@link ViewContainerRef} is created as a result of `
` element, and represents a
- * location in the current view
- * where these actions are performed.
- *
- * Views are always created as children of the current {@link ViewMetadata}, and as siblings of the
- * `` element. Thus a
- * directive in a child view cannot inject the directive that created it.
- *
- * Since directives that create views via ViewContainers are common in Angular, and using the full
- * `` element syntax is wordy, Angular
- * also supports a shorthand notation: `` and ` ` are
- * equivalent.
- *
- * Thus,
- *
- * ```
- *
- * ```
- *
- * Expands in use to:
- *
- * ```
- *
- * ```
- *
- * Notice that although the shorthand places `*foo="bar"` within the ` ` element, the binding for
- * the directive
- * controller is correctly instantiated on the `` element rather than the `` element.
- *
- *
- * ## Example
- *
- * Let's suppose we want to implement the `unless` behavior, to conditionally include a template.
- *
- * Here is a simple directive that triggers on an `unless` selector:
- *
- * ```
- * @Directive({
- * selector: '[unless]',
- * properties: ['unless']
- * })
- * export class Unless {
- * viewContainer: ViewContainerRef;
- * templateRef: TemplateRef;
- * prevCondition: boolean;
- *
- * constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef) {
- * this.viewContainer = viewContainer;
- * this.templateRef = templateRef;
- * this.prevCondition = null;
- * }
- *
- * set unless(newCondition) {
- * if (newCondition && (isBlank(this.prevCondition) || !this.prevCondition)) {
- * this.prevCondition = true;
- * this.viewContainer.clear();
- * } else if (!newCondition && (isBlank(this.prevCondition) || this.prevCondition)) {
- * this.prevCondition = false;
- * this.viewContainer.create(this.templateRef);
- * }
- * }
- * }
- * ```
- *
- * We can then use this `unless` selector in a template:
- * ```
- *
- * ```
- *
- * Once the directive instantiates the child view, the shorthand notation for the template expands
- * and the result is:
- *
- * ```
- *
- * ```
- *
- * Note also that although the ` ` template still exists inside the ` `,
- * the instantiated
- * view occurs on the second ` ` which is a sibling to the `` element.
- */
- class DirectiveMetadata extends InjectableMetadata {
-
-
- /**
- * The CSS selector that triggers the instantiation of a directive.
- *
- * Angular only allows directives to trigger on CSS selectors that do not cross element
- * boundaries.
- *
- * `selector` may be declared as one of the following:
- *
- * - `element-name`: select by element name.
- * - `.class`: select by class name.
- * - `[attribute]`: select by attribute name.
- * - `[attribute=value]`: select by attribute name and value.
- * - `:not(sub_selector)`: select only if the element does not match the `sub_selector`.
- * - `selector1, selector2`: select if either `selector1` or `selector2` matches.
- *
- *
- * ## Example
- *
- * Suppose we have a directive with an `input[type=text]` selector.
- *
- * And the following HTML:
- *
- * ```html
- *