` ) will ensure that this element will get the "button" role.
- *
- * ```typescript
- * @Directive({
- * selector: '[my-button]',
- * host: {
- * 'role': 'button'
- * }
- * })
- * class MyButton {
- * }
- * ```
- */
- host: {[key: string]: string};
-
- /**
- * 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;
-
- /**
- * The module id of the module that contains the directive.
- * Needed to be able to resolve relative urls for templates and styles.
- * In Dart, this can be determined automatically and does not need to be set.
- * In CommonJS, this can always be set to `module.id`.
- *
- * ## Simple Example
- *
- * ```
- * @Directive({
- * selector: 'someDir',
- * moduleId: module.id
- * })
- * class SomeDir {
- * }
- *
- * ```
- */
- moduleId: string;
-
- /**
- * Configures the queries that will be injected into the directive.
- *
- * Content queries are set before the `afterContentInit` callback is called.
- * View queries are set before the `afterViewInit` callback is called.
- *
- * ### Example
- *
- * ```
- * @Component({
- * selector: 'someDir',
- * queries: {
- * contentChildren: new ContentChildren(ChildDirective),
- * viewChildren: new ViewChildren(ChildDirective)
- * }
- * })
- * @View({
- * template: '
',
- * directives: [ChildDirective]
- * })
- * class SomeDir {
- * contentChildren: QueryList
,
- * viewChildren: QueryList
- *
- * afterContentInit() {
- * // contentChildren is set
- * }
- *
- * afterViewInit() {
- * // viewChildren is set
- * }
- * }
- * ```
- */
- queries: {[key: string]: any};
-
- }
-
-
- /**
- * Declare reusable pipe function.
- *
- * ## Example
- *
- * ```
- * @Pipe({
- * name: 'lowercase'
- * })
- * class Lowercase {
- * transform(v, args) { return v.toLowerCase(); }
- * }
- * ```
- */
- class PipeMetadata extends InjectableMetadata {
-
- constructor({name, pure}: {name: string, pure: boolean});
-
- name: string;
-
- pure: boolean;
-
- }
-
-
- /**
- * Declares a data-bound input property.
- *
- * Angular automatically updates data-bound properties during change detection.
- *
- * `InputMetadata` takes an optional parameter that specifies the name
- * used when instantiating a component in the template. When not provided,
- * the name of the decorated property is used.
- *
- * ### Example
- *
- * The following example creates a component with two input properties.
- *
- * ```typescript
- * @Component({selector: 'bank-account'})
- * @View({
- * template: `
- * Bank Name: {{bankName}}
- * Account Id: {{id}}
- * `
- * })
- * class BankAccount {
- * @Input() bankName: string;
- * @Input('account-id') id: string;
- *
- * // this property is not bound, and won't be automatically updated by Angular
- * normalizedBankName: string;
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- *
- *
- * `,
- * directives: [IntervalDir]
- * })
- * class App {
- * everySecond() { console.log('second'); }
- * everyFiveSeconds() { console.log('five seconds'); }
- * }
- * bootstrap(App);
- * ```
- */
- class OutputMetadata {
-
- constructor(bindingPropertyName?: string);
-
- bindingPropertyName: string;
-
- }
-
-
- /**
- * Declares a host property binding.
- *
- * Angular automatically checks host property bindings during change detection.
- * If a binding changes, it will update the host element of the directive.
- *
- * `HostBindingMetadata` takes an optional parameter that specifies the property
- * name of the host element that will be updated. When not provided,
- * the class property name is used.
- *
- * ### Example
- *
- * The following example creates a directive that sets the `valid` and `invalid` classes
- * on the DOM element that has ng-model directive on it.
- *
- * ```typescript
- * @Directive({selector: '[ng-model]'})
- * class NgModelStatus {
- * constructor(public control:NgModel) {}
- * @HostBinding('[class.valid]') get valid { return this.control.valid; }
- * @HostBinding('[class.invalid]') get invalid { return this.control.invalid; }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `Increment `,
- * directives: [CountClicks]
- * })
- * class App {}
- *
- * bootstrap(App);
- * ```
- */
- class HostListenerMetadata {
-
- constructor(eventName: string, args?: string[]);
-
- eventName: string;
-
- args: string[];
-
- }
-
-
- /**
- * Metadata properties available for configuring Views.
- *
- * 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 {
-
- constructor({templateUrl, template, directives, pipes, encapsulation, styles, styleUrls}?: {
- templateUrl?: string,
- template?: string,
- directives?: Array,
- pipes?: Array,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- });
-
- /**
- * Specifies a template URL for an Angular component.
- *
- * NOTE: Only one of `templateUrl` or `template` can be defined per View.
- *
- *
- */
- templateUrl: string;
-
- /**
- * Specifies an inline template for an Angular component.
- *
- * NOTE: Only one of `templateUrl` or `template` can be defined per View.
- */
- 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: [NgFor]
- * 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;
-
- }
-
-
- /**
- * Defines template and style encapsulation options available for Component's {@link View}.
- *
- * See {@link ViewMetadata#encapsulation}.
- */
- enum ViewEncapsulation {
-
- /**
- * Emulate `Native` scoping of styles by adding an attribute containing surrogate id to the Host
- * Element and pre-processing the style rules provided via
- * {@link ViewMetadata#styles} or {@link ViewMetadata#stylesUrls}, and adding the new Host Element
- * attribute to all selectors.
- *
- * This is the default option.
- */
- Emulated,
-
- /**
- * Use the native encapsulation mechanism of the renderer.
- *
- * For the DOM this means using [Shadow DOM](https://w3c.github.io/webcomponents/spec/shadow/) and
- * creating a ShadowRoot for Component's Host Element.
- */
- Native,
-
- /**
- * Don't provide any template or style encapsulation.
- */
- None
- }
-
-
-
- /**
- * Interface for the {@link DirectiveMetadata} decorator function.
- *
- * See {@link DirectiveFactory}.
- */
- interface DirectiveDecorator extends TypeDecorator {
-
- }
-
-
- /**
- * 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;
-
- }
-
-
- /**
- * 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 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,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any}
- }): DirectiveMetadata;
-
- (obj: {
- selector?: string,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any}
- }): DirectiveDecorator;
-
- }
-
-
- /**
- * {@link ComponentMetadata} 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,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any},
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentMetadata;
-
- (obj: {
- selector?: string,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any},
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentDecorator;
-
- }
-
-
- /**
- * {@link ViewMetadata} 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,
- pipes?: Array,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewMetadata;
-
- (obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array,
- pipes?: Array,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
-
- }
-
-
- /**
- * {@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 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;
-
- }
-
-
- interface ContentChildrenFactory {
-
- new(selector: Type | string, {descendants}?: {descendants?: boolean}): ContentChildrenMetadata;
-
- (selector: Type | string, {descendants}?: {descendants?: boolean}): any;
-
- }
-
-
- interface ContentChildFactory {
-
- new(selector: Type | string): ContentChildFactory;
-
- (selector: Type | string): any;
-
- }
-
-
- interface ViewChildrenFactory {
-
- new(selector: Type | string): ViewChildrenMetadata;
-
- (selector: Type | string): any;
-
- }
-
-
- interface ViewChildFactory {
-
- new(selector: Type | string): ViewChildFactory;
-
- (selector: Type | string): any;
-
- }
-
-
- /**
- * {@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, pure?: boolean}): any;
-
- (obj: {name: string, pure?: boolean}): any;
-
- }
-
-
- /**
- * {@link InputMetadata} factory for creating decorators.
- *
- * See {@link InputMetadata}.
- */
- interface InputFactory {
-
- new(bindingPropertyName?: string): any;
-
- (bindingPropertyName?: string): any;
-
- }
-
-
- /**
- * {@link OutputMetadata} factory for creating decorators.
- *
- * See {@link OutputMetadata}.
- */
- interface OutputFactory {
-
- new(bindingPropertyName?: string): any;
-
- (bindingPropertyName?: string): any;
-
- }
-
-
- /**
- * {@link HostBindingMetadata} factory function.
- */
- interface HostBindingFactory {
-
- new(hostPropertyName?: string): any;
-
- (hostPropertyName?: string): any;
-
- }
-
-
- /**
- * {@link HostListenerMetadata} factory function.
- */
- interface HostListenerFactory {
-
- new(eventName: string, args?: string[]): any;
-
- (eventName: string, args?: string[]): any;
-
- }
-
-
- /**
- * {@link ComponentMetadata} factory function.
- */
- var Component: ComponentFactory;
-
-
-
- /**
- * {@link DirectiveMetadata} factory function.
- */
- var Directive: DirectiveFactory;
-
-
-
- /**
- * {@link ViewMetadata} factory function.
- */
- var View: ViewFactory;
-
-
-
- /**
- * {@link AttributeMetadata} factory function.
- */
- var Attribute: AttributeFactory;
-
-
-
- /**
- * {@link QueryMetadata} factory function.
- */
- var Query: QueryFactory;
-
-
-
- /**
- * {@link ContentChildrenMetadata} factory function.
- */
- var ContentChildren: ContentChildrenFactory;
-
-
-
- /**
- * {@link ContentChildMetadata} factory function.
- */
- var ContentChild: ContentChildFactory;
-
-
-
- /**
- * {@link ViewChildrenMetadata} factory function.
- */
- var ViewChildren: ViewChildrenFactory;
-
-
-
- /**
- * {@link ViewChildMetadata} factory function.
- */
- var ViewChild: ViewChildFactory;
-
-
-
- /**
- * {@link di/ViewQueryMetadata} factory function.
- */
- var ViewQuery: QueryFactory;
-
-
-
- /**
- * {@link PipeMetadata} factory function.
- */
- var Pipe: PipeFactory;
-
-
-
- /**
- * {@link InputMetadata} factory function.
- *
- * See {@link InputMetadata}.
- */
- var Input: InputFactory;
-
-
-
- /**
- * {@link OutputMetadata} factory function.
- *
- * See {@link OutputMetadatas}.
- */
- var Output: OutputFactory;
-
-
-
- /**
- * {@link HostBindingMetadata} factory function.
- */
- var HostBinding: HostBindingFactory;
-
-
-
- /**
- * {@link HostListenerMetadata} factory function.
- */
- var HostListener: HostListenerFactory;
-
-
-
- /**
- * 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 = ng.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;
-
- }
-
-
- /**
- * A parameter metadata that specifies a dependency.
- *
- * ### Example ([live demo](http://plnkr.co/edit/6uHYJK?p=preview))
- *
- * ```typescript
- * class Engine {}
- *
- * @Injectable()
- * class Car {
- * engine;
- * constructor(@Inject("MyEngine") engine:Engine) {
- * this.engine = engine;
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([
- * bind("MyEngine").toClass(Engine),
- * Car
- * ]);
- *
- * expect(injector.get(Car).engine instanceof Engine).toBe(true);
- * ```
- *
- * When `@Inject()` is not present, {@link Injector} will use the type annotation of the parameter.
- *
- * ### Example
- *
- * ```typescript
- * class Engine {}
- *
- * @Injectable()
- * class Car {
- * constructor(public engine: Engine) {} //same as constructor(@Inject(Engine) engine:Engine)
- * }
- *
- * var injector = Injector.resolveAndCreate([Engine, Car]);
- * expect(injector.get(Car).engine instanceof Engine).toBe(true);
- * ```
- */
- class InjectMetadata {
-
- constructor(token: any);
-
- token: any;
-
- toString(): string;
-
- }
-
-
- /**
- * A parameter metadata that marks a dependency as optional. {@link Injector} provides `null` if
- * the dependency is not found.
- *
- * ### Example ([live demo](http://plnkr.co/edit/AsryOm?p=preview))
- *
- * ```typescript
- * class Engine {}
- *
- * @Injectable()
- * class Car {
- * engine;
- * constructor(@Optional() engine:Engine) {
- * this.engine = engine;
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([Car]);
- * expect(injector.get(Car).engine).toBeNull();
- * ```
- */
- class OptionalMetadata {
-
- toString(): string;
-
- }
-
-
- /**
- * A marker metadata that marks a class as available to {@link Injector} for creation.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Wk4DMQ?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class UsefulService {}
- *
- * @Injectable()
- * class NeedsService {
- * constructor(public service:UsefulService) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([NeedsService, UsefulService]);
- * expect(injector.get(NeedsService).service instanceof UsefulService).toBe(true);
- * ```
- * {@link Injector} will throw {@link NoAnnotationError} when trying to instantiate a class that
- * does not have `@Injectable` marker, as shown in the example below.
- *
- * ```typescript
- * class UsefulService {}
- *
- * class NeedsService {
- * constructor(public service:UsefulService) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([NeedsService, UsefulService]);
- * expect(() => injector.get(NeedsService)).toThrowError();
- * ```
- */
- class InjectableMetadata {
-
- constructor();
-
- }
-
-
- /**
- * Specifies that an {@link Injector} should retrieve a dependency only from itself.
- *
- * ### Example ([live demo](http://plnkr.co/edit/NeagAg?p=preview))
- *
- * ```typescript
- * class Dependency {
- * }
- *
- * @Injectable()
- * class NeedsDependency {
- * dependency;
- *
- * dependency;
- * constructor(@Self() dependency:Dependency) {
- * this.dependency = dependency;
- * }
- * }
- *
- * var inj = Injector.resolveAndCreate([Dependency, NeedsDependency]);
- * var nd = inj.get(NeedsDependency);
- *
- * expect(nd.dependency instanceof Dependency).toBe(true);
- *
- * var inj = Injector.resolveAndCreate([Dependency]);
- * var child = inj.resolveAndCreateChild([NeedsDependency]);
- * expect(() => child.get(NeedsDependency)).toThrowError();
- * ```
- */
- class SelfMetadata {
-
- toString(): string;
-
- }
-
-
- /**
- * Specifies that an injector should retrieve a dependency from any injector until reaching the
- * closest host.
- *
- * In Angular, a component element is automatically declared as a host for all the injectors in
- * its view.
- *
- * ### Example ([live demo](http://plnkr.co/edit/GX79pV?p=preview))
- *
- * In the following example `App` contains `ParentCmp`, which contains `ChildDirective`.
- * So `ParentCmp` is the host of `ChildDirective`.
- *
- * `ChildDirective` depends on two services: `HostService` and `OtherService`.
- * `HostService` is defined at `ParentCmp`, and `OtherService` is defined at `App`.
- *
- * ```typescript
- * class OtherService {}
- * class HostService {}
- *
- * @Directive({
- * selector: 'child-directive'
- * })
- * class ChildDirective {
- * constructor(@Optional() @Host() os:OtherService, @Optional() @Host() hs:HostService){
- * console.log("os is null", os);
- * console.log("hs is NOT null", hs);
- * }
- * }
- *
- * @Component({
- * selector: 'parent-cmp',
- * bindings: [HostService]
- * })
- * @View({
- * template: `
- * Dir: ): ResolvedBinding[];
-
- /**
- * Resolves an array of bindings and creates an injector from those bindings.
- *
- * The passed-in bindings can be an array of `Type`, {@link Binding},
- * or a recursive array of more bindings.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ePOccA?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Car, Engine]);
- * expect(injector.get(Car) instanceof Car).toBe(true);
- * ```
- *
- * This function is slower than the corresponding `fromResolvedBindings`
- * because it needs to resolve the passed-in bindings first.
- * See {@link resolve} and {@link fromResolvedBindings}.
- */
- static resolveAndCreate(bindings: Array): Injector;
-
- /**
- * Creates an injector from previously resolved bindings.
- *
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * ### Example ([live demo](http://plnkr.co/edit/KrSMci?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var bindings = Injector.resolve([Car, Engine]);
- * var injector = Injector.fromResolvedBindings(bindings);
- * expect(injector.get(Car) instanceof Car).toBe(true);
- * ```
- */
- static fromResolvedBindings(bindings: ResolvedBinding[]): Injector;
-
- /**
- * Retrieves an instance from the injector based on the provided token.
- * Throws {@link NoBindingError} if not found.
- *
- * ### Example ([live demo](http://plnkr.co/edit/HeXSHg?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind("validToken").toValue("Value")
- * ]);
- * expect(injector.get("validToken")).toEqual("Value");
- * expect(() => injector.get("invalidToken")).toThrowError();
- * ```
- *
- * `Injector` returns itself when given `Injector` as a token.
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([]);
- * expect(injector.get(Injector)).toBe(injector);
- * ```
- */
- get(token: any): any;
-
- /**
- * Retrieves an instance from the injector based on the provided token.
- * Returns null if not found.
- *
- * ### Example ([live demo](http://plnkr.co/edit/tpEbEy?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind("validToken").toValue("Value")
- * ]);
- * expect(injector.getOptional("validToken")).toEqual("Value");
- * expect(injector.getOptional("invalidToken")).toBe(null);
- * ```
- *
- * `Injector` returns itself when given `Injector` as a token.
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([]);
- * expect(injector.getOptional(Injector)).toBe(injector);
- * ```
- */
- getOptional(token: any): any;
-
- /**
- * Parent of this injector.
- *
- *
- *
- * ### Example ([live demo](http://plnkr.co/edit/eosMGo?p=preview))
- *
- * ```typescript
- * var parent = Injector.resolveAndCreate([]);
- * var child = parent.resolveAndCreateChild([]);
- * expect(child.parent).toBe(parent);
- * ```
- */
- parent: Injector;
-
- /**
- * Resolves an array of bindings and creates a child injector from those bindings.
- *
- *
- *
- * The passed-in bindings can be an array of `Type`, {@link Binding},
- * or a recursive array of more bindings.
- *
- * ### Example ([live demo](http://plnkr.co/edit/opB3T4?p=preview))
- *
- * ```typescript
- * class ParentBinding {}
- * class ChildBinding {}
- *
- * var parent = Injector.resolveAndCreate([ParentBinding]);
- * var child = parent.resolveAndCreateChild([ChildBinding]);
- *
- * expect(child.get(ParentBinding) instanceof ParentBinding).toBe(true);
- * expect(child.get(ChildBinding) instanceof ChildBinding).toBe(true);
- * expect(child.get(ParentBinding)).toBe(parent.get(ParentBinding));
- * ```
- *
- * This function is slower than the corresponding `createChildFromResolved`
- * because it needs to resolve the passed-in bindings first.
- * See {@link resolve} and {@link createChildFromResolved}.
- */
- resolveAndCreateChild(bindings: Array): Injector;
-
- /**
- * Creates a child injector from previously resolved bindings.
- *
- *
- *
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * ### Example ([live demo](http://plnkr.co/edit/VhyfjN?p=preview))
- *
- * ```typescript
- * class ParentBinding {}
- * class ChildBinding {}
- *
- * var parentBindings = Injector.resolve([ParentBinding]);
- * var childBindings = Injector.resolve([ChildBinding]);
- *
- * var parent = Injector.fromResolvedBindings(parentBindings);
- * var child = parent.createChildFromResolved(childBindings);
- *
- * expect(child.get(ParentBinding) instanceof ParentBinding).toBe(true);
- * expect(child.get(ChildBinding) instanceof ChildBinding).toBe(true);
- * expect(child.get(ParentBinding)).toBe(parent.get(ParentBinding));
- * ```
- */
- createChildFromResolved(bindings: ResolvedBinding[]): Injector;
-
- /**
- * Resolves a binding and instantiates an object in the context of the injector.
- *
- * The created object does not get cached by the injector.
- *
- * ### Example ([live demo](http://plnkr.co/edit/yvVXoB?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Engine]);
- *
- * var car = injector.resolveAndInstantiate(Car);
- * expect(car.engine).toBe(injector.get(Engine));
- * expect(car).not.toBe(injector.resolveAndInstantiate(Car));
- * ```
- */
- resolveAndInstantiate(binding: Type | Binding): any;
-
- /**
- * Instantiates an object using a resolved binding in the context of the injector.
- *
- * The created object does not get cached by the injector.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ptCImQ?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Engine]);
- * var carBinding = Injector.resolve([Car])[0];
- * var car = injector.instantiateResolved(carBinding);
- * expect(car.engine).toBe(injector.get(Engine));
- * expect(car).not.toBe(injector.instantiateResolved(carBinding));
- * ```
- */
- instantiateResolved(binding: ResolvedBinding): any;
-
- displayName: string;
-
- toString(): string;
-
- }
-
-
- /**
- * Describes how the {@link Injector} should instantiate a given token.
- *
- * See {@link bind}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/GNAyj6K6PfYg2NBzgwZ5?p%3Dpreview&p=preview))
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding("message", { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get("message")).toEqual('Hello');
- * ```
- */
- class Binding {
-
- constructor(token: any, {toClass, toValue, toAlias, toFactory, deps, multi}: {
- toClass?: Type,
- toValue?: any,
- toAlias?: any,
- toFactory?: Function,
- deps?: Object[],
- multi?: boolean
- });
-
- /**
- * Token used when retrieving this binding. Usually, it is a type {@link `Type`}.
- */
- token: any;
-
- /**
- * Binds a DI token to an implementation class.
- *
- * ### Example ([live demo](http://plnkr.co/edit/RSTG86qgmoxCyj9SWPwY?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy
- * comparison.
- *
- * ```typescript
- * 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 DI token to a value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/UFVsMVQIDe7l4waWziES?p=preview))
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding("message", { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get("message")).toEqual('Hello');
- * ```
- */
- toValue: any;
-
- /**
- * Binds a DI token as an alias for an existing token.
- *
- * 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 ([live demo](http://plnkr.co/edit/QsatsOJJ6P8T2fMe9gr8?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused the example contains both use cases for easy
- * comparison.
- *
- * ```typescript
- * 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 DI token to a function which computes the value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Scoxy0pJNqKGAPZY1VVC?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * deps: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- *
- * Used in conjuction with dependencies.
- */
- toFactory: Function;
-
- /**
- * Specifies a set of dependencies
- * (as `token`s) which should be injected into the factory function.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Scoxy0pJNqKGAPZY1VVC?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * deps: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- *
- * Used in conjunction with `toFactory`.
- */
- dependencies: Object[];
-
- /**
- * Creates multiple bindings matching the same token (a multi-binding).
- *
- * Multi-bindings are used for creating pluggable service, where the system comes
- * with some default bindings, and the user can register additonal bindings.
- * The combination of the default bindings and the additional bindings will be
- * used to drive the behavior of the system.
- *
- * ### Example
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding("Strings", { toValue: "String1", multi: true}),
- * new Binding("Strings", { toValue: "String2", multi: true})
- * ]);
- *
- * expect(injector.get("Strings")).toEqual(["String1", "String2"]);
- * ```
- *
- * Multi-bindings and regular bindings cannot be mixed. The following
- * will throw an exception:
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding("Strings", { toValue: "String1", multi: true }),
- * new Binding("Strings", { toValue: "String2"})
- * ]);
- * ```
- */
- multi: boolean;
-
- }
-
-
- /**
- * Helper class for the {@link bind} function.
- */
- class BindingBuilder {
-
- constructor(token: any);
-
- token: any;
-
- /**
- * Binds a DI token to a class.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ZpBCSYqv6e2ud5KXLdxQ?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy comparison.
- *
- * ```typescript
- * 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 DI token to a value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/G024PFHmDL0cJFgfZK8O?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind('message').toValue('Hello')
- * ]);
- *
- * expect(injector.get('message')).toEqual('Hello');
- * ```
- */
- toValue(value: any): Binding;
-
- /**
- * Binds a DI token as an alias for an existing token.
- *
- * 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 ([live demo](http://plnkr.co/edit/uBaoF2pN5cfc5AfZapNw?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy
- * comparison.
- *
- * ```typescript
- * 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 DI token to a function which computes the value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/OejNIfTT3zb1iBxaIYOb?p=preview))
- *
- * ```typescript
- * 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(factory: Function, dependencies?: any[]): Binding;
-
- }
-
-
- /**
- * An internal resolved representation of a {@link Binding} used by the {@link Injector}.
- *
- * It is usually created automatically by `Injector.resolveAndCreate`.
- *
- * It can be created manually, as follows:
- *
- * ### Example ([live demo](http://plnkr.co/edit/RfEnhh8kUEI0G3qsnIeT?p%3Dpreview&p=preview))
- *
- * ```typescript
- * var resolvedBindings = Injector.resolve([new Binding('message', {toValue: 'Hello'})]);
- * var injector = Injector.fromResolvedBindings(resolvedBindings);
- *
- * expect(injector.get('message')).toEqual('Hello');
- * ```
- */
- interface ResolvedBinding {
-
- /**
- * A key, usually a `Type`.
- */
- key: Key;
-
- }
-
-
- /**
- * @private
- * An internal resolved representation of a factory function created by resolving {@link Binding}.
- */
- class ResolvedFactory {
-
- constructor(factory: Function, dependencies: Dependency[]);
-
- /**
- * 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 {
-
- constructor(key: Key, optional: boolean, lowerBoundVisibility: any, upperBoundVisibility: any, properties: any[]);
-
- static fromKey(key: Key): Dependency;
-
- key: Key;
-
- optional: boolean;
-
- lowerBoundVisibility: any;
-
- upperBoundVisibility: any;
-
- properties: any[];
-
- }
-
-
- /**
- * Creates a {@link Binding}.
- *
- * To construct a {@link Binding}, bind a `token` to either a class, a value, a factory function, or
- * to an alias to another `token`.
- * See {@link BindingBuilder} for more details.
- *
- * The `token` is most commonly a class or {@link angular2/di/OpaqueToken}.
- */
- 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`.
- *
- * `Key` is used internally by {@link Injector} because its system-wide unique `id` allows the
- * injector to store created objects in a more efficient way.
- *
- * `Key` should not be created directly. {@link Injector} creates keys automatically when resolving
- * bindings.
- */
- class Key {
-
- /**
- * Private
- */
- constructor(token: Object, id: number);
-
- /**
- * 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;
-
- /**
- * Returns a stringified token.
- */
- displayName: string;
-
- }
-
-
- /**
- * @private
- * 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}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/vq8D3FRB9aGbnWJqtEPE?p=preview))
- *
- * ```typescript
- * class A {
- * constructor(b:B) {}
- * }
- *
- * expect(() => Injector.resolveAndCreate([A])).toThrowError();
- * ```
- */
- class NoBindingError extends AbstractBindingError {
-
- constructor(injector: Injector, key: Key);
-
- }
-
-
- /**
- * Base class for all errors arising from misconfigured bindings.
- */
- class AbstractBindingError extends BaseException {
-
- constructor(injector: Injector, key: Key, constructResolvingMessage: Function);
-
- addKey(injector: Injector, key: Key): void;
-
- context: any;
-
- }
-
-
- /**
- * Thrown when dependencies form a cycle.
- *
- * ### Example ([live demo](http://plnkr.co/edit/wYQdNos0Tzql3ei1EV9j?p=info))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind("one").toFactory((two) => "two", [[new Inject("two")]]),
- * bind("two").toFactory((one) => "one", [[new Inject("one")]])
- * ]);
- *
- * expect(() => injector.get("one")).toThrowError();
- * ```
- *
- * Retrieving `A` or `B` throws a `CyclicDependencyError` as the graph above cannot be constructed.
- */
- class CyclicDependencyError extends AbstractBindingError {
-
- constructor(injector: Injector, key: Key);
-
- }
-
-
- /**
- * 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.
- *
- * ### Example ([live demo](http://plnkr.co/edit/7aWYdcqTQsP0eNqEdUAf?p=preview))
- *
- * ```typescript
- * class A {
- * constructor() {
- * throw new Error('message');
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([A]);
- *
- * try {
- * injector.get(A);
- * } catch (e) {
- * expect(e instanceof InstantiationError).toBe(true);
- * expect(e.originalException.message).toEqual("message");
- * expect(e.originalStack).toBeDefined();
- * }
- * ```
- */
- interface InstantiationError extends WrappedException {
-
- addKey(injector: Injector, key: Key): void;
-
- wrapperMessage: string;
-
- causeKey: Key;
-
- context: any;
-
- }
-
-
- /**
- * Thrown when an object other then {@link Binding} (or `Type`) is passed to {@link Injector}
- * creation.
- *
- * ### Example ([live demo](http://plnkr.co/edit/YatCFbPAMCL0JSSQ4mvH?p=preview))
- *
- * ```typescript
- * expect(() => Injector.resolveAndCreate(["not a type"])).toThrowError();
- * ```
- */
- class InvalidBindingError extends BaseException {
-
- constructor(binding: any);
-
- }
-
-
- /**
- * 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.
- *
- * ### Example ([live demo](http://plnkr.co/edit/rHnZtlNS7vJOPQ6pcVkm?p=preview))
- *
- * ```typescript
- * class A {
- * constructor(b) {}
- * }
- *
- * expect(() => Injector.resolveAndCreate([A])).toThrowError();
- * ```
- *
- * This error is also thrown when the class not marked with {@link @Injectable} has parameter types.
- *
- * ```typescript
- * class B {}
- *
- * class A {
- * constructor(b:B) {} // no information about the parameter types of A is available at runtime.
- * }
- *
- * expect(() => Injector.resolveAndCreate([A,B])).toThrowError();
- * ```
- */
- class NoAnnotationError extends BaseException {
-
- constructor(typeOrFunc: any, params: any[][]);
-
- }
-
-
- /**
- * Thrown when getting an object by index.
- *
- * ### Example ([live demo](http://plnkr.co/edit/bRs0SX2OTQiJzqvjgl8P?p=preview))
- *
- * ```typescript
- * class A {}
- *
- * var injector = Injector.resolveAndCreate([A]);
- *
- * expect(() => injector.getAt(100)).toThrowError();
- * ```
- */
- class OutOfBoundsError extends BaseException {
-
- constructor(index: any);
-
- }
-
-
- /**
- * Creates a token that can be used in a DI Binding.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Ys9ezXpj2Mnoy3Uc8KBp?p=preview))
- *
- * ```typescript
- * var t = new OpaqueToken("binding");
- *
- * var injector = Injector.resolveAndCreate([
- * bind(t).toValue("bindingValue")
- * ]);
- *
- * expect(injector.get(t)).toEqual("bindingValue");
- * ```
- *
- * Using an `OpaqueToken` is preferable to using strings as tokens because of possible collisions
- * caused by multiple bindings using the same string as two different tokens.
- *
- * Using an `OpaqueToken` is preferable to using an `Object` as tokens because it provides better
- * error messages.
- */
- class OpaqueToken {
-
- constructor(_desc: string);
-
- 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;
-
-
-
- /**
- * The `async` pipe subscribes to an Observable or Promise and returns the latest value it has
- * emitted.
- * When a new value is emitted, the `async` pipe marks the component to be checked for changes.
- *
- * # Example
- * The example below binds the `time` Observable to the view. Every 500ms, the `time` Observable
- * updates the view with the current time.
- *
- * ```
- * import {Observable} from 'angular2/core';
- * @Component({
- * selector: "task-cmp"
- * })
- * @View({
- * template: "Time: {{ time | async }}"
- * })
- * class Task {
- * time = new Observable(observer => {
- * setInterval(_ =>
- * observer.next(new Date().getTime()), 500);
- * });
- * }
- * ```
- */
- class AsyncPipe implements PipeTransform, PipeOnDestroy {
-
- constructor(_ref: ChangeDetectorRef);
-
- onDestroy(): void;
-
- transform(obj: Observable | Promise, args?: any[]): any;
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a date value to a string based on the requested format.
- *
- * # Usage
- *
- * expression | date[:format]
- *
- * where `expression` is a date object or a number (milliseconds since UTC epoch) and
- * `format` indicates which date/time components to include:
- *
- * | Component | Symbol | Short Form | Long Form | Numeric | 2-digit |
- * |-----------|:------:|--------------|-------------------|-----------|-----------|
- * | era | G | G (AD) | GGGG (Anno Domini)| - | - |
- * | year | y | - | - | y (2015) | yy (15) |
- * | month | M | MMM (Sep) | MMMM (September) | M (9) | MM (09) |
- * | day | d | - | - | d (3) | dd (03) |
- * | weekday | E | EEE (Sun) | EEEE (Sunday) | - | - |
- * | hour | j | - | - | j (13) | jj (13) |
- * | hour12 | h | - | - | h (1 PM) | hh (01 PM)|
- * | hour24 | H | - | - | H (13) | HH (13) |
- * | minute | m | - | - | m (5) | mm (05) |
- * | second | s | - | - | s (9) | ss (09) |
- * | timezone | z | - | z (Pacific Standard Time)| - | - |
- * | timezone | Z | Z (GMT-8:00) | - | - | - |
- *
- * In javascript, only the components specified will be respected (not the ordering,
- * punctuations, ...) and details of the formatting will be dependent on the locale.
- * On the other hand in Dart version, you can also include quoted text as well as some extra
- * date/time components such as quarter. For more information see:
- * https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/intl/intl.DateFormat.
- *
- * `format` can also be one of the following predefined formats:
- *
- * - `'medium'`: equivalent to `'yMMMdjms'` (e.g. Sep 3, 2010, 12:05:08 PM for en-US)
- * - `'short'`: equivalent to `'yMdjm'` (e.g. 9/3/2010, 12:05 PM for en-US)
- * - `'fullDate'`: equivalent to `'yMMMMEEEEd'` (e.g. Friday, September 3, 2010 for en-US)
- * - `'longDate'`: equivalent to `'yMMMMd'` (e.g. September 3, 2010)
- * - `'mediumDate'`: equivalent to `'yMMMd'` (e.g. Sep 3, 2010 for en-US)
- * - `'shortDate'`: equivalent to `'yMd'` (e.g. 9/3/2010 for en-US)
- * - `'mediumTime'`: equivalent to `'jms'` (e.g. 12:05:08 PM for en-US)
- * - `'shortTime'`: equivalent to `'jm'` (e.g. 12:05 PM for en-US)
- *
- * Timezone of the formatted text will be the local system timezone of the end-users machine.
- *
- * # Examples
- *
- * Assuming `dateObj` is (year: 2015, month: 6, day: 15, hour: 21, minute: 43, second: 11)
- * in the _local_ time and locale is 'en-US':
- *
- * {{ dateObj | date }} // output is 'Jun 15, 2015'
- * {{ dateObj | date:'medium' }} // output is 'Jun 15, 2015, 9:43:11 PM'
- * {{ dateObj | date:'shortTime' }} // output is '9:43 PM'
- * {{ dateObj | date:'mmss' }} // output is '43:11'
- */
- class DatePipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- supports(obj: any): boolean;
-
- }
-
-
- let DEFAULT_PIPES: Binding;
-
-
-
- let DEFAULT_PIPES_TOKEN: OpaqueToken;
-
-
-
- /**
- * Implements json transforms to any object.
- *
- * # Example
- *
- * In this example we transform the user object to json.
- *
- * ```
- * @Component({
- * selector: "user-cmp"
- * })
- * @View({
- * template: "User: {{ user | json }}"
- * })
- * class Username {
- * user:Object
- * constructor() {
- * this.user = { name: "PatrickJS" };
- * }
- * }
- *
- * ```
- */
- class JsonPipe implements PipeTransform {
-
- transform(value: any, args?: any[]): string;
-
- }
-
-
- /**
- * Creates a new List or String containing only a subset (slice) of the
- * elements.
- *
- * The starting index of the subset to return is specified by the `start` parameter.
- *
- * The ending index of the subset to return is specified by the optional `end` parameter.
- *
- * # Usage
- *
- * expression | slice:start[:end]
- *
- * All behavior is based on the expected behavior of the JavaScript API
- * Array.prototype.slice() and String.prototype.slice()
- *
- * Where the input expression is a [List] or [String], and `start` is:
- *
- * - **a positive integer**: return the item at _start_ index and all items after
- * in the list or string expression.
- * - **a negative integer**: return the item at _start_ index from the end and all items after
- * in the list or string expression.
- * - **`|start|` greater than the size of the expression**: return an empty list or string.
- * - **`|start|` negative greater than the size of the expression**: return entire list or
- * string expression.
- *
- * and where `end` is:
- *
- * - **omitted**: return all items until the end of the input
- * - **a positive integer**: return all items before _end_ index of the list or string
- * expression.
- * - **a negative integer**: return all items before _end_ index from the end of the list
- * or string expression.
- *
- * When operating on a [List], the returned list is always a copy even when all
- * the elements are being returned.
- *
- * # Examples
- *
- * ## List Example
- *
- * Assuming `var collection = ['a', 'b', 'c', 'd']`, this `ng-for` directive:
- *
- * {{i}}
- *
- * produces the following:
- *
- * b
- * c
- *
- * ## String Examples
- *
- * {{ 'abcdefghij' | slice:0:4 }} // output is 'abcd'
- * {{ 'abcdefghij' | slice:4:0 }} // output is ''
- * {{ 'abcdefghij' | slice:-4 }} // output is 'ghij'
- * {{ 'abcdefghij' | slice:-4,-2 }} // output is 'gh'
- * {{ 'abcdefghij' | slice: -100 }} // output is 'abcdefghij'
- * {{ 'abcdefghij' | slice: 100 }} // output is ''
- */
- class SlicePipe implements PipeTransform {
-
- transform(value: any, args?: any[]): any;
-
- supports(obj: any): boolean;
-
- }
-
-
- /**
- * Implements lowercase transforms to text.
- *
- * # Example
- *
- * In this example we transform the user text lowercase.
- *
- * ```
- * @Component({
- * selector: "username-cmp"
- * })
- * @View({
- * template: "Username: {{ user | lowercase }}"
- * })
- * class Username {
- * user:string;
- * }
- *
- * ```
- */
- class LowerCasePipe implements PipeTransform {
-
- transform(value: string, args?: any[]): string;
-
- }
-
-
- class NumberPipe {
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a number as local text. i.e. group sizing and separator and other locale-specific
- * configurations are based on the active locale.
- *
- * # Usage
- *
- * expression | number[:digitInfo]
- *
- * where `expression` is a number and `digitInfo` has the following format:
- *
- * {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}
- *
- * - minIntegerDigits is the minimum number of integer digits to use. Defaults to 1.
- * - minFractionDigits is the minimum number of digits after fraction. Defaults to 0.
- * - maxFractionDigits is the maximum number of digits after fraction. Defaults to 3.
- *
- * For more information on the acceptable range for each of these numbers and other
- * details see your native internationalization library.
- *
- * # Examples
- *
- * {{ 123 | number }} // output is 123
- * {{ 123.1 | number: '.2-3' }} // output is 123.10
- * {{ 1 | number: '2.2' }} // output is 01.00
- */
- class DecimalPipe extends NumberPipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a number as local percent.
- *
- * # Usage
- *
- * expression | percent[:digitInfo]
- *
- * For more information about `digitInfo` see {@link DecimalPipe}
- */
- class PercentPipe extends NumberPipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a number as local currency.
- *
- * # Usage
- *
- * expression | currency[:currencyCode[:symbolDisplay[:digitInfo]]]
- *
- * where `currencyCode` is the ISO 4217 currency code, such as "USD" for the US dollar and
- * "EUR" for the euro. `symbolDisplay` is a boolean indicating whether to use the currency
- * symbol (e.g. $) or the currency code (e.g. USD) in the output. The default for this value
- * is `false`.
- * For more information about `digitInfo` see {@link DecimalPipe}
- */
- class CurrencyPipe extends NumberPipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- }
-
-
- /**
- * Implements uppercase transforms to text.
- *
- * # Example
- *
- * In this example we transform the user text uppercase.
- *
- * ```
- * @Component({
- * selector: "username-cmp"
- * })
- * @View({
- * template: "Username: {{ user | uppercase }}"
- * })
- * class Username {
- * user:string;
- * }
- *
- * ```
- */
- class UpperCasePipe implements PipeTransform {
-
- transform(value: string, args?: any[]): string;
-
- }
-
-
- /**
- *
- * Runtime representation a type that a Component or other object is instances of.
- *
- * An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by
- * the `MyCustomComponent` constructor function.
- */
- interface Type extends Function {
-
- new(...args: any[]): any;
-
- }
-
-
- class Observable {
-
- observer(generator: any): Object;
-
- }
-
-
- /**
- * Use by directives and components to emit custom Events.
- *
- * ## Examples
- *
- * In the following example, `Zippy` alternatively emits `open` and `close` events when its
- * title gets clicked:
- *
- * ```
- * @Component({selector: 'zippy'})
- * @View({template: `
- *
- *
Toggle
- *
- *
- *
{
-
- (value: T, index?: number, array?: T[]): boolean;
-
- }
-
-
- class WrappedException extends Error {
-
- constructor(_wrapperMessage: string, _originalException: any, _originalStack?: any, _context?: any);
-
- wrapperMessage: string;
-
- wrapperStack: any;
-
- originalException: any;
-
- originalStack: any;
-
- context: any;
-
- message: string;
-
- toString(): string;
-
- }
-
-
- /**
- * An {@link angular2/di/OpaqueToken} 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);
- * });
- *
- * ```
- */
- let APP_COMPONENT: OpaqueToken;
-
-
-
- /**
- * A DI Token representing a unique string id assigned to the application by Angular and used
- * primarily for prefixing application attributes and CSS styles when
- * {@link ViewEncapsulation#Emulated} is being used.
- *
- * If you need to avoid randomly generated value to be used as an application id, you can provide
- * a custom value via a DI binding configuring the root {@link Injector}
- * using this token.
- */
- let APP_ID: OpaqueToken;
-
-
-
- /**
- * Initialize the Angular 'platform' on the page.
- *
- * See {@link PlatformRef} for details on the Angular platform.
- *
- * # Without specified bindings
- *
- * If no bindings are specified, `platform`'s behavior depends on whether an existing
- * platform exists:
- *
- * If no platform exists, a new one will be created with the default {@link platformBindings}.
- *
- * If a platform already exists, it will be returned (regardless of what bindings it
- * was created with). This is a convenience feature, allowing for multiple applications
- * to be loaded into the same platform without awareness of each other.
- *
- * # With specified bindings
- *
- * It is also possible to specify bindings to be made in the new platform. These bindings
- * will be shared between all applications on the page. For example, an abstraction for
- * the browser cookie jar should be bound at the platform level, because there is only one
- * cookie jar regardless of how many applications on the age will be accessing it.
- *
- * If bindings are specified directly, `platform` will create the Angular platform with
- * them if a platform did not exist already. If it did exist, however, an error will be
- * thrown.
- *
- * # DOM Applications
- *
- * This version of `platform` initializes Angular to run in the UI thread, with direct
- * DOM access. Web-worker applications should call `platform` from
- * `src/web_workers/worker/application_common` instead.
- */
- function platform(bindings?: Array): PlatformRef;
-
-
-
- /**
- * The Angular platform is the entry point for Angular on a web page. Each page
- * has exactly one platform, and services (such as reflection) which are common
- * to every Angular application running on the page are bound in its scope.
- *
- * A page's platform is initialized implicitly when {@link bootstrap}() is called, or
- * explicitly by calling {@link platform}().
- */
- interface PlatformRef {
-
- /**
- * Retrieve the platform {@link Injector}, which is the parent injector for
- * every Angular application on the page and provides singleton bindings.
- */
- injector: Injector;
-
- /**
- * Instantiate a new Angular application on the page.
- *
- * # What is an application?
- *
- * Each Angular application has its own zone, change detection, compiler,
- * renderer, and other framework components. An application hosts one or more
- * root components, which can be initialized via `ApplicationRef.bootstrap()`.
- *
- * # Application Bindings
- *
- * Angular applications require numerous bindings to be properly instantiated.
- * When using `application()` to create a new app on the page, these bindings
- * must be provided. Fortunately, there are helper functions to configure
- * typical bindings, as shown in the example below.
- *
- * # Example
- * ```
- * var myAppBindings = [MyAppService];
- *
- * platform()
- * .application([applicationCommonBindings(), applicationDomBindings(), myAppBindings])
- * .bootstrap(MyTopLevelComponent);
- * ```
- * # See Also
- *
- * See the {@link bootstrap} documentation for more details.
- */
- application(bindings: Array): ApplicationRef;
-
- /**
- * Instantiate a new Angular application on the page, using bindings which
- * are only available asynchronously. One such use case is to initialize an
- * application running in a web worker.
- *
- * # Usage
- *
- * `bindingFn` is a function that will be called in the new application's zone.
- * It should return a {@link Promise} to a list of bindings to be used for the
- * new application. Once this promise resolves, the application will be
- * constructed in the same manner as a normal `application()`.
- */
- asyncApplication(bindingFn: (zone: NgZone) =>
- Promise>): Promise;
-
- /**
- * Destroy the Angular platform and all Angular applications on the page.
- */
- dispose(): void;
-
- }
-
-
- /**
- * A reference to an Angular application running on a page.
- *
- * For more about Angular applications, see the documentation for {@link bootstrap}.
- */
- interface ApplicationRef {
-
- /**
- * Register a listener to be called each time `bootstrap()` is called to bootstrap
- * a new root component.
- */
- registerBootstrapListener(listener: (ref: ComponentRef) => void): void;
-
- /**
- * Bootstrap a new component at the root level of the application.
- *
- * # Bootstrap process
- *
- * When bootstrapping a new root component into an application, Angular mounts the
- * specified application component onto DOM elements identified by the [componentType]'s
- * selector and kicks off automatic change detection to finish initializing the component.
- *
- * # Optional Bindings
- *
- * Bindings for the given component can optionally be overridden via the `bindings`
- * parameter. These bindings will only apply for the root component being added and any
- * child components under it.
- *
- * # Example
- * ```
- * var app = platform.application([applicationCommonBindings(), applicationDomBindings()];
- * app.bootstrap(FirstRootComponent);
- * app.bootstrap(SecondRootComponent, [bind(OverrideBinding).toClass(OverriddenBinding)]);
- * ```
- */
- bootstrap(componentType: Type, bindings?: Array): Promise;
-
- /**
- * Retrieve the application {@link Injector}.
- */
- injector: Injector;
-
- /**
- * Retrieve the application {@link NgZone}.
- */
- zone: NgZone;
-
- /**
- * Dispose of this application and all of its components.
- */
- dispose(): void;
-
- }
-
-
- /**
- * Construct a default set of bindings which should be included in any Angular
- * application, regardless of whether it runs on the UI thread or in a web worker.
- */
- function applicationCommonBindings(): Array;
-
-
-
- /**
- * Create an Angular zone.
- */
- function createNgZone(): NgZone;
-
-
-
- /**
- * @private
- */
- function platformCommon(bindings?: Array, initializer?: () => void): PlatformRef;
-
-
-
- /**
- * Constructs the set of bindings meant for use at the platform level.
- *
- * These are bindings that should be singletons shared among all Angular applications
- * running on the page.
- */
- function platformBindings(): Array;
-
-
-
- function bootstrap(appComponentType: /*Type*/ any, appBindings?: Array): Promise;
-
-
-
- /**
- * 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 {
-
- constructor(value: string);
-
- /**
- * 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;
-
- }
-
-
- /**
- * A service that can be used to get and set the title of a current HTML document.
- *
- * Since an Angular 2 application can't be bootstrapped on the entire HTML document (`` tag)
- * it is not possible to bind to the `text` property of the `HTMLTitleElement` elements
- * (representing the `` tag). Instead, this service can be used to set and get the current
- * title value.
- */
- class Title {
-
- /**
- * Get the title of the current HTML document.
- * @returns {string}
- */
- getTitle(): string;
-
- /**
- * Set the title of the current HTML document.
- * @param newTitle
- */
- setTitle(newTitle: string): void;
-
- }
-
-
- /**
- * Implement this interface to get notified when your directive's content has been fully
- * initialized.
- *
- * ### Example ([live demo](http://plnkr.co/edit/plamXUpsLQbIXpViZhUO?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({template: `<ng-content></ng-content>`})
- * class ParentComponent implements AfterContentInit {
- * @ContentChild(ChildComponent) contentChild: ChildComponent;
- *
- * constructor() {
- * // contentChild is not initialized yet
- * console.log(this.getMessage(this.contentChild));
- * }
- *
- * afterContentInit() {
- * // contentChild is updated after the content has been checked
- * console.log('AfterContentInit: ' + this.getMessage(this.contentChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <parent-cmp>
- * <child-cmp where="content"></child-cmp>
- * </parent-cmp>`,
- * directives: [ParentComponent, ChildComponent]
- * })
- * export class App {
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterContentInit {
-
- afterContentInit(): void;
-
- }
-
-
- /**
- * Implement this interface to get notified after every check of your directive's content.
- *
- * ### Example ([live demo](http://plnkr.co/edit/tGdrytNEKQnecIPkD7NU?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({template: `<ng-content></ng-content>`})
- * class ParentComponent implements AfterContentChecked {
- * @ContentChild(ChildComponent) contentChild: ChildComponent;
- *
- * constructor() {
- * // contentChild is not initialized yet
- * console.log(this.getMessage(this.contentChild));
- * }
- *
- * afterContentChecked() {
- * // contentChild is updated after the content has been checked
- * console.log('AfterContentChecked: ' + this.getMessage(this.contentChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <parent-cmp>
- * <button (click)="hasContent = !hasContent">Toggle content child</button>
- * <child-cmp *ng-if="hasContent" where="content"></child-cmp>
- * </parent-cmp>`,
- * directives: [NgIf, ParentComponent, ChildComponent]
- * })
- * export class App {
- * hasContent = true;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterContentChecked {
-
- afterContentChecked(): void;
-
- }
-
-
- /**
- * Implement this interface to get notified when your component's view has been fully initialized.
- *
- * ### Example ([live demo](http://plnkr.co/edit/LhTKVMEM0fkJgyp4CI1W?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({
- * template: `<child-cmp where="view"></child-cmp>`,
- * directives: [ChildComponent]
- * })
- * class ParentComponent implements AfterViewInit {
- * @ViewChild(ChildComponent) viewChild: ChildComponent;
- *
- * constructor() {
- * // viewChild is not initialized yet
- * console.log(this.getMessage(this.viewChild));
- * }
- *
- * afterViewInit() {
- * // viewChild is updated after the view has been initialized
- * console.log('afterViewInit: ' + this.getMessage(this.viewChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<parent-cmp></parent-cmp>`,
- * directives: [ParentComponent]
- * })
- * export class App {
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterViewInit {
-
- afterViewInit(): void;
-
- }
-
-
- /**
- * Implement this interface to get notified after every check of your component's view.
- *
- * ### Example ([live demo](http://plnkr.co/edit/0qDGHcPQkc25CXhTNzKU?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({
- * template: `
- * <button (click)="showView = !showView">Toggle view child</button>
- * <child-cmp *ng-if="showView" where="view"></child-cmp>`,
- * directives: [NgIf, ChildComponent]
- * })
- * class ParentComponent implements AfterViewChecked {
- * @ViewChild(ChildComponent) viewChild: ChildComponent;
- * showView = true;
- *
- * constructor() {
- * // viewChild is not initialized yet
- * console.log(this.getMessage(this.viewChild));
- * }
- *
- * afterViewChecked() {
- * // viewChild is updated after the view has been checked
- * console.log('AfterViewChecked: ' + this.getMessage(this.viewChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<parent-cmp></parent-cmp>`,
- * directives: [ParentComponent]
- * })
- * export class App {
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterViewChecked {
-
- afterViewChecked(): void;
-
- }
-
-
- /**
- * Lifecycle hooks are guaranteed to be called in the following order:
- * - `OnChanges` (if any bindings have changed),
- * - `OnInit` (after the first check only),
- * - `DoCheck`,
- * - `AfterContentInit`,
- * - `AfterContentChecked`,
- * - `AfterViewInit`,
- * - `AfterViewChecked`,
- * - `OnDestroy` (at the very end before destruction)
- * Implement this interface to get notified when any data-bound property of your directive changes.
- *
- * `onChanges` is called right after the data-bound properties have been checked and before view
- * and content children are checked if at least one of them has changed.
- *
- * The `changes` parameter contains an entry for each of the changed data-bound property. The key is
- * the property name and the value is an instance of {@link SimpleChange}.
- *
- * ### Example ([live example](http://plnkr.co/edit/AHrB6opLqHDBPkt4KpdT?p=preview)):
- *
- * ```typescript
- * @Component({selector: 'my-cmp'})
- * @View({template: `<p>myProp = {{myProp}}</p>`})
- * class MyComponent implements OnChanges {
- * @Property() myProp: any;
- *
- * onChanges(changes: {[propName: string]: SimpleChange}) {
- * console.log('onChanges - myProp = ' + changes['myProp'].currentValue);
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="value = value + 1">Change MyComponent</button>
- * <my-cmp [my-prop]="value"></my-cmp>`,
- * directives: [MyComponent]
- * })
- * export class App {
- * value = 0;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface OnChanges {
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- }
-
-
- /**
- * Implement this interface to get notified when your directive is destroyed.
- *
- * `onDestroy` callback is typically used for any custom cleanup that needs to occur when the
- * instance is destroyed
- *
- * ### Example ([live example](http://plnkr.co/edit/1MBypRryXd64v4pV03Yn?p=preview))
- *
- * ```typesript
- * @Component({selector: 'my-cmp'})
- * @View({template: `<p>my-component</p>`})
- * class MyComponent implements OnInit, OnDestroy {
- * onInit() {
- * console.log('onInit');
- * }
- *
- * onDestroy() {
- * console.log('onDestroy');
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="hasChild = !hasChild">
- * {{hasChild ? 'Destroy' : 'Create'}} MyComponent
- * </button>
- * <my-cmp *ng-if="hasChild"></my-cmp>`,
- * directives: [MyComponent, NgIf]
- * })
- * export class App {
- * hasChild = true;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * * ```
- */
- interface OnDestroy {
-
- onDestroy(): void;
-
- }
-
-
- /**
- * Implement this interface to execute custom initialization logic after your directive's
- * data-bound properties have been initialized.
- *
- * `onInit` is called right after the directive's data-bound properties have been checked for the
- * first time, and before any of its children have been checked. It is invoked only once when the
- * directive is instantiated.
- *
- * ### Example ([live example](http://plnkr.co/edit/1MBypRryXd64v4pV03Yn?p=preview))
- *
- * ```typescript
- * @Component({selector: 'my-cmp'})
- * @View({template: `<p>my-component</p>`})
- * class MyComponent implements OnInit, OnDestroy {
- * onInit() {
- * console.log('onInit');
- * }
- *
- * onDestroy() {
- * console.log('onDestroy');
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="hasChild = !hasChild">
- * {{hasChild ? 'Destroy' : 'Create'}} MyComponent
- * </button>
- * <my-cmp *ng-if="hasChild"></my-cmp>`,
- * directives: [MyComponent, NgIf]
- * })
- * export class App {
- * hasChild = true;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface OnInit {
-
- onInit(): void;
-
- }
-
-
- /**
- * Implement this interface to override the default change detection algorithm for your directive.
- *
- * `doCheck` gets called to check the changes in the directives instead of the default algorithm.
- *
- * The default change detection algorithm looks for differences by comparing bound-property values
- * by reference across change detection runs. When `DoCheck` is implemented, the default algorithm
- * is disabled and `doCheck` is responsible for checking for changes.
- *
- * Implementing this interface allows improving performance by using insights about the component,
- * its implementation and data types of its properties.
- *
- * Note that a directive should not implement both `DoCheck` and {@link OnChanges} at the same time.
- * `onChanges` would not be called when a directive implements `DoCheck`. Reaction to the changes
- * have to be handled from within the `doCheck` callback.
- *
- * Use {@link KeyValueDiffers} and {@link IterableDiffers} to add your custom check mechanisms.
- *
- * ### Example ([live demo](http://plnkr.co/edit/QpnIlF0CR2i5bcYbHEUJ?p=preview))
- *
- * In the following example `doCheck` uses an {@link IterableDiffers} to detect the updates to the
- * array `list`:
- *
- * ```typescript
- * @Component({selector: 'custom-check'})
- * @View({
- * template: `
- * <p>Changes:</p>
- * <ul>
- * <li *ng-for="#line of logs">{{line}}</li>
- * </ul>`,
- * directives: [NgFor]
- * })
- * class CustomCheckComponent implements DoCheck {
- * @Property() list: any[];
- * differ: any;
- * logs = [];
- *
- * constructor(differs: IterableDiffers) {
- * this.differ = differs.find([]).create(null);
- * }
- *
- * doCheck() {
- * var changes = this.differ.diff(this.list);
- *
- * if (changes) {
- * changes.forEachAddedItem(r => this.logs.push('added ' + r.item));
- * changes.forEachRemovedItem(r => this.logs.push('removed ' + r.item))
- * }
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="list.push(list.length)">Push</button>
- * <button (click)="list.pop()">Pop</button>
- * <custom-check [list]="list"></custom-check>`,
- * directives: [CustomCheckComponent]
- * })
- * export class App {
- * list = [];
- * }
- * ```
- */
- interface DoCheck {
-
- doCheck(): void;
-
- }
-
-
- class DirectiveResolver {
-
- /**
- * Return {@link DirectiveMetadata} for a given `Type`.
- */
- resolve(type: Type): DirectiveMetadata;
-
- }
-
-
- /**
- * Low-level service for compiling {@link Component}s into {@link ProtoViewRef ProtoViews}s, which
- * can later be used to create and render a Component instance.
- *
- * Most applications should instead use higher-level {@link DynamicComponentLoader} service, which
- * both compiles and instantiates a Component.
- */
- interface Compiler {
-
- compileInHost(componentType: Type): Promise<ProtoViewRef>;
-
- clearCache(): void;
-
- }
-
-
- /**
- * Service exposing low level API for creating, moving and destroying Views.
- *
- * Most applications should use higher-level abstractions like {@link DynamicComponentLoader} and
- * {@link ViewContainerRef} instead.
- */
- interface AppViewManager {
-
- /**
- * Returns a {@link ViewContainerRef} of the View Container at the specified location.
- */
- getViewContainer(location: ElementRef): ViewContainerRef;
-
- /**
- * Returns the {@link ElementRef} that makes up the specified Host View.
- */
- getHostElement(hostViewRef: HostViewRef): ElementRef;
-
- /**
- * Searches the Component View of the Component specified via `hostLocation` and returns the
- * {@link ElementRef} for the Element identified via a Variable Name `variableName`.
- *
- * Throws an exception if the specified `hostLocation` is not a Host Element of a Component, or if
- * variable `variableName` couldn't be found in the Component View of this Component.
- */
- getNamedElementInComponentView(hostLocation: ElementRef, variableName: string): ElementRef;
-
- /**
- * Returns the component instance for the provided Host Element.
- */
- getComponent(hostLocation: ElementRef): any;
-
- /**
- * Creates an instance of a Component and attaches it to the first element in the global View
- * (usually DOM Document) that matches the component's selector or `overrideSelector`.
- *
- * This as a low-level way to bootstrap an application and upgrade an existing Element to a
- * Host Element. Most applications should use {@link DynamicComponentLoader#loadAsRoot} instead.
- *
- * The Component and its View are created based on the `hostProtoViewRef` which can be obtained
- * by compiling the component with {@link Compiler#compileInHost}.
- *
- * Use {@link AppViewManager#destroyRootHostView} to destroy the created Component and it's Host
- * View.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- *
- * }
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<some-component></some-component>)
- * `
- * })
- * 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;
-
- /**
- * Destroys the Host View created via {@link AppViewManager#createRootHostView}.
- *
- * Along with the Host View, the Component Instance as well as all nested View and Components are
- * destroyed as well.
- */
- destroyRootHostView(hostViewRef: HostViewRef): void;
-
- /**
- * Instantiates an Embedded View based on the {@link TemplateRef `templateRef`} and inserts it
- * into the View Container specified via `viewContainerLocation` at the specified `index`.
- *
- * Returns the {@link ViewRef} for the newly created View.
- *
- * This as a low-level way to create and attach an Embedded via to a View Container. Most
- * applications should used {@link ViewContainerRef#createEmbeddedView} instead.
- *
- * Use {@link AppViewManager#destroyViewInContainer} to destroy the created Embedded View.
- */
- createEmbeddedViewInContainer(viewContainerLocation: ElementRef, index: number, templateRef: TemplateRef): ViewRef;
-
- /**
- * Instantiates a single {@link Component} and inserts its Host View into the View Container
- * found at `viewContainerLocation`. Within the container, the view will be inserted at position
- * specified via `index`.
- *
- * The component is instantiated using its {@link ProtoViewRef `protoViewRef`} which can be
- * obtained via {@link Compiler#compileInHost}.
- *
- * You can optionally specify `imperativelyCreatedInjector`, which configure the {@link Injector}
- * that will be created for the Host View.
- *
- * Returns the {@link HostViewRef} of the Host View created for the newly instantiated Component.
- *
- * Use {@link AppViewManager#destroyViewInContainer} to destroy the created Host View.
- */
- createHostViewInContainer(viewContainerLocation: ElementRef, index: number, protoViewRef: ProtoViewRef, imperativelyCreatedInjector: ResolvedBinding[]): HostViewRef;
-
- /**
- * Destroys an Embedded or Host View attached to a View Container at the specified `index`.
- *
- * The View Container is located via `viewContainerLocation`.
- */
- destroyViewInContainer(viewContainerLocation: ElementRef, index: number): void;
-
- /**
- * See {@link AppViewManager#detachViewInContainer}.
- */
- attachViewInContainer(viewContainerLocation: ElementRef, index: number, viewRef: ViewRef): ViewRef;
-
- /**
- * See {@link AppViewManager#attachViewInContainer}.
- */
- detachViewInContainer(viewContainerLocation: ElementRef, index: number): ViewRef;
-
- }
-
-
- /**
- * An unmodifiable list of items that Angular keeps up to date when the state
- * of the application changes.
- *
- * The type of object that {@link QueryMetadata} and {@link ViewQueryMetadata} provide.
- *
- * Implements an iterable interface, therefore it can be used in both ES6
- * javascript `for (var i of items)` loops as well as in Angular templates with
- * `*ng-for="#i of myList"`.
- *
- * Changes can be observed by subscribing to the changes `Observable`.
- *
- * NOTE: In the future this class will implement an `Observable` interface.
- *
- * ### Example ([live demo](http://plnkr.co/edit/RX8sJnQYl9FWuSCWme5z?p=preview))
- * ```javascript
- * @Component({...})
- * class Container {
- * constructor(@Query(Item) items: QueryList<Item>) {
- * items.changes.subscribe(_ => console.log(items.length));
- * }
- * }
- * ```
- */
- class QueryList<T> {
-
- changes: Observable;
-
- length: number;
-
- first: T;
-
- last: T;
-
- /**
- * returns a new list with the passsed in function applied to each element.
- */
- map<U>(fn: (item: T) => U): U[];
-
- toString(): string;
-
- }
-
-
- /**
- * Service for instantiating a Component and attaching it to a View at a specified location.
- */
- interface DynamicComponentLoader {
-
- /**
- * Creates an instance of a Component `type` and attaches it to the first element in the
- * platform-specific global view that matches the component's selector.
- *
- * In a browser the platform-specific global view is the main DOM Document.
- *
- * If needed, the component's selector can be overridden via `overrideSelector`.
- *
- * You can optionally provide `injector` and this {@link Injector} will be used to instantiate the
- * Component.
- *
- * To be notified when this Component instance is destroyed, you can also optionally provide
- * `onDispose` callback.
- *
- * Returns a promise for the {@link ComponentRef} representing the newly created Component.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<child id="child"></child>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, injector: ng.Injector) {
- * dynamicComponentLoader.loadAsRoot(ChildComponent, '#child', injector);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <child id="child">
- * Child
- * </child>
- * )
- * </my-app>
- * ```
- */
- loadAsRoot(type: Type, overrideSelector: string, injector: Injector, onDispose?: () => void): Promise<ComponentRef>;
-
- /**
- * Creates an instance of a Component and attaches it to a View Container located inside of the
- * Component View of another Component instance.
- *
- * The targeted Component Instance is specified via its `hostLocation` {@link ElementRef}. The
- * location within the Component View of this Component Instance is specified via `anchorName`
- * Template Variable Name.
- *
- * You can optionally provide `bindings` to configure the {@link Injector} provisioned for this
- * Component Instance.
- *
- * Returns a promise for the {@link ComponentRef} representing the newly created Component.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<div #child></div>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <div #child="" class="ng-binding"></div>
- * <child-component class="ng-binding">Child</child-component>
- * )
- * </my-app>
- * ```
- */
- loadIntoLocation(type: Type, hostLocation: ElementRef, anchorName: string, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
-
- /**
- * Creates an instance of a Component and attaches it to the View Container found at the
- * `location` specified as {@link ElementRef}.
- *
- * You can optionally provide `bindings` to configure the {@link Injector} provisioned for this
- * Component Instance.
- *
- * Returns a promise for the {@link ComponentRef} representing the newly created Component.
- *
- *
- * ## 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.loadNextToLocation(ChildComponent, elementRef);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>Parent</my-app>
- * <child-component>Child</child-component>
- * ```
- */
- loadNextToLocation(type: Type, location: ElementRef, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
-
- }
-
-
- /**
- * Represents a location in a View that has an injection, change-detection and render context
- * associated with it.
- *
- * An `ElementRef` is created for each element in the Template that contains a Directive, Component
- * or data-binding.
- *
- * An `ElementRef` is backed by a render-specific element. In the browser, this is usually a DOM
- * element.
- */
- interface ElementRef extends RenderElementRef {
-
- /**
- * The underlying native element or `null` if direct access to native elements is not supported
- * (e.g. when the application runs in a web worker).
- *
- * <div class="callout is-critical">
- * <header>Use with caution</header>
- * <p>
- * Use this API as the last resort when direct access to DOM is needed. Use templating and
- * data-binding provided by Angular instead. Alternatively you take a look at {@link Renderer}
- * which provides API that can safely be used even when direct access to native elements is not
- * supported.
- * </p>
- * <p>
- * Relying on direct DOM access creates tight coupling between your application and rendering
- * layers which will make it impossible to separate the two and deploy your application into a
- * web worker.
- * </p>
- * </div>
- */
- nativeElement: any;
-
- }
-
-
- /**
- * Represents an Embedded Template that can be used to instantiate Embedded Views.
- *
- * You can access a `TemplateRef`, in two ways. Via a directive placed on a `<template>` element (or
- * directive prefixed with `*`) and have the `TemplateRef` for this Embedded View injected into the
- * constructor of the directive using the `TemplateRef` Token. Alternatively you can query for the
- * `TemplateRef` from a Component or a Directive via {@link Query}.
- *
- * To instantiate Embedded Views based on a Template, use
- * {@link ViewContainerRef#createEmbeddedView}, which will create the View and attach it to the
- * View Container.
- */
- interface TemplateRef {
-
- /**
- * The location in the View where the Embedded View logically belongs to.
- *
- * The data-binding and injection contexts of Embedded Views created from this `TemplateRef`
- * inherit from the contexts of this location.
- *
- * Typically new Embedded Views are attached to the View Container of this location, but in
- * advanced use-cases, the View can be attached to a different container while keeping the
- * data-binding and injection context from the original location.
- */
- elementRef: ElementRef;
-
- /**
- * Allows you to check if this Embedded Template defines Local Variable with name matching `name`.
- */
- hasLocal(name: string): boolean;
-
- }
-
-
- /**
- * Represents an Angular View.
- *
- * <!-- TODO: move the next two paragraphs to the dev guide -->
- * A View is a fundamental building block of the application UI. It is the smallest grouping of
- * Elements which are created and destroyed together.
- *
- * Properties of elements in a View can change, but the structure (number and order) of elements in
- * a View cannot. Changing the structure of Elements can only be done by inserting, moving or
- * removing nested Views via a {@link ViewContainer}. Each View can contain many View Containers.
- * <!-- /TODO -->
- *
- * ## Example
- *
- * Given this template...
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * ... we have two {@link ProtoViewRef}s:
- *
- * Outer {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- *
- * The outer/inner {@link ProtoViewRef}s are then assembled into views like so:
- *
- * ```
- * <!-- ViewRef: outer-0 -->
- * Count: 2
- * <ul>
- * <template view-container-ref></template>
- * <!-- ViewRef: inner-1 --><li>first</li><!-- /ViewRef: inner-1 -->
- * <!-- ViewRef: inner-2 --><li>second</li><!-- /ViewRef: inner-2 -->
- * </ul>
- * <!-- /ViewRef: outer-0 -->
- * ```
- */
- interface ViewRef extends HostViewRef {
-
- /**
- * Sets `value` of local variable called `variableName` in this View.
- */
- setLocal(variableName: string, value: any): void;
-
- }
-
-
- /**
- * Represents a View containing a single Element that is the Host Element of a {@link Component}
- * instance.
- *
- * A Host View is created for every dynamically created Component that was compiled on its own (as
- * opposed to as a part of another Component's Template) via {@link Compiler#compileInHost} or one
- * of the higher-level APIs: {@link AppViewManager#createRootHostView},
- * {@link AppViewManager#createHostViewInContainer}, {@link ViewContainerRef#createHostView}.
- */
- interface HostViewRef {
-
- }
-
-
- /**
- * Represents an Angular ProtoView.
- *
- * A ProtoView is a prototypical {@link ViewRef View} that is the result of Template compilation and
- * is used by Angular to efficiently create an instance of this View based on the compiled Template.
- *
- * Most ProtoViews are created and used internally by Angular and you don't need to know about them,
- * except in advanced use-cases where you compile components yourself via the low-level
- * {@link Compiler#compileInHost} API.
- *
- *
- * ## Example
- *
- * Given this template:
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * Angular desugars and compiles the template into two ProtoViews:
- *
- * Outer ProtoView:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner ProtoView:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate ProtoViews.
- */
- interface ProtoViewRef {
-
- }
-
-
- /**
- * Represents a container where one or more Views can be attached.
- *
- * The container can contain two kinds of Views. Host Views, created by instantiating a
- * {@link Component} via {@link #createHostView}, and Embedded Views, created by instantiating an
- * {@link TemplateRef Embedded Template} via {@link #createEmbeddedView}.
- *
- * The location of the View Container within the containing View is specified by the Anchor
- * `element`. Each View Container can have only one Anchor Element and each Anchor Element can only
- * have a single View Container.
- *
- * Root elements of Views attached to this container become siblings of the Anchor Element in
- * the Rendered View.
- *
- * To access a `ViewContainerRef` of an Element, you can either place a {@link Directive} injected
- * with `ViewContainerRef` on the Element, or you obtain it via
- * {@link AppViewManager#getViewContainer}.
- *
- * <!-- TODO(i): we are also considering ElementRef#viewContainer api -->
- */
- interface ViewContainerRef {
-
- /**
- * Anchor element that specifies the location of this container in the containing View.
- * <!-- TODO: rename to anchorElement -->
- */
- element: ElementRef;
-
- /**
- * Destroys all Views in this container.
- */
- clear(): void;
-
- /**
- * Returns the {@link ViewRef} for the View located in this container at the specified index.
- */
- get(index: number): ViewRef;
-
- /**
- * Returns the number of Views currently attached to this container.
- */
- length: number;
-
- /**
- * Instantiates an Embedded View based on the {@link TemplateRef `templateRef`} and inserts it
- * into this container at the specified `index`.
- *
- * If `index` is not specified, the new View will be inserted as the last View in the container.
- *
- * Returns the {@link ViewRef} for the newly created View.
- */
- createEmbeddedView(templateRef: TemplateRef, index?: number): ViewRef;
-
- /**
- * Instantiates a single {@link Component} and inserts its Host View into this container at the
- * specified `index`.
- *
- * The component is instantiated using its {@link ProtoViewRef `protoView`} which can be
- * obtained via {@link Compiler#compileInHost}.
- *
- * If `index` is not specified, the new View will be inserted as the last View in the container.
- *
- * You can optionally specify `dynamicallyCreatedBindings`, which configure the {@link Injector}
- * that will be created for the Host View.
- *
- * Returns the {@link HostViewRef} of the Host View created for the newly instantiated Component.
- */
- createHostView(protoViewRef?: ProtoViewRef, index?: number, dynamicallyCreatedBindings?: ResolvedBinding[]): HostViewRef;
-
- /**
- * Inserts a View identified by a {@link ViewRef} into the container at the specified `index`.
- *
- * If `index` is not specified, the new View will be inserted as the last View in the container.
- *
- * Returns the inserted {@link ViewRef}.
- */
- insert(viewRef: ViewRef, index?: number): ViewRef;
-
- /**
- * Returns the index of the View, specified via {@link ViewRef}, within the current container or
- * `-1` if this container doesn't contain the View.
- */
- indexOf(viewRef: ViewRef): number;
-
- /**
- * Destroys a View attached to this container at the specified `index`.
- *
- * If `index` is not specified, the last View in the container will be removed.
- */
- remove(index?: number): void;
-
- /**
- * Use along with {@link #insert} to move a View within the current container.
- *
- * If the `index` param is omitted, the last {@link ViewRef} is detached.
- */
- detach(index?: number): ViewRef;
-
- }
-
-
- /**
- * Represents an instance of a Component created via {@link DynamicComponentLoader}.
- *
- * `ComponentRef` provides access to the Component Instance as well other objects related to this
- * Component Instance and allows you to destroy the Component Instance via the {@link #dispose}
- * method.
- */
- interface ComponentRef {
-
- /**
- * Location of the Host Element of this Component Instance.
- */
- location: ElementRef;
-
- /**
- * The instance of the Component.
- */
- instance: any;
-
- /**
- * The user defined component type, represented via the constructor function.
- *
- * <!-- TODO: customize wording for Dart docs -->
- */
- componentType: Type;
-
- /**
- * The {@link ViewRef} of the Host View of this Component instance.
- */
- hostView: HostViewRef;
-
- /**
- * Destroys the component instance and all of the data structures associated with it.
- *
- * TODO(i): rename to destroy to be consistent with AppViewManager and ViewContainerRef
- */
- dispose(): void;
-
- }
-
-
- /**
- * 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();
- * });
- * ```
- */
- interface LifeCycle {
-
- /**
- * 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;
-
- }
-
-
- /**
- * An injectable service for executing work inside or outside of the Angular zone.
- *
- * The most common use of this service is to optimize performance when starting a work consisting of
- * one or more asynchronous tasks that don't require UI updates or error handling to be handled by
- * Angular. Such tasks can be kicked off via {@link #runOutsideAngular} and if needed, these tasks
- * can reenter the Angular zone via {@link #run}.
- *
- * <!-- TODO: add/fix links to:
- * - docs explaining zones and the use of zones in Angular and change-detection
- * - link to runOutsideAngular/run (throughout this file!)
- * -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/lY9m8HLy7z06vDoUaSN2?p=preview))
- * ```
- * import {Component, View, NgIf, NgZone} from 'angular2/angular2';
- *
- * @Component({
- * selector: 'ng-zone-demo'
- * })
- * @View({
- * template: `
- * <h2>Demo: NgZone</h2>
- *
- * <p>Progress: {{progress}}%</p>
- * <p *ng-if="progress >= 100">Done processing {{label}} of Angular zone!</p>
- *
- * <button (click)="processWithinAngularZone()">Process within Angular zone</button>
- * <button (click)="processOutsideOfAngularZone()">Process outside of Angular zone</button>
- * `,
- * directives: [NgIf]
- * })
- * export class NgZoneDemo {
- * progress: number = 0;
- * label: string;
- *
- * constructor(private _ngZone: NgZone) {}
- *
- * // Loop inside the Angular zone
- * // so the UI DOES refresh after each setTimeout cycle
- * processWithinAngularZone() {
- * this.label = 'inside';
- * this.progress = 0;
- * this._increaseProgress(() => console.log('Inside Done!'));
- * }
- *
- * // Loop outside of the Angular zone
- * // so the UI DOES NOT refresh after each setTimeout cycle
- * processOutsideOfAngularZone() {
- * this.label = 'outside';
- * this.progress = 0;
- * this._ngZone.runOutsideAngular(() => {
- * this._increaseProgress(() => {
- * // reenter the Angular zone and display done
- * this._ngZone.run(() => {console.log('Outside Done!') });
- * }}));
- * }
- *
- *
- * _increaseProgress(doneCallback: () => void) {
- * this.progress += 1;
- * console.log(`Current progress: ${this.progress}%`);
- *
- * if (this.progress < 100) {
- * window.setTimeout(() => this._increaseProgress(doneCallback)), 10)
- * } else {
- * doneCallback();
- * }
- * }
- * }
- * ```
- */
- interface NgZone {
-
- /**
- * Executes the `fn` function synchronously within the Angular zone and returns value returned by
- * the function.
- *
- * Running functions via `run` allows you to reenter Angular zone from a task that was executed
- * outside of the Angular zone (typically started via {@link #runOutsideAngular}).
- *
- * Any future tasks or microtasks scheduled from within this function will continue executing from
- * within the Angular zone.
- */
- run(fn: () => any): any;
-
- /**
- * Executes the `fn` function synchronously in Angular's parent zone and returns value returned by
- * the function.
- *
- * Running functions via `runOutsideAngular` allows you to escape Angular's zone and do work that
- * doesn't trigger Angular change-detection or is subject to Angular's error handling.
- *
- * Any future tasks or microtasks scheduled from within this function will continue executing from
- * outside of the Angular zone.
- *
- * Use {@link #run} to reenter the Angular zone and do work that updates the application model.
- */
- runOutsideAngular(fn: () => any): any;
-
- }
-
-
- /**
- * A dispatcher that relays all events that occur in a Render View.
- *
- * Use {@link Renderer#setEventDispatcher} to register a dispatcher for a particular Render View.
- */
- interface RenderEventDispatcher {
-
- /**
- * Called when Event called `eventName` was triggered on an Element with an Event Binding for this
- * Event.
- *
- * `elementIndex` specifies the depth-first index of the Element in the Render View.
- *
- * `locals` is a map for local variable to value mapping that should be used when evaluating the
- * Event Binding expression.
- *
- * Returns `false` if `preventDefault` should be called to stop the default behavior of the Event
- * in the Rendering Context.
- */
- dispatchRenderEvent(elementIndex: number, eventName: string, locals: Map<string, any>): boolean;
-
- }
-
-
- /**
- * Injectable service that provides a low-level interface for modifying the UI.
- *
- * Use this service to bypass Angular's templating and make custom UI changes that can't be
- * expressed declaratively. For example if you need to set a property or an attribute whose name is
- * not statically known, use {@link #setElementProperty} or {@link #setElementAttribute}
- * respectively.
- *
- * If you are implementing a custom renderer, you must implement this interface.
- *
- * The default Renderer implementation is {@link DomRenderer}. Also see {@link WebWorkerRenderer}.
- */
- interface Renderer {
-
- /**
- * Registers a component template represented as arrays of {@link RenderTemplateCmd}s and styles
- * with the Renderer.
- *
- * Once a template is registered it can be referenced via {@link RenderBeginComponentCmd} when
- * {@link #createProtoView creating Render ProtoView}.
- */
- registerComponentTemplate(templateId: number, commands: RenderTemplateCmd[], styles: string[], nativeShadow: boolean): void;
-
- /**
- * Creates a {@link RenderProtoViewRef} from an array of {@link RenderTemplateCmd}`s.
- */
- createProtoView(cmds: RenderTemplateCmd[]): RenderProtoViewRef;
-
- /**
- * Creates a Root Host View based on the provided `hostProtoViewRef`.
- *
- * `fragmentCount` is the number of nested {@link RenderFragmentRef}s in this View. This parameter
- * is non-optional so that the renderer can create a result synchronously even when application
- * runs in a different context (e.g. in a Web Worker).
- *
- * `hostElementSelector` is a (CSS) selector for querying the main document to find the Host
- * Element. The newly created Root Host View should be attached to this element.
- *
- * Returns an instance of {@link RenderViewWithFragments}, representing the Render View.
- */
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
-
- /**
- * Creates a Render View based on the provided `protoViewRef`.
- *
- * `fragmentCount` is the number of nested {@link RenderFragmentRef}s in this View. This parameter
- * is non-optional so that the renderer can create a result synchronously even when application
- * runs in a different context (e.g. in a Web Worker).
- *
- * Returns an instance of {@link RenderViewWithFragments}, representing the Render View.
- */
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
-
- /**
- * Destroys a Render View specified via `viewRef`.
- *
- * This operation should be performed only on a View that has already been dehydrated and
- * all of its Render Fragments have been detached.
- *
- * Destroying a View indicates to the Renderer that this View is not going to be referenced in any
- * future operations. If the Renderer created any renderer-specific objects for this View, these
- * objects should now be destroyed to prevent memory leaks.
- */
- destroyView(viewRef: RenderViewRef): void;
-
- /**
- * Attaches the Nodes of a Render Fragment after the last Node of `previousFragmentRef`.
- */
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
-
- /**
- * Attaches the Nodes of the Render Fragment after an Element.
- */
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
-
- /**
- * Detaches the Nodes of a Render Fragment from their parent.
- *
- * This operations should be called only on a View that has been already
- * {@link #dehydrateView dehydrated}.
- */
- detachFragment(fragmentRef: RenderFragmentRef): void;
-
- /**
- * Notifies a custom Renderer to initialize a Render View.
- *
- * This method is called by Angular after a Render View has been created, or when a previously
- * dehydrated Render View is about to be reused.
- */
- hydrateView(viewRef: RenderViewRef): void;
-
- /**
- * Notifies a custom Renderer that a Render View is no longer active.
- *
- * This method is called by Angular before a Render View will be destroyed, or when a hydrated
- * Render View is about to be put into a pool for future reuse.
- */
- dehydrateView(viewRef: RenderViewRef): void;
-
- /**
- * Returns the underlying native element at the specified `location`, or `null` if direct access
- * to native elements is not supported (e.g. when the application runs in a web worker).
- *
- * <div class="callout is-critical">
- * <header>Use with caution</header>
- * <p>
- * Use this api as the last resort when direct access to DOM is needed. Use templating and
- * data-binding, or other {@link Renderer} methods instead.
- * </p>
- * <p>
- * Relying on direct DOM access creates tight coupling between your application and rendering
- * layers which will make it impossible to separate the two and deploy your application into a
- * web worker.
- * </p>
- * </div>
- */
- getNativeElementSync(location: RenderElementRef): any;
-
- /**
- * Sets a property on the Element specified via `location`.
- */
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
-
- /**
- * Sets an attribute on the Element specified via `location`.
- *
- * If `attributeValue` is `null`, the attribute is removed.
- */
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
-
- /**
- * Sets a (CSS) class on the Element specified via `location`.
- *
- * `isAdd` specifies if the class should be added or removed.
- */
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
-
- /**
- * Sets a (CSS) inline style on the Element specified via `location`.
- *
- * If `styleValue` is `null`, the style is removed.
- */
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
-
- /**
- * Calls a method on the Element specified via `location`.
- */
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
-
- /**
- * Sets the value of an interpolated TextNode at the specified index to the `text` value.
- *
- * `textNodeIndex` is the depth-first index of the Node among interpolated Nodes in the Render
- * View.
- */
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
-
- /**
- * Sets a dispatcher to relay all events triggered in the given Render View.
- *
- * Each Render View can have only one Event Dispatcher, if this method is called multiple times,
- * the last provided dispatcher will be used.
- */
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: RenderEventDispatcher): void;
-
- }
-
-
- /**
- * Represents an Element that is part of a {@link RenderViewRef Render View}.
- *
- * `RenderElementRef` is a counterpart to {@link ElementRef} available in the Application Context.
- *
- * When using `Renderer` from the Application Context, `ElementRef` can be used instead of
- * `RenderElementRef`.
- */
- interface RenderElementRef {
-
- /**
- * Reference to the Render View that contains this Element.
- */
- renderView: RenderViewRef;
-
- /**
- * Index of the Element (in the depth-first order) inside the Render View.
- *
- * This index is used internally by Angular to locate elements.
- */
- boundElementIndex: number;
-
- }
-
-
- /**
- * Represents an Angular View in the Rendering Context.
- *
- * `RenderViewRef` specifies to the {@link Renderer} what View to update or destroy.
- *
- * Unlike a {@link ViewRef} available in the Application Context, Render View contains all the
- * static Component Views that have been recursively merged into a single Render View.
- *
- * Each `RenderViewRef` contains one or more {@link RenderFragmentRef Render Fragments}, these
- * Fragments are created, hydrated, dehydrated and destroyed as a single unit together with the
- * View.
- */
- class RenderViewRef {
-
- }
-
-
- /**
- * Represents an Angular ProtoView in the Rendering Context.
- *
- * When you implement a custom {@link Renderer}, `RenderProtoViewRef` specifies what Render View
- * your renderer should create.
- *
- * `RenderProtoViewRef` is a counterpart to {@link ProtoViewRef} available in the Application
- * Context. But unlike `ProtoViewRef`, `RenderProtoViewRef` contains all static nested Proto Views
- * that are recursively merged into a single Render Proto View.
- *
- *
- * <!-- TODO: this is created by Renderer#createProtoView in the new compiler -->
- */
- interface RenderProtoViewRef {
-
- }
-
-
- /**
- * Represents a list of sibling Nodes that can be moved by the {@link Renderer} independently of
- * other Render Fragments.
- *
- * Any {@link RenderView} has one Render Fragment.
- *
- * Additionally any View with an Embedded View that contains a {@link NgContent View Projection}
- * results in additional Render Fragment.
- */
- class RenderFragmentRef {
-
- }
-
-
- /**
- * Container class produced by a {@link Renderer} when creating a Render View.
- *
- * An instance of `RenderViewWithFragments` contains a {@link RenderViewRef} and an array of
- * {@link RenderFragmentRef}s belonging to this Render View.
- */
- class RenderViewWithFragments {
-
- constructor(viewRef: RenderViewRef, fragmentRefs: RenderFragmentRef[]);
-
- /**
- * Reference to the {@link RenderViewRef}.
- */
- viewRef: RenderViewRef;
-
- /**
- * Array of {@link RenderFragmentRef}s ordered in the depth-first order.
- */
- fragmentRefs: RenderFragmentRef[];
-
- }
-
-
- /**
- * A DI Token representing the main rendering context. In a browser this is the DOM Document.
- *
- * Note: Document might not be available in the Application Context when Application and Rendering
- * Contexts are not the same (e.g. when running the application into a Web Worker).
- */
- let DOCUMENT: OpaqueToken;
-
-
-
- interface RenderTemplateCmd {
-
- visit(visitor: RenderCommandVisitor, context: any): any;
-
- }
-
-
- interface RenderCommandVisitor {
-
- visitText(cmd: RenderTextCmd, context: any): any;
-
- visitNgContent(cmd: RenderNgContentCmd, context: any): any;
-
- visitBeginElement(cmd: RenderBeginElementCmd, context: any): any;
-
- visitEndElement(context: any): any;
-
- visitBeginComponent(cmd: RenderBeginComponentCmd, context: any): any;
-
- visitEndComponent(context: any): any;
-
- visitEmbeddedTemplate(cmd: RenderEmbeddedTemplateCmd, context: any): any;
-
- }
-
-
- interface RenderTextCmd extends RenderBeginCmd {
-
- value: string;
-
- }
-
-
- interface RenderNgContentCmd {
-
- ngContentIndex: number;
-
- }
-
-
- interface RenderBeginElementCmd extends RenderBeginCmd {
-
- name: string;
-
- attrNameAndValues: string[];
-
- eventTargetAndNames: string[];
-
- }
-
-
- interface RenderBeginComponentCmd extends RenderBeginElementCmd {
-
- nativeShadow: boolean;
-
- templateId: number;
-
- }
-
-
- interface RenderEmbeddedTemplateCmd extends RenderBeginElementCmd {
-
- isMerged: boolean;
-
- children: RenderTemplateCmd[];
-
- }
-
-
- interface RenderBeginCmd extends RenderTemplateCmd {
-
- ngContentIndex: number;
-
- isBound: boolean;
-
- }
-
-
- /**
- * 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:
- *
- * ```
- * <div class="message" [ng-class]="{error: errorCount > 0}">
- * Please check errors.
- * </div>
- * ```
- */
- class NgClass implements DoCheck, OnDestroy {
-
- constructor(_iterableDiffers: IterableDiffers, _keyValueDiffers: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer);
-
- 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, and also to alias the 'last' to a local variable that will
- * be set to a boolean indicating if the item is the last one in the iteration
- *
- * 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
- *
- * ```
- * <ul>
- * <li *ng-for="#error of errors; #i = index">
- * Error {{i}} of {{errors.length}}: {{error.message}}
- * </li>
- * </ul>
- * ```
- *
- * # Syntax
- *
- * - `<li *ng-for="#item of items; #i = index">...</li>`
- * - `<li template="ng-for #item of items; #i = index">...</li>`
- * - `<template ng-for #item [ng-for-of]="items" #i="index"><li>...</li></template>`
- */
- class NgFor implements DoCheck {
-
- constructor(_viewContainer: ViewContainerRef, _templateRef: TemplateRef, _iterableDiffers: IterableDiffers, _cdr: ChangeDetectorRef);
-
- ngForOf: any;
-
- doCheck(): void;
-
- }
-
-
- /**
- * 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 ([live demo](http://plnkr.co/edit/fe0kgemFBtmQOY31b4tw?p=preview)):
- *
- * ```
- * <div *ng-if="errorCount > 0" class="error">
- * <!-- Error message displayed when the errorCount property on the current context is greater
- * than 0. -->
- * {{errorCount}} errors detected
- * </div>
- * ```
- *
- * # Syntax
- *
- * - `<div *ng-if="condition">...</div>`
- * - `<div template="ng-if condition">...</div>`
- * - `<template [ng-if]="condition"><div>...</div></template>`
- */
- class NgIf {
-
- constructor(_viewContainer: ViewContainerRef, _templateRef: TemplateRef);
-
- ngIf: any;
-
- }
-
-
- /**
- * 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:
- *
- * ```
- * <div [ng-style]="{'text-align': alignExp}"></div>
- * ```
- *
- * In the above example the `text-align` style will be updated based on the `alignExp` value
- * changes.
- *
- * # Syntax
- *
- * - `<div [ng-style]="{'text-align': alignExp}"></div>`
- * - `<div [ng-style]="styleExp"></div>`
- */
- class NgStyle implements DoCheck {
-
- constructor(_differs: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer);
-
- rawStyle: any;
-
- doCheck(): 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:
- *
- * ```
- * <ANY [ng-switch]="expression">
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template ng-switch-default>...</template>
- * </ANY>
- * ```
- */
- 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
- * <template [ng-switch-when]="contextVariable">...</template>
- *
- * // match against a constant string
- * <template ng-switch-when="stringValue">...</template>
- * ```
- */
- class NgSwitchWhen {
-
- constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef, _switch: NgSwitch);
-
- ngSwitchWhen: any;
-
- }
-
-
- /**
- * Defines a default case statement.
- *
- * Default case statements are displayed when no `NgSwitchWhen` match the `ng-switch` value.
- *
- * Example:
- *
- * ```
- * <template ng-switch-default>...</template>
- * ```
- */
- class NgSwitchDefault {
-
- constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef, sswitch: NgSwitch);
-
- }
-
-
- /**
- * A collection of 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 `directives`
- * property of the `@View` annotation.
- *
- * ### Example ([live demo](http://plnkr.co/edit/yakGwpCdUkg0qfzX5m8g?p=preview))
- *
- * Instead of writing:
- *
- * ```typescript
- * 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:
- *
- * ```typescript
- * 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 {
- * ...
- * }
- * ```
- */
- let CORE_DIRECTIVES: Type[];
-
-
-
- /**
- * Omitting from external API doc as this is really an abstract internal concept.
- */
- class AbstractControl {
-
- constructor(validator: Function);
-
- validator: Function;
-
- value: any;
-
- status: string;
-
- valid: boolean;
-
- errors: {[key: string]: any};
-
- 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 | number>| 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`s have values and
- * validation state, which is determined by an optional validation function.
- *
- * `Control` is one of the three fundamental building blocks used to define forms in Angular, along
- * with {@link ControlGroup} and {@link ControlArray}.
- *
- * # Usage
- *
- * By default, a `Control` is created for every `<input>` or other form component.
- * With {@link NgFormControl} or {@link NgFormModel} an existing {@link Control} can be
- * bound to a DOM element instead. This `Control` can be configured with a custom
- * validation function.
- *
- * ### Example ([live demo](http://plnkr.co/edit/23DESOpbNnBpBHZt1BR4?p=preview))
- */
- class Control extends AbstractControl {
-
- constructor(value?: any, validator?: Function);
-
- /**
- * Set the value of the control to `value`.
- *
- * If `onlySelf` is `true`, this change will only affect the validation of this `Control`
- * and not its parent component. If `emitEvent` is `true`, this change will cause a
- * `valueChanges` event on the `Control` to be emitted. Both of these options default to
- * `false`.
- *
- * If `emitModelToViewChange` is `true`, the view will be notified about the new value
- * via an `onChange` event. This is the default behavior if `emitModelToViewChange` is not
- * specified.
- */
- updateValue(value: any, {onlySelf, emitEvent, emitModelToViewChange}?:
- {onlySelf?: boolean, emitEvent?: boolean, emitModelToViewChange?: boolean}): void;
-
- /**
- * Register a listener for change events.
- */
- 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.
- *
- * ### Example ([live demo](http://plnkr.co/edit/23DESOpbNnBpBHZt1BR4?p=preview))
- */
- class ControlGroup extends AbstractControl {
-
- constructor(controls: {[key: string]: AbstractControl}, optionals?: {[key: string]: boolean}, validator?: Function);
-
- controls: {[key: string]: AbstractControl};
-
- addControl(name: string, control: 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.
- *
- * # Adding or removing controls
- *
- * To change the controls in the array, use the `push`, `insert`, or `removeAt` methods
- * in `ControlArray` itself. These methods ensure the controls are properly tracked in the
- * form's hierarchy. Do not modify the array of `AbstractControl`s used to instantiate
- * the `ControlArray` directly, as that will result in strange and unexpected behavior such
- * as broken change detection.
- *
- * ### Example ([live demo](http://plnkr.co/edit/23DESOpbNnBpBHZt1BR4?p=preview))
- */
- class ControlArray extends AbstractControl {
-
- constructor(controls: AbstractControl[], validator?: Function);
-
- controls: AbstractControl[];
-
- /**
- * Get the {@link AbstractControl} at the given `index` in the array.
- */
- at(index: number): AbstractControl;
-
- /**
- * Insert a new {@link AbstractControl} at the end of the array.
- */
- push(control: AbstractControl): void;
-
- /**
- * Insert a new {@link AbstractControl} at the given `index` in the array.
- */
- insert(index: number, control: AbstractControl): void;
-
- /**
- * Remove the control at the given `index` in the array.
- */
- removeAt(index: number): void;
-
- /**
- * Get the length of the control array.
- */
- length: number;
-
- }
-
-
- class AbstractControlDirective {
-
- control: AbstractControl;
-
- value: any;
-
- valid: boolean;
-
- errors: {[key: string]: any};
-
- 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 multiple {@link 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: `
- * <form #f="form" (submit)='onLogIn(f.value)'>
- * Login <input type='text' ng-control='login' #l="form">
- * <div *ng-if="!l.valid">Login is invalid</div>
- *
- * Password <input type='password' ng-control='password'>
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * onLogIn(value): void {
- * // 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: `
- * <form (submit)='onLogIn()'>
- * Login <input type='text' ng-control='login' [(ng-model)]="credentials.login">
- * Password <input type='password' ng-control='password'
- * [(ng-model)]="credentials.password">
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * credentials: {login:string, password:string};
- *
- * onLogIn(): void {
- * // this.credentials.login === "some login"
- * // this.credentials.password === "some password"
- * }
- * }
- * ```
- */
- class NgControlName extends NgControl implements OnChanges,
- OnDestroy {
-
- constructor(parent: ControlContainer, validators: Function[], valueAccessors: ControlValueAccessor[]);
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- validators: Function[];
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- onDestroy(): void;
-
- viewToModelUpdate(newValue: any): void;
-
- path: string[];
-
- formDirective: any;
-
- control: Control;
-
- validator: Function;
-
- }
-
-
- /**
- * Binds an existing {@link Control} to a DOM element.
- *
- * ### Example ([live demo](http://plnkr.co/edit/jcQlZ2tTh22BZZ2ucNAT?p=preview))
- *
- * 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.
- *
- * ```typescript
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: `
- * <div>
- * <h2>NgFormControl Example</h2>
- * <form>
- * <p>Element with existing control: <input type="text"
- * [ng-form-control]="loginControl"></p>
- * <p>Value of existing control: {{loginControl.value}}</p>
- * </form>
- * </div>
- * `,
- * directives: [CORE_DIRECTIVES, FORM_DIRECTIVES]
- * })
- * export class App {
- * loginControl: Control = new Control('');
- * }
- * ```
- *
- * # ng-model
- *
- * We can also use `ng-model` to bind a domain model to the form.
- *
- * ### Example ([live demo](http://plnkr.co/edit/yHMLuHO7DNgT8XvtjTDH?p=preview))
- *
- * ```typescript
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<input type='text' [ng-form-control]='loginControl' [(ng-model)]='login'>"
- * })
- * class LoginComp {
- * loginControl: Control = new Control('');
- * login:string;
- * }
- * ```
- */
- class NgFormControl extends NgControl implements OnChanges {
-
- constructor(validators: Function[], valueAccessors: ControlValueAccessor[]);
-
- form: Control;
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- validators: Function[];
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- path: string[];
-
- control: Control;
-
- validator: Function;
-
- viewToModelUpdate(newValue: any): void;
-
- }
-
-
- /**
- * Binds a domain model to a form control.
- *
- * # Usage
- *
- * `ng-model` binds an existing domain model to a form control. For a
- * two-way binding, use `[(ng-model)]` to ensure the model updates in
- * both directions.
- *
- * ### Example ([live demo](http://plnkr.co/edit/R3UX5qDaUqFO2VYR0UzH?p=preview))
- * ```typescript
- * @Component({selector: "search-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `<input type='text' [(ng-model)]="searchQuery">`
- * })
- * class SearchComp {
- * searchQuery: string;
- * }
- * ```
- */
- class NgModel extends NgControl implements OnChanges {
-
- constructor(validators: Function[], valueAccessors: ControlValueAccessor[]);
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- validators: Function[];
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- control: Control;
-
- path: string[];
-
- validator: Function;
-
- viewToModelUpdate(newValue: any): void;
-
- }
-
-
- /**
- * A base 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: `
- * <form #f="form" (submit)='onSignUp(f.value)'>
- * <div ng-control-group='credentials' #credentials="form">
- * Login <input type='text' ng-control='login'>
- * Password <input type='password' ng-control='password'>
- * </div>
- * <div *ng-if="!credentials.valid">Credentials are invalid</div>
- *
- * <div ng-control-group='personal'>
- * Name <input type='text' ng-control='name'>
- * </div>
- * <button type='submit'>Sign Up!</button>
- * </form>
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {
- * // personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgControlGroup extends ControlContainer implements OnInit,
- OnDestroy {
-
- constructor(_parent: ControlContainer);
-
- onInit(): void;
-
- onDestroy(): void;
-
- control: ControlGroup;
-
- path: string[];
-
- formDirective: Form;
-
- }
-
-
- /**
- * Binds an existing control group to a DOM element.
- *
- * ### Example ([live demo](http://plnkr.co/edit/jqrVirudY8anJxTMUjTP?p=preview))
- *
- * 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.
- *
- * ```typescript
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: `
- * <div>
- * <h2>NgFormModel Example</h2>
- * <form [ng-form-model]="loginForm">
- * <p>Login: <input type="text" ng-control="login"></p>
- * <p>Password: <input type="password" ng-control="password"></p>
- * </form>
- * <p>Value:</p>
- * <pre>{{value}}</pre>
- * </div>
- * `,
- * directives: [FORM_DIRECTIVES]
- * })
- * export class App {
- * loginForm: ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * get value(): string {
- * return JSON.stringify(this.loginForm.value, null, 2);
- * }
- * }
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```typescript
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form [ng-form-model]='loginForm'>
- * Login <input type='text' ng-control='login' [(ng-model)]='credentials.login'>
- * Password <input type='password' ng-control='password'
- * [(ng-model)]='credentials.password'>
- * <button (click)="onLogin()">Login</button>
- * </form>`
- * })
- * class LoginComp {
- * credentials: {login: string, password: string};
- * loginForm: ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin(): void {
- * // this.credentials.login === 'some login'
- * // this.credentials.password === 'some password'
- * }
- * }
- * ```
- */
- class NgFormModel extends ControlContainer implements Form,
- OnChanges {
-
- 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;
-
- }
-
-
- /**
- * If `NgForm` is bound in a component, `<form>` elements in that component will be
- * upgraded to use the Angular form system.
- *
- * # Typical Use
- *
- * Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation
- * to use `NgForm` and its associated controls.
- *
- * # Structure
- *
- * An Angular form is a collection of {@link Control}s in some hierarchy.
- * `Control`s can be at the top level or can be organized in {@link ControlGroups}
- * or {@link ControlArray}s. This hierarchy is reflected in the form's `value`, a
- * JSON object that mirrors the form structure.
- *
- * # Submission
- *
- * The `ng-submit` event signals when the user triggers a form submission.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ltdgYj4P0iY64AR71EpL?p=preview))
- *
- * ```typescript
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: `
- * <div>
- * <p>Submit the form to see the data object Angular builds</p>
- * <h2>NgForm demo</h2>
- * <form #f="form" (ng-submit)="onSubmit(f.value)">
- * <h3>Control group: credentials</h3>
- * <div ng-control-group="credentials">
- * <p>Login: <input type="text" ng-control="login"></p>
- * <p>Password: <input type="password" ng-control="password"></p>
- * </div>
- * <h3>Control group: person</h3>
- * <div ng-control-group="person">
- * <p>First name: <input type="text" ng-control="firstName"></p>
- * <p>Last name: <input type="text" ng-control="lastName"></p>
- * </div>
- * <button type="submit">Submit Form</button>
- * <p>Form data submitted:</p>
- * </form>
- * <pre>{{data}}</pre>
- * </div>
- * `,
- * directives: [CORE_DIRECTIVES, FORM_DIRECTIVES]
- * })
- * export class App {
- * constructor() {}
- *
- * data: string;
- *
- * onSubmit(data) {
- * this.data = JSON.stringify(data, null, 2);
- * }
- * }
- * ```
- */
- class NgForm extends ControlContainer implements Form {
-
- form: ControlGroup;
-
- ngSubmit: any;
-
- formDirective: Form;
-
- control: ControlGroup;
-
- path: string[];
-
- controls: {[key: string]: AbstractControl};
-
- 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
- * ```
- * <input type="text" [(ng-model)]="searchQuery">
- * ```
- */
- class DefaultValueAccessor implements ControlValueAccessor {
-
- constructor(_renderer: Renderer, _elementRef: ElementRef);
-
- onChange: any;
-
- onTouched: any;
-
- writeValue(value: any): void;
-
- registerOnChange(fn: (_: any) => void): void;
-
- registerOnTouched(fn: () => void): void;
-
- }
-
-
- class NgControlStatus {
-
- constructor(cd: NgControl);
-
- ngClassUntouched: boolean;
-
- ngClassTouched: boolean;
-
- ngClassPristine: boolean;
-
- ngClassDirty: boolean;
-
- ngClassValid: boolean;
-
- ngClassInvalid: boolean;
-
- }
-
-
- /**
- * The accessor for writing a value and listening to changes on a checkbox input element.
- *
- * # Example
- * ```
- * <input type="checkbox" [ng-control]="rememberLogin">
- * ```
- */
- class CheckboxControlValueAccessor implements ControlValueAccessor {
-
- constructor(_renderer: Renderer, _elementRef: ElementRef);
-
- onChange: any;
-
- onTouched: any;
-
- writeValue(value: any): void;
-
- registerOnChange(fn: (_: any) => {}): void;
-
- registerOnTouched(fn: () => {}): void;
-
- }
-
-
- /**
- * Marks `<option>` as dynamic, so Angular can be notified when options change.
- *
- * #Example:
- *
- * ```
- * <select ng-control="city">
- * <option *ng-for="#c of cities" [value]="c"></option>
- * </select>
- * ```
- */
- class NgSelectOption {
-
- }
-
-
- /**
- * The accessor for writing a value and listening to changes on a select element.
- */
- class SelectControlValueAccessor implements ControlValueAccessor {
-
- constructor(_renderer: Renderer, _elementRef: ElementRef, query: QueryList<NgSelectOption>);
-
- value: string;
-
- onChange: any;
-
- onTouched: any;
-
- writeValue(value: any): void;
-
- 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.
- *
- * ### Example:
- *
- * ```typescript
- * @View({
- * directives: [FORM_DIRECTIVES]
- * })
- * @Component({
- * selector: 'my-app'
- * })
- * class MyApp {}
- * ```
- */
- let FORM_DIRECTIVES: Type[];
-
-
-
- let NG_VALIDATORS: OpaqueToken;
-
-
-
- /**
- * Provides a set of validators used by form controls.
- *
- * # Example
- *
- * ```
- * var loginControl = new Control("", Validators.required)
- * ```
- */
- class Validators {
-
- static required(control:Control): {[key: string]: boolean};
-
- static nullValidator(c: any): {[key: string]: boolean};
-
- static compose(validators: Function[]): Function;
-
- static group(group:ControlGroup): {[key: string]: any[]};
-
- static array(array:ControlArray): {[key: string]: any[]};
-
- }
-
-
- class DefaultValidators {
-
- }
-
-
- /**
- * 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/core';
- *
- * @Component({
- * selector: 'login-comp',
- * viewBindings: [FormBuilder]
- * })
- * @View({
- * template: `
- * <form [control-group]="loginForm">
- * Login <input control="login">
- *
- * <div control-group="passwordRetry">
- * Password <input type="password" control="password">
- * Confirm password <input type="password" control="passwordConfirmation">
- * </div>
- * </form>
- * `,
- * 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: {[key: string]: any}, extra?: {[key: string]: any}): ControlGroup;
-
- control(value: Object, validator?: Function): Control;
-
- array(controlsConfig: any[], validator?: Function): ControlArray;
-
- }
-
-
- /**
- * Shorthand set of bindings used for building Angular forms.
- *
- * ### Example:
- *
- * ```typescript
- * bootstrap(MyApp, [FORM_BINDINGS]);
- * ```
- */
- let FORM_BINDINGS: Type[];
-
-
-
- function inspectNativeElement(element: any): DebugElement;
-
-
-
- let ELEMENT_PROBE_BINDINGS: any[];
-
-
-
- /**
- * A DebugElement contains information from the Angular compiler about an
- * element and provides access to the corresponding ElementInjector and
- * underlying DOM Element, as well as a way to query for children.
- */
- interface DebugElement {
-
- componentInstance: any;
-
- nativeElement: any;
-
- elementRef: ElementRef;
-
- getDirectiveInstance(directiveIndex: number): any;
-
- /**
- * Get child DebugElements from within the Light DOM.
- *
- * @return {DebugElement[]}
- */
- children: DebugElement[];
-
- /**
- * Get the root DebugElement children of a component. Returns an empty
- * list if the current DebugElement is not a component root.
- *
- * @return {DebugElement[]}
- */
- componentViewChildren: DebugElement[];
-
- triggerEventHandler(eventName: string, eventObj: Event): void;
-
- hasDirective(type: Type): boolean;
-
- inject(type: Type): any;
-
- getLocal(name: string): any;
-
- /**
- * Return the first descendant TestElement matching the given predicate
- * and scope.
- *
- * @param {Function: boolean} predicate
- * @param {Scope} scope
- *
- * @return {DebugElement}
- */
- query(predicate: Predicate<DebugElement>, scope?: Function): DebugElement;
-
- /**
- * Return descendant TestElememts matching the given predicate
- * and scope.
- *
- * @param {Function: boolean} predicate
- * @param {Scope} scope
- *
- * @return {DebugElement[]}
- */
- queryAll(predicate: Predicate<DebugElement>, scope?: Function): DebugElement[];
-
- }
-
-
- /**
- * Returns a DebugElement for a ElementRef.
- *
- * @param {ElementRef}: elementRef
- * @return {DebugElement}
- */
- function inspectElement(elementRef: ElementRef): DebugElement;
-
-
-
- function asNativeElements(arr: DebugElement[]): any[];
-
-
-
- class Scope {
-
- static all(debugElement: DebugElement): DebugElement[];
-
- static light(debugElement: DebugElement): DebugElement[];
-
- static view(debugElement: DebugElement): DebugElement[];
-
- }
-
-
- class By {
-
- static all(): Function;
-
- static css(selector: string): Predicate<DebugElement>;
-
- static directive(type: Type): Predicate<DebugElement>;
-
- }
-
-
- 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.
- *
- * This exception is only thrown in dev mode.
- *
- * <!-- TODO: Add a link once the dev mode option is configurable -->
- *
- * ### Example
- *
- * ```typescript
- * @Component({selector: 'parent'})
- * @View({
- * template: `
- * <child [prop]="parentProp"></child>
- * `,
- * directives: [forwardRef(() => Child)]
- * })
- * class Parent {
- * parentProp = "init";
- * }
- *
- * @Directive({selector: 'child', inputs: ['prop']})
- * class Child {
- * constructor(public parent: Parent) {}
- *
- * set prop(v) {
- * // this updates the parent property, which is disallowed during change detection
- * // this will result in ExpressionChangedAfterItHasBeenCheckedException
- * this.parent.parentProp = "updated";
- * }
- * }
- * ```
- */
- class ExpressionChangedAfterItHasBeenCheckedException extends BaseException {
-
- constructor(exp: string, oldValue: any, currValue: any, context: any);
-
- }
-
-
- /**
- * Thrown when an expression evaluation raises an exception.
- *
- * This error wraps the original exception to attach additional contextual information that can
- * be useful for debugging.
- *
- * ### Example ([live demo](http://plnkr.co/edit/2Kywoz?p=preview))
- *
- * ```typescript
- * @Directive({selector: 'child', inputs: ['prop']})
- * class Child {
- * prop;
- * }
- *
- * @Component({
- * selector: 'app'
- * })
- * @View({
- * template: `
- * <child [prop]="field.first"></child>
- * `,
- * directives: [Child]
- * })
- * class App {
- * field = null;
- * }
- *
- * bootstrap(App);
- * ```
- *
- * You can access the original exception and stack through the `originalException` and
- * `originalStack` properties.
- */
- class ChangeDetectionError extends WrappedException {
-
- constructor(exp: string, originalException: any, originalStack: any, context: any);
-
- /**
- * Information about the expression that triggered the exception.
- */
- location: string;
-
- }
-
-
- /**
- * Reference to a component's change detection object.
- */
- interface ChangeDetectorRef {
-
- /**
- * Marks all {@link OnPush} ancestors as to be checked.
- *
- * <!-- TODO: Add a link to a chapter on OnPush components -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/GC512b?p=preview))
- *
- * ```typescript
- * @Component({selector: 'cmp', changeDetection: ChangeDetectionStrategy.OnPush})
- * @View({template: `Number of ticks: {{numberOfTicks}}`})
- * class Cmp {
- * numberOfTicks = 0;
- *
- * constructor(ref: ChangeDetectorRef) {
- * setInterval(() => {
- * this.numberOfTicks ++
- * // the following is required, otherwise the view will not be updated
- * this.ref.markForCheck();
- * }, 1000);
- * }
- * }
- *
- * @Component({
- * selector: 'app',
- * changeDetection: ChangeDetectionStrategy.OnPush
- * })
- * @View({
- * template: `
- * <cmp><cmp>
- * `,
- * directives: [Cmp]
- * })
- * class App {
- * }
- *
- * bootstrap(App);
- * ```
- */
- markForCheck(): void;
-
- /**
- * Detaches the change detector from the change detector tree.
- *
- * The detached change detector will not be checked until it is reattached.
- *
- * This can also be used in combination with {@link detectChanges} to implement local change
- * detection checks.
- *
- * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
- * <!-- TODO: Add a live demo once ref.detectChanges is merged into master -->
- *
- * ### Example
- *
- * The following example defines a component with a large list of readonly data.
- * Imagine the data changes constantly, many times per second. For performance reasons,
- * we want to check and update the list every five seconds. We can do that by detaching
- * the component's change detector and doing a local check every five seconds.
- *
- * ```typescript
- * class DataProvider {
- * // in a real application the returned data will be different every time
- * get data() {
- * return [1,2,3,4,5];
- * }
- * }
- *
- * @Component({selector: 'giant-list'})
- * @View({
- * template: `
- * <li *ng-for="#d of dataProvider.data">Data {{d}}</lig>
- * `,
- * directives: [NgFor]
- * })
- * class GiantList {
- * constructor(private ref: ChangeDetectorRef, private dataProvider:DataProvider) {
- * ref.detach();
- * setInterval(() => {
- * this.ref.detectChanges();
- * }, 5000);
- * }
- * }
- *
- * @Component({
- * selector: 'app', bindings: [DataProvider]
- * })
- * @View({
- * template: `
- * <giant-list><giant-list>
- * `,
- * directives: [GiantList]
- * })
- * class App {
- * }
- *
- * bootstrap(App);
- * ```
- */
- detach(): void;
-
- /**
- * Checks the change detector and its children.
- *
- * This can also be used in combination with {@link detach} to implement local change detection
- * checks.
- *
- * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
- * <!-- TODO: Add a live demo once ref.detectChanges is merged into master -->
- *
- * ### Example
- *
- * The following example defines a component with a large list of readonly data.
- * Imagine, the data changes constantly, many times per second. For performance reasons,
- * we want to check and update the list every five seconds.
- *
- * We can do that by detaching the component's change detector and doing a local change detection
- * check
- * every five seconds.
- *
- * See {@link detach} for more information.
- */
- detectChanges(): void;
-
- /**
- * Reattach the change detector to the change detector tree.
- *
- * This also marks OnPush ancestors as to be checked. This reattached change detector will be
- * checked during the next change detection run.
- *
- * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/aUhZha?p=preview))
- *
- * The following example creates a component displaying `live` data. The component will detach
- * its change detector from the main change detector tree when the component's live property
- * is set to false.
- *
- * ```typescript
- * class DataProvider {
- * data = 1;
- *
- * constructor() {
- * setInterval(() => {
- * this.data = this.data * 2;
- * }, 500);
- * }
- * }
- *
- * @Component({selector: 'live-data', inputs: ['live']})
- * @View({
- * template: `Data: {{dataProvider.data}}`
- * })
- * class LiveData {
- * constructor(private ref: ChangeDetectorRef, private dataProvider:DataProvider) {}
- *
- * set live(value) {
- * if (value)
- * this.ref.reattach();
- * else
- * this.ref.detach();
- * }
- * }
- *
- * @Component({
- * selector: 'app',
- * bindings: [DataProvider]
- * })
- * @View({
- * template: `
- * Live Update: <input type="checkbox" [(ng-model)]="live">
- * <live-data [live]="live"><live-data>
- * `,
- * directives: [LiveData, FORM_DIRECTIVES]
- * })
- * class App {
- * live = true;
- * }
- *
- * bootstrap(App);
- * ```
- */
- 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 {
-
- constructor(wrapped: any);
-
- static wrap(value: any): WrappedValue;
-
- wrapped: any;
-
- }
-
-
- class SimpleChange {
-
- constructor(previousValue: any, currentValue: any);
-
- previousValue: any;
-
- currentValue: any;
-
- isFirstChange(): boolean;
-
- }
-
-
- /**
- * To create a Pipe, you must implement this interface.
- *
- * Angular invokes the `transform` method with the value of a binding
- * as the first argument, and any parameters as the second argument in list form.
- *
- * ## Syntax
- *
- * `value | pipeName[:arg0[:arg1...]]`
- *
- * ### Example ([live demo](http://plnkr.co/edit/f5oyIked9M2cKzvZNKHV?p=preview))
- *
- * The `RepeatPipe` below repeats the value as many times as indicated by the first argument:
- *
- * ```
- * import {Pipe, PipeTransform} from 'angular2/angular2';
- *
- * @Pipe({name: 'repeat'})
- * export class RepeatPipe implements PipeTransform {
- * transform(value: any, args: any[] = []) {
- * if (args.length == 0) {
- * throw new Error('repeat pipe requires one argument');
- * }
- * let times: number = args[0];
- * return value.repeat(times);
- * }
- * }
- * ```
- *
- * Invoking `{{ 'ok' | repeat:3 }}` in a template produces `okokok`.
- */
- interface PipeTransform {
-
- transform(value: any, args: any[]): any;
-
- }
-
-
- /**
- * To create a stateful Pipe, you should implement this interface.
- *
- * A stateful pipe may produce different output, given the same input. It is
- * likely that a stateful pipe may contain state that should be cleaned up when
- * a binding is destroyed. For example, a subscription to a stream of data may need to
- * be disposed, or an interval may need to be cleared.
- *
- * ### Example ([live demo](http://plnkr.co/edit/hlaejwQAmWayxwc5YXQE?p=preview))
- *
- * In this example, a pipe is created to countdown its input value, updating it every
- * 50ms. Because it maintains an internal interval, it automatically clears
- * the interval when the binding is destroyed or the countdown completes.
- *
- * ```
- * import {Pipe, PipeTransform} from 'angular2/angular2'
- * @Pipe({name: 'countdown'})
- * class CountDown implements PipeTransform, PipeOnDestroy {
- * remainingTime:Number;
- * interval:SetInterval;
- * onDestroy() {
- * if (this.interval) {
- * clearInterval(this.interval);
- * }
- * }
- * transform(value: any, args: any[] = []) {
- * if (!parseInt(value, 10)) return null;
- * if (typeof this.remainingTime !== 'number') {
- * this.remainingTime = parseInt(value, 10);
- * }
- * if (!this.interval) {
- * this.interval = setInterval(() => {
- * this.remainingTime-=50;
- * if (this.remainingTime <= 0) {
- * this.remainingTime = 0;
- * clearInterval(this.interval);
- * delete this.interval;
- * }
- * }, 50);
- * }
- * return this.remainingTime;
- * }
- * }
- * ```
- *
- * Invoking `{{ 10000 | countdown }}` would cause the value to be decremented by 50,
- * every 50ms, until it reaches 0.
- */
- interface PipeOnDestroy {
-
- onDestroy(): void;
-
- }
-
-
- /**
- * A repository of different iterable diffing strategies used by NgFor, NgClass, and others.
- */
- class IterableDiffers {
-
- constructor(factories: IterableDifferFactory[]);
-
- 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 {
-
- constructor(factories: KeyValueDifferFactory[]);
-
- 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;
-
- }
-
-
- /**
- * 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: <T>(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 ResolvedBinding: InjectableReference;
-
-
-
- var InstantiationError: InjectableReference;
-
-
-
- var PlatformRef: InjectableReference;
-
-
-
- var ApplicationRef: InjectableReference;
-
-
-
- var Compiler: InjectableReference;
-
-
-
- var AppViewManager: InjectableReference;
-
-
-
- var DynamicComponentLoader: InjectableReference;
-
-
-
- var ElementRef: InjectableReference;
-
-
-
- var TemplateRef: InjectableReference;
-
-
-
- var ViewRef: InjectableReference;
-
-
-
- var ProtoViewRef: InjectableReference;
-
-
-
- var ViewContainerRef: InjectableReference;
-
-
-
- var ComponentRef: InjectableReference;
-
-
-
- var LifeCycle: InjectableReference;
-
-
-
- var NgZone: InjectableReference;
-
-
-
- var Renderer: InjectableReference;
-
-
-
- var RenderProtoViewRef: InjectableReference;
-
-
-
- var DebugElement: InjectableReference;
-
-
-
- var ChangeDetectorRef: InjectableReference;
-
-
-
-}
-
-declare module "angular2/angular2" {
- export = ng;
-}
-
-
-
-declare module ngWorker {
- /**
- * A dispatcher that relays all events that occur in a Render View.
- *
- * Use {@link Renderer#setEventDispatcher} to register a dispatcher for a particular Render View.
- */
- interface RenderEventDispatcher {
-
- /**
- * Called when Event called `eventName` was triggered on an Element with an Event Binding for this
- * Event.
- *
- * `elementIndex` specifies the depth-first index of the Element in the Render View.
- *
- * `locals` is a map for local variable to value mapping that should be used when evaluating the
- * Event Binding expression.
- *
- * Returns `false` if `preventDefault` should be called to stop the default behavior of the Event
- * in the Rendering Context.
- */
- dispatchRenderEvent(elementIndex: number, eventName: string, locals: Map<string, any>): boolean;
-
- }
-
-
- /**
- * Injectable service that provides a low-level interface for modifying the UI.
- *
- * Use this service to bypass Angular's templating and make custom UI changes that can't be
- * expressed declaratively. For example if you need to set a property or an attribute whose name is
- * not statically known, use {@link #setElementProperty} or {@link #setElementAttribute}
- * respectively.
- *
- * If you are implementing a custom renderer, you must implement this interface.
- *
- * The default Renderer implementation is {@link DomRenderer}. Also see {@link WebWorkerRenderer}.
- */
- interface Renderer {
-
- /**
- * Registers a component template represented as arrays of {@link RenderTemplateCmd}s and styles
- * with the Renderer.
- *
- * Once a template is registered it can be referenced via {@link RenderBeginComponentCmd} when
- * {@link #createProtoView creating Render ProtoView}.
- */
- registerComponentTemplate(templateId: number, commands: RenderTemplateCmd[], styles: string[], nativeShadow: boolean): void;
-
- /**
- * Creates a {@link RenderProtoViewRef} from an array of {@link RenderTemplateCmd}`s.
- */
- createProtoView(cmds: RenderTemplateCmd[]): RenderProtoViewRef;
-
- /**
- * Creates a Root Host View based on the provided `hostProtoViewRef`.
- *
- * `fragmentCount` is the number of nested {@link RenderFragmentRef}s in this View. This parameter
- * is non-optional so that the renderer can create a result synchronously even when application
- * runs in a different context (e.g. in a Web Worker).
- *
- * `hostElementSelector` is a (CSS) selector for querying the main document to find the Host
- * Element. The newly created Root Host View should be attached to this element.
- *
- * Returns an instance of {@link RenderViewWithFragments}, representing the Render View.
- */
- createRootHostView(hostProtoViewRef: RenderProtoViewRef, fragmentCount: number, hostElementSelector: string): RenderViewWithFragments;
-
- /**
- * Creates a Render View based on the provided `protoViewRef`.
- *
- * `fragmentCount` is the number of nested {@link RenderFragmentRef}s in this View. This parameter
- * is non-optional so that the renderer can create a result synchronously even when application
- * runs in a different context (e.g. in a Web Worker).
- *
- * Returns an instance of {@link RenderViewWithFragments}, representing the Render View.
- */
- createView(protoViewRef: RenderProtoViewRef, fragmentCount: number): RenderViewWithFragments;
-
- /**
- * Destroys a Render View specified via `viewRef`.
- *
- * This operation should be performed only on a View that has already been dehydrated and
- * all of its Render Fragments have been detached.
- *
- * Destroying a View indicates to the Renderer that this View is not going to be referenced in any
- * future operations. If the Renderer created any renderer-specific objects for this View, these
- * objects should now be destroyed to prevent memory leaks.
- */
- destroyView(viewRef: RenderViewRef): void;
-
- /**
- * Attaches the Nodes of a Render Fragment after the last Node of `previousFragmentRef`.
- */
- attachFragmentAfterFragment(previousFragmentRef: RenderFragmentRef, fragmentRef: RenderFragmentRef): void;
-
- /**
- * Attaches the Nodes of the Render Fragment after an Element.
- */
- attachFragmentAfterElement(elementRef: RenderElementRef, fragmentRef: RenderFragmentRef): void;
-
- /**
- * Detaches the Nodes of a Render Fragment from their parent.
- *
- * This operations should be called only on a View that has been already
- * {@link #dehydrateView dehydrated}.
- */
- detachFragment(fragmentRef: RenderFragmentRef): void;
-
- /**
- * Notifies a custom Renderer to initialize a Render View.
- *
- * This method is called by Angular after a Render View has been created, or when a previously
- * dehydrated Render View is about to be reused.
- */
- hydrateView(viewRef: RenderViewRef): void;
-
- /**
- * Notifies a custom Renderer that a Render View is no longer active.
- *
- * This method is called by Angular before a Render View will be destroyed, or when a hydrated
- * Render View is about to be put into a pool for future reuse.
- */
- dehydrateView(viewRef: RenderViewRef): void;
-
- /**
- * Returns the underlying native element at the specified `location`, or `null` if direct access
- * to native elements is not supported (e.g. when the application runs in a web worker).
- *
- * <div class="callout is-critical">
- * <header>Use with caution</header>
- * <p>
- * Use this api as the last resort when direct access to DOM is needed. Use templating and
- * data-binding, or other {@link Renderer} methods instead.
- * </p>
- * <p>
- * Relying on direct DOM access creates tight coupling between your application and rendering
- * layers which will make it impossible to separate the two and deploy your application into a
- * web worker.
- * </p>
- * </div>
- */
- getNativeElementSync(location: RenderElementRef): any;
-
- /**
- * Sets a property on the Element specified via `location`.
- */
- setElementProperty(location: RenderElementRef, propertyName: string, propertyValue: any): void;
-
- /**
- * Sets an attribute on the Element specified via `location`.
- *
- * If `attributeValue` is `null`, the attribute is removed.
- */
- setElementAttribute(location: RenderElementRef, attributeName: string, attributeValue: string): void;
-
- /**
- * Sets a (CSS) class on the Element specified via `location`.
- *
- * `isAdd` specifies if the class should be added or removed.
- */
- setElementClass(location: RenderElementRef, className: string, isAdd: boolean): void;
-
- /**
- * Sets a (CSS) inline style on the Element specified via `location`.
- *
- * If `styleValue` is `null`, the style is removed.
- */
- setElementStyle(location: RenderElementRef, styleName: string, styleValue: string): void;
-
- /**
- * Calls a method on the Element specified via `location`.
- */
- invokeElementMethod(location: RenderElementRef, methodName: string, args: any[]): void;
-
- /**
- * Sets the value of an interpolated TextNode at the specified index to the `text` value.
- *
- * `textNodeIndex` is the depth-first index of the Node among interpolated Nodes in the Render
- * View.
- */
- setText(viewRef: RenderViewRef, textNodeIndex: number, text: string): void;
-
- /**
- * Sets a dispatcher to relay all events triggered in the given Render View.
- *
- * Each Render View can have only one Event Dispatcher, if this method is called multiple times,
- * the last provided dispatcher will be used.
- */
- setEventDispatcher(viewRef: RenderViewRef, dispatcher: RenderEventDispatcher): void;
-
- }
-
-
- /**
- * Represents an Element that is part of a {@link RenderViewRef Render View}.
- *
- * `RenderElementRef` is a counterpart to {@link ElementRef} available in the Application Context.
- *
- * When using `Renderer` from the Application Context, `ElementRef` can be used instead of
- * `RenderElementRef`.
- */
- interface RenderElementRef {
-
- /**
- * Reference to the Render View that contains this Element.
- */
- renderView: RenderViewRef;
-
- /**
- * Index of the Element (in the depth-first order) inside the Render View.
- *
- * This index is used internally by Angular to locate elements.
- */
- boundElementIndex: number;
-
- }
-
-
- /**
- * Represents an Angular View in the Rendering Context.
- *
- * `RenderViewRef` specifies to the {@link Renderer} what View to update or destroy.
- *
- * Unlike a {@link ViewRef} available in the Application Context, Render View contains all the
- * static Component Views that have been recursively merged into a single Render View.
- *
- * Each `RenderViewRef` contains one or more {@link RenderFragmentRef Render Fragments}, these
- * Fragments are created, hydrated, dehydrated and destroyed as a single unit together with the
- * View.
- */
- class RenderViewRef {
-
- }
-
-
- /**
- * Represents an Angular ProtoView in the Rendering Context.
- *
- * When you implement a custom {@link Renderer}, `RenderProtoViewRef` specifies what Render View
- * your renderer should create.
- *
- * `RenderProtoViewRef` is a counterpart to {@link ProtoViewRef} available in the Application
- * Context. But unlike `ProtoViewRef`, `RenderProtoViewRef` contains all static nested Proto Views
- * that are recursively merged into a single Render Proto View.
- *
- *
- * <!-- TODO: this is created by Renderer#createProtoView in the new compiler -->
- */
- interface RenderProtoViewRef {
-
- }
-
-
- /**
- * Represents a list of sibling Nodes that can be moved by the {@link Renderer} independently of
- * other Render Fragments.
- *
- * Any {@link RenderView} has one Render Fragment.
- *
- * Additionally any View with an Embedded View that contains a {@link NgContent View Projection}
- * results in additional Render Fragment.
- */
- class RenderFragmentRef {
-
- }
-
-
- /**
- * Container class produced by a {@link Renderer} when creating a Render View.
- *
- * An instance of `RenderViewWithFragments` contains a {@link RenderViewRef} and an array of
- * {@link RenderFragmentRef}s belonging to this Render View.
- */
- class RenderViewWithFragments {
-
- constructor(viewRef: RenderViewRef, fragmentRefs: RenderFragmentRef[]);
-
- /**
- * Reference to the {@link RenderViewRef}.
- */
- viewRef: RenderViewRef;
-
- /**
- * Array of {@link RenderFragmentRef}s ordered in the depth-first order.
- */
- fragmentRefs: RenderFragmentRef[];
-
- }
-
-
- interface RenderTemplateCmd {
-
- visit(visitor: RenderCommandVisitor, context: any): any;
-
- }
-
-
- interface RenderCommandVisitor {
-
- visitText(cmd: RenderTextCmd, context: any): any;
-
- visitNgContent(cmd: RenderNgContentCmd, context: any): any;
-
- visitBeginElement(cmd: RenderBeginElementCmd, context: any): any;
-
- visitEndElement(context: any): any;
-
- visitBeginComponent(cmd: RenderBeginComponentCmd, context: any): any;
-
- visitEndComponent(context: any): any;
-
- visitEmbeddedTemplate(cmd: RenderEmbeddedTemplateCmd, context: any): any;
-
- }
-
-
- interface RenderTextCmd extends RenderBeginCmd {
-
- value: string;
-
- }
-
-
- interface RenderNgContentCmd {
-
- ngContentIndex: number;
-
- }
-
-
- interface RenderBeginElementCmd extends RenderBeginCmd {
-
- name: string;
-
- attrNameAndValues: string[];
-
- eventTargetAndNames: string[];
-
- }
-
-
- interface RenderBeginComponentCmd extends RenderBeginElementCmd {
-
- nativeShadow: boolean;
-
- templateId: number;
-
- }
-
-
- interface RenderEmbeddedTemplateCmd extends RenderBeginElementCmd {
-
- isMerged: boolean;
-
- children: RenderTemplateCmd[];
-
- }
-
-
- interface RenderBeginCmd extends RenderTemplateCmd {
-
- ngContentIndex: number;
-
- isBound: boolean;
-
- }
-
-
- let PRIMITIVE: Type;
-
-
-
- /**
- * Implement this interface to get notified when your directive's content has been fully
- * initialized.
- *
- * ### Example ([live demo](http://plnkr.co/edit/plamXUpsLQbIXpViZhUO?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({template: `<ng-content></ng-content>`})
- * class ParentComponent implements AfterContentInit {
- * @ContentChild(ChildComponent) contentChild: ChildComponent;
- *
- * constructor() {
- * // contentChild is not initialized yet
- * console.log(this.getMessage(this.contentChild));
- * }
- *
- * afterContentInit() {
- * // contentChild is updated after the content has been checked
- * console.log('AfterContentInit: ' + this.getMessage(this.contentChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <parent-cmp>
- * <child-cmp where="content"></child-cmp>
- * </parent-cmp>`,
- * directives: [ParentComponent, ChildComponent]
- * })
- * export class App {
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterContentInit {
-
- afterContentInit(): void;
-
- }
-
-
- /**
- * Implement this interface to get notified after every check of your directive's content.
- *
- * ### Example ([live demo](http://plnkr.co/edit/tGdrytNEKQnecIPkD7NU?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({template: `<ng-content></ng-content>`})
- * class ParentComponent implements AfterContentChecked {
- * @ContentChild(ChildComponent) contentChild: ChildComponent;
- *
- * constructor() {
- * // contentChild is not initialized yet
- * console.log(this.getMessage(this.contentChild));
- * }
- *
- * afterContentChecked() {
- * // contentChild is updated after the content has been checked
- * console.log('AfterContentChecked: ' + this.getMessage(this.contentChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <parent-cmp>
- * <button (click)="hasContent = !hasContent">Toggle content child</button>
- * <child-cmp *ng-if="hasContent" where="content"></child-cmp>
- * </parent-cmp>`,
- * directives: [NgIf, ParentComponent, ChildComponent]
- * })
- * export class App {
- * hasContent = true;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterContentChecked {
-
- afterContentChecked(): void;
-
- }
-
-
- /**
- * Implement this interface to get notified when your component's view has been fully initialized.
- *
- * ### Example ([live demo](http://plnkr.co/edit/LhTKVMEM0fkJgyp4CI1W?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({
- * template: `<child-cmp where="view"></child-cmp>`,
- * directives: [ChildComponent]
- * })
- * class ParentComponent implements AfterViewInit {
- * @ViewChild(ChildComponent) viewChild: ChildComponent;
- *
- * constructor() {
- * // viewChild is not initialized yet
- * console.log(this.getMessage(this.viewChild));
- * }
- *
- * afterViewInit() {
- * // viewChild is updated after the view has been initialized
- * console.log('afterViewInit: ' + this.getMessage(this.viewChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<parent-cmp></parent-cmp>`,
- * directives: [ParentComponent]
- * })
- * export class App {
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterViewInit {
-
- afterViewInit(): void;
-
- }
-
-
- /**
- * Implement this interface to get notified after every check of your component's view.
- *
- * ### Example ([live demo](http://plnkr.co/edit/0qDGHcPQkc25CXhTNzKU?p=preview))
- *
- * ```typescript
- * @Component({selector: 'child-cmp'})
- * @View({template: `{{where}} child`})
- * class ChildComponent {
- * @Property() where: string;
- * }
- *
- * @Component({selector: 'parent-cmp'})
- * @View({
- * template: `
- * <button (click)="showView = !showView">Toggle view child</button>
- * <child-cmp *ng-if="showView" where="view"></child-cmp>`,
- * directives: [NgIf, ChildComponent]
- * })
- * class ParentComponent implements AfterViewChecked {
- * @ViewChild(ChildComponent) viewChild: ChildComponent;
- * showView = true;
- *
- * constructor() {
- * // viewChild is not initialized yet
- * console.log(this.getMessage(this.viewChild));
- * }
- *
- * afterViewChecked() {
- * // viewChild is updated after the view has been checked
- * console.log('AfterViewChecked: ' + this.getMessage(this.viewChild));
- * }
- *
- * private getMessage(cmp: ChildComponent): string {
- * return cmp ? cmp.where + ' child' : 'no child';
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<parent-cmp></parent-cmp>`,
- * directives: [ParentComponent]
- * })
- * export class App {
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface AfterViewChecked {
-
- afterViewChecked(): void;
-
- }
-
-
- /**
- * Lifecycle hooks are guaranteed to be called in the following order:
- * - `OnChanges` (if any bindings have changed),
- * - `OnInit` (after the first check only),
- * - `DoCheck`,
- * - `AfterContentInit`,
- * - `AfterContentChecked`,
- * - `AfterViewInit`,
- * - `AfterViewChecked`,
- * - `OnDestroy` (at the very end before destruction)
- * Implement this interface to get notified when any data-bound property of your directive changes.
- *
- * `onChanges` is called right after the data-bound properties have been checked and before view
- * and content children are checked if at least one of them has changed.
- *
- * The `changes` parameter contains an entry for each of the changed data-bound property. The key is
- * the property name and the value is an instance of {@link SimpleChange}.
- *
- * ### Example ([live example](http://plnkr.co/edit/AHrB6opLqHDBPkt4KpdT?p=preview)):
- *
- * ```typescript
- * @Component({selector: 'my-cmp'})
- * @View({template: `<p>myProp = {{myProp}}</p>`})
- * class MyComponent implements OnChanges {
- * @Property() myProp: any;
- *
- * onChanges(changes: {[propName: string]: SimpleChange}) {
- * console.log('onChanges - myProp = ' + changes['myProp'].currentValue);
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="value = value + 1">Change MyComponent</button>
- * <my-cmp [my-prop]="value"></my-cmp>`,
- * directives: [MyComponent]
- * })
- * export class App {
- * value = 0;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface OnChanges {
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- }
-
-
- /**
- * Implement this interface to get notified when your directive is destroyed.
- *
- * `onDestroy` callback is typically used for any custom cleanup that needs to occur when the
- * instance is destroyed
- *
- * ### Example ([live example](http://plnkr.co/edit/1MBypRryXd64v4pV03Yn?p=preview))
- *
- * ```typesript
- * @Component({selector: 'my-cmp'})
- * @View({template: `<p>my-component</p>`})
- * class MyComponent implements OnInit, OnDestroy {
- * onInit() {
- * console.log('onInit');
- * }
- *
- * onDestroy() {
- * console.log('onDestroy');
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="hasChild = !hasChild">
- * {{hasChild ? 'Destroy' : 'Create'}} MyComponent
- * </button>
- * <my-cmp *ng-if="hasChild"></my-cmp>`,
- * directives: [MyComponent, NgIf]
- * })
- * export class App {
- * hasChild = true;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * * ```
- */
- interface OnDestroy {
-
- onDestroy(): void;
-
- }
-
-
- /**
- * Implement this interface to execute custom initialization logic after your directive's
- * data-bound properties have been initialized.
- *
- * `onInit` is called right after the directive's data-bound properties have been checked for the
- * first time, and before any of its children have been checked. It is invoked only once when the
- * directive is instantiated.
- *
- * ### Example ([live example](http://plnkr.co/edit/1MBypRryXd64v4pV03Yn?p=preview))
- *
- * ```typescript
- * @Component({selector: 'my-cmp'})
- * @View({template: `<p>my-component</p>`})
- * class MyComponent implements OnInit, OnDestroy {
- * onInit() {
- * console.log('onInit');
- * }
- *
- * onDestroy() {
- * console.log('onDestroy');
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="hasChild = !hasChild">
- * {{hasChild ? 'Destroy' : 'Create'}} MyComponent
- * </button>
- * <my-cmp *ng-if="hasChild"></my-cmp>`,
- * directives: [MyComponent, NgIf]
- * })
- * export class App {
- * hasChild = true;
- * }
- *
- * bootstrap(App).catch(err => console.error(err));
- * ```
- */
- interface OnInit {
-
- onInit(): void;
-
- }
-
-
- /**
- * Implement this interface to override the default change detection algorithm for your directive.
- *
- * `doCheck` gets called to check the changes in the directives instead of the default algorithm.
- *
- * The default change detection algorithm looks for differences by comparing bound-property values
- * by reference across change detection runs. When `DoCheck` is implemented, the default algorithm
- * is disabled and `doCheck` is responsible for checking for changes.
- *
- * Implementing this interface allows improving performance by using insights about the component,
- * its implementation and data types of its properties.
- *
- * Note that a directive should not implement both `DoCheck` and {@link OnChanges} at the same time.
- * `onChanges` would not be called when a directive implements `DoCheck`. Reaction to the changes
- * have to be handled from within the `doCheck` callback.
- *
- * Use {@link KeyValueDiffers} and {@link IterableDiffers} to add your custom check mechanisms.
- *
- * ### Example ([live demo](http://plnkr.co/edit/QpnIlF0CR2i5bcYbHEUJ?p=preview))
- *
- * In the following example `doCheck` uses an {@link IterableDiffers} to detect the updates to the
- * array `list`:
- *
- * ```typescript
- * @Component({selector: 'custom-check'})
- * @View({
- * template: `
- * <p>Changes:</p>
- * <ul>
- * <li *ng-for="#line of logs">{{line}}</li>
- * </ul>`,
- * directives: [NgFor]
- * })
- * class CustomCheckComponent implements DoCheck {
- * @Property() list: any[];
- * differ: any;
- * logs = [];
- *
- * constructor(differs: IterableDiffers) {
- * this.differ = differs.find([]).create(null);
- * }
- *
- * doCheck() {
- * var changes = this.differ.diff(this.list);
- *
- * if (changes) {
- * changes.forEachAddedItem(r => this.logs.push('added ' + r.item));
- * changes.forEachRemovedItem(r => this.logs.push('removed ' + r.item))
- * }
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <button (click)="list.push(list.length)">Push</button>
- * <button (click)="list.pop()">Pop</button>
- * <custom-check [list]="list"></custom-check>`,
- * directives: [CustomCheckComponent]
- * })
- * export class App {
- * list = [];
- * }
- * ```
- */
- interface DoCheck {
-
- doCheck(): void;
-
- }
-
-
- /**
- * Declares an injectable parameter to be a live list of directives or variable
- * bindings from the content children of a directive.
- *
- * ### Example ([live demo](http://plnkr.co/edit/lY9m8HLy7z06vDoUaSN2?p=preview))
- *
- * Assume that `<tabs>` component would like to get a list its children `<pane>`
- * components as shown in this example:
- *
- * ```html
- * <tabs>
- * <pane title="Overview">...</pane>
- * <pane *ng-for="#o of objects" [title]="o.title">{{o.text}}</pane>
- * </tabs>
- * ```
- *
- * The preferred solution is to query for `Pane` directives using this decorator.
- *
- * ```javascript
- * @Component({
- * selector: 'pane',
- * inputs: ['title']
- * })
- * @View(...)
- * class Pane {
- * title:string;
- * }
- *
- * @Component({
- * selector: 'tabs'
- * })
- * @View({
- * template: `
- * <ul>
- * <li *ng-for="#pane of panes">{{pane.title}}</li>
- * </ul>
- * <content></content>
- * `
- * })
- * class Tabs {
- * panes: QueryList<Pane>;
- * constructor(@Query(Pane) panes:QueryList<Pane>) {
- * this.panes = panes;
- * }
- * }
- * ```
- *
- * A query can look for variable bindings by passing in a string with desired binding symbol.
- *
- * ### Example ([live demo](http://plnkr.co/edit/sT2j25cH1dURAyBRCKx1?p=preview))
- * ```html
- * <seeker>
- * <div #findme>...</div>
- * </seeker>
- *
- * @Component({
- * selector: 'foo'
- * })
- * @View(...)
- * class seeker {
- * constructor(@Query('findme') elList: QueryList<ElementRef>) {...}
- * }
- * ```
- *
- * In this case the object that is injected depend on the type of the variable
- * binding. It can be an ElementRef, a directive or a component.
- *
- * Passing in a comma separated list of variable bindings will query for all of them.
- *
- * ```html
- * <seeker>
- * <div #find-me>...</div>
- * <div #find-me-too>...</div>
- * </seeker>
- *
- * @Component({
- * selector: 'foo'
- * })
- * @View(...)
- * class Seeker {
- * constructor(@Query('findMe, findMeToo') elList: QueryList<ElementRef>) {...}
- * }
- * ```
- *
- * Configure whether query looks for direct children or all descendants
- * of the querying element, by using the `descendants` parameter.
- * It is set to `false` by default.
- *
- * ### Example ([live demo](http://plnkr.co/edit/wtGeB977bv7qvA5FTYl9?p=preview))
- * ```html
- * <container #first>
- * <item>a</item>
- * <item>b</item>
- * <container #second>
- * <item>c</item>
- * </container>
- * </container>
- * ```
- *
- * When querying for items, the first container will see only `a` and `b` by default,
- * but with `Query(TextDirective, {descendants: true})` it will see `c` too.
- *
- * The queried directives are kept in a depth-first pre-order with respect to their
- * positions in the DOM.
- *
- * Query does not look deep into any subcomponent views.
- *
- * Query is updated as part of the change-detection cycle. Since change detection
- * happens after construction of a directive, QueryList will always be empty when observed in the
- * constructor.
- *
- * The injected object is an unmodifiable live list.
- * See {@link QueryList} for more details.
- */
- class QueryMetadata extends DependencyMetadata {
-
- constructor(_selector: Type | string, {descendants, first}?: {descendants?: boolean, first?: boolean});
-
- /**
- * whether we want to query only direct children (false) or all
- * children (true).
- */
- descendants: boolean;
-
- first: boolean;
-
- /**
- * always `false` to differentiate it with {@link ViewQueryMetadata}.
- */
- isViewQuery: boolean;
-
- /**
- * what this is querying for.
- */
- selector: any;
-
- /**
- * whether this is querying for a variable binding or a directive.
- */
- isVarBindingQuery: boolean;
-
- /**
- * returns a list of variable bindings this is querying for.
- * Only applicable if this is a variable bindings query.
- */
- varBindings: string[];
-
- toString(): string;
-
- }
-
-
- /**
- * Configures a content query.
- *
- * Content queries are set before the `afterContentInit` callback is called.
- *
- * ### Example
- *
- * ```
- * @Directive({
- * selector: 'someDir'
- * })
- * class SomeDir {
- * @ContentChildren(ChildDirective) contentChildren: QueryList<ChildDirective>;
- *
- * afterContentInit() {
- * // contentChildren is set
- * }
- * }
- * ```
- */
- class ContentChildrenMetadata extends QueryMetadata {
-
- constructor(_selector: Type | string, {descendants}?: {descendants?: boolean});
-
- }
-
-
- /**
- * Configures a content query.
- *
- * Content queries are set before the `afterContentInit` callback is called.
- *
- * ### Example
- *
- * ```
- * @Directive({
- * selector: 'someDir'
- * })
- * class SomeDir {
- * @ContentChild(ChildDirective) contentChild;
- *
- * afterContentInit() {
- * // contentChild is set
- * }
- * }
- * ```
- */
- class ContentChildMetadata extends QueryMetadata {
-
- constructor(_selector: Type | string);
-
- }
-
-
- /**
- * Configures a view query.
- *
- * View queries are set before the `afterViewInit` callback is called.
- *
- * ### Example
- *
- * ```
- * @Component({
- * selector: 'someDir'
- * })
- * @View({templateUrl: 'someTemplate', directives: [ItemDirective]})
- * class SomeDir {
- * @ViewChildren(ItemDirective) viewChildren: QueryList<ItemDirective>;
- *
- * afterViewInit() {
- * // viewChildren is set
- * }
- * }
- * ```
- */
- class ViewChildrenMetadata extends ViewQueryMetadata {
-
- constructor(_selector: Type | string);
-
- }
-
-
- /**
- * Similar to {@link QueryMetadata}, but querying the component view, instead of
- * the content children.
- *
- * ### Example ([live demo](http://plnkr.co/edit/eNsFHDf7YjyM6IzKxM1j?p=preview))
- *
- * ```javascript
- * @Component({...})
- * @View({
- * template: `
- * <item> a </item>
- * <item> b </item>
- * <item> c </item>
- * `
- * })
- * class MyComponent {
- * shown: boolean;
- *
- * constructor(private @Query(Item) items:QueryList<Item>) {
- * items.onChange(() => console.log(items.length));
- * }
- * }
- * ```
- *
- * Supports the same querying parameters as {@link QueryMetadata}, except
- * `descendants`. This always queries the whole view.
- *
- * As `shown` is flipped between true and false, items will contain zero of one
- * items.
- *
- * Specifies that a {@link QueryList} should be injected.
- *
- * The injected object is an iterable and observable live list.
- * See {@link QueryList} for more details.
- */
- class ViewQueryMetadata extends QueryMetadata {
-
- constructor(_selector: Type | string, {descendants, first}?: {descendants?: boolean, first?: boolean});
-
- /**
- * always `true` to differentiate it with {@link QueryMetadata}.
- */
- isViewQuery: any;
-
- toString(): string;
-
- }
-
-
- /**
- * Configures a view query.
- *
- * View queries are set before the `afterViewInit` callback is called.
- *
- * ### Example
- *
- * ```
- * @Component({
- * selector: 'someDir'
- * })
- * @View({templateUrl: 'someTemplate', directives: [ItemDirective]})
- * class SomeDir {
- * @ViewChild(ItemDirective) viewChild:ItemDirective;
- *
- * afterViewInit() {
- * // viewChild is set
- * }
- * }
- * ```
- */
- class ViewChildMetadata extends ViewQueryMetadata {
-
- constructor(_selector: Type | 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 `<input>` element and want to know its `type`.
- *
- * ```html
- * <input type="text">
- * ```
- *
- * 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 {
-
- constructor(attributeName: string);
-
- attributeName: string;
-
- token: any;
-
- toString(): string;
-
- }
-
-
- /**
- * 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}.
- *
- * ## Lifecycle hooks
- *
- * When the component class implements some {@link angular2/lifecycle_hooks} the callbacks are
- * called by the change detection at defined points in time during the life of the component.
- *
- * ## Example
- *
- * ```
- * @Component({
- * selector: 'greet'
- * })
- * @View({
- * template: 'Hello {{name}}!'
- * })
- * class Greet {
- * name: string;
- *
- * constructor() {
- * this.name = 'World';
- * }
- * }
- * ```
- */
- class ComponentMetadata extends DirectiveMetadata {
-
- constructor({selector, inputs, outputs, properties, events, host, exportAs, moduleId, bindings,
- viewBindings, changeDetection, queries}?: {
- selector?: string,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- viewBindings?: any[],
- queries?: {[key: string]: any},
- changeDetection?: ChangeDetectionStrategy,
- });
-
- /**
- * 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: `<needs-greeter></needs-greeter>`,
- * 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<DirectiveType>`: A live collection of direct child
- * directives.
- * - `@QueryDescendants(DirectiveType) query:QueryList<DirectiveType>`: 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:
- *
- * ```
- * <div dependency="1">
- * <div dependency="2">
- * <div dependency="3" my-directive>
- * <div dependency="4">
- * <div dependency="5"></div>
- * </div>
- * <div dependency="6"></div>
- * </div>
- * </div>
- * </div>
- * ```
- *
- * With the following `dependency` decorator and `SomeService` injectable class.
- *
- * ```
- * @Injectable()
- * class SomeService {
- * }
- *
- * @Directive({
- * selector: '[dependency]',
- * inputs: [
- * '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<Dependency>) {
- * }
- * }
- * ```
- *
- * 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<Dependency>) {
- * }
- * }
- * ```
- *
- * 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]',
- * inputs: [
- * '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 `<div>` or any other element with the
- * `tooltip` selector,
- * like so:
- *
- * ```
- * <div tooltip="some text here"></div>
- * ```
- *
- * 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 `<template>` 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
- * `<template>` 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
- * `<template>` element syntax is wordy, Angular
- * also supports a shorthand notation: `<li *foo="bar">` and `<li template="foo: bar">` are
- * equivalent.
- *
- * Thus,
- *
- * ```
- * <ul>
- * <li *foo="bar" title="text"></li>
- * </ul>
- * ```
- *
- * Expands in use to:
- *
- * ```
- * <ul>
- * <template [foo]="bar">
- * <li title="text"></li>
- * </template>
- * </ul>
- * ```
- *
- * Notice that although the shorthand places `*foo="bar"` within the `<li>` element, the binding for
- * the directive
- * controller is correctly instantiated on the `<template>` element rather than the `<li>` element.
- *
- * ## Lifecycle hooks
- *
- * When the directive class implements some {@link angular2/lifecycle_hooks} the callbacks are
- * called by the change detection at defined points in time during the life of the directive.
- *
- * ## 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]',
- * inputs: ['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:
- * ```
- * <ul>
- * <li *unless="expr"></li>
- * </ul>
- * ```
- *
- * Once the directive instantiates the child view, the shorthand notation for the template expands
- * and the result is:
- *
- * ```
- * <ul>
- * <template [unless]="exp">
- * <li></li>
- * </template>
- * <li></li>
- * </ul>
- * ```
- *
- * Note also that although the `<li></li>` template still exists inside the `<template></template>`,
- * the instantiated
- * view occurs on the second `<li></li>` which is a sibling to the `<template>` element.
- */
- class DirectiveMetadata extends InjectableMetadata {
-
- constructor({selector, inputs, outputs, properties, events, host, bindings, exportAs, moduleId,
- queries}?: {
- selector?: string,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any}
- });
-
- /**
- * 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
- * <form>
- * <input type="text">
- * <input type="radio">
- * <form>
- * ```
- *
- * The directive would only be instantiated on the `<input type="text">` element.
- */
- selector: string;
-
- /**
- * Enumerates the set of data-bound input properties for a directive
- *
- * Angular automatically updates input properties during change detection.
- *
- * The `inputs` property defines a set of `directiveProperty` to `bindingProperty`
- * configuration:
- *
- * - `directiveProperty` specifies the component property where the value is written.
- * - `bindingProperty` specifies the DOM property where the value is read from.
- *
- * When `bindingProperty` is not provided, it is assumed to be equal to `directiveProperty`.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ivhfXY?p=preview))
- *
- * The following example creates a component with two data-bound properties.
- *
- * ```typescript
- * @Component({
- * selector: 'bank-account',
- * inputs: ['bankName', 'id: account-id']
- * })
- * @View({
- * template: `
- * Bank Name: {{bankName}}
- * Account Id: {{id}}
- * `
- * })
- * class BankAccount {
- * bankName: string;
- * id: string;
- *
- * // this property is not bound, and won't be automatically updated by Angular
- * normalizedBankName: string;
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <bank-account bank-name="RBC" account-id="4747"></bank-account>
- * `,
- * directives: [BankAccount]
- * })
- * class App {}
- *
- * bootstrap(App);
- * ```
- */
- inputs: string[];
-
- /**
- * @deprecated
- * Same as `inputs`. This is to enable easier migration.
- */
- properties: string[];
-
- /**
- * Enumerates the set of event-bound output properties.
- *
- * When an output property emits an event, an event handler attached to that event
- * the template is invoked.
- *
- * The `outputs` property defines a set of `directiveProperty` to `bindingProperty`
- * configuration:
- *
- * - `directiveProperty` specifies the component property that emits events.
- * - `bindingProperty` specifies the DOM property the event handler is attached to.
- *
- * ### Example ([live demo](http://plnkr.co/edit/d5CNq7?p=preview))
- *
- * ```typescript
- * @Directive({
- * selector: 'interval-dir',
- * outputs: ['everySecond', 'five5Secs: everyFiveSeconds']
- * })
- * class IntervalDir {
- * everySecond = new EventEmitter();
- * five5Secs = new EventEmitter();
- *
- * constructor() {
- * setInterval(() => this.everySecond.next("event"), 1000);
- * setInterval(() => this.five5Secs.next("event"), 5000);
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <interval-dir (every-second)="everySecond()" (every-five-seconds)="everyFiveSeconds()">
- * </interval-dir>
- * `,
- * directives: [IntervalDir]
- * })
- * class App {
- * everySecond() { console.log('second'); }
- * everyFiveSeconds() { console.log('five seconds'); }
- * }
- * bootstrap(App);
- * ```
- */
- outputs: string[];
-
- /**
- * @deprecated
- * Same as `outputs`. This is to enable easier migration.
- */
- events: string[];
-
- /**
- * Specify the events, actions, properties and attributes related to the host element.
- *
- * ## Host Listeners
- *
- * Specifies which DOM events 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 evaluation 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 $event local variable.
- *
- * ### Example ([live demo](http://plnkr.co/edit/DlA5KU?p=preview))
- *
- * The following example declares a directive that attaches a click listener to the button and
- * counts clicks.
- *
- * ```typescript
- * @Directive({
- * selector: 'button[counting]',
- * host: {
- * '(click)': 'onClick($event.target)'
- * }
- * })
- * class CountClicks {
- * numberOfClicks = 0;
- *
- * onClick(btn) {
- * console.log("button", btn, "number of clicks:", this.numberOfClicks++);
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<button counting>Increment</button>`,
- * directives: [CountClicks]
- * })
- * class App {}
- *
- * bootstrap(App);
- * ```
- *
- * ## Host Property Bindings
- *
- * Specifies which DOM properties a directive updates.
- *
- * Angular automatically checks host property bindings during change detection.
- * If a binding changes, it will update the host element of the directive.
- *
- * ### Example ([live demo](http://plnkr.co/edit/gNg0ED?p=preview))
- *
- * The following example creates a directive that sets the `valid` and `invalid` classes
- * on the DOM element that has ng-model directive on it.
- *
- * ```typescript
- * @Directive({
- * selector: '[ng-model]',
- * host: {
- * '[class.valid]': 'valid',
- * '[class.invalid]': 'invalid'
- * }
- * })
- * class NgModelStatus {
- * constructor(public control:NgModel) {}
- * get valid { return this.control.valid; }
- * get invalid { return this.control.invalid; }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<input [(ng-model)]="prop">`,
- * directives: [FORM_DIRECTIVES, NgModelStatus]
- * })
- * class App {
- * prop;
- * }
- *
- * bootstrap(App);
- * ```
- *
- * ## Attributes
- *
- * Specifies static attributes that should be propagated to a host element.
- *
- * ### Example
- *
- * In this example using `my-button` directive (ex.: `<div my-button></div>`) on a host element
- * (here: `<div>` ) will ensure that this element will get the "button" role.
- *
- * ```typescript
- * @Directive({
- * selector: '[my-button]',
- * host: {
- * 'role': 'button'
- * }
- * })
- * class MyButton {
- * }
- * ```
- */
- host: {[key: string]: string};
-
- /**
- * 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: `<child-dir #c="child"></child-dir>`,
- * directives: [ChildDir]
- * })
- * class MainComponent {
- * }
- *
- * ```
- */
- exportAs: string;
-
- /**
- * The module id of the module that contains the directive.
- * Needed to be able to resolve relative urls for templates and styles.
- * In Dart, this can be determined automatically and does not need to be set.
- * In CommonJS, this can always be set to `module.id`.
- *
- * ## Simple Example
- *
- * ```
- * @Directive({
- * selector: 'someDir',
- * moduleId: module.id
- * })
- * class SomeDir {
- * }
- *
- * ```
- */
- moduleId: string;
-
- /**
- * Configures the queries that will be injected into the directive.
- *
- * Content queries are set before the `afterContentInit` callback is called.
- * View queries are set before the `afterViewInit` callback is called.
- *
- * ### Example
- *
- * ```
- * @Component({
- * selector: 'someDir',
- * queries: {
- * contentChildren: new ContentChildren(ChildDirective),
- * viewChildren: new ViewChildren(ChildDirective)
- * }
- * })
- * @View({
- * template: '<child-directive></child-directive>',
- * directives: [ChildDirective]
- * })
- * class SomeDir {
- * contentChildren: QueryList<ChildDirective>,
- * viewChildren: QueryList<ChildDirective>
- *
- * afterContentInit() {
- * // contentChildren is set
- * }
- *
- * afterViewInit() {
- * // viewChildren is set
- * }
- * }
- * ```
- */
- queries: {[key: string]: any};
-
- }
-
-
- /**
- * Declare reusable pipe function.
- *
- * ## Example
- *
- * ```
- * @Pipe({
- * name: 'lowercase'
- * })
- * class Lowercase {
- * transform(v, args) { return v.toLowerCase(); }
- * }
- * ```
- */
- class PipeMetadata extends InjectableMetadata {
-
- constructor({name, pure}: {name: string, pure: boolean});
-
- name: string;
-
- pure: boolean;
-
- }
-
-
- /**
- * Declares a data-bound input property.
- *
- * Angular automatically updates data-bound properties during change detection.
- *
- * `InputMetadata` takes an optional parameter that specifies the name
- * used when instantiating a component in the template. When not provided,
- * the name of the decorated property is used.
- *
- * ### Example
- *
- * The following example creates a component with two input properties.
- *
- * ```typescript
- * @Component({selector: 'bank-account'})
- * @View({
- * template: `
- * Bank Name: {{bankName}}
- * Account Id: {{id}}
- * `
- * })
- * class BankAccount {
- * @Input() bankName: string;
- * @Input('account-id') id: string;
- *
- * // this property is not bound, and won't be automatically updated by Angular
- * normalizedBankName: string;
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <bank-account bank-name="RBC" account-id="4747"></bank-account>
- * `,
- * directives: [BankAccount]
- * })
- * class App {}
- *
- * bootstrap(App);
- * ```
- */
- class InputMetadata {
-
- constructor(bindingPropertyName?: string);
-
- /**
- * Name used when instantiating a component in the temlate.
- */
- bindingPropertyName: string;
-
- }
-
-
- /**
- * Declares an event-bound output property.
- *
- * When an output property emits an event, an event handler attached to that event
- * the template is invoked.
- *
- * `OutputMetadata` takes an optional parameter that specifies the name
- * used when instantiating a component in the template. When not provided,
- * the name of the decorated property is used.
- *
- * ### Example
- *
- * ```typescript
- * @Directive({
- * selector: 'interval-dir',
- * })
- * class IntervalDir {
- * @Output() everySecond = new EventEmitter();
- * @Output('everyFiveSeconds') five5Secs = new EventEmitter();
- *
- * constructor() {
- * setInterval(() => this.everySecond.next("event"), 1000);
- * setInterval(() => this.five5Secs.next("event"), 5000);
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `
- * <interval-dir (every-second)="everySecond()" (every-five-seconds)="everyFiveSeconds()">
- * </interval-dir>
- * `,
- * directives: [IntervalDir]
- * })
- * class App {
- * everySecond() { console.log('second'); }
- * everyFiveSeconds() { console.log('five seconds'); }
- * }
- * bootstrap(App);
- * ```
- */
- class OutputMetadata {
-
- constructor(bindingPropertyName?: string);
-
- bindingPropertyName: string;
-
- }
-
-
- /**
- * Declares a host property binding.
- *
- * Angular automatically checks host property bindings during change detection.
- * If a binding changes, it will update the host element of the directive.
- *
- * `HostBindingMetadata` takes an optional parameter that specifies the property
- * name of the host element that will be updated. When not provided,
- * the class property name is used.
- *
- * ### Example
- *
- * The following example creates a directive that sets the `valid` and `invalid` classes
- * on the DOM element that has ng-model directive on it.
- *
- * ```typescript
- * @Directive({selector: '[ng-model]'})
- * class NgModelStatus {
- * constructor(public control:NgModel) {}
- * @HostBinding('[class.valid]') get valid { return this.control.valid; }
- * @HostBinding('[class.invalid]') get invalid { return this.control.invalid; }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<input [(ng-model)]="prop">`,
- * directives: [FORM_DIRECTIVES, NgModelStatus]
- * })
- * class App {
- * prop;
- * }
- *
- * bootstrap(App);
- * ```
- */
- class HostBindingMetadata {
-
- constructor(hostPropertyName?: string);
-
- hostPropertyName: string;
-
- }
-
-
- /**
- * Declares a host listener.
- *
- * Angular will invoke the decorated method when the host element emits the specified event.
- *
- * If the decorated method returns `false`, then `preventDefault` is applied on the DOM
- * event.
- *
- * ### Example
- *
- * The following example declares a directive that attaches a click listener to the button and
- * counts clicks.
- *
- * ```typescript
- * @Directive({selector: 'button[counting]'})
- * class CountClicks {
- * numberOfClicks = 0;
- *
- * @HostListener('click', ['$event.target'])
- * onClick(btn) {
- * console.log("button", btn, "number of clicks:", this.numberOfClicks++);
- * }
- * }
- *
- * @Component({selector: 'app'})
- * @View({
- * template: `<button counting>Increment</button>`,
- * directives: [CountClicks]
- * })
- * class App {}
- *
- * bootstrap(App);
- * ```
- */
- class HostListenerMetadata {
-
- constructor(eventName: string, args?: string[]);
-
- eventName: string;
-
- args: string[];
-
- }
-
-
- /**
- * Metadata properties available for configuring Views.
- *
- * 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 {
-
- constructor({templateUrl, template, directives, pipes, encapsulation, styles, styleUrls}?: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any[]>,
- pipes?: Array<Type | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- });
-
- /**
- * Specifies a template URL for an Angular component.
- *
- * NOTE: Only one of `templateUrl` or `template` can be defined per View.
- *
- * <!-- TODO: what's the url relative to? -->
- */
- templateUrl: string;
-
- /**
- * Specifies an inline template for an Angular component.
- *
- * NOTE: Only one of `templateUrl` or `template` can be defined per View.
- */
- template: string;
-
- /**
- * Specifies stylesheet URLs for an Angular component.
- *
- * <!-- TODO: what's the url relative to? -->
- */
- 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: [NgFor]
- * template: '
- * <ul>
- * <li *ng-for="#item of items">{{item}}</li>
- * </ul>'
- * })
- * class MyComponent {
- * }
- * ```
- */
- directives: Array<Type | any[]>;
-
- pipes: Array<Type | any[]>;
-
- /**
- * 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;
-
- }
-
-
- /**
- * Defines template and style encapsulation options available for Component's {@link View}.
- *
- * See {@link ViewMetadata#encapsulation}.
- */
- enum ViewEncapsulation {
-
- /**
- * Emulate `Native` scoping of styles by adding an attribute containing surrogate id to the Host
- * Element and pre-processing the style rules provided via
- * {@link ViewMetadata#styles} or {@link ViewMetadata#stylesUrls}, and adding the new Host Element
- * attribute to all selectors.
- *
- * This is the default option.
- */
- Emulated,
-
- /**
- * Use the native encapsulation mechanism of the renderer.
- *
- * For the DOM this means using [Shadow DOM](https://w3c.github.io/webcomponents/spec/shadow/) and
- * creating a ShadowRoot for Component's Host Element.
- */
- Native,
-
- /**
- * Don't provide any template or style encapsulation.
- */
- None
- }
-
-
-
- /**
- * Interface for the {@link DirectiveMetadata} decorator function.
- *
- * See {@link DirectiveFactory}.
- */
- interface DirectiveDecorator extends TypeDecorator {
-
- }
-
-
- /**
- * 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<Type | any[]>,
- pipes?: Array<Type | any[]>,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
-
- }
-
-
- /**
- * 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<Type | any[]>,
- pipes?: Array<Type | any[]>,
- renderer?: string,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
-
- }
-
-
- /**
- * {@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,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any}
- }): DirectiveMetadata;
-
- (obj: {
- selector?: string,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any}
- }): DirectiveDecorator;
-
- }
-
-
- /**
- * {@link ComponentMetadata} 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,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any},
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentMetadata;
-
- (obj: {
- selector?: string,
- inputs?: string[],
- outputs?: string[],
- properties?: string[],
- events?: string[],
- host?: {[key: string]: string},
- bindings?: any[],
- exportAs?: string,
- moduleId?: string,
- queries?: {[key: string]: any},
- viewBindings?: any[],
- changeDetection?: ChangeDetectionStrategy,
- }): ComponentDecorator;
-
- }
-
-
- /**
- * {@link ViewMetadata} 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<Type | any[]>,
- pipes?: Array<Type | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewMetadata;
-
- (obj: {
- templateUrl?: string,
- template?: string,
- directives?: Array<Type | any[]>,
- pipes?: Array<Type | any[]>,
- encapsulation?: ViewEncapsulation,
- styles?: string[],
- styleUrls?: string[],
- }): ViewDecorator;
-
- }
-
-
- /**
- * {@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 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<SomeType>) {
- * ...
- * }
- * }
- * ```
- *
- * ### 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;
-
- }
-
-
- interface ContentChildrenFactory {
-
- new(selector: Type | string, {descendants}?: {descendants?: boolean}): ContentChildrenMetadata;
-
- (selector: Type | string, {descendants}?: {descendants?: boolean}): any;
-
- }
-
-
- interface ContentChildFactory {
-
- new(selector: Type | string): ContentChildFactory;
-
- (selector: Type | string): any;
-
- }
-
-
- interface ViewChildrenFactory {
-
- new(selector: Type | string): ViewChildrenMetadata;
-
- (selector: Type | string): any;
-
- }
-
-
- interface ViewChildFactory {
-
- new(selector: Type | string): ViewChildFactory;
-
- (selector: Type | string): any;
-
- }
-
-
- /**
- * {@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, pure?: boolean}): any;
-
- (obj: {name: string, pure?: boolean}): any;
-
- }
-
-
- /**
- * {@link InputMetadata} factory for creating decorators.
- *
- * See {@link InputMetadata}.
- */
- interface InputFactory {
-
- new(bindingPropertyName?: string): any;
-
- (bindingPropertyName?: string): any;
-
- }
-
-
- /**
- * {@link OutputMetadata} factory for creating decorators.
- *
- * See {@link OutputMetadata}.
- */
- interface OutputFactory {
-
- new(bindingPropertyName?: string): any;
-
- (bindingPropertyName?: string): any;
-
- }
-
-
- /**
- * {@link HostBindingMetadata} factory function.
- */
- interface HostBindingFactory {
-
- new(hostPropertyName?: string): any;
-
- (hostPropertyName?: string): any;
-
- }
-
-
- /**
- * {@link HostListenerMetadata} factory function.
- */
- interface HostListenerFactory {
-
- new(eventName: string, args?: string[]): any;
-
- (eventName: string, args?: string[]): any;
-
- }
-
-
- /**
- * {@link ComponentMetadata} factory function.
- */
- var Component: ComponentFactory;
-
-
-
- /**
- * {@link DirectiveMetadata} factory function.
- */
- var Directive: DirectiveFactory;
-
-
-
- /**
- * {@link ViewMetadata} factory function.
- */
- var View: ViewFactory;
-
-
-
- /**
- * {@link AttributeMetadata} factory function.
- */
- var Attribute: AttributeFactory;
-
-
-
- /**
- * {@link QueryMetadata} factory function.
- */
- var Query: QueryFactory;
-
-
-
- /**
- * {@link ContentChildrenMetadata} factory function.
- */
- var ContentChildren: ContentChildrenFactory;
-
-
-
- /**
- * {@link ContentChildMetadata} factory function.
- */
- var ContentChild: ContentChildFactory;
-
-
-
- /**
- * {@link ViewChildrenMetadata} factory function.
- */
- var ViewChildren: ViewChildrenFactory;
-
-
-
- /**
- * {@link ViewChildMetadata} factory function.
- */
- var ViewChild: ViewChildFactory;
-
-
-
- /**
- * {@link di/ViewQueryMetadata} factory function.
- */
- var ViewQuery: QueryFactory;
-
-
-
- /**
- * {@link PipeMetadata} factory function.
- */
- var Pipe: PipeFactory;
-
-
-
- /**
- * {@link InputMetadata} factory function.
- *
- * See {@link InputMetadata}.
- */
- var Input: InputFactory;
-
-
-
- /**
- * {@link OutputMetadata} factory function.
- *
- * See {@link OutputMetadatas}.
- */
- var Output: OutputFactory;
-
-
-
- /**
- * {@link HostBindingMetadata} factory function.
- */
- var HostBinding: HostBindingFactory;
-
-
-
- /**
- * {@link HostListenerMetadata} factory function.
- */
- var HostListener: HostListenerFactory;
-
-
-
- /**
- * 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 = ng.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.
- */
- <T extends Type>(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;
-
- }
-
-
- /**
- * A parameter metadata that specifies a dependency.
- *
- * ### Example ([live demo](http://plnkr.co/edit/6uHYJK?p=preview))
- *
- * ```typescript
- * class Engine {}
- *
- * @Injectable()
- * class Car {
- * engine;
- * constructor(@Inject("MyEngine") engine:Engine) {
- * this.engine = engine;
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([
- * bind("MyEngine").toClass(Engine),
- * Car
- * ]);
- *
- * expect(injector.get(Car).engine instanceof Engine).toBe(true);
- * ```
- *
- * When `@Inject()` is not present, {@link Injector} will use the type annotation of the parameter.
- *
- * ### Example
- *
- * ```typescript
- * class Engine {}
- *
- * @Injectable()
- * class Car {
- * constructor(public engine: Engine) {} //same as constructor(@Inject(Engine) engine:Engine)
- * }
- *
- * var injector = Injector.resolveAndCreate([Engine, Car]);
- * expect(injector.get(Car).engine instanceof Engine).toBe(true);
- * ```
- */
- class InjectMetadata {
-
- constructor(token: any);
-
- token: any;
-
- toString(): string;
-
- }
-
-
- /**
- * A parameter metadata that marks a dependency as optional. {@link Injector} provides `null` if
- * the dependency is not found.
- *
- * ### Example ([live demo](http://plnkr.co/edit/AsryOm?p=preview))
- *
- * ```typescript
- * class Engine {}
- *
- * @Injectable()
- * class Car {
- * engine;
- * constructor(@Optional() engine:Engine) {
- * this.engine = engine;
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([Car]);
- * expect(injector.get(Car).engine).toBeNull();
- * ```
- */
- class OptionalMetadata {
-
- toString(): string;
-
- }
-
-
- /**
- * A marker metadata that marks a class as available to {@link Injector} for creation.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Wk4DMQ?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class UsefulService {}
- *
- * @Injectable()
- * class NeedsService {
- * constructor(public service:UsefulService) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([NeedsService, UsefulService]);
- * expect(injector.get(NeedsService).service instanceof UsefulService).toBe(true);
- * ```
- * {@link Injector} will throw {@link NoAnnotationError} when trying to instantiate a class that
- * does not have `@Injectable` marker, as shown in the example below.
- *
- * ```typescript
- * class UsefulService {}
- *
- * class NeedsService {
- * constructor(public service:UsefulService) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([NeedsService, UsefulService]);
- * expect(() => injector.get(NeedsService)).toThrowError();
- * ```
- */
- class InjectableMetadata {
-
- constructor();
-
- }
-
-
- /**
- * Specifies that an {@link Injector} should retrieve a dependency only from itself.
- *
- * ### Example ([live demo](http://plnkr.co/edit/NeagAg?p=preview))
- *
- * ```typescript
- * class Dependency {
- * }
- *
- * @Injectable()
- * class NeedsDependency {
- * dependency;
- *
- * dependency;
- * constructor(@Self() dependency:Dependency) {
- * this.dependency = dependency;
- * }
- * }
- *
- * var inj = Injector.resolveAndCreate([Dependency, NeedsDependency]);
- * var nd = inj.get(NeedsDependency);
- *
- * expect(nd.dependency instanceof Dependency).toBe(true);
- *
- * var inj = Injector.resolveAndCreate([Dependency]);
- * var child = inj.resolveAndCreateChild([NeedsDependency]);
- * expect(() => child.get(NeedsDependency)).toThrowError();
- * ```
- */
- class SelfMetadata {
-
- toString(): string;
-
- }
-
-
- /**
- * Specifies that an injector should retrieve a dependency from any injector until reaching the
- * closest host.
- *
- * In Angular, a component element is automatically declared as a host for all the injectors in
- * its view.
- *
- * ### Example ([live demo](http://plnkr.co/edit/GX79pV?p=preview))
- *
- * In the following example `App` contains `ParentCmp`, which contains `ChildDirective`.
- * So `ParentCmp` is the host of `ChildDirective`.
- *
- * `ChildDirective` depends on two services: `HostService` and `OtherService`.
- * `HostService` is defined at `ParentCmp`, and `OtherService` is defined at `App`.
- *
- * ```typescript
- * class OtherService {}
- * class HostService {}
- *
- * @Directive({
- * selector: 'child-directive'
- * })
- * class ChildDirective {
- * constructor(@Optional() @Host() os:OtherService, @Optional() @Host() hs:HostService){
- * console.log("os is null", os);
- * console.log("hs is NOT null", hs);
- * }
- * }
- *
- * @Component({
- * selector: 'parent-cmp',
- * bindings: [HostService]
- * })
- * @View({
- * template: `
- * Dir: <child-directive></child-directive>
- * `,
- * directives: [ChildDirective]
- * })
- * class ParentCmp {
- * }
- *
- * @Component({
- * selector: 'app',
- * bindings: [OtherService]
- * })
- * @View({
- * template: `
- * Parent: <parent-cmp></parent-cmp>
- * `,
- * directives: [ParentCmp]
- * })
- * class App {
- * }
- *
- * bootstrap(App);
- * ```
- */
- class HostMetadata {
-
- toString(): string;
-
- }
-
-
- /**
- * Specifies that the dependency resolution should start from the parent injector.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Wchdzb?p=preview))
- *
- * ```typescript
- * class Dependency {
- * }
- *
- * @Injectable()
- * class NeedsDependency {
- * dependency;
- * constructor(@SkipSelf() dependency:Dependency) {
- * this.dependency = dependency;
- * }
- * }
- *
- * var parent = Injector.resolveAndCreate([Dependency]);
- * var child = parent.resolveAndCreateChild([NeedsDependency]);
- * expect(child.get(NeedsDependency).dependency instanceof Depedency).toBe(true);
- *
- * var inj = Injector.resolveAndCreate([Dependency, NeedsDependency]);
- * expect(() => inj.get(NeedsDependency)).toThrowError();
- * ```
- */
- class SkipSelfMetadata {
-
- toString(): string;
-
- }
-
-
- /**
- * `DependencyMetadata` is used by the framework to extend DI.
- * This is internal to Angular and should not be used directly.
- */
- class DependencyMetadata {
-
- token: any;
-
- }
-
-
- /**
- * Allows to refer to references which are not yet defined.
- *
- * For instance, `forwardRef` is used when the `token` which we need to refer to for the purposes of
- * DI is declared,
- * but not yet defined. It is also used when the `token` which we use when creating a query is not
- * yet defined.
- *
- * ### Example ([live demo](http://plnkr.co/edit/bRs0SX2OTQiJzqvjgl8P?p=preview))
- *
- * ```typescript
- * class Door {
- * lock: Lock;
- * constructor(@Inject(forwardRef(() => Lock)) lock:Lock) {
- * this.lock = lock;
- * }
- * }
- *
- * // Only at this point Lock is defined.
- * class Lock {
- * }
- *
- * var injector = Injector.resolveAndCreate([Door, Lock]);
- * var door = injector.get(Door);
- * expect(door instanceof Door).toBe(true);
- * expect(door.lock instanceof Lock).toBe(true);
- * ```
- */
- function forwardRef(forwardRefFn: ForwardRefFn): Type;
-
-
-
- /**
- * Lazily retrieves the reference value from a forwardRef.
- *
- * Acts as the identity function when given a non-forward-ref value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/GU72mJrk1fiodChcmiDR?p=preview))
- *
- * ```typescript
- * var ref = forwardRef(() => "refValue");
- * expect(resolveForwardRef(ref)).toEqual("refValue");
- * expect(resolveForwardRef("regularValue")).toEqual("regularValue");
- * ```
- *
- * See: {@link forwardRef}
- */
- function resolveForwardRef(type: any): any;
-
-
-
- /**
- * An interface that a function passed into {@link forwardRef} has to implement.
- *
- * ### Example
- *
- * ```typescript
- * var fn:ForwardRefFn = forwardRef(() => Lock);
- * ```
- */
- interface ForwardRefFn {
-
- (): any;
-
- }
-
-
- /**
- * A dependency injection container used for instantiating objects and 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 ([live demo](http://plnkr.co/edit/jzjec0?p=preview))
- *
- * The following example creates an `Injector` configured to create `Engine` and `Car`.
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Car, Engine]);
- * var car = injector.get(Car);
- * expect(car instanceof Car).toBe(true);
- * expect(car.engine instanceof Engine).toBe(true);
- * ```
- *
- * Notice, 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 {
-
- /**
- * Private
- */
- constructor(_proto: any, _parent?: Injector, _depProvider?: any, _debugContext?: Function);
-
- /**
- * Turns an array of binding definitions into an array of resolved bindings.
- *
- * A resolution is a process of flattening multiple nested arrays and converting individual
- * bindings into an array of {@link ResolvedBinding}s.
- *
- * ### Example ([live demo](http://plnkr.co/edit/AiXTHi?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var bindings = Injector.resolve([Car, [[Engine]]]);
- *
- * expect(bindings.length).toEqual(2);
- *
- * expect(bindings[0] instanceof ResolvedBinding).toBe(true);
- * expect(bindings[0].key.displayName).toBe("Car");
- * expect(bindings[0].dependencies.length).toEqual(1);
- * expect(bindings[0].factory).toBeDefined();
- *
- * expect(bindings[1].key.displayName).toBe("Engine");
- * });
- * ```
- *
- * See {@link fromResolvedBindings} for more info.
- */
- static resolve(bindings: Array<Type | Binding | any[]>): ResolvedBinding[];
-
- /**
- * Resolves an array of bindings and creates an injector from those bindings.
- *
- * The passed-in bindings can be an array of `Type`, {@link Binding},
- * or a recursive array of more bindings.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ePOccA?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Car, Engine]);
- * expect(injector.get(Car) instanceof Car).toBe(true);
- * ```
- *
- * This function is slower than the corresponding `fromResolvedBindings`
- * because it needs to resolve the passed-in bindings first.
- * See {@link resolve} and {@link fromResolvedBindings}.
- */
- static resolveAndCreate(bindings: Array<Type | Binding | any[]>): Injector;
-
- /**
- * Creates an injector from previously resolved bindings.
- *
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * ### Example ([live demo](http://plnkr.co/edit/KrSMci?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var bindings = Injector.resolve([Car, Engine]);
- * var injector = Injector.fromResolvedBindings(bindings);
- * expect(injector.get(Car) instanceof Car).toBe(true);
- * ```
- */
- static fromResolvedBindings(bindings: ResolvedBinding[]): Injector;
-
- /**
- * Retrieves an instance from the injector based on the provided token.
- * Throws {@link NoBindingError} if not found.
- *
- * ### Example ([live demo](http://plnkr.co/edit/HeXSHg?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind("validToken").toValue("Value")
- * ]);
- * expect(injector.get("validToken")).toEqual("Value");
- * expect(() => injector.get("invalidToken")).toThrowError();
- * ```
- *
- * `Injector` returns itself when given `Injector` as a token.
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([]);
- * expect(injector.get(Injector)).toBe(injector);
- * ```
- */
- get(token: any): any;
-
- /**
- * Retrieves an instance from the injector based on the provided token.
- * Returns null if not found.
- *
- * ### Example ([live demo](http://plnkr.co/edit/tpEbEy?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind("validToken").toValue("Value")
- * ]);
- * expect(injector.getOptional("validToken")).toEqual("Value");
- * expect(injector.getOptional("invalidToken")).toBe(null);
- * ```
- *
- * `Injector` returns itself when given `Injector` as a token.
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([]);
- * expect(injector.getOptional(Injector)).toBe(injector);
- * ```
- */
- getOptional(token: any): any;
-
- /**
- * Parent of this injector.
- *
- * <!-- TODO: Add a link to the section of the user guide talking about hierarchical injection.
- * -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/eosMGo?p=preview))
- *
- * ```typescript
- * var parent = Injector.resolveAndCreate([]);
- * var child = parent.resolveAndCreateChild([]);
- * expect(child.parent).toBe(parent);
- * ```
- */
- parent: Injector;
-
- /**
- * Resolves an array of bindings and creates a child injector from those bindings.
- *
- * <!-- TODO: Add a link to the section of the user guide talking about hierarchical injection.
- * -->
- *
- * The passed-in bindings can be an array of `Type`, {@link Binding},
- * or a recursive array of more bindings.
- *
- * ### Example ([live demo](http://plnkr.co/edit/opB3T4?p=preview))
- *
- * ```typescript
- * class ParentBinding {}
- * class ChildBinding {}
- *
- * var parent = Injector.resolveAndCreate([ParentBinding]);
- * var child = parent.resolveAndCreateChild([ChildBinding]);
- *
- * expect(child.get(ParentBinding) instanceof ParentBinding).toBe(true);
- * expect(child.get(ChildBinding) instanceof ChildBinding).toBe(true);
- * expect(child.get(ParentBinding)).toBe(parent.get(ParentBinding));
- * ```
- *
- * This function is slower than the corresponding `createChildFromResolved`
- * because it needs to resolve the passed-in bindings first.
- * See {@link resolve} and {@link createChildFromResolved}.
- */
- resolveAndCreateChild(bindings: Array<Type | Binding | any[]>): Injector;
-
- /**
- * Creates a child injector from previously resolved bindings.
- *
- * <!-- TODO: Add a link to the section of the user guide talking about hierarchical injection.
- * -->
- *
- * This API is the recommended way to construct injectors in performance-sensitive parts.
- *
- * ### Example ([live demo](http://plnkr.co/edit/VhyfjN?p=preview))
- *
- * ```typescript
- * class ParentBinding {}
- * class ChildBinding {}
- *
- * var parentBindings = Injector.resolve([ParentBinding]);
- * var childBindings = Injector.resolve([ChildBinding]);
- *
- * var parent = Injector.fromResolvedBindings(parentBindings);
- * var child = parent.createChildFromResolved(childBindings);
- *
- * expect(child.get(ParentBinding) instanceof ParentBinding).toBe(true);
- * expect(child.get(ChildBinding) instanceof ChildBinding).toBe(true);
- * expect(child.get(ParentBinding)).toBe(parent.get(ParentBinding));
- * ```
- */
- createChildFromResolved(bindings: ResolvedBinding[]): Injector;
-
- /**
- * Resolves a binding and instantiates an object in the context of the injector.
- *
- * The created object does not get cached by the injector.
- *
- * ### Example ([live demo](http://plnkr.co/edit/yvVXoB?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Engine]);
- *
- * var car = injector.resolveAndInstantiate(Car);
- * expect(car.engine).toBe(injector.get(Engine));
- * expect(car).not.toBe(injector.resolveAndInstantiate(Car));
- * ```
- */
- resolveAndInstantiate(binding: Type | Binding): any;
-
- /**
- * Instantiates an object using a resolved binding in the context of the injector.
- *
- * The created object does not get cached by the injector.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ptCImQ?p=preview))
- *
- * ```typescript
- * @Injectable()
- * class Engine {
- * }
- *
- * @Injectable()
- * class Car {
- * constructor(public engine:Engine) {}
- * }
- *
- * var injector = Injector.resolveAndCreate([Engine]);
- * var carBinding = Injector.resolve([Car])[0];
- * var car = injector.instantiateResolved(carBinding);
- * expect(car.engine).toBe(injector.get(Engine));
- * expect(car).not.toBe(injector.instantiateResolved(carBinding));
- * ```
- */
- instantiateResolved(binding: ResolvedBinding): any;
-
- displayName: string;
-
- toString(): string;
-
- }
-
-
- /**
- * Describes how the {@link Injector} should instantiate a given token.
- *
- * See {@link bind}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/GNAyj6K6PfYg2NBzgwZ5?p%3Dpreview&p=preview))
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding("message", { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get("message")).toEqual('Hello');
- * ```
- */
- class Binding {
-
- constructor(token: any, {toClass, toValue, toAlias, toFactory, deps, multi}: {
- toClass?: Type,
- toValue?: any,
- toAlias?: any,
- toFactory?: Function,
- deps?: Object[],
- multi?: boolean
- });
-
- /**
- * Token used when retrieving this binding. Usually, it is a type {@link `Type`}.
- */
- token: any;
-
- /**
- * Binds a DI token to an implementation class.
- *
- * ### Example ([live demo](http://plnkr.co/edit/RSTG86qgmoxCyj9SWPwY?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy
- * comparison.
- *
- * ```typescript
- * 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 DI token to a value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/UFVsMVQIDe7l4waWziES?p=preview))
- *
- * ```javascript
- * var injector = Injector.resolveAndCreate([
- * new Binding("message", { toValue: 'Hello' })
- * ]);
- *
- * expect(injector.get("message")).toEqual('Hello');
- * ```
- */
- toValue: any;
-
- /**
- * Binds a DI token as an alias for an existing token.
- *
- * 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 ([live demo](http://plnkr.co/edit/QsatsOJJ6P8T2fMe9gr8?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused the example contains both use cases for easy
- * comparison.
- *
- * ```typescript
- * 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 DI token to a function which computes the value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Scoxy0pJNqKGAPZY1VVC?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * deps: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- *
- * Used in conjuction with dependencies.
- */
- toFactory: Function;
-
- /**
- * Specifies a set of dependencies
- * (as `token`s) which should be injected into the factory function.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Scoxy0pJNqKGAPZY1VVC?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding(Number, { toFactory: () => { return 1+2; }}),
- * new Binding(String, { toFactory: (value) => { return "Value: " + value; },
- * deps: [Number] })
- * ]);
- *
- * expect(injector.get(Number)).toEqual(3);
- * expect(injector.get(String)).toEqual('Value: 3');
- * ```
- *
- * Used in conjunction with `toFactory`.
- */
- dependencies: Object[];
-
- /**
- * Creates multiple bindings matching the same token (a multi-binding).
- *
- * Multi-bindings are used for creating pluggable service, where the system comes
- * with some default bindings, and the user can register additonal bindings.
- * The combination of the default bindings and the additional bindings will be
- * used to drive the behavior of the system.
- *
- * ### Example
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding("Strings", { toValue: "String1", multi: true}),
- * new Binding("Strings", { toValue: "String2", multi: true})
- * ]);
- *
- * expect(injector.get("Strings")).toEqual(["String1", "String2"]);
- * ```
- *
- * Multi-bindings and regular bindings cannot be mixed. The following
- * will throw an exception:
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * new Binding("Strings", { toValue: "String1", multi: true }),
- * new Binding("Strings", { toValue: "String2"})
- * ]);
- * ```
- */
- multi: boolean;
-
- }
-
-
- /**
- * Helper class for the {@link bind} function.
- */
- class BindingBuilder {
-
- constructor(token: any);
-
- token: any;
-
- /**
- * Binds a DI token to a class.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ZpBCSYqv6e2ud5KXLdxQ?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy comparison.
- *
- * ```typescript
- * 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 DI token to a value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/G024PFHmDL0cJFgfZK8O?p=preview))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind('message').toValue('Hello')
- * ]);
- *
- * expect(injector.get('message')).toEqual('Hello');
- * ```
- */
- toValue(value: any): Binding;
-
- /**
- * Binds a DI token as an alias for an existing token.
- *
- * 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 ([live demo](http://plnkr.co/edit/uBaoF2pN5cfc5AfZapNw?p=preview))
- *
- * Because `toAlias` and `toClass` are often confused, the example contains both use cases for
- * easy
- * comparison.
- *
- * ```typescript
- * 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 DI token to a function which computes the value.
- *
- * ### Example ([live demo](http://plnkr.co/edit/OejNIfTT3zb1iBxaIYOb?p=preview))
- *
- * ```typescript
- * 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(factory: Function, dependencies?: any[]): Binding;
-
- }
-
-
- /**
- * An internal resolved representation of a {@link Binding} used by the {@link Injector}.
- *
- * It is usually created automatically by `Injector.resolveAndCreate`.
- *
- * It can be created manually, as follows:
- *
- * ### Example ([live demo](http://plnkr.co/edit/RfEnhh8kUEI0G3qsnIeT?p%3Dpreview&p=preview))
- *
- * ```typescript
- * var resolvedBindings = Injector.resolve([new Binding('message', {toValue: 'Hello'})]);
- * var injector = Injector.fromResolvedBindings(resolvedBindings);
- *
- * expect(injector.get('message')).toEqual('Hello');
- * ```
- */
- interface ResolvedBinding {
-
- /**
- * A key, usually a `Type`.
- */
- key: Key;
-
- }
-
-
- /**
- * @private
- * An internal resolved representation of a factory function created by resolving {@link Binding}.
- */
- class ResolvedFactory {
-
- constructor(factory: Function, dependencies: Dependency[]);
-
- /**
- * 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 {
-
- constructor(key: Key, optional: boolean, lowerBoundVisibility: any, upperBoundVisibility: any, properties: any[]);
-
- static fromKey(key: Key): Dependency;
-
- key: Key;
-
- optional: boolean;
-
- lowerBoundVisibility: any;
-
- upperBoundVisibility: any;
-
- properties: any[];
-
- }
-
-
- /**
- * Creates a {@link Binding}.
- *
- * To construct a {@link Binding}, bind a `token` to either a class, a value, a factory function, or
- * to an alias to another `token`.
- * See {@link BindingBuilder} for more details.
- *
- * The `token` is most commonly a class or {@link angular2/di/OpaqueToken}.
- */
- 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`.
- *
- * `Key` is used internally by {@link Injector} because its system-wide unique `id` allows the
- * injector to store created objects in a more efficient way.
- *
- * `Key` should not be created directly. {@link Injector} creates keys automatically when resolving
- * bindings.
- */
- class Key {
-
- /**
- * Private
- */
- constructor(token: Object, id: number);
-
- /**
- * 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;
-
- /**
- * Returns a stringified token.
- */
- displayName: string;
-
- }
-
-
- /**
- * @private
- * 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}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/vq8D3FRB9aGbnWJqtEPE?p=preview))
- *
- * ```typescript
- * class A {
- * constructor(b:B) {}
- * }
- *
- * expect(() => Injector.resolveAndCreate([A])).toThrowError();
- * ```
- */
- class NoBindingError extends AbstractBindingError {
-
- constructor(injector: Injector, key: Key);
-
- }
-
-
- /**
- * Base class for all errors arising from misconfigured bindings.
- */
- class AbstractBindingError extends BaseException {
-
- constructor(injector: Injector, key: Key, constructResolvingMessage: Function);
-
- addKey(injector: Injector, key: Key): void;
-
- context: any;
-
- }
-
-
- /**
- * Thrown when dependencies form a cycle.
- *
- * ### Example ([live demo](http://plnkr.co/edit/wYQdNos0Tzql3ei1EV9j?p=info))
- *
- * ```typescript
- * var injector = Injector.resolveAndCreate([
- * bind("one").toFactory((two) => "two", [[new Inject("two")]]),
- * bind("two").toFactory((one) => "one", [[new Inject("one")]])
- * ]);
- *
- * expect(() => injector.get("one")).toThrowError();
- * ```
- *
- * Retrieving `A` or `B` throws a `CyclicDependencyError` as the graph above cannot be constructed.
- */
- class CyclicDependencyError extends AbstractBindingError {
-
- constructor(injector: Injector, key: Key);
-
- }
-
-
- /**
- * 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.
- *
- * ### Example ([live demo](http://plnkr.co/edit/7aWYdcqTQsP0eNqEdUAf?p=preview))
- *
- * ```typescript
- * class A {
- * constructor() {
- * throw new Error('message');
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([A]);
- *
- * try {
- * injector.get(A);
- * } catch (e) {
- * expect(e instanceof InstantiationError).toBe(true);
- * expect(e.originalException.message).toEqual("message");
- * expect(e.originalStack).toBeDefined();
- * }
- * ```
- */
- interface InstantiationError extends WrappedException {
-
- addKey(injector: Injector, key: Key): void;
-
- wrapperMessage: string;
-
- causeKey: Key;
-
- context: any;
-
- }
-
-
- /**
- * Thrown when an object other then {@link Binding} (or `Type`) is passed to {@link Injector}
- * creation.
- *
- * ### Example ([live demo](http://plnkr.co/edit/YatCFbPAMCL0JSSQ4mvH?p=preview))
- *
- * ```typescript
- * expect(() => Injector.resolveAndCreate(["not a type"])).toThrowError();
- * ```
- */
- class InvalidBindingError extends BaseException {
-
- constructor(binding: any);
-
- }
-
-
- /**
- * 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.
- *
- * ### Example ([live demo](http://plnkr.co/edit/rHnZtlNS7vJOPQ6pcVkm?p=preview))
- *
- * ```typescript
- * class A {
- * constructor(b) {}
- * }
- *
- * expect(() => Injector.resolveAndCreate([A])).toThrowError();
- * ```
- *
- * This error is also thrown when the class not marked with {@link @Injectable} has parameter types.
- *
- * ```typescript
- * class B {}
- *
- * class A {
- * constructor(b:B) {} // no information about the parameter types of A is available at runtime.
- * }
- *
- * expect(() => Injector.resolveAndCreate([A,B])).toThrowError();
- * ```
- */
- class NoAnnotationError extends BaseException {
-
- constructor(typeOrFunc: any, params: any[][]);
-
- }
-
-
- /**
- * Thrown when getting an object by index.
- *
- * ### Example ([live demo](http://plnkr.co/edit/bRs0SX2OTQiJzqvjgl8P?p=preview))
- *
- * ```typescript
- * class A {}
- *
- * var injector = Injector.resolveAndCreate([A]);
- *
- * expect(() => injector.getAt(100)).toThrowError();
- * ```
- */
- class OutOfBoundsError extends BaseException {
-
- constructor(index: any);
-
- }
-
-
- /**
- * Creates a token that can be used in a DI Binding.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Ys9ezXpj2Mnoy3Uc8KBp?p=preview))
- *
- * ```typescript
- * var t = new OpaqueToken("binding");
- *
- * var injector = Injector.resolveAndCreate([
- * bind(t).toValue("bindingValue")
- * ]);
- *
- * expect(injector.get(t)).toEqual("bindingValue");
- * ```
- *
- * Using an `OpaqueToken` is preferable to using strings as tokens because of possible collisions
- * caused by multiple bindings using the same string as two different tokens.
- *
- * Using an `OpaqueToken` is preferable to using an `Object` as tokens because it provides better
- * error messages.
- */
- class OpaqueToken {
-
- constructor(_desc: string);
-
- 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;
-
-
-
- /**
- * The `async` pipe subscribes to an Observable or Promise and returns the latest value it has
- * emitted.
- * When a new value is emitted, the `async` pipe marks the component to be checked for changes.
- *
- * # Example
- * The example below binds the `time` Observable to the view. Every 500ms, the `time` Observable
- * updates the view with the current time.
- *
- * ```
- * import {Observable} from 'angular2/core';
- * @Component({
- * selector: "task-cmp"
- * })
- * @View({
- * template: "Time: {{ time | async }}"
- * })
- * class Task {
- * time = new Observable<number>(observer => {
- * setInterval(_ =>
- * observer.next(new Date().getTime()), 500);
- * });
- * }
- * ```
- */
- class AsyncPipe implements PipeTransform, PipeOnDestroy {
-
- constructor(_ref: ChangeDetectorRef);
-
- onDestroy(): void;
-
- transform(obj: Observable | Promise<any>, args?: any[]): any;
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a date value to a string based on the requested format.
- *
- * # Usage
- *
- * expression | date[:format]
- *
- * where `expression` is a date object or a number (milliseconds since UTC epoch) and
- * `format` indicates which date/time components to include:
- *
- * | Component | Symbol | Short Form | Long Form | Numeric | 2-digit |
- * |-----------|:------:|--------------|-------------------|-----------|-----------|
- * | era | G | G (AD) | GGGG (Anno Domini)| - | - |
- * | year | y | - | - | y (2015) | yy (15) |
- * | month | M | MMM (Sep) | MMMM (September) | M (9) | MM (09) |
- * | day | d | - | - | d (3) | dd (03) |
- * | weekday | E | EEE (Sun) | EEEE (Sunday) | - | - |
- * | hour | j | - | - | j (13) | jj (13) |
- * | hour12 | h | - | - | h (1 PM) | hh (01 PM)|
- * | hour24 | H | - | - | H (13) | HH (13) |
- * | minute | m | - | - | m (5) | mm (05) |
- * | second | s | - | - | s (9) | ss (09) |
- * | timezone | z | - | z (Pacific Standard Time)| - | - |
- * | timezone | Z | Z (GMT-8:00) | - | - | - |
- *
- * In javascript, only the components specified will be respected (not the ordering,
- * punctuations, ...) and details of the formatting will be dependent on the locale.
- * On the other hand in Dart version, you can also include quoted text as well as some extra
- * date/time components such as quarter. For more information see:
- * https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/intl/intl.DateFormat.
- *
- * `format` can also be one of the following predefined formats:
- *
- * - `'medium'`: equivalent to `'yMMMdjms'` (e.g. Sep 3, 2010, 12:05:08 PM for en-US)
- * - `'short'`: equivalent to `'yMdjm'` (e.g. 9/3/2010, 12:05 PM for en-US)
- * - `'fullDate'`: equivalent to `'yMMMMEEEEd'` (e.g. Friday, September 3, 2010 for en-US)
- * - `'longDate'`: equivalent to `'yMMMMd'` (e.g. September 3, 2010)
- * - `'mediumDate'`: equivalent to `'yMMMd'` (e.g. Sep 3, 2010 for en-US)
- * - `'shortDate'`: equivalent to `'yMd'` (e.g. 9/3/2010 for en-US)
- * - `'mediumTime'`: equivalent to `'jms'` (e.g. 12:05:08 PM for en-US)
- * - `'shortTime'`: equivalent to `'jm'` (e.g. 12:05 PM for en-US)
- *
- * Timezone of the formatted text will be the local system timezone of the end-users machine.
- *
- * # Examples
- *
- * Assuming `dateObj` is (year: 2015, month: 6, day: 15, hour: 21, minute: 43, second: 11)
- * in the _local_ time and locale is 'en-US':
- *
- * {{ dateObj | date }} // output is 'Jun 15, 2015'
- * {{ dateObj | date:'medium' }} // output is 'Jun 15, 2015, 9:43:11 PM'
- * {{ dateObj | date:'shortTime' }} // output is '9:43 PM'
- * {{ dateObj | date:'mmss' }} // output is '43:11'
- */
- class DatePipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- supports(obj: any): boolean;
-
- }
-
-
- let DEFAULT_PIPES: Binding;
-
-
-
- let DEFAULT_PIPES_TOKEN: OpaqueToken;
-
-
-
- /**
- * Implements json transforms to any object.
- *
- * # Example
- *
- * In this example we transform the user object to json.
- *
- * ```
- * @Component({
- * selector: "user-cmp"
- * })
- * @View({
- * template: "User: {{ user | json }}"
- * })
- * class Username {
- * user:Object
- * constructor() {
- * this.user = { name: "PatrickJS" };
- * }
- * }
- *
- * ```
- */
- class JsonPipe implements PipeTransform {
-
- transform(value: any, args?: any[]): string;
-
- }
-
-
- /**
- * Creates a new List or String containing only a subset (slice) of the
- * elements.
- *
- * The starting index of the subset to return is specified by the `start` parameter.
- *
- * The ending index of the subset to return is specified by the optional `end` parameter.
- *
- * # Usage
- *
- * expression | slice:start[:end]
- *
- * All behavior is based on the expected behavior of the JavaScript API
- * Array.prototype.slice() and String.prototype.slice()
- *
- * Where the input expression is a [List] or [String], and `start` is:
- *
- * - **a positive integer**: return the item at _start_ index and all items after
- * in the list or string expression.
- * - **a negative integer**: return the item at _start_ index from the end and all items after
- * in the list or string expression.
- * - **`|start|` greater than the size of the expression**: return an empty list or string.
- * - **`|start|` negative greater than the size of the expression**: return entire list or
- * string expression.
- *
- * and where `end` is:
- *
- * - **omitted**: return all items until the end of the input
- * - **a positive integer**: return all items before _end_ index of the list or string
- * expression.
- * - **a negative integer**: return all items before _end_ index from the end of the list
- * or string expression.
- *
- * When operating on a [List], the returned list is always a copy even when all
- * the elements are being returned.
- *
- * # Examples
- *
- * ## List Example
- *
- * Assuming `var collection = ['a', 'b', 'c', 'd']`, this `ng-for` directive:
- *
- * <li *ng-for="var i in collection | slice:1:3">{{i}}</li>
- *
- * produces the following:
- *
- * <li>b</li>
- * <li>c</li>
- *
- * ## String Examples
- *
- * {{ 'abcdefghij' | slice:0:4 }} // output is 'abcd'
- * {{ 'abcdefghij' | slice:4:0 }} // output is ''
- * {{ 'abcdefghij' | slice:-4 }} // output is 'ghij'
- * {{ 'abcdefghij' | slice:-4,-2 }} // output is 'gh'
- * {{ 'abcdefghij' | slice: -100 }} // output is 'abcdefghij'
- * {{ 'abcdefghij' | slice: 100 }} // output is ''
- */
- class SlicePipe implements PipeTransform {
-
- transform(value: any, args?: any[]): any;
-
- supports(obj: any): boolean;
-
- }
-
-
- /**
- * Implements lowercase transforms to text.
- *
- * # Example
- *
- * In this example we transform the user text lowercase.
- *
- * ```
- * @Component({
- * selector: "username-cmp"
- * })
- * @View({
- * template: "Username: {{ user | lowercase }}"
- * })
- * class Username {
- * user:string;
- * }
- *
- * ```
- */
- class LowerCasePipe implements PipeTransform {
-
- transform(value: string, args?: any[]): string;
-
- }
-
-
- class NumberPipe {
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a number as local text. i.e. group sizing and separator and other locale-specific
- * configurations are based on the active locale.
- *
- * # Usage
- *
- * expression | number[:digitInfo]
- *
- * where `expression` is a number and `digitInfo` has the following format:
- *
- * {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}
- *
- * - minIntegerDigits is the minimum number of integer digits to use. Defaults to 1.
- * - minFractionDigits is the minimum number of digits after fraction. Defaults to 0.
- * - maxFractionDigits is the maximum number of digits after fraction. Defaults to 3.
- *
- * For more information on the acceptable range for each of these numbers and other
- * details see your native internationalization library.
- *
- * # Examples
- *
- * {{ 123 | number }} // output is 123
- * {{ 123.1 | number: '.2-3' }} // output is 123.10
- * {{ 1 | number: '2.2' }} // output is 01.00
- */
- class DecimalPipe extends NumberPipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a number as local percent.
- *
- * # Usage
- *
- * expression | percent[:digitInfo]
- *
- * For more information about `digitInfo` see {@link DecimalPipe}
- */
- class PercentPipe extends NumberPipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- }
-
-
- /**
- * WARNING: this pipe uses the Internationalization API.
- * Therefore it is only reliable in Chrome and Opera browsers.
- *
- * Formats a number as local currency.
- *
- * # Usage
- *
- * expression | currency[:currencyCode[:symbolDisplay[:digitInfo]]]
- *
- * where `currencyCode` is the ISO 4217 currency code, such as "USD" for the US dollar and
- * "EUR" for the euro. `symbolDisplay` is a boolean indicating whether to use the currency
- * symbol (e.g. $) or the currency code (e.g. USD) in the output. The default for this value
- * is `false`.
- * For more information about `digitInfo` see {@link DecimalPipe}
- */
- class CurrencyPipe extends NumberPipe implements PipeTransform {
-
- transform(value: any, args: any[]): string;
-
- }
-
-
- /**
- * Implements uppercase transforms to text.
- *
- * # Example
- *
- * In this example we transform the user text uppercase.
- *
- * ```
- * @Component({
- * selector: "username-cmp"
- * })
- * @View({
- * template: "Username: {{ user | uppercase }}"
- * })
- * class Username {
- * user:string;
- * }
- *
- * ```
- */
- class UpperCasePipe implements PipeTransform {
-
- transform(value: string, args?: any[]): string;
-
- }
-
-
- /**
- *
- * Runtime representation a type that a Component or other object is instances of.
- *
- * An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by
- * the `MyCustomComponent` constructor function.
- */
- interface Type extends Function {
-
- new(...args: any[]): any;
-
- }
-
-
- class Observable {
-
- observer(generator: any): Object;
-
- }
-
-
- /**
- * Use by directives and components to emit custom Events.
- *
- * ## Examples
- *
- * In the following example, `Zippy` alternatively emits `open` and `close` events when its
- * title gets clicked:
- *
- * ```
- * @Component({selector: 'zippy'})
- * @View({template: `
- * <div class="zippy">
- * <div (click)="toggle()">Toggle</div>
- * <div [hidden]="!visible">
- * <ng-content></ng-content>
- * </div>
- * </div>`})
- * export class Zippy {
- * visible: boolean = true;
- * @Output() open: EventEmitter = new EventEmitter();
- * @Output() close: EventEmitter = new EventEmitter();
- *
- * toggle() {
- * this.visible = !this.visible;
- * if (this.visible) {
- * this.open.next(null);
- * } else {
- * this.close.next(null);
- * }
- * }
- * }
- * ```
- *
- * 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): any;
-
- toRx(): any;
-
- next(value: any): void;
-
- throw(error: any): void;
-
- return(value?: any): void;
-
- }
-
-
- interface Predicate<T> {
-
- (value: T, index?: number, array?: T[]): boolean;
-
- }
-
-
- class WrappedException extends Error {
-
- constructor(_wrapperMessage: string, _originalException: any, _originalStack?: any, _context?: any);
-
- wrapperMessage: string;
-
- wrapperStack: any;
-
- originalException: any;
-
- originalStack: any;
-
- context: any;
-
- message: string;
-
- toString(): string;
-
- }
-
-
- /**
- * Constructs the set of bindings meant for use at the platform level.
- *
- * These are bindings that should be singletons shared among all Angular applications
- * running on the page.
- */
- function platformBindings(): Array<Type | Binding | any[]>;
-
-
-
- /**
- * Construct a default set of bindings which should be included in any Angular
- * application, regardless of whether it runs on the UI thread or in a web worker.
- */
- function applicationCommonBindings(): Array<Type | Binding | any[]>;
-
-
-
- /**
- * Create an Angular zone.
- */
- function createNgZone(): NgZone;
-
-
-
- /**
- * @private
- */
- function platformCommon(bindings?: Array<Type | Binding | any[]>, initializer?: () => void): PlatformRef;
-
-
-
- /**
- * The Angular platform is the entry point for Angular on a web page. Each page
- * has exactly one platform, and services (such as reflection) which are common
- * to every Angular application running on the page are bound in its scope.
- *
- * A page's platform is initialized implicitly when {@link bootstrap}() is called, or
- * explicitly by calling {@link platform}().
- */
- interface PlatformRef {
-
- /**
- * Retrieve the platform {@link Injector}, which is the parent injector for
- * every Angular application on the page and provides singleton bindings.
- */
- injector: Injector;
-
- /**
- * Instantiate a new Angular application on the page.
- *
- * # What is an application?
- *
- * Each Angular application has its own zone, change detection, compiler,
- * renderer, and other framework components. An application hosts one or more
- * root components, which can be initialized via `ApplicationRef.bootstrap()`.
- *
- * # Application Bindings
- *
- * Angular applications require numerous bindings to be properly instantiated.
- * When using `application()` to create a new app on the page, these bindings
- * must be provided. Fortunately, there are helper functions to configure
- * typical bindings, as shown in the example below.
- *
- * # Example
- * ```
- * var myAppBindings = [MyAppService];
- *
- * platform()
- * .application([applicationCommonBindings(), applicationDomBindings(), myAppBindings])
- * .bootstrap(MyTopLevelComponent);
- * ```
- * # See Also
- *
- * See the {@link bootstrap} documentation for more details.
- */
- application(bindings: Array<Type | Binding | any[]>): ApplicationRef;
-
- /**
- * Instantiate a new Angular application on the page, using bindings which
- * are only available asynchronously. One such use case is to initialize an
- * application running in a web worker.
- *
- * # Usage
- *
- * `bindingFn` is a function that will be called in the new application's zone.
- * It should return a {@link Promise} to a list of bindings to be used for the
- * new application. Once this promise resolves, the application will be
- * constructed in the same manner as a normal `application()`.
- */
- asyncApplication(bindingFn: (zone: NgZone) =>
- Promise<Array<Type | Binding | any[]>>): Promise<ApplicationRef>;
-
- /**
- * Destroy the Angular platform and all Angular applications on the page.
- */
- dispose(): void;
-
- }
-
-
- /**
- * A reference to an Angular application running on a page.
- *
- * For more about Angular applications, see the documentation for {@link bootstrap}.
- */
- interface ApplicationRef {
-
- /**
- * Register a listener to be called each time `bootstrap()` is called to bootstrap
- * a new root component.
- */
- registerBootstrapListener(listener: (ref: ComponentRef) => void): void;
-
- /**
- * Bootstrap a new component at the root level of the application.
- *
- * # Bootstrap process
- *
- * When bootstrapping a new root component into an application, Angular mounts the
- * specified application component onto DOM elements identified by the [componentType]'s
- * selector and kicks off automatic change detection to finish initializing the component.
- *
- * # Optional Bindings
- *
- * Bindings for the given component can optionally be overridden via the `bindings`
- * parameter. These bindings will only apply for the root component being added and any
- * child components under it.
- *
- * # Example
- * ```
- * var app = platform.application([applicationCommonBindings(), applicationDomBindings()];
- * app.bootstrap(FirstRootComponent);
- * app.bootstrap(SecondRootComponent, [bind(OverrideBinding).toClass(OverriddenBinding)]);
- * ```
- */
- bootstrap(componentType: Type, bindings?: Array<Type | Binding | any[]>): Promise<ComponentRef>;
-
- /**
- * Retrieve the application {@link Injector}.
- */
- injector: Injector;
-
- /**
- * Retrieve the application {@link NgZone}.
- */
- zone: NgZone;
-
- /**
- * Dispose of this application and all of its components.
- */
- dispose(): void;
-
- }
-
-
- /**
- * 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 {
-
- constructor(value: string);
-
- /**
- * 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;
-
- }
-
-
- /**
- * A service that can be used to get and set the title of a current HTML document.
- *
- * Since an Angular 2 application can't be bootstrapped on the entire HTML document (`<html>` tag)
- * it is not possible to bind to the `text` property of the `HTMLTitleElement` elements
- * (representing the `<title>` tag). Instead, this service can be used to set and get the current
- * title value.
- */
- class Title {
-
- /**
- * Get the title of the current HTML document.
- * @returns {string}
- */
- getTitle(): string;
-
- /**
- * Set the title of the current HTML document.
- * @param newTitle
- */
- setTitle(newTitle: string): void;
-
- }
-
-
- class DirectiveResolver {
-
- /**
- * Return {@link DirectiveMetadata} for a given `Type`.
- */
- resolve(type: Type): DirectiveMetadata;
-
- }
-
-
- /**
- * Low-level service for compiling {@link Component}s into {@link ProtoViewRef ProtoViews}s, which
- * can later be used to create and render a Component instance.
- *
- * Most applications should instead use higher-level {@link DynamicComponentLoader} service, which
- * both compiles and instantiates a Component.
- */
- interface Compiler {
-
- compileInHost(componentType: Type): Promise<ProtoViewRef>;
-
- clearCache(): void;
-
- }
-
-
- /**
- * Service exposing low level API for creating, moving and destroying Views.
- *
- * Most applications should use higher-level abstractions like {@link DynamicComponentLoader} and
- * {@link ViewContainerRef} instead.
- */
- interface AppViewManager {
-
- /**
- * Returns a {@link ViewContainerRef} of the View Container at the specified location.
- */
- getViewContainer(location: ElementRef): ViewContainerRef;
-
- /**
- * Returns the {@link ElementRef} that makes up the specified Host View.
- */
- getHostElement(hostViewRef: HostViewRef): ElementRef;
-
- /**
- * Searches the Component View of the Component specified via `hostLocation` and returns the
- * {@link ElementRef} for the Element identified via a Variable Name `variableName`.
- *
- * Throws an exception if the specified `hostLocation` is not a Host Element of a Component, or if
- * variable `variableName` couldn't be found in the Component View of this Component.
- */
- getNamedElementInComponentView(hostLocation: ElementRef, variableName: string): ElementRef;
-
- /**
- * Returns the component instance for the provided Host Element.
- */
- getComponent(hostLocation: ElementRef): any;
-
- /**
- * Creates an instance of a Component and attaches it to the first element in the global View
- * (usually DOM Document) that matches the component's selector or `overrideSelector`.
- *
- * This as a low-level way to bootstrap an application and upgrade an existing Element to a
- * Host Element. Most applications should use {@link DynamicComponentLoader#loadAsRoot} instead.
- *
- * The Component and its View are created based on the `hostProtoViewRef` which can be obtained
- * by compiling the component with {@link Compiler#compileInHost}.
- *
- * Use {@link AppViewManager#destroyRootHostView} to destroy the created Component and it's Host
- * View.
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- *
- * }
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<some-component></some-component>)
- * `
- * })
- * 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;
-
- /**
- * Destroys the Host View created via {@link AppViewManager#createRootHostView}.
- *
- * Along with the Host View, the Component Instance as well as all nested View and Components are
- * destroyed as well.
- */
- destroyRootHostView(hostViewRef: HostViewRef): void;
-
- /**
- * Instantiates an Embedded View based on the {@link TemplateRef `templateRef`} and inserts it
- * into the View Container specified via `viewContainerLocation` at the specified `index`.
- *
- * Returns the {@link ViewRef} for the newly created View.
- *
- * This as a low-level way to create and attach an Embedded via to a View Container. Most
- * applications should used {@link ViewContainerRef#createEmbeddedView} instead.
- *
- * Use {@link AppViewManager#destroyViewInContainer} to destroy the created Embedded View.
- */
- createEmbeddedViewInContainer(viewContainerLocation: ElementRef, index: number, templateRef: TemplateRef): ViewRef;
-
- /**
- * Instantiates a single {@link Component} and inserts its Host View into the View Container
- * found at `viewContainerLocation`. Within the container, the view will be inserted at position
- * specified via `index`.
- *
- * The component is instantiated using its {@link ProtoViewRef `protoViewRef`} which can be
- * obtained via {@link Compiler#compileInHost}.
- *
- * You can optionally specify `imperativelyCreatedInjector`, which configure the {@link Injector}
- * that will be created for the Host View.
- *
- * Returns the {@link HostViewRef} of the Host View created for the newly instantiated Component.
- *
- * Use {@link AppViewManager#destroyViewInContainer} to destroy the created Host View.
- */
- createHostViewInContainer(viewContainerLocation: ElementRef, index: number, protoViewRef: ProtoViewRef, imperativelyCreatedInjector: ResolvedBinding[]): HostViewRef;
-
- /**
- * Destroys an Embedded or Host View attached to a View Container at the specified `index`.
- *
- * The View Container is located via `viewContainerLocation`.
- */
- destroyViewInContainer(viewContainerLocation: ElementRef, index: number): void;
-
- /**
- * See {@link AppViewManager#detachViewInContainer}.
- */
- attachViewInContainer(viewContainerLocation: ElementRef, index: number, viewRef: ViewRef): ViewRef;
-
- /**
- * See {@link AppViewManager#attachViewInContainer}.
- */
- detachViewInContainer(viewContainerLocation: ElementRef, index: number): ViewRef;
-
- }
-
-
- /**
- * An unmodifiable list of items that Angular keeps up to date when the state
- * of the application changes.
- *
- * The type of object that {@link QueryMetadata} and {@link ViewQueryMetadata} provide.
- *
- * Implements an iterable interface, therefore it can be used in both ES6
- * javascript `for (var i of items)` loops as well as in Angular templates with
- * `*ng-for="#i of myList"`.
- *
- * Changes can be observed by subscribing to the changes `Observable`.
- *
- * NOTE: In the future this class will implement an `Observable` interface.
- *
- * ### Example ([live demo](http://plnkr.co/edit/RX8sJnQYl9FWuSCWme5z?p=preview))
- * ```javascript
- * @Component({...})
- * class Container {
- * constructor(@Query(Item) items: QueryList<Item>) {
- * items.changes.subscribe(_ => console.log(items.length));
- * }
- * }
- * ```
- */
- class QueryList<T> {
-
- changes: Observable;
-
- length: number;
-
- first: T;
-
- last: T;
-
- /**
- * returns a new list with the passsed in function applied to each element.
- */
- map<U>(fn: (item: T) => U): U[];
-
- toString(): string;
-
- }
-
-
- /**
- * Service for instantiating a Component and attaching it to a View at a specified location.
- */
- interface DynamicComponentLoader {
-
- /**
- * Creates an instance of a Component `type` and attaches it to the first element in the
- * platform-specific global view that matches the component's selector.
- *
- * In a browser the platform-specific global view is the main DOM Document.
- *
- * If needed, the component's selector can be overridden via `overrideSelector`.
- *
- * You can optionally provide `injector` and this {@link Injector} will be used to instantiate the
- * Component.
- *
- * To be notified when this Component instance is destroyed, you can also optionally provide
- * `onDispose` callback.
- *
- * Returns a promise for the {@link ComponentRef} representing the newly created Component.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<child id="child"></child>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, injector: ng.Injector) {
- * dynamicComponentLoader.loadAsRoot(ChildComponent, '#child', injector);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <child id="child">
- * Child
- * </child>
- * )
- * </my-app>
- * ```
- */
- loadAsRoot(type: Type, overrideSelector: string, injector: Injector, onDispose?: () => void): Promise<ComponentRef>;
-
- /**
- * Creates an instance of a Component and attaches it to a View Container located inside of the
- * Component View of another Component instance.
- *
- * The targeted Component Instance is specified via its `hostLocation` {@link ElementRef}. The
- * location within the Component View of this Component Instance is specified via `anchorName`
- * Template Variable Name.
- *
- * You can optionally provide `bindings` to configure the {@link Injector} provisioned for this
- * Component Instance.
- *
- * Returns a promise for the {@link ComponentRef} representing the newly created Component.
- *
- *
- * ## Example
- *
- * ```
- * @ng.Component({
- * selector: 'child-component'
- * })
- * @ng.View({
- * template: 'Child'
- * })
- * class ChildComponent {
- * }
- *
- *
- * @ng.Component({
- * selector: 'my-app'
- * })
- * @ng.View({
- * template: `
- * Parent (<div #child></div>)
- * `
- * })
- * class MyApp {
- * constructor(dynamicComponentLoader: ng.DynamicComponentLoader, elementRef: ng.ElementRef) {
- * dynamicComponentLoader.loadIntoLocation(ChildComponent, elementRef, 'child');
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>
- * Parent (
- * <div #child="" class="ng-binding"></div>
- * <child-component class="ng-binding">Child</child-component>
- * )
- * </my-app>
- * ```
- */
- loadIntoLocation(type: Type, hostLocation: ElementRef, anchorName: string, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
-
- /**
- * Creates an instance of a Component and attaches it to the View Container found at the
- * `location` specified as {@link ElementRef}.
- *
- * You can optionally provide `bindings` to configure the {@link Injector} provisioned for this
- * Component Instance.
- *
- * Returns a promise for the {@link ComponentRef} representing the newly created Component.
- *
- *
- * ## 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.loadNextToLocation(ChildComponent, elementRef);
- * }
- * }
- *
- * ng.bootstrap(MyApp);
- * ```
- *
- * Resulting DOM:
- *
- * ```
- * <my-app>Parent</my-app>
- * <child-component>Child</child-component>
- * ```
- */
- loadNextToLocation(type: Type, location: ElementRef, bindings?: ResolvedBinding[]): Promise<ComponentRef>;
-
- }
-
-
- /**
- * Represents a location in a View that has an injection, change-detection and render context
- * associated with it.
- *
- * An `ElementRef` is created for each element in the Template that contains a Directive, Component
- * or data-binding.
- *
- * An `ElementRef` is backed by a render-specific element. In the browser, this is usually a DOM
- * element.
- */
- interface ElementRef extends RenderElementRef {
-
- /**
- * The underlying native element or `null` if direct access to native elements is not supported
- * (e.g. when the application runs in a web worker).
- *
- * <div class="callout is-critical">
- * <header>Use with caution</header>
- * <p>
- * Use this API as the last resort when direct access to DOM is needed. Use templating and
- * data-binding provided by Angular instead. Alternatively you take a look at {@link Renderer}
- * which provides API that can safely be used even when direct access to native elements is not
- * supported.
- * </p>
- * <p>
- * Relying on direct DOM access creates tight coupling between your application and rendering
- * layers which will make it impossible to separate the two and deploy your application into a
- * web worker.
- * </p>
- * </div>
- */
- nativeElement: any;
-
- }
-
-
- /**
- * Represents an Embedded Template that can be used to instantiate Embedded Views.
- *
- * You can access a `TemplateRef`, in two ways. Via a directive placed on a `<template>` element (or
- * directive prefixed with `*`) and have the `TemplateRef` for this Embedded View injected into the
- * constructor of the directive using the `TemplateRef` Token. Alternatively you can query for the
- * `TemplateRef` from a Component or a Directive via {@link Query}.
- *
- * To instantiate Embedded Views based on a Template, use
- * {@link ViewContainerRef#createEmbeddedView}, which will create the View and attach it to the
- * View Container.
- */
- interface TemplateRef {
-
- /**
- * The location in the View where the Embedded View logically belongs to.
- *
- * The data-binding and injection contexts of Embedded Views created from this `TemplateRef`
- * inherit from the contexts of this location.
- *
- * Typically new Embedded Views are attached to the View Container of this location, but in
- * advanced use-cases, the View can be attached to a different container while keeping the
- * data-binding and injection context from the original location.
- */
- elementRef: ElementRef;
-
- /**
- * Allows you to check if this Embedded Template defines Local Variable with name matching `name`.
- */
- hasLocal(name: string): boolean;
-
- }
-
-
- /**
- * Represents an Angular View.
- *
- * <!-- TODO: move the next two paragraphs to the dev guide -->
- * A View is a fundamental building block of the application UI. It is the smallest grouping of
- * Elements which are created and destroyed together.
- *
- * Properties of elements in a View can change, but the structure (number and order) of elements in
- * a View cannot. Changing the structure of Elements can only be done by inserting, moving or
- * removing nested Views via a {@link ViewContainer}. Each View can contain many View Containers.
- * <!-- /TODO -->
- *
- * ## Example
- *
- * Given this template...
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * ... we have two {@link ProtoViewRef}s:
- *
- * Outer {@link ProtoViewRef}:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner {@link ProtoViewRef}:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate {@link ProtoViewRef}s.
- *
- * The outer/inner {@link ProtoViewRef}s are then assembled into views like so:
- *
- * ```
- * <!-- ViewRef: outer-0 -->
- * Count: 2
- * <ul>
- * <template view-container-ref></template>
- * <!-- ViewRef: inner-1 --><li>first</li><!-- /ViewRef: inner-1 -->
- * <!-- ViewRef: inner-2 --><li>second</li><!-- /ViewRef: inner-2 -->
- * </ul>
- * <!-- /ViewRef: outer-0 -->
- * ```
- */
- interface ViewRef extends HostViewRef {
-
- /**
- * Sets `value` of local variable called `variableName` in this View.
- */
- setLocal(variableName: string, value: any): void;
-
- }
-
-
- /**
- * Represents a View containing a single Element that is the Host Element of a {@link Component}
- * instance.
- *
- * A Host View is created for every dynamically created Component that was compiled on its own (as
- * opposed to as a part of another Component's Template) via {@link Compiler#compileInHost} or one
- * of the higher-level APIs: {@link AppViewManager#createRootHostView},
- * {@link AppViewManager#createHostViewInContainer}, {@link ViewContainerRef#createHostView}.
- */
- interface HostViewRef {
-
- }
-
-
- /**
- * Represents an Angular ProtoView.
- *
- * A ProtoView is a prototypical {@link ViewRef View} that is the result of Template compilation and
- * is used by Angular to efficiently create an instance of this View based on the compiled Template.
- *
- * Most ProtoViews are created and used internally by Angular and you don't need to know about them,
- * except in advanced use-cases where you compile components yourself via the low-level
- * {@link Compiler#compileInHost} API.
- *
- *
- * ## Example
- *
- * Given this template:
- *
- * ```
- * Count: {{items.length}}
- * <ul>
- * <li *ng-for="var item of items">{{item}}</li>
- * </ul>
- * ```
- *
- * Angular desugars and compiles the template into two ProtoViews:
- *
- * Outer ProtoView:
- * ```
- * Count: {{items.length}}
- * <ul>
- * <template ng-for var-item [ng-for-of]="items"></template>
- * </ul>
- * ```
- *
- * Inner ProtoView:
- * ```
- * <li>{{item}}</li>
- * ```
- *
- * Notice that the original template is broken down into two separate ProtoViews.
- */
- interface ProtoViewRef {
-
- }
-
-
- /**
- * Represents a container where one or more Views can be attached.
- *
- * The container can contain two kinds of Views. Host Views, created by instantiating a
- * {@link Component} via {@link #createHostView}, and Embedded Views, created by instantiating an
- * {@link TemplateRef Embedded Template} via {@link #createEmbeddedView}.
- *
- * The location of the View Container within the containing View is specified by the Anchor
- * `element`. Each View Container can have only one Anchor Element and each Anchor Element can only
- * have a single View Container.
- *
- * Root elements of Views attached to this container become siblings of the Anchor Element in
- * the Rendered View.
- *
- * To access a `ViewContainerRef` of an Element, you can either place a {@link Directive} injected
- * with `ViewContainerRef` on the Element, or you obtain it via
- * {@link AppViewManager#getViewContainer}.
- *
- * <!-- TODO(i): we are also considering ElementRef#viewContainer api -->
- */
- interface ViewContainerRef {
-
- /**
- * Anchor element that specifies the location of this container in the containing View.
- * <!-- TODO: rename to anchorElement -->
- */
- element: ElementRef;
-
- /**
- * Destroys all Views in this container.
- */
- clear(): void;
-
- /**
- * Returns the {@link ViewRef} for the View located in this container at the specified index.
- */
- get(index: number): ViewRef;
-
- /**
- * Returns the number of Views currently attached to this container.
- */
- length: number;
-
- /**
- * Instantiates an Embedded View based on the {@link TemplateRef `templateRef`} and inserts it
- * into this container at the specified `index`.
- *
- * If `index` is not specified, the new View will be inserted as the last View in the container.
- *
- * Returns the {@link ViewRef} for the newly created View.
- */
- createEmbeddedView(templateRef: TemplateRef, index?: number): ViewRef;
-
- /**
- * Instantiates a single {@link Component} and inserts its Host View into this container at the
- * specified `index`.
- *
- * The component is instantiated using its {@link ProtoViewRef `protoView`} which can be
- * obtained via {@link Compiler#compileInHost}.
- *
- * If `index` is not specified, the new View will be inserted as the last View in the container.
- *
- * You can optionally specify `dynamicallyCreatedBindings`, which configure the {@link Injector}
- * that will be created for the Host View.
- *
- * Returns the {@link HostViewRef} of the Host View created for the newly instantiated Component.
- */
- createHostView(protoViewRef?: ProtoViewRef, index?: number, dynamicallyCreatedBindings?: ResolvedBinding[]): HostViewRef;
-
- /**
- * Inserts a View identified by a {@link ViewRef} into the container at the specified `index`.
- *
- * If `index` is not specified, the new View will be inserted as the last View in the container.
- *
- * Returns the inserted {@link ViewRef}.
- */
- insert(viewRef: ViewRef, index?: number): ViewRef;
-
- /**
- * Returns the index of the View, specified via {@link ViewRef}, within the current container or
- * `-1` if this container doesn't contain the View.
- */
- indexOf(viewRef: ViewRef): number;
-
- /**
- * Destroys a View attached to this container at the specified `index`.
- *
- * If `index` is not specified, the last View in the container will be removed.
- */
- remove(index?: number): void;
-
- /**
- * Use along with {@link #insert} to move a View within the current container.
- *
- * If the `index` param is omitted, the last {@link ViewRef} is detached.
- */
- detach(index?: number): ViewRef;
-
- }
-
-
- /**
- * Represents an instance of a Component created via {@link DynamicComponentLoader}.
- *
- * `ComponentRef` provides access to the Component Instance as well other objects related to this
- * Component Instance and allows you to destroy the Component Instance via the {@link #dispose}
- * method.
- */
- interface ComponentRef {
-
- /**
- * Location of the Host Element of this Component Instance.
- */
- location: ElementRef;
-
- /**
- * The instance of the Component.
- */
- instance: any;
-
- /**
- * The user defined component type, represented via the constructor function.
- *
- * <!-- TODO: customize wording for Dart docs -->
- */
- componentType: Type;
-
- /**
- * The {@link ViewRef} of the Host View of this Component instance.
- */
- hostView: HostViewRef;
-
- /**
- * Destroys the component instance and all of the data structures associated with it.
- *
- * TODO(i): rename to destroy to be consistent with AppViewManager and ViewContainerRef
- */
- dispose(): void;
-
- }
-
-
- /**
- * 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();
- * });
- * ```
- */
- interface LifeCycle {
-
- /**
- * 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;
-
- }
-
-
- /**
- * An injectable service for executing work inside or outside of the Angular zone.
- *
- * The most common use of this service is to optimize performance when starting a work consisting of
- * one or more asynchronous tasks that don't require UI updates or error handling to be handled by
- * Angular. Such tasks can be kicked off via {@link #runOutsideAngular} and if needed, these tasks
- * can reenter the Angular zone via {@link #run}.
- *
- * <!-- TODO: add/fix links to:
- * - docs explaining zones and the use of zones in Angular and change-detection
- * - link to runOutsideAngular/run (throughout this file!)
- * -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/lY9m8HLy7z06vDoUaSN2?p=preview))
- * ```
- * import {Component, View, NgIf, NgZone} from 'angular2/angular2';
- *
- * @Component({
- * selector: 'ng-zone-demo'
- * })
- * @View({
- * template: `
- * <h2>Demo: NgZone</h2>
- *
- * <p>Progress: {{progress}}%</p>
- * <p *ng-if="progress >= 100">Done processing {{label}} of Angular zone!</p>
- *
- * <button (click)="processWithinAngularZone()">Process within Angular zone</button>
- * <button (click)="processOutsideOfAngularZone()">Process outside of Angular zone</button>
- * `,
- * directives: [NgIf]
- * })
- * export class NgZoneDemo {
- * progress: number = 0;
- * label: string;
- *
- * constructor(private _ngZone: NgZone) {}
- *
- * // Loop inside the Angular zone
- * // so the UI DOES refresh after each setTimeout cycle
- * processWithinAngularZone() {
- * this.label = 'inside';
- * this.progress = 0;
- * this._increaseProgress(() => console.log('Inside Done!'));
- * }
- *
- * // Loop outside of the Angular zone
- * // so the UI DOES NOT refresh after each setTimeout cycle
- * processOutsideOfAngularZone() {
- * this.label = 'outside';
- * this.progress = 0;
- * this._ngZone.runOutsideAngular(() => {
- * this._increaseProgress(() => {
- * // reenter the Angular zone and display done
- * this._ngZone.run(() => {console.log('Outside Done!') });
- * }}));
- * }
- *
- *
- * _increaseProgress(doneCallback: () => void) {
- * this.progress += 1;
- * console.log(`Current progress: ${this.progress}%`);
- *
- * if (this.progress < 100) {
- * window.setTimeout(() => this._increaseProgress(doneCallback)), 10)
- * } else {
- * doneCallback();
- * }
- * }
- * }
- * ```
- */
- interface NgZone {
-
- /**
- * Executes the `fn` function synchronously within the Angular zone and returns value returned by
- * the function.
- *
- * Running functions via `run` allows you to reenter Angular zone from a task that was executed
- * outside of the Angular zone (typically started via {@link #runOutsideAngular}).
- *
- * Any future tasks or microtasks scheduled from within this function will continue executing from
- * within the Angular zone.
- */
- run(fn: () => any): any;
-
- /**
- * Executes the `fn` function synchronously in Angular's parent zone and returns value returned by
- * the function.
- *
- * Running functions via `runOutsideAngular` allows you to escape Angular's zone and do work that
- * doesn't trigger Angular change-detection or is subject to Angular's error handling.
- *
- * Any future tasks or microtasks scheduled from within this function will continue executing from
- * outside of the Angular zone.
- *
- * Use {@link #run} to reenter the Angular zone and do work that updates the application model.
- */
- runOutsideAngular(fn: () => any): any;
-
- }
-
-
- /**
- * 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:
- *
- * ```
- * <div class="message" [ng-class]="{error: errorCount > 0}">
- * Please check errors.
- * </div>
- * ```
- */
- class NgClass implements DoCheck, OnDestroy {
-
- constructor(_iterableDiffers: IterableDiffers, _keyValueDiffers: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer);
-
- 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, and also to alias the 'last' to a local variable that will
- * be set to a boolean indicating if the item is the last one in the iteration
- *
- * 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
- *
- * ```
- * <ul>
- * <li *ng-for="#error of errors; #i = index">
- * Error {{i}} of {{errors.length}}: {{error.message}}
- * </li>
- * </ul>
- * ```
- *
- * # Syntax
- *
- * - `<li *ng-for="#item of items; #i = index">...</li>`
- * - `<li template="ng-for #item of items; #i = index">...</li>`
- * - `<template ng-for #item [ng-for-of]="items" #i="index"><li>...</li></template>`
- */
- class NgFor implements DoCheck {
-
- constructor(_viewContainer: ViewContainerRef, _templateRef: TemplateRef, _iterableDiffers: IterableDiffers, _cdr: ChangeDetectorRef);
-
- ngForOf: any;
-
- doCheck(): void;
-
- }
-
-
- /**
- * 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 ([live demo](http://plnkr.co/edit/fe0kgemFBtmQOY31b4tw?p=preview)):
- *
- * ```
- * <div *ng-if="errorCount > 0" class="error">
- * <!-- Error message displayed when the errorCount property on the current context is greater
- * than 0. -->
- * {{errorCount}} errors detected
- * </div>
- * ```
- *
- * # Syntax
- *
- * - `<div *ng-if="condition">...</div>`
- * - `<div template="ng-if condition">...</div>`
- * - `<template [ng-if]="condition"><div>...</div></template>`
- */
- class NgIf {
-
- constructor(_viewContainer: ViewContainerRef, _templateRef: TemplateRef);
-
- ngIf: any;
-
- }
-
-
- /**
- * 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:
- *
- * ```
- * <div [ng-style]="{'text-align': alignExp}"></div>
- * ```
- *
- * In the above example the `text-align` style will be updated based on the `alignExp` value
- * changes.
- *
- * # Syntax
- *
- * - `<div [ng-style]="{'text-align': alignExp}"></div>`
- * - `<div [ng-style]="styleExp"></div>`
- */
- class NgStyle implements DoCheck {
-
- constructor(_differs: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer);
-
- rawStyle: any;
-
- doCheck(): 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:
- *
- * ```
- * <ANY [ng-switch]="expression">
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template [ng-switch-when]="whenExpression1">...</template>
- * <template ng-switch-default>...</template>
- * </ANY>
- * ```
- */
- 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
- * <template [ng-switch-when]="contextVariable">...</template>
- *
- * // match against a constant string
- * <template ng-switch-when="stringValue">...</template>
- * ```
- */
- class NgSwitchWhen {
-
- constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef, _switch: NgSwitch);
-
- ngSwitchWhen: any;
-
- }
-
-
- /**
- * Defines a default case statement.
- *
- * Default case statements are displayed when no `NgSwitchWhen` match the `ng-switch` value.
- *
- * Example:
- *
- * ```
- * <template ng-switch-default>...</template>
- * ```
- */
- class NgSwitchDefault {
-
- constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef, sswitch: NgSwitch);
-
- }
-
-
- /**
- * A collection of 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 `directives`
- * property of the `@View` annotation.
- *
- * ### Example ([live demo](http://plnkr.co/edit/yakGwpCdUkg0qfzX5m8g?p=preview))
- *
- * Instead of writing:
- *
- * ```typescript
- * 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:
- *
- * ```typescript
- * 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 {
- * ...
- * }
- * ```
- */
- let CORE_DIRECTIVES: Type[];
-
-
-
- /**
- * Omitting from external API doc as this is really an abstract internal concept.
- */
- class AbstractControl {
-
- constructor(validator: Function);
-
- validator: Function;
-
- value: any;
-
- status: string;
-
- valid: boolean;
-
- errors: {[key: string]: any};
-
- 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 | number>| 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`s have values and
- * validation state, which is determined by an optional validation function.
- *
- * `Control` is one of the three fundamental building blocks used to define forms in Angular, along
- * with {@link ControlGroup} and {@link ControlArray}.
- *
- * # Usage
- *
- * By default, a `Control` is created for every `<input>` or other form component.
- * With {@link NgFormControl} or {@link NgFormModel} an existing {@link Control} can be
- * bound to a DOM element instead. This `Control` can be configured with a custom
- * validation function.
- *
- * ### Example ([live demo](http://plnkr.co/edit/23DESOpbNnBpBHZt1BR4?p=preview))
- */
- class Control extends AbstractControl {
-
- constructor(value?: any, validator?: Function);
-
- /**
- * Set the value of the control to `value`.
- *
- * If `onlySelf` is `true`, this change will only affect the validation of this `Control`
- * and not its parent component. If `emitEvent` is `true`, this change will cause a
- * `valueChanges` event on the `Control` to be emitted. Both of these options default to
- * `false`.
- *
- * If `emitModelToViewChange` is `true`, the view will be notified about the new value
- * via an `onChange` event. This is the default behavior if `emitModelToViewChange` is not
- * specified.
- */
- updateValue(value: any, {onlySelf, emitEvent, emitModelToViewChange}?:
- {onlySelf?: boolean, emitEvent?: boolean, emitModelToViewChange?: boolean}): void;
-
- /**
- * Register a listener for change events.
- */
- 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.
- *
- * ### Example ([live demo](http://plnkr.co/edit/23DESOpbNnBpBHZt1BR4?p=preview))
- */
- class ControlGroup extends AbstractControl {
-
- constructor(controls: {[key: string]: AbstractControl}, optionals?: {[key: string]: boolean}, validator?: Function);
-
- controls: {[key: string]: AbstractControl};
-
- addControl(name: string, control: 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.
- *
- * # Adding or removing controls
- *
- * To change the controls in the array, use the `push`, `insert`, or `removeAt` methods
- * in `ControlArray` itself. These methods ensure the controls are properly tracked in the
- * form's hierarchy. Do not modify the array of `AbstractControl`s used to instantiate
- * the `ControlArray` directly, as that will result in strange and unexpected behavior such
- * as broken change detection.
- *
- * ### Example ([live demo](http://plnkr.co/edit/23DESOpbNnBpBHZt1BR4?p=preview))
- */
- class ControlArray extends AbstractControl {
-
- constructor(controls: AbstractControl[], validator?: Function);
-
- controls: AbstractControl[];
-
- /**
- * Get the {@link AbstractControl} at the given `index` in the array.
- */
- at(index: number): AbstractControl;
-
- /**
- * Insert a new {@link AbstractControl} at the end of the array.
- */
- push(control: AbstractControl): void;
-
- /**
- * Insert a new {@link AbstractControl} at the given `index` in the array.
- */
- insert(index: number, control: AbstractControl): void;
-
- /**
- * Remove the control at the given `index` in the array.
- */
- removeAt(index: number): void;
-
- /**
- * Get the length of the control array.
- */
- length: number;
-
- }
-
-
- class AbstractControlDirective {
-
- control: AbstractControl;
-
- value: any;
-
- valid: boolean;
-
- errors: {[key: string]: any};
-
- 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 multiple {@link 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: `
- * <form #f="form" (submit)='onLogIn(f.value)'>
- * Login <input type='text' ng-control='login' #l="form">
- * <div *ng-if="!l.valid">Login is invalid</div>
- *
- * Password <input type='password' ng-control='password'>
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * onLogIn(value): void {
- * // 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: `
- * <form (submit)='onLogIn()'>
- * Login <input type='text' ng-control='login' [(ng-model)]="credentials.login">
- * Password <input type='password' ng-control='password'
- * [(ng-model)]="credentials.password">
- * <button type='submit'>Log in!</button>
- * </form>
- * `})
- * class LoginComp {
- * credentials: {login:string, password:string};
- *
- * onLogIn(): void {
- * // this.credentials.login === "some login"
- * // this.credentials.password === "some password"
- * }
- * }
- * ```
- */
- class NgControlName extends NgControl implements OnChanges,
- OnDestroy {
-
- constructor(parent: ControlContainer, validators: Function[], valueAccessors: ControlValueAccessor[]);
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- validators: Function[];
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- onDestroy(): void;
-
- viewToModelUpdate(newValue: any): void;
-
- path: string[];
-
- formDirective: any;
-
- control: Control;
-
- validator: Function;
-
- }
-
-
- /**
- * Binds an existing {@link Control} to a DOM element.
- *
- * ### Example ([live demo](http://plnkr.co/edit/jcQlZ2tTh22BZZ2ucNAT?p=preview))
- *
- * 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.
- *
- * ```typescript
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: `
- * <div>
- * <h2>NgFormControl Example</h2>
- * <form>
- * <p>Element with existing control: <input type="text"
- * [ng-form-control]="loginControl"></p>
- * <p>Value of existing control: {{loginControl.value}}</p>
- * </form>
- * </div>
- * `,
- * directives: [CORE_DIRECTIVES, FORM_DIRECTIVES]
- * })
- * export class App {
- * loginControl: Control = new Control('');
- * }
- * ```
- *
- * # ng-model
- *
- * We can also use `ng-model` to bind a domain model to the form.
- *
- * ### Example ([live demo](http://plnkr.co/edit/yHMLuHO7DNgT8XvtjTDH?p=preview))
- *
- * ```typescript
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: "<input type='text' [ng-form-control]='loginControl' [(ng-model)]='login'>"
- * })
- * class LoginComp {
- * loginControl: Control = new Control('');
- * login:string;
- * }
- * ```
- */
- class NgFormControl extends NgControl implements OnChanges {
-
- constructor(validators: Function[], valueAccessors: ControlValueAccessor[]);
-
- form: Control;
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- validators: Function[];
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- path: string[];
-
- control: Control;
-
- validator: Function;
-
- viewToModelUpdate(newValue: any): void;
-
- }
-
-
- /**
- * Binds a domain model to a form control.
- *
- * # Usage
- *
- * `ng-model` binds an existing domain model to a form control. For a
- * two-way binding, use `[(ng-model)]` to ensure the model updates in
- * both directions.
- *
- * ### Example ([live demo](http://plnkr.co/edit/R3UX5qDaUqFO2VYR0UzH?p=preview))
- * ```typescript
- * @Component({selector: "search-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `<input type='text' [(ng-model)]="searchQuery">`
- * })
- * class SearchComp {
- * searchQuery: string;
- * }
- * ```
- */
- class NgModel extends NgControl implements OnChanges {
-
- constructor(validators: Function[], valueAccessors: ControlValueAccessor[]);
-
- update: any;
-
- model: any;
-
- viewModel: any;
-
- validators: Function[];
-
- onChanges(changes: {[key: string]: SimpleChange}): void;
-
- control: Control;
-
- path: string[];
-
- validator: Function;
-
- viewToModelUpdate(newValue: any): void;
-
- }
-
-
- /**
- * A base 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: `
- * <form #f="form" (submit)='onSignUp(f.value)'>
- * <div ng-control-group='credentials' #credentials="form">
- * Login <input type='text' ng-control='login'>
- * Password <input type='password' ng-control='password'>
- * </div>
- * <div *ng-if="!credentials.valid">Credentials are invalid</div>
- *
- * <div ng-control-group='personal'>
- * Name <input type='text' ng-control='name'>
- * </div>
- * <button type='submit'>Sign Up!</button>
- * </form>
- * `})
- * class SignupComp {
- * onSignUp(value) {
- * // value === {
- * // personal: {name: 'some name'},
- * // credentials: {login: 'some login', password: 'some password'}}
- * }
- * }
- *
- * ```
- */
- class NgControlGroup extends ControlContainer implements OnInit,
- OnDestroy {
-
- constructor(_parent: ControlContainer);
-
- onInit(): void;
-
- onDestroy(): void;
-
- control: ControlGroup;
-
- path: string[];
-
- formDirective: Form;
-
- }
-
-
- /**
- * Binds an existing control group to a DOM element.
- *
- * ### Example ([live demo](http://plnkr.co/edit/jqrVirudY8anJxTMUjTP?p=preview))
- *
- * 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.
- *
- * ```typescript
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: `
- * <div>
- * <h2>NgFormModel Example</h2>
- * <form [ng-form-model]="loginForm">
- * <p>Login: <input type="text" ng-control="login"></p>
- * <p>Password: <input type="password" ng-control="password"></p>
- * </form>
- * <p>Value:</p>
- * <pre>{{value}}</pre>
- * </div>
- * `,
- * directives: [FORM_DIRECTIVES]
- * })
- * export class App {
- * loginForm: ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * get value(): string {
- * return JSON.stringify(this.loginForm.value, null, 2);
- * }
- * }
- * ```
- *
- * We can also use ng-model to bind a domain model to the form.
- *
- * ```typescript
- * @Component({selector: "login-comp"})
- * @View({
- * directives: [FORM_DIRECTIVES],
- * template: `
- * <form [ng-form-model]='loginForm'>
- * Login <input type='text' ng-control='login' [(ng-model)]='credentials.login'>
- * Password <input type='password' ng-control='password'
- * [(ng-model)]='credentials.password'>
- * <button (click)="onLogin()">Login</button>
- * </form>`
- * })
- * class LoginComp {
- * credentials: {login: string, password: string};
- * loginForm: ControlGroup;
- *
- * constructor() {
- * this.loginForm = new ControlGroup({
- * login: new Control(""),
- * password: new Control("")
- * });
- * }
- *
- * onLogin(): void {
- * // this.credentials.login === 'some login'
- * // this.credentials.password === 'some password'
- * }
- * }
- * ```
- */
- class NgFormModel extends ControlContainer implements Form,
- OnChanges {
-
- 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;
-
- }
-
-
- /**
- * If `NgForm` is bound in a component, `<form>` elements in that component will be
- * upgraded to use the Angular form system.
- *
- * # Typical Use
- *
- * Include `FORM_DIRECTIVES` in the `directives` section of a {@link View} annotation
- * to use `NgForm` and its associated controls.
- *
- * # Structure
- *
- * An Angular form is a collection of {@link Control}s in some hierarchy.
- * `Control`s can be at the top level or can be organized in {@link ControlGroups}
- * or {@link ControlArray}s. This hierarchy is reflected in the form's `value`, a
- * JSON object that mirrors the form structure.
- *
- * # Submission
- *
- * The `ng-submit` event signals when the user triggers a form submission.
- *
- * ### Example ([live demo](http://plnkr.co/edit/ltdgYj4P0iY64AR71EpL?p=preview))
- *
- * ```typescript
- * @Component({
- * selector: 'my-app'
- * })
- * @View({
- * template: `
- * <div>
- * <p>Submit the form to see the data object Angular builds</p>
- * <h2>NgForm demo</h2>
- * <form #f="form" (ng-submit)="onSubmit(f.value)">
- * <h3>Control group: credentials</h3>
- * <div ng-control-group="credentials">
- * <p>Login: <input type="text" ng-control="login"></p>
- * <p>Password: <input type="password" ng-control="password"></p>
- * </div>
- * <h3>Control group: person</h3>
- * <div ng-control-group="person">
- * <p>First name: <input type="text" ng-control="firstName"></p>
- * <p>Last name: <input type="text" ng-control="lastName"></p>
- * </div>
- * <button type="submit">Submit Form</button>
- * <p>Form data submitted:</p>
- * </form>
- * <pre>{{data}}</pre>
- * </div>
- * `,
- * directives: [CORE_DIRECTIVES, FORM_DIRECTIVES]
- * })
- * export class App {
- * constructor() {}
- *
- * data: string;
- *
- * onSubmit(data) {
- * this.data = JSON.stringify(data, null, 2);
- * }
- * }
- * ```
- */
- class NgForm extends ControlContainer implements Form {
-
- form: ControlGroup;
-
- ngSubmit: any;
-
- formDirective: Form;
-
- control: ControlGroup;
-
- path: string[];
-
- controls: {[key: string]: AbstractControl};
-
- 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
- * ```
- * <input type="text" [(ng-model)]="searchQuery">
- * ```
- */
- class DefaultValueAccessor implements ControlValueAccessor {
-
- constructor(_renderer: Renderer, _elementRef: ElementRef);
-
- onChange: any;
-
- onTouched: any;
-
- writeValue(value: any): void;
-
- registerOnChange(fn: (_: any) => void): void;
-
- registerOnTouched(fn: () => void): void;
-
- }
-
-
- class NgControlStatus {
-
- constructor(cd: NgControl);
-
- ngClassUntouched: boolean;
-
- ngClassTouched: boolean;
-
- ngClassPristine: boolean;
-
- ngClassDirty: boolean;
-
- ngClassValid: boolean;
-
- ngClassInvalid: boolean;
-
- }
-
-
- /**
- * The accessor for writing a value and listening to changes on a checkbox input element.
- *
- * # Example
- * ```
- * <input type="checkbox" [ng-control]="rememberLogin">
- * ```
- */
- class CheckboxControlValueAccessor implements ControlValueAccessor {
-
- constructor(_renderer: Renderer, _elementRef: ElementRef);
-
- onChange: any;
-
- onTouched: any;
-
- writeValue(value: any): void;
-
- registerOnChange(fn: (_: any) => {}): void;
-
- registerOnTouched(fn: () => {}): void;
-
- }
-
-
- /**
- * Marks `<option>` as dynamic, so Angular can be notified when options change.
- *
- * #Example:
- *
- * ```
- * <select ng-control="city">
- * <option *ng-for="#c of cities" [value]="c"></option>
- * </select>
- * ```
- */
- class NgSelectOption {
-
- }
-
-
- /**
- * The accessor for writing a value and listening to changes on a select element.
- */
- class SelectControlValueAccessor implements ControlValueAccessor {
-
- constructor(_renderer: Renderer, _elementRef: ElementRef, query: QueryList<NgSelectOption>);
-
- value: string;
-
- onChange: any;
-
- onTouched: any;
-
- writeValue(value: any): void;
-
- 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.
- *
- * ### Example:
- *
- * ```typescript
- * @View({
- * directives: [FORM_DIRECTIVES]
- * })
- * @Component({
- * selector: 'my-app'
- * })
- * class MyApp {}
- * ```
- */
- let FORM_DIRECTIVES: Type[];
-
-
-
- let NG_VALIDATORS: OpaqueToken;
-
-
-
- /**
- * Provides a set of validators used by form controls.
- *
- * # Example
- *
- * ```
- * var loginControl = new Control("", Validators.required)
- * ```
- */
- class Validators {
-
- static required(control:Control): {[key: string]: boolean};
-
- static nullValidator(c: any): {[key: string]: boolean};
-
- static compose(validators: Function[]): Function;
-
- static group(group:ControlGroup): {[key: string]: any[]};
-
- static array(array:ControlArray): {[key: string]: any[]};
-
- }
-
-
- class DefaultValidators {
-
- }
-
-
- /**
- * 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/core';
- *
- * @Component({
- * selector: 'login-comp',
- * viewBindings: [FormBuilder]
- * })
- * @View({
- * template: `
- * <form [control-group]="loginForm">
- * Login <input control="login">
- *
- * <div control-group="passwordRetry">
- * Password <input type="password" control="password">
- * Confirm password <input type="password" control="passwordConfirmation">
- * </div>
- * </form>
- * `,
- * 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: {[key: string]: any}, extra?: {[key: string]: any}): ControlGroup;
-
- control(value: Object, validator?: Function): Control;
-
- array(controlsConfig: any[], validator?: Function): ControlArray;
-
- }
-
-
- /**
- * Shorthand set of bindings used for building Angular forms.
- *
- * ### Example:
- *
- * ```typescript
- * bootstrap(MyApp, [FORM_BINDINGS]);
- * ```
- */
- let FORM_BINDINGS: Type[];
-
-
-
- function inspectNativeElement(element: any): DebugElement;
-
-
-
- let ELEMENT_PROBE_BINDINGS: any[];
-
-
-
- /**
- * A DebugElement contains information from the Angular compiler about an
- * element and provides access to the corresponding ElementInjector and
- * underlying DOM Element, as well as a way to query for children.
- */
- interface DebugElement {
-
- componentInstance: any;
-
- nativeElement: any;
-
- elementRef: ElementRef;
-
- getDirectiveInstance(directiveIndex: number): any;
-
- /**
- * Get child DebugElements from within the Light DOM.
- *
- * @return {DebugElement[]}
- */
- children: DebugElement[];
-
- /**
- * Get the root DebugElement children of a component. Returns an empty
- * list if the current DebugElement is not a component root.
- *
- * @return {DebugElement[]}
- */
- componentViewChildren: DebugElement[];
-
- triggerEventHandler(eventName: string, eventObj: Event): void;
-
- hasDirective(type: Type): boolean;
-
- inject(type: Type): any;
-
- getLocal(name: string): any;
-
- /**
- * Return the first descendant TestElement matching the given predicate
- * and scope.
- *
- * @param {Function: boolean} predicate
- * @param {Scope} scope
- *
- * @return {DebugElement}
- */
- query(predicate: Predicate<DebugElement>, scope?: Function): DebugElement;
-
- /**
- * Return descendant TestElememts matching the given predicate
- * and scope.
- *
- * @param {Function: boolean} predicate
- * @param {Scope} scope
- *
- * @return {DebugElement[]}
- */
- queryAll(predicate: Predicate<DebugElement>, scope?: Function): DebugElement[];
-
- }
-
-
- /**
- * Returns a DebugElement for a ElementRef.
- *
- * @param {ElementRef}: elementRef
- * @return {DebugElement}
- */
- function inspectElement(elementRef: ElementRef): DebugElement;
-
-
-
- function asNativeElements(arr: DebugElement[]): any[];
-
-
-
- class Scope {
-
- static all(debugElement: DebugElement): DebugElement[];
-
- static light(debugElement: DebugElement): DebugElement[];
-
- static view(debugElement: DebugElement): DebugElement[];
-
- }
-
-
- class By {
-
- static all(): Function;
-
- static css(selector: string): Predicate<DebugElement>;
-
- static directive(type: Type): Predicate<DebugElement>;
-
- }
-
-
- 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.
- *
- * This exception is only thrown in dev mode.
- *
- * <!-- TODO: Add a link once the dev mode option is configurable -->
- *
- * ### Example
- *
- * ```typescript
- * @Component({selector: 'parent'})
- * @View({
- * template: `
- * <child [prop]="parentProp"></child>
- * `,
- * directives: [forwardRef(() => Child)]
- * })
- * class Parent {
- * parentProp = "init";
- * }
- *
- * @Directive({selector: 'child', inputs: ['prop']})
- * class Child {
- * constructor(public parent: Parent) {}
- *
- * set prop(v) {
- * // this updates the parent property, which is disallowed during change detection
- * // this will result in ExpressionChangedAfterItHasBeenCheckedException
- * this.parent.parentProp = "updated";
- * }
- * }
- * ```
- */
- class ExpressionChangedAfterItHasBeenCheckedException extends BaseException {
-
- constructor(exp: string, oldValue: any, currValue: any, context: any);
-
- }
-
-
- /**
- * Thrown when an expression evaluation raises an exception.
- *
- * This error wraps the original exception to attach additional contextual information that can
- * be useful for debugging.
- *
- * ### Example ([live demo](http://plnkr.co/edit/2Kywoz?p=preview))
- *
- * ```typescript
- * @Directive({selector: 'child', inputs: ['prop']})
- * class Child {
- * prop;
- * }
- *
- * @Component({
- * selector: 'app'
- * })
- * @View({
- * template: `
- * <child [prop]="field.first"></child>
- * `,
- * directives: [Child]
- * })
- * class App {
- * field = null;
- * }
- *
- * bootstrap(App);
- * ```
- *
- * You can access the original exception and stack through the `originalException` and
- * `originalStack` properties.
- */
- class ChangeDetectionError extends WrappedException {
-
- constructor(exp: string, originalException: any, originalStack: any, context: any);
-
- /**
- * Information about the expression that triggered the exception.
- */
- location: string;
-
- }
-
-
- /**
- * Reference to a component's change detection object.
- */
- interface ChangeDetectorRef {
-
- /**
- * Marks all {@link OnPush} ancestors as to be checked.
- *
- * <!-- TODO: Add a link to a chapter on OnPush components -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/GC512b?p=preview))
- *
- * ```typescript
- * @Component({selector: 'cmp', changeDetection: ChangeDetectionStrategy.OnPush})
- * @View({template: `Number of ticks: {{numberOfTicks}}`})
- * class Cmp {
- * numberOfTicks = 0;
- *
- * constructor(ref: ChangeDetectorRef) {
- * setInterval(() => {
- * this.numberOfTicks ++
- * // the following is required, otherwise the view will not be updated
- * this.ref.markForCheck();
- * }, 1000);
- * }
- * }
- *
- * @Component({
- * selector: 'app',
- * changeDetection: ChangeDetectionStrategy.OnPush
- * })
- * @View({
- * template: `
- * <cmp><cmp>
- * `,
- * directives: [Cmp]
- * })
- * class App {
- * }
- *
- * bootstrap(App);
- * ```
- */
- markForCheck(): void;
-
- /**
- * Detaches the change detector from the change detector tree.
- *
- * The detached change detector will not be checked until it is reattached.
- *
- * This can also be used in combination with {@link detectChanges} to implement local change
- * detection checks.
- *
- * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
- * <!-- TODO: Add a live demo once ref.detectChanges is merged into master -->
- *
- * ### Example
- *
- * The following example defines a component with a large list of readonly data.
- * Imagine the data changes constantly, many times per second. For performance reasons,
- * we want to check and update the list every five seconds. We can do that by detaching
- * the component's change detector and doing a local check every five seconds.
- *
- * ```typescript
- * class DataProvider {
- * // in a real application the returned data will be different every time
- * get data() {
- * return [1,2,3,4,5];
- * }
- * }
- *
- * @Component({selector: 'giant-list'})
- * @View({
- * template: `
- * <li *ng-for="#d of dataProvider.data">Data {{d}}</lig>
- * `,
- * directives: [NgFor]
- * })
- * class GiantList {
- * constructor(private ref: ChangeDetectorRef, private dataProvider:DataProvider) {
- * ref.detach();
- * setInterval(() => {
- * this.ref.detectChanges();
- * }, 5000);
- * }
- * }
- *
- * @Component({
- * selector: 'app', bindings: [DataProvider]
- * })
- * @View({
- * template: `
- * <giant-list><giant-list>
- * `,
- * directives: [GiantList]
- * })
- * class App {
- * }
- *
- * bootstrap(App);
- * ```
- */
- detach(): void;
-
- /**
- * Checks the change detector and its children.
- *
- * This can also be used in combination with {@link detach} to implement local change detection
- * checks.
- *
- * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
- * <!-- TODO: Add a live demo once ref.detectChanges is merged into master -->
- *
- * ### Example
- *
- * The following example defines a component with a large list of readonly data.
- * Imagine, the data changes constantly, many times per second. For performance reasons,
- * we want to check and update the list every five seconds.
- *
- * We can do that by detaching the component's change detector and doing a local change detection
- * check
- * every five seconds.
- *
- * See {@link detach} for more information.
- */
- detectChanges(): void;
-
- /**
- * Reattach the change detector to the change detector tree.
- *
- * This also marks OnPush ancestors as to be checked. This reattached change detector will be
- * checked during the next change detection run.
- *
- * <!-- TODO: Add a link to a chapter on detach/reattach/local digest -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/aUhZha?p=preview))
- *
- * The following example creates a component displaying `live` data. The component will detach
- * its change detector from the main change detector tree when the component's live property
- * is set to false.
- *
- * ```typescript
- * class DataProvider {
- * data = 1;
- *
- * constructor() {
- * setInterval(() => {
- * this.data = this.data * 2;
- * }, 500);
- * }
- * }
- *
- * @Component({selector: 'live-data', inputs: ['live']})
- * @View({
- * template: `Data: {{dataProvider.data}}`
- * })
- * class LiveData {
- * constructor(private ref: ChangeDetectorRef, private dataProvider:DataProvider) {}
- *
- * set live(value) {
- * if (value)
- * this.ref.reattach();
- * else
- * this.ref.detach();
- * }
- * }
- *
- * @Component({
- * selector: 'app',
- * bindings: [DataProvider]
- * })
- * @View({
- * template: `
- * Live Update: <input type="checkbox" [(ng-model)]="live">
- * <live-data [live]="live"><live-data>
- * `,
- * directives: [LiveData, FORM_DIRECTIVES]
- * })
- * class App {
- * live = true;
- * }
- *
- * bootstrap(App);
- * ```
- */
- 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 {
-
- constructor(wrapped: any);
-
- static wrap(value: any): WrappedValue;
-
- wrapped: any;
-
- }
-
-
- class SimpleChange {
-
- constructor(previousValue: any, currentValue: any);
-
- previousValue: any;
-
- currentValue: any;
-
- isFirstChange(): boolean;
-
- }
-
-
- /**
- * To create a Pipe, you must implement this interface.
- *
- * Angular invokes the `transform` method with the value of a binding
- * as the first argument, and any parameters as the second argument in list form.
- *
- * ## Syntax
- *
- * `value | pipeName[:arg0[:arg1...]]`
- *
- * ### Example ([live demo](http://plnkr.co/edit/f5oyIked9M2cKzvZNKHV?p=preview))
- *
- * The `RepeatPipe` below repeats the value as many times as indicated by the first argument:
- *
- * ```
- * import {Pipe, PipeTransform} from 'angular2/angular2';
- *
- * @Pipe({name: 'repeat'})
- * export class RepeatPipe implements PipeTransform {
- * transform(value: any, args: any[] = []) {
- * if (args.length == 0) {
- * throw new Error('repeat pipe requires one argument');
- * }
- * let times: number = args[0];
- * return value.repeat(times);
- * }
- * }
- * ```
- *
- * Invoking `{{ 'ok' | repeat:3 }}` in a template produces `okokok`.
- */
- interface PipeTransform {
-
- transform(value: any, args: any[]): any;
-
- }
-
-
- /**
- * To create a stateful Pipe, you should implement this interface.
- *
- * A stateful pipe may produce different output, given the same input. It is
- * likely that a stateful pipe may contain state that should be cleaned up when
- * a binding is destroyed. For example, a subscription to a stream of data may need to
- * be disposed, or an interval may need to be cleared.
- *
- * ### Example ([live demo](http://plnkr.co/edit/hlaejwQAmWayxwc5YXQE?p=preview))
- *
- * In this example, a pipe is created to countdown its input value, updating it every
- * 50ms. Because it maintains an internal interval, it automatically clears
- * the interval when the binding is destroyed or the countdown completes.
- *
- * ```
- * import {Pipe, PipeTransform} from 'angular2/angular2'
- * @Pipe({name: 'countdown'})
- * class CountDown implements PipeTransform, PipeOnDestroy {
- * remainingTime:Number;
- * interval:SetInterval;
- * onDestroy() {
- * if (this.interval) {
- * clearInterval(this.interval);
- * }
- * }
- * transform(value: any, args: any[] = []) {
- * if (!parseInt(value, 10)) return null;
- * if (typeof this.remainingTime !== 'number') {
- * this.remainingTime = parseInt(value, 10);
- * }
- * if (!this.interval) {
- * this.interval = setInterval(() => {
- * this.remainingTime-=50;
- * if (this.remainingTime <= 0) {
- * this.remainingTime = 0;
- * clearInterval(this.interval);
- * delete this.interval;
- * }
- * }, 50);
- * }
- * return this.remainingTime;
- * }
- * }
- * ```
- *
- * Invoking `{{ 10000 | countdown }}` would cause the value to be decremented by 50,
- * every 50ms, until it reaches 0.
- */
- interface PipeOnDestroy {
-
- onDestroy(): void;
-
- }
-
-
- /**
- * A repository of different iterable diffing strategies used by NgFor, NgClass, and others.
- */
- class IterableDiffers {
-
- constructor(factories: IterableDifferFactory[]);
-
- 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 {
-
- constructor(factories: KeyValueDifferFactory[]);
-
- 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;
-
- }
-
-
- /**
- * 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: <T>(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;
-
- }
-
-
- /**
- * Bootstrapping a Webworker Application
- *
- * You instantiate the application side by calling bootstrapWebworker from your webworker index
- * script.
- * You can call bootstrapWebworker() exactly as you would call bootstrap() in a regular Angular
- * application
- * See the bootstrap() docs for more details.
- */
- function bootstrapWebWorker(appComponentType: Type, componentInjectableBindings?: Array<Type | Binding | any[]>): Promise<ComponentRef>;
-
-
-
- /**
- * Message Bus is a low level API used to communicate between the UI and the background.
- * Communication is based on a channel abstraction. Messages published in a
- * given channel to one MessageBusSink are received on the same channel
- * by the corresponding MessageBusSource.
- */
- class MessageBus implements MessageBusSource, MessageBusSink {
-
- /**
- * Sets up a new channel on the MessageBus.
- * MUST be called before calling from or to on the channel.
- * If runInZone is true then the source will emit events inside the angular zone
- * and the sink will buffer messages and send only once the zone exits.
- * if runInZone is false then the source will emit events inside the global zone
- * and the sink will send messages immediately.
- */
- initChannel(channel: string, runInZone?: boolean): void;
-
- /**
- * Assigns this bus to the given zone.
- * Any callbacks attached to channels where runInZone was set to true on initialization
- * will be executed in the given zone.
- */
- attachToZone(zone: NgZone): void;
-
- /**
- * Returns an {@link EventEmitter} that emits every time a message
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
-
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
-
- }
-
-
- interface MessageBusSource {
-
- /**
- * Sets up a new channel on the MessageBusSource.
- * MUST be called before calling from on the channel.
- * If runInZone is true then the source will emit events inside the angular zone.
- * if runInZone is false then the source will emit events inside the global zone.
- */
- initChannel(channel: string, runInZone: boolean): void;
-
- /**
- * Assigns this source to the given zone.
- * Any channels which are initialized with runInZone set to true will emit events that will be
- * executed within the given zone.
- */
- attachToZone(zone: NgZone): void;
-
- /**
- * Returns an {@link EventEmitter} that emits every time a message
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
-
- }
-
-
- interface MessageBusSink {
-
- /**
- * Sets up a new channel on the MessageBusSink.
- * MUST be called before calling to on the channel.
- * If runInZone is true the sink will buffer messages and send only once the zone exits.
- * if runInZone is false the sink will send messages immediatly.
- */
- initChannel(channel: string, runInZone: boolean): void;
-
- /**
- * Assigns this sink to the given zone.
- * Any channels which are initialized with runInZone set to true will wait for the given zone
- * to exit before sending messages.
- */
- attachToZone(zone: NgZone): void;
-
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
-
- }
-
-
- interface ClientMessageBrokerFactory {
-
- /**
- * Initializes the given channel and attaches a new {@link ClientMessageBroker} to it.
- */
- createMessageBroker(channel: string, runInZone?: boolean): ClientMessageBroker;
-
- }
-
-
- interface ClientMessageBroker {
-
- channel: any;
-
- runOnService(args: UiArguments, returnType: Type): Promise<any>;
-
- }
-
-
- class FnArg {
-
- constructor(value: any, type: Type);
-
- value: any;
-
- type: Type;
-
- }
-
-
- class UiArguments {
-
- constructor(method: string, args?: FnArg[]);
-
- method: string;
-
- args: FnArg[];
-
- }
-
-
- interface ServiceMessageBrokerFactory {
-
- /**
- * Initializes the given channel and attaches a new {@link ServiceMessageBroker} to it.
- */
- createMessageBroker(channel: string, runInZone?: boolean): ServiceMessageBroker;
-
- }
-
-
- /**
- * Helper class for UIComponents that allows components to register methods.
- * If a registered method message is received from the broker on the worker,
- * the UIMessageBroker deserializes its arguments and calls the registered method.
- * If that method returns a promise, the UIMessageBroker returns the result to the worker.
- */
- interface ServiceMessageBroker {
-
- channel: any;
-
- registerMethod(methodName: string, signature: Type[], method: Function, returnType?: Type): void;
-
- }
-
-
- class ReceivedMessage {
-
- constructor(data: {[key: string]: any});
-
- method: string;
-
- args: any[];
-
- id: string;
-
- type: string;
-
- }
-
-
- var Renderer: InjectableReference;
-
-
-
- var RenderProtoViewRef: InjectableReference;
-
-
-
- var ResolvedBinding: InjectableReference;
-
-
-
- var InstantiationError: InjectableReference;
-
-
-
- var PlatformRef: InjectableReference;
-
-
-
- var ApplicationRef: InjectableReference;
-
-
-
- var Compiler: InjectableReference;
-
-
-
- var AppViewManager: InjectableReference;
-
-
-
- var DynamicComponentLoader: InjectableReference;
-
-
-
- var ElementRef: InjectableReference;
-
-
-
- var TemplateRef: InjectableReference;
-
-
-
- var ViewRef: InjectableReference;
-
-
-
- var ProtoViewRef: InjectableReference;
-
-
-
- var ViewContainerRef: InjectableReference;
-
-
-
- var ComponentRef: InjectableReference;
-
-
-
- var LifeCycle: InjectableReference;
-
-
-
- var NgZone: InjectableReference;
-
-
-
- var DebugElement: InjectableReference;
-
-
-
- var ChangeDetectorRef: InjectableReference;
-
-
-
- var ClientMessageBrokerFactory: InjectableReference;
-
-
-
- var ClientMessageBroker: InjectableReference;
-
-
-
- var ServiceMessageBrokerFactory: InjectableReference;
-
-
-
- var ServiceMessageBroker: InjectableReference;
-
-
-
-}
-
-declare module "angular2/web_worker/worker" {
- export = ngWorker;
-}
-
-
-
-declare module ngUi {
- let PRIMITIVE: Type;
-
-
-
- /**
- *
- * Runtime representation a type that a Component or other object is instances of.
- *
- * An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by
- * the `MyCustomComponent` constructor function.
- */
- interface Type extends Function {
-
- new(...args: any[]): any;
-
- }
-
-
- class Observable {
-
- observer(generator: any): Object;
-
- }
-
-
- /**
- * Use by directives and components to emit custom Events.
- *
- * ## Examples
- *
- * In the following example, `Zippy` alternatively emits `open` and `close` events when its
- * title gets clicked:
- *
- * ```
- * @Component({selector: 'zippy'})
- * @View({template: `
- * <div class="zippy">
- * <div (click)="toggle()">Toggle</div>
- * <div [hidden]="!visible">
- * <ng-content></ng-content>
- * </div>
- * </div>`})
- * export class Zippy {
- * visible: boolean = true;
- * @Output() open: EventEmitter = new EventEmitter();
- * @Output() close: EventEmitter = new EventEmitter();
- *
- * toggle() {
- * this.visible = !this.visible;
- * if (this.visible) {
- * this.open.next(null);
- * } else {
- * this.close.next(null);
- * }
- * }
- * }
- * ```
- *
- * 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): any;
-
- toRx(): any;
-
- next(value: any): void;
-
- throw(error: any): void;
-
- return(value?: any): void;
-
- }
-
-
- interface Predicate<T> {
-
- (value: T, index?: number, array?: T[]): boolean;
-
- }
-
-
- class WrappedException extends Error {
-
- constructor(_wrapperMessage: string, _originalException: any, _originalStack?: any, _context?: any);
-
- wrapperMessage: string;
-
- wrapperStack: any;
-
- originalException: any;
-
- originalStack: any;
-
- context: any;
-
- message: string;
-
- toString(): string;
-
- }
-
-
- /**
- * An injectable service for executing work inside or outside of the Angular zone.
- *
- * The most common use of this service is to optimize performance when starting a work consisting of
- * one or more asynchronous tasks that don't require UI updates or error handling to be handled by
- * Angular. Such tasks can be kicked off via {@link #runOutsideAngular} and if needed, these tasks
- * can reenter the Angular zone via {@link #run}.
- *
- * <!-- TODO: add/fix links to:
- * - docs explaining zones and the use of zones in Angular and change-detection
- * - link to runOutsideAngular/run (throughout this file!)
- * -->
- *
- * ### Example ([live demo](http://plnkr.co/edit/lY9m8HLy7z06vDoUaSN2?p=preview))
- * ```
- * import {Component, View, NgIf, NgZone} from 'angular2/angular2';
- *
- * @Component({
- * selector: 'ng-zone-demo'
- * })
- * @View({
- * template: `
- * <h2>Demo: NgZone</h2>
- *
- * <p>Progress: {{progress}}%</p>
- * <p *ng-if="progress >= 100">Done processing {{label}} of Angular zone!</p>
- *
- * <button (click)="processWithinAngularZone()">Process within Angular zone</button>
- * <button (click)="processOutsideOfAngularZone()">Process outside of Angular zone</button>
- * `,
- * directives: [NgIf]
- * })
- * export class NgZoneDemo {
- * progress: number = 0;
- * label: string;
- *
- * constructor(private _ngZone: NgZone) {}
- *
- * // Loop inside the Angular zone
- * // so the UI DOES refresh after each setTimeout cycle
- * processWithinAngularZone() {
- * this.label = 'inside';
- * this.progress = 0;
- * this._increaseProgress(() => console.log('Inside Done!'));
- * }
- *
- * // Loop outside of the Angular zone
- * // so the UI DOES NOT refresh after each setTimeout cycle
- * processOutsideOfAngularZone() {
- * this.label = 'outside';
- * this.progress = 0;
- * this._ngZone.runOutsideAngular(() => {
- * this._increaseProgress(() => {
- * // reenter the Angular zone and display done
- * this._ngZone.run(() => {console.log('Outside Done!') });
- * }}));
- * }
- *
- *
- * _increaseProgress(doneCallback: () => void) {
- * this.progress += 1;
- * console.log(`Current progress: ${this.progress}%`);
- *
- * if (this.progress < 100) {
- * window.setTimeout(() => this._increaseProgress(doneCallback)), 10)
- * } else {
- * doneCallback();
- * }
- * }
- * }
- * ```
- */
- interface NgZone {
-
- /**
- * Executes the `fn` function synchronously within the Angular zone and returns value returned by
- * the function.
- *
- * Running functions via `run` allows you to reenter Angular zone from a task that was executed
- * outside of the Angular zone (typically started via {@link #runOutsideAngular}).
- *
- * Any future tasks or microtasks scheduled from within this function will continue executing from
- * within the Angular zone.
- */
- run(fn: () => any): any;
-
- /**
- * Executes the `fn` function synchronously in Angular's parent zone and returns value returned by
- * the function.
- *
- * Running functions via `runOutsideAngular` allows you to escape Angular's zone and do work that
- * doesn't trigger Angular change-detection or is subject to Angular's error handling.
- *
- * Any future tasks or microtasks scheduled from within this function will continue executing from
- * outside of the Angular zone.
- *
- * Use {@link #run} to reenter the Angular zone and do work that updates the application model.
- */
- runOutsideAngular(fn: () => any): any;
-
- }
-
-
- class WebWorkerApplication {
-
- constructor(_clientMessageBrokerFactory: ClientMessageBrokerFactory, _serviceMessageBrokerFactory: ServiceMessageBrokerFactory);
-
- createClientMessageBroker(channel: string, runInZone?: boolean): ClientMessageBroker;
-
- createServiceMessageBroker(channel: string, runInZone?: boolean): ServiceMessageBroker;
-
- }
-
-
- /**
- * Bootstrapping a WebWorker
- *
- * You instantiate a WebWorker application by calling bootstrap with the URI of your worker's index
- * script
- * Note: The WebWorker script must call bootstrapWebworker once it is set up to complete the
- * bootstrapping process
- */
- function bootstrap(uri: string): WebWorkerInstance;
-
-
-
- function spawnWebWorker(uri: string): WebWorkerInstance;
-
-
-
- /**
- * Wrapper class that exposes the {@link WebWorkerApplication}
- * Isolate instance and underlying {@link MessageBus} for lower level message passing.
- */
- class WebWorkerInstance {
-
- constructor(app: WebWorkerApplication, worker: Worker, bus: MessageBus);
-
- app: WebWorkerApplication;
-
- worker: Worker;
-
- bus: MessageBus;
-
- }
-
-
- /**
- * Message Bus is a low level API used to communicate between the UI and the background.
- * Communication is based on a channel abstraction. Messages published in a
- * given channel to one MessageBusSink are received on the same channel
- * by the corresponding MessageBusSource.
- */
- class MessageBus implements MessageBusSource, MessageBusSink {
-
- /**
- * Sets up a new channel on the MessageBus.
- * MUST be called before calling from or to on the channel.
- * If runInZone is true then the source will emit events inside the angular zone
- * and the sink will buffer messages and send only once the zone exits.
- * if runInZone is false then the source will emit events inside the global zone
- * and the sink will send messages immediately.
- */
- initChannel(channel: string, runInZone?: boolean): void;
-
- /**
- * Assigns this bus to the given zone.
- * Any callbacks attached to channels where runInZone was set to true on initialization
- * will be executed in the given zone.
- */
- attachToZone(zone: NgZone): void;
-
- /**
- * Returns an {@link EventEmitter} that emits every time a message
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
-
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
-
- }
-
-
- interface MessageBusSource {
-
- /**
- * Sets up a new channel on the MessageBusSource.
- * MUST be called before calling from on the channel.
- * If runInZone is true then the source will emit events inside the angular zone.
- * if runInZone is false then the source will emit events inside the global zone.
- */
- initChannel(channel: string, runInZone: boolean): void;
-
- /**
- * Assigns this source to the given zone.
- * Any channels which are initialized with runInZone set to true will emit events that will be
- * executed within the given zone.
- */
- attachToZone(zone: NgZone): void;
-
- /**
- * Returns an {@link EventEmitter} that emits every time a message
- * is received on the given channel.
- */
- from(channel: string): EventEmitter;
-
- }
-
-
- interface MessageBusSink {
-
- /**
- * Sets up a new channel on the MessageBusSink.
- * MUST be called before calling to on the channel.
- * If runInZone is true the sink will buffer messages and send only once the zone exits.
- * if runInZone is false the sink will send messages immediatly.
- */
- initChannel(channel: string, runInZone: boolean): void;
-
- /**
- * Assigns this sink to the given zone.
- * Any channels which are initialized with runInZone set to true will wait for the given zone
- * to exit before sending messages.
- */
- attachToZone(zone: NgZone): void;
-
- /**
- * Returns an {@link EventEmitter} for the given channel
- * To publish methods to that channel just call next (or add in dart) on the returned emitter
- */
- to(channel: string): EventEmitter;
-
- }
-
-
- interface ClientMessageBrokerFactory {
-
- /**
- * Initializes the given channel and attaches a new {@link ClientMessageBroker} to it.
- */
- createMessageBroker(channel: string, runInZone?: boolean): ClientMessageBroker;
-
- }
-
-
- interface ClientMessageBroker {
-
- channel: any;
-
- runOnService(args: UiArguments, returnType: Type): Promise<any>;
-
- }
-
-
- class FnArg {
-
- constructor(value: any, type: Type);
-
- value: any;
-
- type: Type;
-
- }
-
-
- class UiArguments {
-
- constructor(method: string, args?: FnArg[]);
-
- method: string;
-
- args: FnArg[];
-
- }
-
-
- interface ServiceMessageBrokerFactory {
-
- /**
- * Initializes the given channel and attaches a new {@link ServiceMessageBroker} to it.
- */
- createMessageBroker(channel: string, runInZone?: boolean): ServiceMessageBroker;
-
- }
-
-
- /**
- * Helper class for UIComponents that allows components to register methods.
- * If a registered method message is received from the broker on the worker,
- * the UIMessageBroker deserializes its arguments and calls the registered method.
- * If that method returns a promise, the UIMessageBroker returns the result to the worker.
- */
- interface ServiceMessageBroker {
-
- channel: any;
-
- registerMethod(methodName: string, signature: Type[], method: Function, returnType?: Type): void;
-
- }
-
-
- class ReceivedMessage {
-
- constructor(data: {[key: string]: any});
-
- method: string;
-
- args: any[];
-
- id: string;
-
- type: string;
-
- }
-
-
- var NgZone: InjectableReference;
-
-
-
- var ClientMessageBrokerFactory: InjectableReference;
-
-
-
- var ClientMessageBroker: InjectableReference;
-
-
-
- var ServiceMessageBrokerFactory: InjectableReference;
-
-
-
- var ServiceMessageBroker: InjectableReference;
-
-
-
-}
-
-declare module "angular2/web_worker/ui" {
- export = ngUi;
-}
-
-
+// Angular 2 distributes typings in our NPM package.
+// To get the typings, simply:
+// $ npm install angular2
+// and use TypeScript 1.6.2 or later.
+//
+// Note that TypeScript must be configured with
+// --moduleResolution node
+// which is the default when --module commonjs
diff --git a/angular2/http.d.ts b/angular2/http.d.ts
deleted file mode 100644
index 573d346a5..000000000
--- a/angular2/http.d.ts
+++ /dev/null
@@ -1,1310 +0,0 @@
-// Type definitions for Angular v2.0.0-local_sha.7d5c3eb
-// Project: http://angular.io/
-// Definitions by: angular team <https://github.com/angular/>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-// ***********************************************************
-// This file is generated by the Angular build process.
-// Please do not create manual edits or send pull requests
-// modifying this file.
-// ***********************************************************
-
-// angular2/http depends transitively on these libraries.
-// If you don't have them installed you can install them using TSD
-// https://github.com/DefinitelyTyped/tsd
-
-///<reference path="./angular2.d.ts"/>
-
-
-
-
-/**
- * @module
- * @description
- * The http module provides services to perform http requests. To get started, see the {@link Http}
- * class.
- */
-declare module ngHttp {
- /**
- * Mock Connection to represent a {@link Connection} for tests.
- */
- class MockConnection implements Connection {
-
- constructor(req: Request);
-
- /**
- * Describes the state of the connection, based on `XMLHttpRequest.readyState`, but with
- * additional states. For example, state 5 indicates an aborted connection.
- */
- readyState: ReadyStates;
-
- /**
- * {@link Request} instance used to create the connection.
- */
- request: Request;
-
- /**
- * {@link ng.EventEmitter} of {@link Response}. Can be subscribed to in order to be notified when a
- * response is available.
- */
- response: any;
-
- /**
- * Sends a mock response to the connection. This response is the value that is emitted to the
- * {@link ng.EventEmitter} returned by {@link Http}.
- *
- * #Example
- *
- * ```
- * var connection;
- * backend.connections.toRx().subscribe(c => connection = c);
- * http.request('data.json').toRx().subscribe(res => console.log(res.text()));
- * connection.mockRespond(new Response('fake response')); //logs 'fake response'
- * ```
- */
- mockRespond(res: Response): void;
-
- /**
- * Not yet implemented!
- *
- * Sends the provided {@link Response} to the `downloadObserver` of the `Request`
- * associated with this connection.
- */
- mockDownload(res: Response): void;
-
- /**
- * Emits the provided error object as an error to the {@link Response} {@link ng.EventEmitter}
- * returned
- * from {@link Http}.
- */
- mockError(err?: Error): void;
-
- }
-
-
- /**
- * A mock backend for testing the {@link Http} service.
- *
- * This class can be injected in tests, and should be used to override bindings
- * to other backends, such as {@link XHRBackend}.
- *
- * #Example
- *
- * ```
- * import {MockBackend, DefaultOptions, Http} from 'angular2/http';
- * it('should get some data', inject([AsyncTestCompleter], (async) => {
- * var connection;
- * var injector = Injector.resolveAndCreate([
- * MockBackend,
- * bind(Http).toFactory((backend, defaultOptions) => {
- * return new Http(backend, defaultOptions)
- * }, [MockBackend, DefaultOptions])]);
- * var http = injector.get(Http);
- * var backend = injector.get(MockBackend);
- * //Assign any newly-created connection to local variable
- * backend.connections.toRx().subscribe(c => connection = c);
- * http.request('data.json').toRx().subscribe((res) => {
- * expect(res.text()).toBe('awesome');
- * async.done();
- * });
- * connection.mockRespond(new Response('awesome'));
- * }));
- * ```
- *
- * This method only exists in the mock implementation, not in real Backends.
- */
- class MockBackend implements ConnectionBackend {
-
- constructor();
-
- /**
- * {@link ng.EventEmitter}
- * of {@link MockConnection} instances that have been created by this backend. Can be subscribed
- * to in order to respond to connections.
- *
- * #Example
- *
- * ```
- * import {MockBackend, Http, BaseRequestOptions} from 'angular2/http';
- * import {Injector} from 'angular2/core';
- *
- * it('should get a response', () => {
- * var connection; //this will be set when a new connection is emitted from the backend.
- * var text; //this will be set from mock response
- * var injector = Injector.resolveAndCreate([
- * MockBackend,
- * bind(Http).toFactory(backend, options) {
- * return new Http(backend, options);
- * }, [MockBackend, BaseRequestOptions]]);
- * var backend = injector.get(MockBackend);
- * var http = injector.get(Http);
- * backend.connections.toRx().subscribe(c => connection = c);
- * http.request('something.json').toRx().subscribe(res => {
- * text = res.text();
- * });
- * connection.mockRespond(new Response({body: 'Something'}));
- * expect(text).toBe('Something');
- * });
- * ```
- *
- * This property only exists in the mock implementation, not in real Backends.
- */
- connections: any;
-
- /**
- * An array representation of `connections`. This array will be updated with each connection that
- * is created by this backend.
- *
- * This property only exists in the mock implementation, not in real Backends.
- */
- connectionsArray: MockConnection[];
-
- /**
- * {@link ng.EventEmitter} of {@link MockConnection} instances that haven't yet been resolved (i.e.
- * with a `readyState`
- * less than 4). Used internally to verify that no connections are pending via the
- * `verifyNoPendingRequests` method.
- *
- * This property only exists in the mock implementation, not in real Backends.
- */
- pendingConnections: any;
-
- /**
- * Checks all connections, and raises an exception if any connection has not received a response.
- *
- * This method only exists in the mock implementation, not in real Backends.
- */
- verifyNoPendingRequests(): void;
-
- /**
- * Can be used in conjunction with `verifyNoPendingRequests` to resolve any not-yet-resolve
- * connections, if it's expected that there are connections that have not yet received a response.
- *
- * This method only exists in the mock implementation, not in real Backends.
- */
- resolveAllConnections(): void;
-
- /**
- * Creates a new {@link MockConnection}. This is equivalent to calling `new
- * MockConnection()`, except that it also will emit the new `Connection` to the `connections`
- * emitter of this `MockBackend` instance. This method will usually only be used by tests
- * against the framework itself, not by end-users.
- */
- createConnection(req: Request): Connection;
-
- }
-
-
- /**
- * Creates `Request` instances from provided values.
- *
- * The Request's interface is inspired by the Request constructor defined in the [Fetch
- * Spec](https://fetch.spec.whatwg.org/#request-class),
- * but is considered a static value whose body can be accessed many times. There are other
- * differences in the implementation, but this is the most significant.
- *
- * `Request` instances are typically created by higher-level classes, like {@link Http} and
- * {@link Jsonp}, but it may occasionally be useful to explicitly create `Request` instances.
- * One such example is when creating services that wrap higher-level services, like {@link Http},
- * where it may be useful to generate a `Request` with arbitrary headers and search params.
- *
- * ```typescript
- * import {Injectable, Injector} from 'angular2/angular2';
- * import {HTTP_BINDINGS, Http, Request, RequestMethods} from 'angular2/http';
- *
- * @Injectable()
- * class AutoAuthenticator {
- * constructor(public http:Http) {}
- * request(url:string) {
- * return this.http.request(new Request({
- * method: RequestMethods.Get,
- * url: url,
- * search: 'password=123'
- * }));
- * }
- * }
- *
- * var injector = Injector.resolveAndCreate([HTTP_BINDINGS, AutoAuthenticator]);
- * var authenticator = injector.get(AutoAuthenticator);
- * authenticator.request('people.json').toRx().subscribe(res => {
- * //URL should have included '?password=123'
- * console.log('people', res.json());
- * });
- * ```
- */
- class Request {
-
- constructor(requestOptions: RequestOptions);
-
- /**
- * Http method with which to perform the request.
- */
- method: RequestMethods;
-
- /**
- * {@link Headers} instance
- */
- headers: Headers;
-
- /**
- * Url of the remote resource
- */
- url: string;
-
- /**
- * Returns the request's body as string, assuming that body exists. If body is undefined, return
- * empty
- * string.
- */
- text(): String;
-
- }
-
-
- /**
- * Creates `Response` instances from provided values.
- *
- * Though this object isn't
- * usually instantiated by end-users, it is the primary object interacted with when it comes time to
- * add data to a view.
- *
- * #Example
- *
- * ```
- * http.request('my-friends.txt').toRx().subscribe(response => this.friends = response.text());
- * ```
- *
- * The Response's interface is inspired by the Response constructor defined in the [Fetch
- * Spec](https://fetch.spec.whatwg.org/#response-class), but is considered a static value whose body
- * can be accessed many times. There are other differences in the implementation, but this is the
- * most significant.
- */
- class Response {
-
- constructor(responseOptions: ResponseOptions);
-
- /**
- * One of "basic", "cors", "default", "error, or "opaque".
- *
- * Defaults to "default".
- */
- type: ResponseTypes;
-
- /**
- * True if the response's status is within 200-299
- */
- ok: boolean;
-
- /**
- * URL of response.
- *
- * Defaults to empty string.
- */
- url: string;
-
- /**
- * Status code returned by server.
- *
- * Defaults to 200.
- */
- status: number;
-
- /**
- * Text representing the corresponding reason phrase to the `status`, as defined in [ietf rfc 2616
- * section 6.1.1](https://tools.ietf.org/html/rfc2616#section-6.1.1)
- *
- * Defaults to "OK"
- */
- statusText: string;
-
- /**
- * Non-standard property
- *
- * Denotes how many of the response body's bytes have been loaded, for example if the response is
- * the result of a progress event.
- */
- bytesLoaded: number;
-
- /**
- * Non-standard property
- *
- * Denotes how many bytes are expected in the final response body.
- */
- totalBytes: number;
-
- /**
- * Headers object based on the `Headers` class in the [Fetch
- * Spec](https://fetch.spec.whatwg.org/#headers-class).
- */
- headers: Headers;
-
- /**
- * Not yet implemented
- */
- blob(): any;
-
- /**
- * Attempts to return body as parsed `JSON` object, or raises an exception.
- */
- json(): Object;
-
- /**
- * Returns the body as a string, presuming `toString()` can be called on the response body.
- */
- text(): string;
-
- /**
- * Not yet implemented
- */
- arrayBuffer(): any;
-
- }
-
-
- /**
- * Interface for options to construct a Request, based on
- * [RequestInit](https://fetch.spec.whatwg.org/#requestinit) from the Fetch spec.
- */
- type RequestOptionsArgs = {
- url?: string;
- method?: string | RequestMethods;
- search?: string | URLSearchParams;
- headers?: Headers;
- // TODO: Support Blob, ArrayBuffer, JSON, URLSearchParams, FormData
- body?: string;
- }
-
-
- /**
- * Interface for options to construct a Response, based on
- * [ResponseInit](https://fetch.spec.whatwg.org/#responseinit) from the Fetch spec.
- */
- type ResponseOptionsArgs = {
- // TODO: Support Blob, ArrayBuffer, JSON
- body?: string | Object | FormData;
- status?: number;
- statusText?: string;
- headers?: Headers;
- type?: ResponseTypes;
- url?: string;
- }
-
-
- /**
- * Abstract class from which real connections are derived.
- */
- class Connection {
-
- readyState: ReadyStates;
-
- request: Request;
-
- response: any;
-
- }
-
-
- /**
- * Abstract class from which real backends are derived.
- *
- * The primary purpose of a `ConnectionBackend` is to create new connections to fulfill a given
- * {@link Request}.
- */
- class ConnectionBackend {
-
- constructor();
-
- createConnection(request: any): Connection;
-
- }
-
-
- class BrowserXhr {
-
- constructor();
-
- build(): any;
-
- }
-
-
- /**
- * Subclass of {@link RequestOptions}, with default values.
- *
- * Default values:
- * * method: {@link RequestMethods RequestMethods.Get}
- * * headers: empty {@link Headers} object
- *
- * This class could be extended and bound to the {@link RequestOptions} class
- * when configuring an {@link Injector}, in order to override the default options
- * used by {@link Http} to create and send {@link Request Requests}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/LEKVSx?p=preview))
- *
- * ```typescript
- * import {bind, bootstrap} from 'angular2/angular2';
- * import {HTTP_BINDINGS, Http, BaseRequestOptions, RequestOptions} from 'angular2/http';
- * import {App} from './myapp';
- *
- * class MyOptions extends BaseRequestOptions {
- * search: string = 'coreTeam=true';
- * }
- *
- * bootstrap(App, [HTTP_BINDINGS, bind(RequestOptions).toClass(MyOptions)]);
- * ```
- *
- * The options could also be extended when manually creating a {@link Request}
- * object.
- *
- * ### Example ([live demo](http://plnkr.co/edit/oyBoEvNtDhOSfi9YxaVb?p=preview))
- *
- * ```
- * import {BaseRequestOptions, Request, RequestMethods} from 'angular2/http';
- *
- * var options = new BaseRequestOptions();
- * var req = new Request(options.merge({
- * method: RequestMethods.Post,
- * url: 'https://google.com'
- * }));
- * console.log('req.method:', RequestMethods[req.method]); // Post
- * console.log('options.url:', options.url); // null
- * console.log('req.url:', req.url); // https://google.com
- * ```
- */
- class BaseRequestOptions extends RequestOptions {
-
- constructor();
-
- }
-
-
- /**
- * Creates a request options object to be optionally provided when instantiating a
- * {@link Request}.
- *
- * This class is based on the `RequestInit` description in the [Fetch
- * Spec](https://fetch.spec.whatwg.org/#requestinit).
- *
- * All values are null by default. Typical defaults can be found in the {@link BaseRequestOptions}
- * class, which sub-classes `RequestOptions`.
- *
- * ### Example ([live demo](http://plnkr.co/edit/7Wvi3lfLq41aQPKlxB4O?p=preview))
- *
- * ```typescript
- * import {RequestOptions, Request, RequestMethods} from 'angular2/http';
- *
- * var options = new RequestOptions({
- * method: RequestMethods.Post,
- * url: 'https://google.com'
- * });
- * var req = new Request(options);
- * console.log('req.method:', RequestMethods[req.method]); // Post
- * console.log('options.url:', options.url); // https://google.com
- * ```
- */
- class RequestOptions {
-
- constructor({method, headers, body, url, search}?: RequestOptionsArgs);
-
- /**
- * Http method with which to execute a {@link Request}.
- * Acceptable methods are defined in the {@link RequestMethods} enum.
- */
- method: RequestMethods | string;
-
- /**
- * {@link Headers} to be attached to a {@link Request}.
- */
- headers: Headers;
-
- /**
- * Body to be used when creating a {@link Request}.
- */
- body: string;
-
- /**
- * Url with which to perform a {@link Request}.
- */
- url: string;
-
- /**
- * Search parameters to be included in a {@link Request}.
- */
- search: URLSearchParams;
-
- /**
- * Creates a copy of the `RequestOptions` instance, using the optional input as values to override
- * existing values. This method will not change the values of the instance on which it is being
- * called.
- *
- * Note that `headers` and `search` will override existing values completely if present in
- * the `options` object. If these values should be merged, it should be done prior to calling
- * `merge` on the `RequestOptions` instance.
- *
- * Example ([live demo](http://plnkr.co/edit/6w8XA8YTkDRcPYpdB9dk?p=preview))
- *
- * ```typescript
- * import {RequestOptions, Request, RequestMethods} from 'angular2/http';
- *
- * var options = new RequestOptions({
- * method: RequestMethods.Post
- * });
- * var req = new Request(options.merge({
- * url: 'https://google.com'
- * }));
- * console.log('req.method:', RequestMethods[req.method]); // Post
- * console.log('options.url:', options.url); // null
- * console.log('req.url:', req.url); // https://google.com
- * ```
- */
- merge(options?: RequestOptionsArgs): RequestOptions;
-
- }
-
-
- /**
- * Subclass of {@link ResponseOptions}, with default values.
- *
- * Default values:
- * * status: 200
- * * headers: empty {@link Headers} object
- *
- * This class could be extended and bound to the {@link ResponseOptions} class
- * when configuring an {@link Injector}, in order to override the default options
- * used by {@link Http} to create {@link Response Responses}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/qv8DLT?p=preview))
- *
- * ```typescript
- * import {bind, bootstrap} from 'angular2/angular2';
- * import {HTTP_BINDINGS, Headers, Http, BaseResponseOptions, ResponseOptions} from 'angular2/http';
- * import {App} from './myapp';
- *
- * class MyOptions extends BaseResponseOptions {
- * headers:Headers = new Headers({network: 'github'});
- * }
- *
- * bootstrap(App, [HTTP_BINDINGS, bind(ResponseOptions).toClass(MyOptions)]);
- * ```
- *
- * The options could also be extended when manually creating a {@link Response}
- * object.
- *
- * ### Example ([live demo](http://plnkr.co/edit/VngosOWiaExEtbstDoix?p=preview))
- *
- * ```
- * import {BaseResponseOptions, Response} from 'angular2/http';
- *
- * var options = new BaseResponseOptions();
- * var res = new Response(options.merge({
- * body: 'Angular2',
- * headers: new Headers({framework: 'angular'})
- * }));
- * console.log('res.headers.get("framework"):', res.headers.get('framework')); // angular
- * console.log('res.text():', res.text()); // Angular2;
- * ```
- */
- class BaseResponseOptions extends ResponseOptions {
-
- constructor();
-
- }
-
-
- /**
- * Creates a response options object to be optionally provided when instantiating a
- * {@link Response}.
- *
- * This class is based on the `ResponseInit` description in the [Fetch
- * Spec](https://fetch.spec.whatwg.org/#responseinit).
- *
- * All values are null by default. Typical defaults can be found in the
- * {@link BaseResponseOptions} class, which sub-classes `ResponseOptions`.
- *
- * This class may be used in tests to build {@link Response Responses} for
- * mock responses (see {@link MockBackend}).
- *
- * ### Example ([live demo](http://plnkr.co/edit/P9Jkk8e8cz6NVzbcxEsD?p=preview))
- *
- * ```typescript
- * import {ResponseOptions, Response} from 'angular2/http';
- *
- * var options = new ResponseOptions({
- * body: '{"name":"Jeff"}'
- * });
- * var res = new Response(options);
- *
- * console.log('res.json():', res.json()); // Object {name: "Jeff"}
- * ```
- */
- class ResponseOptions {
-
- constructor({body, status, headers, statusText, type, url}?: ResponseOptionsArgs);
-
- /**
- * String or Object representing the body of the {@link Response}.
- */
- body: string | Object;
-
- /**
- * Http {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html status code}
- * associated with the response.
- */
- status: number;
-
- /**
- * Response {@link Headers headers}
- */
- headers: Headers;
-
- url: string;
-
- /**
- * Creates a copy of the `ResponseOptions` instance, using the optional input as values to
- * override
- * existing values. This method will not change the values of the instance on which it is being
- * called.
- *
- * This may be useful when sharing a base `ResponseOptions` object inside tests,
- * where certain properties may change from test to test.
- *
- * Example ([live demo](http://plnkr.co/edit/1lXquqFfgduTFBWjNoRE?p=preview))
- *
- * ```typescript
- * import {ResponseOptions, Response} from 'angular2/http';
- *
- * var options = new ResponseOptions({
- * body: {name: 'Jeff'}
- * });
- * var res = new Response(options.merge({
- * url: 'https://google.com'
- * }));
- * console.log('options.url:', options.url); // null
- * console.log('res.json():', res.json()); // Object {name: "Jeff"}
- * console.log('res.url:', res.url); // https://google.com
- * ```
- */
- merge(options?: ResponseOptionsArgs): ResponseOptions;
-
- }
-
-
- /**
- * Creates {@link XHRConnection} instances.
- *
- * This class would typically not be used by end users, but could be
- * overridden if a different backend implementation should be used,
- * such as in a node backend.
- *
- * #Example
- *
- * ```
- * import {Http, MyNodeBackend, HTTP_BINDINGS, BaseRequestOptions} from 'angular2/http';
- * @Component({
- * viewBindings: [
- * HTTP_BINDINGS,
- * bind(Http).toFactory((backend, options) => {
- * return new Http(backend, options);
- * }, [MyNodeBackend, BaseRequestOptions])]
- * })
- * class MyComponent {
- * constructor(http:Http) {
- * http('people.json').toRx().subscribe(res => this.people = res.json());
- * }
- * }
- * ```
- */
- class XHRBackend implements ConnectionBackend {
-
- constructor(_browserXHR: BrowserXhr, _baseResponseOptions: ResponseOptions);
-
- createConnection(request: Request): XHRConnection;
-
- }
-
-
- /**
- * Creates connections using `XMLHttpRequest`. Given a fully-qualified
- * request, an `XHRConnection` will immediately create an `XMLHttpRequest` object and send the
- * request.
- *
- * This class would typically not be created or interacted with directly inside applications, though
- * the {@link MockConnection} may be interacted with in tests.
- */
- class XHRConnection implements Connection {
-
- constructor(req: Request, browserXHR: BrowserXhr, baseResponseOptions?: ResponseOptions);
-
- request: Request;
-
- /**
- * Response {@link ng.EventEmitter} which emits a single {@link Response} value on load event of
- * `XMLHttpRequest`.
- */
- response: any;
-
- readyState: ReadyStates;
-
- }
-
-
- interface JSONPBackend extends ConnectionBackend {
-
- createConnection(request: Request): JSONPConnection;
-
- }
-
-
- interface JSONPConnection extends Connection {
-
- readyState: ReadyStates;
-
- request: Request;
-
- response: any;
-
- baseResponseOptions: ResponseOptions;
-
- finished(data?: any): void;
-
- }
-
-
- /**
- * Performs http requests using `XMLHttpRequest` as the default backend.
- *
- * `Http` is available as an injectable class, with methods to perform http requests. Calling
- * `request` returns an {@link ng.Observable} which will emit a single {@link Response} when a
- * response is received.
- *
- * #Example
- *
- * ```typescript
- * import {Http, HTTP_BINDINGS} from 'angular2/http';
- * @Component({selector: 'http-app', viewBindings: [HTTP_BINDINGS]})
- * @View({templateUrl: 'people.html'})
- * class PeopleComponent {
- * constructor(http: Http) {
- * http.get('people.json')
- * // Call map on the response observable to get the parsed people object
- * .map(res => res.json())
- * // Subscribe to the observable to get the parsed people object and attach it to the
- * // component
- * .subscribe(people => this.people = people);
- * }
- * }
- * ```
- *
- *
- * #Example
- *
- * ```
- * http.get('people.json').observer({next: (value) => this.people = people});
- * ```
- *
- * The default construct used to perform requests, `XMLHttpRequest`, is abstracted as a "Backend" (
- * {@link XHRBackend} in this case), which could be mocked with dependency injection by replacing
- * the {@link XHRBackend} binding, as in the following example:
- *
- * #Example
- *
- * ```typescript
- * import {MockBackend, BaseRequestOptions, Http} from 'angular2/http';
- * var injector = Injector.resolveAndCreate([
- * BaseRequestOptions,
- * MockBackend,
- * bind(Http).toFactory(
- * function(backend, defaultOptions) {
- * return new Http(backend, defaultOptions);
- * },
- * [MockBackend, BaseRequestOptions])
- * ]);
- * var http = injector.get(Http);
- * http.get('request-from-mock-backend.json').subscribe((res:Response) => doSomething(res));
- * ```
- */
- class Http {
-
- constructor(_backend: ConnectionBackend, _defaultOptions: RequestOptions);
-
- /**
- * Performs any type of http request. First argument is required, and can either be a url or
- * a {@link Request} instance. If the first argument is a url, an optional {@link RequestOptions}
- * object can be provided as the 2nd argument. The options object will be merged with the values
- * of {@link BaseRequestOptions} before performing the request.
- */
- request(url: string | Request, options?: RequestOptionsArgs): any;
-
- /**
- * Performs a request with `get` http method.
- */
- get(url: string, options?: RequestOptionsArgs): any;
-
- /**
- * Performs a request with `post` http method.
- */
- post(url: string, body: string, options?: RequestOptionsArgs): any;
-
- /**
- * Performs a request with `put` http method.
- */
- put(url: string, body: string, options?: RequestOptionsArgs): any;
-
- /**
- * Performs a request with `delete` http method.
- */
- delete(url: string, options?: RequestOptionsArgs): any;
-
- /**
- * Performs a request with `patch` http method.
- */
- patch(url: string, body: string, options?: RequestOptionsArgs): any;
-
- /**
- * Performs a request with `head` http method.
- */
- head(url: string, options?: RequestOptionsArgs): any;
-
- }
-
-
- class Jsonp extends Http {
-
- constructor(backend: ConnectionBackend, defaultOptions: RequestOptions);
-
- /**
- * Performs any type of http request. First argument is required, and can either be a url or
- * a {@link Request} instance. If the first argument is a url, an optional {@link RequestOptions}
- * object can be provided as the 2nd argument. The options object will be merged with the values
- * of {@link BaseRequestOptions} before performing the request.
- */
- request(url: string | Request, options?: RequestOptionsArgs): any;
-
- }
-
-
- /**
- * Polyfill for [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers/Headers), as
- * specified in the [Fetch Spec](https://fetch.spec.whatwg.org/#headers-class).
- *
- * The only known difference between this `Headers` implementation and the spec is the
- * lack of an `entries` method.
- *
- * ### Example ([live demo](http://plnkr.co/edit/MTdwT6?p=preview))
- *
- * ```
- * import {Headers} from 'angular2/http';
- *
- * var firstHeaders = new Headers();
- * firstHeaders.append('Content-ng.Type', 'image/jpeg');
- * console.log(firstHeaders.get('Content-ng.Type')) //'image/jpeg'
- *
- * // Create headers from Plain Old JavaScript Object
- * var secondHeaders = new Headers({
- * 'X-My-Custom-Header': 'Angular'
- * });
- * console.log(secondHeaders.get('X-My-Custom-Header')); //'Angular'
- *
- * var thirdHeaders = new Headers(secondHeaders);
- * console.log(thirdHeaders.get('X-My-Custom-Header')); //'Angular'
- * ```
- */
- class Headers {
-
- constructor(headers?: Headers | {[key: string]: any});
-
- /**
- * Appends a header to existing list of header values for a given header name.
- */
- append(name: string, value: string): void;
-
- /**
- * Deletes all header values for the given name.
- */
- delete(name: string): void;
-
- forEach(fn: (value: string, name: string, headers: Headers) => any): void;
-
- /**
- * Returns first header that matches given name.
- */
- get(header: string): string;
-
- /**
- * Check for existence of header by given name.
- */
- has(header: string): boolean;
-
- /**
- * Provides names of set headers
- */
- keys(): string[];
-
- /**
- * Sets or overrides header value for given name.
- */
- set(header: string, value: string | string[]): void;
-
- /**
- * Returns values of all headers.
- */
- values(): string[][];
-
- /**
- * Returns list of header values for a given name.
- */
- getAll(header: string): string[];
-
- /**
- * This method is not implemented.
- */
- entries(): void;
-
- }
-
-
- /**
- * Acceptable response types to be associated with a {@link Response}, based on
- * [ResponseType](https://fetch.spec.whatwg.org/#responsetype) from the Fetch spec.
- */
- enum ResponseTypes {
-
- Basic,
-
- Cors,
-
- Default,
-
- Error,
-
- Opaque
- }
-
-
-
- /**
- * All possible states in which a connection can be, based on
- * [States](http://www.w3.org/TR/XMLHttpRequest/#states) from the `XMLHttpRequest` spec, but with an
- * additional "CANCELLED" state.
- */
- enum ReadyStates {
-
- Unsent,
-
- Open,
-
- HeadersReceived,
-
- Loading,
-
- Done,
-
- Cancelled
- }
-
-
-
- /**
- * Supported http methods.
- */
- enum RequestMethods {
-
- Get,
-
- Post,
-
- Put,
-
- Delete,
-
- Options,
-
- Head,
-
- Patch
- }
-
-
-
- /**
- * Map-like representation of url search parameters, based on
- * [URLSearchParams](https://url.spec.whatwg.org/#urlsearchparams) in the url living standard,
- * with several extensions for merging URLSearchParams objects:
- * - setAll()
- * - appendAll()
- * - replaceAll()
- */
- class URLSearchParams {
-
- constructor(rawParams?: string);
-
- paramsMap: Map<string, string[]>;
-
- rawParams: string;
-
- clone(): URLSearchParams;
-
- has(param: string): boolean;
-
- get(param: string): string;
-
- getAll(param: string): string[];
-
- set(param: string, val: string): void;
-
- setAll(searchParams: URLSearchParams): void;
-
- append(param: string, val: string): void;
-
- appendAll(searchParams: URLSearchParams): void;
-
- replaceAll(searchParams: URLSearchParams): void;
-
- toString(): string;
-
- delete(param: string): void;
-
- }
-
-
- /**
- * Provides a basic set of injectables to use the {@link Http} service in any application.
- *
- * The `HTTP_BINDINGS` should be included either in a component's injector,
- * or in the root injector when bootstrapping an application.
- *
- * ### Example ([live demo](http://plnkr.co/edit/snj7Nv?p=preview))
- *
- * ```
- * import {bootstrap, Component, NgFor, View} from 'angular2/angular2';
- * import {HTTP_BINDINGS, Http} from 'angular2/http';
- *
- * @Component({
- * selector: 'app',
- * bindings: [HTTP_BINDINGS]
- * })
- * @View({
- * template: `
- * <div>
- * <h1>People</h1>
- * <ul>
- * <li *ng-for="#person of people">
- * {{person.name}}
- * </li>
- * </ul>
- * </div>
- * `,
- * directives: [NgFor]
- * })
- * export class App {
- * people: Object[];
- * constructor(http:Http) {
- * http.get('people.json').toRx().subscribe(res => {
- * this.people = res.json();
- * });
- * }
- * active:boolean = false;
- * toggleActiveState() {
- * this.active = !this.active;
- * }
- * }
- *
- * bootstrap(App)
- * .catch(err => console.error(err));
- * ```
- *
- * The primary public API included in `HTTP_BINDINGS` is the {@link Http} class.
- * However, other bindings required by `Http` are included,
- * which may be beneficial to override in certain cases.
- *
- * The bindings included in `HTTP_BINDINGS` include:
- * * {@link Http}
- * * {@link XHRBackend}
- * * `BrowserXHR` - Private factory to create `XMLHttpRequest` instances
- * * {@link RequestOptions} - Bound to {@link BaseRequestOptions} class
- * * {@link ResponseOptions} - Bound to {@link BaseResponseOptions} class
- *
- * There may be cases where it makes sense to extend the base request options,
- * such as to add a search string to be appended to all URLs.
- * To accomplish this, a new binding for {@link RequestOptions} should
- * be added in the same injector as `HTTP_BINDINGS`.
- *
- * ### Example ([live demo](http://plnkr.co/edit/aCMEXi?p=preview))
- *
- * ```
- * import {bind, bootstrap} from 'angular2/angular2';
- * import {HTTP_BINDINGS, BaseRequestOptions, RequestOptions} from 'angular2/http';
- *
- * class MyOptions extends BaseRequestOptions {
- * search: string = 'coreTeam=true';
- * }
- *
- * bootstrap(App, [HTTP_BINDINGS, bind(RequestOptions).toClass(MyOptions)])
- * .catch(err => console.error(err));
- * ```
- *
- * Likewise, to use a mock backend for unit tests, the {@link XHRBackend}
- * binding should be bound to {@link MockBackend}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/7LWALD?p=preview))
- *
- * ```
- * import {bind, Injector} from 'angular2/angular2';
- * import {HTTP_BINDINGS, Http, Response, XHRBackend, MockBackend} from 'angular2/http';
- *
- * var people = [{name: 'Jeff'}, {name: 'Tobias'}];
- *
- * var injector = Injector.resolveAndCreate([
- * HTTP_BINDINGS,
- * MockBackend,
- * bind(XHRBackend).toAlias(MockBackend)
- * ]);
- * var http = injector.get(Http);
- * var backend = injector.get(MockBackend);
- *
- * // Listen for any new requests
- * backend.connections.observer({
- * next: connection => {
- * var response = new Response({body: people});
- * setTimeout(() => {
- * // Send a response to the request
- * connection.mockRespond(response);
- * });
- * });
- *
- * http.get('people.json').observer({
- * next: res => {
- * // Response came from mock backend
- * console.log('first person', res.json()[0].name);
- * }
- * });
- * ```
- */
- let HTTP_BINDINGS: any[];
-
-
-
- /**
- * Provides a basic set of bindings to use the {@link Jsonp} service in any application.
- *
- * The `JSONP_BINDINGS` should be included either in a component's injector,
- * or in the root injector when bootstrapping an application.
- *
- * ### Example ([live demo](http://plnkr.co/edit/vmeN4F?p=preview))
- *
- * ```
- * import {Component, NgFor, View} from 'angular2/angular2';
- * import {JSONP_BINDINGS, Jsonp} from 'angular2/http';
- *
- * @Component({
- * selector: 'app',
- * bindings: [JSONP_BINDINGS]
- * })
- * @View({
- * template: `
- * <div>
- * <h1>People</h1>
- * <ul>
- * <li *ng-for="#person of people">
- * {{person.name}}
- * </li>
- * </ul>
- * </div>
- * `,
- * directives: [NgFor]
- * })
- * export class App {
- * people: Array<Object>;
- * constructor(jsonp:Jsonp) {
- * jsonp.request('people.json').toRx().subscribe(res => {
- * this.people = res.json();
- * })
- * }
- * }
- * ```
- *
- * The primary public API included in `JSONP_BINDINGS` is the {@link Jsonp} class.
- * However, other bindings required by `Jsonp` are included,
- * which may be beneficial to override in certain cases.
- *
- * The bindings included in `JSONP_BINDINGS` include:
- * * {@link Jsonp}
- * * {@link JSONPBackend}
- * * `BrowserJsonp` - Private factory
- * * {@link RequestOptions} - Bound to {@link BaseRequestOptions} class
- * * {@link ResponseOptions} - Bound to {@link BaseResponseOptions} class
- *
- * There may be cases where it makes sense to extend the base request options,
- * such as to add a search string to be appended to all URLs.
- * To accomplish this, a new binding for {@link RequestOptions} should
- * be added in the same injector as `JSONP_BINDINGS`.
- *
- * ### Example ([live demo](http://plnkr.co/edit/TFug7x?p=preview))
- *
- * ```
- * import {bind, bootstrap} from 'angular2/angular2';
- * import {JSONP_BINDINGS, BaseRequestOptions, RequestOptions} from 'angular2/http';
- *
- * class MyOptions extends BaseRequestOptions {
- * search: string = 'coreTeam=true';
- * }
- *
- * bootstrap(App, [JSONP_BINDINGS, bind(RequestOptions).toClass(MyOptions)])
- * .catch(err => console.error(err));
- * ```
- *
- * Likewise, to use a mock backend for unit tests, the {@link JSONPBackend}
- * binding should be bound to {@link MockBackend}.
- *
- * ### Example ([live demo](http://plnkr.co/edit/HDqZWL?p=preview))
- *
- * ```
- * import {bind, Injector} from 'angular2/angular2';
- * import {JSONP_BINDINGS, Jsonp, Response, JSONPBackend, MockBackend} from 'angular2/http';
- *
- * var people = [{name: 'Jeff'}, {name: 'Tobias'}];
- * var injector = Injector.resolveAndCreate([
- * JSONP_BINDINGS,
- * MockBackend,
- * bind(JSONPBackend).toAlias(MockBackend)
- * ]);
- * var jsonp = injector.get(Jsonp);
- * var backend = injector.get(MockBackend);
- *
- * // Listen for any new requests
- * backend.connections.observer({
- * next: connection => {
- * var response = new Response({body: people});
- * setTimeout(() => {
- * // Send a response to the request
- * connection.mockRespond(response);
- * });
- * });
- *
- * jsonp.get('people.json').observer({
- * next: res => {
- * // Response came from mock backend
- * console.log('first person', res.json()[0].name);
- * }
- * });
- * ```
- */
- let JSONP_BINDINGS: any[];
-
-
-
- var JSONPBackend: ng.InjectableReference;
-
-
-
- var JSONPConnection: ng.InjectableReference;
-
-
-
-}
-
-declare module "angular2/http" {
- export = ngHttp;
-}
-
-
diff --git a/angular2/router.d.ts b/angular2/router.d.ts
deleted file mode 100644
index be33ebf93..000000000
--- a/angular2/router.d.ts
+++ /dev/null
@@ -1,1330 +0,0 @@
-// Type definitions for Angular v2.0.0-39
-// Project: http://angular.io/
-// Definitions by: angular team <https://github.com/angular/>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-// ***********************************************************
-// This file is generated by the Angular build process.
-// Please do not create manual edits or send pull requests
-// modifying this file.
-// ***********************************************************
-
-// angular2/router depends transitively on these libraries.
-// If you don't have them installed you can install them using TSD
-// https://github.com/DefinitelyTyped/tsd
-
-///<reference path="./angular2.d.ts"/>
-
-
-
-
-/**
- * @module
- * @description
- * Maps application URLs into application states, to support deep-linking and navigation.
- */
-declare module ngRouter {
- /**
- * The `Router` is responsible for mapping URLs to components.
- *
- * You can see the state of the router by inspecting the read-only field `router.navigating`.
- * This may be useful for showing a spinner, for instance.
- *
- * ## Concepts
- *
- * Routers and component instances have a 1:1 correspondence.
- *
- * The router holds reference to a number of {@link RouterOutlet}.
- * An outlet is a placeholder that the router dynamically fills in depending on the current URL.
- *
- * When the router navigates from a URL, it must first recognize it and serialize it into an
- * `Instruction`.
- * The router uses the `RouteRegistry` to get an `Instruction`.
- */
- class Router {
-
- constructor(registry: RouteRegistry, parent: Router, hostComponent: any);
-
- navigating: boolean;
-
- lastNavigationAttempt: string;
-
- registry: RouteRegistry;
-
- parent: Router;
-
- hostComponent: any;
-
- /**
- * Constructs a child router. You probably don't need to use this unless you're writing a reusable
- * component.
- */
- childRouter(hostComponent: any): Router;
-
- /**
- * Constructs a child router. You probably don't need to use this unless you're writing a reusable
- * component.
- */
- auxRouter(hostComponent: any): Router;
-
- /**
- * Register an outlet to notified of primary route changes.
- *
- * You probably don't need to use this unless you're writing a reusable component.
- */
- registerPrimaryOutlet(outlet: RouterOutlet): Promise<boolean>;
-
- /**
- * Register an outlet to notified of auxiliary route changes.
- *
- * You probably don't need to use this unless you're writing a reusable component.
- */
- registerAuxOutlet(outlet: RouterOutlet): Promise<boolean>;
-
- /**
- * Given an instruction, returns `true` if the instruction is currently active,
- * otherwise `false`.
- */
- isRouteActive(instruction: Instruction): boolean;
-
- /**
- * Dynamically update the routing configuration and trigger a navigation.
- *
- * # Usage
- *
- * ```
- * router.config([
- * { 'path': '/', 'component': IndexComp },
- * { 'path': '/user/:id', 'component': UserComp },
- * ]);
- * ```
- */
- config(definitions: RouteDefinition[]): Promise<any>;
-
- /**
- * Navigate based on the provided Route Link DSL. It's preferred to navigate with this method
- * over `navigateByUrl`.
- *
- * # Usage
- *
- * This method takes an array representing the Route Link DSL:
- * ```
- * ['./MyCmp', {param: 3}]
- * ```
- * See the {@link RouterLink} directive for more.
- */
- navigate(linkParams: any[]): Promise<any>;
-
- /**
- * Navigate to a URL. Returns a promise that resolves when navigation is complete.
- * It's preferred to navigate with `navigate` instead of this method, since URLs are more brittle.
- *
- * If the given URL begins with a `/`, router will navigate absolutely.
- * If the given URL does not begin with `/`, the router will navigate relative to this component.
- */
- navigateByUrl(url: string, _skipLocationChange?: boolean): Promise<any>;
-
- /**
- * Navigate via the provided instruction. Returns a promise that resolves when navigation is
- * complete.
- */
- navigateByInstruction(instruction: Instruction, _skipLocationChange?: boolean): Promise<any>;
-
- /**
- * Updates this router and all descendant routers according to the given instruction
- */
- commit(instruction: Instruction, _skipLocationChange?: boolean): Promise<any>;
-
- /**
- * Subscribe to URL updates from the router
- */
- subscribe(onNext: (value: any) => void): Object;
-
- /**
- * Removes the contents of this router's outlet and all descendant outlets
- */
- deactivate(instruction: Instruction): Promise<any>;
-
- /**
- * Given a URL, returns an instruction representing the component graph
- */
- recognize(url: string): Promise<Instruction>;
-
- /**
- * Navigates to either the last URL successfully navigated to, or the last URL requested if the
- * router has yet to successfully navigate.
- */
- renavigate(): Promise<any>;
-
- /**
- * Generate a URL from a component name and optional map of parameters. The URL is relative to the
- * app's base href.
- */
- generate(linkParams: any[]): Instruction;
-
- }
-
-
- /**
- * A router outlet is a placeholder that Angular dynamically fills based on the application's route.
- *
- * ## Use
- *
- * ```
- * <router-outlet></router-outlet>
- * ```
- */
- interface RouterOutlet {
-
- name: string;
-
- /**
- * Called by the Router to instantiate a new component during the commit phase of a navigation.
- * This method in turn is responsible for calling the `onActivate` hook of its child.
- */
- activate(nextInstruction: ComponentInstruction): Promise<any>;
-
- /**
- * Called by the {@link Router} during the commit phase of a navigation when an outlet
- * reuses a component between different routes.
- * This method in turn is responsible for calling the `onReuse` hook of its child.
- */
- reuse(nextInstruction: ComponentInstruction): Promise<any>;
-
- /**
- * Called by the {@link Router} when an outlet reuses a component across navigations.
- * This method in turn is responsible for calling the `onReuse` hook of its child.
- */
- deactivate(nextInstruction: ComponentInstruction): Promise<any>;
-
- /**
- * Called by the {@link Router} during recognition phase of a navigation.
- *
- * If this resolves to `false`, the given navigation is cancelled.
- *
- * This method delegates to the child component's `canDeactivate` hook if it exists,
- * and otherwise resolves to true.
- */
- canDeactivate(nextInstruction: ComponentInstruction): Promise<boolean>;
-
- /**
- * Called by the {@link Router} during recognition phase of a navigation.
- *
- * If the new child component has a different ng.Type than the existing child component,
- * this will resolve to `false`. You can't reuse an old component when the new component
- * is of a different ng.Type.
- *
- * Otherwise, this method delegates to the child component's `canReuse` hook if it exists,
- * or resolves to true if the hook is not present.
- */
- canReuse(nextInstruction: ComponentInstruction): Promise<boolean>;
-
- }
-
-
- /**
- * The RouterLink directive lets you link to specific parts of your app.
- *
- * Consider the following route configuration:
- *
- * ```
- * @RouteConfig([
- * { path: '/user', component: UserCmp, as: 'user' }
- * ]);
- * class MyComp {}
- * ```
- *
- * When linking to this `user` route, you can write:
- *
- * ```
- * <a [router-link]="['./user']">link to user component</a>
- * ```
- *
- * RouterLink expects the value to be an array of route names, followed by the params
- * for that level of routing. For instance `['/team', {teamId: 1}, 'user', {userId: 2}]`
- * means that we want to generate a link for the `team` route with params `{teamId: 1}`,
- * and with a child route `user` with params `{userId: 2}`.
- *
- * The first route name should be prepended with `/`, `./`, or `../`.
- * If the route begins with `/`, the router will look up the route from the root of the app.
- * If the route begins with `./`, the router will instead look in the current component's
- * children for the route. And if the route begins with `../`, the router will look at the
- * current component's parent.
- */
- class RouterLink {
-
- constructor(_router: Router, _location: Location);
-
- visibleHref: string;
-
- isRouteActive: boolean;
-
- routeParams: any;
-
- onClick(): boolean;
-
- }
-
-
- /**
- * `RouteParams` is an immutable map of parameters for the given route
- * based on the url matcher and optional parameters for that route.
- *
- * You can inject `RouteParams` into the constructor of a component to use it.
- *
- * ## Example
- *
- * ```
- * import {bootstrap, Component, View} from 'angular2/angular2';
- * import {Router, ROUTER_DIRECTIVES, routerBindings, RouteConfig} from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {path: '/user/:id', component: UserCmp, as: 'UserCmp'},
- * ])
- * class AppCmp {}
- *
- * @Component({...})
- * @View({ template: 'user: {{id}}' })
- * class UserCmp {
- * string: id;
- * constructor(params: RouteParams) {
- * this.id = params.get('id');
- * }
- * }
- *
- * bootstrap(AppCmp, routerBindings(AppCmp));
- * ```
- */
- class RouteParams {
-
- constructor(params: {[key: string]: string});
-
- params: {[key: string]: string};
-
- get(param: string): string;
-
- }
-
-
- /**
- * The RouteRegistry holds route configurations for each component in an Angular app.
- * It is responsible for creating Instructions from URLs, and generating URLs based on route and
- * parameters.
- */
- class RouteRegistry {
-
- /**
- * Given a component and a configuration object, add the route to this registry
- */
- config(parentComponent: any, config: RouteDefinition): void;
-
- /**
- * Reads the annotations of a component and configures the registry based on them
- */
- configFromComponent(component: any): void;
-
- /**
- * Given a URL and a parent component, return the most specific instruction for navigating
- * the application into the state specified by the url
- */
- recognize(url: string, parentComponent: any): Promise<Instruction>;
-
- /**
- * Given a normalized list with component names and params like: `['user', {id: 3 }]`
- * generates a url with a leading slash relative to the provided `parentComponent`.
- */
- generate(linkParams: any[], parentComponent: any): Instruction;
-
- }
-
-
- /**
- * `LocationStrategy` is responsible for representing and reading route state
- * from the the browser's URL. Angular provides two strategies:
- * {@link HashLocationStrategy} (default) and {@link PathLocationStrategy}.
- *
- * This is used under the hood of the {@link Location} service.
- *
- * Applications should use the {@link Router} or {@link Location} services to
- * interact with application route state.
- *
- * For instance, {@link HashLocationStrategy} produces URLs like
- * `http://example.com#/foo`, and {@link PathLocationStrategy} produces
- * `http://example.com/foo` as an equivalent URL.
- *
- * See these two classes for more.
- */
- class LocationStrategy {
-
- path(): string;
-
- pushState(ctx: any, title: string, url: string): void;
-
- forward(): void;
-
- back(): void;
-
- onPopState(fn: (_: any) => any): void;
-
- getBaseHref(): string;
-
- }
-
-
- /**
- * `HashLocationStrategy` is a {@link LocationStrategy} used to configure the
- * {@link Location} service to represent its state in the
- * [hash fragment](https://en.wikipedia.org/wiki/Uniform_Resource_Locator#Syntax)
- * of the browser's URL.
- *
- * `HashLocationStrategy` is the default binding for {@link LocationStrategy}
- * provided in {@link routerBindings} and {@link ROUTER_BINDINGS}.
- *
- * For instance, if you call `location.go('/foo')`, the browser's URL will become
- * `example.com#/foo`.
- *
- * ## Example
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {
- * ROUTER_DIRECTIVES,
- * routerBindings,
- * RouteConfig,
- * Location
- * } from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * constructor(location: Location) {
- * location.go('/foo');
- * }
- * }
- *
- * bootstrap(AppCmp, [
- * routerBindings(AppCmp) // includes binding to HashLocationStrategy
- * ]);
- * ```
- */
- class HashLocationStrategy extends LocationStrategy {
-
- constructor();
-
- onPopState(fn: EventListener): void;
-
- getBaseHref(): string;
-
- path(): string;
-
- pushState(state: any, title: string, url: string): void;
-
- forward(): void;
-
- back(): void;
-
- }
-
-
- /**
- * `PathLocationStrategy` is a {@link LocationStrategy} used to configure the
- * {@link Location} service to represent its state in the
- * [path](https://en.wikipedia.org/wiki/Uniform_Resource_Locator#Syntax) of the
- * browser's URL.
- *
- * If you're using `PathLocationStrategy`, you must provide a binding for
- * {@link APP_BASE_HREF} to a string representing the URL prefix that should
- * be preserved when generating and recognizing URLs.
- *
- * For instance, if you provide an `APP_BASE_HREF` of `'/my/app'` and call
- * `location.go('/foo')`, the browser's URL will become
- * `example.com/my/app/foo`.
- *
- * ## Example
- *
- * ```
- * import {Component, View, bind} from 'angular2/angular2';
- * import {
- * APP_BASE_HREF
- * ROUTER_DIRECTIVES,
- * routerBindings,
- * RouteConfig,
- * Location,
- * LocationStrategy,
- * PathLocationStrategy
- * } from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * constructor(location: Location) {
- * location.go('/foo');
- * }
- * }
- *
- * bootstrap(AppCmp, [
- * routerBindings(AppCmp),
- * bind(LocationStrategy).toClass(PathLocationStrategy),
- * bind(APP_BASE_HREF).toValue('/my/app')
- * ]);
- * ```
- */
- class PathLocationStrategy extends LocationStrategy {
-
- constructor();
-
- onPopState(fn: EventListener): void;
-
- getBaseHref(): string;
-
- path(): string;
-
- pushState(state: any, title: string, url: string): void;
-
- forward(): void;
-
- back(): void;
-
- }
-
-
- /**
- * `Location` is a service that applications can use to interact with a browser's URL.
- * Depending on which {@link LocationStrategy} is used, `Location` will either persist
- * to the URL's path or the URL's hash segment.
- *
- * Note: it's better to use {@link Router#navigate} service to trigger route changes. Use
- * `Location` only if you need to interact with or create normalized URLs outside of
- * routing.
- *
- * `Location` is responsible for normalizing the URL against the application's base href.
- * A normalized URL is absolute from the URL host, includes the application's base href, and has no
- * trailing slash:
- * - `/my/app/user/123` is normalized
- * - `my/app/user/123` **is not** normalized
- * - `/my/app/user/123/` **is not** normalized
- *
- * ## Example
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {
- * ROUTER_DIRECTIVES,
- * routerBindings,
- * RouteConfig,
- * Location
- * } from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * constructor(location: Location) {
- * location.go('/foo');
- * }
- * }
- *
- * bootstrap(AppCmp, [routerBindings(AppCmp)]);
- * ```
- */
- class Location {
-
- constructor(platformStrategy: LocationStrategy, href?: string);
-
- platformStrategy: LocationStrategy;
-
- /**
- * Returns the normalized URL path.
- */
- path(): string;
-
- /**
- * Given a string representing a URL, returns the normalized URL path.
- */
- normalize(url: string): string;
-
- /**
- * Given a string representing a URL, returns the normalized URL path.
- * If the given URL doesn't begin with a leading slash (`'/'`), this method adds one
- * before normalizing.
- */
- normalizeAbsolutely(url: string): string;
-
- /**
- * Changes the browsers URL to the normalized version of the given URL, and pushes a
- * new item onto the platform's history.
- */
- go(url: string): void;
-
- /**
- * Navigates forward in the platform's history.
- */
- forward(): void;
-
- /**
- * Navigates back in the platform's history.
- */
- back(): void;
-
- /**
- * Subscribe to the platform's `popState` events.
- */
- subscribe(onNext: (value: any) => void, onThrow?: (exception: any) => void, onReturn?: () => void): void;
-
- }
-
-
- /**
- * The `APP_BASE_HREF` token represents the base href to be used with the
- * {@link PathLocationStrategy}.
- *
- * If you're using {@link PathLocationStrategy}, you must provide a binding to a string
- * representing the URL prefix that should be preserved when generating and recognizing
- * URLs.
- *
- * ## Example
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {ROUTER_DIRECTIVES, routerBindings, RouteConfig} from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * // ...
- * }
- *
- * bootstrap(AppCmp, [
- * routerBindings(AppCmp),
- * PathLocationStrategy,
- * bind(APP_BASE_HREF).toValue('/my/app')
- * ]);
- * ```
- */
- let APP_BASE_HREF: OpaqueToken;
-
-
-
- /**
- * Defines route lifecycle method `onActivate`, which is called by the router at the end of a
- * successful route navigation.
- *
- * For a single component's navigation, only one of either {@link OnActivate} or {@link OnReuse}
- * will be called depending on the result of {@link CanReuse}.
- *
- * The `onActivate` hook is called with two {@link ComponentInstruction}s as parameters, the first
- * representing the current route being navigated to, and the second parameter representing the
- * previous route or `null`.
- *
- * If `onActivate` returns a promise, the route change will wait until the promise settles to
- * instantiate and activate child components.
- *
- * ## Example
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {OnActivate, ComponentInstruction} from 'angular2/router';
- *
- * @Component({
- * selector: 'my-cmp'
- * })
- * @View({
- * template: '<div>hello!</div>'
- * })
- * class MyCmp implements OnActivate {
- * onActivate(next: ComponentInstruction, prev: ComponentInstruction) {
- * this.log = 'Finished navigating from ' + prev.urlPath + ' to ' + next.urlPath;
- * }
- * }
- * ```
- */
- interface OnActivate {
-
- onActivate(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction): any;
-
- }
-
-
- /**
- * Defines route lifecycle method `onDeactivate`, which is called by the router before destroying
- * a component as part of a route change.
- *
- * The `onDeactivate` hook is called with two {@link ComponentInstruction}s as parameters, the first
- * representing the current route being navigated to, and the second parameter representing the
- * previous route.
- *
- * If `onDeactivate` returns a promise, the route change will wait until the promise settles.
- *
- * ## Example
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {OnDeactivate, ComponentInstruction} from 'angular2/router';
- *
- * @Component({
- * selector: 'my-cmp'
- * })
- * @View({
- * template: '<div>hello!</div>'
- * })
- * class MyCmp implements OnDeactivate {
- * onDeactivate(next: ComponentInstruction, prev: ComponentInstruction) {
- * return this.doFadeAwayAnimation();
- * }
- * }
- * ```
- */
- interface OnDeactivate {
-
- onDeactivate(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction): any;
-
- }
-
-
- /**
- * Defines route lifecycle method `onReuse`, which is called by the router at the end of a
- * successful route navigation when {@link CanReuse} is implemented and returns or resolves to true.
- *
- * For a single component's navigation, only one of either {@link OnActivate} or {@link OnReuse}
- * will be called, depending on the result of {@link CanReuse}.
- *
- * The `onReuse` hook is called with two {@link ComponentInstruction}s as parameters, the first
- * representing the current route being navigated to, and the second parameter representing the
- * previous route or `null`.
- *
- * ## Example
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {CanReuse, OnReuse, ComponentInstruction} from 'angular2/router';
- *
- * @Component({
- * selector: 'my-cmp'
- * })
- * @View({
- * template: '<div>hello!</div>'
- * })
- * class MyCmp implements CanReuse, OnReuse {
- * canReuse(next: ComponentInstruction, prev: ComponentInstruction) {
- * return true;
- * }
- *
- * onReuse(next: ComponentInstruction, prev: ComponentInstruction) {
- * this.params = next.params;
- * }
- * }
- * ```
- */
- interface OnReuse {
-
- onReuse(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction): any;
-
- }
-
-
- /**
- * Defines route lifecycle method `canDeactivate`, which is called by the router to determine
- * if a component can be removed as part of a navigation.
- *
- * The `canDeactivate` hook is called with two {@link ComponentInstruction}s as parameters, the
- * first representing the current route being navigated to, and the second parameter
- * representing the previous route.
- *
- * If `canDeactivate` returns or resolves to `false`, the navigation is cancelled. If it returns or
- * resolves to `true`, then the navigation continues, and the component will be deactivated
- * (the {@link OnDeactivate} hook will be run) and removed.
- *
- * If `canDeactivate` throws or rejects, the navigation is also cancelled.
- *
- * ## Example
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {CanDeactivate, ComponentInstruction} from 'angular2/router';
- *
- * @Component({
- * selector: 'my-cmp'
- * })
- * @View({
- * template: '<div>hello!</div>'
- * })
- * class MyCmp implements CanDeactivate {
- * canDeactivate(next: ComponentInstruction, prev: ComponentInstruction) {
- * return askUserIfTheyAreSureTheyWantToQuit();
- * }
- * }
- * ```
- */
- interface CanDeactivate {
-
- canDeactivate(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction): any;
-
- }
-
-
- /**
- * Defines route lifecycle method `canReuse`, which is called by the router to determine whether a
- * component should be reused across routes, or whether to destroy and instantiate a new component.
- *
- * The `canReuse` hook is called with two {@link ComponentInstruction}s as parameters, the first
- * representing the current route being navigated to, and the second parameter representing the
- * previous route.
- *
- * If `canReuse` returns or resolves to `true`, the component instance will be reused and the
- * {@link OnDeactivate} hook will be run. If `canReuse` returns or resolves to `false`, a new
- * component will be instantiated, and the existing component will be deactivated and removed as
- * part of the navigation.
- *
- * If `canReuse` throws or rejects, the navigation will be cancelled.
- *
- * ## Example
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {CanReuse, OnReuse, ComponentInstruction} from 'angular2/router';
- *
- * @Component({
- * selector: 'my-cmp'
- * })
- * @View({
- * template: '<div>hello!</div>'
- * })
- * class MyCmp implements CanReuse, OnReuse {
- * canReuse(next: ComponentInstruction, prev: ComponentInstruction) {
- * return next.params.id == prev.params.id;
- * }
- *
- * onReuse(next: ComponentInstruction, prev: ComponentInstruction) {
- * this.id = next.params.id;
- * }
- * }
- * ```
- */
- interface CanReuse {
-
- canReuse(nextInstruction: ComponentInstruction, prevInstruction: ComponentInstruction): any;
-
- }
-
-
- /**
- * Defines route lifecycle hook `CanActivate`, which is called by the router to determine
- * if a component can be instantiated as part of a navigation.
- *
- * The `CanActivate` hook is called with two {@link ComponentInstruction}s as parameters, the first
- * representing
- * the current route being navigated to, and the second parameter representing the previous route or
- * `null`.
- *
- * Note that unlike other lifecycle hooks, this one uses an annotation rather than an interface.
- * This is because the `CanActivate` function is called before the component is instantiated.
- *
- * If `CanActivate` returns or resolves to `false`, the navigation is cancelled.
- * If `CanActivate` throws or rejects, the navigation is also cancelled.
- * If `CanActivate` returns or resolves to `true`, navigation continues, the component is
- * instantiated, and the {@link OnActivate} hook of that component is called if implemented.
- *
- * ## Example
- * ```
- * import {Component} from 'angular2/angular2';
- * import {CanActivate} from 'angular2/router';
- *
- * @Component({
- * selector: 'control-panel-cmp'
- * })
- * @View({
- * template: '<div>Control Panel: ...</div>'
- * })
- * @CanActivate(() => checkIfUserIsLoggedIn())
- * class ControlPanelCmp {
- * // ...
- * }
- * ```
- */
- var CanActivate: (hook: (next: ComponentInstruction, prev: ComponentInstruction) => Promise<boolean>| boolean) =>
- ClassDecorator;
-
-
-
- /**
- * `Instruction` is a tree of {@link ComponentInstruction}s with all the information needed
- * to transition each component in the app to a given route, including all auxiliary routes.
- *
- * `Instruction`s can be created using {@link Router#generate}, and can be used to
- * perform route changes with {@link Router#navigateByInstruction}.
- *
- * ## Example
- *
- * ```
- * import {bootstrap, Component, View} from 'angular2/angular2';
- * import {Router, ROUTER_DIRECTIVES, routerBindings, RouteConfig} from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * constructor(router: Router) {
- * var instruction = router.generate(['/MyRoute']);
- * router.navigateByInstruction(instruction);
- * }
- * }
- *
- * bootstrap(AppCmp, routerBindings(AppCmp));
- * ```
- */
- class Instruction {
-
- constructor(component: ComponentInstruction, child: Instruction, auxInstruction: {[key: string]: Instruction});
-
- component: ComponentInstruction;
-
- child: Instruction;
-
- auxInstruction: {[key: string]: Instruction};
-
- /**
- * Returns a new instruction that shares the state of the existing instruction, but with
- * the given child {@link Instruction} replacing the existing child.
- */
- replaceChild(child: Instruction): Instruction;
-
- }
-
-
- /**
- * A `ComponentInstruction` represents the route state for a single component. An `Instruction` is
- * composed of a tree of these `ComponentInstruction`s.
- *
- * `ComponentInstructions` is a public API. Instances of `ComponentInstruction` are passed
- * to route lifecycle hooks, like {@link CanActivate}.
- *
- * `ComponentInstruction`s are [https://en.wikipedia.org/wiki/Hash_consing](hash consed). You should
- * never construct one yourself with "new." Instead, rely on {@link Router/PathRecognizer} to
- * construct `ComponentInstruction`s.
- *
- * You should not modify this object. It should be treated as immutable.
- */
- interface ComponentInstruction {
-
- reuse: boolean;
-
- urlPath: string;
-
- urlParams: string[];
-
- params: {[key: string]: any};
-
- /**
- * Returns the component type of the represented route, or `null` if this instruction
- * hasn't been resolved.
- */
- componentType: any;
-
- /**
- * Returns a promise that will resolve to component type of the represented route.
- * If this instruction references an {@link AsyncRoute}, the `loader` function of that route
- * will run.
- */
- resolveComponentType(): Promise<ng.Type>;
-
- /**
- * Returns the specificity of the route associated with this `Instruction`.
- */
- specificity: any;
-
- /**
- * Returns `true` if the component type of this instruction has no child {@link RouteConfig},
- * or `false` if it does.
- */
- terminal: any;
-
- /**
- * Returns the route data of the given route that was specified in the {@link RouteDefinition},
- * or `null` if no route data was specified.
- */
- routeData(): Object;
-
- }
-
-
- /**
- * Creates a token that can be used in a DI Binding.
- *
- * ### Example ([live demo](http://plnkr.co/edit/Ys9ezXpj2Mnoy3Uc8KBp?p=preview))
- *
- * ```typescript
- * var t = new OpaqueToken("binding");
- *
- * var injector = Injector.resolveAndCreate([
- * bind(t).toValue("bindingValue")
- * ]);
- *
- * expect(injector.get(t)).toEqual("bindingValue");
- * ```
- *
- * Using an `OpaqueToken` is preferable to using strings as tokens because of possible collisions
- * caused by multiple bindings using the same string as two different tokens.
- *
- * Using an `OpaqueToken` is preferable to using an `Object` as tokens because it provides better
- * error messages.
- */
- class OpaqueToken {
-
- constructor(_desc: string);
-
- toString(): string;
-
- }
-
-
- let ROUTE_DATA: OpaqueToken;
-
-
-
- /**
- * Token used to bind the component with the top-level {@link RouteConfig}s for the
- * application.
- *
- * You can use the {@link routerBindings} function in your {@link bootstrap} bindings to
- * simplify setting up these bindings.
- *
- * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {
- * ROUTER_DIRECTIVES,
- * ROUTER_BINDINGS,
- * ROUTER_PRIMARY_COMPONENT,
- * RouteConfig
- * } from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * // ...
- * }
- *
- * bootstrap(AppCmp, [
- * ROUTER_BINDINGS,
- * bind(ROUTER_PRIMARY_COMPONENT).toValue(AppCmp)
- * ]);
- * ```
- */
- let ROUTER_PRIMARY_COMPONENT: OpaqueToken;
-
-
-
- /**
- * A list of directives. To use the router directives like {@link RouterOutlet} and
- * {@link RouterLink}, add this to your `directives` array in the {@link View} decorator of your
- * component.
- *
- * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {ROUTER_DIRECTIVES, routerBindings, RouteConfig} from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * // ...
- * }
- *
- * bootstrap(AppCmp, [routerBindings(AppCmp)]);
- * ```
- */
- let ROUTER_DIRECTIVES: any[];
-
-
-
- /**
- * A list of {@link Binding}s. To use the router, you must add this to your application.
- *
- * Note that you also need to bind to {@link ROUTER_PRIMARY_COMPONENT}.
- *
- * You can use the {@link routerBindings} function in your {@link bootstrap} bindings to
- * simplify setting up these bindings.
- *
- * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {
- * ROUTER_DIRECTIVES,
- * ROUTER_BINDINGS,
- * ROUTER_PRIMARY_COMPONENT,
- * RouteConfig
- * } from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * // ...
- * }
- *
- * bootstrap(AppCmp, [
- * ROUTER_BINDINGS,
- * bind(ROUTER_PRIMARY_COMPONENT).toValue(AppCmp)
- * ]);
- * ```
- */
- let ROUTER_BINDINGS: any[];
-
-
-
- /**
- * A list of {@link Binding}s. To use the router, you must add these bindings to
- * your application.
- *
- * ## Example ([live demo](http://plnkr.co/edit/iRUP8B5OUbxCWQ3AcIDm))
- *
- * ```
- * import {Component, View} from 'angular2/angular2';
- * import {ROUTER_DIRECTIVES, routerBindings, RouteConfig} from 'angular2/router';
- *
- * @Component({...})
- * @View({directives: [ROUTER_DIRECTIVES]})
- * @RouteConfig([
- * {...},
- * ])
- * class AppCmp {
- * // ...
- * }
- *
- * bootstrap(AppCmp, [routerBindings(AppCmp)]);
- * ```
- */
- function routerBindings(primaryComponent: ng.Type): Array<any>;
-
-
-
- /**
- * `Route` is a type of {@link RouteDefinition} used to route a path to a component.
- *
- * It has the following properties:
- * - `path` is a string that uses the route matcher DSL.
- * - `component` a component type.
- * - `as` is an optional `CamelCase` string representing the name of the route.
- * - `data` is an optional property of any type representing arbitrary route metadata for the given
- * route. It is injectable via the {@link ROUTE_DATA} token.
- *
- * ## Example
- * ```
- * import {RouteConfig} from 'angular2/router';
- *
- * @RouteConfig([
- * {path: '/home', component: HomeCmp, as: 'HomeCmp' }
- * ])
- * class MyApp {}
- * ```
- */
- class Route implements RouteDefinition {
-
- constructor({path, component, as, data}:
- {path: string, component: ng.Type, as?: string, data?: any});
-
- data: any;
-
- path: string;
-
- component: ng.Type;
-
- as: string;
-
- loader: Function;
-
- redirectTo: string;
-
- }
-
-
- /**
- * `Redirect` is a type of {@link RouteDefinition} used to route a path to an asynchronously loaded
- * component.
- *
- * It has the following properties:
- * - `path` is a string that uses the route matcher DSL.
- * - `redirectTo` is a string representing the new URL to be matched against.
- *
- * ## Example
- * ```
- * import {RouteConfig} from 'angular2/router';
- *
- * @RouteConfig([
- * {path: '/', redirectTo: '/home'},
- * {path: '/home', component: HomeCmp}
- * ])
- * class MyApp {}
- * ```
- */
- class Redirect implements RouteDefinition {
-
- constructor({path, redirectTo}: {path: string, redirectTo: string});
-
- path: string;
-
- redirectTo: string;
-
- as: string;
-
- loader: Function;
-
- data: any;
-
- }
-
-
- /**
- * `AuxRoute` is a type of {@link RouteDefinition} used to define an auxiliary route.
- *
- * It takes an object with the following properties:
- * - `path` is a string that uses the route matcher DSL.
- * - `component` a component type.
- * - `as` is an optional `CamelCase` string representing the name of the route.
- * - `data` is an optional property of any type representing arbitrary route metadata for the given
- * route. It is injectable via the {@link ROUTE_DATA} token.
- *
- * ## Example
- * ```
- * import {RouteConfig, AuxRoute} from 'angular2/router';
- *
- * @RouteConfig([
- * new AuxRoute({path: '/home', component: HomeCmp})
- * ])
- * class MyApp {}
- * ```
- */
- class AuxRoute implements RouteDefinition {
-
- constructor({path, component, as}: {path: string, component: ng.Type, as?: string});
-
- data: any;
-
- path: string;
-
- component: ng.Type;
-
- as: string;
-
- loader: Function;
-
- redirectTo: string;
-
- }
-
-
- /**
- * `AsyncRoute` is a type of {@link RouteDefinition} used to route a path to an asynchronously
- * loaded component.
- *
- * It has the following properties:
- * - `path` is a string that uses the route matcher DSL.
- * - `loader` is a function that returns a promise that resolves to a component.
- * - `as` is an optional `CamelCase` string representing the name of the route.
- * - `data` is an optional property of any type representing arbitrary route metadata for the given
- * route. It is injectable via the {@link ROUTE_DATA} token.
- *
- * ## Example
- * ```
- * import {RouteConfig} from 'angular2/router';
- *
- * @RouteConfig([
- * {path: '/home', loader: () => Promise.resolve(MyLoadedCmp), as: 'MyLoadedCmp'}
- * ])
- * class MyApp {}
- * ```
- */
- class AsyncRoute implements RouteDefinition {
-
- constructor({path, loader, as, data}: {path: string, loader: Function, as?: string, data?: any});
-
- data: any;
-
- path: string;
-
- loader: Function;
-
- as: string;
-
- }
-
-
- /**
- * `RouteDefinition` defines a route within a {@link RouteConfig} decorator.
- *
- * Supported keys:
- * - `path` (required)
- * - `component`, `loader`, `redirectTo` (requires exactly one of these)
- * - `as` (optional)
- * - `data` (optional)
- *
- * See also {@link Route}, {@link AsyncRoute}, {@link AuxRoute}, and {@link Redirect}.
- */
- interface RouteDefinition {
-
- path: string;
-
- component?: ng.Type | ComponentDefinition;
-
- loader?: Function;
-
- redirectTo?: string;
-
- as?: string;
-
- data?: any;
-
- }
-
-
- var RouteConfig: (configs: RouteDefinition[]) => ClassDecorator;
-
-
-
- interface ComponentDefinition {
-
- type: string;
-
- loader?: Function;
-
- component?: ng.Type;
-
- }
-
-
- var RouterOutlet: ng.InjectableReference;
-
-
-
- var ComponentInstruction: ng.InjectableReference;
-
-
-
-}
-
-declare module "angular2/router" {
- export = ngRouter;
-}
-
-
diff --git a/angular2/test_lib.d.ts b/angular2/test_lib.d.ts
deleted file mode 100644
index ccd64b21b..000000000
--- a/angular2/test_lib.d.ts
+++ /dev/null
@@ -1,408 +0,0 @@
-// Type definitions for Angular v2.0.0-local_sha.7d5c3eb
-// Project: http://angular.io/
-// Definitions by: angular team <https://github.com/angular/>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-// ***********************************************************
-// This file is generated by the Angular build process.
-// Please do not create manual edits or send pull requests
-// modifying this file.
-// ***********************************************************
-
-// angular2/test_lib depends transitively on these libraries.
-// If you don't have them installed you can install them using TSD
-// https://github.com/DefinitelyTyped/tsd
-
-///<reference path="./angular2.d.ts"/>
-///<reference path="../jasmine/jasmine.d.ts"/>
-
-
-
-declare module ngTestLib {
- /**
- * Allows injecting dependencies in `beforeEach()` and `it()`.
- *
- * Example:
- *
- * ```
- * beforeEach(inject([Dependency, AClass], (dep, object) => {
- * // some code that uses `dep` and `object`
- * // ...
- * }));
- *
- * it('...', inject([AClass, AsyncTestCompleter], (object, async) => {
- * object.doSomething().then(() => {
- * expect(...);
- * async.done();
- * });
- * })
- * ```
- *
- * Notes:
- * - injecting an `AsyncTestCompleter` allow completing async tests - this is the equivalent of
- * adding a `done` parameter in Jasmine,
- * - inject is currently a function because of some Traceur limitation the syntax should eventually
- * becomes `it('...', @Inject (object: AClass, async: AsyncTestCompleter) => { ... });`
- *
- * @param {Array} tokens
- * @param {Function} fn
- * @return {FunctionWithParamTokens}
- */
- function inject(tokens: any[], fn: Function): FunctionWithParamTokens;
-
-
-
- var proxy: ClassDecorator;
-
-
-
- var afterEach: Function;
-
-
-
- type SyncTestFn = () => void
-
-
- interface NgMatchers extends jasmine.Matchers {
-
- toBe(expected: any): boolean;
-
- toEqual(expected: any): boolean;
-
- toBePromise(): boolean;
-
- toBeAnInstanceOf(expected: any): boolean;
-
- toHaveText(expected: any): boolean;
-
- toHaveCssClass(expected: any): boolean;
-
- toImplement(expected: any): boolean;
-
- toContainError(expected: any): boolean;
-
- toThrowErrorWith(expectedMessage: any): boolean;
-
- not: NgMatchers;
-
- }
-
-
- var expect: (actual: any) => NgMatchers;
-
-
-
- class AsyncTestCompleter {
-
- constructor(_done: Function);
-
- done(): void;
-
- }
-
-
- function describe(...args: any[]): void;
-
-
-
- function ddescribe(...args: any[]): void;
-
-
-
- function xdescribe(...args: any[]): void;
-
-
-
- function beforeEach(fn: FunctionWithParamTokens | SyncTestFn): void;
-
-
-
- /**
- * Allows overriding default bindings defined in test_injector.js.
- *
- * The given function must return a list of DI bindings.
- *
- * Example:
- *
- * beforeEachBindings(() => [
- * bind(Compiler).toClass(MockCompiler),
- * bind(SomeToken).toValue(myValue),
- * ]);
- */
- function beforeEachBindings(fn: any): void;
-
-
-
- function it(name: any, fn: any, timeOut?: any): void;
-
-
-
- function xit(name: any, fn: any, timeOut?: any): void;
-
-
-
- function iit(name: any, fn: any, timeOut?: any): void;
-
-
-
- interface GuinessCompatibleSpy extends jasmine.Spy {
-
- /**
- * By chaining the spy with and.returnValue, all calls to the function will return a specific
- * value.
- */
- andReturn(val: any): void;
-
- /**
- * By chaining the spy with and.callFake, all calls to the spy will delegate to the supplied
- * function.
- */
- andCallFake(fn: Function): GuinessCompatibleSpy;
-
- /**
- * removes all recorded calls
- */
- reset(): void;
-
- }
-
-
- class SpyObject {
-
- constructor(type?: any);
-
- static stub(object?: any, config?: any, overrides?: any): void;
-
- noSuchMethod(args: any): void;
-
- spy(name: any): void;
-
- prop(name: any, value: any): void;
-
- }
-
-
- function isInInnerZone(): boolean;
-
-
-
- interface RootTestComponent {
-
- debugElement: ng.DebugElement;
-
- detectChanges(): void;
-
- destroy(): void;
-
- }
-
-
- /**
- * Builds a RootTestComponent for use in component level tests.
- */
- class TestComponentBuilder {
-
- constructor(_injector: ng.Injector);
-
- /**
- * Overrides only the html of a {@link ComponentMetadata}.
- * All the other properties of the component's {@link ng.ViewMetadata} are preserved.
- *
- * @param {ng.Type} component
- * @param {string} html
- *
- * @return {TestComponentBuilder}
- */
- overrideTemplate(componentType: ng.Type, template: string): TestComponentBuilder;
-
- /**
- * Overrides a component's {@link ng.ViewMetadata}.
- *
- * @param {ng.Type} component
- * @param {view} View
- *
- * @return {TestComponentBuilder}
- */
- overrideView(componentType: ng.Type, view: ng.ViewMetadata): TestComponentBuilder;
-
- /**
- * Overrides the directives from the component {@link ng.ViewMetadata}.
- *
- * @param {ng.Type} component
- * @param {ng.Type} from
- * @param {ng.Type} to
- *
- * @return {TestComponentBuilder}
- */
- overrideDirective(componentType: ng.Type, from: ng.Type, to: ng.Type): TestComponentBuilder;
-
- /**
- * Overrides one or more injectables configured via `bindings` metadata property of a directive or
- * component.
- * Very useful when certain bindings need to be mocked out.
- *
- * The bindings specified via this method are appended to the existing `bindings` causing the
- * duplicated bindings to
- * be overridden.
- *
- * @param {ng.Type} component
- * @param {any[]} bindings
- *
- * @return {TestComponentBuilder}
- */
- overrideBindings(type: ng.Type, bindings: any[]): TestComponentBuilder;
-
- /**
- * Overrides one or more injectables configured via `bindings` metadata property of a directive or
- * component.
- * Very useful when certain bindings need to be mocked out.
- *
- * The bindings specified via this method are appended to the existing `bindings` causing the
- * duplicated bindings to
- * be overridden.
- *
- * @param {ng.Type} component
- * @param {any[]} bindings
- *
- * @return {TestComponentBuilder}
- */
- overrideViewBindings(type: ng.Type, bindings: any[]): TestComponentBuilder;
-
- /**
- * Builds and returns a RootTestComponent.
- *
- * @return {Promise<RootTestComponent>}
- */
- createAsync(rootComponentType: ng.Type): Promise<RootTestComponent>;
-
- }
-
-
- function createTestInjector(bindings: Array<ng.Type | ng.Binding | any[]>): ng.Injector;
-
-
-
- class FunctionWithParamTokens {
-
- constructor(_tokens: any[], _fn: Function);
-
- /**
- * Returns the value of the executed function.
- */
- execute(injector: ng.Injector): any;
-
- hasToken(token: any): boolean;
-
- }
-
-
- /**
- * Wraps a function to be executed in the fakeAsync zone:
- * - microtasks are manually executed by calling `flushMicrotasks()`,
- * - timers are synchronous, `tick()` simulates the asynchronous passage of time.
- *
- * If there are any pending timers at the end of the function, an exception will be thrown.
- *
- * @param fn
- * @returns {Function} The function wrapped to be executed in the fakeAsync zone
- */
- function fakeAsync(fn: Function): Function;
-
-
-
- function clearPendingTimers(): void;
-
-
-
- /**
- * Simulates the asynchronous passage of time for the timers in the fakeAsync zone.
- *
- * The microtasks queue is drained at the very start of this function and after any timer callback
- * has been executed.
- *
- * @param {number} millis Number of millisecond, defaults to 0
- */
- function tick(millis?: number): void;
-
-
-
- /**
- * Flush any pending microtasks.
- */
- function flushMicrotasks(): void;
-
-
-
- class Log {
-
- constructor();
-
- add(value: any): void;
-
- fn(value: any): void;
-
- clear(): void;
-
- result(): string;
-
- }
-
-
- class BrowserDetection {
-
- constructor(ua: string);
-
- isFirefox: boolean;
-
- isAndroid: boolean;
-
- isEdge: boolean;
-
- isIE: boolean;
-
- isWebkit: boolean;
-
- isIOS7: boolean;
-
- isSlow: boolean;
-
- supportsIntlApi: boolean;
-
- }
-
-
- var browserDetection: BrowserDetection;
-
-
-
- function dispatchEvent(element: any, eventType: any): void;
-
-
-
- function el(html: string): HTMLElement;
-
-
-
- function containsRegexp(input: string): RegExp;
-
-
-
- function normalizeCSS(css: string): string;
-
-
-
- function stringifyElement(el: any): string;
-
-
-
- var RootTestComponent: ng.InjectableReference;
-
-
-
-}
-
-declare module "angular2/test_lib" {
- export = ngTestLib;
-}
-
-
diff --git a/async/async.d.ts b/async/async.d.ts
index 6054e9a47..418f5539b 100644
--- a/async/async.d.ts
+++ b/async/async.d.ts
@@ -76,11 +76,11 @@ interface Async {
each<T>(arr: T[], iterator: AsyncIterator<T>, callback?: ErrorCallback): void;
eachSeries<T>(arr: T[], iterator: AsyncIterator<T>, callback?: ErrorCallback): void;
eachLimit<T>(arr: T[], limit: number, iterator: AsyncIterator<T>, callback?: ErrorCallback): void;
- forEachOf(obj: any, iterator: (item: any, key: [string|number], callback?: ErrorCallback) => void, callback: ErrorCallback): void;
+ forEachOf(obj: any, iterator: (item: any, key: string|number, callback?: ErrorCallback) => void, callback: ErrorCallback): void;
forEachOf<T>(obj: T[], iterator: AsyncForEachOfIterator<T>, callback?: ErrorCallback): void;
- forEachOfSeries(obj: any, iterator: (item: any, key: [string|number], callback?: ErrorCallback) => void, callback: ErrorCallback): void;
+ forEachOfSeries(obj: any, iterator: (item: any, key: string|number, callback?: ErrorCallback) => void, callback: ErrorCallback): void;
forEachOfSeries<T>(obj: T[], iterator: AsyncForEachOfIterator<T>, callback?: ErrorCallback): void;
- forEachOfLimit(obj: any, limit: number, iterator: (item: any, key: [string|number], callback?: ErrorCallback) => void, callback: ErrorCallback): void;
+ forEachOfLimit(obj: any, limit: number, iterator: (item: any, key: string|number, callback?: ErrorCallback) => void, callback: ErrorCallback): void;
forEachOfLimit<T>(obj: T[], limit: number, iterator: AsyncForEachOfIterator<T>, callback?: ErrorCallback): void;
map<T, R>(arr: T[], iterator: AsyncResultIterator<T, R>, callback?: AsyncResultArrayCallback<R>): any;
mapSeries<T, R>(arr: T[], iterator: AsyncResultIterator<T, R>, callback?: AsyncResultArrayCallback<R>): any;
diff --git a/benchmark/benchmark-tests.ts b/benchmark/benchmark-tests.ts
new file mode 100644
index 000000000..363e522b0
--- /dev/null
+++ b/benchmark/benchmark-tests.ts
@@ -0,0 +1,237 @@
+/// <reference path="./benchmark.d.ts"/>
+import Benchmark = require("benchmark");
+
+var suite = new Benchmark.Suite;
+
+// add tests
+suite.add('RegExp#test', function() {
+ /o/.test('Hello World!');
+})
+.add('String#indexOf', function() {
+ 'Hello World!'.indexOf('o') > -1;
+})
+.add('String#match', function() {
+ !!'Hello World!'.match(/o/);
+})
+// add listeners
+.on('cycle', function(event: {target: any}) {
+ console.log(String(event.target));
+})
+.on('complete', function() {
+ console.log('Fastest is ' + this.filter('fastest').pluck('name'));
+})
+// run async
+.run({ 'async': true });
+
+var fn: Function;
+var onStart: Function;
+var onCycle: Function;
+var onAbort: Function;
+var onError: Function;
+var onReset: Function;
+var onComplete: Function;
+var setup: Function;
+var teardown: Function;
+var benches: Benchmark[];
+var listener: Function;
+var count: number;
+
+// basic usage (the `new` operator is optional)
+var bench = new Benchmark(fn);
+
+// or using a name first
+var bench = new Benchmark('foo', fn);
+
+// or with options
+var bench = new Benchmark('foo', fn, {
+
+ // displayed by Benchmark#toString if `name` is not available
+ 'id': 'xyz',
+
+ // called when the benchmark starts running
+ 'onStart': onStart,
+
+ // called after each run cycle
+ 'onCycle': onCycle,
+
+ // called when aborted
+ 'onAbort': onAbort,
+
+ // called when a test errors
+ 'onError': onError,
+
+ // called when reset
+ 'onReset': onReset,
+
+ // called when the benchmark completes running
+ 'onComplete': onComplete,
+
+ // compiled/called before the test loop
+ 'setup': setup,
+
+ // compiled/called after the test loop
+ 'teardown': teardown
+});
+
+// or name and options
+var bench = new Benchmark('foo', {
+
+ // a flag to indicate the benchmark is deferred
+ 'defer': true,
+
+ // benchmark test function
+ 'fn': function(deferred: {resolve(): void}) {
+ // call resolve() when the deferred test is finished
+ deferred.resolve();
+ }
+});
+
+// or options only
+var bench = new Benchmark({
+
+ // benchmark name
+ 'name': 'foo',
+
+ // benchmark test as a string
+ 'fn': '[1,2,3,4].sort()'
+});
+
+// a test’s `this` binding is set to the benchmark instance
+var bench = new Benchmark('foo', function() {
+ 'My name is '.concat(this.name); // My name is foo
+});
+
+// get odd numbers
+Benchmark.filter([1, 2, 3, 4, 5], function(n) {
+ return n % 2;
+}); // -> [1, 3, 5];
+
+// get fastest benchmarks
+Benchmark.filter(benches, 'fastest');
+
+// get slowest benchmarks
+Benchmark.filter(benches, 'slowest');
+
+// get benchmarks that completed without erroring
+Benchmark.filter(benches, 'successful');
+
+// invoke `reset` on all benchmarks
+Benchmark.invoke(benches, 'reset');
+
+// invoke `emit` with arguments
+Benchmark.invoke(benches, 'emit', 'complete', listener);
+
+// invoke `run(true)`, treat benchmarks as a queue, and register invoke callbacks
+Benchmark.invoke(benches, {
+
+ // invoke the `run` method
+ 'name': 'run',
+
+ // pass a single argument
+ 'args': true,
+
+ // treat as queue, removing benchmarks from front of `benches` until empty
+ 'queued': true,
+
+ // called before any benchmarks have been invoked.
+ 'onStart': onStart,
+
+ // called between invoking benchmarks
+ 'onCycle': onCycle,
+
+ // called after all benchmarks have been invoked.
+ 'onComplete': onComplete
+});
+
+var element: HTMLElement;
+// basic usage
+var bench = new Benchmark({
+ 'setup': function() {
+ var c = this.count,
+ element = document.getElementById('container');
+ while (c--) {
+ element.appendChild(document.createElement('div'));
+ }
+ },
+ 'fn': function() {
+ element.removeChild(element.lastChild);
+ }
+});
+
+// or using strings
+var bench = new Benchmark({
+ 'setup': '\
+ var a = 0;\n\
+ (function() {\n\
+ (function() {\n\
+ (function() {',
+ 'fn': 'a += 1;',
+ 'teardown': '\
+ }())\n\
+ }())\n\
+ }())'
+});
+
+var bizarro = bench.clone({
+ 'name': 'doppelganger'
+});
+
+// unregister a listener for an event type
+bench.off('cycle', listener);
+
+// unregister a listener for multiple event types
+bench.off('start cycle', listener);
+
+// unregister all listeners for an event type
+bench.off('cycle');
+
+// unregister all listeners for multiple event types
+bench.off('start cycle complete');
+
+// unregister all listeners for all event types
+bench.off();
+
+// register a listener for an event type
+bench.on('cycle', listener);
+
+// register a listener for multiple event types
+bench.on('start cycle', listener);
+
+// basic usage
+bench.run();
+
+// or with options
+bench.run({ 'async': true });
+
+// basic usage
+suite.add(fn);
+
+// or using a name first
+suite.add('foo', fn);
+
+// or with options
+suite.add('foo', fn, {
+ 'onCycle': onCycle,
+ 'onComplete': onComplete
+});
+
+// or name and options
+suite.add('foo', {
+ 'fn': fn,
+ 'onCycle': onCycle,
+ 'onComplete': onComplete
+});
+
+// or options only
+suite.add({
+ 'name': 'foo',
+ 'fn': fn,
+ 'onCycle': onCycle,
+ 'onComplete': onComplete
+});
+
+// basic usage
+suite.run();
+
+// or with options
+suite.run({ 'async': true, 'queued': true });
diff --git a/benchmark/benchmark.d.ts b/benchmark/benchmark.d.ts
new file mode 100644
index 000000000..3365f335c
--- /dev/null
+++ b/benchmark/benchmark.d.ts
@@ -0,0 +1,192 @@
+// Type definitions for Benchmark v1.0.0
+// Project: http://benchmarkjs.com
+// Definitions by: Asana <https://asana.com>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "benchmark" {
+ class Benchmark {
+ static deepClone<T>(value: T): T;
+ static each(obj: Object | any[], callback: Function, thisArg?: any): void;
+ static extend(destination: Object, ...sources: Object[]): Object;
+ static filter<T>(arr: T[], callback: (value: T) => any, thisArg?: any): T[];
+ static filter<T>(arr: T[], filter: string, thisArg?: any): T[];
+ static forEach<T>(arr: T[], callback: (value: T) => any, thisArg?: any): void;
+ static formatNumber(num: number): string;
+ static forOwn(obj: Object, callback: Function, thisArg?: any): void;
+ static hasKey(obj: Object, key: string): boolean;
+ static indexOf<T>(arr: T[], value: T, fromIndex?: number): number;
+ static interpolate(template: string, values: Object): string;
+ static invoke(benches: Benchmark[], name: string | Object, ...args: any[]): any[];
+ static join(obj: Object, separator1?: string, separator2?: string): string;
+ static map<T, K>(arr: T[], callback: (value: T) => K, thisArg?: any): K[];
+ static pluck<T, K>(arr: T[], key: string): K[];
+ static reduce<T, K>(arr: T[], callback: (accumulator: K, value: T) => K, thisArg?: any): K;
+
+ static options: Benchmark.Options;
+ static platform: Benchmark.Platform;
+ static support: Benchmark.Support;
+ static version: string;
+
+ constructor(fn: Function | string, options?: Benchmark.Options);
+ constructor(name: string, fn: Function | string, options?: Benchmark.Options);
+ constructor(name: string, options?: Benchmark.Options);
+ constructor(options: Benchmark.Options);
+
+ aborted: boolean;
+ compiled: Function | string;
+ count: number;
+ cycles: number;
+ error: Error;
+ fn: Function | string;
+ hz: number;
+ running: boolean;
+ setup: Function | string;
+ teardown: Function | string;
+
+ stats: Benchmark.Stats;
+ times: Benchmark.Times;
+
+ abort(): Benchmark;
+ clone(options: Benchmark.Options): Benchmark;
+ compare(benchmark: Benchmark): number;
+ emit(type: string | Object): any;
+ listeners(type: string): Function[];
+ off(type?: string, listener?: Function): Benchmark;
+ off(types: string[]): Benchmark;
+ on(type?: string, listener?: Function): Benchmark;
+ on(types: string[]): Benchmark;
+ reset(): Benchmark;
+ run(options?: Benchmark.Options): Benchmark;
+ toString(): string;
+ }
+
+ module Benchmark {
+ export interface Options {
+ async?: boolean;
+ defer?: boolean;
+ delay?: number;
+ id?: string;
+ initCount?: number;
+ maxTime?: number;
+ minSamples?: number;
+ minTime?: number;
+ name?: string;
+ onAbort?: Function;
+ onComplete?: Function;
+ onCycle?: Function;
+ onError?: Function;
+ onReset?: Function;
+ onStart?: Function;
+ setup?: Function | string;
+ teardown?: Function | string;
+ fn?: Function | string;
+ queued?: boolean;
+ }
+
+ export interface Platform {
+ description: string;
+ layout: string;
+ manufacturer: string;
+ name: string;
+ os: string;
+ prerelease: string;
+ product: string;
+ version: string;
+ toString(): string;
+ }
+
+ export interface Support {
+ air: boolean;
+ argumentsClass: boolean;
+ browser: boolean;
+ charByIndex: boolean;
+ charByOwnIndex: boolean;
+ decompilation: boolean;
+ descriptors: boolean;
+ getAllKeys: boolean;
+ iteratesOwnFirst: boolean;
+ java: boolean;
+ nodeClass: boolean;
+ timeout: boolean;
+ }
+
+ export interface Stats {
+ deviation: number;
+ mean: number;
+ moe: number;
+ rme: number;
+ sample: any[];
+ sem: number;
+ variance: number;
+ }
+
+ export interface Times {
+ cycle: number;
+ elapsed: number;
+ period: number;
+ timeStamp: number;
+ }
+
+ export class Deferred {
+ constructor(clone: Benchmark);
+
+ benchmark: Benchmark;
+ cycles: number;
+ elapsed: number;
+ timeStamp: number;
+ }
+
+ export class Event {
+ constructor(type: string | Object);
+
+ aborted: boolean;
+ cancelled: boolean;
+ currentTarget: Object;
+ result: any;
+ target: Object;
+ timeStamp: number;
+ type: string;
+ }
+
+ export class Suite {
+ static options: { name: string };
+
+ constructor(name?: string, options?: Options);
+
+ aborted: boolean;
+ length: number;
+ running: boolean;
+ abort(): Suite;
+ add(name: string, fn: Function | string, options?: Options): Suite;
+ add(fn: Function | string, options?: Options): Suite;
+ add(name: string, options?: Options): Suite;
+ add(options: Options): Suite;
+ clone(options: Options): Suite;
+ emit(type: string | Object): any;
+ filter(callback: Function | string): Suite;
+ forEach(callback: Function): Suite;
+ indexOf(value: any): number;
+ invoke(name: string, ...args: any[]): any[];
+ join(separator?: string): string;
+ listeners(type: string): Function[];
+ map(callback: Function): any[];
+ off(type?: string, callback?: Function): Benchmark;
+ off(types: string[]): Benchmark;
+ on(type?: string, callback?: Function): Benchmark;
+ on(types: string[]): Benchmark;
+ pluck(property: string): any[];
+ pop(): Function;
+ push(benchmark: Benchmark): number;
+ reduce<T>(callback: Function, accumulator: T): T;
+ reset(): Suite;
+ reverse(): any[];
+ run(options?: Options): Suite;
+ shift(): Benchmark;
+ slice(start: number, end: number): any[];
+ slice(start: number, deleteCount: number, ...values: any[]): any[];
+ unshift(benchmark: Benchmark): number;
+ }
+ }
+
+ export = Benchmark;
+}
diff --git a/bounce/bounce-tests.ts b/bounce/bounce-tests.ts
new file mode 100644
index 000000000..bd90bfe4c
--- /dev/null
+++ b/bounce/bounce-tests.ts
@@ -0,0 +1,77 @@
+/// <reference path="./bounce.d.ts" />
+/// <reference path="./../jquery/jquery.d.ts" />
+
+import Bounce from 'bounce.js';
+import * as $ from 'jquery';
+
+function test_chaining_transformations() {
+ var bounce = new Bounce();
+ bounce
+ .scale({
+ from: { x: 0, y: 0 },
+ to: { x: 2, y: 2 },
+ duration: 1000
+ })
+ .rotate({
+ from: 0,
+ to: 360,
+ delay: 500
+ })
+ .translate({
+ from: { x: 0, y: -100 },
+ to: { x: 0, y: 0 },
+ stiffness: 1,
+ bounces: 4
+ })
+ .skew({
+ from: { x: 1, y: 0.8 },
+ to: { x: 0.8, y: 1 },
+ easing: 'bounce'
+ });
+}
+
+function test_serialization() {
+ var b1 = new Bounce();
+ var serialized = b1.serialize();
+ var b2 = new Bounce();
+ b2.deserialize(serialized);
+}
+
+function test_apply () {
+ var bounce = new Bounce();
+ var element = document.createElement('div');
+ bounce.applyTo(element);
+ bounce.applyTo([element]);
+ bounce.applyTo($('div'));
+
+ var options = {
+ loop: true,
+ remove: true,
+ onComplete: () => {}
+ };
+ bounce.applyTo(element, options);
+ bounce.applyTo([element], options);
+ bounce.applyTo($('div'), options);
+}
+
+function test_apply_promise () {
+ var bounce = new Bounce();
+ var element = document.createElement('div');
+ bounce.applyTo($('div')).then(() => {});
+
+ var options = {
+ loop: true,
+ remove: true
+ };
+ bounce.applyTo($('div')).then(() => {});
+}
+
+function test_define() {
+ var bounce = new Bounce();
+ bounce.define('named-animation');
+}
+
+function test_remove() {
+ var bounce = new Bounce();
+ bounce.remove();
+}
diff --git a/bounce/bounce.d.ts b/bounce/bounce.d.ts
new file mode 100644
index 000000000..9ff7c3a08
--- /dev/null
+++ b/bounce/bounce.d.ts
@@ -0,0 +1,66 @@
+// Type definitions for Bounce.js v0.8.2
+// Project: http://github.com/tictail/bounce.js
+// Definitions by: Cherry <http://github.com/cherrry>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts"/>
+
+declare module 'bounce.js' {
+ export default Bounce
+
+ interface Point2D {
+ x: number
+ y: number
+ }
+
+ interface BounceOptions<T> {
+ from: T
+ to: T
+ duration?: number
+ delay?: number
+ easing?: string
+ bounces?: number
+ stiffness?: number
+ }
+
+ interface AnimationOptions {
+ loop?: boolean
+ remove?: boolean
+ onComplete?: () => void
+ }
+
+ interface SerailizedComponent<T> {
+ type: string
+ from: T
+ to: T
+ duration: number
+ delay: number
+ easing: string
+ bounces: number
+ stiffness: number
+ }
+
+ class Bounce {
+ static FPS: number
+ static counter: number
+
+ static isSupported(): boolean
+
+ constructor();
+
+ scale(options: BounceOptions<Point2D>): Bounce
+ rotate(options: BounceOptions<number>): Bounce
+ translate(options: BounceOptions<Point2D>): Bounce
+ skew(options: BounceOptions<Point2D>): Bounce
+
+ serialize(): SerailizedComponent<number|Point2D>[]
+ deserialize(serailized: SerailizedComponent<number|Point2D>[]): Bounce
+
+ applyTo(element: Element, options?: AnimationOptions): void
+ applyTo(elements: Element[], options?: AnimationOptions): void
+ applyTo(elements: JQuery, options?: AnimationOptions): JQueryPromise<void>
+
+ define(name: string): Bounce
+ remove(): void
+ }
+}
diff --git a/ckeditor/ckeditor.d.ts b/ckeditor/ckeditor.d.ts
index a8f268074..cab51f72c 100644
--- a/ckeditor/ckeditor.d.ts
+++ b/ckeditor/ckeditor.d.ts
@@ -64,6 +64,7 @@ declare module CKEDITOR {
var status: string;
var timestamp: string;
var version: string;
+ var config: config;
// Methods
@@ -556,6 +557,7 @@ declare module CKEDITOR {
}
interface config {
+ contentsCss?: string | string[];
startupMode?: string;
removeButtons?: string;
removePlugins?: string;
@@ -576,6 +578,7 @@ declare module CKEDITOR {
height?: string | number;
toolbarLocation?: string;
readOnly?: boolean;
+ customConfig?: string;
}
diff --git a/closure-compiler/closure-compiler-tests.ts b/closure-compiler/closure-compiler-tests.ts
new file mode 100644
index 000000000..e0bd650a3
--- /dev/null
+++ b/closure-compiler/closure-compiler-tests.ts
@@ -0,0 +1,17 @@
+/// <reference path="closure-compiler.d.ts"/>
+import {compile} from 'closure-compiler';
+
+compile('some.source()', {'check-only': null},
+ (err: Error, stdout: string, stderr: string): void => {
+ console.log('Got', err, 'stdout', stdout, 'stderr', stderr);
+ });
+
+// No options, Callback wins.
+compile('some.source()', (err: Error, stdout: string, stderr: string): void => {
+ console.log('Got', err, 'stdout', stdout, 'stderr', stderr);
+});
+
+compile(null, {'js': ['a/f.js', 'a/f2.js'], 'check-only': null},
+ (err: Error, stdout: string, stderr: string): void => {
+ console.log('Got', err, 'stdout', stdout, 'stderr', stderr);
+ });
diff --git a/closure-compiler/closure-compiler.d.ts b/closure-compiler/closure-compiler.d.ts
new file mode 100644
index 000000000..0d1aba741
--- /dev/null
+++ b/closure-compiler/closure-compiler.d.ts
@@ -0,0 +1,11 @@
+// Type definitions for closure-compiler
+// Project: https://github.com/tim-smart/node-closure/
+// Definitions by: Martin Probst <https://github.com/mprobst>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module 'closure-compiler' {
+ type Callback = (err: Error, stdout: string, stderr: string) => any;
+ function compile(src: string, callback: Callback): void;
+ function compile(src: string, options: {[k: string]: string | string[]},
+ callback: Callback): void;
+}
diff --git a/connect/connect-tests.ts b/connect/connect-tests.ts
new file mode 100644
index 000000000..e8665f8f9
--- /dev/null
+++ b/connect/connect-tests.ts
@@ -0,0 +1,32 @@
+/// <reference path="./connect.d.ts" />
+
+import * as http from "http";
+import * as connect from "connect";
+
+const app = connect();
+
+// log all requests
+app.use((req: http.IncomingMessage, res: http.ServerResponse, next: Function) => {
+ console.log(req, res);
+ next();
+});
+
+// Stop on errors
+app.use((err: Error, req: http.IncomingMessage, res: http.ServerResponse, next: Function) => {
+ if (err) {
+ return res.end(`Error: ${err}`);
+ }
+
+ next();
+});
+
+// respond to all requests
+app.use((req: http.IncomingMessage, res: http.ServerResponse) => {
+ res.end("Hello from Connect!\n");
+});
+
+//create node.js http server and listen on port
+http.createServer(app).listen(3000);
+
+//create node.js http server and listen on port using connect shortcut
+app.listen(3000);
diff --git a/connect/connect.d.ts b/connect/connect.d.ts
new file mode 100644
index 000000000..575a341b6
--- /dev/null
+++ b/connect/connect.d.ts
@@ -0,0 +1,92 @@
+// Type definitions for connect v3.4.0
+// Project: https://github.com/senchalabs/connect
+// Definitions by: Maxime LUCE <https://github.com/SomaticIT/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module "connect" {
+ import * as http from "http";
+
+ /**
+ * Create a new connect server.
+ * @public
+ */
+ function createServer(): createServer.Server;
+
+ module createServer {
+ export type ServerHandle = HandleFunction | http.Server;
+
+ export type SimpleHandleFunction = (req: http.IncomingMessage, res: http.ServerResponse) => void;
+ export type NextHandleFunction = (req: http.IncomingMessage, res: http.ServerResponse, next: Function) => void;
+ export type ErrorHandleFunction = (err: Error, req: http.IncomingMessage, res: http.ServerResponse, next: Function) => void;
+ export type HandleFunction = SimpleHandleFunction | NextHandleFunction | ErrorHandleFunction;
+
+ export interface ServerStackItem {
+ route: string;
+ handle: ServerHandle;
+ }
+
+ export interface Server extends NodeJS.EventEmitter {
+ (req: http.IncomingMessage, res: http.ServerResponse, next?: Function): void;
+
+ route: string;
+ stack: ServerStackItem[];
+
+ /**
+ * Utilize the given middleware `handle` to the given `route`,
+ * defaulting to _/_. This "route" is the mount-point for the
+ * middleware, when given a value other than _/_ the middleware
+ * is only effective when that segment is present in the request's
+ * pathname.
+ *
+ * For example if we were to mount a function at _/admin_, it would
+ * be invoked on _/admin_, and _/admin/settings_, however it would
+ * not be invoked for _/_, or _/posts_.
+ *
+ * @public
+ */
+ use(fn: HandleFunction): Server;
+ use(route: string, fn: HandleFunction): Server;
+
+ /**
+ * Handle server requests, punting them down
+ * the middleware stack.
+ *
+ * @private
+ */
+ handle(req: http.IncomingMessage, res: http.ServerResponse, next: Function): void;
+
+ /**
+ * Listen for connections.
+ *
+ * This method takes the same arguments
+ * as node's `http.Server#listen()`.
+ *
+ * HTTP and HTTPS:
+ *
+ * If you run your application both as HTTP
+ * and HTTPS you may wrap them individually,
+ * since your Connect "server" is really just
+ * a JavaScript `Function`.
+ *
+ * var connect = require('connect')
+ * , http = require('http')
+ * , https = require('https');
+ *
+ * var app = connect();
+ *
+ * http.createServer(app).listen(80);
+ * https.createServer(options, app).listen(443);
+ *
+ * @api public
+ */
+ listen(port: number, hostname?: string, backlog?: number, callback?: Function): http.Server;
+ listen(port: number, hostname?: string, callback?: Function): http.Server;
+ listen(path: string, callback?: Function): http.Server;
+ listen(handle: any, listeningListener?: Function): http.Server;
+ }
+ }
+
+ export = createServer;
+}
diff --git a/denodeify/denodeify-tests.ts b/denodeify/denodeify-tests.ts
new file mode 100644
index 000000000..0cd6a0c98
--- /dev/null
+++ b/denodeify/denodeify-tests.ts
@@ -0,0 +1,10 @@
+/// <reference path="denodeify.d.ts" />
+/// <reference path="../es6-promise/es6-promise.d.ts" />
+/// <reference path="../node/node.d.ts" />
+
+import denodeify = require("denodeify");
+import fs = require('fs');
+import cp = require('child_process');
+
+const readFile = denodeify<string,string,string>(fs.readFile);
+const exec = denodeify<string,string>(cp.exec, (err, stdout, stderr) => [err, stdout]);
\ No newline at end of file
diff --git a/denodeify/denodeify.d.ts b/denodeify/denodeify.d.ts
new file mode 100644
index 000000000..fec2fbf3c
--- /dev/null
+++ b/denodeify/denodeify.d.ts
@@ -0,0 +1,36 @@
+// Type definitions for denodeify 1.2.1
+// Project: https://github.com/matthew-andrews/denodeify
+// Definitions by: joaomoreno <https://github.com/joaomoreno/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../es6-promise/es6-promise.d.ts" />
+
+declare module "denodeify" {
+ function _<R>(fn: _.F0<R>, transformer?: _.M): () => Promise<R>;
+ function _<A,R>(fn: _.F1<A,R>, transformer?: _.M): (a:A) => Promise<R>;
+ function _<A,B,R>(fn: _.F2<A,B,R>, transformer?: _.M): (a:A, b:B) => Promise<R>;
+ function _<A,B,C,R>(fn: _.F3<A,B,C,R>, transformer?: _.M): (a:A, b:B, c:C) => Promise<R>;
+ function _<A,B,C,D,R>(fn: _.F4<A,B,C,D,R>, transformer?: _.M): (a:A, b:B, c:C, d:D) => Promise<R>;
+ function _<A,B,C,D,E,R>(fn: _.F5<A,B,C,D,E,R>, transformer?: _.M): (a:A, b:B, c:C, d:D, e:E) => Promise<R>;
+ function _<A,B,C,D,E,F,R>(fn: _.F6<A,B,C,D,E,F,R>, transformer?: _.M): (a:A, b:B, c:C, d:D, e:E, f:F) => Promise<R>;
+ function _<A,B,C,D,E,F,G,R>(fn: _.F7<A,B,C,D,E,F,G,R>, transformer?: _.M): (a:A, b:B, c:C, d:D, e:E, f:F, g:G) => Promise<R>;
+ function _<A,B,C,D,E,F,G,H,R>(fn: _.F8<A,B,C,D,E,F,G,H,R>, transformer?: _.M): (a:A, b:B, c:C, d:D, e:E, f:F, g:G, h:H) => Promise<R>;
+ function _(fn: _.F, transformer?: _.M): (...args: any[]) => Promise<any>;
+
+ module _ {
+ type Callback<R> = (err: Error, result: R) => any;
+ type F0<R> = (cb: Callback<R>) => any;
+ type F1<A,R> = (a:A, cb: Callback<R>) => any;
+ type F2<A,B,R> = (a:A, b:B, cb: Callback<R>) => any;
+ type F3<A,B,C,R> = (a:A, b:B, c:C, cb: Callback<R>) => any;
+ type F4<A,B,C,D,R> = (a:A, b:B, c:C, d:D, cb: Callback<R>) => any;
+ type F5<A,B,C,D,E,R> = (a:A, b:B, c:C, d:D, e:E, cb: Callback<R>) => any;
+ type F6<A,B,C,D,E,F,R> = (a:A, b:B, c:C, d:D, e:E, f:F, cb: Callback<R>) => any;
+ type F7<A,B,C,D,E,F,G,R> = (a:A, b:B, c:C, d:D, e:E, f:F, g:G, cb: Callback<R>) => any;
+ type F8<A,B,C,D,E,F,G,H,R> = (a:A, b:B, c:C, d:D, e:E, f:F, g:G, h:H, cb: Callback<R>) => any;
+ type F = (...args: any[]) => any;
+ type M = (err: Error, ...args: any[]) => any[];
+ }
+
+ export = _;
+}
\ No newline at end of file
diff --git a/docopt/docopt-tests.ts b/docopt/docopt-tests.ts
new file mode 100644
index 000000000..b8c1a2c25
--- /dev/null
+++ b/docopt/docopt-tests.ts
@@ -0,0 +1,11 @@
+/// <reference path="docopt.d.ts" />
+/// <reference path="../node/node.d.ts" />
+
+var doc = `
+Usage:
+ quick_example.coffee tcp <host> <port> [--timeout=<seconds>]
+ quick_example.coffee serial <port> [--baud=9600] [--timeout=<seconds>]
+ quick_example.coffee -h | --help | --version
+`;
+var {docopt} = require('docopt');
+console.log(docopt(doc, { version: '0.1.1rc' }));
diff --git a/docopt/docopt.d.ts b/docopt/docopt.d.ts
new file mode 100644
index 000000000..ea2330a19
--- /dev/null
+++ b/docopt/docopt.d.ts
@@ -0,0 +1,23 @@
+// Type definitions for Docopt v0.6.2
+// Project: http://docopt.org/
+// Definitions by: Giovanni Bassi <https://github.com/giggio/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+interface DocoptOption {
+ /** is an optional argument vector. It defaults to the arguments passed to your program (process.argv[2..]). You can also supply it with an array of strings, as with process.argv. For example: ['--verbose', '-o', 'hai.txt'] */
+ argv?: Array<string>,
+ /** (default:true) specifies whether the parser should automatically print the help message (supplied as doc) in case -h or --help options are encountered. After showing the usage-message, the program will terminate. If you want to handle -h or --help options manually (the same as other options), set help=false. */
+ help?: boolean,
+ /** (default:null) is an optional argument that specifies the version of your program. If supplied, then, if the parser encounters --version option, it will print the supplied version and terminate. version could be any printable object, but most likely a string, e.g. '2.1.0rc1'. */
+ version?: any,
+ /** (default false) If set to true will disallow mixing options and positional argument. I.e. after first positional argument, all arguments will be interpreted as positional even if the look like options. This can be used for strict compatibility with POSIX, or if you want to dispatch your arguments to other programs. */
+ options_first?: boolean,
+ /** (default true) If set to false will cause docopt to throw exceptions instead of printing the error to console and terminating the application. This flag is mainly for testing purposes. */
+ exit?: boolean
+}
+declare module "docopt" {
+ /**
+ * @param doc should be a string with the help message, written according to rules of the docopt language.
+ */
+ export function docopt(doc: string, options: DocoptOption): any;
+}
diff --git a/faker/faker.d.ts b/faker/faker.d.ts
index 6397dd993..01ce203ea 100644
--- a/faker/faker.d.ts
+++ b/faker/faker.d.ts
@@ -171,6 +171,8 @@ declare module Faker {
uuid(): string;
boolean(): boolean;
};
+
+ seed(value: number): void;
}
interface Card {
diff --git a/finalhandler/finalhandler-tests.ts b/finalhandler/finalhandler-tests.ts
new file mode 100644
index 000000000..cb8dc053d
--- /dev/null
+++ b/finalhandler/finalhandler-tests.ts
@@ -0,0 +1,17 @@
+/// <reference path="./finalhandler.d.ts" />
+
+import {ServerRequest, ServerResponse} from "http";
+import finalHandler from "finalhandler";
+
+let req: ServerRequest;
+let res: ServerResponse;
+let options: {
+ onerror: (err: any, req: ServerRequest, res: ServerResponse) => void;
+ message: boolean|((err: any, status: number) => string);
+ stacktrace: boolean;
+};
+
+let result: (err: any) => void;
+
+result = finalHandler(req, res);
+result = finalHandler(req, res, options);
diff --git a/finalhandler/finalhandler.d.ts b/finalhandler/finalhandler.d.ts
new file mode 100644
index 000000000..37e931718
--- /dev/null
+++ b/finalhandler/finalhandler.d.ts
@@ -0,0 +1,20 @@
+// Type definitions for finalhandler
+// Project: https://github.com/pillarjs/finalhandler
+// Definitions by: Ilya Mochalov <https://github.com/chrootsu>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module "finalhandler" {
+ import {ServerRequest, ServerResponse} from "http";
+
+ export interface Options {
+ message?: boolean|((err: any, status: number) => string);
+ onerror?: (err: any, req: ServerRequest, res: ServerResponse) => void;
+ stacktrace?: boolean;
+ }
+
+ function finalHandler(req: ServerRequest, res: ServerResponse, options?: Options): (err: any) => void;
+
+ export default finalHandler;
+}
diff --git a/flat/flat-tests.ts b/flat/flat-tests.ts
new file mode 100644
index 000000000..b6909cdb1
--- /dev/null
+++ b/flat/flat-tests.ts
@@ -0,0 +1,57 @@
+/// <reference path="./flat.d.ts" />
+
+import {flatten, unflatten} from "flat";
+
+module TestFlatten {
+ let options: {
+ delimiter?: string;
+ safe?: boolean;
+ maxDepth?: number;
+ };
+
+ type Target = {
+ a: {
+ b: number;
+ },
+ c: boolean[][];
+ };
+
+ let target: Target;
+
+ type Result = {
+ 'a.b': number;
+ 'c.0.0': boolean;
+ };
+
+ let result: Result;
+
+ result = flatten<Target, Result>(target);
+ result = flatten<Target, Result>(target, options);
+}
+
+module TestUnflatten {
+ let options: {
+ delimiter?: string;
+ object?: boolean;
+ overwrite?: boolean;
+ };
+
+ type Target = {
+ 'a.b': number;
+ 'c.0.0': boolean;
+ };
+
+ let target: Target;
+
+ type Result = {
+ a: {
+ b: number;
+ },
+ c: boolean[][];
+ };
+
+ let result: Result;
+
+ result = unflatten<Target, Result>(target);
+ result = unflatten<Target, Result>(target, options);
+}
diff --git a/flat/flat.d.ts b/flat/flat.d.ts
new file mode 100644
index 000000000..f3698f125
--- /dev/null
+++ b/flat/flat.d.ts
@@ -0,0 +1,41 @@
+// Type definitions for flat
+// Project: https://github.com/hughsk/flat
+// Definitions by: Ilya Mochalov <https://github.com/chrootsu>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module FlatTypes {
+ interface FlattenOptions {
+ delimiter?: string;
+ safe?: boolean;
+ maxDepth?: number;
+ }
+
+ interface Flatten {
+ <TTarget, TResult>(
+ target: TTarget,
+ options?: FlattenOptions
+ ): TResult;
+
+ flatten: Flatten;
+ unflatten: Unflatten;
+ }
+
+ interface UnflattenOptions {
+ delimiter?: string;
+ object?: boolean;
+ overwrite?: boolean;
+ }
+
+ interface Unflatten {
+ <TTarget, TResult>(
+ target: TTarget,
+ options?: UnflattenOptions
+ ): TResult;
+ }
+}
+
+declare module "flat" {
+ var flatten: FlatTypes.Flatten;
+
+ export = flatten;
+}
diff --git a/freedom/freedom.d.ts b/freedom/freedom.d.ts
index f012c9dea..fa80a530c 100644
--- a/freedom/freedom.d.ts
+++ b/freedom/freedom.d.ts
@@ -406,6 +406,12 @@ declare module freedom.PgpProvider {
interface PublicKey {
key: string;
fingerprint: string;
+ words: string[];
+ }
+
+ interface KeyFingerprint {
+ fingerprint: string;
+ words: string[];
}
interface VerifyDecryptResult {
@@ -418,6 +424,7 @@ declare module freedom.PgpProvider {
setup(passphrase: string, userid: string): Promise<void>;
clear(): Promise<void>;
exportKey(): Promise<PublicKey>;
+ getFingerprint(publicKey: string): Promise<KeyFingerprint>;
signEncrypt(data: ArrayBuffer, encryptKey?: string,
sign?: boolean): Promise<ArrayBuffer>;
verifyDecrypt(data: ArrayBuffer,
diff --git a/gruntjs/gruntjs.d.ts b/gruntjs/gruntjs.d.ts
index 850d0b226..e503cb572 100644
--- a/gruntjs/gruntjs.d.ts
+++ b/gruntjs/gruntjs.d.ts
@@ -192,6 +192,12 @@ declare module grunt {
*/
requires(prop: string, ...andProps: string[]): void
requires(prop: string[], ...andProps: string[][]): void
+
+ /**
+ * Recursively merges properties of the specified configObject into the current project configuration.
+ * You can use this method to append configuration options, targets, etc., to already defined tasks.
+ */
+ merge<T>(configObject: T): void;
}
}
diff --git a/gulp-inject/gulp-inject.d.ts b/gulp-inject/gulp-inject.d.ts
index 42f5fb348..fb2668a1f 100644
--- a/gulp-inject/gulp-inject.d.ts
+++ b/gulp-inject/gulp-inject.d.ts
@@ -22,8 +22,11 @@ declare module "gulp-inject" {
ignorePath?: string | string[];
relative?: boolean;
addPrefix?: string;
+ addSuffix?: string;
addRootSlash?: boolean;
name?: string;
+ removeTags?: boolean;
+ empty?: boolean;
starttag?: string | ITagFunction;
endtag?: string | ITagFunction;
transform?: ITransformFunction;
diff --git a/hammerjs/hammerjs.d.ts b/hammerjs/hammerjs.d.ts
index 5ea8165b0..0df86dfc6 100644
--- a/hammerjs/hammerjs.d.ts
+++ b/hammerjs/hammerjs.d.ts
@@ -3,8 +3,6 @@
// Definitions by: Philip Bulley <https://github.com/milkisevil/>, Han Lin Yap <https://github.com/codler>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-/// <reference path="../touch-events/touch-events.d.ts" />
-
declare var Hammer:HammerStatic;
declare module "hammerjs" {
diff --git a/iniparser/iniparser-tests.ts b/iniparser/iniparser-tests.ts
new file mode 100644
index 000000000..8558766df
--- /dev/null
+++ b/iniparser/iniparser-tests.ts
@@ -0,0 +1,21 @@
+/// <reference path="iniparser.d.ts" />
+
+import * as iniparser from 'iniparser';
+
+type Result = {section: {param: string}};
+
+let file: string;
+
+{
+ let callback: (err: any, data: Result) => void;
+ let result: void;
+
+ iniparser.parse(file, callback);
+}
+
+{
+ let result: Result;
+
+ result = iniparser.parseSync<Result>(file);
+ result = iniparser.parseString<Result>('');
+}
diff --git a/iniparser/iniparser.d.ts b/iniparser/iniparser.d.ts
new file mode 100644
index 000000000..81fd07377
--- /dev/null
+++ b/iniparser/iniparser.d.ts
@@ -0,0 +1,15 @@
+// Type definitions for iniparser
+// Project: https://github.com/shockie/node-iniparser
+// Definitions by: Ilya Mochalov <https://github.com/chrootsu>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "iniparser" {
+ export function parse<T>(
+ file: string,
+ callback: (err: any, data: T) => void
+ ): void;
+
+ export function parseSync<T>(file: string): T;
+
+ export function parseString<T>(data: string): T;
+}
diff --git a/jest/jest.d.ts b/jest/jest.d.ts
index d500525b6..2ee765728 100644
--- a/jest/jest.d.ts
+++ b/jest/jest.d.ts
@@ -40,6 +40,7 @@ declare module jest {
toBeFalsy(): boolean;
toBeTruthy(): boolean;
toBeNull(): boolean;
+ toBeDefined(): boolean;
toBeUndefined(): boolean;
toMatch(expected: RegExp): boolean;
toContain(expected: string): boolean;
diff --git a/jquery.pnotify/jquery.pnotify.d.ts b/jquery.pnotify/jquery.pnotify.d.ts
index 6e3e67cd3..a21416f84 100644
--- a/jquery.pnotify/jquery.pnotify.d.ts
+++ b/jquery.pnotify/jquery.pnotify.d.ts
@@ -11,6 +11,8 @@ interface PNotifyStack {
push?: string;
spacing1?: number;
spacing2?: number;
+ firstpos1?: number;
+ firstpos2?: number;
context?: JQuery
}
diff --git a/knex/knex-test.ts b/knex/knex-test.ts
index 081f98867..1d468b260 100644
--- a/knex/knex-test.ts
+++ b/knex/knex-test.ts
@@ -12,6 +12,7 @@ var knex = Knex({
});
var knex = Knex({
+ debug: true,
client: 'mysql',
connection: {
socketPath : '/path/to/socket.sock',
@@ -32,7 +33,13 @@ var knex = Knex({
},
pool: {
min: 0,
- max: 7
+ max: 7,
+ afterCreate: (connection: any, callback: Function) => {
+ return callback(null, connection);
+ },
+ beforeDestroy: (connection: any, callback: Function) => {
+ return callback(null, connection);
+ }
}
});
diff --git a/knex/knex.d.ts b/knex/knex.d.ts
index 82c26cfec..d2afc4aa8 100644
--- a/knex/knex.d.ts
+++ b/knex/knex.d.ts
@@ -135,6 +135,8 @@ declare module "knex" {
transacting(trx: Transaction): QueryBuilder;
connection(connection: any): QueryBuilder;
+
+ clone(): QueryBuilder;
}
interface As {
@@ -394,6 +396,7 @@ declare module "knex" {
}
interface Config {
+ debug?: boolean;
client?: string;
dialect?: string;
connection: string|ConnectionConfig|
@@ -427,7 +430,9 @@ declare module "knex" {
interface PoolConfig {
name?: string;
create?: Function;
+ afterCreate?: Function;
destroy?: Function;
+ beforeDestroy?: Function;
min?: number;
max?: number;
refreshIdle?: boolean;
diff --git a/ko.plus/ko.plus-tests.ts b/ko.plus/ko.plus-tests.ts
index 7dd1053b2..bff291d83 100644
--- a/ko.plus/ko.plus-tests.ts
+++ b/ko.plus/ko.plus-tests.ts
@@ -11,6 +11,9 @@
Version 1.1 - added test for makeEditable
+ Version 1.2 - amended callback on commmand.fail() method - accepts response,
+ status and message values
+
Note: Typescript version 1.4 or higher is required for union types
and type declarations
*/
@@ -29,8 +32,13 @@ function CommandTests() {
.done((data: any) => {
alert("success");
})
- .fail((error: string) => {
- alert(error);
+ .fail((response) => {
+ // dummy
+ return false;
+ })
+ .fail((response, status, message) => {
+ // fail has response, error and text
+ alert(status + message);
});
// initialize command with options (action only)
diff --git a/ko.plus/ko.plus.d.ts b/ko.plus/ko.plus.d.ts
index dacf6121f..4c9299aee 100644
--- a/ko.plus/ko.plus.d.ts
+++ b/ko.plus/ko.plus.d.ts
@@ -1,8 +1,9 @@
-// Type definitions for ko.plus v0.0.21
+// Type definitions for ko.plus v0.0.24
// Project: https://github.com/stevegreatrex/ko.plus
// Definitions by: Howard Richards <https://github.com/conficient>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
+/// <reference path="../jquery/jquery.d.ts" />
/// <reference path="../knockout/knockout.d.ts" />
/**
@@ -16,6 +17,9 @@
*
* Version 1.1 - fixed bug - makeEditable is now a function on .editable
* also refactored how the Editable classes inherit to simplify
+ *
+ * Version 1.2 - amended callback on commmand.fail() method - accepts response,
+ * status and message values
*/
//
@@ -87,7 +91,7 @@ declare module KoPlus {
//
done: (callback: (data: any) => void) => Command;
- fail: (callback: (error: string) => void) => Command;
+ fail: (callback: (response: any, status?: string, statusText?:string) => void) => Command;
always: (callback: Function) => Command;
diff --git a/lodash/lodash-tests.ts b/lodash/lodash-tests.ts
index adf86e9a6..c083edd4c 100644
--- a/lodash/lodash-tests.ts
+++ b/lodash/lodash-tests.ts
@@ -104,46 +104,43 @@ result = <(key: string) => any>testMapCache.get;
result = <(key: string) => boolean>testMapCache.has;
result = <(key: string, value: any) => _.Dictionary<any>>testMapCache.set;
-/*************
- * Chaining *
- *************/
-result = <_.LoDashWrapper<string>>_('test');
-result = <_.LoDashWrapper<number>>_(1);
-result = <_.LoDashWrapper<boolean>>_(true);
-result = <_.LoDashArrayWrapper<string>>_(['test1', 'test2']);
-// Appears to be a change in the compiler, if the type explicity implements the object indexer.
-// Looking at: https://typescript.codeplex.com/wikipage?title=Known%20breaking%20changes%20between%200.8%20and%200.9&referringTitle=Documentation
-// "The ‘noimplicitany’ option now warns on the use of the hidden default indexer"
-result = <_.LoDashObjectWrapper<_.Dictionary<string>>>_(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' });
+// _
+module TestWrapper {
+ {
+ let result: _.LoDashImplicitWrapper<string>;
+ result = _('');
+ }
-result = <_.LoDashWrapper<string>>_.chain('test');
-result = <_.LoDashWrapper<string>>_('test').chain();
-result = <_.LoDashWrapper<number>>_.chain(1);
-result = <_.LoDashWrapper<number>>_(1).chain();
-result = <_.LoDashWrapper<boolean>>_.chain(true);
-result = <_.LoDashWrapper<boolean>>_(true).chain();
-result = <_.LoDashArrayWrapper<string>>_.chain(['test1', 'test2']);
-result = <_.LoDashArrayWrapper<string>>_(['test1', 'test2']).chain();
-result = <_.LoDashObjectWrapper<_.Dictionary<string>>>_.chain(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' });
-result = <_.LoDashObjectWrapper<_.Dictionary<string>>>_(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' }).chain();
+ {
+ let result: _.LoDashImplicitWrapper<number>;
+ result = _(42);
+ }
+
+ {
+ let result: _.LoDashImplicitWrapper<boolean>;
+ result = _(true);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<string>;
+ result = _<string>(['']);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<{a: string}>;
+ result = _<{a: string}>({a: ''});
+ }
+}
//Wrapped array shortcut methods
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).concat(5, 6);
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).concat([5, 6]);
result = <string>_([1, 2, 3, 4]).join(',');
result = <number>_([1, 2, 3, 4]).pop();
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).push(5, 6, 7);
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).reverse();
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3, 4]).push(5, 6, 7);
result = <number>_([1, 2, 3, 4]).shift();
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).sort((a, b) => 1);
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).splice(1);
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).splice(1, 2, 5, 6);
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).unshift(5, 6);
-
-result = <number[]>_.tap([1, 2, 3, 4], function (array) { console.log(array); });
-result = <_.LoDashWrapper<string>>_('test').tap(function (value) { console.log(value); });
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).tap(function (array) { console.log(array); });
-result = <_.LoDashObjectWrapper<_.Dictionary<string>>>_(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' }).tap(function (array) { console.log(array); });
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3, 4]).sort((a, b) => 1);
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3, 4]).splice(1);
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3, 4]).splice(1, 2, 5, 6);
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3, 4]).unshift(5, 6);
result = <string>_('test').toString();
result = <string>_([1, 2, 3]).toString();
@@ -412,10 +409,10 @@ result = <Array<number>>_.flatten([1, [2], [[3]]], true);
result = <Array<number>>_.flatten<number>([1, [2], [3, [[4]]]], true);
result = <Array<number|boolean>>_.flatten<number|boolean>([1, [2], [3, [[false]]]], true);
-result = <_.LoDashArrayWrapper<number>>_([[1, 2], [3, 4], 5, 6]).flatten();
-result = <_.LoDashArrayWrapper<number|Array<Array<number>>>>_([1, [2], [3, [[4]]]]).flatten();
+result = <_.LoDashImplicitArrayWrapper<number>>_([[1, 2], [3, 4], 5, 6]).flatten();
+result = <_.LoDashImplicitArrayWrapper<number|Array<Array<number>>>>_([1, [2], [3, [[4]]]]).flatten();
-result = <_.LoDashArrayWrapper<number>>_([1, [2], [3, [[4]]]]).flatten(true);
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, [2], [3, [[4]]]]).flatten(true);
// _.flattenDeep
module TestFlattenDeep {
@@ -1053,76 +1050,417 @@ result = <number[]>_([1, 2]).zipWith<number>([1, 2], [1, 2], [1, 2], [1, 2], [1,
* Chain *
*********/
+// _.chain
+module TestChain {
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _.chain('');
+ result = _('').chain();
+
+ result = _.chain('').chain();
+ result = _('').chain().chain();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _.chain(42);
+ result = _(42).chain();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _.chain(true);
+ result = _(true).chain();
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<string>;
+
+ result = _.chain(['']);
+ result = _(['']).chain();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<{a: string}>;
+
+ result = _.chain<{a: string}>({a: ''});
+ result = _<{a: string}>({a: ''}).chain();
+ }
+}
+
+// _.tap
+module TestTap {
+ {
+ let interceptor: (value: string) => void;
+ let result: string;
+
+ _.tap('', interceptor);
+ _.tap('', interceptor, any);
+ }
+
+ {
+ let interceptor: (value: string[]) => void;
+ let result: _.LoDashImplicitArrayWrapper<string>;
+
+ _.tap([''], interceptor);
+ _.tap([''], interceptor, any);
+ }
+
+ {
+ let interceptor: (value: {a: string}) => void;
+ let result: _.LoDashImplicitObjectWrapper<{a: string}>;
+
+ _.tap({a: ''}, interceptor);
+ _.tap({a: ''}, interceptor, any);
+ }
+
+ {
+ let interceptor: (value: string) => void;
+ let result: _.LoDashImplicitWrapper<string>;
+
+ _.chain('').tap(interceptor, any);
+ _.chain('').tap(interceptor, any);
+
+ _('').tap(interceptor);
+ _('').tap(interceptor, any);
+ }
+
+ {
+ let interceptor: (value: string[]) => void;
+ let result: _.LoDashImplicitArrayWrapper<string>;
+
+ _.chain(['']).tap(interceptor);
+ _.chain(['']).tap(interceptor, any);
+
+ _(['']).tap(interceptor);
+ _(['']).tap(interceptor, any);
+ }
+
+ {
+ let interceptor: (value: {a: string}) => void;
+ let result: _.LoDashImplicitObjectWrapper<{a: string}>;
+
+ _.chain({a: ''}).tap(interceptor);
+ _.chain({a: ''}).tap(interceptor, any);
+
+ _({a: ''}).tap(interceptor);
+ _({a: ''}).tap(interceptor, any);
+ }
+
+ {
+ let interceptor: (value: string) => void;
+ let result: _.LoDashExplicitWrapper<string>;
+
+ _.chain('').tap(interceptor, any);
+ _.chain('').tap(interceptor, any);
+
+ _('').chain().tap(interceptor);
+ _('').chain().tap(interceptor, any);
+ }
+
+ {
+ let interceptor: (value: string[]) => void;
+ let result: _.LoDashExplicitArrayWrapper<string>;
+
+ _.chain(['']).tap(interceptor);
+ _.chain(['']).tap(interceptor, any);
+
+ _(['']).chain().tap(interceptor);
+ _(['']).chain().tap(interceptor, any);
+ }
+
+ {
+ let interceptor: (value: {a: string}) => void;
+ let result: _.LoDashExplicitObjectWrapper<{a: string}>;
+
+ _.chain({a: ''}).tap(interceptor);
+ _.chain({a: ''}).tap(interceptor, any);
+
+ _({a: ''}).chain().tap(interceptor);
+ _({a: ''}).chain().tap(interceptor, any);
+ }
+}
+
// _.thru
-{
- let result: number;
- result = _.thru<number, number>(1, (value: number) => value);
- result = _.thru<number, number>(1, (value: number) => value, any);
-}
-{
- let result: _.LoDashWrapper<number>;
- result = _(1).thru<number>((value: number) => value);
- result = _(1).thru<number>((value: number) => value, any);
-}
-{
- let result: _.LoDashWrapper<string>;
- result = _('').thru<string>((value: string) => value);
- result = _('').thru<string>((value: string) => value, any);
-}
-{
- let result: _.LoDashWrapper<boolean>;
- result = _(true).thru<boolean>((value: boolean) => value);
- result = _(true).thru<boolean>((value: boolean) => value, any);
-}
-{
- let result: _.LoDashObjectWrapper<any>;
- result = _({}).thru<Object>((value: Object) => value);
- result = _({}).thru<Object>((value: Object) => value, any);
-}
-{
- let result: _.LoDashArrayWrapper<number>;
- result = _([1, 2, 3]).thru<number>((value: number[]) => value);
- result = _([1, 2, 3]).thru<number>((value: number[]) => value, any);
+module TestThru {
+ interface Interceptor<T> {
+ (value: T): T;
+ }
+
+ {
+ let interceptor: Interceptor<number>;
+ let result: number;
+
+ result = _.thru<number, number>(1, interceptor);
+ result = _.thru<number, number>(1, interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<number>;
+ let result: _.LoDashImplicitWrapper<number>;
+
+ result = _(1).thru<number>(interceptor);
+ result = _(1).thru<number>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<string>;
+ let result: _.LoDashImplicitWrapper<string>;
+
+ result = _('').thru<string>(interceptor);
+ result = _('').thru<string>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<boolean>;
+ let result: _.LoDashImplicitWrapper<boolean>;
+
+ result = _(true).thru<boolean>(interceptor);
+ result = _(true).thru<boolean>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<{a: string}>;
+ let result: _.LoDashImplicitObjectWrapper<{a: string}>;
+
+ result = _({a: ''}).thru<{a: string}>(interceptor);
+ result = _({a: ''}).thru<{a: string}>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<number[]>;
+ let result: _.LoDashImplicitArrayWrapper<number>;
+
+ result = _([1, 2, 3]).thru<number>(interceptor);
+ result = _([1, 2, 3]).thru<number>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<number>;
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(1).chain().thru<number>(interceptor);
+ result = _(1).chain().thru<number>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<string>;
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('').chain().thru<string>(interceptor);
+ result = _('').chain().thru<string>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<boolean>;
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _(true).chain().thru<boolean>(interceptor);
+ result = _(true).chain().thru<boolean>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<{a: string}>;
+ let result: _.LoDashExplicitObjectWrapper<{a: string}>;
+
+ result = _({a: ''}).chain().thru<{a: string}>(interceptor);
+ result = _({a: ''}).chain().thru<{a: string}>(interceptor, any);
+ }
+
+ {
+ let interceptor: Interceptor<number[]>;
+ let result: _.LoDashExplicitArrayWrapper<number>;
+
+ result = _([1, 2, 3]).chain().thru<number>(interceptor);
+ result = _([1, 2, 3]).chain().thru<number>(interceptor, any);
+ }
}
// _.prototype.commit
-{
- let result: _.LoDashWrapper<number>;
- result = _(42).commit();
+module TestCommit {
+ {
+ let result: _.LoDashImplicitWrapper<number>;
+ result = _(42).commit();
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<any>;
+ result = _<any>([]).commit();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<any>;
+ result = _({}).commit();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+ result = _(42).chain().commit();
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<any>;
+ result = _<any>([]).chain().commit();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<any>;
+ result = _({}).chain().commit();
+ }
}
-{
- let result: _.LoDashArrayWrapper<any>;
- result = _<any>([]).commit();
-}
-{
- let result: _.LoDashObjectWrapper<any>;
- result = _({}).commit();
+
+// _.prototype.concat
+module TestConcat {
+ {
+ let result: _.LoDashImplicitArrayWrapper<number>;
+
+ result = _(1).concat<number>(2);
+ result = _(1).concat<number>(2, 3);
+ result = _(1).concat<number>(2, 3, 4);
+
+ result = _(1).concat(2);
+ result = _(1).concat(2, 3);
+ result = _(1).concat(2, 3, 4);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<string>;
+
+ result = _<string>(['']).concat<string>(['']);
+ result = _<string>(['']).concat<string>([''], ['']);
+ result = _<string>(['']).concat<string>([''], [''], ['']);
+
+ result = _<string>(['']).concat(['']);
+ result = _<string>(['']).concat([''], ['']);
+ result = _<string>(['']).concat([''], [''], ['']);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<{a: string}>;
+
+ result = _({a: ''}).concat<{a: string}>({a: ''});
+ result = _({a: ''}).concat<{a: string}>({a: ''}, {a: ''});
+ result = _({a: ''}).concat<{a: string}>({a: ''}, {a: ''}, {a: ''});
+
+ result = _({a: ''}).concat({a: ''});
+ result = _({a: ''}).concat({a: ''}, {a: ''});
+ result = _({a: ''}).concat({a: ''}, {a: ''}, {a: ''});
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<number>;
+
+ result = _(1).chain().concat<number>(2);
+ result = _(1).chain().concat<number>(2, 3);
+ result = _(1).chain().concat<number>(2, 3, 4);
+
+ result = _(1).chain().concat(2);
+ result = _(1).chain().concat(2, 3);
+ result = _(1).chain().concat(2, 3, 4);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<string>;
+
+ result = _<string>(['']).chain().concat<string>(['']);
+ result = _<string>(['']).chain().concat<string>([''], ['']);
+ result = _<string>(['']).chain().concat<string>([''], [''], ['']);
+
+ result = _<string>(['']).chain().concat(['']);
+ result = _<string>(['']).chain().concat([''], ['']);
+ result = _<string>(['']).chain().concat([''], [''], ['']);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<{a: string}>;
+
+ result = _({a: ''}).chain().concat<{a: string}>({a: ''});
+ result = _({a: ''}).chain().concat<{a: string}>({a: ''}, {a: ''});
+ result = _({a: ''}).chain().concat<{a: string}>({a: ''}, {a: ''}, {a: ''});
+
+ result = _({a: ''}).chain().concat({a: ''});
+ result = _({a: ''}).chain().concat({a: ''}, {a: ''});
+ result = _({a: ''}).chain().concat({a: ''}, {a: ''}, {a: ''});
+ }
}
// _.prototype.plant
-{
- let result: _.LoDashWrapper<number>;
- result = _(any).plant(42);
+module TestPlant {
+ {
+ let result: _.LoDashImplicitWrapper<number>;
+ result = _(any).plant(42);
+ }
+
+ {
+ let result: _.LoDashImplicitStringWrapper;
+ result = _(any).plant('');
+ }
+
+ {
+ let result: _.LoDashImplicitWrapper<boolean>;
+ result = _(any).plant(true);
+ }
+
+ {
+ let result: _.LoDashImplicitNumberArrayWrapper;
+ result = _(any).plant([42]);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<any>;
+ result = _(any).plant<any>([]);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<{}>;
+ result = _(any).plant<{}>({});
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+ result = _(any).chain().plant(42);
+ }
+
+ {
+ let result: _.LoDashExplicitStringWrapper;
+ result = _(any).chain().plant('');
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+ result = _(any).chain().plant(true);
+ }
+
+ {
+ let result: _.LoDashExplicitNumberArrayWrapper;
+ result = _(any).chain().plant([42]);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<any>;
+ result = _(any).chain().plant<any>([]);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<{}>;
+ result = _(any).chain().plant<{}>({});
+ }
}
-{
- let result: _.LoDashStringWrapper;
- result = _(any).plant('');
-}
-{
- let result: _.LoDashWrapper<boolean>;
- result = _(any).plant(true);
-}
-{
- let result: _.LoDashNumberArrayWrapper;
- result = _(any).plant([42]);
-}
-{
- let result: _.LoDashArrayWrapper<any>;
- result = _(any).plant<any>([]);
-}
-{
- let result: _.LoDashObjectWrapper<{}>;
- result = _(any).plant<{}>({});
+
+// _.prototype.reverse
+module TestReverse {
+ {
+ let result: _.LoDashImplicitArrayWrapper<number>;
+ result: _([42]).reverse();
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<number>;
+ result: _([42]).chain().reverse();
+ }
}
/**************
@@ -1318,9 +1656,9 @@ result = <_.Dictionary<number>>_.countBy([4.3, 6.1, 6.4], function (num) { retur
result = <_.Dictionary<number>>_.countBy([4.3, 6.1, 6.4], function (num) { return this.floor(num); }, Math);
result = <_.Dictionary<number>>_.countBy(['one', 'two', 'three'], 'length');
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_([4.3, 6.1, 6.4]).countBy(function (num) { return Math.floor(num); });
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_([4.3, 6.1, 6.4]).countBy(function (num) { return this.floor(num); }, Math);
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_(['one', 'two', 'three']).countBy('length');
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_([4.3, 6.1, 6.4]).countBy(function (num) { return Math.floor(num); });
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_([4.3, 6.1, 6.4]).countBy(function (num) { return this.floor(num); }, Math);
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_(['one', 'two', 'three']).countBy('length');
// _.detect
module TestDetect {
@@ -1509,11 +1847,11 @@ result = <number[]>_.each([1, 2, 3], function (num) { console.log(num); });
result = <_.Dictionary<number>>_.each({ 'one': 1, 'two': 2, 'three': 3 }, function (num) { console.log(num); });
result = <IFoodType>_.each<IFoodType, string>({ name: 'apple', type: 'fruit' }, function (value, key) { console.log(value, key) });
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3]).forEach(function (num) { console.log(num); });
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).forEach(function (num) { console.log(num); });
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3]).forEach(function (num) { console.log(num); });
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).forEach(function (num) { console.log(num); });
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3]).each(function (num) { console.log(num); });
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).each(function (num) { console.log(num); });
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3]).each(function (num) { console.log(num); });
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).each(function (num) { console.log(num); });
result = <number[]>_.forEachRight([1, 2, 3], function (num) { console.log(num); });
result = <_.Dictionary<number>>_.forEachRight({ 'one': 1, 'two': 2, 'three': 3 }, function (num) { console.log(num); });
@@ -1521,11 +1859,11 @@ result = <_.Dictionary<number>>_.forEachRight({ 'one': 1, 'two': 2, 'three': 3 }
result = <number[]>_.eachRight([1, 2, 3], function (num) { console.log(num); });
result = <_.Dictionary<number>>_.eachRight({ 'one': 1, 'two': 2, 'three': 3 }, function (num) { console.log(num); });
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3]).forEachRight(function (num) { console.log(num); });
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).forEachRight(function (num) { console.log(num); });
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3]).forEachRight(function (num) { console.log(num); });
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).forEachRight(function (num) { console.log(num); });
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3]).eachRight(function (num) { console.log(num); });
-result = <_.LoDashObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).eachRight(function (num) { console.log(num); });
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3]).eachRight(function (num) { console.log(num); });
+result = <_.LoDashImplicitObjectWrapper<_.Dictionary<number>>>_(<{ [index: string]: number; }>{ 'one': 1, 'two': 2, 'three': 3 }).eachRight(function (num) { console.log(num); });
result = <_.Dictionary<number[]>>_.groupBy([4.2, 6.1, 6.4], function (num) { return Math.floor(num); });
result = <_.Dictionary<number[]>>_.groupBy([4.2, 6.1, 6.4], function (num) { return this.floor(num); }, Math);
@@ -1764,14 +2102,14 @@ result = <IFoodCombined[]>_(foodsCombined).reject({ 'type': 'fruit' }).value();
result = <number>_.sample([1, 2, 3, 4]);
result = <number[]>_.sample([1, 2, 3, 4], 2);
-result = <_.LoDashWrapper<number>>_([1, 2, 3, 4]).sample();
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3, 4]).sample(2);
+result = <_.LoDashImplicitWrapper<number>>_([1, 2, 3, 4]).sample();
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3, 4]).sample(2);
result = <number>_([1, 2, 3, 4]).sample().value();
result = <number[]>_([1, 2, 3, 4]).sample(2).value();
result = <number[]>_.shuffle([1, 2, 3, 4, 5, 6]);
-result = <_.LoDashArrayWrapper<number>>_([1, 2, 3]).shuffle();
-result = <_.LoDashArrayWrapper<_.Dictionary<string>>>_(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' }).shuffle();
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, 2, 3]).shuffle();
+result = <_.LoDashImplicitArrayWrapper<_.Dictionary<string>>>_(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' }).shuffle();
result = <number>_.size([1, 2]);
result = <number>_([1, 2]).size();
@@ -1850,12 +2188,6 @@ result = <number[]>_([1, 2, 3]).sortBy(function (num) { return this.sin(num); },
result = <string[]>_(['banana', 'strawberry', 'apple']).sortBy('length').value();
result = <IFoodOrganic[]>_(foodsOrganic).sortByAll('organic', (food) => food.name, { organic: true }).value();
-(function (a: number, b: number, c: number, d: number): Array<number> { return _.toArray(arguments).slice(1); })(1, 2, 3, 4);
-result = <number[]>_.toArray([1, 2, 3, 4]);
-(function (a: number, b: number, c: number, d: number): Array<number> { return _(arguments).toArray<number>().slice(1).value(); })(1, 2, 3, 4);
-result = <number[]>_([1,2,3,4]).toArray().value();
-
-
result = <IStoogesCombined[]>_.where(stoogesCombined, { 'age': 40 });
result = <IStoogesCombined[]>_.where(stoogesCombined, { 'quotes': ['Poifect!'] });
@@ -1866,7 +2198,24 @@ result = <IStoogesCombined[]>_(stoogesCombined).where({ 'quotes': ['Poifect!'] }
* Date *
********/
-result = <number>_.now();
+module TestNow {
+ {
+ let result: number;
+
+ result = _.now();
+ result = _(42).now();
+ result = _<any>([]).now();
+ result = _({}).now();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(42).chain().now();
+ result = _<any>([]).chain().now();
+ result = _({}).chain().now();
+ }
+}
/*************
* Functions *
@@ -1969,8 +2318,8 @@ result = <number>_(testComposeSquareFn).compose<(n: number, m: number) => number
var createCallbackObj: { [index: string]: string; } = { name: 'Joe' };
result = <() => any>_.createCallback('name');
result = <() => boolean>_.createCallback(createCallbackObj);
-result = <_.LoDashObjectWrapper<() => any>>_('name').createCallback();
-result = <_.LoDashObjectWrapper<() => boolean>>_(createCallbackObj).createCallback();
+result = <_.LoDashImplicitObjectWrapper<() => any>>_('name').createCallback();
+result = <_.LoDashImplicitObjectWrapper<() => boolean>>_(createCallbackObj).createCallback();
// _.curry
var testCurryFn = (a: number, b: number, c: number) => [a, b, c];
@@ -2034,14 +2383,14 @@ source.addEventListener('message', <Function>_.debounce(function () { }, 250, {
'maxWait': 1000
}), false);
-result = <_.LoDashObjectWrapper<Function>>_(function () { }).debounce(150);
+result = <_.LoDashImplicitObjectWrapper<Function>>_(function () { }).debounce(150);
-jQuery('#postbox').on('click', <_.LoDashObjectWrapper<Function>>_(function () { }).debounce(300, {
+jQuery('#postbox').on('click', <_.LoDashImplicitObjectWrapper<Function>>_(function () { }).debounce(300, {
'leading': true,
'trailing': false
}));
-source.addEventListener('message', <_.LoDashObjectWrapper<Function>>_(function () { }).debounce(250, {
+source.addEventListener('message', <_.LoDashImplicitObjectWrapper<Function>>_(function () { }).debounce(250, {
'maxWait': 1000
}), false);
@@ -2049,11 +2398,11 @@ var returnedDebounce = _.throttle(function (a: any) { return a * 5; }, 5);
returnedThrottled(4);
result = <number>_.defer(function () { console.log('deferred'); });
-result = <_.LoDashWrapper<number>>_(function () { console.log('deferred'); }).defer();
+result = <_.LoDashImplicitWrapper<number>>_(function () { console.log('deferred'); }).defer();
var log = _.bind(console.log, console);
result = <number>_.delay(log, 1000, 'logged later');
-result = <_.LoDashWrapper<number>>_(log).delay(1000, 'logged later');
+result = <_.LoDashImplicitWrapper<number>>_(log).delay(1000, 'logged later');
// _.flow
var testFlowSquareFn = (n: number) => n * n;
@@ -2271,6 +2620,20 @@ var testCloneDeepCustomizerFn: TestCloneDeepCustomizerFn;
result = _({a: {b: 2}}).cloneDeep(testCloneDeepCustomizerFn, any);
}
+// _.eq
+module TestEq {
+ let customizer: (value: any, other: any, indexOrKey?: number|string) => boolean;
+ let result: boolean;
+
+ result = _.eq(any, any);
+ result = _.eq(any, any, customizer);
+ result = _.eq(any, any, customizer, any);
+
+ result = _(any).eq(any);
+ result = _(any).eq(any, customizer);
+ result = _(any).eq(any, customizer, any)
+}
+
// _.gt
result = <boolean>_.gt(1, 2);
result = <boolean>_(1).gt(2);
@@ -2321,6 +2684,20 @@ result = <boolean>_([1, 2, 3]).isEmpty();
result = <boolean>_({}).isEmpty();
result = <boolean>_('').isEmpty();
+// _.isEqual
+module TestIsEqual {
+ let customizer: (value: any, other: any, indexOrKey?: number|string) => boolean;
+ let result: boolean;
+
+ result = _.isEqual(any, any);
+ result = _.isEqual(any, any, customizer);
+ result = _.isEqual(any, any, customizer, any);
+
+ result = _(any).isEqual(any);
+ result = _(any).isEqual(any, customizer);
+ result = _(any).isEqual(any, customizer, any)
+}
+
// _.isError
result = <boolean>_.isError(any);
result = <boolean>_(1).isError();
@@ -2418,6 +2795,47 @@ result = <boolean>_(1).lte(2);
result = <boolean>_([]).lte(2);
result = <boolean>_({}).lte(2);
+// _.toArray
+module TestToArray {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
+
+ {
+ let result: string[];
+
+ result = _.toArray('');
+
+ result = (function (a: string) {return _.toArray<IArguments, string>(arguments);})('');
+
+ result = _((function (a: string) {return arguments;})('')).toArray<string>().value();
+ }
+
+ {
+ let result: TResult[];
+
+ result = _.toArray<TResult>(array);
+ result = _.toArray<TResult>(list);
+ result = _.toArray<TResult>(dictionary);
+
+ result = _(array).toArray().value();
+ result = _(list).toArray<TResult>().value();
+ result = _(dictionary).toArray<TResult>().value();
+ }
+
+ {
+ let result: any[];
+
+ result = _.toArray();
+ result = _.toArray<number>(42);
+ result = _.toArray<boolean>(true);
+
+ result = _('').toArray<string>().value();
+ result = _(42).toArray<any>().value();
+ result = _(true).toArray<any>().value();
+ }
+}
+
// _.toPlainObject
module TestToPlainObject {
let result: TResult;
@@ -2581,8 +2999,8 @@ result = <NameAge>_.assign({ 'name': 'moe' }, { 'age': 40 }, function (a, b) {
return typeof a == 'undefined' ? b : a;
});
-result = <_.LoDashObjectWrapper<NameAge>>_({ 'name': 'moe' }).assign({ 'age': 40 });
-result = <_.LoDashObjectWrapper<NameAge>>_({ 'name': 'moe' }).assign({ 'age': 40 }, function (a, b) {
+result = <_.LoDashImplicitObjectWrapper<NameAge>>_({ 'name': 'moe' }).assign({ 'age': 40 });
+result = <_.LoDashImplicitObjectWrapper<NameAge>>_({ 'name': 'moe' }).assign({ 'age': 40 }, function (a, b) {
return typeof a == 'undefined' ? b : a;
});
@@ -2591,8 +3009,8 @@ result = <NameAge>_.extend({ 'name': 'moe' }, { 'age': 40 }, function (a, b) {
return typeof a == 'undefined' ? b : a;
});
-result = <_.LoDashObjectWrapper<NameAge>>_({ 'name': 'moe' }).extend({ 'age': 40 });
-result = <_.LoDashObjectWrapper<NameAge>>_({ 'name': 'moe' }).extend({ 'age': 40 }, function (a, b) {
+result = <_.LoDashImplicitObjectWrapper<NameAge>>_({ 'name': 'moe' }).extend({ 'age': 40 });
+result = <_.LoDashImplicitObjectWrapper<NameAge>>_({ 'name': 'moe' }).extend({ 'age': 40 }, function (a, b) {
return typeof a == 'undefined' ? b : a;
});
@@ -2621,7 +3039,7 @@ interface Food {
}
var foodDefaults = { 'name': 'apple' };
result = <Food>_.defaults(foodDefaults, { 'name': 'banana', 'type': 'fruit' });
-result = <_.LoDashObjectWrapper<Food>>_(foodDefaults).defaults({ 'name': 'banana', 'type': 'fruit' });
+result = <_.LoDashImplicitObjectWrapper<Food>>_(foodDefaults).defaults({ 'name': 'banana', 'type': 'fruit' });
//_.defaultsDeep
interface DefaultsDeepResult {
@@ -2676,15 +3094,52 @@ module TestFindKey {
}
}
-result = <string>_.findLastKey({ 'a': 1, 'b': 2, 'c': 3, 'd': 4 }, function (num) {
- return num % 2 == 1;
-});
+// _.findLastKey
+module TestFindLastKey {
+ let result: string;
+
+ {
+ let predicateFn: (value: any, key?: string, object?: {}) => boolean;
+
+ result = _.findLastKey<{a: string;}>({a: ''});
+
+ result = _.findLastKey<{a: string;}>({a: ''}, predicateFn);
+ result = _.findLastKey<{a: string;}>({a: ''}, predicateFn, any);
+
+
+ result = _.findLastKey<{a: string;}>({a: ''}, '');
+ result = _.findLastKey<{a: string;}>({a: ''}, '', any);
+
+ result = _.findLastKey<{a: number;}, {a: string;}>({a: ''}, {a: 42});
+
+ result = _<{a: string;}>({a: ''}).findLastKey();
+
+ result = _<{a: string;}>({a: ''}).findLastKey(predicateFn);
+ result = _<{a: string;}>({a: ''}).findLastKey(predicateFn, any);
+
+
+ result = _<{a: string;}>({a: ''}).findLastKey('');
+ result = _<{a: string;}>({a: ''}).findLastKey('', any);
+
+ result = _<{a: string;}>({a: ''}).findLastKey<{a: number;}>({a: 42});
+ }
+
+ {
+ let predicateFn: (value: string, key?: string, collection?: _.Dictionary<string>) => boolean;
+
+ result = _.findLastKey<string, {a: string;}>({a: ''}, predicateFn);
+ result = _.findLastKey<string, {a: string;}>({a: ''}, predicateFn, any);
+
+ result = _<{a: string;}>({a: ''}).findLastKey<string>(predicateFn);
+ result = _<{a: string;}>({a: ''}).findLastKey<string>(predicateFn, any);
+ }
+}
result = <Dog>_.forIn(new Dog('Dagny'), function (value, key) {
console.log(key);
});
-result = <_.LoDashObjectWrapper<Dog>>_(new Dog('Dagny')).forIn(function (value, key) {
+result = <_.LoDashImplicitObjectWrapper<Dog>>_(new Dog('Dagny')).forIn(function (value, key) {
console.log(key);
});
@@ -2692,7 +3147,7 @@ result = <Dog>_.forInRight(new Dog('Dagny'), function (value, key) {
console.log(key);
});
-result = <_.LoDashObjectWrapper<Dog>>_(new Dog('Dagny')).forInRight(function (value, key) {
+result = <_.LoDashImplicitObjectWrapper<Dog>>_(new Dog('Dagny')).forInRight(function (value, key) {
console.log(key);
});
@@ -2706,7 +3161,7 @@ result = <ZeroOne>_.forOwn(<ZeroOne>{ '0': 'zero', '1': 'one', 'one': '2' }, fun
console.log(key);
});
-result = <_.LoDashObjectWrapper<ZeroOne>>_({ '0': 'zero', '1': 'one', 'length': 2 }).forOwn(function (num, key) {
+result = <_.LoDashImplicitObjectWrapper<ZeroOne>>_({ '0': 'zero', '1': 'one', 'length': 2 }).forOwn(function (num, key) {
console.log(key);
});
@@ -2714,15 +3169,15 @@ result = <any>_.forOwnRight({ '0': 'zero', '1': 'one', 'length': 2 }, function (
console.log(key);
});
-result = <_.LoDashObjectWrapper<ZeroOne>>_({ '0': 'zero', '1': 'one', 'length': 2 }).forOwnRight(function (num, key) {
+result = <_.LoDashImplicitObjectWrapper<ZeroOne>>_({ '0': 'zero', '1': 'one', 'length': 2 }).forOwnRight(function (num, key) {
console.log(key);
});
result = <string[]>_.functions(_);
result = <string[]>_.methods(_);
-result = <_.LoDashArrayWrapper<string>>_(_).functions();
-result = <_.LoDashArrayWrapper<string>>_(_).methods();
+result = <_.LoDashImplicitArrayWrapper<string>>_(_).functions();
+result = <_.LoDashImplicitArrayWrapper<string>>_(_).methods();
// _.get
result = <number>_.get<number>({ 'a': [{ 'b': { 'c': 3 } }] }, 'a[0].b.c');
@@ -2758,31 +3213,6 @@ result = <boolean>_({}).has(['', 42, true]);
result = _({}).invert<TResult>(true).value();
}
-// _.isEqual (alias: _.eq)
-result = <boolean>_.isEqual(1, 1);
-result = <boolean>_(1).isEqual(1);
-result = <boolean>_.eq(1, 1);
-result = <boolean>_(1).eq(1);
-
-var testEqObject = { 'user': 'fred' };
-var testEqOtherObject = { 'user': 'fred' };
-result = <boolean>_.isEqual(testEqObject, testEqOtherObject);
-result = <boolean>_(testEqObject).isEqual(testEqOtherObject);
-result = <boolean>_.eq(testEqObject, testEqOtherObject);
-result = <boolean>_(testEqObject).eq(testEqOtherObject);
-
-var testEqArray = ['hello', 'goodbye'];
-var testEqOtherArray = ['hi', 'goodbye'];
-var testEqCustomizerFn = (value: any, other: any): boolean => {
- if (_.every([value, other], RegExp.prototype.test, /^h(?:i|ello)$/)) {
- return true;
- }
-};
-result = <boolean>_.isEqual(testEqArray, testEqOtherArray, testEqCustomizerFn);
-result = <boolean>_(testEqArray).isEqual(testEqOtherArray, testEqCustomizerFn);
-result = <boolean>_.eq(testEqArray, testEqOtherArray, testEqCustomizerFn);
-result = <boolean>_(testEqArray).eq(testEqOtherArray, testEqCustomizerFn);
-
class Stooge {
constructor(
public name: string,
diff --git a/lodash/lodash.d.ts b/lodash/lodash.d.ts
index d5463ffc0..881124328 100644
--- a/lodash/lodash.d.ts
+++ b/lodash/lodash.d.ts
@@ -38,13 +38,13 @@ declare module _ {
*
* Explicit chaining can be enabled by using the _.chain method.
**/
- (value: number): LoDashWrapper<number>;
- (value: string): LoDashStringWrapper;
- (value: boolean): LoDashWrapper<boolean>;
- (value: Array<number>): LoDashNumberArrayWrapper;
- <T>(value: Array<T>): LoDashArrayWrapper<T>;
- <T extends {}>(value: T): LoDashObjectWrapper<T>;
- (value: any): LoDashWrapper<any>;
+ (value: number): LoDashImplicitWrapper<number>;
+ (value: string): LoDashImplicitStringWrapper;
+ (value: boolean): LoDashImplicitWrapper<boolean>;
+ (value: Array<number>): LoDashImplicitNumberArrayWrapper;
+ <T>(value: Array<T>): LoDashImplicitArrayWrapper<T>;
+ <T extends {}>(value: T): LoDashImplicitObjectWrapper<T>;
+ (value: any): LoDashImplicitWrapper<any>;
/**
* The semantic version number.
@@ -211,101 +211,40 @@ declare module _ {
unindexedChars: boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
- /**
- * Produces the toString result of the wrapped value.
- * @return Returns the string result.
- **/
- toString(): string;
+ interface LoDashWrapperBase<T, TWrapper> { }
- /**
- * Executes the chained sequence to extract the unwrapped value.
- * @return Returns the resolved unwrapped value.
- **/
- value(): T;
+ interface LoDashImplicitWrapperBase<T, TWrapper> extends LoDashWrapperBase<T, TWrapper> { }
- /**
- * @see _.value
- **/
- run(): T;
+ interface LoDashExplicitWrapperBase<T, TWrapper> extends LoDashWrapperBase<T, TWrapper> { }
- /**
- * @see _.value
- **/
- toJSON(): T;
+ interface LoDashImplicitWrapper<T> extends LoDashImplicitWrapperBase<T, LoDashImplicitWrapper<T>> { }
- /**
- * @see _.value
- **/
- valueOf(): T;
- }
+ interface LoDashExplicitWrapper<T> extends LoDashExplicitWrapperBase<T, LoDashExplicitWrapper<T>> { }
- interface LoDashWrapper<T> extends LoDashWrapperBase<T, LoDashWrapper<T>> { }
+ interface LoDashImplicitStringWrapper extends LoDashImplicitWrapper<string> { }
- interface LoDashStringWrapper extends LoDashWrapper<string> { }
+ interface LoDashExplicitStringWrapper extends LoDashExplicitWrapper<string> { }
- interface LoDashObjectWrapper<T> extends LoDashWrapperBase<T, LoDashObjectWrapper<T>> { }
+ interface LoDashImplicitObjectWrapper<T> extends LoDashImplicitWrapperBase<T, LoDashImplicitObjectWrapper<T>> { }
- interface LoDashArrayWrapper<T> extends LoDashWrapperBase<T[], LoDashArrayWrapper<T>> {
- concat(...items: Array<T|Array<T>>): LoDashArrayWrapper<T>;
+ interface LoDashExplicitObjectWrapper<T> extends LoDashExplicitWrapperBase<T, LoDashExplicitObjectWrapper<T>> { }
+
+ interface LoDashImplicitArrayWrapper<T> extends LoDashImplicitWrapperBase<T[], LoDashImplicitArrayWrapper<T>> {
join(seperator?: string): string;
pop(): T;
- push(...items: T[]): LoDashArrayWrapper<T>;
- reverse(): LoDashArrayWrapper<T>;
+ push(...items: T[]): LoDashImplicitArrayWrapper<T>;
shift(): T;
- sort(compareFn?: (a: T, b: T) => number): LoDashArrayWrapper<T>;
- splice(start: number): LoDashArrayWrapper<T>;
- splice(start: number, deleteCount: number, ...items: any[]): LoDashArrayWrapper<T>;
- unshift(...items: T[]): LoDashArrayWrapper<T>;
+ sort(compareFn?: (a: T, b: T) => number): LoDashImplicitArrayWrapper<T>;
+ splice(start: number): LoDashImplicitArrayWrapper<T>;
+ splice(start: number, deleteCount: number, ...items: any[]): LoDashImplicitArrayWrapper<T>;
+ unshift(...items: T[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashNumberArrayWrapper extends LoDashArrayWrapper<number> { }
+ interface LoDashExplicitArrayWrapper<T> extends LoDashExplicitWrapperBase<T[], LoDashExplicitArrayWrapper<T>> { }
- //_.chain
- interface LoDashStatic {
- /**
- * Creates a lodash object that wraps the given value with explicit method chaining enabled.
- * @param value The value to wrap.
- * @return The wrapper object.
- **/
- chain(value: number): LoDashWrapper<number>;
- chain(value: string): LoDashWrapper<string>;
- chain(value: boolean): LoDashWrapper<boolean>;
- chain<T>(value: Array<T>): LoDashArrayWrapper<T>;
- chain<T extends {}>(value: T): LoDashObjectWrapper<T>;
- chain(value: any): LoDashWrapper<any>;
- }
+ interface LoDashImplicitNumberArrayWrapper extends LoDashImplicitArrayWrapper<number> { }
- interface LoDashWrapperBase<T, TWrapper> {
- /**
- * Enables explicit method chaining on the wrapper object.
- * @see _.chain
- * @return The wrapper object.
- **/
- chain(): TWrapper;
- }
-
- //_.tap
- interface LoDashStatic {
- /**
- * Invokes interceptor with the value as the first argument and then returns value. The
- * purpose of this method is to "tap into" a method chain in order to perform operations on
- * intermediate results within the chain.
- * @param value The value to provide to interceptor
- * @param interceptor The function to invoke.
- * @return value
- **/
- tap<T>(
- value: T,
- interceptor: (value: T) => void): T;
- }
-
- interface LoDashWrapperBase<T, TWrapper> {
- /**
- * @see _.tap
- **/
- tap(interceptor: (value: T) => void): TWrapper;
- }
+ interface LoDashExplicitNumberArrayWrapper extends LoDashExplicitArrayWrapper<number> { }
/*********
* Array *
@@ -327,18 +266,18 @@ declare module _ {
): T[][];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.chunk
*/
- chunk(size?: number): LoDashArrayWrapper<T[]>;
+ chunk(size?: number): LoDashImplicitArrayWrapper<T[]>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.chunk
*/
- chunk<TResult>(size?: number): LoDashArrayWrapper<TResult[]>;
+ chunk<TResult>(size?: number): LoDashImplicitArrayWrapper<TResult[]>;
}
//_.compact
@@ -353,18 +292,18 @@ declare module _ {
compact<T>(array?: List<T>): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.compact
*/
- compact(): LoDashArrayWrapper<T>;
+ compact(): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.compact
*/
- compact<TResult>(): LoDashArrayWrapper<TResult>;
+ compact<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.difference
@@ -383,18 +322,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.difference
*/
- difference(...values: (T[]|List<T>)[]): LoDashArrayWrapper<T>;
+ difference(...values: (T[]|List<T>)[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.difference
*/
- difference<TValue>(...values: (TValue[]|List<TValue>)[]): LoDashArrayWrapper<TValue>;
+ difference<TValue>(...values: (TValue[]|List<TValue>)[]): LoDashImplicitArrayWrapper<TValue>;
}
//_.drop
@@ -409,18 +348,18 @@ declare module _ {
drop<T>(array: T[]|List<T>, n?: number): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.drop
*/
- drop(n?: number): LoDashArrayWrapper<T>;
+ drop(n?: number): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.drop
*/
- drop<TResult>(n?: number): LoDashArrayWrapper<TResult>;
+ drop<TResult>(n?: number): LoDashImplicitArrayWrapper<TResult>;
}
//_.dropRight
@@ -438,18 +377,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.dropRight
*/
- dropRight(n?: number): LoDashArrayWrapper<T>;
+ dropRight(n?: number): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.dropRight
*/
- dropRight<TResult>(n?: number): LoDashArrayWrapper<TResult>;
+ dropRight<TResult>(n?: number): LoDashImplicitArrayWrapper<TResult>;
}
//_.dropRightWhile
@@ -496,14 +435,14 @@ declare module _ {
): TValue[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.dropRightWhile
*/
dropRightWhile(
predicate?: ListIterator<T, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.dropRightWhile
@@ -511,24 +450,24 @@ declare module _ {
dropRightWhile(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.dropRightWhile
*/
dropRightWhile<TWhere>(
predicate?: TWhere
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.dropRightWhile
*/
dropRightWhile<TValue>(
predicate?: ListIterator<TValue, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.dropRightWhile
@@ -536,14 +475,14 @@ declare module _ {
dropRightWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.dropRightWhile
*/
dropRightWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
}
//_.dropWhile
@@ -590,14 +529,14 @@ declare module _ {
): TValue[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.dropWhile
*/
dropWhile(
predicate?: ListIterator<T, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.dropWhile
@@ -605,24 +544,24 @@ declare module _ {
dropWhile(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.dropWhile
*/
dropWhile<TWhere>(
predicate?: TWhere
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.dropWhile
*/
dropWhile<TValue>(
predicate?: ListIterator<TValue, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.dropWhile
@@ -630,14 +569,14 @@ declare module _ {
dropWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.dropWhile
*/
dropWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
}
//_.findIndex
@@ -684,7 +623,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.findIndex
*/
@@ -709,7 +648,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.findIndex
*/
@@ -777,7 +716,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.findLastIndex
*/
@@ -802,7 +741,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.findLastIndex
*/
@@ -840,14 +779,14 @@ declare module _ {
first<T>(array: List<T>): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.first
*/
first(): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.first
*/
@@ -885,16 +824,16 @@ declare module _ {
flatten<T>(array: RecursiveList<T>, isDeep: boolean): List<T> | RecursiveList<T>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.flatten
**/
- flatten<T>(): LoDashArrayWrapper<any>;
+ flatten<T>(): LoDashImplicitArrayWrapper<any>;
/**
* @see _.flatten
**/
- flatten<T>(isShallow: boolean): LoDashArrayWrapper<any>;
+ flatten<T>(isShallow: boolean): LoDashImplicitArrayWrapper<any>;
}
//_.flattenDeep
@@ -918,18 +857,18 @@ declare module _ {
flattenDeep<T>(array: RecursiveList<T>): any[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.flattenDeep
*/
- flattenDeep<TResult>(): LoDashArrayWrapper<TResult>;
+ flattenDeep<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.flattenDeep
*/
- flattenDeep<TResult>(): LoDashArrayWrapper<TResult>;
+ flattenDeep<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.head
@@ -940,14 +879,14 @@ declare module _ {
head<T>(array: List<T>): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.first
*/
head(): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.first
*/
@@ -973,7 +912,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.indexOf
*/
@@ -983,7 +922,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.indexOf
*/
@@ -1004,18 +943,18 @@ declare module _ {
initial<T>(array: T[]|List<T>): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.initial
*/
- initial(): LoDashArrayWrapper<T>;
+ initial(): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.initial
*/
- initial<TResult>(): LoDashArrayWrapper<TResult>;
+ initial<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.intersection
@@ -1030,18 +969,18 @@ declare module _ {
intersection<T>(...arrays: (T[]|List<T>)[]): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.intersection
*/
- intersection<TResult>(...arrays: (TResult[]|List<TResult>)[]): LoDashArrayWrapper<TResult>;
+ intersection<TResult>(...arrays: (TResult[]|List<TResult>)[]): LoDashImplicitArrayWrapper<TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.intersection
*/
- intersection<TResult>(...arrays: (TResult[]|List<TResult>)[]): LoDashArrayWrapper<TResult>;
+ intersection<TResult>(...arrays: (TResult[]|List<TResult>)[]): LoDashImplicitArrayWrapper<TResult>;
}
//_.last
@@ -1055,14 +994,14 @@ declare module _ {
last<T>(array: List<T>): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.last
*/
last(): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.last
*/
@@ -1086,7 +1025,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.lastIndexOf
*/
@@ -1096,7 +1035,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.lastIndexOf
*/
@@ -1133,50 +1072,50 @@ declare module _ {
): _.Dictionary<any>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.zipObject
*/
object<TValues, TResult extends {}>(
values?: List<TValues>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
object<TResult extends {}>(
values?: List<any>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
object(
values?: List<any>
- ): _.LoDashObjectWrapper<_.Dictionary<any>>;
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.zipObject
*/
object<TValues, TResult extends {}>(
values?: List<TValues>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
object<TResult extends {}>(
values?: List<any>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
object(
values?: List<any>
- ): _.LoDashObjectWrapper<_.Dictionary<any>>;
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
}
//_.pull
@@ -1204,18 +1143,18 @@ declare module _ {
): List<T>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.pull
*/
- pull(...values: T[]): LoDashArrayWrapper<T>;
+ pull(...values: T[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.pull
*/
- pull<TValue>(...values: TValue[]): LoDashObjectWrapper<List<TValue>>;
+ pull<TValue>(...values: TValue[]): LoDashImplicitObjectWrapper<List<TValue>>;
}
//_.pullAt
@@ -1236,18 +1175,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.pullAt
*/
- pullAt(...indexes: (number|number[])[]): LoDashArrayWrapper<T>;
+ pullAt(...indexes: (number|number[])[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.pullAt
*/
- pullAt<TValue>(...indexes: (number|number[])[]): LoDashArrayWrapper<TValue>;
+ pullAt<TValue>(...indexes: (number|number[])[]): LoDashImplicitArrayWrapper<TValue>;
}
//_.remove
@@ -1296,14 +1235,14 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.remove
*/
remove(
predicate?: ListIterator<T, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.remove
@@ -1311,24 +1250,24 @@ declare module _ {
remove(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.remove
*/
remove<W>(
predicate?: W
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.remove
*/
remove<TResult>(
predicate?: ListIterator<TResult, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.remove
@@ -1336,14 +1275,14 @@ declare module _ {
remove<TResult>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.remove
*/
remove<W, TResult>(
predicate?: W
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
}
//_.rest
@@ -1359,18 +1298,18 @@ declare module _ {
rest<T>(array: List<T>): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.rest
*/
- rest(): LoDashArrayWrapper<T>;
+ rest(): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.rest
*/
- rest<TResult>(): LoDashArrayWrapper<TResult>;
+ rest<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.slice
@@ -1390,14 +1329,14 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.slice
*/
slice(
start?: number,
end?: number
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
}
//_.sortedIndex
@@ -1478,18 +1417,18 @@ declare module _ {
tail<T>(array: List<T>): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.rest
*/
- tail(): LoDashArrayWrapper<T>;
+ tail(): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.rest
*/
- tail<TResult>(): LoDashArrayWrapper<TResult>;
+ tail<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.take
@@ -1507,18 +1446,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.take
*/
- take(n?: number): LoDashArrayWrapper<T>;
+ take(n?: number): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.take
*/
- take<TResult>(n?: number): LoDashArrayWrapper<TResult>;
+ take<TResult>(n?: number): LoDashImplicitArrayWrapper<TResult>;
}
//_.takeRight
@@ -1536,18 +1475,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.takeRight
*/
- takeRight(n?: number): LoDashArrayWrapper<T>;
+ takeRight(n?: number): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.takeRight
*/
- takeRight<TResult>(n?: number): LoDashArrayWrapper<TResult>;
+ takeRight<TResult>(n?: number): LoDashImplicitArrayWrapper<TResult>;
}
//_.takeRightWhile
@@ -1594,14 +1533,14 @@ declare module _ {
): TValue[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.takeRightWhile
*/
takeRightWhile(
predicate?: ListIterator<T, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.takeRightWhile
@@ -1609,24 +1548,24 @@ declare module _ {
takeRightWhile(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.takeRightWhile
*/
takeRightWhile<TWhere>(
predicate?: TWhere
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.takeRightWhile
*/
takeRightWhile<TValue>(
predicate?: ListIterator<TValue, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.takeRightWhile
@@ -1634,14 +1573,14 @@ declare module _ {
takeRightWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.takeRightWhile
*/
takeRightWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
}
//_.takeWhile
@@ -1688,14 +1627,14 @@ declare module _ {
): TValue[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.takeWhile
*/
takeWhile(
predicate?: ListIterator<T, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.takeWhile
@@ -1703,24 +1642,24 @@ declare module _ {
takeWhile(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
/**
* @see _.takeWhile
*/
takeWhile<TWhere>(
predicate?: TWhere
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.takeWhile
*/
takeWhile<TValue>(
predicate?: ListIterator<TValue, boolean>,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.takeWhile
@@ -1728,14 +1667,14 @@ declare module _ {
takeWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.takeWhile
*/
takeWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
}
//_.union
@@ -1750,23 +1689,23 @@ declare module _ {
union<T>(...arrays: List<T>[]): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.union
*/
- union(...arrays: List<T>[]): LoDashArrayWrapper<T>;
+ union(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
/**
* @see _.union
*/
- union<T>(...arrays: List<T>[]): LoDashArrayWrapper<T>;
+ union<T>(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.union
*/
- union<T>(...arrays: List<T>[]): LoDashArrayWrapper<T>;
+ union<T>(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
}
//_.uniq
@@ -2011,11 +1950,11 @@ declare module _ {
whereValue?: W): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.uniq
**/
- uniq<TSort>(isSorted?: boolean): LoDashArrayWrapper<T>;
+ uniq<TSort>(isSorted?: boolean): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
@@ -2023,14 +1962,14 @@ declare module _ {
uniq<TSort>(
isSorted: boolean,
callback: ListIterator<T, TSort>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
**/
uniq<TSort>(
callback: ListIterator<T, TSort>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
@@ -2038,13 +1977,13 @@ declare module _ {
**/
uniq(
isSorted: boolean,
- pluckValue: string): LoDashArrayWrapper<T>;
+ pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
* @param pluckValue _.pluck style callback
**/
- uniq(pluckValue: string): LoDashArrayWrapper<T>;
+ uniq(pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
@@ -2052,19 +1991,19 @@ declare module _ {
**/
uniq<W>(
isSorted: boolean,
- whereValue: W): LoDashArrayWrapper<T>;
+ whereValue: W): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
* @param whereValue _.where style callback
**/
uniq<W>(
- whereValue: W): LoDashArrayWrapper<T>;
+ whereValue: W): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
**/
- unique<TSort>(isSorted?: boolean): LoDashArrayWrapper<T>;
+ unique<TSort>(isSorted?: boolean): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
@@ -2072,14 +2011,14 @@ declare module _ {
unique<TSort>(
isSorted: boolean,
callback: ListIterator<T, TSort>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
**/
unique<TSort>(
callback: ListIterator<T, TSort>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
@@ -2087,13 +2026,13 @@ declare module _ {
**/
unique(
isSorted: boolean,
- pluckValue: string): LoDashArrayWrapper<T>;
+ pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
* @param pluckValue _.pluck style callback
**/
- unique(pluckValue: string): LoDashArrayWrapper<T>;
+ unique(pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
@@ -2101,14 +2040,14 @@ declare module _ {
**/
unique<W>(
isSorted: boolean,
- whereValue: W): LoDashArrayWrapper<T>;
+ whereValue: W): LoDashImplicitArrayWrapper<T>;
/**
* @see _.uniq
* @param whereValue _.where style callback
**/
unique<W>(
- whereValue: W): LoDashArrayWrapper<T>;
+ whereValue: W): LoDashImplicitArrayWrapper<T>;
}
//_.unzipWith
@@ -2130,24 +2069,24 @@ declare module _ {
): TResult[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.unzipWith
*/
unzipWith<TArr, TResult>(
iteratee?: MemoIterator<TArr, TResult>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.unzipWith
*/
unzipWith<TArr, TResult>(
iteratee?: MemoIterator<TArr, TResult>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
}
//_.without
@@ -2165,18 +2104,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.without
*/
- without(...values: T[]): LoDashArrayWrapper<T>;
+ without(...values: T[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.without
*/
- without<TValue>(...values: TValue[]): LoDashArrayWrapper<TValue>;
+ without<TValue>(...values: TValue[]): LoDashImplicitArrayWrapper<TValue>;
}
//_.xor
@@ -2190,18 +2129,18 @@ declare module _ {
xor<T>(...arrays: List<T>[]): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.xor
*/
- xor(...arrays: List<T>[]): LoDashArrayWrapper<T>;
+ xor(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.xor
*/
- xor<TValue>(...arrays: List<TValue>[]): LoDashArrayWrapper<TValue>;
+ xor<TValue>(...arrays: List<TValue>[]): LoDashImplicitArrayWrapper<TValue>;
}
//_.zip
@@ -2231,16 +2170,16 @@ declare module _ {
unzip(...arrays: any[]): any[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.zip
**/
- zip(...arrays: any[][]): _.LoDashArrayWrapper<any[][]>;
+ zip(...arrays: any[][]): _.LoDashImplicitArrayWrapper<any[][]>;
/**
* @see _.zip
**/
- unzip(...arrays: any[]): _.LoDashArrayWrapper<any[][]>;
+ unzip(...arrays: any[]): _.LoDashImplicitArrayWrapper<any[][]>;
}
//_.zipObject
@@ -2278,50 +2217,50 @@ declare module _ {
): _.Dictionary<any>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.zipObject
*/
zipObject<TValues, TResult extends {}>(
values?: List<TValues>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
zipObject<TResult extends {}>(
values?: List<any>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
zipObject(
values?: List<any>
- ): _.LoDashObjectWrapper<_.Dictionary<any>>;
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.zipObject
*/
zipObject<TValues, TResult extends {}>(
values?: List<TValues>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
zipObject<TResult extends {}>(
values?: List<any>
- ): _.LoDashObjectWrapper<TResult>;
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.zipObject
*/
zipObject(
values?: List<any>
- ): _.LoDashObjectWrapper<_.Dictionary<any>>;
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
}
//_.zipWith
@@ -2338,21 +2277,105 @@ declare module _ {
zipWith<TResult>(...args: any[]): TResult[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.zipWith
*/
- zipWith<TResult>(...args: any[]): LoDashArrayWrapper<TResult>;
+ zipWith<TResult>(...args: any[]): LoDashImplicitArrayWrapper<TResult>;
}
/*********
* Chain *
*********/
+ //_.chain
+ interface LoDashStatic {
+ /**
+ * Creates a lodash object that wraps value with explicit method chaining enabled.
+ *
+ * @param value The value to wrap.
+ * @return Returns the new lodash wrapper instance.
+ */
+ chain(value: number): LoDashExplicitWrapper<number>;
+ chain(value: string): LoDashExplicitWrapper<string>;
+ chain(value: boolean): LoDashExplicitWrapper<boolean>;
+ chain<T>(value: T[]): LoDashExplicitArrayWrapper<T>;
+ chain<T extends {}>(value: T): LoDashExplicitObjectWrapper<T>;
+ chain(value: any): LoDashExplicitWrapper<any>;
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.chain
+ */
+ chain(): LoDashExplicitWrapper<T>;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.chain
+ */
+ chain(): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.chain
+ */
+ chain(): LoDashExplicitObjectWrapper<T>;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.chain
+ */
+ chain(): TWrapper;
+ }
+
+ //_.tap
+ interface LoDashStatic {
+ /**
+ * This method invokes interceptor and returns value. The interceptor is bound to thisArg and invoked with one
+ * argument; (value). The purpose of this method is to "tap into" a method chain in order to perform operations
+ * on intermediate results within the chain.
+ *
+ * @param value The value to provide to interceptor.
+ * @param interceptor The function to invoke.
+ * @parem thisArg The this binding of interceptor.
+ * @return Returns value.
+ **/
+ tap<T>(
+ value: T,
+ interceptor: (value: T) => void,
+ thisArg?: any
+ ): T;
+ }
+
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.tap
+ */
+ tap(
+ interceptor: (value: T) => void,
+ thisArg?: any
+ ): TWrapper;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.tap
+ */
+ tap(
+ interceptor: (value: T) => void,
+ thisArg?: any
+ ): TWrapper;
+ }
+
//_.thru
interface LoDashStatic {
/**
* This method is like _.tap except that it returns the result of interceptor.
+ *
* @param value The value to provide to interceptor.
* @param interceptor The function to invoke.
* @param thisArg The this binding of interceptor.
@@ -2361,48 +2384,91 @@ declare module _ {
thru<T, TResult>(
value: T,
interceptor: (value: T) => TResult,
- thisArg?: any): TResult;
+ thisArg?: any
+ ): TResult;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.thru
*/
thru<TResult extends number>(
interceptor: (value: T) => TResult,
- thisArg?: any): LoDashWrapper<TResult>;
+ thisArg?: any): LoDashImplicitWrapper<TResult>;
/**
* @see _.thru
*/
thru<TResult extends string>(
interceptor: (value: T) => TResult,
- thisArg?: any): LoDashWrapper<TResult>;
+ thisArg?: any): LoDashImplicitWrapper<TResult>;
/**
* @see _.thru
*/
thru<TResult extends boolean>(
interceptor: (value: T) => TResult,
- thisArg?: any): LoDashWrapper<TResult>;
+ thisArg?: any): LoDashImplicitWrapper<TResult>;
/**
* @see _.thru
*/
- thru<TResult extends Object>(
+ thru<TResult extends {}>(
interceptor: (value: T) => TResult,
- thisArg?: any): LoDashObjectWrapper<TResult>;
+ thisArg?: any): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.thru
*/
thru<TResult>(
interceptor: (value: T) => TResult[],
- thisArg?: any): LoDashArrayWrapper<TResult>;
+ thisArg?: any): LoDashImplicitArrayWrapper<TResult>;
}
- // _.prototype.commit
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.thru
+ */
+ thru<TResult extends number>(
+ interceptor: (value: T) => TResult,
+ thisArg?: any
+ ): LoDashExplicitWrapper<TResult>;
+
+ /**
+ * @see _.thru
+ */
+ thru<TResult extends string>(
+ interceptor: (value: T) => TResult,
+ thisArg?: any
+ ): LoDashExplicitWrapper<TResult>;
+
+ /**
+ * @see _.thru
+ */
+ thru<TResult extends boolean>(
+ interceptor: (value: T) => TResult,
+ thisArg?: any
+ ): LoDashExplicitWrapper<TResult>;
+
+ /**
+ * @see _.thru
+ */
+ thru<TResult extends {}>(
+ interceptor: (value: T) => TResult,
+ thisArg?: any
+ ): LoDashExplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.thru
+ */
+ thru<TResult>(
+ interceptor: (value: T) => TResult[],
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
+ }
+
+ //_.prototype.commit
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* Executes the chained sequence and returns the wrapped result.
*
@@ -2411,44 +2477,181 @@ declare module _ {
commit(): TWrapper;
}
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.commit
+ */
+ commit(): TWrapper;
+ }
+
+ //_.prototype.concat
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * Creates a new array joining a wrapped array with any additional arrays and/or values.
+ *
+ * @param items
+ * @return Returns the new concatenated array.
+ */
+ concat<TItem>(...items: Array<TItem|Array<TItem>>): LoDashImplicitArrayWrapper<TItem>;
+
+ /**
+ * @see _.concat
+ */
+ concat(...items: Array<T|Array<T>>): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.concat
+ */
+ concat<TItem>(...items: Array<TItem|Array<TItem>>): LoDashExplicitArrayWrapper<TItem>;
+
+ /**
+ * @see _.concat
+ */
+ concat(...items: Array<T|Array<T>>): LoDashExplicitArrayWrapper<T>;
+ }
+
//_.prototype.plant
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* Creates a clone of the chained sequence planting value as the wrapped value.
* @param value The value to plant as the wrapped value.
* @return Returns the new lodash wrapper instance.
*/
- plant(value: number): LoDashWrapper<number>;
+ plant(value: number): LoDashImplicitWrapper<number>;
/**
* @see _.plant
*/
- plant(value: string): LoDashStringWrapper;
+ plant(value: string): LoDashImplicitStringWrapper;
/**
* @see _.plant
*/
- plant(value: boolean): LoDashWrapper<boolean>;
+ plant(value: boolean): LoDashImplicitWrapper<boolean>;
/**
* @see _.plant
*/
- plant(value: number[]): LoDashNumberArrayWrapper;
+ plant(value: number[]): LoDashImplicitNumberArrayWrapper;
/**
* @see _.plant
*/
- plant<T>(value: T[]): LoDashArrayWrapper<T>;
+ plant<T>(value: T[]): LoDashImplicitArrayWrapper<T>;
/**
* @see _.plant
*/
- plant<T extends {}>(value: T): LoDashObjectWrapper<T>;
+ plant<T extends {}>(value: T): LoDashImplicitObjectWrapper<T>;
/**
* @see _.plant
*/
- plant(value: any): LoDashWrapper<any>;
+ plant(value: any): LoDashImplicitWrapper<any>;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.plant
+ */
+ plant(value: number): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.plant
+ */
+ plant(value: string): LoDashExplicitStringWrapper;
+
+ /**
+ * @see _.plant
+ */
+ plant(value: boolean): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.plant
+ */
+ plant(value: number[]): LoDashExplicitNumberArrayWrapper;
+
+ /**
+ * @see _.plant
+ */
+ plant<T>(value: T[]): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.plant
+ */
+ plant<T extends {}>(value: T): LoDashExplicitObjectWrapper<T>;
+
+ /**
+ * @see _.plant
+ */
+ plant(value: any): LoDashExplicitWrapper<any>;
+ }
+
+ //_.prototype.reverse
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * Reverses the wrapped array so the first element becomes the last, the second element becomes the second to
+ * last, and so on.
+ *
+ * Note: This method mutates the wrapped array.
+ *
+ * @return Returns the new reversed lodash wrapper instance.
+ */
+ reverse(): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.reverse
+ */
+ reverse(): LoDashExplicitArrayWrapper<T>;
+ }
+
+ // _.run
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * @see _.value
+ */
+ run(): T;
+ }
+
+ // _.toJSON
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * @see _.value
+ */
+ toJSON(): T;
+ }
+
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * Produces the result of coercing the unwrapped value to a string.
+ *
+ * @return Returns the coerced string value.
+ */
+ toString(): string;
+ }
+
+ // _.value
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * Executes the chained sequence to extract the unwrapped value.
+ *
+ * @alias _.run, _.toJSON, _.valueOf
+ *
+ * @return Returns the resolved unwrapped value.
+ */
+ value(): T;
+ }
+
+ // _.valueOf
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * @see _.value
+ */
+ valueOf(): T;
}
/**************
@@ -2493,7 +2696,7 @@ declare module _ {
): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.every
*/
@@ -2518,7 +2721,7 @@ declare module _ {
): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.every
*/
@@ -2581,7 +2784,7 @@ declare module _ {
): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.some
*/
@@ -2606,7 +2809,7 @@ declare module _ {
): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.some
*/
@@ -2647,18 +2850,18 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.at
*/
- at(...props: Array<number|string|Array<number|string>>): LoDashArrayWrapper<T>;
+ at(...props: Array<number|string|Array<number|string>>): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.at
*/
- at<TResult>(...props: Array<number|string|Array<number|string>>): LoDashArrayWrapper<TResult>;
+ at<TResult>(...props: Array<number|string|Array<number|string>>): LoDashImplicitArrayWrapper<TResult>;
}
//_.collect
@@ -2714,52 +2917,52 @@ declare module _ {
): boolean[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.map
*/
collect<TResult>(
iteratee?: ListIterator<T, TResult>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
collect<TResult>(
iteratee?: string
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
collect<TObject extends {}>(
iteratee?: TObject
- ): LoDashArrayWrapper<boolean>;
+ ): LoDashImplicitArrayWrapper<boolean>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.map
*/
collect<TValue, TResult>(
iteratee?: ListIterator<TValue, TResult>|DictionaryIterator<TValue, TResult>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
collect<TValue, TResult>(
iteratee?: string
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
collect<TObject extends {}>(
iteratee?: TObject
- ): LoDashArrayWrapper<boolean>;
+ ): LoDashImplicitArrayWrapper<boolean>;
}
//_.contains
@@ -2870,7 +3073,7 @@ declare module _ {
fromIndex?: number): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.contains
**/
@@ -2887,7 +3090,7 @@ declare module _ {
includes(target: T, fromIndex?: number): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.contains
**/
@@ -2904,7 +3107,7 @@ declare module _ {
includes<TValue>(target: TValue, fromIndex?: number): boolean;
}
- interface LoDashStringWrapper {
+ interface LoDashImplicitStringWrapper {
/**
* @see _.contains
**/
@@ -2990,13 +3193,13 @@ declare module _ {
thisArg?: any): Dictionary<number>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.countBy
**/
countBy(
callback?: ListIterator<T, any>,
- thisArg?: any): LoDashObjectWrapper<Dictionary<number>>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<number>>;
/**
* @see _.countBy
@@ -3004,7 +3207,7 @@ declare module _ {
**/
countBy(
callback: string,
- thisArg?: any): LoDashObjectWrapper<Dictionary<number>>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<number>>;
}
//_.detect
@@ -3045,7 +3248,7 @@ declare module _ {
): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.find
*/
@@ -3070,7 +3273,7 @@ declare module _ {
): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.find
*/
@@ -3150,7 +3353,7 @@ declare module _ {
): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.every
*/
@@ -3175,7 +3378,7 @@ declare module _ {
): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.every
*/
@@ -3229,24 +3432,24 @@ declare module _ {
end?: number): List<TResult>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.fill
*/
fill<TResult>(
value: TResult,
start?: number,
- end?: number): LoDashArrayWrapper<TResult>;
+ end?: number): LoDashImplicitArrayWrapper<TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.fill
*/
fill<TResult>(
value: TResult,
start?: number,
- end?: number): LoDashObjectWrapper<List<TResult>>;
+ end?: number): LoDashImplicitObjectWrapper<List<TResult>>;
}
//_.filter
@@ -3418,62 +3621,62 @@ declare module _ {
whereValue: W): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.filter
**/
- filter(): LoDashArrayWrapper<T>;
+ filter(): LoDashImplicitArrayWrapper<T>;
/**
* @see _.filter
**/
filter(
callback: ListIterator<T, boolean>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.filter
* @param pluckValue _.pluck style callback
**/
filter(
- pluckValue: string): LoDashArrayWrapper<T>;
+ pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.filter
* @param pluckValue _.pluck style callback
**/
filter<W>(
- whereValue: W): LoDashArrayWrapper<T>;
+ whereValue: W): LoDashImplicitArrayWrapper<T>;
/**
* @see _.filter
**/
select(
callback: ListIterator<T, boolean>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.filter
* @param pluckValue _.pluck style callback
**/
select(
- pluckValue: string): LoDashArrayWrapper<T>;
+ pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.filter
* @param pluckValue _.pluck style callback
**/
select<W>(
- whereValue: W): LoDashArrayWrapper<T>;
+ whereValue: W): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.filter
**/
filter<T extends {}>(
callback: ObjectIterator<T, boolean>,
- thisArg?: any): LoDashObjectWrapper<T>;
+ thisArg?: any): LoDashImplicitObjectWrapper<T>;
}
//_.find
@@ -3531,7 +3734,7 @@ declare module _ {
): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.find
*/
@@ -3556,7 +3759,7 @@ declare module _ {
): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.find
*/
@@ -3736,7 +3939,7 @@ declare module _ {
pluckValue: string): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.findLast
*/
@@ -3833,36 +4036,36 @@ declare module _ {
thisArg?: any): T
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.forEach
**/
forEach(
callback: ListIterator<T, void>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.forEach
**/
each(
callback: ListIterator<T, void>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.forEach
**/
forEach<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<T>;
+ thisArg?: any): LoDashImplicitObjectWrapper<T>;
/**
* @see _.forEach
**/
each<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<T>;
+ thisArg?: any): LoDashImplicitObjectWrapper<T>;
}
//_.forEachRight
@@ -3923,29 +4126,29 @@ declare module _ {
thisArg?: any): Dictionary<T>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.forEachRight
**/
forEachRight(
callback: ListIterator<T, void>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.forEachRight
**/
eachRight(
callback: ListIterator<T, void>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.forEachRight
**/
forEachRight<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<Dictionary<T>>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<T>>;
/**
* @see _.forEachRight
@@ -3955,7 +4158,7 @@ declare module _ {
**/
eachRight<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<Dictionary<T>>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<T>>;
}
//_.groupBy
@@ -4045,46 +4248,46 @@ declare module _ {
whereValue: W): Dictionary<TValue[]>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.groupBy
**/
groupBy(
callback: ListIterator<T, any>,
- thisArg?: any): _.LoDashObjectWrapper<_.Dictionary<T[]>>;
+ thisArg?: any): _.LoDashImplicitObjectWrapper<_.Dictionary<T[]>>;
/**
* @see _.groupBy
**/
groupBy(
- pluckValue: string): _.LoDashObjectWrapper<_.Dictionary<T[]>>;
+ pluckValue: string): _.LoDashImplicitObjectWrapper<_.Dictionary<T[]>>;
/**
* @see _.groupBy
**/
groupBy<W>(
- whereValue: W): _.LoDashObjectWrapper<_.Dictionary<T[]>>;
+ whereValue: W): _.LoDashImplicitObjectWrapper<_.Dictionary<T[]>>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.groupBy
**/
groupBy<TValue>(
callback: ListIterator<TValue, any>,
- thisArg?: any): _.LoDashObjectWrapper<_.Dictionary<TValue[]>>;
+ thisArg?: any): _.LoDashImplicitObjectWrapper<_.Dictionary<TValue[]>>;
/**
* @see _.groupBy
**/
groupBy<TValue>(
- pluckValue: string): _.LoDashObjectWrapper<_.Dictionary<TValue[]>>;
+ pluckValue: string): _.LoDashImplicitObjectWrapper<_.Dictionary<TValue[]>>;
/**
* @see _.groupBy
**/
groupBy<W, TValue>(
- whereValue: W): _.LoDashObjectWrapper<_.Dictionary<TValue[]>>;
+ whereValue: W): _.LoDashImplicitObjectWrapper<_.Dictionary<TValue[]>>;
}
//_.indexBy
@@ -4286,52 +4489,52 @@ declare module _ {
): boolean[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.map
*/
map<TResult>(
iteratee?: ListIterator<T, TResult>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
map<TResult>(
iteratee?: string
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
map<TObject extends {}>(
iteratee?: TObject
- ): LoDashArrayWrapper<boolean>;
+ ): LoDashImplicitArrayWrapper<boolean>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.map
*/
map<TValue, TResult>(
iteratee?: ListIterator<TValue, TResult>|DictionaryIterator<TValue, TResult>,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
map<TValue, TResult>(
iteratee?: string
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.map
*/
map<TObject extends {}>(
iteratee?: TObject
- ): LoDashArrayWrapper<boolean>;
+ ): LoDashImplicitArrayWrapper<boolean>;
}
//_.ceil
@@ -4345,7 +4548,7 @@ declare module _ {
ceil(n: number, precision?: number): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.ceil
*/
@@ -4363,7 +4566,7 @@ declare module _ {
floor(n: number, precision?: number): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.floor
*/
@@ -4381,7 +4584,7 @@ declare module _ {
round(n: number, precision?: number): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.round
*/
@@ -4462,7 +4665,7 @@ declare module _ {
property: string): number;
}
- interface LoDashNumberArrayWrapper {
+ interface LoDashImplicitNumberArrayWrapper {
/**
* @see _.sum
**/
@@ -4476,7 +4679,7 @@ declare module _ {
thisArg?: any): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.sum
**/
@@ -4497,7 +4700,7 @@ declare module _ {
property: string): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.sum
**/
@@ -4545,20 +4748,20 @@ declare module _ {
property: string|string[]): any[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.pluck
**/
pluck<TResult>(
- property: string): LoDashArrayWrapper<TResult>;
+ property: string): LoDashImplicitArrayWrapper<TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.pluck
**/
pluck<TResult>(
- property: string): LoDashArrayWrapper<TResult>;
+ property: string): LoDashImplicitArrayWrapper<TResult>;
}
//_.partition
@@ -4640,73 +4843,73 @@ declare module _ {
pluckValue: string): T[][];
}
- interface LoDashStringWrapper {
+ interface LoDashImplicitStringWrapper {
/**
* @see _.partition
*/
partition(
callback: ListIterator<string, boolean>,
- thisArg?: any): LoDashArrayWrapper<string[]>;
+ thisArg?: any): LoDashImplicitArrayWrapper<string[]>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.partition
*/
partition(
callback: ListIterator<T, boolean>,
- thisArg?: any): LoDashArrayWrapper<T[]>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T[]>;
/**
* @see _.partition
*/
partition<W>(
- whereValue: W): LoDashArrayWrapper<T[]>;
+ whereValue: W): LoDashImplicitArrayWrapper<T[]>;
/**
* @see _.partition
*/
partition(
path: string,
- srcValue: any): LoDashArrayWrapper<T[]>;
+ srcValue: any): LoDashImplicitArrayWrapper<T[]>;
/**
* @see _.partition
*/
partition(
- pluckValue: string): LoDashArrayWrapper<T[]>;
+ pluckValue: string): LoDashImplicitArrayWrapper<T[]>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.partition
*/
partition<TResult>(
callback: ListIterator<TResult, boolean>,
- thisArg?: any): LoDashArrayWrapper<TResult[]>;
+ thisArg?: any): LoDashImplicitArrayWrapper<TResult[]>;
/**
* @see _.partition
*/
partition<TResult>(
callback: DictionaryIterator<TResult, boolean>,
- thisArg?: any): LoDashArrayWrapper<TResult[]>;
+ thisArg?: any): LoDashImplicitArrayWrapper<TResult[]>;
/**
* @see _.partition
*/
partition<W, TResult>(
- whereValue: W): LoDashArrayWrapper<TResult[]>;
+ whereValue: W): LoDashImplicitArrayWrapper<TResult[]>;
/**
* @see _.partition
*/
partition<TResult>(
path: string,
- srcValue: any): LoDashArrayWrapper<TResult[]>;
+ srcValue: any): LoDashImplicitArrayWrapper<TResult[]>;
/**
* @see _.partition
*/
partition<TResult>(
- pluckValue: string): LoDashArrayWrapper<TResult[]>;
+ pluckValue: string): LoDashImplicitArrayWrapper<TResult[]>;
}
//_.reduce
@@ -4874,7 +5077,7 @@ declare module _ {
thisArg?: any): TResult;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.reduce
**/
@@ -4921,7 +5124,7 @@ declare module _ {
thisArg?: any): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.reduce
**/
@@ -5165,25 +5368,25 @@ declare module _ {
whereValue: W): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.reject
**/
reject(
callback: ListIterator<T, boolean>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.reject
* @param pluckValue _.pluck style callback
**/
- reject(pluckValue: string): LoDashArrayWrapper<T>;
+ reject(pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.reject
* @param whereValue _.where style callback
**/
- reject<W>(whereValue: W): LoDashArrayWrapper<T>;
+ reject<W>(whereValue: W): LoDashImplicitArrayWrapper<T>;
}
//_.sample
@@ -5224,16 +5427,16 @@ declare module _ {
sample<T>(collection: Dictionary<T>, n: number): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.sample
**/
- sample(n: number): LoDashArrayWrapper<T>;
+ sample(n: number): LoDashImplicitArrayWrapper<T>;
/**
* @see _.sample
**/
- sample(): LoDashWrapper<T>;
+ sample(): LoDashImplicitWrapper<T>;
}
//_.shuffle
@@ -5257,18 +5460,18 @@ declare module _ {
shuffle<T>(collection: Dictionary<T>): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.shuffle
**/
- shuffle(): LoDashArrayWrapper<T>;
+ shuffle(): LoDashImplicitArrayWrapper<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.shuffle
**/
- shuffle(): LoDashArrayWrapper<T>;
+ shuffle(): LoDashImplicitArrayWrapper<T>;
}
//_.size
@@ -5301,14 +5504,14 @@ declare module _ {
size(aString: string): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.size
**/
size(): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.size
**/
@@ -5371,7 +5574,7 @@ declare module _ {
): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.some
*/
@@ -5396,7 +5599,7 @@ declare module _ {
): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.some
*/
@@ -5497,31 +5700,31 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.sortBy
**/
sortBy<TSort>(
iteratee?: ListIterator<T, TSort>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ thisArg?: any): LoDashImplicitArrayWrapper<T>;
/**
* @see _.sortBy
* @param pluckValue _.pluck style callback
**/
- sortBy(pluckValue: string): LoDashArrayWrapper<T>;
+ sortBy(pluckValue: string): LoDashImplicitArrayWrapper<T>;
/**
* @see _.sortBy
* @param whereValue _.where style callback
**/
- sortBy<W>(whereValue: W): LoDashArrayWrapper<T>;
+ sortBy<W>(whereValue: W): LoDashImplicitArrayWrapper<T>;
/**
* Sorts by all the given arguments, using either ListIterator, pluckValue, or whereValue foramts
* @param args The rules by which to sort
*/
- sortByAll(...args: (ListIterator<T, boolean>|Object|string)[]): LoDashArrayWrapper<T>;
+ sortByAll(...args: (ListIterator<T, boolean>|Object|string)[]): LoDashImplicitArrayWrapper<T>;
}
//_.sortByAll
@@ -5570,18 +5773,18 @@ declare module _ {
...iteratees: (ListIterator<T, any>|string|Object)[]): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.sortByAll
**/
sortByAll(
- iteratees: (ListIterator<T, any>|string|Object)[]): LoDashArrayWrapper<T>;
+ iteratees: (ListIterator<T, any>|string|Object)[]): LoDashImplicitArrayWrapper<T>;
/**
* @see _.sortByAll
**/
sortByAll(
- ...iteratees: (ListIterator<T, any>|string|Object)[]): LoDashArrayWrapper<T>;
+ ...iteratees: (ListIterator<T, any>|string|Object)[]): LoDashImplicitArrayWrapper<T>;
}
//_.sortByOrder
@@ -5633,54 +5836,20 @@ declare module _ {
orders?: string[]): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.sortByOrder
**/
sortByOrder(
iteratees: (ListIterator<T, any>|string|Object)[],
- orders?: boolean[]): LoDashArrayWrapper<T>;
+ orders?: boolean[]): LoDashImplicitArrayWrapper<T>;
/**
* @see _.sortByOrder
**/
sortByOrder(
iteratees: (ListIterator<T, any>|string|Object)[],
- orders?: string[]): LoDashArrayWrapper<T>;
- }
-
- //_.toArray
- interface LoDashStatic {
- /**
- * Converts the collection to an array.
- * @param collection The collection to convert.
- * @return The new converted array.
- **/
- toArray<T>(collection: Array<T>): T[];
-
- /**
- * @see _.toArray
- **/
- toArray<T>(collection: List<T>): T[];
-
- /**
- * @see _.toArray
- **/
- toArray<T>(collection: Dictionary<T>): T[];
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.toArray
- **/
- toArray(): LoDashArrayWrapper<T>;
- }
-
- interface LoDashObjectWrapper<T> {
- /**
- * @see _.toArray
- **/
- toArray<TValue>(): LoDashArrayWrapper<TValue>;
+ orders?: string[]): LoDashImplicitArrayWrapper<T>;
}
//_.where
@@ -5711,11 +5880,11 @@ declare module _ {
properties: U): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.where
**/
- where<U extends {}>(properties: U): LoDashArrayWrapper<T>;
+ where<U extends {}>(properties: U): LoDashImplicitArrayWrapper<T>;
}
/********
@@ -5725,13 +5894,27 @@ declare module _ {
//_.now
interface LoDashStatic {
/**
- * Gets the number of milliseconds that have elapsed since the Unix epoch
- * (1 January 1970 00:00:00 UTC).
- * @return The number of milliseconds.
- **/
+ * Gets the number of milliseconds that have elapsed since the Unix epoch (1 January 1970 00:00:00 UTC).
+ *
+ * @return The number of milliseconds.
+ */
now(): number;
}
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.now
+ */
+ now(): number;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.now
+ */
+ now(): LoDashExplicitWrapper<number>;
+ }
+
/*************
* Functions *
*************/
@@ -5750,11 +5933,11 @@ declare module _ {
func: Function): Function;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.after
**/
- after(func: Function): LoDashObjectWrapper<Function>;
+ after(func: Function): LoDashImplicitObjectWrapper<Function>;
}
//_.ary
@@ -5769,11 +5952,11 @@ declare module _ {
ary<TResult extends Function>(func: Function, n?: number, guard?: Object): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.ary
*/
- ary<TResult extends Function>(n?: number, guard?: Object): LoDashObjectWrapper<TResult>;
+ ary<TResult extends Function>(n?: number, guard?: Object): LoDashImplicitObjectWrapper<TResult>;
}
//_.backflow
@@ -5784,11 +5967,11 @@ declare module _ {
backflow<TResult extends Function>(...funcs: Function[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.flowRight
**/
- backflow<TResult extends Function>(...funcs: Function[]): LoDashObjectWrapper<TResult>;
+ backflow<TResult extends Function>(...funcs: Function[]): LoDashImplicitObjectWrapper<TResult>;
}
//_.before
@@ -5804,7 +5987,7 @@ declare module _ {
before<TFunc extends Function>(n: number, func: TFunc): TFunc;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @sed _.before
*/
@@ -5827,13 +6010,13 @@ declare module _ {
...args: any[]): (...args: any[]) => any;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.bind
**/
bind(
thisArg: any,
- ...args: any[]): LoDashObjectWrapper<(...args: any[]) => any>;
+ ...args: any[]): LoDashImplicitObjectWrapper<(...args: any[]) => any>;
}
//_.bindAll
@@ -5852,11 +6035,11 @@ declare module _ {
...methodNames: string[]): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.bindAll
**/
- bindAll(...methodNames: string[]): LoDashWrapper<T>;
+ bindAll(...methodNames: string[]): LoDashImplicitWrapper<T>;
}
//_.bindKey
@@ -5877,13 +6060,13 @@ declare module _ {
...args: any[]): Function;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.bindKey
**/
bindKey(
key: string,
- ...args: any[]): LoDashObjectWrapper<Function>;
+ ...args: any[]): LoDashImplicitObjectWrapper<Function>;
}
//_.compose
@@ -5894,11 +6077,11 @@ declare module _ {
compose<TResult extends Function>(...funcs: Function[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.flowRight
*/
- compose<TResult extends Function>(...funcs: Function[]): LoDashObjectWrapper<TResult>;
+ compose<TResult extends Function>(...funcs: Function[]): LoDashImplicitObjectWrapper<TResult>;
}
//_.createCallback
@@ -5927,22 +6110,22 @@ declare module _ {
argCount?: number): () => boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.createCallback
**/
createCallback(
thisArg?: any,
- argCount?: number): LoDashObjectWrapper<() => any>;
+ argCount?: number): LoDashImplicitObjectWrapper<() => any>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.createCallback
**/
createCallback(
thisArg?: any,
- argCount?: number): LoDashObjectWrapper<() => any>;
+ argCount?: number): LoDashImplicitObjectWrapper<() => any>;
}
//_.curry
@@ -6040,11 +6223,11 @@ declare module _ {
(t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.curry
**/
- curry<TResult extends Function>(arity?: number): LoDashObjectWrapper<TResult>;
+ curry<TResult extends Function>(arity?: number): LoDashImplicitObjectWrapper<TResult>;
}
//_.curryRight
@@ -6101,11 +6284,11 @@ declare module _ {
arity?: number): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.curryRight
**/
- curryRight<TResult extends Function>(arity?: number): LoDashObjectWrapper<TResult>;
+ curryRight<TResult extends Function>(arity?: number): LoDashImplicitObjectWrapper<TResult>;
}
//_.debounce
@@ -6133,13 +6316,13 @@ declare module _ {
options?: DebounceSettings): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.debounce
**/
debounce(
wait: number,
- options?: DebounceSettings): LoDashObjectWrapper<Function>;
+ options?: DebounceSettings): LoDashImplicitObjectWrapper<Function>;
}
interface DebounceSettings {
@@ -6173,11 +6356,11 @@ declare module _ {
...args: any[]): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.defer
**/
- defer(...args: any[]): LoDashWrapper<number>;
+ defer(...args: any[]): LoDashImplicitWrapper<number>;
}
//_.delay
@@ -6196,13 +6379,13 @@ declare module _ {
...args: any[]): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.delay
**/
delay(
wait: number,
- ...args: any[]): LoDashWrapper<number>;
+ ...args: any[]): LoDashImplicitWrapper<number>;
}
//_.flow
@@ -6216,11 +6399,11 @@ declare module _ {
flow<TResult extends Function>(...funcs: Function[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.flow
**/
- flow<TResult extends Function>(...funcs: Function[]): LoDashObjectWrapper<TResult>;
+ flow<TResult extends Function>(...funcs: Function[]): LoDashImplicitObjectWrapper<TResult>;
}
//_.flowRight
@@ -6234,11 +6417,11 @@ declare module _ {
flowRight<TResult extends Function>(...funcs: Function[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.flowRight
**/
- flowRight<TResult extends Function>(...funcs: Function[]): LoDashObjectWrapper<TResult>;
+ flowRight<TResult extends Function>(...funcs: Function[]): LoDashImplicitObjectWrapper<TResult>;
}
//_.memoize
@@ -6261,11 +6444,11 @@ declare module _ {
resolver?: Function): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.memoize
*/
- memoize<TResult extends MemoizedFunction>(resolver?: Function): LoDashObjectWrapper<TResult>;
+ memoize<TResult extends MemoizedFunction>(resolver?: Function): LoDashImplicitObjectWrapper<TResult>;
}
//_.modArgs
@@ -6291,16 +6474,16 @@ declare module _ {
): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.modArgs
*/
- modArgs<TResult extends Function>(...transforms: Function[]): LoDashObjectWrapper<TResult>;
+ modArgs<TResult extends Function>(...transforms: Function[]): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.modArgs
*/
- modArgs<TResult extends Function>(transforms: Function[]): LoDashObjectWrapper<TResult>;
+ modArgs<TResult extends Function>(transforms: Function[]): LoDashImplicitObjectWrapper<TResult>;
}
//_.negate
@@ -6319,16 +6502,16 @@ declare module _ {
negate<T extends Function, TResult extends Function>(predicate: T): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.negate
*/
- negate(): LoDashObjectWrapper<(...args: any[]) => boolean>;
+ negate(): LoDashImplicitObjectWrapper<(...args: any[]) => boolean>;
/**
* @see _.negate
*/
- negate<TResult extends Function>(): LoDashObjectWrapper<TResult>;
+ negate<TResult extends Function>(): LoDashImplicitObjectWrapper<TResult>;
}
//_.once
@@ -6343,11 +6526,11 @@ declare module _ {
once<T extends Function>(func: T): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.once
*/
- once(): LoDashObjectWrapper<T>;
+ once(): LoDashImplicitObjectWrapper<T>;
}
//_.partial
@@ -6397,16 +6580,16 @@ declare module _ {
rearg<TResult extends Function>(func: Function, ...indexes: number[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.rearg
*/
- rearg<TResult extends Function>(indexes: number[]): LoDashObjectWrapper<TResult>;
+ rearg<TResult extends Function>(indexes: number[]): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.rearg
*/
- rearg<TResult extends Function>(...indexes: number[]): LoDashObjectWrapper<TResult>;
+ rearg<TResult extends Function>(...indexes: number[]): LoDashImplicitObjectWrapper<TResult>;
}
//_.restParam
@@ -6426,11 +6609,11 @@ declare module _ {
restParam<TResult extends Function, TFunc extends Function>(func: TFunc, start?: number): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.restParam
*/
- restParam<TResult extends Function>(start?: number): LoDashObjectWrapper<TResult>;
+ restParam<TResult extends Function>(start?: number): LoDashImplicitObjectWrapper<TResult>;
}
//_.spread
@@ -6444,11 +6627,11 @@ declare module _ {
spread<TResult extends Function>(func: Function): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.spread
*/
- spread<TResult extends Function>(): LoDashObjectWrapper<TResult>;
+ spread<TResult extends Function>(): LoDashImplicitObjectWrapper<TResult>;
}
@@ -6538,7 +6721,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.clone
*/
@@ -6555,7 +6738,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.clone
*/
@@ -6572,7 +6755,7 @@ declare module _ {
thisArg?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.clone
*/
@@ -6609,7 +6792,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.cloneDeep
*/
@@ -6618,7 +6801,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.cloneDeep
*/
@@ -6627,7 +6810,7 @@ declare module _ {
thisArg?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.cloneDeep
*/
@@ -6636,6 +6819,30 @@ declare module _ {
thisArg?: any): T;
}
+ //_.eq
+ interface LoDashStatic {
+ /**
+ * @see _.isEqual
+ */
+ eq(
+ value: any,
+ other: any,
+ customizer?: IsEqualCustomizer,
+ thisArg?: any
+ ): boolean;
+ }
+
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.isEqual
+ */
+ eq(
+ other: any,
+ customizer?: IsEqualCustomizer,
+ thisArg?: any
+ ): boolean;
+ }
+
//_.gt
interface LoDashStatic {
/**
@@ -6647,7 +6854,7 @@ declare module _ {
gt(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.gt
*/
@@ -6665,7 +6872,7 @@ declare module _ {
gte(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.gte
*/
@@ -6682,7 +6889,7 @@ declare module _ {
isArguments(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isArguments
*/
@@ -6699,7 +6906,7 @@ declare module _ {
isArray(value?: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.isArray
*/
@@ -6716,7 +6923,7 @@ declare module _ {
isBoolean(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isBoolean
*/
@@ -6733,7 +6940,7 @@ declare module _ {
isDate(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isDate
*/
@@ -6750,7 +6957,7 @@ declare module _ {
isElement(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isElement
*/
@@ -6768,13 +6975,56 @@ declare module _ {
isEmpty(value?: any[]|Dictionary<any>|string|any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.isEmpty
*/
isEmpty(): boolean;
}
+ //_.isEqual
+ interface IsEqualCustomizer {
+ (value: any, other: any, indexOrKey?: number|string): boolean;
+ }
+
+ interface LoDashStatic {
+ /**
+ * Performs a deep comparison between two values to determine if they are equivalent. If customizer is
+ * provided it’s invoked to compare values. If customizer returns undefined comparisons are handled by the
+ * method instead. The customizer is bound to thisArg and invoked with up to three arguments: (value, other
+ * [, index|key]).
+ *
+ * Note: This method supports comparing arrays, booleans, Date objects, numbers, Object objects, regexes,
+ * and strings. Objects are compared by their own, not inherited, enumerable properties. Functions and DOM
+ * nodes are not supported. Provide a customizer function to extend support for comparing other values.
+ *
+ * @alias _.eq
+ *
+ * @param value The value to compare.
+ * @param other The other value to compare.
+ * @param customizer The function to customize value comparisons.
+ * @param thisArg The this binding of customizer.
+ * @return Returns true if the values are equivalent, else false.
+ */
+ isEqual(
+ value: any,
+ other: any,
+ customizer?: IsEqualCustomizer,
+ thisArg?: any
+ ): boolean;
+ }
+
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.isEqual
+ */
+ isEqual(
+ other: any,
+ customizer?: IsEqualCustomizer,
+ thisArg?: any
+ ): boolean;
+ }
+
//_.isError
interface LoDashStatic {
/**
@@ -6786,7 +7036,7 @@ declare module _ {
isError(value: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isError
*/
@@ -6804,7 +7054,7 @@ declare module _ {
isFinite(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isFinite
*/
@@ -6821,7 +7071,7 @@ declare module _ {
isFunction(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isFunction
*/
@@ -6848,7 +7098,7 @@ declare module _ {
isMatch(object: Object, source: Object, customizer?: isMatchCustomizer, thisArg?: any): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.isMatch
*/
@@ -6866,7 +7116,7 @@ declare module _ {
isNaN(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isNaN
*/
@@ -6883,7 +7133,7 @@ declare module _ {
isNative(value: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isNative
*/
@@ -6900,7 +7150,7 @@ declare module _ {
isNull(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isNull
*/
@@ -6918,7 +7168,7 @@ declare module _ {
isNumber(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isNumber
*/
@@ -6936,7 +7186,7 @@ declare module _ {
isObject(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isObject
*/
@@ -6957,7 +7207,7 @@ declare module _ {
isPlainObject(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isPlainObject
*/
@@ -6974,7 +7224,7 @@ declare module _ {
isRegExp(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isRegExp
*/
@@ -6991,7 +7241,7 @@ declare module _ {
isString(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isString
*/
@@ -7008,7 +7258,7 @@ declare module _ {
isTypedArray(value: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isTypedArray
*/
@@ -7025,7 +7275,7 @@ declare module _ {
isUndefined(value: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isUndefined
*/
@@ -7043,7 +7293,7 @@ declare module _ {
lt(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.lt
*/
@@ -7061,13 +7311,65 @@ declare module _ {
lte(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.lte
*/
lte(other: any): boolean;
}
+ //_.toArray
+ interface LoDashStatic {
+ /**
+ * Converts value to an array.
+ *
+ * @param value The value to convert.
+ * @return Returns the converted array.
+ */
+ toArray(value: string): string[];
+
+ /**
+ * @see _.toArray
+ */
+ toArray<T>(value: List<T>|Dictionary<T>): T[];
+
+ /**
+ * @see _.toArray
+ */
+ toArray<TValue, TResult>(value: TValue): TResult[];
+
+ /**
+ * @see _.toArray
+ */
+ toArray<TValue>(value: TValue): any[];
+
+ /**
+ * @see _.toArray
+ */
+ toArray(value?: any): any[];
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.toArray
+ */
+ toArray<TResult>(): LoDashImplicitArrayWrapper<TResult>;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.toArray
+ */
+ toArray(): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.toArray
+ */
+ toArray<TResult>(): LoDashImplicitArrayWrapper<TResult>;
+ }
+
//_.toPlainObject
interface LoDashStatic {
/**
@@ -7080,11 +7382,11 @@ declare module _ {
toPlainObject<TResult extends {}>(value?: any): TResult;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.toPlainObject
*/
- toPlainObject<TResult extends {}>(): LoDashObjectWrapper<TResult>;
+ toPlainObject<TResult extends {}>(): LoDashImplicitObjectWrapper<TResult>;
}
/********
@@ -7102,7 +7404,7 @@ declare module _ {
add(augend: number, addend: number): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.add
*/
@@ -7163,7 +7465,7 @@ declare module _ {
): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.max
*/
@@ -7188,7 +7490,7 @@ declare module _ {
): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.max
*/
@@ -7267,7 +7569,7 @@ declare module _ {
): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.min
*/
@@ -7292,7 +7594,7 @@ declare module _ {
): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.min
*/
@@ -7340,7 +7642,7 @@ declare module _ {
inRange(n: number, end: number): boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.inRange
*/
@@ -7384,7 +7686,7 @@ declare module _ {
random(floating?: boolean): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.random
*/
@@ -7498,7 +7800,7 @@ declare module _ {
thisArg?: any): Result;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.assign
**/
@@ -7607,11 +7909,11 @@ declare module _ {
create<TResult extends {}>(prototype: Object, properties?: Object): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.create
*/
- create<TResult extends {}>(properties?: Object): LoDashObjectWrapper<TResult>;
+ create<TResult extends {}>(properties?: Object): LoDashImplicitObjectWrapper<TResult>;
}
//_.defaults
@@ -7629,11 +7931,11 @@ declare module _ {
...sources: any[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.defaults
**/
- defaults<T, TResult>(...sources: any[]): LoDashObjectWrapper<TResult>
+ defaults<T, TResult>(...sources: any[]): LoDashImplicitObjectWrapper<TResult>
}
//_.defaultsDeep
@@ -7649,11 +7951,11 @@ declare module _ {
...sources: any[]): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.defaultsDeep
**/
- defaultsDeep<TResult>(...sources: any[]): LoDashObjectWrapper<TResult>
+ defaultsDeep<TResult>(...sources: any[]): LoDashImplicitObjectWrapper<TResult>
}
//_.findKey
@@ -7709,7 +8011,7 @@ declare module _ {
): string;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.findKey
*/
@@ -7745,32 +8047,86 @@ declare module _ {
//_.findLastKey
interface LoDashStatic {
/**
- * This method is like _.findKey except that it iterates over elements of a collection in the opposite order.
- * @param object The object to search.
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- * @return The key of the found element, else undefined.
- **/
- findLastKey(
- object: any,
- callback: (value: any) => boolean,
- thisArg?: any): string;
+ * This method is like _.findKey except that it iterates over elements of a collection in the opposite order.
+ *
+ * If a property name is provided for predicate the created _.property style callback returns the property
+ * value of the given element.
+ *
+ * If a value is also provided for thisArg the created _.matchesProperty style callback returns true for
+ * elements that have a matching property value, else false.
+ *
+ * If an object is provided for predicate the created _.matches style callback returns true for elements that
+ * have the properties of the given object, else false.
+ *
+ * @param object The object to search.
+ * @param predicate The function invoked per iteration.
+ * @param thisArg The this binding of predicate.
+ * @return Returns the key of the matched element, else undefined.
+ */
+ findLastKey<TValues, TObject>(
+ object: TObject,
+ predicate?: DictionaryIterator<TValues, boolean>,
+ thisArg?: any
+ ): string;
/**
- * @see _.findLastKey
- * @param pluckValue _.pluck style callback
- **/
- findLastKey(
- object: any,
- pluckValue: string): string;
+ * @see _.findLastKey
+ */
+ findLastKey<TObject>(
+ object: TObject,
+ predicate?: ObjectIterator<any, boolean>,
+ thisArg?: any
+ ): string;
/**
- * @see _.findLastKey
- * @param whereValue _.where style callback
- **/
- findLastKey<W extends Dictionary<any>, T>(
- object: T,
- whereValue: W): string;
+ * @see _.findLastKey
+ */
+ findLastKey<TObject>(
+ object: TObject,
+ predicate?: string,
+ thisArg?: any
+ ): string;
+
+ /**
+ * @see _.findLastKey
+ */
+ findLastKey<TWhere extends Dictionary<any>, TObject>(
+ object: TObject,
+ predicate?: TWhere
+ ): string;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.findLastKey
+ */
+ findLastKey<TValues>(
+ predicate?: DictionaryIterator<TValues, boolean>,
+ thisArg?: any
+ ): string;
+
+ /**
+ * @see _.findLastKey
+ */
+ findLastKey(
+ predicate?: ObjectIterator<any, boolean>,
+ thisArg?: any
+ ): string;
+
+ /**
+ * @see _.findLastKey
+ */
+ findLastKey(
+ predicate?: string,
+ thisArg?: any
+ ): string;
+
+ /**
+ * @see _.findLastKey
+ */
+ findLastKey<TWhere extends Dictionary<any>>(
+ predicate?: TWhere
+ ): string;
}
//_.forIn
@@ -7798,13 +8154,13 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.forIn
**/
forIn<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): _.LoDashObjectWrapper<T>;
+ thisArg?: any): _.LoDashImplicitObjectWrapper<T>;
}
//_.forInRight
@@ -7831,13 +8187,13 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.forInRight
**/
forInRight<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): _.LoDashObjectWrapper<T>;
+ thisArg?: any): _.LoDashImplicitObjectWrapper<T>;
}
//_.forOwn
@@ -7865,13 +8221,13 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.forOwn
**/
forOwn<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): _.LoDashObjectWrapper<T>;
+ thisArg?: any): _.LoDashImplicitObjectWrapper<T>;
}
//_.forOwnRight
@@ -7897,13 +8253,13 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.forOwnRight
**/
forOwnRight<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): _.LoDashObjectWrapper<T>;
+ thisArg?: any): _.LoDashImplicitObjectWrapper<T>;
}
//_.functions
@@ -7922,16 +8278,16 @@ declare module _ {
methods(object: any): string[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.functions
**/
- functions(): _.LoDashArrayWrapper<string>;
+ functions(): _.LoDashImplicitArrayWrapper<string>;
/**
* @see _.functions
**/
- methods(): _.LoDashArrayWrapper<string>;
+ methods(): _.LoDashImplicitArrayWrapper<string>;
}
//_.get
@@ -7950,7 +8306,7 @@ declare module _ {
): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.get
**/
@@ -7971,7 +8327,7 @@ declare module _ {
has(object: any, path: string|number|boolean|Array<string|number|boolean>): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.has
*/
@@ -7991,91 +8347,11 @@ declare module _ {
invert<T extends {}, TResult extends {}>(object: T, multiValue?: boolean): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.invert
*/
- invert<TResult extends {}>(multiValue?: boolean): LoDashObjectWrapper<TResult>;
- }
-
- //_.isEqual
- interface EqCustomizer {
- (value: any, other: any, indexOrKey?: number|string): boolean;
- }
-
- interface LoDashStatic {
- /**
- * Performs a deep comparison between two values to determine if they are equivalent. If customizer is
- * provided it is invoked to compare values. If customizer returns undefined comparisons are handled
- * by the method instead. The customizer is bound to thisArg and invoked with three
- * arguments: (value, other [, index|key]).
- * @param value The value to compare.
- * @param other The other value to compare.
- * @param callback The function to customize value comparisons.
- * @param thisArg The this binding of customizer.
- * @return True if the values are equivalent, else false.
- */
- isEqual(value?: any,
- other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
-
- /**
- * @see _.isEqual
- */
- eq(value?: any,
- other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
- }
-
- interface LoDashWrapper<T> {
- /**
- * @see _.isEqual
- */
- isEqual(other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
-
- /**
- * @see _.isEqual
- */
- eq(other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
-
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.isEqual
- */
- isEqual(other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
-
- /**
- * @see _.isEqual
- */
- eq(other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
- }
-
- interface LoDashObjectWrapper<T> {
- /**
- * @see _.isEqual
- */
- isEqual(other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
-
- /**
- * @see _.isEqual
- */
- eq(other?: any,
- callback?: EqCustomizer,
- thisArg?: any): boolean;
+ invert<TResult extends {}>(multiValue?: boolean): LoDashImplicitObjectWrapper<TResult>;
}
//_.keys
@@ -8088,11 +8364,11 @@ declare module _ {
keys(object?: any): string[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.keys
**/
- keys(): LoDashArrayWrapper<string>
+ keys(): LoDashImplicitArrayWrapper<string>
}
//_.keysIn
@@ -8105,11 +8381,11 @@ declare module _ {
keysIn(object?: any): string[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.keysIn
**/
- keysIn(): LoDashArrayWrapper<string>
+ keysIn(): LoDashImplicitArrayWrapper<string>
}
//_.mapKeys
@@ -8155,52 +8431,52 @@ declare module _ {
): Dictionary<T>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.mapKeys
*/
mapKeys<TKey>(
iteratee?: ListIterator<T, TKey>,
thisArg?: any
- ): LoDashObjectWrapper<Dictionary<T>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<T>>;
/**
* @see _.mapKeys
*/
mapKeys<TObject extends {}>(
iteratee?: TObject
- ): LoDashObjectWrapper<Dictionary<T>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<T>>;
/**
* @see _.mapKeys
*/
mapKeys(
iteratee?: string
- ): LoDashObjectWrapper<Dictionary<T>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<T>>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.mapKeys
*/
mapKeys<TResult, TKey>(
iteratee?: ListIterator<TResult, TKey>|DictionaryIterator<TResult, TKey>,
thisArg?: any
- ): LoDashObjectWrapper<Dictionary<TResult>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
/**
* @see _.mapKeys
*/
mapKeys<TResult, TObject extends {}>(
iteratee?: TObject
- ): LoDashObjectWrapper<Dictionary<TResult>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
/**
* @see _.mapKeys
*/
mapKeys<TResult>(
iteratee?: string
- ): LoDashObjectWrapper<Dictionary<TResult>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
}
//_.mapValues
@@ -8230,34 +8506,34 @@ declare module _ {
mapValues<T>(obj: T, callback: ObjectIterator<any, any>, thisArg?: any): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.mapValues
* TValue is the type of the property values of T.
* TResult is the type output by the ObjectIterator function
*/
- mapValues<TValue, TResult>(callback: ObjectIterator<TValue, TResult>, thisArg?: any): LoDashObjectWrapper<Dictionary<TResult>>;
+ mapValues<TValue, TResult>(callback: ObjectIterator<TValue, TResult>, thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
/**
* @see _.mapValues
* TResult is the type of the property specified by pluck.
* T should be a Dictionary<Dictionary<TResult>>
*/
- mapValues<TResult>(pluck: string): LoDashObjectWrapper<Dictionary<TResult>>;
+ mapValues<TResult>(pluck: string): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
/**
* @see _.mapValues
* TResult is the type of the properties on the object specified by pluck.
* T should be a Dictionary<Dictionary<Dictionary<TResult>>>
*/
- mapValues<TResult>(pluck: string, where: Dictionary<TResult>): LoDashArrayWrapper<Dictionary<boolean>>;
+ mapValues<TResult>(pluck: string, where: Dictionary<TResult>): LoDashImplicitArrayWrapper<Dictionary<boolean>>;
/**
* @see _.mapValues
* TResult is the type of the properties of each object in the values of T
* T should be a Dictionary<Dictionary<TResult>>
*/
- mapValues<TResult>(where: Dictionary<TResult>): LoDashArrayWrapper<boolean>;
+ mapValues<TResult>(where: Dictionary<TResult>): LoDashImplicitArrayWrapper<boolean>;
}
//_.merge
@@ -8331,7 +8607,7 @@ declare module _ {
): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.merge
*/
@@ -8339,7 +8615,7 @@ declare module _ {
source: TSource,
customizer?: MergeCustomizer,
thisArg?: any
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.merge
@@ -8349,7 +8625,7 @@ declare module _ {
source2: TSource2,
customizer?: MergeCustomizer,
thisArg?: any
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.merge
@@ -8360,7 +8636,7 @@ declare module _ {
source3: TSource3,
customizer?: MergeCustomizer,
thisArg?: any
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.merge
@@ -8372,14 +8648,14 @@ declare module _ {
source4: TSource4,
customizer?: MergeCustomizer,
thisArg?: any
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.merge
*/
merge<TResult>(
...otherArgs: any[]
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
}
//_.omit
@@ -8414,25 +8690,25 @@ declare module _ {
thisArg?: any): Omitted;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.omit
**/
omit<Omitted>(
- ...keys: string[]): LoDashObjectWrapper<Omitted>;
+ ...keys: string[]): LoDashImplicitObjectWrapper<Omitted>;
/**
* @see _.omit
**/
omit<Omitted>(
- keys: string[]): LoDashObjectWrapper<Omitted>;
+ keys: string[]): LoDashImplicitObjectWrapper<Omitted>;
/**
* @see _.omit
**/
omit<Omitted>(
callback: ObjectIterator<any, boolean>,
- thisArg?: any): LoDashObjectWrapper<Omitted>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Omitted>;
}
//_.pairs
@@ -8446,11 +8722,11 @@ declare module _ {
pairs(object?: any): any[][];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.pairs
**/
- pairs(): LoDashArrayWrapper<any[]>;
+ pairs(): LoDashImplicitArrayWrapper<any[]>;
}
//_.pick
@@ -8482,21 +8758,21 @@ declare module _ {
): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.pick
*/
pick<TResult extends Object>(
predicate: ObjectIterator<any, boolean>,
thisArg?: any
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.pick
*/
pick<TResult extends Object>(
...predicate: Array<string|number|boolean|Array<string|number|boolean>>
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
}
//_.result
@@ -8517,7 +8793,7 @@ declare module _ {
): TResult;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.result
*/
@@ -8544,14 +8820,14 @@ declare module _ {
): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.set
*/
set(
path: StringRepresentable|StringRepresentable[],
value: any
- ): LoDashObjectWrapper<T>;
+ ): LoDashImplicitObjectWrapper<T>;
}
//_.transform
@@ -8606,7 +8882,7 @@ declare module _ {
): TResult[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.transform
*/
@@ -8614,7 +8890,7 @@ declare module _ {
iteratee?: MemoVoidArrayIterator<T, TResult[]>,
accumulator?: TResult[],
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.transform
@@ -8623,10 +8899,10 @@ declare module _ {
iteratee?: MemoVoidArrayIterator<T, Dictionary<TResult>>,
accumulator?: Dictionary<TResult>,
thisArg?: any
- ): LoDashObjectWrapper<Dictionary<TResult>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.transform
*/
@@ -8634,7 +8910,7 @@ declare module _ {
iteratee?: MemoVoidDictionaryIterator<T, Dictionary<TResult>>,
accumulator?: Dictionary<TResult>,
thisArg?: any
- ): LoDashObjectWrapper<Dictionary<TResult>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
/**
* @see _.transform
@@ -8643,7 +8919,7 @@ declare module _ {
iteratee?: MemoVoidDictionaryIterator<T, TResult[]>,
accumulator?: TResult[],
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
}
//_.values
@@ -8656,11 +8932,11 @@ declare module _ {
values<T>(object?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.values
**/
- values<TResult>(): LoDashObjectWrapper<TResult[]>;
+ values<TResult>(): LoDashImplicitObjectWrapper<TResult[]>;
}
//_.valuesIn
@@ -8673,11 +8949,11 @@ declare module _ {
valuesIn<T>(object?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.valuesIn
**/
- valuesIn<TResult>(): LoDashObjectWrapper<TResult[]>;
+ valuesIn<TResult>(): LoDashImplicitObjectWrapper<TResult[]>;
}
/**********
@@ -8694,7 +8970,7 @@ declare module _ {
camelCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.camelCase
*/
@@ -8706,7 +8982,7 @@ declare module _ {
capitalize(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.capitalize
*/
@@ -8724,7 +9000,7 @@ declare module _ {
deburr(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.deburr
*/
@@ -8743,7 +9019,7 @@ declare module _ {
endsWith(string?: string, target?: string, position?: number): boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.endsWith
*/
@@ -8760,7 +9036,7 @@ declare module _ {
escape(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.escape
*/
@@ -8778,7 +9054,7 @@ declare module _ {
escapeRegExp(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.escapeRegExp
*/
@@ -8795,7 +9071,7 @@ declare module _ {
kebabCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.kebabCase
*/
@@ -8814,7 +9090,7 @@ declare module _ {
}
//_.pad
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.pad
*/
@@ -8835,7 +9111,7 @@ declare module _ {
}
//_.padLeft
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.padLeft
*/
@@ -8856,7 +9132,7 @@ declare module _ {
}
//_.padRight
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.padRight
*/
@@ -8876,7 +9152,7 @@ declare module _ {
parseInt(string: string, radix?: number): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.parseInt
*/
@@ -8894,7 +9170,7 @@ declare module _ {
repeat(string?: string, n?: number): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.repeat
*/
@@ -8911,7 +9187,7 @@ declare module _ {
snakeCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.snakeCase
*/
@@ -8928,7 +9204,7 @@ declare module _ {
startCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.startCase
*/
@@ -8947,7 +9223,7 @@ declare module _ {
startsWith(string?: string, target?: string, position?: number): boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.startsWith
*/
@@ -8991,7 +9267,7 @@ declare module _ {
options?: TemplateSettings): TemplateExecutor;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.template
*/
@@ -9009,7 +9285,7 @@ declare module _ {
trim(string?: string, chars?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trim
*/
@@ -9027,7 +9303,7 @@ declare module _ {
trimLeft(string?: string, chars?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trimLeft
*/
@@ -9045,7 +9321,7 @@ declare module _ {
trimRight(string?: string, chars?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trimRight
*/
@@ -9073,7 +9349,7 @@ declare module _ {
trunc(string?: string, options?: TruncOptions|number): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trunc
*/
@@ -9091,7 +9367,7 @@ declare module _ {
unescape(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.unescape
*/
@@ -9109,7 +9385,7 @@ declare module _ {
words(string?: string, pattern?: string|RegExp): string[];
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.words
*/
@@ -9131,7 +9407,7 @@ declare module _ {
attempt<TResult>(func: (...args: any[]) => TResult): TResult|Error;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.attempt
*/
@@ -9177,23 +9453,23 @@ declare module _ {
callback<TResult>(): (value: TResult) => TResult;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.callback
*/
- callback<TResult>(thisArg?: any): LoDashObjectWrapper<(object: any) => TResult>;
+ callback<TResult>(thisArg?: any): LoDashImplicitObjectWrapper<(object: any) => TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.callback
*/
- callback(thisArg?: any): LoDashObjectWrapper<(object: any) => boolean>;
+ callback(thisArg?: any): LoDashImplicitObjectWrapper<(object: any) => boolean>;
/**
* @see _.callback
*/
- callback<TResult>(thisArg?: any): LoDashObjectWrapper<(...args: any[]) => TResult>;
+ callback<TResult>(thisArg?: any): LoDashImplicitObjectWrapper<(...args: any[]) => TResult>;
}
//_.identity
@@ -9206,21 +9482,21 @@ declare module _ {
identity<T>(value?: T): T;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.identity
*/
identity(): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.identity
*/
identity(): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.identity
*/
@@ -9259,23 +9535,23 @@ declare module _ {
iteratee<TResult>(): (value: TResult) => TResult;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.callback
*/
- iteratee<TResult>(thisArg?: any): LoDashObjectWrapper<(object: any) => TResult>;
+ iteratee<TResult>(thisArg?: any): LoDashImplicitObjectWrapper<(object: any) => TResult>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.callback
*/
- iteratee(thisArg?: any): LoDashObjectWrapper<(object: any) => boolean>;
+ iteratee(thisArg?: any): LoDashImplicitObjectWrapper<(object: any) => boolean>;
/**
* @see _.callback
*/
- iteratee<TResult>(thisArg?: any): LoDashObjectWrapper<(...args: any[]) => TResult>;
+ iteratee<TResult>(thisArg?: any): LoDashImplicitObjectWrapper<(...args: any[]) => TResult>;
}
//_.matches
@@ -9303,11 +9579,11 @@ declare module _ {
): (value: V) => boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.matches
*/
- matches<V>(): LoDashObjectWrapper<(value: V) => boolean>;
+ matches<V>(): LoDashImplicitObjectWrapper<(value: V) => boolean>;
}
//_.matchesProperty
@@ -9336,20 +9612,20 @@ declare module _ {
): (value: V) => boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.matchesProperty
*/
matchesProperty<SrcValue>(
srcValue: SrcValue
- ): LoDashObjectWrapper<(value: any) => boolean>;
+ ): LoDashImplicitObjectWrapper<(value: any) => boolean>;
/**
* @see _.matchesProperty
*/
matchesProperty<SrcValue, Value>(
srcValue: SrcValue
- ): LoDashObjectWrapper<(value: Value) => boolean>;
+ ): LoDashImplicitObjectWrapper<(value: Value) => boolean>;
}
//_.method
@@ -9369,28 +9645,28 @@ declare module _ {
method<TResult>(path: any[], ...args: any[]): (object: any) => TResult;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TResult>(...args: any[]): LoDashImplicitWrapper<(object: any) => TResult>;
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TResult>(...args: any[]): LoDashImplicitWrapper<(object: any) => TResult>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TResult>(...args: any[]): LoDashImplicitWrapper<(object: any) => TResult>;
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TResult>(...args: any[]): LoDashImplicitWrapper<(object: any) => TResult>;
}
//_.methodOf
@@ -9405,11 +9681,11 @@ declare module _ {
methodOf<TResult>(object: Object, ...args: any[]): (path: string | any[]) => TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.methodOf
*/
- methodOf<TResult>(...args: any[]): LoDashObjectWrapper<(path: string | any[]) => TResult>;
+ methodOf<TResult>(...args: any[]): LoDashImplicitObjectWrapper<(path: string | any[]) => TResult>;
}
//_.mixin
@@ -9446,21 +9722,21 @@ declare module _ {
): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.mixin
*/
mixin<TResult>(
source: Dictionary<Function>,
options?: MixinOptions
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
/**
* @see _.mixin
*/
mixin<TResult>(
options?: MixinOptions
- ): LoDashObjectWrapper<TResult>;
+ ): LoDashImplicitObjectWrapper<TResult>;
}
//_.noConflict
@@ -9473,7 +9749,7 @@ declare module _ {
noConflict(): typeof _;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.noConflict
*/
@@ -9489,7 +9765,7 @@ declare module _ {
noop(...args: any[]): void;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.noop
*/
@@ -9506,18 +9782,18 @@ declare module _ {
property<TObj, TResult>(path: string|string[]): (obj: TObj) => TResult;
}
- interface LoDashStringWrapper {
+ interface LoDashImplicitStringWrapper {
/**
* @see _.property
*/
- property<TObj, TResult>(): LoDashObjectWrapper<(obj: TObj) => TResult>;
+ property<TObj, TResult>(): LoDashImplicitObjectWrapper<(obj: TObj) => TResult>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.property
*/
- property<TObj, TResult>(): LoDashObjectWrapper<(obj: TObj) => TResult>;
+ property<TObj, TResult>(): LoDashImplicitObjectWrapper<(obj: TObj) => TResult>;
}
//_.propertyOf
@@ -9531,11 +9807,11 @@ declare module _ {
propertyOf<T extends {}>(object: T): (path: string|string[]) => any;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.propertyOf
*/
- propertyOf(): LoDashObjectWrapper<(path: string|string[]) => any>;
+ propertyOf(): LoDashImplicitObjectWrapper<(path: string|string[]) => any>;
}
//_.range
@@ -9562,13 +9838,13 @@ declare module _ {
step?: number): number[];
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.range
*/
range(
end?: number,
- step?: number): LoDashArrayWrapper<number>;
+ step?: number): LoDashImplicitArrayWrapper<number>;
}
//_.runInContext
@@ -9582,7 +9858,7 @@ declare module _ {
runInContext(context?: Object): typeof _;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.runInContext
*/
@@ -9612,19 +9888,19 @@ declare module _ {
times(n: number): number[];
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.times
*/
times<TResult>(
iteratee: (num: number) => TResult,
thisArgs?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.times
*/
- times(): LoDashArrayWrapper<number>;
+ times(): LoDashImplicitArrayWrapper<number>;
}
//_.uniqueId
@@ -9637,7 +9913,7 @@ declare module _ {
uniqueId(prefix?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.uniqueId
*/
@@ -9654,7 +9930,7 @@ declare module _ {
constant<T>(value: T): () => T;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.constant
*/
diff --git a/mobservable-react/mobservable-react.d.ts b/mobservable-react/mobservable-react.d.ts
index f42627a85..e95fc69f5 100644
--- a/mobservable-react/mobservable-react.d.ts
+++ b/mobservable-react/mobservable-react.d.ts
@@ -10,7 +10,7 @@ declare module "mobservable-react" {
* Turns a React component or stateless render function into a reactive component.
*/
export function reactiveComponent<P>(clazz: React.ClassicComponentClass<P>): React.ClassicComponentClass<P>;
+ export function reactiveComponent<TFunction extends React.ComponentClass<any>>(target: TFunction): void; // decorator signature
export function reactiveComponent<P>(clazz: React.ComponentClass<P>): React.ComponentClass<P>;
- export function reactiveComponent<TFunction extends React.ComponentClass<any>>(target: TFunction): TFunction | void; // decorator signature
export function reactiveComponent<P>(renderFunction: (props: P) => React.ReactElement<any>): React.ClassicComponentClass<P>;
}
\ No newline at end of file
diff --git a/mocha/mocha-tests.ts b/mocha/mocha-tests.ts
index f90fefaf9..c50f5feab 100644
--- a/mocha/mocha-tests.ts
+++ b/mocha/mocha-tests.ts
@@ -249,3 +249,7 @@ function test_run_withOnComplete() {
console.log(failures);
});
}
+
+function test_throwError() {
+ mocha.throwError(new Error("I'm an error!"));
+}
diff --git a/mocha/mocha.d.ts b/mocha/mocha.d.ts
index 88dc359fc..b4f182aab 100644
--- a/mocha/mocha.d.ts
+++ b/mocha/mocha.d.ts
@@ -100,6 +100,12 @@ declare class Mocha {
invert(): Mocha;
ignoreLeaks(value: boolean): Mocha;
checkLeaks(): Mocha;
+ /**
+ * Function to allow assertion libraries to throw errors directly into mocha.
+ * This is useful when running tests in a browser because window.onerror will
+ * only receive the 'message' attribute of the Error.
+ */
+ throwError(error: Error): void;
/** Enables growl support. */
growl(): Mocha;
globals(value: string): Mocha;
diff --git a/moment/moment-external-tests.ts b/moment/moment-external-tests.ts
index ed3e1e2a8..c8108d1b9 100644
--- a/moment/moment-external-tests.ts
+++ b/moment/moment-external-tests.ts
@@ -255,6 +255,7 @@ moment.locale('en', {
weekdaysShort: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
weekdaysMin: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"],
longDateFormat: {
+ LTS: "h:mm:ss A",
LT: "h:mm A",
L: "MM/DD/YYYY",
LL: "MMMM D YYYY",
@@ -376,6 +377,7 @@ moment.locale('en', {
moment.locale('en', {
longDateFormat : {
+ LTS: "h:mm:ss A",
LT: "h:mm A",
L: "MM/DD/YYYY",
l: "M/D/YYYY",
@@ -390,6 +392,7 @@ moment.locale('en', {
moment.locale('en', {
longDateFormat : {
+ LTS: "h:mm:ss A",
LT: "h:mm A",
L: "MM/DD/YYYY",
LL: "MMMM Do YYYY",
diff --git a/moment/moment-node.d.ts b/moment/moment-node.d.ts
index c67b4f742..babde41c9 100644
--- a/moment/moment-node.d.ts
+++ b/moment/moment-node.d.ts
@@ -19,7 +19,7 @@ declare module moment {
month?: number;
/** Month */
M?: number;
-
+
/** Week */
weeks?: number;
/** Week */
@@ -346,11 +346,13 @@ declare module moment {
LLL: string;
LLLL: string;
LT: string;
+ LTS: string;
l?: string;
ll?: string;
lll?: string;
llll?: string;
lt?: string;
+ lts?: string;
}
interface MomentRelativeTime {
diff --git a/moment/moment-tests.ts b/moment/moment-tests.ts
index 29712c115..14e58c612 100644
--- a/moment/moment-tests.ts
+++ b/moment/moment-tests.ts
@@ -127,6 +127,15 @@ moment().isoWeeks(45);
moment().dayOfYear();
moment().dayOfYear(45);
+moment().set('year', 2013);
+moment().set('month', 3); // April
+moment().set('date', 1);
+moment().set('hour', 13);
+moment().set('minute', 20);
+moment().set('second', 30);
+moment().set('millisecond', 123);
+moment().set({'year': 2013, 'month': 3});
+
var getMilliseconds: number = moment().milliseconds();
var getSeconds: number = moment().seconds();
var getMinutes: number = moment().minutes();
@@ -257,6 +266,7 @@ moment.locale('en', {
weekdaysShort: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
weekdaysMin: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"],
longDateFormat: {
+ LTS: "h:mm:ss A",
LT: "h:mm A",
L: "MM/DD/YYYY",
LL: "MMMM D YYYY",
@@ -378,6 +388,7 @@ moment.locale('en', {
moment.locale('en', {
longDateFormat : {
+ LTS: "h:mm:ss A",
LT: "h:mm A",
L: "MM/DD/YYYY",
l: "M/D/YYYY",
@@ -392,6 +403,7 @@ moment.locale('en', {
moment.locale('en', {
longDateFormat : {
+ LTS: "h:mm A",
LT: "h:mm A",
L: "MM/DD/YYYY",
LL: "MMMM Do YYYY",
diff --git a/mongodb/mongodb.d.ts b/mongodb/mongodb.d.ts
index 2fc3f0227..38037f003 100644
--- a/mongodb/mongodb.d.ts
+++ b/mongodb/mongodb.d.ts
@@ -127,6 +127,14 @@ declare module "mongodb" {
// Creates an ObjectID from a hex string representation of an ObjectID.
// hexString – create a ObjectID from a passed in 24 byte hexstring.
public static createFromHexString(hexString: string): ObjectID;
+
+ // Checks if a value is a valid bson ObjectId
+ // id - Value to be checked
+ public static isValid(id: string): Boolean;
+
+ // Generate a 12 byte id string used in ObjectID's
+ // time - optional parameter allowing to pass in a second based timestamp
+ public generate(time?: number): string;
}
// Class documentation : http://mongodb.github.io/node-mongodb-native/api-bson-generated/binary.html
diff --git a/polymer/polymer-tests.ts b/polymer/polymer-tests.ts
index 311fda967..8a44ed285 100644
--- a/polymer/polymer-tests.ts
+++ b/polymer/polymer-tests.ts
@@ -63,7 +63,7 @@ var el2 = document.createElement('my-element');
class MyElement2 {
is: string;
- registered() {
+ beforeRegister() {
this.is = "my-element2";
}
}
@@ -74,7 +74,7 @@ Polymer(MyElement2);
class MyElement3 implements polymer.Base {
is: string;
- registered() {
+ beforeRegister() {
this.is = "my-element3";
}
}
diff --git a/polymer/polymer.d.ts b/polymer/polymer.d.ts
index b764aeb2a..c346de8b3 100644
--- a/polymer/polymer.d.ts
+++ b/polymer/polymer.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for polymer v1.1.2
+// Type definitions for polymer v1.1.5
// Project: https://github.com/Polymer/polymer
// Definitions by: Louis Grignon <https://github.com/lgrignon>, Suguru Inatomi <https://github.com/laco0416>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
@@ -161,7 +161,7 @@ declare module polymer {
getContentChildren?(selector: string): HTMLElement[];
- fire?(type: string, detail?: Object, options?: Object): CustomEvent;
+ fire?(type: string, detail?: any, options?: Object): CustomEvent;
async?(callback: ()=>void, waitTime?: number): number;
@@ -177,6 +177,10 @@ declare module polymer {
create?(tag: string, props: Object): Element;
+ isLightDescendant?(node: HTMLElement): boolean;
+
+ isLocalDescendant?(node: HTMLElement): boolean
+
// XStyling
updateStyles?(): void;
@@ -201,6 +205,8 @@ declare module polymer {
observers?: string[];
+ beforeRegister?(): void;
+
registered?(): void;
created?(): void;
diff --git a/react-redux/react-redux-tests.tsx b/react-redux/react-redux-tests.tsx
index 9bd662295..abbacabef 100644
--- a/react-redux/react-redux-tests.tsx
+++ b/react-redux/react-redux-tests.tsx
@@ -4,7 +4,7 @@
/// <reference path="../react-router/react-router.d.ts" />
/// <reference path="../object-assign/object-assign.d.ts" />
-import { Component } from 'react';
+import { Component, ReactElement } from 'react';
import * as React from 'react';
import * as Router from 'react-router';
import { Route, RouterState } from 'react-router';
@@ -23,13 +23,13 @@ interface CounterState {
declare var increment: Function;
class Counter extends Component<any, any> {
- render() {
- return (
- <button onClick={this.props.onIncrement}>
- {this.props.value}
- </button>
- );
- }
+ render() {
+ return (
+ <button onClick={this.props.onIncrement}>
+ {this.props.value}
+ </button>
+ );
+ }
}
function mapStateToProps(state: CounterState) {
@@ -242,3 +242,37 @@ connect(mapStateToProps2, actionCreators, mergeProps)(TodoApp);
+
+
+interface TestProp {
+ property1: number;
+ someOtherProperty?: string;
+}
+interface TestState {
+ isLoaded: boolean;
+ state1: number;
+}
+class TestComponent extends Component<TestProp, TestState> { }
+const WrappedTestComponent = connect()(TestComponent);
+
+// return value of the connect()(TestComponent) is of the type TestComponent
+let ATestComponent: typeof TestComponent = null;
+ATestComponent = TestComponent;
+ATestComponent = WrappedTestComponent;
+
+let anElement: ReactElement<TestProp>;
+<TestComponent property1={42} />;
+<WrappedTestComponent property1={42} />;
+<ATestComponent property1={42} />;
+
+class NonComponent {}
+// this doesn't compile
+//connect()(NonComponent);
+
+// connect()(SomeClass) has the same constructor as SomeClass itself
+class SomeClass extends Component<any, any> {
+ constructor(public foo: string) { super() }
+ public bar: number;
+}
+let bar: number = new (connect()(SomeClass))("foo").bar;
+
diff --git a/react-redux/react-redux.d.ts b/react-redux/react-redux.d.ts
index f1ef5458e..767b6b109 100644
--- a/react-redux/react-redux.d.ts
+++ b/react-redux/react-redux.d.ts
@@ -10,8 +10,9 @@ declare module "react-redux" {
import { Component } from 'react';
import { Store, Dispatch, ActionCreator } from 'redux';
+ export class ElementClass extends Component<any, any> { }
export interface ClassDecorator {
- <TFunction extends Function>(target: TFunction): TFunction|void;
+ <T extends (typeof ElementClass)>(component: T): T
}
/**
diff --git a/react/react.d.ts b/react/react.d.ts
index de8ba6732..ba86c4690 100644
--- a/react/react.d.ts
+++ b/react/react.d.ts
@@ -427,7 +427,7 @@ declare namespace __React {
allowTransparency?: boolean;
alt?: string;
async?: boolean;
- autoComplete?: boolean;
+ autoComplete?: string;
autoFocus?: boolean;
autoPlay?: boolean;
cellPadding?: number | string;
diff --git a/redux/redux.d.ts b/redux/redux.d.ts
index 1bcbedc63..669ab6b99 100644
--- a/redux/redux.d.ts
+++ b/redux/redux.d.ts
@@ -43,7 +43,7 @@ declare module Redux {
function createStore(reducer: Reducer, initialState?: any): Store;
function bindActionCreators<T>(actionCreators: T, dispatch: Dispatch): T;
function combineReducers(reducers: any): Reducer;
- function applyMiddleware(...middleware: Middleware[]): Function;
+ function applyMiddleware(...middlewares: Middleware[]): Function;
function compose<T extends Function>(...functions: Function[]): T;
}
diff --git a/reflux/reflux-tests.ts b/reflux/reflux-tests.ts
new file mode 100644
index 000000000..afebd1a81
--- /dev/null
+++ b/reflux/reflux-tests.ts
@@ -0,0 +1,59 @@
+/// <reference path="reflux.d.ts" />
+/// <reference path="../react/react.d.ts" />
+
+import Reflux = require("reflux");
+import React = require("react");
+
+var syncActions = Reflux.createActions([
+ "statusUpdate",
+ "statusEdited",
+ "statusAdded"
+]);
+
+
+var asyncActions = Reflux.createActions({
+ fireBall: {asyncResult: true}
+});
+
+asyncActions.fireBall.listen(function () {
+ // Trigger async action
+ setTimeout(() => this.completed(true), 1000);
+});
+
+
+// Creates a DataStore
+var statusStore = Reflux.createStore({
+
+ // Initial setup
+ init: function () {
+
+ // Register statusUpdate action
+ this.listenTo(asyncActions.fireBall, this.onFireBall);
+ },
+ // Callback
+ onFireBall: function (flag: boolean) {
+ var status = flag ? 'ONLINE' : 'OFFLINE';
+
+ // Pass on to listeners
+ this.trigger(status);
+ }
+});
+
+Reflux.createAction({
+ children: ["progressed", "completed", "failed"]
+});
+
+
+var actions = Reflux.createActions(["fireBall", "magicMissile"]);
+
+var Store = Reflux.createStore({
+ init: function () {
+ this.listenToMany(actions);
+ },
+ onFireBall: function () {
+ // whoooosh!
+ },
+ onMagicMissile: function () {
+ // bzzzzapp!
+ }
+});
diff --git a/reflux/reflux.d.ts b/reflux/reflux.d.ts
new file mode 100644
index 000000000..035bca7f3
--- /dev/null
+++ b/reflux/reflux.d.ts
@@ -0,0 +1,62 @@
+// Type definitions for RefluxJS
+// Project: https://github.com/reflux/refluxjs
+// Definitions by: Maurice de Beijer <https://github.com/mauricedb>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module RefluxCore {
+
+ interface StoreDefinition {
+ listenables?: any[],
+ init?: Function,
+ getInitialState?: Function,
+ [propertyName: string]: any;
+ }
+
+ interface ListenFn {
+ (...params: any[]):any,
+ completed: Function,
+ failed: Function
+ }
+ interface Listenable {
+ listen: ListenFn
+ }
+
+ interface Subscription {
+ stop: Function,
+ listenable: Listenable
+ }
+
+ interface Store {
+ hasListener(listenable: Listenable): boolean,
+ listenToMany(listenables: Listenable[]): void,
+ validateListening(listenable: Listenable): string,
+ listenTo(listenable: Listenable, callback: Function, defaultCallback?: Function): Subscription,
+ stopListeningTo(listenable: Listenable): boolean,
+ stopListeningToAll(): void,
+ fetchInitialState(listenable: Listenable, defaultCallback: Function): void,
+ trigger(state: any):void;
+ }
+
+ interface ActionsDefinition {
+ [index: string]:any
+ }
+
+ interface Actions {
+ [index: string]: Listenable
+ }
+
+ function createStore(definition: StoreDefinition): Store;
+
+ function createAction(definition: ActionsDefinition): any;
+
+ function createActions(definition: ActionsDefinition): any;
+ function createActions(definitions: string[]): any;
+
+ function listenTo(store: Store, handler: string):void;
+ function setState(state: any):void;
+}
+
+declare module "reflux" {
+ export = RefluxCore;
+}
+
diff --git a/request/request.d.ts b/request/request.d.ts
index 4827bc7a6..d3bbd5704 100644
--- a/request/request.d.ts
+++ b/request/request.d.ts
@@ -79,7 +79,7 @@ declare module 'request' {
method?: string;
headers?: Headers;
body?: any;
- followRedirect?: boolean;
+ followRedirect?: boolean|((response: http.IncomingMessage) => boolean);
followAllRedirects?: boolean;
maxRedirects?: number;
encoding?: string;
diff --git a/requirejs/require.d.ts b/requirejs/require.d.ts
index 39c4c3419..22d9f2de2 100644
--- a/requirejs/require.d.ts
+++ b/requirejs/require.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for RequireJS 2.1.8
+// Type definitions for RequireJS 2.1.20
// Project: http://requirejs.org/
// Definitions by: Josh Baldwin <https://github.com/jbaldwin/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
@@ -88,6 +88,10 @@ interface RequireConfig {
// baseUrl.
paths?: { [key: string]: any; };
+ // Allows configuring multiple module IDs to be found in
+ // another script.
+ bundles?: { [key: string]: any; };
+
// Dictionary of Shim's.
// does not cover case of key->string[]
shim?: { [key: string]: RequireShim; };
@@ -195,6 +199,20 @@ interface RequireConfig {
**/
scriptType?: string;
+ /**
+ * If set to true, skips the data-main attribute scanning done
+ * to start module loading. Useful if RequireJS is embedded in
+ * a utility library that may interact with other RequireJS
+ * library on the page, and the embedded version should not do
+ * data-main loading.
+ **/
+ skipDataMain?: boolean;
+
+ /**
+ * Allow extending requirejs to support Subresource Integrity
+ * (SRI).
+ **/
+ onNodeCreated?: (node: HTMLScriptElement, config: RequireConfig, moduleName: string, url: string) => void;
}
// todo: not sure what to do with this guy
diff --git a/rethinkdb/rethinkdb-tests.ts b/rethinkdb/rethinkdb-tests.ts
index e94e5271c..a6911e302 100644
--- a/rethinkdb/rethinkdb-tests.ts
+++ b/rethinkdb/rethinkdb-tests.ts
@@ -7,9 +7,9 @@ r.connect({host:"localhost", port: 28015}, function(err, conn) {
var testDb = r.db('test')
testDb.tableCreate('users').run(conn, function(err, stuff) {
var users = testDb.table('users')
-
+
users.insert({name: "bob"}).run(conn, function() {})
-
+
users.filter(function(doc?) {
return doc("henry").eq("bob")
})
@@ -19,6 +19,24 @@ r.connect({host:"localhost", port: 28015}, function(err, conn) {
})
+ })
+})
+
+// use promises instead of callbacks
+r.connect({host:"localhost", port: 28015}).then(function(conn) {
+ console.log("HI", conn)
+ var testDb = r.db('test')
+ testDb.tableCreate('users').run(conn).then(function(stuff) {
+ var users = testDb.table('users')
+
+ users.insert({name: "bob"}).run(conn, function() {})
+
+ users.filter(function(doc?) {
+ return doc("henry").eq("bob")
+ })
+ .between("james", "beth")
+ .limit(4)
+ .run(conn);
})
-})
\ No newline at end of file
+})
diff --git a/rethinkdb/rethinkdb.d.ts b/rethinkdb/rethinkdb.d.ts
index 2c65a7cf4..22b721b9a 100644
--- a/rethinkdb/rethinkdb.d.ts
+++ b/rethinkdb/rethinkdb.d.ts
@@ -4,10 +4,11 @@
// Definitions: https://github.com/borisyankov/DefinitelyTyped
// Reference: http://www.rethinkdb.com/api/#js
// TODO: Document manipulation and below
+///<reference path="../bluebird/bluebird.d.ts"/>
declare module "rethinkdb" {
- export function connect(host:ConnectionOptions, cb:(err:Error, conn:Connection)=>void);
+ export function connect(host:ConnectionOptions, cb?:(err:Error, conn:Connection)=>void):Promise<Connection>;
export function dbCreate(name:string):Operation<CreateResult>;
export function dbDrop(name:string):Operation<DropResult>;
@@ -50,7 +51,7 @@ declare module "rethinkdb" {
interface Connection {
close();
- reconnect(cb:(err:Error, conn:Connection)=>void);
+ reconnect(cb?:(err:Error, conn:Connection)=>void):Promise<Connection>;
use(dbName:string);
addListener(event:string, cb:Function);
on(event:string, cb:Function);
@@ -139,11 +140,11 @@ declare module "rethinkdb" {
}
interface ExpressionFunction<U> {
- (doc:Expression<any>):Expression<U>;
+ (doc:Expression<any>):Expression<U>;
}
interface JoinFunction<U> {
- (left:Expression<any>, right:Expression<any>):Expression<U>;
+ (left:Expression<any>, right:Expression<any>):Expression<U>;
}
interface ReduceFunction<U> {
@@ -159,7 +160,7 @@ declare module "rethinkdb" {
interface UpdateOptions {
non_atomic: boolean;
durability: string; // 'soft'
- return_vals: boolean; // false
+ return_vals: boolean; // false
}
interface WriteResult {
@@ -193,7 +194,7 @@ declare module "rethinkdb" {
}
interface Expression<T> extends Writeable, Operation<T> {
- (prop:string):Expression<any>;
+ (prop:string):Expression<any>;
merge(query:Expression<Object>):Expression<Object>;
append(prop:string):Expression<Object>;
contains(prop:string):Expression<boolean>;
@@ -221,7 +222,7 @@ declare module "rethinkdb" {
}
interface Operation<T> {
- run(conn:Connection, cb:(err:Error, result:T)=>void);
+ run(conn:Connection, cb?:(err:Error, result:T)=>void):Promise<T>;
}
interface Aggregator {}
diff --git a/roslib/roslib.d.ts b/roslib/roslib.d.ts
index 667a37983..8610ea7d4 100644
--- a/roslib/roslib.d.ts
+++ b/roslib/roslib.d.ts
@@ -3,22 +3,373 @@
// Definitions by: Stefan Profanter <https://github.com/Pro/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/* ----------------------------------
+
+ NOTE: This typescript definition is not yet complete. I should be extended if definitions are missing.
+
+ ---------------------------------- */
+
declare module ROSLIB {
export class Ros {
- constructor(data: {
- url: string
+ /**
+ * Manages connection to the server and all interactions with ROS.
+ *
+ * Emits the following events:
+ * * 'error' - there was an error with ROS
+ * * 'connection' - connected to the WebSocket server
+ * * 'close' - disconnected to the WebSocket server
+ * * <topicName> - a message came from rosbridge with the given topic name
+ * * <serviceID> - a service response came from rosbridge with the given ID
+ *
+ * @constructor
+ * @param options - possible keys include:
+ * * url (optional) - the WebSocket URL for rosbridge (can be specified later with `connect`)
+ */
+ constructor(options:{
+ url?: string
});
- on(eventName: string, callback: (event: any) => void) : void;
- connect(url: string) : void;
+ on(eventName:string, callback:(event:any) => void):void;
+
+ /**
+ * Connect to the specified WebSocket.
+ *
+ * @param url - WebSocket URL for Rosbridge
+ */
+ connect(url:string):void;
+
+ /**
+ * Disconnect from the WebSocket server.
+ */
+ close():void;
+
+ /**
+ * Sends an authorization request to the server.
+ *
+ * @param mac - MAC (hash) string given by the trusted source.
+ * @param client - IP of the client.
+ * @param dest - IP of the destination.
+ * @param rand - Random string given by the trusted source.
+ * @param t - Time of the authorization request.
+ * @param level - User level as a string given by the client.
+ * @param end - End time of the client's session.
+ */
+ authenticate(mac:string, client:string, dest:string, rand:string, t:number, level:string, end:string): void;
+
+
+ /**
+ * Sends the message over the WebSocket, but queues the message up if not yet
+ * connected.
+ */
+ callOnConnection(message:any): void;
+
+ /**
+ * Retrieves list of topics in ROS as an array.
+ *
+ * @param callback function with params:
+ * * topics - Array of topic names
+ */
+ getTopics(callback:(topics:string[]) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves Topics in ROS as an array as specific type
+ *
+ * @param topicType topic type to find:
+ * @param callback function with params:
+ * * topics - Array of topic names
+ */
+ getTopicsForType(topicType:string, callback:(topics:string[]) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves list of active service names in ROS.
+ *
+ * @param callback - function with the following params:
+ * * services - array of service names
+ */
+ getServices(callback:(services:string[]) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves list of services in ROS as an array as specific type
+ *
+ * @param serviceType service type to find:
+ * @param callback function with params:
+ * * topics - Array of service names
+ */
+ getServicesForType(serviceType: string, callback:(services:string[]) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves list of active node names in ROS.
+ *
+ * @param callback - function with the following params:
+ * * nodes - array of node names
+ */
+ getNodes(callback:(nodes:string[]) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves list of param names from the ROS Parameter Server.
+ *
+ * @param callback function with params:
+ * * params - array of param names.
+ */
+ getParams(callback:(params:string[]) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves a type of ROS topic.
+ *
+ * @param topic name of the topic:
+ * @param callback - function with params:
+ * * type - String of the topic type
+ */
+ getTopicType(topic: string, callback:(type:string) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves a type of ROS service.
+ *
+ * @param service name of service:
+ * @param callback - function with params:
+ * * type - String of the service type
+ */
+ getServiceType(service: string, callback:(type:string) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Retrieves a detail of ROS message.
+ *
+ * @param callback - function with params:
+ * * details - Array of the message detail
+ * @param message - String of a topic type
+ */
+ getMessageDetails(message: Message, callback:(detail:any) => void, failedCallback:(error:any)=>void): void;
+
+ /**
+ * Decode a typedefs into a dictionary like `rosmsg show foo/bar`
+ *
+ * @param defs - array of type_def dictionary
+ */
+ decodeTypeDefs(defs: any): void;
+ }
+
+ export class Message {
+ /**
+ * Message objects are used for publishing and subscribing to and from topics.
+ *
+ * @constructor
+ * @param values - object matching the fields defined in the .msg definition file
+ */
+ constructor(values:any);
+ }
+
+ export class Param {
+ /**
+ * A ROS parameter.
+ *
+ * @constructor
+ * @param options - possible keys include:
+ * * ros - the ROSLIB.Ros connection handle
+ * * name - the param name, like max_vel_x
+ */
+ constructor(options:{
+ ros: Ros,
+ name: string
+ });
+
+ /**
+ * Fetches the value of the param.
+ *
+ * @param callback - function with the following params:
+ * * value - the value of the param from ROS.
+ */
+ get(callback:(response:any) => void): void;
+
+ /**
+ * Sets the value of the param in ROS.
+ *
+ * @param value - value to set param to.
+ */
+ set(value:any, callback:(response:any) => void): void;
+
+ /**
+ * Delete this parameter on the ROS server.
+ */
+ delete(callback:(response:any) => void): void;
+
}
export class Service {
- constructor(data: {
+ /**
+ * A ROS service client.
+ *
+ * @constructor
+ * @params options - possible keys include:
+ * * ros - the ROSLIB.Ros connection handle
+ * * name - the service name, like /add_two_ints
+ * * serviceType - the service type, like 'rospy_tutorials/AddTwoInts'
+ */
+ constructor(data:{
ros: Ros,
name: string,
serviceType: string
});
+
+ /**
+ * Calls the service. Returns the service response in the callback.
+ *
+ * @param request - the ROSLIB.ServiceRequest to send
+ * @param callback - function with params:
+ * * response - the response from the service request
+ * @param failedCallback - the callback function when the service call failed (optional). Params:
+ * * error - the error message reported by ROS
+ */
+ callService(request:ServiceRequest, callback:(response:any) => void, failedCallback?:(error:any) => void): void;
+ }
+
+ export class ServiceRequest {
+ /**
+ * A ServiceRequest is passed into the service call.
+ *
+ * @constructor
+ * @param values - object matching the fields defined in the .srv definition file
+ */
+ constructor(values?: any);
+ }
+
+ export class ServiceResponse {
+ /**
+ * A ServiceResponse is returned from the service call.
+ *
+ * @constructor
+ * @param values - object matching the fields defined in the .srv definition file
+ */
+ constructor(values?: any);
+ }
+
+ export class Topic {
+ /**
+ * Publish and/or subscribe to a topic in ROS.
+ *
+ * Emits the following events:
+ * * 'warning' - if there are any warning during the Topic creation
+ * * 'message' - the message data from rosbridge
+ *
+ * @constructor
+ * @param options - object with following keys:
+ * * ros - the ROSLIB.Ros connection handle
+ * * name - the topic name, like /cmd_vel
+ * * messageType - the message type, like 'std_msgs/String'
+ * * compression - the type of compression to use, like 'png'
+ * * throttle_rate - the rate (in ms in between messages) at which to throttle the topics
+ * * queue_size - the queue created at bridge side for re-publishing webtopics (defaults to 100)
+ * * latch - latch the topic when publishing
+ * * queue_length - the queue length at bridge side used when subscribing (defaults to 0, no queueing).
+ */
+ constructor(options: {
+ ros: Ros,
+ name: string,
+ messageType: string,
+ compression: string,
+ throttle_rate: number,
+ queue_size: number,
+ latch: number,
+ queue_length: number
+ });
+
+ /**
+ * Every time a message is published for the given topic, the callback
+ * will be called with the message object.
+ *
+ * @param callback - function with the following params:
+ * * message - the published message
+ */
+ subscribe(callback: (message: Message) => void): void;
+
+ /**
+ * Unregisters as a subscriber for the topic. Unsubscribing stop remove
+ * all subscribe callbacks. To remove a call back, you must explicitly
+ * pass the callback function in.
+ *
+ * @param callback - the optional callback to unregister, if
+ * * provided and other listeners are registered the topic won't
+ * * unsubscribe, just stop emitting to the passed listener
+ */
+ unsubscribe(callback?: () => void): void;
+
+ /**
+ * Registers as a publisher for the topic.
+ */
+ advertise(): void;
+
+ /**
+ * Unregisters as a publisher for the topic.
+ */
+ unadvertise(): void;
+
+ /**
+ * Publish the message.
+ *
+ * @param message - A ROSLIB.Message object.
+ */
+ publish(message: Message): void;
+ }
+
+ class ActionClient {
+ /**
+ * An actionlib action client.
+ *
+ * Emits the following events:
+ * * 'timeout' - if a timeout occurred while sending a goal
+ * * 'status' - the status messages received from the action server
+ * * 'feedback' - the feedback messages received from the action server
+ * * 'result' - the result returned from the action server
+ *
+ * @constructor
+ * @param options - object with following keys:
+ * * ros - the ROSLIB.Ros connection handle
+ * * serverName - the action server name, like /fibonacci
+ * * actionName - the action message name, like 'actionlib_tutorials/FibonacciAction'
+ * * timeout - the timeout length when connecting to the action server
+ */
+ constructor(options: {
+ ros: Ros,
+ serverName: string,
+ actionName: string,
+ timeout: number
+ });
+
+ /**
+ * Cancel all goals associated with this ActionClient.
+ */
+ cancel(): void;
+ }
+
+ class Goal {
+ /**
+ * An actionlib goal goal is associated with an action server.
+ *
+ * Emits the following events:
+ * * 'timeout' - if a timeout occurred while sending a goal
+ *
+ * @constructor
+ * @param object with following keys:
+ * * actionClient - the ROSLIB.ActionClient to use with this goal
+ * * goalMessage - The JSON object containing the goal for the action server
+ */
+ constructor(options: {
+ actionClient: ActionClient,
+ goalMessage: any
+ });
+
+ /**
+ * Send the goal to the action server.
+ *
+ * @param timeout (optional) - a timeout length for the goal's result
+ */
+ send(timeout?: number): void;
+
+ /**
+ * Cancel the current goal.
+ */
+ cancel(): void;
}
}
+
diff --git a/simplestorage.js/simplestorage.js-tests.ts b/simplestorage.js/simplestorage.js-tests.ts
new file mode 100644
index 000000000..1e9f4202a
--- /dev/null
+++ b/simplestorage.js/simplestorage.js-tests.ts
@@ -0,0 +1,17 @@
+///<reference path="simplestorage.js.d.ts"/>
+
+var versionTest: string = simpleStorage.version;
+var canUseTest: boolean = simpleStorage.canUse();
+var simpleStorageTest1: boolean|Error = simpleStorage.set("string", 7);
+var simpleStorageTest2: boolean|Error = simpleStorage.set("string", 7, {});
+var simpleStorageTest3: boolean|Error = simpleStorage.set("string", 7, { TTL: 7 });
+var simpleStorageTest4: boolean|Error = simpleStorage.set("string", undefined);
+var simpleStorageTest5: boolean|Error = simpleStorage.set("string", undefined, {});
+var simpleStorageTest6: boolean|Error = simpleStorage.set("string", undefined, { TTL: 7 });
+var getTest: any = simpleStorage.get("string");
+var deleteKeyTest: boolean|Error = simpleStorage.deleteKey("string");
+var setTTLTest: boolean|Error = simpleStorage.setTTL("string", 7);
+var getTTLTest: number|boolean = simpleStorage.getTTL("string");
+var flushTest: boolean|Error = simpleStorage.flush();
+var indexTest: [string]|boolean = simpleStorage.index();
+var storageSizeTest: number = simpleStorage.storageSize();
diff --git a/simplestorage.js/simplestorage.js.d.ts b/simplestorage.js/simplestorage.js.d.ts
new file mode 100644
index 000000000..bda285aac
--- /dev/null
+++ b/simplestorage.js/simplestorage.js.d.ts
@@ -0,0 +1,110 @@
+// Type definitions for simpleStorage v0.1.3
+// Project: https://github.com/andris9/simpleStorage
+// Definitions by: Áxel Costas Pena <https://github.com/axelcostaspena>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module simplestoragejs {
+
+ /**
+ * {@link simpleStorage} API is a subset of {@link http://www.jstorage.info/|jStorage} with slight modifications, so for most cases it should work out of the box if you are converting from {@link http://www.jstorage.info/|jStorage}. Main difference is between return values - if an action failed because of an error (storage full, storage not available, invalid data used etc.), you get the error object as the return value. {@link http://www.jstorage.info/|jStorage} never indicated anything if an error occurred.
+ * @see https://github.com/andris9/simpleStorage#usage
+ */
+ export interface SimpleStorage {
+
+ version: string;
+
+ /**
+ * Check if local storage can be used.
+ * Returns <code>true</code> if storage is available.
+ * @see https://github.com/andris9/simpleStorage#canuse
+ */
+ canUse(): boolean;
+
+ /**
+ * Store or update a value in local storage.
+ * Returns <code>true</code> if value was stored, <code>false</code> if value was not stored or <code>{@link Error}</code> object if value was not stored because of an error.
+ * @param key The key for the value.
+ * @param value Value to be stored (can be any JSONeable value).
+ * @param [options] Optional options object.
+ * @see https://github.com/andris9/simpleStorage#setkey-value-options
+ */
+ set(key: string, value: any, options?: SetOptions): boolean|Error;
+
+ /**
+ * Retrieve a value from local storage.
+ * Returns the value for a key or undefined if the key was not found.
+ * @param key The key to be retrieved.
+ * @see https://github.com/andris9/simpleStorage#getkey
+ */
+ get(key: string): any;
+
+ /**
+ * Removes a value from local storage.
+ * Returns <code>true</code> if the value was deleted, <code>false</code> if the value was not found or <code>{@link Error}</code> object if value was not deleted because of an error.
+ * @param key The key to be deleted.
+ * @see https://github.com/andris9/simpleStorage#deletekeykey
+ */
+ deleteKey(key: string): boolean|Error;
+
+ /**
+ * Set a millisecond timeout. When the timeout is reached, the key is removed automatically from local storage.
+ * Returns <code>true</code> if ttl was set, <code>false</code> if value was not found or <code>{@link Error}</code> object if ttl was not set because of an error.
+ * @param key The key to be updated.
+ * @param ttl Timeout in milliseconds. If the value is 0, timeout is cleared from the key.
+ * @see https://github.com/andris9/simpleStorage#setttlkey-ttl
+ */
+ setTTL(key: string, ttl: number): boolean|Error;
+
+ /**
+ * Retrieve remaining milliseconds for a key with TTL.
+ * Returns the finite number of remaining milliseconds, <code>Infinity</code> if TTL is not set for the selected key or <code>false</code> if the selected key does not exist or is expired.
+ * @param key The key to be checked.
+ * @see https://github.com/andris9/simpleStorage#getttlkey
+ */
+ getTTL(key: string): number|boolean;
+
+ /**
+ * Clear all values.
+ * Returns <code>true</code> if storage was flushed or <code>{@link Error}</code> object if storage was not flushed because of an error.
+ * @see https://github.com/andris9/simpleStorage#flush
+ */
+ flush(): boolean|Error;
+
+ /**
+ * Retrieve all used keys as an array.
+ * Returns an array of keys.
+ * @see https://github.com/andris9/simpleStorage#index
+ */
+ index(): [string]|boolean;
+
+ /**
+ * Get used storage in symbol count.
+ * @see https://github.com/andris9/simpleStorage#storagesize
+ */
+ storageSize(): number;
+ }
+
+ /**
+ * @see https://github.com/andris9/simpleStorage#setkey-value-options
+ */
+ export interface SetOptions {
+ /**
+ * Sets the time-to-live (TTL) value in milliseconds for the given key/value.
+ */
+ TTL?: number;
+ }
+
+}
+
+declare module "simpleStorage" {
+ export = simpleStorage;
+}
+
+/**
+ * Cross-browser key-value store database to store data locally in the browser.
+ * {@link simpleStorage} is a fork of {@link http://www.jstorage.info/|jStorage} that only includes the minimal set of features. Basically it is a wrapper for native <code>{@link JSON}</code> + <code>{@link WindowLocalStorage.localStorage|localStorage}</code> with some TTL magic mixed in.
+ * The module has no dependencies, you can use it as a standalone script (introduces {@link simpleStorage} global) or as an AMD module. All modern browsers (including mobile) are supported, older browsers (IE7, Firefox 3) are not.
+ * {@link simpleStorage} is very small - about 1kB in size when minimized and gzipped.
+ * @see https://github.com/andris9/simpleStorage#simplestorage
+ */
+declare var simpleStorage:simplestoragejs.SimpleStorage;
diff --git a/typeahead/typeahead.d.ts b/typeahead/typeahead.d.ts
index a8b139937..49538fbd9 100644
--- a/typeahead/typeahead.d.ts
+++ b/typeahead/typeahead.d.ts
@@ -152,6 +152,20 @@ declare module Twitter.Typeahead {
* If it's a precompiled template, the passed in context will contain query and isEmpty.
*/
header?: any;
+
+ /**
+ * Rendered when 0 suggestions are available for the given query.
+ * Can be either a HTML string or a precompiled template.
+ * If it's a precompiled template, the passed in context will contain query.
+ */
+ notFound?: (query: string) => string;
+
+ /**
+ * Rendered when 0 synchronous suggestions are available but asynchronous suggestions are expected.
+ * Can be either a HTML string or a precompiled template.
+ * If it's a precompiled template, the passed in context will contain query.
+ */
+ pending?: (query: string) => string;
/**
* Used to render a single suggestion.
diff --git a/ui-grid/ui-grid.d.ts b/ui-grid/ui-grid.d.ts
index 8b67f649b..b4ac33934 100644
--- a/ui-grid/ui-grid.d.ts
+++ b/ui-grid/ui-grid.d.ts
@@ -734,13 +734,13 @@ declare module uiGrid {
* to load when scrolling up
* @default false
*/
- infiniteScrollUp?: boolean,
+ infiniteScrollUp?: boolean;
/**
* Inform the grid of whether there are rows
* to load scrolling down
* @default true
*/
- infiniteScrollDown?: boolean,
+ infiniteScrollDown?: boolean;
/**
* Defaults to 200
* @default 200
@@ -1038,6 +1038,12 @@ declare module uiGrid {
* @param {scrollEndHandler} handler callback
*/
scrollEnd: (scope: ng.IScope, handler: scrollEndHandler) => void;
+ /**
+ * is raised after the sort criteria on one or more columns have changed
+ * @param {ng.IScope} scope Grid scope
+ * @param {sortChangedHandler} handler callback
+ */
+ sortChanged: (scope: ng.IScope, handler: sortChangedHandler<TEntity>) => void;
}
}
export interface columnVisibilityChangedHandler<TEntity> {
@@ -1096,6 +1102,15 @@ declare module uiGrid {
(scrollEvent: JQueryMouseEventObject): void;
}
+ export interface sortChangedHandler<TEntity> {
+ /**
+ * Sort change event callback
+ * @param {IGridInstance} grid instance
+ * @param {IGridColumn} array of gridColumns that have sorting on them, sorted in priority order
+ */
+ (grid: IGridInstanceOf<TEntity>, columns: Array<IGridColumnOf<TEntity>>): void;
+ }
+
export module cellNav {
/**
* Column Definitions for cellNav feature, these are available to be set using the ui-grid
diff --git a/uikit/.gitignore b/uikit/.gitignore
new file mode 100644
index 000000000..7c794a353
--- /dev/null
+++ b/uikit/.gitignore
@@ -0,0 +1,2 @@
+tsconfig.json
+.idea/
\ No newline at end of file
diff --git a/uikit/README.md b/uikit/README.md
new file mode 100644
index 000000000..76015e346
--- /dev/null
+++ b/uikit/README.md
@@ -0,0 +1,88 @@
+# UIkit
+
+UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces.
+
+* [Homepage](http://getuikit.com) - Learn more about UIkit
+* [@getuikit](https://twitter.com/getuikit) - Get the latest buzz on Twitter
+* [Google+ Community](https://plus.google.com/communities/114238665434626719878) - Share news and latest work
+
+Join our developer chat. We are online every work day between 8:00 and 18:00 UTC
+
+[](https://gitter.im/uikit/uikit)
+
+## Getting started
+
+You have following options to get UIkit:
+
+- Download the [latest release](https://github.com/uikit/uikit/releases/latest)
+- Clone the repo, `git clone git://github.com/uikit/uikit.git`.
+- Install with [Bower](http://bower.io): ```bower install uikit```
+
+You find the compiled UIkit distribution in its own [repo](https://github.com/uikit/bower-uikit).
+
+## Developers
+
+First of all, install [Node](http://nodejs.org/). We use [Gulp](http://gulpjs.com) to build UIkit. If you haven't used Gulp before, you need to install the `gulp` package as a global install.
+
+```
+npm install --global gulp
+```
+
+If you haven't done so already, clone the UIkit git repo.
+
+```
+git clone git://github.com/uikit/uikit.git
+```
+Install the Node dependencies.
+
+```
+cd uikit
+npm install
+```
+
+Run `gulp` to lint, build and minify the release.
+
+```
+gulp [-t themename]
+```
+
+The built version of UIkit will be put in the `/dist` subdirectory. Pass a theme name parameter to only build the specified theme.
+
+### Browsersync
+
+```
+gulp sync
+```
+
+After running `gulp sync` a new browser instance will open, pointing to the uikit folder - `http://localhost:3000/`. The browser window will reload anytime you modify a source file.
+
+### Custom prefix
+
+Run gulp with your own prefix parameter ```-p``` to have all classes and JavaScript files custom prefixed.
+
+```
+gulp -p myprefix
+```
+
+
+## Contributing
+
+UIkit follows the [GitFlow branching model](http://nvie.com/posts/a-successful-git-branching-model). The ```master``` branch always reflects a production-ready state while the latest development is taking place in the ```develop``` branch.
+
+Each time you want to work on a fix or a new feature, create a new branch based on the ```develop``` branch: ```git checkout -b BRANCH_NAME develop```. Only pull requests to the ```develop``` branch will be merged.
+
+## Versioning
+
+UIkit is maintained by using the [Semantic Versioning Specification (SemVer)](http://semver.org).
+
+## Browser Support
+
+ |  |  |  | 
+--- | --- | --- | --- | --- |
+Latest ✔ | Latest ✔ | 9+ ✔ | 7.1+ ✔ | Latest ✔ |
+
+Tested with [BrowserStack](https://www.browserstack.com) (thanks for sponsoring!).
+
+## Copyright and License
+
+Copyright [YOOtheme](http://www.yootheme.com) GmbH under the [MIT license](LICENSE.md).
diff --git a/uikit/uikit-tests.ts b/uikit/uikit-tests.ts
new file mode 100644
index 000000000..8bc1f7b63
--- /dev/null
+++ b/uikit/uikit-tests.ts
@@ -0,0 +1,186 @@
+/// <reference path="uikit.d.ts" />
+
+function testModal() {
+ UIkit.modal.alert("Attention!");
+ UIkit.modal.confirm("Are you sure?", function () {
+ // will be executed on confirm.
+ });
+ UIkit.modal.prompt("Name:", 'value', function (newvalue:string) {
+ // will be executed on submit.
+ });
+ var modal = UIkit.modal.blockUI("Any content...");
+ modal.hide();
+ modal.show();
+ var modal = UIkit.modal(".modalSelector");
+
+ if (modal.isActive()) {
+ modal.hide();
+ } else {
+ modal.show();
+ }
+}
+
+function testOffCanvas() {
+ UIkit.offcanvas.show("#id");
+ UIkit.offcanvas.hide();
+ UIkit.offcanvas.hide(true);
+}
+
+function testLightBox() {
+ var element = "#group";
+ var lightbox = UIkit.lightbox(element, {/* options */});
+ var lightbox2 = UIkit.lightbox.create([
+ {source: 'http://url/to/video.mp4', 'type': 'video'},
+ {'source': 'http://url/to/image.jpg', 'type': 'image'}
+ ]);
+ lightbox2.show();
+ var lightbox3 = UIkit.lightbox(element)
+}
+
+function testAutoComplete() {
+ UIkit.autocomplete("#group", {});
+ UIkit.autocomplete("#group");
+}
+
+function testDatepicker() {
+ var datepicker = UIkit.datepicker("#element", {});
+}
+
+function testHtmlEditor() {
+ var htmleditor = UIkit.htmleditor("textarea", {/* options */});
+}
+
+function testSlider() {
+ var slider = UIkit.slider("element", {})
+}
+function testSlideSet() {
+ var slideset = UIkit.slideset("element", {})
+}
+function testSlideShow() {
+ var slideshow = UIkit.slideshow("element", {})
+}
+
+function testParallax() {
+ var parallax = UIkit.parallax("element", {})
+}
+function testAccordion() {
+ var accordion = UIkit.accordion("element", {})
+}
+
+
+function testNotify() {
+ UIkit.notify({
+ message: 'Bazinga!',
+ status: 'info',
+ timeout: 5000,
+ pos: 'top-center'
+ });
+
+
+// Shortcuts
+ UIkit.notify('My message');
+ UIkit.notify('My message', status);
+ UIkit.notify('My message', {/* options */});
+
+ UIkit.notify("Message...", {timeout: 0});
+ UIkit.notify("...", {pos: 'top-center'});
+ UIkit.notify("...", {status: 'info'});
+}
+
+
+function testSearch() {
+ var search = UIkit.search("element", {})
+}
+
+function testNestable() {
+ var nestable = UIkit.nestable('element', {});
+}
+function testSortable() {
+ var sortable = UIkit.sortable('element', {});
+}
+function testStick() {
+ var sticky = UIkit.sticky('element', {});
+}
+function testTimePicker() {
+ var timepicker = UIkit.timepicker('element', {})
+}
+
+function testTooltip() {
+ var tooltip = UIkit.tooltip('element', {})
+}
+
+function testUpload() {
+ $(function(){
+
+ var progressbar = $("#progressbar"),
+ bar = progressbar.find('.uk-progress-bar'),
+ settings = {
+
+ action: '/', // upload url
+
+ allow : '*.(jpg|jpeg|gif|png)', // allow only images
+
+ loadstart: function() {
+ bar.css("width", "0%").text("0%");
+ progressbar.removeClass("uk-hidden");
+ },
+
+ progress: function(percent: number) {
+ percent = Math.ceil(percent);
+ bar.css("width", percent+"%").text(percent+"%");
+ },
+
+ allcomplete: function(response: any) {
+
+ bar.css("width", "100%").text("100%");
+
+ setTimeout(function(){
+ progressbar.addClass("uk-hidden");
+ }, 250);
+
+ alert("Upload Completed")
+ }
+ };
+
+ var select = UIkit.uploadSelect($("#upload-select"), settings),
+ drop = UIkit.uploadDrop($("#upload-drop"), settings);
+ });
+
+ // Test with object literal
+ var select2 = UIkit.uploadSelect($("#upload-select"), {
+
+ action: '/', // upload url
+
+ allow: '*.(jpg|jpeg|gif|png)', // allow only images
+
+ loadstart: function () {
+
+ },
+
+ progress: function (percent:number) {
+
+ },
+
+ allcomplete: function (response:any) {
+
+ }
+ });
+ var drop2 = UIkit.uploadDrop($("#upload-drop"), {
+
+ action: '/', // upload url
+
+ allow: '*.(jpg|jpeg|gif|png)', // allow only images
+
+ loadstart: function () {
+
+ },
+
+ progress: function (percent:number) {
+
+ },
+
+ allcomplete: function (response:any) {
+ }
+ });
+
+}
diff --git a/uikit/uikit.d.ts b/uikit/uikit.d.ts
new file mode 100644
index 000000000..f1ddfe9a5
--- /dev/null
+++ b/uikit/uikit.d.ts
@@ -0,0 +1,1443 @@
+// Type definitions for uikit 2.23.0
+// Project: http://getuikit.org
+// Definitions by: Giovanni Silva <https://github.com/giovannicandido>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts" />
+
+declare module UIkit {
+ interface ModalElement {
+ /**
+ * Show the modal
+ */
+ show(): void
+ /**
+ * Hide the modal
+ */
+ hide(): void
+ /**
+ * Return if the modal is active on the page
+ * @return {boolean} True if the modal is current active on the page, false otherwise
+ */
+ isActive(): boolean
+ }
+ /**
+ * Create modal dialogs with different styles and transitions
+ * Documentation: {@link http://getuikit.org/docs/modal.html}
+ *
+ * <h2>Events</h2>
+ *
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+
+ * <tr>
+ * <td><code>show.uk.modal</code></td>
+ * <td>event</td>
+ * <td>On modal show</td>
+ * </tr>
+ * <tr>
+ * <td><code>hide.uk.modal</code></td>
+ * <td>event</td>
+ * <td>On modal hide</td>
+ * </tr>
+ * </table>
+ * @example
+ * <pre><code>
+ * $('.modalSelector').on({
+ *
+ * 'show.uk.modal': function(){
+ * console.log("Modal is visible.");
+ * },
+ *
+ * 'hide.uk.modal': function(){
+ * console.log("Element is not visible.");
+ * }
+ * });
+ * </code></pre>
+ */
+ interface Modal {
+ /**
+ * Create a alert dialog
+ * @param {string} message The message to display. Can be Html
+ */
+ alert(message:string): void
+ /**
+ * Create a confirm dialog and execute the function on positive confirmation
+ * @param {string} message The message to display. Can be Html
+ * @param {function} fn A function to execute on confirmation
+ */
+ confirm(message:string, fn:() => any): void
+ /**
+ * Create a prompt dialog, where the user enter information
+ * @param {string} message The message to display. Can be Html
+ * @param {function} fn A function to execute on confirmation. The function
+ * receive the new value as a parameter
+ */
+ prompt(message:string, fn:(newValue:string) => any): void
+ /**
+ * Create a prompt dialog, where the user enter information
+ * @param {string} message The message to display. Can be Html
+ * @param {string} value A value to init the input
+ * @param {function} fn A function to execute on confirmation. The function
+ * receive the new value as a parameter
+ */
+ prompt(message:string, value:string, fn:(newValue:string) => any): void
+ /**
+ * Create a modal that blocks the entire page
+ * @param {string} content A content to display. Can be Html
+ */
+ blockUI(content:string): ModalElement
+ /**
+ * Select a modal element on page and return it.
+ * @example
+ * <pre><code>
+ * var modal = UIkit.modal(".modalSelector");
+ *
+ * if ( modal.isActive() ) {
+ * modal.hide();
+ * } else {
+ * modal.show();
+ * }
+ * </code></pre>
+ */
+ (selector:string|JQuery): ModalElement
+ }
+ /**
+ * Create a smooth off-canvas sidebar that slides in and out of the page
+ * Documentation: {@link http://getuikit.org/docs/offcanvas.html}
+ * <h2>Events:</h2>
+ * <table class="uk-table uk-table-striped uk-text-nowrap">
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>show.uk.offcanvas</code></td>
+ * <td>event, panel, bar</td>
+ * <td>On offcanvas show</td>
+ * </tr>
+ * <tr>
+ * <td><code>hide.uk.offcanvas</code></td>
+ * <td>event, panel, bar</td>
+ * <td>On offcanvas hide</td>
+ * </tr>
+ * </table>
+ */
+ interface OffCanvas {
+ /**
+ * Show an off-canvas matching the passed CSS selector
+ * @param {string} selector A CSS selector
+ */
+ show(selector:string): void
+ /**
+ * Hide any active offcanvas. Set force to true, if you don't want any
+ * animation
+ * @param {boolean} force When seted to true do not run animations.
+ * @default false
+ */
+ hide(force?:boolean): void
+ }
+ interface LightBoxOptions {
+ /**
+ * Group name to group elements as a gallery to show.
+ * @default false
+ */
+ group?: string
+ /**
+ * Animation duration between gallery item change
+ * @default 400
+ */
+ duration?: number
+ /**
+ * Allow keyboard navigation
+ * @default true
+ */
+ keyboard?: boolean
+ }
+ interface LightBoxItem {
+ source: string
+ type: string
+ }
+ interface LightBoxElement {
+ /**
+ * Open the lightbox
+ */
+ show(): void
+ }
+ /**
+ * Create a fancy lightbox for images and videos utilizing the @see {@link modal|Modal Component}
+ * Documentation {@link http://getuikit.org/docs/lightbox.html}
+ * <h2>Events:</h2>
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>showitem.uk.lightbox</code></td>
+ * <td>event, data</td>
+ * <td>On lightbox show</td>
+ * </tr>
+ * </table>
+ */
+ interface LightBox {
+ /**
+ * Create dynamic lightbox
+ * @param {Array<LightBoxItem>} items Group of items on the lightbox
+ * @return {LightBoxElement} The lightbox element to show
+ */
+ create(items:Array<LightBoxItem>): LightBoxElement
+ /**
+ * Init element manually
+ */
+ (element:string|JQuery, options?:LightBoxOptions): LightBoxElement
+
+ }
+ type CallbackAutoComplete = () => string
+ interface AutoCompleteOptions {
+ /**
+ * Data source
+ * @default []
+ */
+ source?: string|string[]|CallbackAutoComplete
+ /**
+ * Min. input length before triggering autocomplete
+ * @default 3
+ */
+ minLength?: number
+ /**
+ * Query name when sending ajax request
+ * @default search
+ */
+ param?: string
+ /**
+ * Delay time after stop typing
+ * @default 300
+ */
+ delay?: number
+ }
+ /**
+ * Create inputs that allow users to choose from a list of pre-generated values while typing
+ * Documentation {@link http://getuikit.org/docs/autocomplete.html}
+ * <h2>Events</h2>
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>selectitem.uk.autocomplete</code></td>
+ * <td>event, data, acobject</td>
+ * <td>On item selected</td>
+ * </tr>
+ * <tr>
+ * <td><code>show.uk.autocomplete</code></td>
+ * <td>event</td>
+ * <td>On autocomplete dropdown show</td>
+ * </tr>
+ * </table>
+ */
+ interface AutoComplete {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options?:AutoCompleteOptions): any
+ }
+ interface DatePickerOptions {
+ /**
+ * Start of the week
+ * integer (0..6)
+ * @default 1
+ */
+ weekstart?: number
+ /**
+ * Language string definitions
+ * @default { months:['January',...], weekdays:['Sun',..,'Sat'] }
+ */
+ i18n?: {}
+ /**
+ * Date format string
+ * @default 'DD.MM.YYYY'
+ */
+ format?: string
+ /**
+ * Offset to the input value
+ * @default 5
+ */
+ offsettop?: number
+ /**
+ * Min. date
+ * bool (false to ignore the option)
+ * string (date as in format)
+ * integer (offset in days from current date)
+ * @default false
+ */
+ minDate?: string|boolean|number
+ /**
+ * Max. date
+ * bool (false to ignore the option)
+ * string (date as in format)
+ * integer (offset in days from current date)
+ * @default false
+ */
+ maxDate?: string|boolean|number
+ /**
+ * Position of the datepicker
+ * 'auto', 'top', 'bottom'
+ * @default 'auto'
+ */
+ pos?: string
+
+ }
+ /**
+ * Create a toggleable dropdown with an datepicker
+ * Documentation {@link http://getuikit.org/docs/datepicker.html}
+ * <h2>Events</h2>
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>show.uk.datepicker</code></td>
+ * <td>event</td>
+ * <td>On datepicker dropdown show</td>
+ * </tr>
+ * <tr>
+ * <td><code>hide.uk.datepicker</code></td>
+ * <td>event</td>
+ * <td>On datepicker dropdown hide</td>
+ * </tr>
+ * <tr>
+ * <td><code>update.uk.datepicker</code></td>
+ * <td>event</td>
+ * <td>On calendar rendering</td>
+ * </tr>
+ * </table>
+ */
+ interface DatePicker {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options?:DatePickerOptions): any
+ }
+ interface HtmlEditorOptions {
+ /**
+ * View mode
+ * Possible values 'split','tab'
+ * @default 'split'
+ */
+ mode?: string
+ /**
+ * Button list to appear in the toolbar
+ * @default [ "bold", "italic", "strike", "link", "picture", ... ]
+ */
+ toolbar?: string[]
+ /**
+ * Min. browser width when to switch to responsive tab mode when in split mode
+ * @default 1000
+ */
+ maxsplitsize?: number
+ /**
+ * Label string for preview mode
+ * @default 'Preview'
+ */
+ lblPreview?: string
+ /**
+ * Label string for code mode
+ * @default 'Markdown'
+ */
+ lblCodeview?: string
+ }
+ /**
+ * Create a rich HTML or markdown editor with an immediate preview and syntax highlighting
+ * Documentation {@link http://getuikit.org/docs/htmleditor.html}
+ */
+ interface HtmlEditor {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element: string|JQuery, options?: HtmlEditorOptions): any
+ }
+ interface SliderOptions {
+ /**
+ * Center items mode
+ * @default false
+ */
+ center?: boolean
+ /**
+ * Mouse movement threshold in pixel until trigger element dragging
+ * @default true
+ */
+ threshold?: boolean
+ /**
+ * Infinite scrolling
+ * @default true
+ */
+ infinite?: boolean
+ /**
+ * Class added on active item in center mode
+ * @default uk-active
+ */
+ activecls?: string
+ /**
+ * Defines whether or not the slider items should switch automatically
+ * @default false
+ */
+ autoplay?: boolean
+ /**
+ * Pause autoplay when hovering a slider
+ * @default true
+ */
+ pauseOnHover?: boolean
+ /**
+ * Defines the timespan between switching slider items
+ * @default 7000
+ */
+ autoplayInterval?: number
+ }
+ /**
+ * Create a list of items to use as a responsive carousel slider
+ * Documentation {@link http://getuikit.org/docs/slider.html}
+ * <h2>Events</h2>
+ * <table class="uk-table uk-table-striped uk-text-nowrap">
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>focusitem.uk.slider</code></td>
+ * <td>event, index, item</td>
+ * <td>On item focus</td>
+ * </tr>
+ * </table>
+ */
+ interface Slider {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options?:SliderOptions): any
+ }
+ interface SlideSetOptions {
+ /**
+ * Default visible items in a set
+ * @default 1
+ */
+ default?: number
+ /**
+ * Visible items in a set at small breakpoint
+ * @default null
+ */
+ small?: number
+ /**
+ * Visible items in a set at medium breakpoint
+ * @default null
+ */
+ medium?: number
+ /**
+ * Visible items in a set at large breakpoint
+ * @default null
+ */
+ large?: number
+ /**
+ * Visible items in a set at xlarge breakpoint
+ * @default null
+ */
+ xlarge?: number
+ /**
+ * Animation name
+ * @default 'fade'
+ */
+ animation?: string
+ /**
+ * Animation duration in ms
+ * @default 200
+ */
+ duration?: number
+ /**
+ * Animation delay between items in a set
+ * @default 100
+ */
+ delay?: number
+ /**
+ * Items filter
+ * @default ""
+ */
+ filter?: string
+ /**
+ * Defines whether or not the slideset items should switch automatically.
+ * @default false
+ */
+ autoplay?: boolean
+ /**
+ * Pause autoplay when hovering a slideset.
+ * @default true
+ */
+ pauseOnHover?: boolean
+ /**
+ * Defines the timespan between switching slideset items.
+ * @default 7000
+ */
+ autoplayInterval?: number
+ }
+ /**
+ * Create sets and groups of items, allowing to loop through the sets.
+ * Documentation {@link http://getuikit.org/docs/slideset.html}
+ * <h2>Events</h2>
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>show.uk.slideset</code></td>
+ * <td>event, set</td>
+ * <td>On set show</td>
+ * </tr>
+ * </table>
+ */
+ interface SlideSet {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options?:SlideSetOptions): any
+ }
+ interface SlideShowOptions {
+ /**
+ * Defines the preferred transition between items.
+ * @default 'fade
+ */
+ animation?: string
+
+ /**
+ * Defines the transition duration.
+ * @default 500
+ */
+ duration?: number
+
+ /**
+ * Defines the slideshow height.
+ * @default 'auto'
+ */
+ height?: string
+
+ /**
+ * Defines the first slideshow item to be displayed.
+ * @default 0
+ */
+ start?: number
+
+ /**
+ * Defines whether or not the slideshow items should switch automatically.
+ * @default false
+ */
+ autoplay?: boolean
+
+ /**
+ * Pause autoplay when hovering a slideshow.
+ * @default true
+ */
+ pauseOnHover?: boolean
+
+ /**
+ * Defines the timespan between switching slideshow items.
+ * @default 7000
+ */
+ autoplayInterval?: number
+
+ /**
+ * Defines whether or not a video starts automatically.
+ * @default true
+ */
+ videoautoplay?: boolean
+
+ /**
+ * Defines whether or not a video is muted.
+ * @default false
+ */
+ videomute?: boolean
+
+ /**
+ * Defines whether or not the Ken Burns effect is active. If kenburns is a numeric value, it will be used as
+ * the animation duration.
+ * @default false
+ */
+ kenburns?: boolean
+
+ /**
+ * Animation series.
+ * @default 'uk-animation-middle-left, uk-animation-top-right, uk-animation-bottom-left, uk-animation-top-center,uk-animation-bottom-right'
+ */
+ kenburnsanimations?: string
+
+ /**
+ * Defines the number of slices, if a "Slice" transition is set.
+ * @default 15
+ */
+ slices?: number
+ }
+ /**
+ * Create a responsive image or video slideshow with stunning transition effects, fullscreen mode and overlays.
+ * Documentation {@link http://getuikit.org/docs/slideshow.html}
+ * <h2>Events</h2>
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>show.uk.slideshow</code></td>
+ * <td>event, next slide</td>
+ * <td>On showing a new slide (after animation is finished)</td>
+ * </tr>
+ * </table>
+ */
+ interface SlideShow {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:SlideShowOptions): any
+ }
+ interface ParallaxOptions {
+
+ /**
+ * Animation velocity during scrolling
+ * @default 0.5
+ */
+ velocity?: number
+ /**
+ * Element dimension reference for animation duration.
+ * @default false
+ */
+ target?: boolean
+ /**
+ * Animation range depending on the viewport.
+ * <h2>Possible value</h2>
+ * float (0 to 1)
+ * @default false
+ */
+ viewport?: number
+ /**
+ * Condition for the active status with a width as integer (e.g. 640) or a css media query
+ * @default false
+ * <h2>Possible Value</h2>
+ * integer / string
+ */
+ media?: number|string
+
+ }
+ /**
+ * Animate CSS properties depending on the scroll position of the document.
+ * Documentation {@link http://getuikit.org/docs/parallax.html}
+ */
+ interface Parallax {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:ParallaxOptions): any
+ }
+ interface AccordionOptions {
+ /**
+ * Show first item on init
+ * @default true
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ showfirst?: boolean
+ /**
+ * Allow multiple open items
+ * @default true
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ collapse?: boolean
+ /**
+ * Animate toggle
+ * @default true
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ animate?: boolean
+ /**
+ * Animation function
+ * @default swing
+ * <h2>Possible value</h2>
+ * string
+ */
+ easing?: string
+ /**
+ * Animation duration
+ * @default 300
+ * <h2>Possible value</h2>
+ * integer
+ */
+ duration?: number
+ /**
+ * Css selector for toggles
+ * @default .uk-accordion-title
+ * <h2>Possible value</h2>
+ * string
+ */
+ toggle?: string
+ /**
+ * Css selector for content containers
+ * @default .uk-accordion-content
+ * <h2>Possible value</h2>
+ * string
+ */
+ containers?: string
+ /**
+ * Class to add when an item is active
+ * @default uk-active
+ * <h2>Possible value</h2>
+ * string
+ */
+ clsactive?: string
+ }
+ /**
+ * Create a list of items, allowing each item's content to be expanded and collapsed by clicking its header.
+ * Documentation {@link http://getuikit.org/docs/accordion.html}
+ * <h2>Events</h2>
+ * <table class="uk-table uk-table-striped uk-text-nowrap">
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>toggle.uk.accordion</code></td>
+ * <td>event, active, toggle, content</td>
+ * <td>On item toggle</td>
+ * </tr>
+ * </table>
+ */
+ interface Accordion {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:AccordionOptions): any
+ }
+
+ interface NotifyOptions {
+ /**
+ * The message to display
+ */
+ message?: string
+
+ /**
+ * A notification can be styled by adding a status to the message to indicate an info, success, warning or a
+ * danger status.
+ * <h2>Possible values</h2>
+ * info, sucess, warning, danger
+ * If you want to create one set its style with the CSS class uk-notify-message-yourStatus
+ * @default 'info'
+ */
+ status?: string
+
+ /**
+ * Amount of tiem in milliseconds a messa is visible. Set to 0 for sticky message
+ * @default 5000
+ */
+ timeout?: number
+
+ /**
+ * Adjust the notification's position to different corners.
+ * @default 'top-center'
+ * <h2>Possible values</h2>
+ * top-center, top-left, top-right, bottom-center, bottom-left, bottom-right
+ * If you want to create one value set its style with the CSS uk-notify-yourPosition
+ */
+ pos?: string
+ }
+ /**
+ * Create toggleable notifications that fade out automatically
+ * Documentation {@link http://getuikit.org/docs/notify.html}
+ */
+ interface Notify {
+ /**
+ * Show a message with default options
+ * @param message The html message
+ */
+ (message:string): any
+ /**
+ * Show a message with a different status
+ * @param message The html message
+ * @param status The string status
+ */
+ (message:string, status:string): any
+ /**
+ * Show a message with diferente options
+ * @param message The html message
+ * @param options Options
+ */
+ (message:string, options:NotifyOptions): any
+ /**
+ * Show a message with diferent options
+ * @param options Options
+ */
+ (options:NotifyOptions): any
+ }
+ interface SearchOptions {
+ /**
+ * Data source url
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ source?: string
+
+ /**
+ * Min. input length before triggering autocomplete
+ * @default 3
+ * <h2>Possible value</h2>
+ * integer
+ */
+ minLength?: number
+
+ /**
+ * Query name when sending ajax request
+ * @default search
+ * <h2>Possible value</h2>
+ * string
+ */
+ param?: string
+
+ /**
+ * Delay time after stop typing
+ * @default 300
+ * <h2>Possible value</h2>
+ * integer
+ */
+ delay?: number
+
+ }
+ /**
+ * Easily create a nicely looking search.
+ * Documentation {@link http://getuikit.org/docs/search.html}
+ */
+ interface Search {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:SearchOptions): any
+ }
+ interface NestableOptions {
+ /**
+ * List group
+ * @default false
+ * <h2>Possible value</h2>
+ * string
+ */
+ group?: string
+ /**
+ * Max nesting level
+ * @default 10
+ * <h2>Possible value</h2>
+ * integer
+ */
+ maxDepth?: number
+ /**
+ * Pixel threshold before starting to drag
+ * @default 20
+ * <h2>Possible value</h2>
+ * integer
+ */
+ threshold?: number
+ /**
+ * List node name
+ * @default ul
+ * <h2>Possible value</h2>
+ * string
+ */
+ listNodeName?: string
+ /**
+ * Item node name
+ * @default li
+ * <h2>Possible value</h2>
+ * string
+ */
+ itemNodeName?: string
+ /**
+ * List base class
+ * @default uk-nestable
+ * <h2>Possible value</h2>
+ * string
+ */
+ listBaseClass?: string
+ /**
+ * List class
+ * @default uk-nestable-list
+ * <h2>Possible value</h2>
+ * string
+ */
+ listClass?: string
+ /**
+ * List item class
+ * @default uk-nestable-list-item
+ * <h2>Possible value</h2>
+ * string
+ */
+ listitemClass?: string
+ /**
+ * Item class
+ * @default uk-nestable-item
+ * <h2>Possible value</h2>
+ * string
+ */
+ itemClass?: string
+ /**
+ * Class added to dragged list
+ * @default uk-nestable-list-dragged
+ * <h2>Possible value</h2>
+ * string
+ */
+ dragClass?: string
+ /**
+ * Class added to <code><html></code> when moving
+ * @default uk-nestable-moving
+ * <h2>Possible value</h2>
+ * string
+ */
+ movingClass?: string
+ /**
+ * Class for drag handle
+ * @default uk-nestable-handle
+ * <h2>Possible value</h2>
+ * string
+ */
+ handleClass?: string
+ /**
+ * Class for collapsed items
+ * @default uk-nestable-collapsed
+ * <h2>Possible value</h2>
+ * string
+ */
+ collapsedClass?: string
+ /**
+ * Class for placeholder of currently dragged element
+ * @default uk-nestable-placeholder
+ * <h2>Possible value</h2>
+ * string
+ */
+ placeClass?: string
+ /**
+ * Elements with this class will not trigger dragging. Useful when having the complete item draggable and not
+ * just the handle.
+ * @default uk-nestable-nodrag
+ * <h2>Possible value</h2>
+ * string
+ */
+ noDragClass?: string
+ /**
+ * Class for empty lists
+ * @default uk-nestable-empty
+ * <h2>Possible value</h2>
+ * string
+ */
+ emptyClass?: string
+
+ }
+ /**
+ * Create nestable lists that can be sorted by drag and drop.
+ * Documentation {@link http://getuikit.org/docs/nestable.html}
+ * <h2>Events</h2>
+ * <table>
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>start.uk.nestable</code></td>
+ * <td>event, nestable object</td>
+ * <td>On nestable drag start</td>
+ * </tr>
+ * <tr>
+ * <td><code>move.uk.nestable</code></td>
+ * <td>event, nestable object</td>
+ * <td>On nestable move item</td>
+ * </tr>
+ * <tr>
+ * <td><code>stop.uk.nestable</code></td>
+ * <td>event, nestable object</td>
+ * <td>On nestable stop dragging</td>
+ * </tr>
+ * <tr>
+ * <td><code>change.uk.nestable</code></td>
+ * <td>event, sortable object, dragged element, action</td>
+ * <td>On nestable change item</td>
+ * </tr>
+ * </table>
+ */
+ interface Nestable {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:NestableOptions): any
+ }
+ interface SortableOptions {
+ /**
+ * List group
+ * @default false
+ * <h2>Possible value</h2>
+ * string
+ */
+ group?: string
+ /**
+ * Animation speed in ms
+ * @default 150
+ * <h2>Possible value</h2>
+ * integer
+ */
+ animation?: string
+ /**
+ * Mouse movement threshold in pixel until trigger element dragging
+ * @default 10
+ * <h2>Possible value</h2>
+ * integer
+ */
+ threshold?: string
+ /**
+ * Custom class to define elements which can trigger sorting
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ handleClass?: string
+ /**
+ * Custom class added to the dragged element
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ dragCustomClass?: string
+
+ }
+ /**
+ * Create sortable grids and lists to rearrange the order of its elements.
+ * Documentation {@link http://getuikit.org/docs/sortable.html}
+ * <h2>Events</h2>
+ * <table class="uk-table uk-table-striped uk-text-nowrap">
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>start.uk.sortable</code></td>
+ * <td>event, sortable object, dragged element</td>
+ * <td>On sortable drag start</td>
+ * </tr>
+ * <tr>
+ * <td><code>move.uk.sortable</code></td>
+ * <td>event, sortable object</td>
+ * <td>On sortable move item</td>
+ * </tr>
+ * <tr>
+ * <td><code>stop.uk.sortable</code></td>
+ * <td>event, sortable object, dragged element</td>
+ * <td>On sortable stop dragging</td>
+ * </tr>
+ * <tr>
+ * <td><code>change.uk.sortable</code></td>
+ * <td>event, sortable object, dragged element, action</td>
+ * <td>On sortable change item</td>
+ * </tr>
+ * </table>
+ */
+ interface Sortable {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:SortableOptions): any
+ }
+ interface StickyOptions {
+ /**
+ * Top offset whent sticky should be triggered
+ * @default 0
+ * <h2>Possible value</h2>
+ * integer
+ */
+ top?: number
+ /**
+ * UIkit animation class
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ animation?: string
+ /**
+ * Init class when the element is sticky for the first time
+ * @default uk-sticky-init
+ * <h2>Possible value</h2>
+ * string
+ */
+ clsinit?: string
+ /**
+ * Active class to add, when element is sticky
+ * @default uk-active
+ * <h2>Possible value</h2>
+ * string
+ */
+ clsactive?: string
+ /**
+ * Class to add, when element is not sticky
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ clsinactive?: string
+ /**
+ * Css selector where to get the width from in sticky mode. By default it takes the width from the created wrapper element.
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ getWidthFrom?: string
+ /**
+ * Condition for the active status with a width as integer (e.g. 640) or a css media query
+ * @default false
+ * <h2>Possible value</h2>
+ * integer / string
+ */
+ media?: number|string
+ /**
+ * Make sure that a sticky element is not over a targeted element via location hash on dom-ready.
+ * @default false
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ target?: boolean
+ /**
+ * Show sticky element only when scrolling up.
+ * @default false
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ showup?: boolean
+ /**
+ * Set to <code>true</code> to bind sticky to the parent or a Css selector to bind sticky to a specific element.
+ * @default false
+ * <h2>Possible value</h2>
+ * mixed
+ */
+ boundary?: boolean|string
+
+ }
+ /**
+ * Make elements remain at the top of the viewport, like a sticky navbar.
+ * Documentation {@link http://getuikit.org/docs/sticky.html}
+ * <h2>Events</h2>
+ * <table class="uk-table uk-table-striped uk-text-nowrap">
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td><code>active.uk.sticky</code></td>
+ * <td>event</td>
+ * <td>Element getting sticky</td>
+ * </tr>
+ * <tr>
+ * <td><code>inactive.uk.sticky</code></td>
+ * <td>event</td>
+ * <td>Element leaving sticky mode</td>
+ * </tr>
+ * </table>
+ */
+ interface Sticky {
+ /**
+ * Init the element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:StickyOptions): any
+ }
+ interface TimepickerOptions {
+ /**
+ * Defines the preferred time notation
+ * @default '24h'
+ * <h2>Possible value</h2>
+ * '24h' or '12h'
+ */
+ format?: string
+ /**
+ * Start time
+ * @default 0
+ * <h2>Possible value</h2>
+ * Integer between 0 and 24
+ */
+ start?: number
+ /**
+ * End time
+ * @default 24
+ * <h2>Possible value</h2>
+ * Integer between 0 and 24
+ */
+ end?: number
+
+ }
+ /**
+ * Create a timepicker which can easily be used by selecting a time value from a pre filled dropdown.
+ * Documentation {@link http://getuikit.org/docs/timepicker.html}
+ */
+ interface Timepicker {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:TimepickerOptions): any
+ }
+ interface TooltipOptions {
+ /**
+ * Offset to the source element
+ * @default 5
+ * <h2>Possible value</h2>
+ * integer
+ */
+ offset?: number
+ /**
+ * Tooltip position
+ * @default 'top'
+ * <h2>Possible value</h2>
+ * string
+ */
+ pos?: string
+ /**
+ * Fade in tooltip
+ * @default false
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ animation?: boolean
+ /**
+ * Delay tooltip show in ms
+ * @default 0
+ * <h2>Possible value</h2>
+ * integer
+ */
+ delay?: number
+ /**
+ * Custom class to add on show
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ cls?: string
+ /**
+ * Toggled active class
+ * @default 'uk-active'
+ * <h2>Possible value</h2>
+ * string
+ */
+ activeClass?: string
+
+ }
+ /**
+ * Easily create a nicely looking tooltip.
+ * Documentation {@link http://getuikit.org/docs/tooltip.html}
+ */
+ interface Tooltip {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:TooltipOptions): any
+ }
+ interface UploadOptions {
+ /**
+ * Target url for the upload
+ * @default ''
+ * <h2>Possible value</h2>
+ * string
+ */
+ action?: string
+ /**
+ * Send each file one by one
+ * @default true
+ * <h2>Possible value</h2>
+ * boolean
+ */
+ single?: boolean
+ /**
+ * Post query name
+ * @default files[]
+ * <h2>Possible value</h2>
+ * string
+ */
+ param?: string
+ /**
+ * Additional request parameters
+ * @default {}
+ * <h2>Possible value</h2>
+ * JSON Object
+ */
+ params?: {}
+ /**
+ * File filter
+ * @default *.*
+ * <h2>Possible value</h2>
+ * string
+ */
+ allow?: string
+ /**
+ * Limit the number of files to upload
+ * @default false
+ * <h2>Possible value</h2>
+ * integer
+ */
+ filelimit?: number
+ /**
+ * Response type from server
+ * @default text
+ * <h2>Possible Value</h2>
+ * (text|json)
+ */
+ "type"?: string
+ before?: (settings: UploadOptions, files: string|string[]) => any
+ beforeAll?: (files: string|string[]) => any
+ beforeSend?: (xhr: XMLHttpRequest) => any
+ progress?: (percent: number) => any
+ complete?: (response: any, xhr: XMLHttpRequest) => any
+ allcomplete?: (response: any, xhr: XMLHttpRequest) => any
+ notallowed?: (file: string|string[], settings: UploadOptions) => any
+ loadstart?: (event: any) => any
+ load?: (event: any) => any
+ loadend?: (event: any) => any
+ error?: (event: any) => any
+ abort?: (event: any) => any
+ readystatechange?: (event: any) => any
+ }
+
+ /**
+ * Allow users to upload files through a file input form element or a placeholder area.
+ * Documentation {@link http://getuikit.org/docs/upload.html}
+ * <h2>Callbacks</h2>
+ * <table class="uk-table uk-table-striped">
+ * <tr>
+ * <th>Name</th>
+ * <th>Parameter</th>
+ * </tr>
+ * <tr>
+ * <td><code>before</code></td>
+ * <td>settings, files</td>
+ * </tr>
+ * <tr>
+ * <td><code>beforeAll</code></td>
+ * <td>files</td>
+ * </tr>
+ * <tr>
+ * <td><code>beforeSend</code></td>
+ * <td>xhr</td>
+ * </tr>
+ * <tr>
+ * <td><code>progress</code></td>
+ * <td>percent</td>
+ * </tr>
+ * <tr>
+ * <td><code>complete</code></td>
+ * <td>response, xhr</td>
+ * </tr>
+ * <tr>
+ * <td><code>allcomplete</code></td>
+ * <td>response, xhr</td>
+ * </tr>
+ * <tr>
+ * <td><code>notallowed</code></td>
+ * <td>file, settings</td>
+ * </tr>
+ * <tr>
+ * <td><code>loadstart</code></td>
+ * <td>event</td>
+ * </tr>
+ * <tr>
+ * <td><code>load</code></td>
+ * <td>event</td>
+ * </tr>
+ * <tr>
+ * <td><code>loadend</code></td>
+ * <td>event</td>
+ * </tr>
+ * <tr>
+ * <td><code>error</code></td>
+ * <td>event</td>
+ * </tr>
+ * <tr>
+ * <td><code>abort</code></td>
+ * <td>event</td>
+ * </tr>
+ * <tr>
+ * <td><code>readystatechange</code></td>
+ * <td>event</td>
+ * </tr>
+ * </table>
+ */
+ interface Upload {
+ /**
+ * Init element manually
+ * @param element
+ * @param options
+ */
+ (element:string|JQuery, options:UploadOptions): any
+ }
+ export var modal:Modal;
+ export var lightbox:LightBox;
+ export var offcanvas:OffCanvas;
+ export var autocomplete:AutoComplete;
+ export var datepicker:DatePicker;
+ export var htmleditor:HtmlEditor;
+ export var slider:Slider;
+ export var slideset:SlideSet;
+ export var slideshow:SlideShow;
+ export var parallax:Parallax;
+ export var accordion:Accordion;
+ export var notify:Notify;
+ export var search:Search;
+ export var nestable:Nestable;
+ export var sortable:Sortable;
+ export var sticky:Sticky;
+ export var timepicker:Timepicker;
+ export var tooltip:Tooltip;
+ export var uploadSelect: Upload;
+ export var uploadDrop: Upload;
+}
+
+declare module 'uikit' {
+ export = UIkit
+}
diff --git a/utils-merge/utils-merge-tests.ts b/utils-merge/utils-merge-tests.ts
new file mode 100644
index 000000000..b4a4a1487
--- /dev/null
+++ b/utils-merge/utils-merge-tests.ts
@@ -0,0 +1,9 @@
+/// <reference path="./utils-merge.d.ts" />
+
+import merge from "utils-merge";
+
+type Result = {a: string, b: number};
+
+let result: Result;
+
+result = merge<{a: string}, {b: number}, Result>({a: ''}, {b: 42});
diff --git a/utils-merge/utils-merge.d.ts b/utils-merge/utils-merge.d.ts
new file mode 100644
index 000000000..0cb7f2522
--- /dev/null
+++ b/utils-merge/utils-merge.d.ts
@@ -0,0 +1,10 @@
+// Type definitions for utils-merge
+// Project: https://github.com/jaredhanson/utils-merge
+// Definitions by: Ilya Mochalov <https://github.com/chrootsu>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "utils-merge" {
+ function merge<TA, TB, TResult>(a: TA, b: TB): TResult;
+
+ export default merge;
+}
diff --git a/voximplant-websdk/voximplant-websdk-tests.ts b/voximplant-websdk/voximplant-websdk-tests.ts
new file mode 100644
index 000000000..2a9363c37
--- /dev/null
+++ b/voximplant-websdk/voximplant-websdk-tests.ts
@@ -0,0 +1,85 @@
+/// <reference path="./voximplant-websdk.d.ts"/>
+
+var vox: VoxImplant.Client = VoxImplant.getInstance(),
+ call: VoxImplant.Call;
+
+vox.init({
+ micRequired: true
+});
+
+vox.addEventListener("SDKReady", function(event: VoxImplant.Events.SDKReady) {
+ console.log("VoxImplant SDK ver. " + event.version + " initialized");
+ vox.connect();
+});
+
+vox.addEventListener("ConnectionEstablished", function(event: VoxImplant.Events.ConnectionEstablished) {
+ console.log("Connection established");
+ vox.login("username", "password");
+});
+
+vox.addEventListener("ConnectionClosed", function(event: VoxImplant.Events.ConnectionClosed) {
+ console.log("Connection closed");
+});
+
+vox.addEventListener("ConnectionFailed", function(event: VoxImplant.Events.ConnectionFailed) {
+ console.log("Connection failed. Reason: " + event.message);
+});
+
+vox.addEventListener("AuthEvent", function(event: VoxImplant.Events.AuthEvent) {
+ if (event.result === true) {
+ // Authorized successfully
+ console.log("Logged in as " + event.displayName);
+
+ call = vox.call("some_number", false);
+ call.addEventListener("Connected", function(callevent: VoxImplant.CallEvents.Connected) {
+ console.log("Call connected");
+ });
+ call.addEventListener("Failed", function(callevent: VoxImplant.CallEvents.Failed) {
+ console.log("Call failed, reason: " + callevent.reason);
+ });
+ call.addEventListener("Disconnected", function(callevent: VoxImplant.CallEvents.Disconnected) {
+ console.log("Call disconnected");
+ });
+
+ var msg_id:String = vox.sendInstantMessage("other_user", "Hello World!");
+
+ } else {
+ console.log("Authorization failed. Code: " + event.code);
+ }
+});
+
+vox.addEventListener("MicAccessResult", function(event: VoxImplant.Events.MicAccessResult) {
+ console.log("Microphone access allowed: " + event.result);
+});
+
+vox.addEventListener("IncomingCall", function(event: VoxImplant.Events.IncomingCall) {
+ call = event.call;
+ call.addEventListener("Connected", function(callevent: VoxImplant.CallEvents.Connected) {
+ console.log("Inbound Call Connected");
+ setTimeout(function() {
+ vox.disconnect();
+ }, 5000);
+ });
+ call.answer();
+});
+
+vox.addEventListener("MessageReceived", function(event: VoxImplant.IMEvents.MessageReceived) {
+ console.log("Message received: " + event.content + " from " + event.id + " id " + event.message_id);
+});
+
+vox.addEventListener("SourcesInfoUpdated", function(event: VoxImplant.Events.SourcesInfoUpdated) {
+ var audioSources: VoxImplant.AudioSourceInfo[] = vox.audioSources(),
+ videoSources: VoxImplant.VideoSourceInfo[] = vox.videoSources();
+ console.log("Received recording sources data:");
+ console.log("Audio: " + audioSources);
+ console.log("Video: " + videoSources);
+
+ vox.useAudioSource(audioSources[0].id, function() { console.log('OK'); }, function() { console.log('Failed'); });
+ vox.useVideoSource(videoSources[0].id, function() { console.log('OK'); }, function() { console.log('Failed'); });
+});
+
+vox.addEventListener("RosterReceived", function(event: VoxImplant.IMEvents.RosterReceived) {
+ var roster: VoxImplant.RosterItem[] = event.roster;
+ console.log("Roster received: " + roster);
+});
+
diff --git a/voximplant-websdk/voximplant-websdk.d.ts b/voximplant-websdk/voximplant-websdk.d.ts
new file mode 100644
index 000000000..2e715d770
--- /dev/null
+++ b/voximplant-websdk/voximplant-websdk.d.ts
@@ -0,0 +1,1169 @@
+// Type definitions for VoxImplant Web SDK 3.0.x
+// Project: http://voximplant.com/
+// Definitions by: Alexey Aylarov <https://github.com/aylarov/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare namespace VoxImplant {
+
+ module Events {
+
+ /**
+ * Event dispatched after login , loginWithOneTimeKey, requestOneTimeLoginKey or loginWithCode function call
+ */
+ interface AuthEvent {
+ /**
+ * Auth error code, possible values are: 301 - code for 'code' auth type was sent, 302 - key for 'onetimekey' auth type received, 401 - invalid password, 404 - invalid username, 403 - user account is frozen, 500 - internal error
+ */
+ code? : number;
+ /**
+ * Authorized user's display name
+ */
+ displayName?: string;
+ /**
+ * This parameter is used to calculate hash parameter for loginWithOneTimeKey method. AuthEvent with the key dispatched after requestOneTimeLoginKey method was called
+ */
+ key?: string;
+ /**
+ * Application options
+ */
+ options?: Object;
+ /**
+ * True in case of successful authorization, false - otherwise
+ */
+ result: boolean;
+ }
+
+ /**
+ * Event dispatched if connection to VoxImplant Cloud was closed because of network problems. See connect function
+ */
+ interface ConnectionClosed {}
+
+ /**
+ * Event dispatched after connection to VoxImplant Cloud was established successfully. See connect function
+ */
+ interface ConnectionEstablished {}
+
+ /**
+ * Event dispatched if connection to VoxImplant Cloud couldn't be established. See connect function
+ */
+ interface ConnectionFailed {
+ /**
+ * Failure reason description
+ */
+ message: string;
+ }
+
+ /**
+ * Event dispatched in case of instant messaging subsystem error
+ */
+ interface IMError {
+ /**
+ * Error data object, contains the error details
+ */
+ errorData: Object;
+ /**
+ * Error type
+ */
+ errorType: IMErrorType;
+ }
+
+ /**
+ * Event dispatched when there is a new incoming call to current user
+ */
+ interface IncomingCall {
+ /**
+ * Incoming call instance. See VoxImplant.Call for details
+ */
+ call: Call;
+ /**
+ * Optional SIP headers received with the message
+ */
+ headers?: Object;
+ }
+
+ /**
+ * Event dispatched after user interaction with the mic access dialog.
+ */
+ interface MicAccessResult {
+ /**
+ * True is access was allowed, false - otherwise
+ */
+ result: boolean;
+ }
+
+ /**
+ * Event dispatched when packet loss data received from VoxImplant servers
+ */
+ interface NetStatsReceived {
+ /**
+ * Network info object
+ */
+ stats: NetworkInfo;
+ }
+
+ /**
+ * Event dispatched after sound playback was stopped. See playToneScript and stopPlayback functions
+ */
+ interface PlaybackFinished {}
+
+ /**
+ * Event dispatched after SDK was successfully initialized after init function call
+ */
+ interface SDKReady {
+ /**
+ * SDK version
+ */
+ version: string;
+ }
+
+ /**
+ * Event dispatched when audio and video sources information was updated. See audioSources and videoSources for details
+ */
+ interface SourcesInfoUpdated {}
+
+ }
+
+ module CallEvents {
+
+ /**
+ * Event dispatched after call was connected
+ */
+ interface Connected {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ /**
+ * Optional SIP headers received with the message
+ */
+ headers?: Object;
+ }
+
+ /**
+ * Event dispatched after call was disconnected
+ */
+ interface Disconnected {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ /**
+ * Optional SIP headers received with the message
+ */
+ headers?: Object;
+ }
+
+ /**
+ * Event dispatched after if call failed
+ */
+ interface Failed {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ /**
+ * Status code of the call (i.e. 486)
+ */
+ code: number;
+ /**
+ * Optional SIP headers received with the message
+ */
+ headers?: Object;
+ /**
+ * Status message of call failure (i.e. Busy Here)
+ */
+ reason: string;
+ }
+
+ /**
+ * Event dispatched when INFO message is received
+ */
+ interface InfoReceived {
+ /**
+ * Content of the message
+ */
+ body: string;
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ /**
+ * Optional SIP headers received with the message
+ */
+ headers?: Object;
+ /**
+ * MIME type of INFO message
+ */
+ mimeType: string;
+ }
+
+ /**
+ * Event dispatched when text message is received
+ */
+ interface MessageReceived {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ /**
+ * Content of the message
+ */
+ text: string;
+ }
+
+ /**
+ * Event dispatched when progress tone playback starts
+ */
+ interface ProgressToneStart {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ }
+
+ /**
+ * Event dispatched when progress tone playback stops
+ */
+ interface ProgressToneStop {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ }
+
+ /**
+ * Event dispatched when call has been transferred successfully
+ */
+ interface TransferComplete {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ }
+
+ /**
+ * Event dispatched when call transfer failed
+ */
+ interface TransferFailed {
+ /**
+ * Call that dispatched the event
+ */
+ call: Call;
+ }
+ }
+
+ module IMEvents {
+
+ /**
+ * Event dispatched when chat session state updated
+ */
+ interface ChatStateUpdate {
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Resource name
+ */
+ resource?: string,
+ /**
+ * Current chat session state. See VoxImplant.ChatStateType enum
+ */
+ state: ChatStateType
+ }
+
+ /**
+ * Event dispatched when instant message received
+ */
+ interface MessageReceived {
+ /**
+ * Message content
+ */
+ content: string,
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Message id
+ */
+ message_id: string,
+ /**
+ * Resource name
+ */
+ resource?: string
+ }
+
+ /**
+ * Event dispatched when sent message status changed
+ */
+ interface MessageStatus {
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Message id
+ */
+ message_id: string,
+ /**
+ * Resource name
+ */
+ resource?: string,
+ /**
+ * Message event type. See VoxImplant.MessageEventType enum
+ */
+ type: MessageEventType
+ }
+
+ /**
+ * Event dispatched when self presence updated
+ */
+ interface PresenceUpdate {
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Status message
+ */
+ message: string,
+ /**
+ * Current presence status
+ */
+ presence: UserStatuses,
+ /**
+ * Resource name
+ */
+ resource?: string
+ }
+
+ /**
+ * Event dispatched when roster item changed
+ */
+ interface RosterItemChange {
+ /**
+ * User display name
+ */
+ displayName: string,
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Resource name
+ */
+ resource?: string,
+ /**
+ * Roster item event type. See VoxImplant.RosterItemEvent enum
+ */
+ type: RosterItemEvent
+ }
+
+ /**
+ * Event dispatched when roster item presence update happened
+ */
+ interface RosterPresenceUpdate {
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Status message
+ */
+ message?: string,
+ /**
+ * Current presence status
+ */
+ presence: UserStatuses,
+ /**
+ * Resource name
+ */
+ resource?: string
+ }
+
+ /**
+ * Event dispatched when roster data received
+ */
+ interface RosterReceived {
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Array contains VoxImplant.RosterItem elements
+ */
+ roster: RosterItem[]
+ }
+
+ /**
+ * Event dispatched when some user tries to add current user into his roster. Current user can confirm or reject the subscription, then VoxImplant.IMEvents.RosterItemChange will be dispatched on for user that made the request
+ */
+ interface SubscriptionRequest {
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * Optional message
+ */
+ message?: string,
+ /**
+ * Resource name
+ */
+ resource?: string,
+ /**
+ * Message event type. See VoxImplant.SubscriptionRequestType enum
+ */
+ type: SubscriptionRequestType
+ }
+
+ }
+
+ type VoxImplantEvent = Events.AuthEvent | Events.ConnectionClosed | Events.ConnectionEstablished |
+ Events.ConnectionFailed | Events.IMError | Events.IncomingCall | Events.MicAccessResult |
+ Events.NetStatsReceived | Events.PlaybackFinished | Events.SDKReady | Events.SourcesInfoUpdated;
+
+
+ type VoxImplantCallEvent = CallEvents.Connected | CallEvents.Disconnected | CallEvents.Failed |
+ CallEvents.InfoReceived | CallEvents.MessageReceived | CallEvents.ProgressToneStart |
+ CallEvents.ProgressToneStop | CallEvents.TransferComplete | CallEvents.TransferFailed;
+
+ type VoxImplantIMEvent = IMEvents.ChatStateUpdate | IMEvents.MessageReceived | IMEvents.MessageStatus |
+ IMEvents.PresenceUpdate | IMEvents.RosterItemChange | IMEvents.RosterPresenceUpdate |
+ IMEvents.RosterReceived | IMEvents.SubscriptionRequest;
+
+ /**
+ * VoxImplant SDK Configuration
+ */
+ interface Config {
+ /**
+ * XSS protection for inbound instant messages that can contain HTML content
+ */
+ imXSSprotection?: boolean;
+ /**
+ * If set to true microphone access dialog will be shown and all functions will become available only after user allowed access
+ */
+ micRequired?: boolean;
+ /**
+ * Automatically plays progress tone by means of SDK according to specified progressToneCountry
+ */
+ progressTone?: boolean;
+ /**
+ * Country code for progress tone generated automatically if progressTone set to true
+ */
+ progressToneCountry?: string;
+ /**
+ * Show debug info in console
+ */
+ showDebugInfo?: boolean;
+ /**
+ * Show Flash Settings panel instead of standard Allow/Deny dialog (in Flash mode)
+ */
+ showFlashSettings?: boolean;
+ /**
+ * Id of HTMLElement that will be used as container for Flash component of SDK (Mic/cam access dialog will appear in the container). If micRequired set to true element should have size not less than 215x138 (px) for access dialog to be shown
+ */
+ swfContainer?: string;
+ /**
+ * Force VoxImplant to use Flash (WebRTC is used if available by default)
+ */
+ useFlashOnly?: boolean;
+ /**
+ * Force VoxImplant to use WebRTC (WebRTC is used if available by default). Error will be thrown if WebRTC in unavailable
+ */
+ useRTCOnly?: boolean;
+ /**
+ * Default constraints that will be applied while the next attachRecordingDevice function call or if micRequired set to true
+ */
+ videoConstraints?: VideoSettings;
+ /**
+ * Video support
+ */
+ videoSupport?: boolean;
+ }
+
+ /**
+ * VoxImplant login options
+ */
+ interface LoginOptions {
+ /**
+ * If set to false Web SDK can be used only for ACD status management
+ */
+ receiveCalls?: boolean;
+ /**
+ * If set to true user presence will be changed automatically while a call
+ */
+ serverPresenceControl?: boolean;
+ }
+
+ /**
+ * Audio recording device info
+ */
+ interface AudioSourceInfo {
+ /**
+ * Device id that can be used to choose audio recording device
+ */
+ id: number | string;
+ /**
+ * Device name , in WebRTC mode populated with real data only when app has been opened using HTTPS protocol
+ */
+ name: string;
+ }
+
+ /**
+ * Video recording device info
+ */
+ interface VideoSourceInfo {
+ /**
+ * Device id that can be used to choose video recording device
+ */
+ id: number | string;
+ /**
+ * Device name , in WebRTC mode populated with real data only when app has been opened using HTTPS protocol
+ */
+ name: string;
+ }
+
+ enum ChatStateType {
+ /**
+ * User is actively participating in the chat session
+ */
+ Active,
+ /**
+ * User is composing a message
+ */
+ Composing,
+ /**
+ * User has effectively ended their participation in the chat session
+ */
+ Gone,
+ /**
+ * User has not been actively participating in the chat session
+ */
+ Inactive,
+ /**
+ * Invalid type
+ */
+ Invalid,
+ /**
+ * User had been composing but now has stopped
+ */
+ Paused
+ }
+
+ enum IMErrorType {
+ RemoteFunctionError,
+ Error,
+ RosterError
+ }
+
+ enum MessageEventType {
+ /**
+ * Cancels the 'Composing' event
+ */
+ Cancel,
+ /**
+ * Indicates that a reply is being composed
+ */
+ Composing,
+ /**
+ * Indicates that the message has been delivered to the recipient
+ */
+ Delivered,
+ /**
+ * Indicates that the message has been displayed
+ */
+ Displayed,
+ /**
+ * Invalid type
+ */
+ Invalid,
+ /**
+ * Indicates that the message has been stored offline by the intended recipient's server
+ */
+ Offline
+ }
+
+ enum OperatorACDStatuses {
+ AfterService,
+ DND,
+ InService,
+ Offline,
+ Online,
+ Ready,
+ Timeout
+ }
+
+ enum RosterItemEvent {
+ /**
+ * Roster item added
+ */
+ Added,
+ /**
+ * Roster item removed
+ */
+ Removed,
+ /**
+ * User subscribed on your status updates (authorized the request)
+ */
+ Subscribed,
+ /**
+ * User unsubscribed from your status updates (didn't authorize the request)
+ */
+ Unsubscribed,
+ /**
+ * Roster item updated
+ */
+ Updated
+ }
+
+ enum SubscriptionRequestType {
+ /**
+ * User is asking for permission to add you into his roster
+ */
+ Subscribe,
+ /**
+ * User removed you from his roster
+ */
+ Unsubscribe
+ }
+
+ enum UserStatuses {
+ /**
+ * User is away
+ */
+ Away,
+ /**
+ * User is available for chat
+ */
+ Chat,
+ /**
+ * User is in DND state (Do Not Disturbed)
+ */
+ DND,
+ /**
+ * User is offline
+ */
+ Offline,
+ /**
+ * User is online
+ */
+ Online,
+ /**
+ * User is in XA state (eXtended Away)
+ */
+ XA
+ }
+
+ /**
+ * Client class used to control platform functions. Can't be instantiatied directly (singleton), please use VoxImplant.getInstance to get the class instance
+ */
+ interface Client {
+ /**
+ * Register handler for specified event
+ *
+ * @param eventName Event name
+ * @param eventHandler Handler function. A single parameter is passed - object with the event information
+ */
+ addEventListener(eventName: string, eventHandler: (eventObject: VoxImplantEvent | VoxImplantIMEvent) => any): void;
+ /**
+ * Add roster item (IM)
+ *
+ * @param user_id User id
+ * @param name Display name
+ * @param group User group
+ */
+ addRosterItem(user_id: string, name: string, group?: string): void;
+ /**
+ * Add roster item group (IM)
+ *
+ * @param user_id User id
+ * @param group Group name
+ */
+ addRosterItemGroup(user_id: string, group: string): void;
+ /**
+ * Enable microphone/camera if micRequired in VoxImplant.Config was set to false (WebRTC mode only)
+ *
+ * @param successCallback A function called in case of successful audio recording device change
+ * @param failedCallback A function called in case of problems while changing audio recording device
+ */
+ attachRecordingDevice(successCallback?: () => any, failedCallback?: () => any): void;
+ /**
+ * Get a list of all currently available audio sources / microphones
+ */
+ audioSources(): AudioSourceInfo[];
+ /**
+ * Create call
+ *
+ * @param number The number to call
+ * @param useVideo Tells if video should be supported for the call
+ * @param customData Custom string associated with the call session. It can be later obtained from Call History using HTTP API
+ * @param extraHeaders Optional custom parameters (SIP headers) that should be passed with call (INVITE) message. Parameter names must start with "X-" to be processed by application. IMPORTANT: Headers size limit is 200 bytes
+ */
+ call(number: string, useVideo?: boolean, customData?: string, extraHeaders?: Object): Call;
+ /**
+ * Get current config
+ */
+ config(): Config;
+ /**
+ * Connect to VoxImplant Cloud
+ */
+ connect(): void;
+ /**
+ * Check if connected to VoxImplant Cloud
+ */
+ connected(): boolean;
+ /**
+ * Disable microphone/camera if micRequired in VoxImplant.Config was set to false (WebRTC mode only)
+ */
+ detachRecordingDevice(): void;
+ /**
+ * Disconnect from VoxImplant Cloud
+ */
+ disconnect(): void;
+ /**
+ * Initialize SDK. SDKReady event will be dispatched after succesful SDK initialization. SDK can't be used until it's initialized
+ *
+ * @param config Client configuration options
+ */
+ init(config?: Config): void;
+ /**
+ * Check if WebRTC support is available
+ */
+ isRTCsupported(): boolean;
+ /**
+ * Login into application
+ *
+ * @param username
+ * @param password
+ * @param options Login options
+ */
+ login(username: string, password: string, options?: LoginOptions): void;
+ /**
+ * Login into application using 'code' auth method
+ *
+ * @param username
+ * @param code
+ * @param options Login options
+ */
+ loginWithCode(username: string, code: string, options?: LoginOptions): void;
+ /**
+ * Login into application using 'onetimekey' auth method
+ *
+ * @param username
+ * @param hash
+ * @param options Login options
+ */
+ loginWithOneTimeKey(username: string, hash: string, options?: LoginOptions): void;
+ /**
+ * Move roster item group (IM)
+ *
+ * @param user_id User id
+ * @param groupSrc Group name (source)
+ * @param groupDst Group name (destination)
+ */
+ moveRosterItemGroup(user_id: string, groupSrc: string, groupDst: string): void;
+ /**
+ * Play ToneScript using WebAudio API
+ *
+ * @param script Tonescript string
+ * @param loop Loop playback if true
+ */
+ playToneScript(script: string, loop?: boolean): void;
+ /**
+ * Remove handler for specified event
+ *
+ * @param eventName Event name
+ * @param eventHandler Handler function
+ */
+ removeEventListener(eventName: string, eventHandler: () => any): void;
+ /**
+ * Remove roster item (IM)
+ *
+ * @param user_id User id
+ */
+ removeRosterItem(user_id: string): void;
+ /**
+ * Remove roster item group (IM)
+ *
+ * @param user_id User id
+ * @param group Group name
+ */
+ remoteRosterItemGroup(user_id: string, group: string): void;
+ /**
+ * Rename roster item (IM)
+ *
+ * @param user_id User id
+ * @param name New display name
+ */
+ renameRosterItem(user_id: string, name: string): void;
+ /**
+ * Request a key for 'onetimekey' auth method. Server will send the key in AuthResult event with code 302
+ *
+ * @param username
+ */
+ requestOneTimeLoginKey(username: string): void;
+ /**
+ * Send message to user (IM)
+ *
+ * @param user_id User id
+ * @param content Message content
+ */
+ sendInstantMessage(user_id: string, content: string): string;
+ /**
+ * Start/stop sending local video to remote party/parties
+ *
+ * @param flag Start/stop - true/false
+ */
+ sendVideo(flag: boolean): void;
+ /**
+ * Set active call
+ *
+ * @param call VoxImplant call instance
+ * @param active If true make call active, otherwise make call inactive
+ */
+ setCallActive(call: Call, active: boolean): void;
+ /**
+ * Set chat session state info
+ *
+ * @param user_id User id
+ * @param status Chat session status. See VoxImplant.ChatStateType enum
+ */
+ setChatState(user_id: string, status: ChatStateType): void;
+ /**
+ * Set local video position
+ *
+ * @param x Horizontal position (px)
+ * @param y Vertical position (px)
+ */
+ setLocalVideoPosition(x: number, y: number): void;
+ /**
+ * Set local video size
+ *
+ * @param width Width in pixels
+ * @param height Height in pixels
+ */
+ setLocalVideoSize(width: number, height: number): void;
+ /**
+ * Set local video size
+ *
+ * @param user_id User id
+ * @param type Message event type: VoxImplant.MessageEventType.Delivered or VoxImplant.MessageEventType.Displayed. See VoxImplant.MessageEventType enum
+ * @param message_id Message id(s)
+ */
+ setMessageStatus(user_id: string, type: MessageEventType, message_id: string[]): void;
+ /**
+ * Set ACD status
+ *
+ * @param status Presence status string, see VoxImplant.OperatorACDStatuses
+ */
+ setOperatorACDStatus(status: OperatorACDStatuses): void;
+ /**
+ * Set presence
+ *
+ * @param status Presence status from VoxImplant.UserStatuses
+ * @param msg Presence text message
+ */
+ setPresenceStatus(status: UserStatuses, msg: string): void;
+ /**
+ * Set background color of flash app (only for Flash mode)
+ *
+ * @param color Color in web format (i.e. #000000 for black)
+ */
+ setSwfColor(color: string): void;
+ /**
+ * Set bandwidth limit for video calls. Currently supported by Chrome/Chromium. The limit will be applied for the next call. (WebRTC mode only)
+ *
+ * @param bandwidth Bandwidth limit in kilobits per second (kbps)
+ */
+ setVideoBandwidth(bandwidth: number): void;
+ /**
+ * Set video settings globally. This settings will be used for the next call.
+ *
+ * @param settings Video settings
+ * @param successCallback Success callback function
+ * @param failedCallback Failed callback function
+ */
+ setVideoSettings(settings: VideoSettings | FlashVideoSettings, successCallback?: () => any, failedCallback?: () => any): void;
+ /**
+ * Show flash settings panel
+ *
+ * @param panel Settings type - default/microphone/camera/etc as described in SecurityPanel class
+ */
+ showFlashSettingsPanel(panel?: string): void;
+ /**
+ * Show/hide local video
+ *
+ * @param flag Show/hide - true/false
+ */
+ showLocalVideo(flag: boolean): void;
+ /**
+ * Stop playing ToneScript using WebAudio API
+ */
+ stopPlayback(): void;
+ /**
+ * Transfer call, depending on the result VoxImplant.CallEvents.TransferComplete or VoxImplant.CallEvents.TransferFailed event will be dispatched
+ *
+ * @param call1 Call which will be transferred
+ * @param call2 Call where call1 will be transferred
+ */
+ transferCall(call1: Call, call2: Call): void;
+ /**
+ * Use specified audio source , use audioSources to get the list of available audio sources
+ *
+ * @param id Id of the audio source
+ * @param successCallback Called in WebRTC mode if audio source changed successfully
+ * @param failedCallback Called in WebRTC mode if audio source couldn't be changed successfully
+ */
+ useAudioSource(id: number | string, successCallback?: () => any, failedCallback?: () => any): void;
+ /**
+ * Use specified audio source , use audioSources to get the list of available audio sources
+ *
+ * @param id Id of the video source
+ * @param successCallback Called in WebRTC mode if video source changed successfully
+ * @param failedCallback Called in WebRTC mode if video source couldn't be changed successfully
+ */
+ useVideoSource(id: number | string, successCallback?: () => any, failedCallback?: () => any): void;
+ /**
+ * Get a list of all currently available video sources / cameras
+ */
+ videoSources(): VideoSourceInfo[];
+ }
+
+ interface Call {
+ /**
+ * Returns information about the call's media state (active/inactive)
+ */
+ active(): boolean;
+ /**
+ * Register handler for specified event
+ *
+ * @param eventName Event name
+ * @param eventHandler Handler function. A single parameter is passed - object with the event information
+ */
+ addEventListener(eventName: string, eventHandler: (eventObject: VoxImplantCallEvent) => any): void;
+ /**
+ * Answer on incoming call
+ *
+ * @param customData Set custom string associated with call session. It can be later obtained from Call History using HTTP API
+ * @param extraHeaders Optional custom parameters (SIP headers) that should be sent after accepting incoming call. Parameter names must start with "X-" to be processed by application
+ */
+ answer(customData?: string, extraHeaders?: Object): void;
+ /**
+ * Reject incoming call
+ *
+ * @param extraHeaders Optional custom parameters (SIP headers) that should be sent after accepting incoming call. Parameter names must start with "X-" to be processed by application
+ */
+ decline(extraHeaders?: Object): void;
+ /**
+ * Returns display name
+ */
+ displayName(): string;
+ /**
+ * Returns HTML video element's id for the call (WebRTC mode)
+ */
+ getVideoElementId(): string;
+ /**
+ * Hangup call
+ *
+ * @param extraHeaders Optional custom parameters (SIP headers) that should be sent after disconnecting/cancelling call. Parameter names must start with "X-" to be processed by application
+ */
+ hangup(extraHeaders?: Object): void;
+ /**
+ * Returns headers object
+ */
+ headers(): Object;
+ /**
+ * Returns call id
+ */
+ id(): string;
+ /**
+ * Mute microphone
+ */
+ muteMicrophone(): void;
+ /**
+ * Mute sound
+ */
+ mutePlayback(): void;
+ /**
+ * Returns dialed number or caller id
+ */
+ number(): string;
+ /**
+ * Reject incoming call
+ *
+ * @param extraHeaders Optional custom parameters (SIP headers) that should be sent after disconnecting/cancelling call. Parameter names must start with "X-" to be processed by application
+ */
+ reject(extraHeaders?: Object): void;
+ /**
+ * Remove handler for specified event
+ *
+ * @param eventName Event name
+ * @param eventHandler Handler function
+ */
+ removeEventListener(eventName: string, eventHandler: () => any): void;
+ /**
+ * Send Info (SIP INFO) message inside the call
+ *
+ * @param mimeType MIME type of the message
+ * @param body Message content
+ * @param extraHeaders Optional headers to be passed with the message
+ */
+ sendInfo(mimeType: string, body: string, extraHeaders?: Object): void;
+ /**
+ * Send text message
+ *
+ * @param msg Message text
+ */
+ sendMessage(msg: string): void;
+ /**
+ * Send tone (DTMF)
+ *
+ * @param key Send tone according to pressed key: 0-9 , * , #
+ */
+ sendTone(key: string): void;
+ /**
+ * Set remote video position
+ *
+ * @param x Horizontal position (px)
+ * @param y Vertical position (px)
+ */
+ setRemoteVideoPosition(x: number, y: number): void;
+ /**
+ * Set remote video size
+ *
+ * @param width Width in pixels
+ * @param height Height in pixels
+ */
+ setRemoteVideoSize(width: number, height: number): void;
+ /**
+ * Set video settings
+ *
+ * @param settings Video settings for current call
+ * @param successCallback Called in WebRTC mode if video settings were applied successfully
+ * @param failedCallback Called in WebRTC mode if video settings couldn't be applied
+ */
+ setVideoSettings(settings: VideoSettings | FlashVideoSettings, successCallback?: () => any, failedCallback?: () => any): void;
+ /**
+ * Show/hide remote party video
+ *
+ * @param flag Show/hide - true/false
+ */
+ showRemoteVideo(flag: boolean): void;
+ /**
+ * Get call's current state
+ */
+ state(): string;
+ /**
+ * Unmute microphone
+ */
+ unmuteMicrophone(): void;
+ /**
+ * Unmute sound
+ */
+ unmutePlayback(): void;
+ }
+
+ /**
+ * WebRTC Video Settings (aka Constraints)
+ */
+ interface VideoSettings {
+ /**
+ * Mandatory constraints object
+ */
+ mandatory: Object;
+ /**
+ * Optional constraints object
+ */
+ optional: Object;
+ }
+
+ /**
+ * Flash Video Settings
+ */
+ interface FlashVideoSettings {
+ /**
+ * The maximum amount of bandwidth the current outgoing video feed can use, in bytes
+ */
+ bandwidth?: number;
+ /**
+ * The maximum rate at which the camera can capture data, in frames per second
+ */
+ fps?: number;
+ /**
+ * Height in pixels (should be set together with width)
+ */
+ height?: number;
+ /**
+ * Width in pixels (should be set together with height)
+ */
+ width?: number;
+ /**
+ * Keyframe interval (seconds)
+ */
+ keyframeInterval?: number;
+ /**
+ * H.264 video codec level
+ */
+ level?: string;
+ /**
+ * H.264 video codec profile
+ */
+ profile?: string;
+ /**
+ * The required level of picture quality, as determined by the amount of compression being applied to each video frame. Acceptable quality values range from 1 (lowest quality, maximum compression) to 100 (highest quality, no compression). The default value is 0, which means that picture quality can vary as needed to avoid exceeding available bandwidth
+ */
+ quality?: number;
+ }
+
+ /**
+ * Network information
+ */
+ interface NetworkInfo {
+ /**
+ * Packet loss percentage
+ */
+ packetLoss: number;
+ }
+
+ /**
+ * VoxImplant roster item
+ */
+ interface RosterItem {
+ /**
+ * Groups this roster item belongs to
+ */
+ groups: string[],
+ /**
+ * User id
+ */
+ id: string,
+ /**
+ * User display name
+ */
+ name: string,
+ /**
+ * Resources
+ */
+ resources: string[],
+ /**
+ * Subscription type
+ */
+ subscription_type: number
+ }
+
+ /**
+ * Get Client instance to use platform functions
+ */
+ function getInstance(): Client;
+ /**
+ * VoxImplant Web SDK lib version
+ */
+ function version(): String;
+
+}
+
+declare module "voximplant-websdk" {
+ export = VoxImplant;
+}
diff --git a/webpack/webpack-env-tests.ts b/webpack/webpack-env-tests.ts
new file mode 100644
index 000000000..b4a9693ec
--- /dev/null
+++ b/webpack/webpack-env-tests.ts
@@ -0,0 +1,15 @@
+/// <reference path="./webpack-env.d.ts" />
+
+interface SomeModule {
+ someMethod(): void;
+}
+
+let someModule = require<SomeModule>('./someModule');
+someModule.someMethod();
+
+let context = require.context('./somePath', true);
+let contextModule = context<SomeModule>('./someModule');
+
+require(['./someModule', './otherModule'], (someModule: SomeModule, otherModule: any) => {
+
+});
diff --git a/webpack/webpack-env.d.ts b/webpack/webpack-env.d.ts
new file mode 100644
index 000000000..01ea6e404
--- /dev/null
+++ b/webpack/webpack-env.d.ts
@@ -0,0 +1,103 @@
+// Type definitions for webpack 1.12.2 (module API)
+// Project: https://github.com/webpack/webpack
+// Definitions by: use-strict <https://github.com/use-strict>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/**
+ * Webpack module API - variables and global functions available inside modules
+ */
+
+declare namespace __WebpackModuleApi {
+ interface RequireContext {
+ keys(): string[];
+ <T>(id: string): T;
+ resolve(id: string): string;
+ }
+
+ interface RequireFunction {
+ /**
+ * Returns the exports from a dependency. The call is sync. No request to the server is fired. The compiler ensures that the dependency is available.
+ */
+ <T>(path: string): T;
+ /**
+ * Behaves similar to require.ensure, but the callback is called with the exports of each dependency in the paths array. There is no option to provide a chunk name.
+ */
+ (paths: string[], callback: (...modules: any[]) => void): void;
+ /**
+ * Download additional dependencies on demand. The paths array lists modules that should be available. When they are, callback is called. If the callback is a function expression, dependencies in that source part are extracted and also loaded on demand. A single request is fired to the server, except if all modules are already available.
+ *
+ * This creates a chunk. The chunk can be named. If a chunk with this name already exists, the dependencies are merged into that chunk and that chunk is used.
+ */
+ ensure: (paths: string[], callback: (require: <T>(path: string) => T) => void) => void;
+ context: (path: string, deep?: boolean, filter?: RegExp) => RequireContext;
+ /**
+ * Returns the module id of a dependency. The call is sync. No request to the server is fired. The compiler ensures that the dependency is available.
+ *
+ * The module id is a number in webpack (in contrast to node.js where it is a string, the filename).
+ */
+ resolve(path: string): number;
+ /**
+ * Like require.resolve, but doesn’t include the module into the bundle. It’s a weak dependency.
+ */
+ resolveWeak(path: string): number;
+ /**
+ * Ensures that the dependency is available, but don’t execute it. This can be use for optimizing the position of a module in the chunks.
+ */
+ include(path: string): void;
+ /**
+ * Multiple requires to the same module result in only one module execution and only one export. Therefore a cache in the runtime exists. Removing values from this cache cause new module execution and a new export. This is only needed in rare cases (for compatibility!).
+ */
+ cache: {
+ [id: string]: any;
+ }
+ }
+}
+
+declare var require: __WebpackModuleApi.RequireFunction;
+
+/**
+ * The resource query of the current module.
+ *
+ * e.g. __resourceQuery === "?test" // Inside "file.js?test"
+ */
+declare var __resourceQuery: string;
+
+/**
+ * Equals the config options output.publicPath.
+ */
+declare var __webpack_public_path__: string;
+
+/**
+ * The raw require function. This expression isn’t parsed by the Parser for dependencies.
+ */
+declare var __webpack_require__: any;
+
+/**
+ * The internal chunk loading function
+ *
+ * @param chunkId The id for the chunk to load.
+ * @param callback A callback function called once the chunk is loaded.
+ */
+declare var __webpack_chunk_load__: (chunkId: any, callback: (require: (id: string) => any) => void) => void;
+
+/**
+ * Access to the internal object of all modules.
+ */
+declare var __webpack_modules__: any[];
+
+/**
+ * Access to the hash of the compilation.
+ *
+ * Only available with the HotModuleReplacementPlugin or the ExtendedAPIPlugin
+ */
+declare var __webpack_hash__: any;
+
+/**
+ * Generates a require function that is not parsed by webpack. Can be used to do cool stuff with a global require function if available.
+ */
+declare var __non_webpack_require__: any;
+
+/**
+ * Equals the config option debug
+ */
+declare var DEBUG: boolean;
\ No newline at end of file
diff --git a/webpack/webpack-tests.ts b/webpack/webpack-tests.ts
index 5a70c2e10..27a4a5385 100644
--- a/webpack/webpack-tests.ts
+++ b/webpack/webpack-tests.ts
@@ -386,22 +386,3 @@ plugin = new webpack.ExtendedAPIPlugin();
plugin = new webpack.NoErrorsPlugin();
plugin = new webpack.WatchIgnorePlugin(paths);
-//
-// http://webpack.github.io/docs/api-in-modules.html
-//
-
-interface SomeModule {
- someMethod(): void;
-}
-
-let someModule: SomeModule = require('./someModule');
-someModule.someMethod();
-
-let context2 = require.context('./somePath', true);
-let contextModule: SomeModule = context2('./someModule');
-
-require(['./someModule', './otherModule'], (someModule: SomeModule, otherModule: any) => {
-
-});
-
-
diff --git a/webpack/webpack.d.ts b/webpack/webpack.d.ts
index 82cf56458..f2049bbc9 100644
--- a/webpack/webpack.d.ts
+++ b/webpack/webpack.d.ts
@@ -259,101 +259,3 @@ declare module "webpack" {
export = webpack;
}
-/**
- * Webpack module API - variables and global functions available inside modules
- */
-
-declare namespace __WebpackModuleApi {
- interface RequireContext {
- keys(): string[];
- <T>(id: string): T;
- resolve(id: string): string;
- }
-
- interface RequireFunction {
- /**
- * Returns the exports from a dependency. The call is sync. No request to the server is fired. The compiler ensures that the dependency is available.
- */
- <T>(path: string): T;
- /**
- * Behaves similar to require.ensure, but the callback is called with the exports of each dependency in the paths array. There is no option to provide a chunk name.
- */
- (paths: string[], callback: (...modules: any[]) => void): void;
- /**
- * Download additional dependencies on demand. The paths array lists modules that should be available. When they are, callback is called. If the callback is a function expression, dependencies in that source part are extracted and also loaded on demand. A single request is fired to the server, except if all modules are already available.
- *
- * This creates a chunk. The chunk can be named. If a chunk with this name already exists, the dependencies are merged into that chunk and that chunk is used.
- */
- ensure: (paths: string[], callback: (require: <T>(path: string) => T) => void) => void;
- context: (path: string, deep?: boolean, filter?: RegExp) => RequireContext;
- /**
- * Returns the module id of a dependency. The call is sync. No request to the server is fired. The compiler ensures that the dependency is available.
- *
- * The module id is a number in webpack (in contrast to node.js where it is a string, the filename).
- */
- resolve(path: string): number;
- /**
- * Like require.resolve, but doesn’t include the module into the bundle. It’s a weak dependency.
- */
- resolveWeak(path: string): number;
- /**
- * Ensures that the dependency is available, but don’t execute it. This can be use for optimizing the position of a module in the chunks.
- */
- include(path: string): void;
- /**
- * Multiple requires to the same module result in only one module execution and only one export. Therefore a cache in the runtime exists. Removing values from this cache cause new module execution and a new export. This is only needed in rare cases (for compatibility!).
- */
- cache: {
- [id: string]: any;
- }
- }
-}
-
-declare var require: __WebpackModuleApi.RequireFunction;
-
-/**
- * The resource query of the current module.
- *
- * e.g. __resourceQuery === "?test" // Inside "file.js?test"
- */
-declare var __resourceQuery: string;
-
-/**
- * Equals the config options output.publicPath.
- */
-declare var __webpack_public_path__: string;
-
-/**
- * The raw require function. This expression isn’t parsed by the Parser for dependencies.
- */
-declare var __webpack_require__: any;
-
-/**
- * The internal chunk loading function
- *
- * @param chunkId The id for the chunk to load.
- * @param callback A callback function called once the chunk is loaded.
- */
-declare var __webpack_chunk_load__: (chunkId: any, callback: (require: (id: string) => any) => void) => void;
-
-/**
- * Access to the internal object of all modules.
- */
-declare var __webpack_modules__: any[];
-
-/**
- * Access to the hash of the compilation.
- *
- * Only available with the HotModuleReplacementPlugin or the ExtendedAPIPlugin
- */
-declare var __webpack_hash__: any;
-
-/**
- * Generates a require function that is not parsed by webpack. Can be used to do cool stuff with a global require function if available.
- */
-declare var __non_webpack_require__: any;
-
-/**
- * Equals the config option debug
- */
-declare var DEBUG: boolean;
diff --git a/winjs/winjs.d.ts b/winjs/winjs.d.ts
index 195ecb66e..903019698 100644
--- a/winjs/winjs.d.ts
+++ b/winjs/winjs.d.ts
@@ -4,18 +4,12 @@
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/* *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
+Copyright (c) Microsoft Corporation. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************** */
/**
@@ -58,6 +52,11 @@ interface IOHelper {
* @returns A promise that is completed when the file has been written.
**/
writeText(fileName: string, text: string): WinJS.Promise<number>;
+
+ /**
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ storage: any;
}
/**
@@ -88,16 +87,6 @@ declare module WinJS.Application {
//#endregion Objects
- //#region Methods
-
- /**
- * Informs the application object that asynchronous work is being performed, and that this event handler should not be considered complete until the promise completes. This function can be set inside the handlers for all WinJS.Application events: onactivated oncheckpoint onerror onloaded onready onsettings onunload.
- * @param promise The promise that should complete before processing is complete.
- **/
- function setPromise(promise: Promise<any>): void;
-
- //#endregion Methods
-
//#region Functions
/**
@@ -141,47 +130,61 @@ declare module WinJS.Application {
//#region Events
+ interface IPromiseEvent extends CustomEvent {
+ /**
+ * Informs the application object that asynchronous work is being performed, and that this event handler should not be considered complete until the promise completes. This function can be set inside the handlers for all WinJS.Application events: onactivated oncheckpoint onerror onloaded onready onsettings onunload.
+ * @param promise The promise that should complete before processing is complete.
+ **/
+ setPromise(promise: IPromise<any>): void;
+ }
+
/**
* Occurs when WinRT activation has occurred. The name of this event is "activated" (and also "mainwindowactivated"). This event occurs after the loaded event and before the ready event.
* @param eventInfo An object that contains information about the event. For more information about event arguments, see the WinRT event argument classes: WebUICachedFileUpdaterActivatedEventArgs, WebUICameraSettingsActivatedEventArgs, WebUIContactPickerActivatedEventArgs, WebUIDeviceActivatedEventArgs, WebUIFileActivatedEventArgs, WebUIFileOpenPickerActivatedEventArgs, WebUIFileSavePickerActivatedEventArgs, WebUILaunchActivatedEventArgs, WebUIPrintTaskSettingsActivatedEventArgs, WebUIProtocolActivatedEventArgs, WebUISearchActivatedEventArgs, WebUIShareTargetActivatedEventArgs.
**/
- function onactivated(eventInfo: CustomEvent): void;
+ function onactivated(eventInfo: IPromiseEvent): void;
/**
* Occurs when receiving PLM notification or when the checkpoint function is called.
* @param eventInfo An object that contains information about the event. The detail property of this object includes the following subproperties: type, setPromise.
**/
- function oncheckpoint(eventInfo: CustomEvent): void;
+ function oncheckpoint(eventInfo: IPromiseEvent): void;
/**
* Occurs when an unhandled error has been raised.
* @param eventInfo An object that contains information about the event.
**/
- function onerror(eventInfo: CustomEvent): void;
+ function onerror(eventInfo: IPromiseEvent): void;
/**
* Occurs after the DOMContentLoaded event, which fires after the page has been parsed but before all the resources are loaded. This event occurs before the activated event and the ready event.
* @param eventInfo An object that contains information about the event. The detail property of this object includes the following subproperties: type, setPromise.
**/
- function onloaded(eventInfo: CustomEvent): void;
+ function onloaded(eventInfo: IPromiseEvent): void;
/**
* Occurs when the application is ready. This event occurs after the loaded event and the activated event.
* @param eventInfo An object that contains information about the event. The detail property of this object includes the following sub-properties: type, setPromise.
**/
- function onready(eventInfo: CustomEvent): void;
+ function onready(eventInfo: IPromiseEvent): void;
/**
* Occurs when the settings charm is invoked.
* @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: type, applicationcommands.
**/
- function onsettings(eventInfo: CustomEvent): void;
+ function onsettings(eventInfo: IPromiseEvent): void;
/**
* Occurs when the application is about to be unloaded.
* @param eventInfo An object that contains information about the event. The detail property of this object includes the following sub-properties: type, setPromise.
**/
- function onunload(eventInfo: CustomEvent): void;
+ function onunload(eventInfo: IPromiseEvent): void;
+
+ /**
+ * Occurs whenever a user clicks the hardware backbutton.
+ * @param eventInfo An object that contains information about the event. The detail property of this object includes the following sub-properties: type
+ **/
+ function onbackclick(eventInfo: IPromiseEvent): void;
//#endregion Events
@@ -192,11 +195,6 @@ declare module WinJS.Application {
declare module WinJS.Binding {
//#region Properties
- /**
- * Determines whether or not binding should automatically set the ID of an element. This property should be set to true in apps that use WinJS (WinJS) binding.
- **/
- var optimizeBindingReferences: boolean;
-
//#endregion Properties
//#region Objects
@@ -276,7 +274,7 @@ declare module WinJS.Binding {
/**
* Do not instantiate. A list returned by the createFiltered method.
**/
- class FilteredListProjection<T> extends ListProjection<T> {
+ interface FilteredListProjection<T> extends ListProjection<T> {
//#region Methods
/**
@@ -320,9 +318,9 @@ declare module WinJS.Binding {
}
/**
- * Do not instantiate. A list of groups.
+ * A list of groups.
**/
- class GroupsListProjection<T> extends ListBase<T> {
+ interface GroupsListProjection<T> extends ListBase<T> {
//#region Methods
/**
@@ -362,13 +360,13 @@ declare module WinJS.Binding {
/**
* Do not instantiate. Sorts the underlying list by group key and within a group respects the position of the item in the underlying list. Returned by createGrouped.
**/
- class GroupedSortedListProjection<T> extends SortedListProjection<T> {
+ interface GroupedSortedListProjection<T, G> extends SortedListProjection<T> {
//#region Properties
/**
* Gets a List, which is a projection of the groups that were identified in this list.
**/
- groups: GroupsListProjection<T>;
+ groups: GroupsListProjection<G>;
//#endregion Properties
@@ -383,12 +381,12 @@ declare module WinJS.Binding {
/**
* Represents a list of objects that can be accessed by index or by a string key. Provides methods to search, sort, filter, and manipulate the data.
**/
- class List<T> extends ListBaseWithMutators<T> {
+ class List<T> implements ListBaseWithMutators<T> {
//#region Constructors
/**
* Creates a List object.
- * @constructor
+ * @constructor
* @param list The array containing the elements to initalize the list.
* @param options You can set two Boolean options: binding and proxy. If options.binding is true, the list contains the result of calling as on the element values. If options.proxy is true, the list specified as the first parameter is used as the storage for the List. This option should be used with care, because uncoordinated edits to the data storage may result in errors.
**/
@@ -396,86 +394,6 @@ declare module WinJS.Binding {
//#endregion Constructors
- //#region Methods
-
- /**
- * Gets a key/data pair for the specified list index.
- * @param index The index of value to retrieve.
- * @returns An object with .key and .data properties.
- **/
- getItem(index: number): IKeyDataPair<T>;
-
- /**
- * Gets a key/data pair for the list item key specified.
- * @param key The key of the value to retrieve.
- * @returns An object with .key and .data properties.
- **/
- getItemFromKey(key: string): IKeyDataPair<T>;
-
- /**
- * Gets the index of the first occurrence of a key in a list.
- * @param key The key to locate in the list.
- * @returns The index of the first occurrence of a key in a list, or -1 if not found.
- **/
- indexOfKey(key: string): number;
-
- /**
- * Moves the value at index to the specified position.
- * @param index The original index of the value.
- * @param newIndex The index of the value after the move.
- **/
- move(index: number, newIndex: number): void;
-
- /**
- * Forces the list to send a itemmutated notification to any listeners for the value at the specified index.
- * @param index The index of the value that was mutated.
- **/
- notifyMutated(index: number): void;
-
- /**
- * Returns a list with the elements reversed. This method reverses the elements of a list object in place. It does not create a new list object during execution.
- **/
- reverse(): void;
-
- /**
- * Replaces the value at the specified index with a new value.
- * @param index The index of the value that was replaced.
- * @param newValue The new value.
- **/
- setAt(index: number, newValue: T): void;
-
- /**
- * Returns a list with the elements sorted. This method sorts the elements of a list object in place. It does not create a new list object during execution.
- * @param sortFunction The function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. This function must always return the same results, given the same inputs. The results should not depend on values that are subject to change. You must call notifyMutated each time an item changes. Do not batch change notifications.
- **/
- sort(sortFunction?: (left: T, right: T) => number): void;
-
- /**
- * Removes elements from a list and, if necessary, inserts new elements in their place, returning the deleted elements.
- * @param start The zero-based location in the list from which to start removing elements.
- * @param howMany The number of elements to remove.
- * @param item The elements to insert into the list in place of the deleted elements.
- * @returns The deleted elements.
- **/
- splice(start: number, howMany?: number, ...item: T[]): T[];
-
- //#endregion Methods
-
- //#region Properties
-
- /**
- * Gets or sets the length of the list, which is an integer value one higher than the highest element defined in the list.
- **/
- length: number;
-
- //#endregion Properties
-
- }
-
- /**
- * Represents a base class for lists.
- **/
- class ListBase<T> {
//#region Events
/**
@@ -555,7 +473,341 @@ declare module WinJS.Binding {
* @param groupSorter A function that accepts two arguments. The function is called with pairs of group keys found in the list. It must return one of the following numeric values: negative if the first argument is less than the second (sorted before), zero if the two arguments are equivalent, positive if the first argument is greater than the second (sorted after).
* @returns A grouped projection over the list.
**/
- createGrouped(groupKey: (x: T) => string, groupData: (x: T) => any, groupSorter?: (left: string, right: string) => number): GroupedSortedListProjection<T>;
+ createGrouped<G>(groupKey: (x: T) => string, groupData: (x: T) => G, groupSorter?: (left: string, right: string) => number): GroupedSortedListProjection<T, G>;
+
+ /**
+ * Creates a live sorted projection over this list. As the list changes, the sorted projection reacts to those changes and may also change.
+ * @param sorter A function that accepts two arguments. The function is called with elements in the list. It must return one of the following numeric values: negative if the first argument is less than the second, zero if the two arguments are equivalent, positive if the first argument is greater than the second. This function must always return the same results, given the same inputs. The results should not depend on values that are subject to change. You must call notifyMutated each time an item changes. Do not batch change notifications.
+ * @returns A sorted projection over the list.
+ **/
+ createSorted(sorter: (left: T, right: T) => number): SortedListProjection<T>;
+
+ /**
+ * Raises an event of the specified type and with the specified additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event.
+ **/
+ dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Checks whether the specified callback function returns true for all elements in a list.
+ * @param callback A function that accepts up to three arguments. This function is called for each element in the list until it returns false or the end of the list is reached.
+ * @param thisArg An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used.
+ * @returns true if the callback returns true for all elements in the list.
+ **/
+ every(callback: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean;
+
+ /**
+ * Returns the elements of a list that meet the condition specified in a callback function.
+ * @param callback A function that accepts up to three arguments. The function is called for each element in the list. This function must always return the same results, given the same inputs. The results should not depend on values that are subject to change. You must call notifyMutated each time an item changes. Do not batch change notifications.
+ * @param thisArg An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used.
+ * @returns An array containing the elements that meet the condition specified in the callback function.
+ **/
+ filter(callback: (value: T, index: number, array: T[]) => any, thisArg?: any): T[];
+
+ /**
+ * Calls the specified callback function for each element in a list.
+ * @param callback A function that accepts up to three arguments. The function is called for each element in the list. The arguments are as follows: value, index, array.
+ * @param thisArg An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used.
+ **/
+ forEach(callback: (value: T, index: number, array: T[]) => void, thisArg?: any): void;
+
+ /**
+ * Gets the value at the specified index.
+ * @param index The index of the value to get.
+ * @returns The value at the specified index.
+ **/
+ getAt(index: number): T;
+
+ /**
+ * Gets a key/data pair for the specified list index.
+ * @param index The index of value to retrieve.
+ * @returns An object with .key and .data properties.
+ **/
+ getItem(index: number): IKeyDataPair<T>;
+
+ /**
+ * Gets a key/data pair for the list item key specified.
+ * @param key The key of the value to retrieve.
+ * @returns An object with .key and .data properties.
+ **/
+ getItemFromKey(key: string): IKeyDataPair<T>;
+
+ /**
+ * Gets the index of the first occurrence of the specified value in a list.
+ * @param searchElement The value to locate in the list.
+ * @param fromIndex The index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
+ * @returns The index of the first occurrence of a value in a list or -1 if not found.
+ **/
+ indexOf(searchElement: T, fromIndex?: number): number;
+
+ /**
+ * Gets the index of the first occurrence of a key in a list.
+ * @param key The key to locate in the list.
+ * @returns The index of the first occurrence of a key in a list, or -1 if not found.
+ **/
+ indexOfKey(key: string): number;
+
+ /**
+ * Returns a string consisting of all the elements of a list separated by the specified separator string.
+ * @param separator A string used to separate the elements of a list. If this parameter is omitted, the list elements are separated with a comma.
+ * @returns The elements of a list separated by the specified separator string.
+ **/
+ join(separator?: string): string;
+
+ /**
+ * Gets the index of the last occurrence of the specified value in a list.
+ * @param searchElement The value to locate in the list.
+ * @param fromIndex The index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the list.
+ * @returns The index of the last occurrence of a value in a list, or -1 if not found.
+ **/
+ lastIndexOf(searchElement: T, fromIndex?: number): number;
+
+ /**
+ * Calls the specified callback function on each element of a list, and returns an array that contains the results.
+ * @param callback A function that accepts up to three arguments. The function is called for each element in the list.
+ * @param thisArg n object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used.
+ * @returns An array containing the result of calling the callback function on each element in the list.
+ **/
+ map<G>(callback: (value: T, index: number, array: T[]) => G, thisArg?: any): G[];
+
+ /**
+ * Moves the value at index to the specified position.
+ * @param index The original index of the value.
+ * @param newIndex The index of the value after the move.
+ **/
+ move(index: number, newIndex: number): void;
+
+ /**
+ * Notifies listeners that a property value was updated.
+ * @param name The name of the property that is being updated.
+ * @param newValue The new value for the property.
+ * @param oldValue The old value for the property.
+ * @returns A promise that is completed when the notifications are complete.
+ **/
+ notify(name: string, newValue: any, oldValue: any): Promise<any>;
+
+ /**
+ * Forces the list to send a itemmutated notification to any listeners for the value at the specified index.
+ * @param index The index of the value that was mutated.
+ **/
+ notifyMutated(index: number): void;
+
+ /**
+ * Forces the list to send a reload notification to any listeners.
+ **/
+ notifyReload(): void;
+
+ /**
+ * Removes the last element from a list and returns it.
+ * @returns The last element from the list.
+ **/
+ pop(): T;
+
+ /**
+ * Appends new element(s) to a list, and returns the new length of the list.
+ * @param value The element to insert at the end of the list.
+ * @returns The new length of the list.
+ **/
+ push(value: T): number;
+ push(...values: T[]): number;
+
+ /**
+ * Accumulates a single result by calling the specified callback function for all elements in a list. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+ * @param callback A function that accepts up to four arguments. These arguments are: previousValue, currentValue, currentIndex, array. The function is called for each element in the list.
+ * @param initiallValue If initialValue is specified, it is used as the value with which to start the accumulation. The first call to the function provides this value as an argument instead of a list value.
+ * @returns The return value from the last call to the callback function.
+ **/
+ reduce(callback: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => T, initiallValue?: T): T;
+
+ /**
+ * Accumulates a single result by calling the specified callback function for all elements in a list, starting with the last member of the list. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+ * @param callback A function that accepts up to four arguments. These arguments are: previousValue, currentValue, currentIndex, array. The function is called for each element in the list.
+ * @param initialValue If initialValue is specified, it is used as the value with which to start the accumulation. The first call to the callback function provides this value as an argument instead of a list value.
+ * @returns The return value from the last call to callback function.
+ **/
+ reduceRight(callback: (previousValue: any, currentValue: any, currentIndex: number, array: T[]) => T, initialValue?: T): T;
+
+ /**
+ * Removes an event listener from the control.
+ * @param type The type (name) of the event.
+ * @param listener The listener to remove.
+ * @param useCapture true if capture is to be initiated, otherwise false.
+ **/
+ removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
+
+ /**
+ * Returns a list with the elements reversed. This method reverses the elements of a list object in place. It does not create a new list object during execution.
+ **/
+ reverse(): void;
+
+ /**
+ * Replaces the value at the specified index with a new value.
+ * @param index The index of the value that was replaced.
+ * @param newValue The new value.
+ **/
+ setAt(index: number, newValue: T): void;
+
+ /**
+ * Removes the first element from a list and returns it.
+ * @returns The first element from the list.
+ **/
+ shift(): T;
+
+ /**
+ * Extracts a section of a list and returns a new list.
+ * @param begin The index that specifies the beginning of the section.
+ * @param end The index that specifies the end of the section.
+ * @returns Returns a section of list.
+ **/
+ slice(begin: number, end?: number): T[];
+
+ /**
+ * Checks whether the specified callback function returns true for any element of a list.
+ * @param callback A function that accepts up to three arguments. The function is called for each element in the list until it returns true, or until the end of the list.
+ * @param thisArg An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used.
+ * @returns true if callback returns true for any element in the list.
+ **/
+ some(callback: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean;
+
+ /**
+ * Returns a list with the elements sorted. This method sorts the elements of a list object in place. It does not create a new list object during execution.
+ * @param sortFunction The function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. This function must always return the same results, given the same inputs. The results should not depend on values that are subject to change. You must call notifyMutated each time an item changes. Do not batch change notifications.
+ **/
+ sort(sortFunction?: (left: T, right: T) => number): void;
+
+ /**
+ * Removes elements from a list and, if necessary, inserts new elements in their place, returning the deleted elements.
+ * @param start The zero-based location in the list from which to start removing elements.
+ * @param howMany The number of elements to remove.
+ * @param item The elements to insert into the list in place of the deleted elements.
+ * @returns The deleted elements.
+ **/
+ splice(start: number, howMany?: number, ...item: T[]): T[];
+
+ /**
+ * Removes one or more listeners from the notification list for a given property.
+ * @param name The name of the property to unbind. If this parameter is omitted, all listeners for all events are removed.
+ * @param action The function to remove from the listener list for the specified property. If this parameter is omitted, all listeners are removed for the specific property.
+ * @returns This object is returned.
+ **/
+ unbind(name: string, action: Function): any;
+
+ /**
+ * Appends new element(s) to a list, and returns the new length of the list.
+ * @param value The element to insert at the start of the list.
+ * @returns The new length of the list.
+ **/
+ unshift(value: T): number;
+ unshift(...values: T[]): number;
+
+ //#endregion Methods
+
+ //#region Properties
+
+ /**
+ * Gets the IListDataSource for the list. The only purpose of this property is to adapt a List to the data model that is used by ListView and FlipView.
+ **/
+ dataSource: WinJS.UI.IListDataSource<T>;
+
+ /**
+ * Gets or sets the length of the list, which is an integer value one higher than the highest element defined in the list.
+ **/
+ length: number;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#endregion Properties
+ }
+
+ /**
+ * Represents a base class for lists.
+ **/
+ interface ListBase<T> {
+ //#region Events
+
+ /**
+ * An item in the list has changed its value.
+ * @param eventInfo An object that contains information about the event. The detail contains the following information: index, key, newItem, newValue, oldItem, oldValue.
+ **/
+ onitemchanged(eventInfo: CustomEvent): void;
+
+ /**
+ * A new item has been inserted into the list.
+ * @param eventInfo An object that contains information about the event. The detail contains the following information: index, key, value.
+ **/
+ oniteminserted(eventInfo: CustomEvent): void;
+
+ /**
+ * An item has been changed locations in the list.
+ * @param eventInfo An object that contains information about the event. The detail contains the following information: index, key, value.
+ **/
+ onitemmoved(eventInfo: CustomEvent): void;
+
+ /**
+ * An item has been mutated. This event occurs as a result of calling the notifyMutated method.
+ * @param eventInfo An object that contains information about the event. The detail contains the following information: index, key, value.
+ **/
+ onitemmutated(eventInfo: CustomEvent): void;
+
+ /**
+ * An item has been removed from the list.
+ * @param eventInfo An object that contains information about the event. The detail contains the following information: index, key, value.
+ **/
+ onitemremoved(eventInfo: CustomEvent): void;
+
+ /**
+ * The list has been refreshed. Any references to items in the list may be incorrect.
+ * @param eventInfo An object that contains information about the event. The detail property of this object is null.
+ **/
+ onreload(eventInfo: CustomEvent): void;
+
+ //#endregion Events
+
+ //#region Methods
+
+ /**
+ * Adds an event listener to the control.
+ * @param type The type (name) of the event.
+ * @param listener The listener to invoke when the event gets raised.
+ * @param useCapture If true, initiates capture, otherwise false.
+ **/
+ addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+
+ /**
+ * Links the specified action to the property specified in the name parameter. This function is invoked when the value of the property may have changed. It is not guaranteed that the action will be called only when a value has actually changed, nor is it guaranteed that the action will be called for every value change. The implementation of this function coalesces change notifications, such that multiple updates to a property value may result in only a single call to the specified action.
+ * @param name The name of the property to which to bind the action.
+ * @param action The function to invoke asynchronously when the property may have changed.
+ * @returns A reference to this observableMixin object.
+ **/
+ bind(name: string, action: Function): any;
+
+ /**
+ * Returns a new list consisting of a combination of two arrays.
+ * @param item Additional items to add to the end of the list.
+ * @returns An array containing the concatenation of the list and any other supplied items.
+ **/
+ concat(...item: T[]): T[];
+
+ /**
+ * Creates a live filtered projection over this list. As the list changes, the filtered projection reacts to those changes and may also change.
+ * @param predicate A function that accepts a single argument. The createFiltered function calls the callback with each element in the list. If the function returns true, that element will be included in the filtered list. This function must always return the same results, given the same inputs. The results should not depend on values that are subject to change. You must call notifyMutated each time an item changes. Do not batch change notifications.
+ * @returns A filtered projection over the list.
+ **/
+ createFiltered(predicate: (x: T) => boolean): FilteredListProjection<T>;
+
+ /**
+ * Creates a live grouped projection over this list. As the list changes, the grouped projection reacts to those changes and may also change. The grouped projection sorts all the elements of the list to be in group-contiguous order. The grouped projection also contains a .groups property, which is a List representing the groups that were found in the list.
+ * @param groupKey A function that accepts a single argument. The function is called with each element in the list, the function should return a string representing the group containing the element. This function must always return the same results, given the same inputs. The results should not depend on values that are subject to change. You must call notifyMutated each time an item changes. Do not batch change notifications.
+ * @param groupData A function that accepts a single argument. The function is called once, on one element per group. It should return the value that should be set as the data of the .groups list element for this group. The data value usually serves as summary or header information for the group.
+ * @param groupSorter A function that accepts two arguments. The function is called with pairs of group keys found in the list. It must return one of the following numeric values: negative if the first argument is less than the second (sorted before), zero if the two arguments are equivalent, positive if the first argument is greater than the second (sorted after).
+ * @returns A grouped projection over the list.
+ **/
+ createGrouped<G>(groupKey: (x: T) => string, groupData: (x: T) => G, groupSorter?: (left: string, right: string) => number): GroupedSortedListProjection<T, G>;
/**
* Creates a live sorted projection over this list. As the list changes, the sorted projection reacts to those changes and may also change.
@@ -704,18 +956,13 @@ declare module WinJS.Binding {
**/
dataSource: WinJS.UI.IListDataSource<T>;
- /**
- * Indicates that the object is compatibile with declarative processing.
- **/
- static supportedForProcessing: boolean;
-
//#endregion Properties
}
/**
* Represents a base class for normal list modifying operations.
**/
- class ListBaseWithMutators<T> extends ListBase<T> {
+ interface ListBaseWithMutators<T> extends ListBase<T> {
//#region Methods
/**
@@ -752,7 +999,7 @@ declare module WinJS.Binding {
/**
* Represents a base class for list projections.
**/
- class ListProjection<T> extends ListBaseWithMutators<T> {
+ interface ListProjection<T> extends ListBaseWithMutators<T> {
//#region Methods
/**
@@ -897,7 +1144,7 @@ declare module WinJS.Binding {
/**
* Do not instantiate. Returned by the createSorted method.
**/
- class SortedListProjection<T> extends ListProjection<T> {
+ interface SortedListProjection<T> extends ListProjection<T> {
//#region Methods
/**
@@ -948,30 +1195,35 @@ declare module WinJS.Binding {
/**
* Creates a template that provides a reusable declarative binding element.
- * @constructor
+ * @constructor
* @param element The DOM element to convert to a template.
* @param options If this parameter is supplied, the template is loaded from the URI and the content of the element parameter is ignored. You can add the following options: href.
**/
- constructor(element: HTMLElement, options?:any);
+ constructor(element: HTMLElement, options?: any);
//#endregion Constructors
//#region Methods
/**
- * Binds values from the specified data context to elements that are descendants of the specified root element that have the declarative binding attributes specified (data-win-bind).
- * @param dataContext The object to use for default data binding.
- * @param container The element to which to add this rendered template. If this parameter is omitted, a new DIV is created.
- * @returns A Promise that will be completed after binding has finished. The value is either container or the created DIV. promise that is completed after binding has finished.
+ * Binds values from the specified data context to elements that are descendants of the specified root element that have the declarative binding attributes specified (data-win-bind).
+ * @param dataContext The object to use for default data binding.
+ * @param container The element to which to add this rendered template. If this parameter is omitted, a new DIV is created.
+ * @returns A Promise that will be completed after binding has finished. The value is either container or the created DIV. promise that is completed after binding has finished.
**/
render(dataContext: any, container?: HTMLElement): Promise<HTMLElement>;
/**
- * Renders a template based on the specified URI (static method).
- * @param href The URI from which to load the template.
- * @param dataContext The object to use for default data binding.
- * @param container The element to which to add this rendered template. If this parameter is omitted, a new DIV is created.
- * @returns A promise that is completed after binding has finished. The value is either the object in the container parameter or the created DIV.
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code. Use render instead.
+ **/
+ renderItem<T>(item: WinJS.Promise<T>, recyled: HTMLElement): { element: WinJS.Promise<HTMLElement>; renderComplete: WinJS.Promise<any>; };
+
+ /**
+ * Renders a template based on the specified URI (static method).
+ * @param href The URI from which to load the template.
+ * @param dataContext The object to use for default data binding.
+ * @param container The element to which to add this rendered template. If this parameter is omitted, a new DIV is created.
+ * @returns A promise that is completed after binding has finished. The value is either the object in the container parameter or the created DIV.
**/
static render(href: string, dataContext: any, container?: HTMLElement): Promise<HTMLElement>;
@@ -1004,10 +1256,21 @@ declare module WinJS.Binding {
**/
extractChild: boolean;
+ /**
+ * Gets or sets the Number of milliseconds to delay instantiating declarative controls. Zero (0) will result in no delay, any negative number
+ * will result in a setImmediate delay, any positive number will be treated as the number of milliseconds.
+ **/
+ processTimeout: number;
+
/**
* Determines whether the Template contains declarative controls that must be processed separately. This property is always true. The controls that belong to a Template object's children are instantiated when a Template instance is rendered.
**/
- isDeclarativeControlContainer: boolean;
+ static isDeclarativeControlContainer: boolean;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
//#endregion Properties
@@ -1071,6 +1334,11 @@ declare module WinJS.Binding {
**/
function expandProperties(shape: any): any;
+ /**
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ function getValue(obj: any, path?: any): any;
+
/**
* Marks a custom initializer function as being compatible with declarative data binding.
* @param customInitializer The custom initializer to be marked as compatible with declarative data binding.
@@ -1078,15 +1346,6 @@ declare module WinJS.Binding {
**/
function initializer(customInitializer: Function): Function;
- /**
- * Notifies listeners that a property value was updated.
- * @param name The name of the property that is being updated.
- * @param newValue The new value for the property.
- * @param oldValue The old value for the property.
- * @returns A promise that is completed when the notifications are complete.
- **/
- function notify(name: string, newValue: string, oldValue: string): Promise<any>;
-
/**
* Sets the destination property to the value of the source property.
* @param source The source object.
@@ -1211,7 +1470,7 @@ declare module WinJS {
/**
* Creates an Error object with the specified name and message properties.
- * @constructor
+ * @constructor
* @param name The name of this error. The name is meant to be consumed programmatically and should not be localized.
* @param message The message for this error. The message is meant to be consumed by humans and should be localized.
**/
@@ -1219,6 +1478,15 @@ declare module WinJS {
//#endregion Constructors
+ //#region Properties
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#endregion Properties
+
}
interface IPromise<T> {
@@ -1243,7 +1511,7 @@ declare module WinJS {
/**
* A promise provides a mechanism to schedule work to be done on a value that has not yet been computed. It is a convenient abstraction for managing interactions with asynchronous APIs. For more information about asynchronous programming, see Asynchronous programming. For more information about promises in JavaScript, see Asynchronous programming in JavaScript. For more information about using promises, see the WinJS Promise sample.
- * @constructor
+ * @constructor
* @param init The function that is called during construction of the Promise that contains the implementation of the operation that the Promise will represent. This can be synchronous or asynchronous, depending on the nature of the operation. Note that placing code within this function does not automatically run it asynchronously; that must be done explicitly with other asynchronous APIs such as setImmediate, setTimeout, requestAnimationFrame, and the Windows Runtime asynchronous APIs. The init function is given three arguments: completeDispatch, errorDispatch, progressDispatch. This parameter is optional.
* @param onCancel The function to call if a consumer of this promise wants to cancel its undone work. Promises are not required to support cancellation.
**/
@@ -1460,6 +1728,15 @@ declare module WinJS {
//#endregion Methods
+ //#region Properties
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#endregion Properties
+
}
//#endregion Objects
@@ -1473,12 +1750,7 @@ declare module WinJS {
* @param type The type of message (error, warning, info, etc.).
**/
function log(message: string, tags?: string, type?: string): void;
- function log(message: ()=>string, tags?: string, type?: string): void;
-
- /**
- * This method has been deprecated. Strict processing is always on; you don't have to call this method to turn it on.
- **/
- function strictProcessing(): void;
+ function log(message: () => string, tags?: string, type?: string): void;
/**
* Wraps calls to XMLHttpRequest in a promise.
@@ -1499,7 +1771,7 @@ declare module WinJS {
headers?: any;
data?: any;
responseType?: string;
- customRequestInitializer?:(request: XMLHttpRequest) => void;
+ customRequestInitializer?: (request: XMLHttpRequest) => void;
}
//#endregion Interfaces
@@ -1692,7 +1964,7 @@ declare module WinJS.UI.Animation {
/**
* Creates an object that performs an animation that adds an item or items to a list.
* @param added Element or elements to add to the list.
- * @param affected Element or elements affected by the added items.
+ * @param affected Element or elements affected by the added items. Typically, this is all other items displayed in the list.
* @returns An object whose execute method is used to execute the animation. The execute method returns a Promise that completes when the animation is finished.
**/
function createAddToListAnimation(added: any, affected: any): IAnimationMethodResponse;
@@ -1700,7 +1972,7 @@ declare module WinJS.UI.Animation {
/**
* Creates an object that performs an animation that adds an item or items to a list of search results.
* @param added Element or elements to add to the list.
- * @param affected Element or elements affected by the added items.
+ * @param affected Element or elements affected by the added items. Typically, this is all other items displayed in the list.
* @returns An object whose execute method is used to execute the animation. The execute method returns a Promise that completes when the animation is finished.
**/
function createAddToSearchListAnimation(added: any, affected: any): IAnimationMethodResponse;
@@ -1708,7 +1980,7 @@ declare module WinJS.UI.Animation {
/**
* Creates an object that performs an animation that collapses a list.
* @param hidden Element or elements hidden as a result of the collapse.
- * @param affected Element or elements affected by the hidden items.
+ * @param affected Element or elements affected by the hidden items. Typically, this is all other items displayed in the list.
* @returns An object whose execute method is used to execute the animation. The execute method returns a Promise that completes when the animation is finished.
**/
function createCollapseAnimation(hidden: any, affected: any): IAnimationMethodResponse;
@@ -1716,7 +1988,7 @@ declare module WinJS.UI.Animation {
/**
* Creates an object that performs an animation that removes an item or items from a list.
* @param deleted Element or elements to delete from the list.
- * @param remaining Element or elements affected by the removal of the deleted items.
+ * @param remaining Element or elements affected by the removal of the deleted items. Typically, this is all other items displayed in the list.
* @returns An object whose execute method is used to execute the animation. The execute method returns a Promise that completes when the animation is finished.
**/
function createDeleteFromListAnimation(deleted: any, remaining: any): IAnimationMethodResponse;
@@ -1724,7 +1996,7 @@ declare module WinJS.UI.Animation {
/**
* Creates an object that performs an animation that removes an item or items from a list of search results.
* @param deleted Element or elements to delete from the list.
- * @param remaining Element or elements affected by the removal of the deleted items.
+ * @param remaining Element or elements affected by the removal of the deleted items. Typically, this is all other items displayed in the list.
* @returns An object whose execute method is used to execute the animation. The execute method returns a Promise that completes when the animation is finished.
**/
function createDeleteFromSearchListAnimation(deleted: any, remaining: any): IAnimationMethodResponse;
@@ -1732,11 +2004,21 @@ declare module WinJS.UI.Animation {
/**
* Creates an object that performs an animation that expands a list.
* @param revealed Element or elements revealed by the expansion.
- * @param affected Element or elements affected by the newly revealed items.
+ * @param affected Element or elements affected by the newly revealed items. Typically, this is all other items displayed in the list.
* @returns An object whose execute method is used to execute the animation. The execute method returns a Promise that completes when the animation is finished.
**/
function createExpandAnimation(revealed: any, affected: any): IAnimationMethodResponse;
+ /**
+ * Creates an exit and entrance animation to play for a page navigation given the current and incoming pages'
+ * animation preferences and whether the pages are navigating forwards or backwards.
+ * @param currentPreferredAnimation A value from WinJS.UI.PageNavigationAnimation describing the animation the current page prefers to use.
+ * @param A value from nextPreferredAnimation WinJS.UI.PageNavigationAnimation describing the animation the incoming page prefers to use.
+ * @param movingBackwards Boolean value for whether the navigation is moving backwards.
+ * @returns an object containing the exit and entrance animations to play based on the parameters given.
+ **/
+ function createPageNavigationAnimations(currentPreferredAnimation: string, nextPreferredAnimation: string, movingBackwards: boolean): { exit: Function; entrance: Function };
+
/**
* Creates an object that performs a peek animation.
* @param element Element or elements involved in the peek.
@@ -1791,6 +2073,34 @@ declare module WinJS.UI.Animation {
**/
function dragSourceStart(dragSource: any, affected?: any): Promise<any>;
+ /**
+ * Execute the incoming phase of the drill in animation, scaling up the incoming page while fading it in.
+ * @param incomingPage Element to be scaled up and faded in.
+ * @returns Promise object that completes when the animation is complete.
+ **/
+ function drillInIncoming(incomingPage: HTMLElement): Promise<any>;
+
+ /**
+ * Execute the outgoing phase of the drill in animation, scaling up the outgoing page while fading it out.
+ * @param incomingPage Element to be scaled up and faded out.
+ * @returns Promise object that completes when the animation is complete.
+ **/
+ function drillInOutgoing(outgoingPage: HTMLElement): Promise<any>;
+
+ /**
+ * Execute the incoming phase of the drill out animation, scaling down the incoming page while fading it in.
+ * @param incomingPage Element to be scaled up and faded in.
+ * @returns Promise object that completes when the animation is complete.
+ **/
+ function drillOutIncoming(incomingPage: HTMLElement): Promise<any>;
+
+ /**
+ * Execute the outgoing phase of the drill out animation, scaling down the outgoing page while fading it out.
+ * @param outgoingPage Element to be scaled down and faded out.
+ * @returns Promise object that completes when the animation is complete.
+ **/
+ function drillOutOutgoing(outgoingPage: HTMLElement): Promise<any>;
+
/**
* Performs an animation that displays one or more elements on a page.
* @param incoming Element or elements that compose the incoming content.
@@ -2264,7 +2574,8 @@ declare module WinJS.UI {
threebars,
fourbars,
scan,
- preview
+ preview,
+ hamburger
}
/**
@@ -2313,6 +2624,10 @@ declare module WinJS.UI {
* The edit operation timed out.
**/
noResponse,
+ /**
+ * The edit operation was canceled.
+ **/
+ canceled,
/**
* The data source cannot be written to.
**/
@@ -2390,7 +2705,15 @@ declare module WinJS.UI {
/**
* The object is an item in the list.
**/
- item
+ item,
+ /**
+ * The object is the header for the list.
+ **/
+ header,
+ /**
+ * The object is the footer for the list.
+ **/
+ footer
}
/**
@@ -2461,10 +2784,147 @@ declare module WinJS.UI {
none
}
+ /**
+ * Specifies what animation type should be returned by WinJS.UI.Animation.createPageNavigationAnimations.
+ **/
+ enum PageNavigationAnimation {
+ /**
+ * The pages will exit and enter using a turnstile animation.
+ **/
+ turnstile,
+ /**
+ * The pages will exit and enter using an animation that slides up/down.
+ **/
+ slide,
+ /**
+ * The pages will enter using an enterPage animation, and exit with no animation.
+ **/
+ enterPage,
+ /**
+ * The pages will exit and enter using a continuum animation.
+ **/
+ continuum,
+ }
+
//#endregion Enumerations
//#region Interfaces
+ /**
+ * Define the shape of a Command object to be used in AppBar and ToolBar controls.
+ **/
+ export interface ICommand {
+ //#region Methods
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param type The event type to register.
+ * @param listener The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+
+ /**
+ * Releases resources held by this ICommand. Call this method when the ICommand is no longer needed. After calling this method, the ICommand becomes unusable.
+ **/
+ dispose(): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param type The event type to unregister.
+ * @param listener The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
+
+ //#endregion Methods
+
+ //#region Properties
+
+ /**
+ * Gets or sets a value that indicates whether the ICommand is disabled.
+ **/
+ disabled: boolean;
+
+ /**
+ * Gets the DOM element that hosts the ICommand.
+ **/
+ element: HTMLElement;
+
+ /**
+ * Adds an extra CSS class during construction.
+ **/
+ extraClass: string;
+
+ /**
+ * Gets or sets the HTMLElement with a 'content' type ICommand that should receive focus whenever focus moves by the user pressing HOME or the arrow keys, from the previous ICommand to this ICommand.
+ **/
+ firstElementFocus: HTMLElement;
+
+ /**
+ * Gets or sets the Flyout object displayed by this command. The specified flyout is shown when the ICommand's button is invoked.
+ **/
+ flyout: Flyout;
+
+ /**
+ * Gets or sets a value that indicates whether the ICommand is hiding or in the process of becoming hidden.
+ **/
+ hidden: boolean;
+
+ /**
+ * Gets or sets the icon of the ICommand.
+ **/
+ icon: string;
+
+ /**
+ * Gets the element identifier (ID) of the command.
+ **/
+ id: string;
+
+ /**
+ * Gets or sets the label of the command.
+ **/
+ label: string;
+
+ /**
+ * Gets or sets the HTMLElement with a 'content' type ICommand that should receive focus whenever focus moves by the user pressing END or the arrow keys, from the previous Command to this Command.
+ **/
+ lastElementFocus: HTMLElement;
+
+ /**
+ * Gets or sets the function to be invoked when the command is clicked.
+ **/
+ onclick: Function;
+
+ /**
+ * Gets the section of the parent control that the command is in. The section can only be set through constructor options.
+ **/
+ section: string;
+
+ /**
+ * Gets or sets the selected state of a toggle button.
+ **/
+ selected: boolean;
+
+ /**
+ * Gets or sets the tooltip of the command.
+ **/
+ tooltip: string;
+
+ /**
+ * Gets the type of the command. The type can only be set through constructor options.
+ **/
+ type: string;
+
+ /**
+ * Gets or sets the priority of the command.
+ **/
+ priority: number;
+
+ //#endregion Properties
+ }
+
+
/**
* Contains items that were requested from an IListDataAdapter and provides some information about those items.
**/
@@ -2575,145 +3035,6 @@ declare module WinJS.UI {
}
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface. Represents a layout for the ListView.
- **/
- interface ILayout {
- //#region Methods
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param beginScrollPosition The first visible pixel in the ListView. For horizontal layouts, this is the x-coordinate of the pixel. For vertical layouts, this is the y-coordinate.
- * @param wholeItem true if the item must be completely visible; otherwise, false if its ok for the item to be partially visible. Promise.
- * @returns A Promise for the index of the first visible item at the specified point.
- **/
- calculateFirstVisible(beginScrollPosition: number, wholeItem: boolean): Promise<any>;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param endScrollPosition The last visible pixel in the ListView. For horizontal layouts, this is the x-coordinate of the pixel. For vertical layouts, this is the y-coordinate.
- * @param wholeItem true if the item must be completely visible; otherwise, false if its ok for the item to be partially visible. Promise.
- * @returns A Promise for the index of the last visible item at the specified point.
- **/
- calculateLastVisible(endScrollPosition: number, wholeItem: boolean): Promise<any>;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @returns A object that has these properties: animationPromise, newEndIndex.
- **/
- endLayout(): any;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param itemIndex The index of the item.
- * @returns A Promise that returns an object with these properties: left, top, contentWidth, contentHeight, totalWidth, totalHeight.
- **/
- getItemPosition(itemIndex: number): Promise<any>;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param itemIndex The data source index of the current item.
- * @param element The element for the current item.
- * @param keyPressed The key that was pressed. This function must check for the arrow keys (leftArrow, upArrow, rightArrow, downArrow), pageDown, and pageUp and determine which item the user navigated to.
- * @returns A Promise that contains the index of the next item (This item becomes the current item).
- **/
- getKeyboardNavigatedItem(itemIndex: number, element: HTMLElement, keyPressed: WinJS.Utilities.Key): Promise<number>;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @returns A Promise that returns an object that has these properties: beginScrollPosition, endScrollPosition.
- **/
- getScrollBarRange(): Promise<any>;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param x The x-coordinate to test.
- * @param y The y-coordinate to test.
- **/
- hitTest(x: number, y: number): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param elements The elements that represent the items that were added.
- **/
- itemsAdded(elements: HTMLElement[]): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- **/
- itemsMoved(): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param elements The elements that represent the items that were removed.
- **/
- itemsRemoved(elements: HTMLElement[]): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param groupIndex The index of the group in the group data source.
- * @param element The element to render for the group header.
- **/
- layoutHeader(groupIndex: number, element: HTMLElement): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param itemIndex The index of the item in the data source.
- * @param element The element to render for the item.
- **/
- layoutItem(itemIndex: number, element: HTMLElement): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param element The element that represents a header in the data source.
- **/
- prepareHeader(element: HTMLElement): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param element An element that represents an item in the data source.
- **/
- prepareItem(element: HTMLElement): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param element The element being released.
- **/
- releaseItem(element: HTMLElement): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- **/
- reset(): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param site The layout site for the layout. You can use this object to query the hosting ListView for info you might need to lay out items.
- **/
- setSite(site: ILayoutSite): void;
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- * @param beginScrollPosition The starting pixel of the area to which the items are rendered.
- * @param endScrollPosition The last pixel of the area to which the items are rendered.
- * @param count The upper bound of the number of items to render.
- * @returns A Promise that returns an object that has these properties: beginIndex, endIndex.
- **/
- startLayout(beginScrollPosition: number, endScrollPosition: number, count: number): Promise<any>;
-
- //#endregion Methods
-
- //#region Properties
-
- /**
- * This API is no longer supported. Starting with the Windows Library for JavaScript 2.0 Preview, use the ILayout2 interface.
- **/
- horizontal: boolean;
-
- //#endregion Properties
-
- }
-
/**
* Represents a layout for the ListView.
**/
@@ -3613,14 +3934,15 @@ declare module WinJS.UI {
//#region Objects
/**
- * Represents an application toolbar for displaying commands.
+ * Displays ICommands in overlayed application pane that opens and closes at the top or bottom of the main view.
**/
class AppBar {
+
//#region Constructors
/**
* Creates a new AppBar object.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the control.
* @param options The set of properties and values to apply to the new AppBar.
**/
@@ -3631,28 +3953,28 @@ declare module WinJS.UI {
//#region Events
/**
- * Occurs immediately after the AppBar is hidden.
+ * Occurs immediately after the AppBar is closed.
* @param eventInfo An object that contains information about the event.
**/
- onafterhide(eventInfo: Event): void;
+ onafterclose: (eventInfo: CustomEvent) => void;
/**
- * Occurs after the AppBar is shown.
+ * Occurs immeidately after the AppBar is opened.
* @param eventInfo An object that contains information about the event.
**/
- onaftershow(eventInfo: Event): void;
+ onafteropen: (eventInfo: CustomEvent) => void;
/**
- * Occurs before the AppBar is hidden.
+ * Occurs immediately before the AppBar is closed. Is cancelable.
* @param eventInfo An object that contains information about the event.
**/
- onbeforehide(eventInfo: Event): void;
+ onbeforeclose: (eventInfo: CustomEvent) => void;
/**
- * Occurs before a hidden AppBar is shown.
+ * Occurs immediately before the AppBar is opened. Is cancelable.
* @param eventInfo An object that contains information about the event.
**/
- onbeforeshow(eventInfo: Event): void;
+ onbeforeopen: (eventInfo: CustomEvent) => void;
//#endregion Events
@@ -3660,11 +3982,19 @@ declare module WinJS.UI {
/**
* Registers an event handler for the specified event.
- * @param type The event type to register. It must be beforeshow, beforehide, aftershow, or afterhide.
+ * @param type The event type to register. It must be beforeopen, beforeclose, afteropen, or afterclose.
* @param listener The event handler function to associate with the event.
* @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
**/
- addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+ addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param type The event type to unregister. It must be beforeopen, beforeclose, afteropen, or afterclose.
+ * @param listener The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
/**
* Raises an event of the specified type and with additional properties.
@@ -3672,7 +4002,7 @@ declare module WinJS.UI {
* @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
* @returns true if preventDefault was called on the event, otherwise false.
**/
- dispatchEvent(type: string, eventProperties: any): boolean;
+ dispatchEvent(eventName: string, eventProperties: any): boolean;
/**
* Releases resources held by this AppBar. Call this method when the AppBar is no longer needed. After calling this method, the AppBar becomes unusable.
@@ -3680,69 +4010,46 @@ declare module WinJS.UI {
dispose(): void;
/**
- * Returns the AppBarCommand object identified by id.
+ * Returns the Command object identified by id.
* @param id The element idenitifier (ID) of the command to be returned.
- * @returns The command identified by id. If multiple commands have the same ID, returns an array of all the commands matching the ID.
+ * @returns The command identified by id. If multiple commands have the same ID, returns the first command found.
**/
- getCommandById(id: string): AppBarCommand;
-
- /**
- * Hides the AppBar.
- **/
- hide(): void;
-
- /**
- * Hides the specified commands of the AppBar.
- * @param commands The commands to hide. The array elements may be AppBarCommand objects, or the string identifiers (IDs) of commands.
- * @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to hide the commands immediately, without animating them; otherwise, false.
- **/
- hideCommands(commands: any[], immediate?: boolean): void;
-
- /**
- * Removes an event handler that the addEventListener method registered.
- * @param type The event type to unregister. It must be beforeshow, beforehide, aftershow, or afterhide.
- * @param listener The event handler function to remove.
- * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
- **/
- removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
-
- /**
- * Shows the AppBar if it is not disabled.
- **/
- show(): void;
-
- /**
- * Shows the specified commands of the AppBar.
- * @param commands The commands to show. The array elements may be AppBarCommand objects, or the string identifiers (IDs) of commands.
- * @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to show the commands immediately, without animating them; otherwise, false.
- **/
- showCommands(commands: any[], immediate?: boolean): void;
+ getCommandById(id: string): ICommand;
/**
* Shows the specified commands of the AppBar while hiding all other commands.
- * @param commands The commands to show. The array elements may be AppBarCommand objects, or the string identifiers (IDs) of commands.
- * @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to show the specified commands (and hide the others) immediately, without animating them; otherwise, false.
+ * @param commands The commands to show. The array elements may be ICommand objects, or the string identifiers (IDs) of commands.
**/
- showOnlyCommands(commands: any[], immediate?: boolean): void;
+ showOnlyCommands(commands: Array<string|ICommand>): void;
+
+ /**
+ * Opens the AppBar.
+ **/
+ open(): void;
+
+ /**
+ * Closes the AppBar.
+ **/
+ close(): void;
+
+ /**
+ * Forces the AppBar to update its layout.
+ **/
+ forceLayout(): void;
//#endregion Methods
//#region Properties
/**
- * Gets/Sets how AppBar will display itself while hidden. Values are "none" and "minimal".
+ * Gets/Sets how AppBar will display itself while closed. Values are "none" , "minimal", "compact" and "full".
**/
closedDisplayMode: string;
/**
- * Sets the AppBarCommand objects that appear in the app bar.
+ * Gets or sets the Binding List of WinJS.UI.Command for the AppBar.
**/
- commands: AppBarCommand[];
-
- /**
- * Gets or sets a value that indicates whether the AppBar is disabled.
- **/
- disabled: boolean;
+ data: WinJS.Binding.List<ICommand>;
/**
* Gets the DOM element that hosts the AppBar.
@@ -3750,24 +4057,55 @@ declare module WinJS.UI {
element: HTMLElement;
/**
- * Gets a value that indicates whether the AppBar is hidden or in the process of becoming hidden.
+ * Gets or sets whether the AppBar is currently opened.
**/
- hidden: boolean;
-
- /**
- * Gets or sets the layout of the app bar contents.
- **/
- layout: string;
+ opened: boolean;
/**
* Gets or sets a value that specifies whether the AppBar appears at the top or bottom of the main view.
**/
placement: string;
- /**
- * Gets or sets a value that indicates whether the AppBar is sticky (won't light dismiss). If not sticky, the app bar dismisses normally when the user touches outside of the appbar.
+ /**
+ * Display options for the AppBar when closed.
**/
- sticky: boolean;
+ static ClosedDisplayMode: {
+ /**
+ * When the AppBar is closed, it is not visible and doesn't take up any space.
+ **/
+ none: string;
+ /**
+ * When the AppBar is closed, its height is reduced to the minimal height required to display only its overflowbutton. All other content in the AppBar is not displayed.
+ **/
+ minimal: string;
+ /**
+ * When the AppBar is closed, its height is reduced such that button commands are still visible, but their labels are hidden.
+ **/
+ compact: string;
+ /**
+ * When the AppBar is closed, its height is always sized to content.
+ **/
+ full: string;
+ };
+
+ /**
+ * Display options for AppBar placement in relation to the main view.
+ */
+ static Placement: {
+ /**
+ * The AppBar appears at the top of the main view
+ **/
+ top: string;
+ /**
+ * The AppBar appears at the bottom of the main view
+ **/
+ bottom: string;
+ };
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
//#endregion Properties
@@ -3776,12 +4114,12 @@ declare module WinJS.UI {
/**
* Represents a command to be displayed in an app bar.
**/
- class AppBarCommand {
+ class AppBarCommand implements ICommand {
//#region Constructors
/**
* Creates a new AppBarCommand object.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the control.
* @param options The set of properties and values to apply to the new AppBarCommand.
**/
@@ -3806,7 +4144,7 @@ declare module WinJS.UI {
/**
* Removes an event handler that the addEventListener method registered.
- * @param type The event type to unregister. It must be beforeshow, beforehide, aftershow, or afterhide.
+ * @param type The event type to unregister.
* @param listener The event handler function to remove.
* @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
**/
@@ -3872,7 +4210,7 @@ declare module WinJS.UI {
onclick: Function;
/**
- * Gets the section of the app bar that the command is in.
+ * Gets the section of the parent control that the command is in. The section can only be set through constructor options.
**/
section: string;
@@ -3887,14 +4225,159 @@ declare module WinJS.UI {
tooltip: string;
/**
- * Gets the type of the command.
+ * Gets the type of the command. The type can only be set through constructor options.
**/
type: string;
+ /**
+ * Gets or sets the priority of the command
+ **/
+ priority: number;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
+ /**
+ * A rich input box that provides suggestions as the user types.
+ **/
+ class AutoSuggestBox {
+ //#region Constructors
+
+ /**
+ * Creates a new AutoSuggestBox.
+ * @constructor
+ * @param element The DOM element hosts the new AutoSuggestBox.
+ * @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
+ **/
+ constructor(element?: HTMLElement, options?: any);
+
+ //#endregion Constructors
+
+ //#region Events
+
+ /**
+ * Raised when the user or the app changes the queryText.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.language, detail.queryText, detail.linguisticDetails.
+ **/
+ onquerychanged(eventInfo: CustomEvent): void;
+
+ /**
+ * Raised awhen the user presses Enter.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.language, detail.queryText, detail.linguisticDetails, detail.keyModifiers.
+ **/
+ onquerysubmitted(eventInfo: CustomEvent): void;
+
+ /**
+ * Raised when the user selects a suggested option for their query.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.tag, detail.keyModifiers, detail.storageFile.
+ **/
+ onresultsuggestionchosen(eventInfo: CustomEvent): void;
+
+ /**
+ * Raised when the system requests suggestions from this app.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.language, detail.linguisticDetails, detail.queryText, detail.searchSuggestionCollection.
+ **/
+ onsuggestionsrequested(eventInfo: CustomEvent): void;
+
+ //#endregion Events
+
+ //#region Methods
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param eventName The name of the event to handle. Note that you drop the "on" when specifying the event name. For example, instead of specifying "onclick", you specify "click".
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Releases resources held by this AutoSuggestBox. Call this method when the AutoSuggestBox is no longer needed. After calling this method, the AutoSuggestBox becomes unusable.
+ **/
+ dispose(): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param eventName The name of the event that the event handler is registered for.
+ * @param eventCallback The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(eventName: string, eventCallback: Function, useCapture?: boolean): void;
+
+ /**
+ * Specifies whether suggestions based on local files are automatically displayed in the input field, and defines the criteria that
+ * the system uses to locate and filter these suggestions.
+ * @param settings The new settings for local content suggestions.
+ **/
+ setLocalContentSuggestionSettings(settings: any): void
+
+ //#endregion Methods
+
+ //#region Properties
+
+ /**
+ * Gets or sets whether the first suggestion is chosen when the user presses Enter.
+ **/
+ chooseSuggestionOnEnter: boolean;
+
+ /**
+ * Gets or sets a value that specifies whether the AutoSuggestBox is disabled. If the control is disabled, it won't receive focus.
+ **/
+ disabled: boolean;
+
+ /**
+ * Gets the DOM element that hosts the AutoSuggestBox.
+ **/
+ element: HTMLElement;
+
+ /**
+ * Gets or sets the placeholder text for the AutoSuggestBox. This text is displayed if there is no other text in the input box.
+ **/
+ placeholderText: string;
+
+ /**
+ * Gets or sets the query text for the AutoSuggestBox.
+ **/
+ queryText: string;
+
+ /**
+ * Gets or sets the history context. This context is used a secondary key (the app ID is the primary key) for storing history.
+ **/
+ searchHistoryContext: string;
+
+ /**
+ * Gets or sets a value that specifies whether history is disabled.
+ **/
+ searchHistoryDisabled: boolean;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#endregion Properties
+
+ /**
+ * Creates the image argument for SearchSuggestionCollection.appendResultSuggestion.
+ * @param url The url of the image.
+ **/
+ static createResultSuggestionImage(url: string): any;
+ }
+
/**
* Provides backwards navigation in the form of a button.
**/
@@ -3903,7 +4386,7 @@ declare module WinJS.UI {
/**
* Creates a new BackButton.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new BackButton.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -3956,6 +4439,11 @@ declare module WinJS.UI {
**/
element: HTMLElement;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -3968,7 +4456,7 @@ declare module WinJS.UI {
/**
* Creates a new CellSpanningLayout.
- * @constructor
+ * @constructor
* @param options An object that contains one or more property/value pairs to apply to the new CellSpanningLayout. Each property of the options object corresponds to one of the object's properties or events. Event names must begin with "on".
**/
constructor(options?: any);
@@ -4023,10 +4511,10 @@ declare module WinJS.UI {
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
- * @param tree
- * @param changedRange
- * @param modifiedItems
- * @param modifiedGroups
+ * @param tree
+ * @param changedRange
+ * @param modifiedItems
+ * @param modifiedGroups
**/
layout(tree: ILayoutSite2, changedRange: any, modifiedItems: any, modifiedGroups: any): void;
@@ -4074,10 +4562,178 @@ declare module WinJS.UI {
**/
orientation: WinJS.UI.Orientation;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
+ /**
+ * Data associated with hiding a dialog.
+ **/
+ interface ContentDialogHideInfo {
+ /***
+ * The dialog's dismissal result. May be 'primary', 'secondary', 'none', or whatever custom value was passed to hide.
+ **/
+ result: string
+ }
+
+ /**
+ * Event object associated with hiding a dialog.
+ **/
+ interface ContentDialogHideEvent extends Event {
+ detail: ContentDialogHideInfo
+ }
+
+ /**
+ * Represents a command to be displayed in an AppBar or ToolBar
+ **/
+ class Command extends AppBarCommand implements ICommand {
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+ }
+
+ /**
+ * Displays a modal dialog which can display arbitrary HTML content.
+ **/
+ class ContentDialog {
+ /**
+ * Specifies the result of dismissing the ContentDialog.
+ **/
+ static DismissalResult: {
+ /**
+ * The dialog was dismissed without the user selecting any of the commands. The user may have dismissed the dialog by hitting the escape key or pressing the hardware back button.
+ **/
+ none: string;
+ /**
+ * The user dismissed the dialog by pressing the primary command.
+ **/
+ primary: string;
+ /**
+ * The user dismissed the dialog by pressing the secondary command.
+ **/
+ secondary: string
+ }
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ /**
+ * Creates a new ContentDialog control.
+ * @constructor
+ * @param The DOM element that hosts the ContentDialog control.
+ * @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
+ **/
+ constructor(element?: HTMLElement, options?: any);
+
+ /**
+ * Gets the DOM element that hosts the ContentDialog control.
+ **/
+ element: HTMLElement;
+
+ /**
+ * Gets or sets the ContentDialog's visibility.
+ **/
+ hidden: boolean;
+
+ /**
+ * The text displayed as the title of the dialog.
+ **/
+ title: string;
+
+ /**
+ * The text displayed on the primary command's button.
+ **/
+ primaryCommandText: string;
+
+ /**
+ * Indicates whether the button representing the primary command is currently disabled.
+ **/
+ primaryCommandDisabled: boolean;
+
+ /**
+ * The text displayed on the secondary command's button.
+ **/
+ secondaryCommandText: string;
+
+ /**
+ * Indicates whether the button representing the secondary command is currently disabled.
+ **/
+ secondaryCommandDisabled: boolean;
+
+ /**
+ * Shows the ContentDialog. Only one ContentDialog may be shown at a time. If another ContentDialog is already shown, this ContentDialog will remain hidden.
+ * @returns A promise which is successfully fulfilled when the dialog is dismissed. The completion value indicates the dialog's dismissal result. This may be 'primary', 'secondary', 'none', or whatever custom value was passed to hide. If this ContentDialog cannot be shown because a ContentDialog is already showing or the ContentDialog is disposed, then the return value is a promise which is in an error state. If preventDefault() is called on the beforeshow event, then this promise will be canceled.
+ **/
+ show(): Promise<ContentDialogHideInfo>;
+
+ /**
+ * Hides the ContentDialog.
+ * @param result A value indicating why the dialog is being hidden. The promise returned by show will be fulfilled with this value.
+ **/
+ hide(result?: any): void;
+
+ /**
+ * Disposes this control.
+ **/
+ dispose(): void;
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param eventName The name of the event to handle. Note that you drop the "on" when specifying the event name. For example, instead of specifying "onclick", you specify "click".
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param eventName The name of the event that the event handler is registered for.
+ * @param eventCallback The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Raised just before showing a dialog. Call preventDefault on this event to stop the dialog from being shown.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onbeforeshow(eventInfo: Event): void;
+
+ /**
+ * Raised immediately after a dialog is fully shown.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onaftershow(eventInfo: Event): void;
+
+ /**
+ * Raised just before hiding a dialog. Call preventDefault on this event to stop the dialog from being hidden.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onbeforehide(eventInfo: ContentDialogHideEvent): void;
+
+ /**
+ * Raised immediately after a dialog is fully hidden.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onafterhide(eventInfo: ContentDialogHideEvent): void;
+ }
+
/**
* Allows users to pick a date value.
**/
@@ -4086,7 +4742,7 @@ declare module WinJS.UI {
/**
* Initializes a new instance of the DatePicker control.
- * @constructor
+ * @constructor
* @param element The DOM element associated with the DatePicker control.
* @param options The set of options to be applied initially to the DatePicker control. The options are the following: calendar, current, datePattern, disabled, maxYear, minYear, monthPattern, yearPattern.
**/
@@ -4128,12 +4784,9 @@ declare module WinJS.UI {
dispose(): void;
/**
- * Raises an event of the specified type and with additional properties.
- * @param type The type (name) of the event.
- * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
- * @returns true if preventDefault was called on the event, otherwise false.
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code. Use render instead.
**/
- raiseEvent(type: string, eventProperties: any): boolean;
+ static getInformation(startDate: any, endDate: any, calendar?: any, datePatterns?: any): any;
/**
* Removes a listener for the specified event.
@@ -4192,6 +4845,11 @@ declare module WinJS.UI {
**/
yearPattern: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -4199,7 +4857,7 @@ declare module WinJS.UI {
/**
* Adds event-related methods to the control.
**/
- class DOMEventMixin {
+ module DOMEventMixin {
//#region Methods
/**
@@ -4208,7 +4866,7 @@ declare module WinJS.UI {
* @param listener The listener to invoke when the event gets raised.
* @param useCapture true to initiate capture; otherwise, false.
**/
- addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+ export function addEventListener(type: string, listener: Function, useCapture?: boolean): void;
/**
* Raises an event of the specified type, adding the specified additional properties.
@@ -4216,7 +4874,7 @@ declare module WinJS.UI {
* @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
* @returns true if preventDefault was called on the event, otherwise false.
**/
- dispatchEvent(type: string, eventProperties: any): boolean;
+ export function dispatchEvent(type: string, eventProperties: any): boolean;
/**
* Removes an event listener from the control.
@@ -4224,17 +4882,9 @@ declare module WinJS.UI {
* @param listener The listener to remove.
* @param useCapture true to initiate capture; otherwise, false.
**/
- removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
-
- /**
- * Adds the set of declaratively specified options (properties and events) to the specified control. If the name of the options property begins with "on", the property value is a function and the control supports addEventListener. This method calls the addEventListener method on the control.
- * @param control The control on which the properties and events are to be applied.
- * @param options The set of options that are specified declaratively.
- **/
- setOptions(control: any, options: any): void;
+ export function removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
//#endregion Methods
-
}
/**
@@ -4245,7 +4895,7 @@ declare module WinJS.UI {
/**
* Creates a new FlipView.
- * @constructor
+ * @constructor
* @param element The DOM element that hosts the control.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the pageselected event, add a property named "onpageselected" and set its value to the event handler.
**/
@@ -4375,6 +5025,31 @@ declare module WinJS.UI {
**/
orientation: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ /**
+ * Event Name
+ **/
+ static datasourceCountChangedEvent: string;
+
+ /**
+ * Event Name
+ **/
+ static pageCompletedEvent: string;
+
+ /**
+ * Event Name
+ **/
+ static pageSelectedEvent: string;
+
+ /**
+ * Event Name
+ **/
+ static pageVisibilityChangedEvent: string;
+
//#endregion Properties
}
@@ -4387,7 +5062,7 @@ declare module WinJS.UI {
/**
* Creates a new Flyout object.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the control.
* @param options The set of properties and values to apply to the new Flyout.
**/
@@ -4433,6 +5108,14 @@ declare module WinJS.UI {
**/
addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(eventName: string, eventProperties: any): boolean;
+
/**
* Releases resources held by this object. Call this method when the object is no longer needed. After calling this method, the object becomes unusable.
**/
@@ -4443,6 +5126,26 @@ declare module WinJS.UI {
**/
hide(): void;
+ /**
+ * Shows the Flyout, if hidden, regardless of other states.
+ * @param anchor. DOM element to temporarily anchor the position of the Flyout to. This is optional if Flyout.anchor has already been set.
+ * @param placement The placement of the Flyout to the anchor: the string literal "top", "bottom", "left", or "right".
+ * @param alignment For "top" or "bottom" placement, the alignment of the Flyout to the anchor's edge: the string literal "center", "left", or "right".
+ **/
+ show(anchor?: HTMLElement, placement?: string, alignment?: string): void;
+
+ /**
+ * Shows the Flyout, if hidden, regardless of other states, top and left aligned at the specified coordinates,
+ * @param coordinates Required. The point where the top left corner of the flyout will appear, relative to the top and left edge of the visual viewport.
+ **/
+ showAt(coordinates: { x: number; y: number; }): void;
+
+ /**
+ * Shows the Flyout, if hidden, regardless of other states, top and left aligned at the location of the mouse event object,
+ * @param mouseEventObj Required. The MouseEvent Object specifying where to show the Flyout.
+ **/
+ showAt(mouseEventObj: MouseEvent): void;
+
/**
* Removes an event handler that the addEventListener method registered.
* @param type The event type to unregister. It must be beforeshow, beforehide, aftershow, or afterhide.
@@ -4451,14 +5154,6 @@ declare module WinJS.UI {
**/
removeEventListener(type: string, listener: Function, useCapture?: boolean): void;
- /**
- * Shows the Flyout, if hidden, regardless of other states.
- * @param anchor Required. The DOM element to anchor the Flyout.
- * @param placement The placement of the Flyout to the anchor: the string literal "top", "bottom", "left", or "right".
- * @param alignment For "top" or "bottom" placement, the alignment of the Flyout to the anchor's edge: the string literal "center", "left", or "right".
- **/
- show(anchor: HTMLElement, placement?: string, alignment?: string): void;
-
//#endregion Methods
//#region Properties
@@ -4473,13 +5168,18 @@ declare module WinJS.UI {
**/
anchor: HTMLElement;
+ /**
+ * Gets or sets a value that indicates whether the Flyout is disabled.
+ **/
+ disabled: boolean;
+
/**
* Gets the DOM element that hosts the Flyout.
**/
element: HTMLElement;
/**
- * Gets a value that indicates whether the Flyout is hidden or in the process of becoming hidden.
+ * Gets a value that indicates whether the Flyout is hidden or in the process of becoming hidden, or sets the Flyout to hide or show itself.
**/
hidden: boolean;
@@ -4488,6 +5188,11 @@ declare module WinJS.UI {
**/
placement: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -4500,7 +5205,7 @@ declare module WinJS.UI {
/**
* Creates a new GridLayout object.
- * @constructor
+ * @constructor
* @param options The set of properties and values to apply to the new GridLayout.
**/
constructor(options?: any);
@@ -4509,20 +5214,6 @@ declare module WinJS.UI {
//#region Methods
- /**
- * This method is no longer supported.
- * @param beginScrollPosition
- * @param wholeItem
- **/
- calculateFirstVisible(beginScrollPosition: number, wholeItem: boolean): void;
-
- /**
- * This method is no longer supported.
- * @param endScrollPosition
- * @param wholeItem
- **/
- calculateLastVisible(endScrollPosition: number, wholeItem: boolean): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
@@ -4533,11 +5224,6 @@ declare module WinJS.UI {
**/
dragOver(): void;
- /**
- * This method is no longer supported.
- **/
- endLayout(): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
@@ -4551,27 +5237,6 @@ declare module WinJS.UI {
**/
getAdjacent(currentItem: any, pressedKey: WinJS.Utilities.Key): any;
- /**
- * This method is no longer supported.
- * @param itemIndex
- **/
- getItemPosition(itemIndex: number): void;
-
- /**
- * This method is no longer supported.
- * @param itemIndex
- * @param element
- * @param keyPressed
- **/
- getKeyboardNavigatedItem(itemIndex: number, element: any, keyPressed: any): void;
-
- /**
- * This method is no longer supported.
- * @param beginScrollPosition
- * @param endScrollPosition
- **/
- getScrollbarRange(beginScrollPosition: number, endScrollPosition: number): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
* @param x The x-coordinate, or the horizontal position on the screen.
@@ -4579,11 +5244,6 @@ declare module WinJS.UI {
**/
hitTest(x: number, y: number): void;
- /**
- * This method is no longer supported.
- **/
- init(): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
* @param site The rendering site for the layout.
@@ -4591,12 +5251,6 @@ declare module WinJS.UI {
**/
initialize(site: ILayoutSite2, groupsEnabled: boolean): void;
- /**
- * This method is no longer supported.
- * @param elements
- **/
- itemsAdded(elements: any): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
* @param firstPixel The first pixel the range of items falls between.
@@ -4604,94 +5258,25 @@ declare module WinJS.UI {
**/
itemsFromRange(firstPixel: number, lastPixel: number): void;
- /**
- * This method is no longer supported.
- **/
- itemsMoved(): void;
-
- /**
- * This method is no longer supported.
- * @param elements
- **/
- itemsRemoved(elements: any): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
- * @param tree
- * @param changedRange
- * @param modifiedItems
- * @param modifiedGroups
+ * @param tree
+ * @param changedRange
+ * @param modifiedItems
+ * @param modifiedGroups
**/
layout(tree: any, changedRange: any, modifiedItems: any, modifiedGroups: any): void;
- /**
- * This method is no longer supported.
- * @param groupIndex
- * @param element A DOM element.
- **/
- layoutHeader(groupIndex: number, element: any): void;
-
- /**
- * This method is no longer supported.
- * @param itemIndex
- * @param element A DOM element.
- **/
- layoutItem(itemIndex: number, element: any): void;
-
- /**
- * This method is no longer supported.
- * @param element
- **/
- prepareHeader(element: HTMLElement): void;
-
- /**
- * This method is no longer supported.
- * @param itemIndex
- * @param element A DOM element.
- **/
- prepareItem(itemIndex: number, element: any): void;
-
- /**
- * This method is no longer supported.
- * @param item
- * @param newItem
- **/
- releaseItem(item: any, newItem: any): void;
-
- /**
- * This method is no longer supported.
- **/
- reset(): void;
-
- /**
- * This method is no longer supported.
- * @param layoutSite
- **/
- setSite(layoutSite: any): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
setupAnimations(): void;
- /**
- * This method is no longer supported.
- * @param beginScrollPosition
- * @param endScrollPositionScrollPosition
- **/
- startLayout(beginScrollPosition: number, endScrollPositionScrollPosition: number): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
uninitialize(): void;
- /**
- * This method is no longer supported.
- * @param count
- **/
- updateBackdrop(count: number): void;
-
//#endregion Methods
//#region Properties
@@ -4716,11 +5301,6 @@ declare module WinJS.UI {
**/
groupInfo: Function;
- /**
- * This property is no longer supported. Starting with the Windows Library for JavaScript 2.0, use the orientation property instead.
- **/
- horizontal: boolean;
-
/**
* This property is no longer supported. Starting with the Windows Library for JavaScript 2.0, use a CellSpanningLayout.
**/
@@ -4746,6 +5326,11 @@ declare module WinJS.UI {
**/
orientation: WinJS.UI.Orientation;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -4758,7 +5343,7 @@ declare module WinJS.UI {
/**
* Creates a new Hub control.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the Hub control.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the contentanimating event, add a property named "oncontentanimating" to the options object and set its value to the event handler.
**/
@@ -4811,6 +5396,12 @@ declare module WinJS.UI {
**/
dispose(): void;
+ /**
+ * Forces the Hub to update its layout.
+ * Use this function when making the Hub visible again after you've set its style.display property to "none” or after style changes have been made that affect the size of the HubSections.
+ **/
+ forceLayout(): void;
+
/**
* Removes an event handler that the addEventListener method registered.
* @param eventName The name of the event that the event handler is registered for.
@@ -4873,6 +5464,47 @@ declare module WinJS.UI {
**/
zoomableView: IZoomableView<any>;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ /**
+ * Specifies whether the Hub animation is an entrance animation or a transition animation.
+ **/
+ static AnimationType: {
+ /**
+ * The animation plays when the Hub is first displayed.
+ **/
+ entrance: string;
+ /**
+ * The animation plays when the Hub is changing its content.
+ **/
+ contentTransition: string;
+ /**
+ * The animation plays when a section is inserted into the Hub.
+ **/
+ insert: string;
+ /**
+ * The animation plays when a section is removed into the Hub.
+ **/
+ remove: string;
+ }
+
+ /**
+ * Gets the current loading state of the Hub.
+ **/
+ static LoadingState: {
+ /**
+ * The Hub is loading sections.
+ **/
+ loading: string;
+ /**
+ * All sections are loaded and animations are complete.
+ **/
+ complete: string;
+ }
+
//#endregion Properties
}
@@ -4885,7 +5517,7 @@ declare module WinJS.UI {
/**
* Creates a new HubSection.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new HubSection.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -4924,6 +5556,16 @@ declare module WinJS.UI {
**/
isHeaderStatic: boolean;
+ /**
+ * This object supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ static isDeclarativeControlContainer: any;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -4944,6 +5586,15 @@ declare module WinJS.UI {
//#endregion Constructors
+ //#region Properties
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#endregion Properties
+
}
/**
@@ -4954,7 +5605,7 @@ declare module WinJS.UI {
/**
* Creates a new ItemContainer.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new ItemContainer. For the ItemContainer to be accessible, this element must have its role attribute set to "list" or "listbox". If tapBehavior is set to none and selectionDisabled is true, then use the "list" role; otherwise, use the "listbox" role.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -5059,6 +5710,11 @@ declare module WinJS.UI {
**/
tapBehavior: TapBehavior;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -5067,6 +5723,10 @@ declare module WinJS.UI {
* This object supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
class Layout {
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
}
/**
@@ -5077,7 +5737,7 @@ declare module WinJS.UI {
/**
* Creates a new ListLayout.
- * @constructor
+ * @constructor
* @param options An object that contains one or more property/value pairs to apply to the new ListLayout. Each property of the options object corresponds to one of the object's properties or events. Event names must begin with "on".
**/
constructor(options?: any);
@@ -5086,20 +5746,6 @@ declare module WinJS.UI {
//#region Methods
- /**
- * This method is no longer supported.
- * @param beginScrollPosition
- * @param wholeItem
- **/
- calculateFirstVisible(beginScrollPosition: number, wholeItem: boolean): void;
-
- /**
- * This method is no longer supported.
- * @param endScrollPosition
- * @param wholeItem
- **/
- calculateLastVisible(endScrollPosition: number, wholeItem: boolean): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
@@ -5110,11 +5756,6 @@ declare module WinJS.UI {
**/
dragOver(): void;
- /**
- * This method is no longer supported.
- **/
- endLayout(): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
@@ -5128,27 +5769,6 @@ declare module WinJS.UI {
**/
getAdjacent(currentItem: any, pressedKey: WinJS.Utilities.Key): any;
- /**
- * This method is no longer supported.
- * @param itemIndex
- **/
- getItemPosition(itemIndex: number): void;
-
- /**
- * This method is no longer supported.
- * @param itemIndex
- * @param element
- * @param keyPressed
- **/
- getKeyboardNavigatedItem(itemIndex: number, element: HTMLElement, keyPressed: any): void;
-
- /**
- * This method is no longer supported.
- * @param beginScrollPosition
- * @param endScrollPosition
- **/
- getScrollbarRange(beginScrollPosition: number, endScrollPosition: number): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
* @param x The x-coordinate, or the horizontal position on the screen.
@@ -5156,117 +5776,37 @@ declare module WinJS.UI {
**/
hitTest(x: number, y: number): void;
- /**
- * This method is no longer supported.
- **/
- init(): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
initialize(): void;
- /**
- * This method is no longer supported.
- * @param elements
- **/
- itemsAdded(elements: any): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
- * @param firstPixel
- * @param lastPixel
+ * @param firstPixel
+ * @param lastPixel
**/
itemsFromRange(firstPixel: number, lastPixel: number): void;
- /**
- * This method is no longer supported.
- **/
- itemsMoved(): void;
-
- /**
- * This method is no longer supported.
- * @param elements
- **/
- itemsRemoved(elements: any): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
- * @param tree
- * @param changedRange
- * @param modifiedItems
- * @param modifiedGroups
+ * @param tree
+ * @param changedRange
+ * @param modifiedItems
+ * @param modifiedGroups
**/
layout(tree: any, changedRange: any, modifiedItems: any, modifiedGroups: any): void;
- /**
- * This method is no longer supported.
- * @param groupIndex
- * @param element A DOM element.
- **/
- layoutHeader(groupIndex: number, element: any): void;
-
- /**
- * This method is no longer supported.
- * @param itemIndex
- * @param element A DOM element.
- **/
- layoutItem(itemIndex: number, element: any): void;
-
- /**
- * This method is no longer supported.
- * @param element
- **/
- prepareHeader(element: HTMLElement): void;
-
- /**
- * This method is no longer supported.
- * @param itemIndex
- * @param element A DOM element.
- **/
- prepareItem(itemIndex: number, element: any): void;
-
- /**
- * This method is no longer supported.
- * @param item
- * @param newItem
- **/
- releaseItem(item: any, newItem: any): void;
-
- /**
- * This method is no longer supported.
- **/
- reset(): void;
-
- /**
- * This method is no longer supported.
- * @param layoutSite
- **/
- setSite(layoutSite: any): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
setupAnimations(): void;
- /**
- * This method is no longer supported.
- * @param beginScrollPosition
- * @param endScrollPositionScrollPosition
- **/
- startLayout(beginScrollPosition: number, endScrollPositionScrollPosition: number): void;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
uninitialize(): void;
- /**
- * This method is no longer supported.
- * @param count
- **/
- updateBackdrop(count: number): void;
-
//#endregion Methods
//#region Properties
@@ -5286,21 +5826,6 @@ declare module WinJS.UI {
**/
groupHeaderPosition: WinJS.UI.HeaderPosition;
- /**
- * This property is no longer supported. Starting with the Windows Library for JavaScript 2.0, use a CellSpanningLayout.
- **/
- groupInfo: Function;
-
- /**
- * This property is no longer supported. Starting with the Windows Library for JavaScript 2.0, use the orientation property instead.
- **/
- horizontal: boolean;
-
- /**
- * This property is no longer supported. Starting with the Windows Library for JavaScript 2.0, use a CellSpanningLayout.
- **/
- itemInfo: Function;
-
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
@@ -5311,6 +5836,11 @@ declare module WinJS.UI {
**/
orientation: WinJS.UI.Orientation;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -5323,7 +5853,7 @@ declare module WinJS.UI {
/**
* Creates a new ListView.
- * @constructor
+ * @constructor
* @param element The DOM element that hosts the ListView control.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the selectionchanged event, add a property named "onselectionchanged" to the options object and set its value to the event handler.
**/
@@ -5333,6 +5863,12 @@ declare module WinJS.UI {
//#region Events
+ /**
+ * Raised when the accessibility attributes have been added to the ListView items.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties detail.firstIndex, detail.lastIndex, detail.firstHeaderIndex, detail.lastHeaderIndex.
+ **/
+ onaccessibilityannotationcomplete(eventInfo: CustomEvent): void;
+
/**
* Occurs when the ListView is about to play an entrance or contentTransition animation.
* @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.type, detail.setPromise.
@@ -5417,6 +5953,18 @@ declare module WinJS.UI {
**/
onselectionchanging(eventInfo: CustomEvent): void;
+ /**
+ * Raised when the header's visibility property changes.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.visible.
+ **/
+ onheadervisibilitychanged(eventInfo: CustomEvent): void;
+
+ /**
+ * Raised when the footer's visibility property changes.
+ * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.visible.
+ **/
+ onfootervisibilitychanged(eventInfo: CustomEvent): void;
+
//#endregion Events
//#region Methods
@@ -5559,6 +6107,16 @@ declare module WinJS.UI {
**/
layout: ILayout2;
+ /**
+ * Gets or sets the footer of the ListView.
+ **/
+ footer: HTMLElement;
+
+ /**
+ * Gets or sets the header of the ListView.
+ **/
+ header: HTMLElement;
+
/**
* Gets or sets a value that specifies how the ListView fetches items and adds and removes them to the DOM. Don't change the value of this property after the ListView has begun loading data.
**/
@@ -5575,15 +6133,25 @@ declare module WinJS.UI {
maxDeferredItemCleanup: number;
/**
- * Gets or sets the number of pages to load when the loadingBehavior property is set to "incremental" and the user scrolls beyond the threshold specified by the pagesToLoadThreshold property.
+ * This property is deprecated. Gets or sets the number of pages to load when the loadingBehavior property is set to "incremental" and the user scrolls beyond the threshold specified by the pagesToLoadThreshold property.
**/
pagesToLoad: number;
/**
- * Gets or sets the threshold (in pages) for initiating an incremental load. When the last visible item is within the specified number of pages from the end of the loaded portion of the list, and if automaticallyLoadPages is true and loadingBehavior is set to "incremental", the ListView initiates an incremental load.
+ * This property is deprecated. Gets or sets the threshold (in pages) for initiating an incremental load. When the last visible item is within the specified number of pages from the end of the loaded portion of the list, and if automaticallyLoadPages is true and loadingBehavior is set to "incremental", the ListView initiates an incremental load.
**/
pagesToLoadThreshold: number;
+ /**
+ * Gets or sets the maximum number of pages to prefetch in the leading buffer for virtualization.
+ **/
+ maxLeadingPages: number;
+
+ /**
+ * Gets or sets the maximum number of pages to prefetch in the trailing buffer for virtualization.
+ **/
+ maxTrailingPages: number;
+
/**
* Gets or sets the function that is called when the ListView discards or recycles the element representation of a group header.
**/
@@ -5624,19 +6192,59 @@ declare module WinJS.UI {
**/
zoomableView: IZoomableView<ListView<T>>;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
/**
- * A tab control that displays multiple items.
-**/
+ * An enumeration of Media commands that the transport bar buttons support.
+ **/
+ interface MediaCommand {
+ audioTracks: string;
+ cast: string;
+ chapterSkipBack: string;
+ chapterSkipForward: string;
+ closedCaptions: string;
+ fastForward: string;
+ goToLive: string;
+ nextTrack: string;
+ pause: string;
+ play: string;
+ playbackRate: string;
+ playFromBeginning: string;
+ previousTrack: string;
+ rewind: string;
+ seek: string;
+ stop: string;
+ timeSkipBack: string;
+ timeSkipForward: string;
+ volume: string;
+ zoom: string;
+ }
+
+ /**
+ * The types of timeline markers supported by the MediaPlayer.
+ **/
+ interface MarkerType {
+ advertisement: string;
+ chapter: string;
+ custom: string;
+ }
+
+ /**
+ * A tab control that displays multiple items.
+ **/
class Pivot {
//#region Constructors
/**
* Creates a new Pivot.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new Pivot.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the cancel event, add a property named "oncancel" to the options object and set its value to the event handler.
**/
@@ -5689,6 +6297,12 @@ declare module WinJS.UI {
**/
dispose(): void;
+ /**
+ * Forces the control to relayout its content. This function is expected to be called
+ * when the pivot element is manually resized.
+ **/
+ forceLayout(): void;
+
/**
* Removes an event handler that the addEventListener method registered.
* @param eventName The name of the event that the event handler is registered for.
@@ -5706,6 +6320,16 @@ declare module WinJS.UI {
**/
element: HTMLElement;
+ /**
+ * Gets or sets the left custom header.
+ **/
+ customLeftHeader: HTMLElement;
+
+ /**
+ * Gets or sets the right custom header.
+ **/
+ customRightHeader: HTMLElement;
+
/**
* Gets or sets the Binding.List that contains the PivotItem objects that belong to this Pivot.
**/
@@ -5726,6 +6350,11 @@ declare module WinJS.UI {
**/
selectedItem: PivotItem;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets the title displayed above the PivotItem controls.
**/
@@ -5742,7 +6371,7 @@ declare module WinJS.UI {
/**
* Creates a new PivotItem.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new PivotItem.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the cancel event, add a property named "oncancel" to the options object and set its value to the event handler.
**/
@@ -5776,6 +6405,16 @@ declare module WinJS.UI {
**/
header: string;
+ /**
+ * This object supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ static isDeclarativeControlContainer: any;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -5787,7 +6426,7 @@ declare module WinJS.UI {
/**
* Creates a new Menu object.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the control.
* @param options The set of properties and values to apply to the new Menu.
**/
@@ -5833,6 +6472,14 @@ declare module WinJS.UI {
**/
addEventListener(type: string, listener: Function, useCapture?: boolean): void;
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(eventName: string, eventProperties: any): boolean;
+
/**
* Releases resources held by this Menu. Call this method when the Menu is no longer needed. After calling this method, the Menu becomes unusable.
**/
@@ -5855,7 +6502,7 @@ declare module WinJS.UI {
* @param commands The commands to hide. The array elements may be MenuCommand objects, or the string identifiers (IDs) of commands.
* @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to hide the commands immediately, without animating them; otherwise, false.
**/
- hideCommands(commands: any[], immediate: boolean): void;
+ hideCommands(commands: any[], immediate?: boolean): void;
/**
* Removes an event handler that the addEventListener method registered.
@@ -5873,19 +6520,32 @@ declare module WinJS.UI {
**/
show(anchor: HTMLElement, placement?: string, alignment?: string): void;
+ /**
+ * Shows the Menu, if hidden, regardless of other states, top and left aligned at the specified coordinates,
+ * @param coordinates Required. The point where the top left corner of the Menu will appear, relative to the top and left edge of the visual viewport.
+ **/
+ showAt(coordinates: { x: number; y: number; }): void;
+
+ /**
+ * Shows the Menu, if hidden, regardless of other states, top and left aligned at the location of the mouse event object,
+ * @param mouseEventObj Required. The MouseEvent Object specifying where to show the Menu.
+ **/
+ showAt(mouseEventObj: MouseEvent): void;
+
+
/**
* Shows the specified commands of the Menu.
* @param commands The commands to show. The array elements may be Menu objects, or the string identifiers (IDs) of commands.
* @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to show the commands immediately, without animating them; otherwise, false.
**/
- showCommands(commands: any[], immediate: boolean): void;
+ showCommands(commands: any[], immediate?: boolean): void;
/**
* Shows the specified commands of the Menu while hiding all other commands.
* @param commands The commands to show. The array elements may be MenuCommand objects, or the string identifiers (IDs) of commands.
* @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to show the specified commands (and hide the others) immediately, without animating them; otherwise, false.
**/
- showOnlyCommands(commands: any[], immediate: boolean): void;
+ showOnlyCommands(commands: any[], immediate?: boolean): void;
//#endregion Methods
@@ -5906,13 +6566,18 @@ declare module WinJS.UI {
**/
commands: MenuCommand[];
+ /**
+ * Gets or sets a value that indicates whether the Menu is disabled.
+ **/
+ disabled: boolean;
+
/**
* Gets the DOM element that hosts the Menu.
**/
element: HTMLElement;
/**
- * Gets a value that indicates whether the Menu is hidden or in the process of becoming hidden.
+ * Gets a value that indicates whether the Menu is hidden or in the process of becoming hidden, or sets the Menu to hide or show itself.
**/
hidden: boolean;
@@ -5921,6 +6586,11 @@ declare module WinJS.UI {
**/
placement: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -5933,7 +6603,7 @@ declare module WinJS.UI {
/**
* Creates a new MenuCommand object.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the control.
* @param options The set of properties and values to apply to the new MenuCommand.
**/
@@ -5945,7 +6615,7 @@ declare module WinJS.UI {
/**
* Registers an event handler for the specified event.
- * @param type The event type to register. It must be beforeshow, beforehide, aftershow, or afterhide.
+ * @param type The event type to register.
* @param listener The event handler function to associate with the event.
* @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
**/
@@ -5958,7 +6628,7 @@ declare module WinJS.UI {
/**
* Removes an event handler that the addEventListener method registered.
- * @param type The event type to unregister. It must be beforeshow, beforehide, aftershow, or afterhide.
+ * @param type The event type to unregister.
* @param listener The event handler function to remove.
* @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
**/
@@ -6013,6 +6683,11 @@ declare module WinJS.UI {
**/
selected: boolean;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets the type of the command.
**/
@@ -6023,14 +6698,14 @@ declare module WinJS.UI {
}
/**
- * Displays navigation commands in a toolbar that the user can show or hide.
+ * Displays NavBarCommands in an overlayed navigation pane that opens and closes at the top or bottom of the main view.
**/
class NavBar {
//#region Constructors
/**
* Creates a new NavBar.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the new NavBar.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -6041,28 +6716,28 @@ declare module WinJS.UI {
//#region Events
/**
- * Occurs immediately after the NavBar is hidden.
+ * Occurs immediately after the NavBar is closed.
* @param eventInfo An object that contains information about the event.
**/
- onafterhide(eventInfo: Event): void;
+ onafterclose(eventInfo: Event): void;
/**
- * Raised after the NavBar is shown.
+ * Raised after the NavBar is opened.
* @param eventInfo An object that contains information about the event.
**/
- onaftershow(eventInfo: Event): void;
+ onafteropen(eventInfo: Event): void;
/**
- * Raised just before the NavBar is hidden.
+ * Raised just before the NavBar is closed.
* @param eventInfo An object that contains information about the event.
**/
- onbeforehide(eventInfo: Event): void;
+ onbeforeclose(eventInfo: Event): void;
/**
- * Occurs before a hidden NavBar is shown.
+ * Occurs before a closed NavBar is opened.
* @param eventInfo An object that contains information about the event.
**/
- onbeforeshow(eventInfo: Event): void;
+ onbeforeopen(eventInfo: Event): void;
/**
* Occurs after the NavBar has finished processing its child elements.
@@ -6096,16 +6771,16 @@ declare module WinJS.UI {
dispose(): void;
/**
- * Hides the NavBar.
+ * Closes the NavBar.
**/
- hide(): void;
+ close(): void;
/**
* Hides the specified commands of the NavBar.
* @param commands The commands to hide. The array elements may be NavBarCommand objects, or the string identifiers (IDs) of commands.
* @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to hide the commands immediately, without animating them; otherwise, false.
**/
- hideCommands(commands: any[], immediate: boolean): void;
+ hideCommands(commands: any[], immediate?: boolean): void;
/**
* Removes an event handler that the addEventListener method registered.
@@ -6116,52 +6791,59 @@ declare module WinJS.UI {
removeEventListener(eventName: string, eventCallback: Function, useCapture?: boolean): void;
/**
- * Shows the NavBar if it is not disabled.
+ * Opens the NavBar
**/
- show(): void;
+ open(): void;
/**
* Shows the specified commands of the NavBar.
* @param commands The commands to show. The array elements may be NavBarCommand objects, or the string identifiers (IDs) of commands.
* @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to show the commands immediately, without animating them; otherwise, false.
**/
- showCommands(commands: any[], immediate: boolean): void;
+ showCommands(commands: any[], immediate?: boolean): void;
/**
* Shows the specified commands of the NavBar while hiding all other commands.
* @param commands The commands to show. The array elements may be NavBarCommand objects, or the string identifiers (IDs) of commands.
* @param immediate The parameter immediate is not supported and may be altered or unavailable in the future. true to show the specified commands (and hide the others) immediately, without animating them; otherwise, false.
**/
- showOnlyCommands(commands: any[], immediate: boolean): void;
+ showOnlyCommands(commands: any[], immediate?: boolean): void;
//#endregion Methods
//#region Properties
+ /**
+ * Gets/Sets how NavBar will display itself while closed. Values are "none" and "minimal".
+ **/
+ closedDisplayMode: string;
+
/**
* This API supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
commands: AppBarCommand;
- /**
- * Gets or sets a value that indicates whether the NavBar is disabled.
- **/
- disabled: boolean;
-
/**
* Gets the HTML element that hosts this NavBar.
**/
element: HTMLElement;
/**
- * Gets a value that indicates whether the NavBar is hidden or in the process of becoming hidden.
+ * Returns the NavBarCommand object identified by id.
+ * @param id The element idenitifier (ID) of the NavBarCommand to be returned.
+ * @returns The NavBarCommand identified by id. If multiple commands have the same ID, returns the first command found.
+ **/
+ getCommandById(id: string): NavBarCommand;
+
+ /**
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code. Use NavBar.opened instead.
**/
hidden: boolean;
/**
- * This API supports the WinJS infrastructure and is not intended to be used directly from your code.
+ * Gets a value that indicates whether the NavBar is opened or in the process of becoming opened, or sets the NavBar to open or close itself.
**/
- layout: string;
+ opened: boolean;
/**
* Gets or sets a value that specifies whether the NavBar appears at the top or bottom of the main view.
@@ -6169,9 +6851,14 @@ declare module WinJS.UI {
placement: string;
/**
- * Gets or sets a value that indicates whether the NavBar is sticky (won't light dismiss). If not sticky, the NavBar dismisses normally when the user touches outside of the NavBar.
+ * This object supports the WinJS infrastructure and is not intended to be used directly from your code.
**/
- sticky: boolean;
+ static isDeclarativeControlContainer: any;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
//#endregion Properties
@@ -6185,7 +6872,7 @@ declare module WinJS.UI {
/**
* Creates a new NavBarCommand.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new NavBarCommand.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -6193,6 +6880,16 @@ declare module WinJS.UI {
//#endregion Constructors
+ //#region Events
+
+ /**
+ * This API supports the Windows Library for JavaScript infrastructure and is not intended to be used directly from your code.
+ * Use NavBarContainer.oninvoked instead.
+ **/
+ oninvoked: any;
+
+ //#endregion Events
+
//#region Methods
/**
@@ -6263,10 +6960,15 @@ declare module WinJS.UI {
**/
state: any;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets the tooltip of the command.
**/
- tooltip: any;
+ tooltip: string;
//#endregion Properties
@@ -6280,7 +6982,7 @@ declare module WinJS.UI {
/**
* Creates a new NavBarContainer.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new NavBarContainer.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -6374,6 +7076,11 @@ declare module WinJS.UI {
**/
maxRows: number;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets the WinJS.Binding.Template or templating function that creates the DOM elements for each item in the data source. Each item can contain multiple elements, but it must have a single root element.
**/
@@ -6391,7 +7098,7 @@ declare module WinJS.UI {
/**
* Creates a new Rating.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new Rating.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the cancel event, add a property named "oncancel" to the options object and set its value to the event handler.
**/
@@ -6473,6 +7180,11 @@ declare module WinJS.UI {
**/
maxRating: number;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets a set of descriptions to show for rating values in the tooltip.
**/
@@ -6495,11 +7207,11 @@ declare module WinJS.UI {
/**
* Creates a new Repeater control.
- * @constructor
+ * @constructor
* @param elemnt The DOM element that will host the new control. The Repeater will create an element if this value is null.
* @param options An object that contains one or more property/value pairs to apply to the new Repeater. Each property of the options object corresponds to one of the object's properties or events. Event names must begin with "on".
**/
- constructor(element?:HTMLElement, options?: any);
+ constructor(element?: HTMLElement, options?: any);
//#endregion Constructors
@@ -6630,6 +7342,16 @@ declare module WinJS.UI {
**/
length: number;
+ /**
+ * This object supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ static isDeclarativeControlContainer: any;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets a WinJS.Binding.Template or custom rendering function that defines the HTML of each item within the Repeater.
**/
@@ -6647,7 +7369,7 @@ declare module WinJS.UI {
/**
* Creates a new SearchBox.
- * @constructor
+ * @constructor
* @param element The DOM element hosts the new SearchBox.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
**/
@@ -6669,17 +7391,11 @@ declare module WinJS.UI {
**/
onquerysubmitted(eventInfo: CustomEvent): void;
- /**
- * Raised when the app automatically redirects focus to the search box. This event can only be raised when the focusOnKeyboardInput property is set to true.
- * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.propertyName.
- **/
- onreceivingfocusonkeyboardinput(eventInfo: CustomEvent): void;
-
/**
* Raised when the user selects a suggested option for the search.
* @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: detail.tag, detail.keyModifiers, detail.storageFile.
**/
- onresultsuggestionschosen(eventInfo: CustomEvent): void;
+ onresultsuggestionchosen(eventInfo: CustomEvent): void;
/**
* Raised when the system requests search suggestions from this app.
@@ -6770,6 +7486,11 @@ declare module WinJS.UI {
**/
searchHistoryDisabled: boolean;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
static createResultSuggestionImage(url: string): any;
@@ -6784,7 +7505,7 @@ declare module WinJS.UI {
/**
* Creates a new SemanticZoom.
- * @constructor
+ * @constructor
* @param element The DOM element that hosts the SemanticZoom.
* @param options An object that contains one or more property/value pairs to apply to the new control. This object can contain these properties: initiallyZoomedOut Boolean, zoomFactor 0.2–0.85.
**/
@@ -6838,6 +7559,11 @@ declare module WinJS.UI {
**/
removeEventListener(eventName: string, eventCallback: Function, useCapture?: boolean): void;
+ /**
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ setTimeoutAfterTTFF(callback: Function, delay: number): void
+
//#endregion Methods
//#region Properties
@@ -6852,16 +7578,16 @@ declare module WinJS.UI {
**/
enableButton: boolean;
- /**
- * Determines whether any controls contained in a SemanticZoom should be processed separately. This property is always true, meaning that the SemanticZoom takes care of processing its own controls.
- **/
- isDeclarativeControlContainer: boolean;
-
/**
* Gets or sets a value that indicates whether SemanticZoom is locked and zooming between views is disabled.
**/
locked: boolean;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets a value that indicates whether the control is zoomed out.
**/
@@ -6872,6 +7598,16 @@ declare module WinJS.UI {
**/
zoomFactor: number;
+ /**
+ * Gets or sets a mapping function which can be used to change the item that is targeted on zoom in.
+ **/
+ zoomedInItem: (any: any) => any;
+
+ /**
+ * Gets or sets a mapping function which can be used to change the item that is targeted on zoom out.
+ **/
+ zoomedOutItem: (any: any) => any;
+
//#endregion Properties
}
@@ -6884,7 +7620,7 @@ declare module WinJS.UI {
/**
* Creates a new SettingsFlyout object.
- * @constructor
+ * @constructor
* @param element The DOM element that will host the control.
* @param options The set of properties and values to apply to the new SettingsFlyout.
**/
@@ -6979,10 +7715,20 @@ declare module WinJS.UI {
**/
static showSettings(id: string, path: any): void;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Methods
//#region Properties
+ /**
+ * Specifies whether the SettingsFlyout is disabled.
+ **/
+ disabled: boolean;
+
/**
* Gets the DOM element the SettingsFlyout is attached to.
**/
@@ -7006,6 +7752,325 @@ declare module WinJS.UI {
//#endregion Properties
}
+ /**
+ * Displays a SplitView which renders a collapsable pane next to arbitrary HTML content.
+ **/
+ class SplitView {
+ /**
+ * Placement options for a SplitView's pane.
+ **/
+ static PanePlacement: {
+ /**
+ * Pane is positioned left of the SplitView's content.
+ **/
+ left: string;
+ /**
+ * Pane is positioned right of the SplitView's content.
+ **/
+ right: string;
+ /**
+ * Pane is positioned above the SplitView's content.
+ **/
+ top: string;
+ /**
+ * Pane is positioned below the SplitView's content.
+ **/
+ bottom: string;
+ }
+
+ /**
+ * Display options for a SplitView's pane when it is closed.
+ **/
+ static ClosedDisplayMode: {
+ /**
+ * When the pane is closed, it is not visible and doesn't take up any space.
+ **/
+ none: string;
+ /**
+ * When the pane is closed, it occupies space leaving less room for the SplitView's content.
+ **/
+ inline: string;
+ }
+
+ /**
+ * Display options for a SplitView's pane when it is open.
+ **/
+ static OpenedDisplayMode: {
+ /**
+ * When the pane is open, it occupies space leaving less room for the SplitView's content.
+ **/
+ inline: string;
+ /**
+ * When the pane is open, it doesn't take up any space and it is light dismissable.
+ **/
+ overlay: string;
+ }
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ /**
+ * Creates a new SplitView.
+ * @constructor
+ * @param element The DOM element hosts the new SplitView.
+ * @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
+ **/
+ constructor(element?: HTMLElement, options?: any);
+
+ /**
+ * Gets the DOM element that hosts the SplitView control.
+ **/
+ element: HTMLElement;
+
+ /**
+ * Gets the DOM element that hosts the SplitView pane.
+ **/
+ paneElement: HTMLElement;
+
+ /**
+ * Gets the DOM element that hosts the SplitView's content.
+ **/
+ contentElement: HTMLElement;
+
+ /**
+ * Gets or sets the placement of the SplitView's pane.
+ **/
+ panePlacement: string;
+
+ /**
+ * Gets or sets the display mode of the SplitView's pane when it is closed.
+ **/
+ closedDisplayMode: string;
+
+ /**
+ * Gets or sets the display mode of the SplitView's pane when it is open.
+ **/
+ openedDisplayMode: string;
+
+ /**
+ * Gets or sets whether the SpitView's pane is currently open.
+ **/
+ paneOpened: boolean;
+
+ /**
+ * Opens the SplitView's pane.
+ **/
+ openPane(): void;
+
+ /**
+ * Closes the SplitView's pane.
+ **/
+ closePane(): void;
+
+ /**
+ * Disposes this control.
+ **/
+ dispose(): void;
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param eventName The name of the event to handle. Note that you drop the "on" when specifying the event name. For example, instead of specifying "onclick", you specify "click".
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param eventName The name of the event that the event handler is registered for.
+ * @param eventCallback The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(eventName: string, eventCallback: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Raised just before opening the pane. Call preventDefault on this event to stop the pane from opening.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onbeforeopen(eventInfo: Event): void;
+
+ /**
+ * Raised immediately after the pane is fully open.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onafteropen(eventInfo: Event): void;
+
+ /**
+ * Raised just before closing the pane. Call preventDefault on this event to stop the pane from closing.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onbeforeclose(eventInfo: Event): void;
+
+ /**
+ * Raised immediately after the pane is fully closed.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ onafterclose(eventInfo: Event): void;
+ }
+
+ /**
+ * Displays a button which is used for opening and closing a SplitView's pane.
+ **/
+ class SplitViewPaneToggle {
+ /**
+ * Creates a new SplitViewPaneToggle.
+ * @constructor
+ * @param element The DOM element hosts the new SplitViewPaneToggle.
+ * @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
+ **/
+ constructor(element?: HTMLButtonElement, options?: any);
+
+ /**
+ * Gets the DOM element that hosts the SplitViewPaneToggle control.
+ **/
+ element: HTMLButtonElement;
+
+ /**
+ * Gets or sets the DOM element of the SplitView that is associated with the SplitViewPaneToggle control.
+ * When the SplitViewPaneToggle is invoked, it'll toggle this SplitView's pane.
+ **/
+ splitView: HTMLElement;
+
+ /**
+ * Disposes this control.
+ **/
+ dispose(): void;
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param eventName The name of the event to handle. Note that you drop the "on" when specifying the event name. For example, instead of specifying "onclick", you specify "click".
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param eventName The name of the event that the event handler is registered for.
+ * @param eventCallback The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(eventName: string, eventCallback: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Raised when the SplitViewPaneToggle is invoked.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ oninvoked(eventInfo: Event): void;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ }
+
+ /**
+ * Represents a command in the SplitView Pane.
+ **/
+ class SplitViewCommand {
+ //#region Constructors
+
+ /**
+ * Creates a new SplitViewCommand.
+ * @constructor
+ * @param element The DOM element hosts the new SplitViewCommand.
+ * @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events.
+ **/
+ constructor(element?: HTMLElement, options?: any);
+
+ //#endregion Constructors
+
+ //# region Events
+
+ /**
+ * Raised when a SplitViewCommand has been invoked.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ oninvoked(eventInfo: CustomEvent): void;
+
+ //#endregion Events
+
+ //#region Methods
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param eventName The name of the event to handle. Note that you drop the "on" when specifying the event name. For example, instead of specifying "onclick", you specify "click".
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Releases resources held by this SplitViewCommand. Call this method when the SplitViewCommand is no longer needed. After calling this method, the SplitViewCommand becomes unusable.
+ **/
+ dispose(): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param eventName The name of the event that the event handler is registered for.
+ * @param eventCallback The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(eventName: string, eventCallback: Function, useCapture?: boolean): void;
+
+ //#endregion Methods
+
+ //#region Properties
+
+ /**
+ * Gets the HTML element that hosts this SplitViewCommand.
+ **/
+ element: HTMLElement;
+
+ /**
+ * Gets or sets the command's icon.
+ **/
+ icon: string;
+
+ /**
+ * Gets or sets the label of the command.
+ **/
+ label: string;
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ /**
+ * Gets or sets the tooltip of the command.
+ **/
+ tooltip: string;
+
+ //#endregion Properties
+ }
/**
* A type of IListDataSource that provides read-access to an object that implements the IStorageQueryResultBase interface. A StorageDataSource enables you to query and bind to items in the data source.
@@ -7033,8 +8098,37 @@ declare module WinJS.UI {
**/
loadThumbnail(item: IItem<T>, image: HTMLImageElement): Promise<void>;
+ /**
+ * Registers an event handler for the specified event.
+ * @param type The name of the event for which to add a listener.
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(type: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param details The set of additional properties to be attached to the event object.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(type: string, details: any): boolean;
+
+ /**
+ * Removes a listener for the specified event.
+ * @param type The name of the event for which to remove a listener.
+ * @param eventHandler The event handler function to associate with the event.
+ * @param useCapture Optional. The same value that was passed to addEventListener for this listener. It may be omitted if it was omitted when calling addEventListener.
+ **/
+ removeEventListener(type: string, eventHandler: Function, useCapture?: any): void;
+
//#endregion Methods
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
}
/**
@@ -7045,7 +8139,7 @@ declare module WinJS.UI {
/**
* Creates a new TabContainer.
- * @constructor
+ * @constructor
* @param element The DOM element that hosts the TabContainer control.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties.
**/
@@ -7069,6 +8163,11 @@ declare module WinJS.UI {
**/
childFocus: HTMLElement;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets the tab index of this container.
**/
@@ -7086,7 +8185,7 @@ declare module WinJS.UI {
/**
* Initializes a new instance of a TimePicker control.
- * @constructor
+ * @constructor
* @param element The DOM element associated with the TimePicker control.
* @param options The set of options to be applied initially to the TimePicker control. The options are the following: clock.
**/
@@ -7128,12 +8227,9 @@ declare module WinJS.UI {
dispose(): void;
/**
- * Raises an event of the specified type and with additional properties.
- * @param type The type (name) of the event.
- * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
- * @returns true if preventDefault was called on the event, otherwise false.
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code. Use render instead.
**/
- raiseEvent(type: string, eventProperties: any): boolean;
+ static getInformation(clock: any, minuteIncrement: any, timerPatterns?: any): any;
/**
* Removes a listener for the specified event.
@@ -7187,6 +8283,11 @@ declare module WinJS.UI {
**/
periodPattern: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -7199,7 +8300,7 @@ declare module WinJS.UI {
/**
* Creates a new ToggleSwitch.
- * @constructor
+ * @constructor
* @param element The DOM that hosts the control.
* @param options An object that contains one or more property/value pairs to apply to the new control. Each property of the options object corresponds to one of the control's properties or events. Event names must begin with "on". For example, to provide a handler for the change event, add a property named "onchange" to the options object and set its value to the event handler.
**/
@@ -7240,20 +8341,6 @@ declare module WinJS.UI {
**/
dispose(): void;
- /**
- * Handles the specified event.
- * @param event The event.
- **/
- handleEvent(event: any): void;
-
- /**
- * Raises an event of the specified type and with additional properties.
- * @param type The type (name) of the event.
- * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
- * @returns true if preventDefault was called on the event, otherwise false.
- **/
- raiseEvent(type: string, eventProperties: any): boolean;
-
/**
* Removes an event handler that the addEventListener method registered.
* @param eventName The name of the event that the event handler is registered for.
@@ -7291,6 +8378,11 @@ declare module WinJS.UI {
**/
labelOn: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
/**
* Gets or sets the main text for the ToggleSwitch control. This text is always displayed, regardless of whether the control is switched on or off.
**/
@@ -7299,6 +8391,139 @@ declare module WinJS.UI {
//#endregion Properties
}
+ /**
+ * Displays ICommands within the flow of the app. Use the ToolBar around other statically positioned app content.
+ **/
+ class ToolBar {
+
+ /**
+ * Display options for the closed ToolBar.
+ **/
+ public static ClosedDisplayMode: {
+ /**
+ * When the ToolBar is closed, the height of the ToolBar is reduced such that button commands are still visible, but their labels are hidden.
+ **/
+ compact: string;
+ /**
+ * When the ToolBar is closed, the height of the ToolBar is always sized to content.
+ **/
+ full: string;
+ };
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ public static supportedForProcessing: boolean;
+
+ /**
+ * Gets the DOM element that hosts the ToolBar.
+ **/
+ public element: HTMLElement;
+
+ /**
+ * Gets or sets the Binding List of ICommand for the ToolBar.
+ **/
+ public data: WinJS.Binding.List<ICommand>;
+
+ /**
+ * Gets or sets the closedDisplayMode for the ToolBar. Values are "compact" and "full".
+ **/
+ public closedDisplayMode: string;
+
+ /**
+ * Creates a new ToolBar control.
+ * @param element The DOM element that will host the control.
+ * @param options The set of properties and values to apply to the new ToolBar.
+ **/
+ constructor(element?: HTMLElement, options?: any);
+
+ /**
+ * Disposes the ToolBar
+ **/
+ public dispose(): void;
+
+ /**
+ * Forces the ToolBar to update its layout.
+ * Use this function when the window did not change size, but the ToolBar itself did.
+ **/
+ public forceLayout(): void;
+
+ /**
+ * Opens the ToolBar
+ **/
+ public open(): void;
+
+ /**
+ * Closes the ToolBar
+ **/
+ public close(): void;
+
+ /**
+ * Returns the Command object identified by id.
+ * @param id The element idenitifier (ID) of the command to be returned.
+ * @returns The command identified by id. If multiple commands have the same ID, returns the first command found.
+ **/
+ getCommandById(id: string): ICommand;
+
+ /**
+ * Shows the specified commands of the ToolBar while hiding all other commands.
+ * @param commands The commands to show. The array elements may be ICommand objects, or the string identifiers (IDs) of commands.
+ **/
+ showOnlyCommands(commands: Array<string|ICommand>): void;
+
+ /**
+ * Gets or sets whether the ToolBar is currently opened.
+ **/
+ public opened: boolean;
+
+ /**
+ * Occurs immediately before the control is opened. Is cancelable.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ public onbeforeopen: (eventInfo: CustomEvent) => void;
+
+ /**
+ * Occurs immediately after the control is opened.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ public onafteropen: (eventInfo: CustomEvent) => void;
+
+ /**
+ * Occurs immediately before the control is closed. Is cancelable.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ public onbeforeclose: (eventInfo: CustomEvent) => void;
+
+ /**
+ * Occurs immediately after the control is closed.
+ * @param eventInfo An object that contains information about the event.
+ **/
+ public onafterclose: (eventInfo: CustomEvent) => void;
+
+ /**
+ * Registers an event handler for the specified event.
+ * @param type The event type to register. It must be beforeopen, beforeclose, afteropen, or afterclose.
+ * @param listener The event handler function to associate with the event.
+ * @param useCapture Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
+ **/
+ addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Removes an event handler that the addEventListener method registered.
+ * @param type The event type to unregister. It must be beforeopen, beforeclose, afteropen, or afterclose.
+ * @param listener The event handler function to remove.
+ * @param useCapture Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
+ **/
+ removeEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(eventName: string, eventProperties: any): boolean;
+ }
/**
* Displays a tooltip that can contain images and formatting.
@@ -7412,6 +8637,11 @@ declare module WinJS.UI {
**/
placement: string;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -7442,6 +8672,14 @@ declare module WinJS.UI {
**/
addEventListener(eventName: string, eventHandler: Function, useCapture?: boolean): void;
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param eventName The name of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ dispatchEvent(eventName: string, eventProperties: any): boolean;
+
/**
* Releases resources held by this ViewBox. Call this method when the ViewBox is no longer needed. After calling this method, the ViewBox becomes unusable.
**/
@@ -7469,6 +8707,11 @@ declare module WinJS.UI {
**/
element: HTMLElement;
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
//#endregion Properties
}
@@ -7488,7 +8731,7 @@ declare module WinJS.UI {
/**
* Initializes the VirtualizedDataSource base class of a custom data source.
- * @constructor
+ * @constructor
* @param listDataAdapter The object that supplies data to the VirtualizedDataSource.
* @param options An object that can contain properties that specify additional options for the VirtualizedDataSource. It supports these properties: cacheSize.
**/
@@ -7498,12 +8741,6 @@ declare module WinJS.UI {
//#region Events
- /**
- * Occurs when the status of the VirtualizedDataSource changes.
- * @param eventInfo An object that contains information about the event. The detail property of this object contains the following sub-properties: status.
- **/
- statuschanged(eventInfo: CustomEvent): void;
-
//#endregion Events
//#region Methods
@@ -7534,6 +8771,15 @@ declare module WinJS.UI {
//#endregion Methods
+ //#region Properties
+
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#endregion Properties
+
}
//#endregion Objects
@@ -7597,6 +8843,11 @@ declare module WinJS.UI {
**/
function isAnimationEnabled(): boolean;
+ /**
+ * * This API supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ function optionsParser(value: string, context?: any, functionContext?: any): any;
+
/**
* Applies declarative control binding to all elements, starting at the specified root element.
* @param rootElement The element at which to start applying the binding. If this parameter is not specified, the binding is applied to the entire document.
@@ -7621,22 +8872,156 @@ declare module WinJS.UI {
function scopedSelect(selector: string, element: HTMLElement): HTMLElement;
/**
- * Given a DOM element and a control, attaches the control to the element.
- * @param element Element to associate with the control.
- * @param control The control to attach to the element.
- **/
- function setControl(element: HTMLElement, control: any): void;
-
- /**
- * Adds the set of declaratively specified options (properties and events) to the specified control. If name of the options property begins with "on", the property value is a function and the control supports addEventListener. setControl calls addEventListener on the control.
+ * Adds the set of declaratively specified options (properties and events) to the specified control. If name of the options property begins with "on", the property value is a function and the control supports addEventListener, setOptions calls addEventListener on the control.
* @param control The control on which the properties and events are to be applied.
* @param options The set of options that are specified declaratively.
**/
function setOptions(control: any, options?: any): void;
+ /**
+ * This API supports the WinJS infrastructure and is not intended to be used directly from your code.
+ **/
+ function simpleItemRenderer(fn: Function): Function;
+
//#endregion Functions
}
+/**
+ * Provides utility functions for generic directional focus movement
+**/
+declare module WinJS.UI.XYFocus {
+ export interface XYFocusOptions {
+ /**
+ * The focus scope, only children of this element are considered in the calculation.
+ **/
+ focusRoot?: HTMLElement;
+
+ /**
+ * A rectangle indicating where focus came from before the current state.
+ **/
+ historyRect?: IRect;
+
+ /**
+ * The element from which to calculate the next focusable element; if specified, referenceRect is ignored.
+ **/
+ referenceElement?: HTMLElement;
+
+ /**
+ * The rectangle from which to calculate next focusable element; ignored if referenceElement is also specified.
+ **/
+ referenceRect?: IRect;
+ }
+
+ export interface IRect {
+ left: number;
+ right?: number;
+ top: number;
+ bottom?: number;
+
+ height: number;
+ width: number;
+ }
+
+ export interface XYFocusEvent extends CustomEvent {
+ detail: { nextFocusElement: HTMLElement; keyCode: number; previousFocusElement: HTMLElement };
+ }
+
+ /**
+ * Gets the mapping object that maps keycodes to XYFocus actions.
+ **/
+ export var keyCodeMap: {
+ /**
+ * The array of keycodes that cause XYFocus to accept.
+ **/
+ accept: Array<number>;
+ /**
+ * The array of keycodes that cause XYFocus to cancel.
+ **/
+ cancel: Array<number>;
+ /**
+ * The array of keycodes that cause XYFocus to navigate down.
+ **/
+ down: Array<number>;
+ /**
+ * The array of keycodes that cause XYFocus to navigate left.
+ **/
+ left: Array<number>;
+ /**
+ * The array of keycodes that cause XYFocus to navigate right.
+ **/
+ right: Array<number>;
+ /**
+ * The array of keycodes that cause XYFocus to navigate up.
+ **/
+ up: Array<number>;
+ };
+
+ /**
+ * Gets or sets the focus root when invoking XYFocus APIs.
+ **/
+ export var focusRoot: HTMLElement;
+
+ /**
+ * Adds an event listener to XYFocus events.
+ * @param type The type (name) of the event.
+ * @param listener The listener to invoke when the event gets raised.
+ **/
+ export function addEventListener(type: string, handler: EventListener): void;
+
+ /**
+ * Raises an event of the specified type and with additional properties.
+ * @param type The type (name) of the event.
+ * @param eventProperties The set of additional properties to be attached to the event object when the event is raised.
+ * @returns true if preventDefault was called on the event, otherwise false.
+ **/
+ export function dispatchEvent(type: string, eventProperties: any): boolean;
+
+ /**
+ * Removes an event listener to XYFocus events.
+ * @param type The type (name) of the event.
+ * @param listener The listener to remove.
+ **/
+ export function removeEventListener(type: string, handler: EventListener): void;
+
+ /**
+ * Returns the next focusable element from the current active element (or reference, if supplied) towards the specified direction.
+ * @param direction The direction to search.
+ * @param options An options object configuring the search.
+ **/
+ export function findNextFocusElement(direction: string, options?: XYFocusOptions): HTMLElement;
+ export function findNextFocusElement(direction: "left", options?: XYFocusOptions): HTMLElement;
+ export function findNextFocusElement(direction: "right", options?: XYFocusOptions): HTMLElement;
+ export function findNextFocusElement(direction: "up", options?: XYFocusOptions): HTMLElement;
+ export function findNextFocusElement(direction: "down", options?: XYFocusOptions): HTMLElement;
+
+ /**
+ * Moves focus to the next focusable element from the current active element (or reference, if supplied) towards the specific direction.
+ * @param direction The direction to move.
+ * @param options An options object configuring the focus move.
+ **/
+ export function moveFocus(direction: string, options?: XYFocusOptions): HTMLElement;
+ export function moveFocus(direction: "left", options?: XYFocusOptions): HTMLElement;
+ export function moveFocus(direction: "right", options?: XYFocusOptions): HTMLElement;
+ export function moveFocus(direction: "up", options?: XYFocusOptions): HTMLElement;
+ export function moveFocus(direction: "down", options?: XYFocusOptions): HTMLElement;
+
+ //#region Events
+
+ /**
+ * Occurs immeidately after XYFocus has changed focus targets.
+ * @param eventInfo An object that contains information about the event. The detail property of this object includes the following subproperties: previousFocusElemewnt, keyCode.
+ **/
+ export function onfocuschanged(eventInfo: CustomEvent): void;
+
+ /**
+ * Occurs immeidately before XYFocus changes focus targets. Is cancelable.
+ * @param eventInfo An object that contains information about the event. The detail property of this object includes the following subproperties: nextFocusElement, keyCode.
+ **/
+ export function onfocuschanging(eventInfo: CustomEvent): void;
+
+ //#endregion Events
+}
+
/**
* Provides functions to load HTML content programmatically.
**/
@@ -7792,7 +9177,7 @@ declare module WinJS.UI.TrackTabBehavior {
* Removes the tab order information from the specified element.
* @param element The element to remove tab information from.
**/
- function detatch(element: HTMLElement): void;
+ function detach(element: HTMLElement): void;
//#endregion Functions
@@ -8151,6 +9536,38 @@ declare module WinJS.Utilities {
* The F12 key.
**/
F12,
+ /**
+ * The XBox One Remote navigation view button.
+ **/
+ NavigationView,
+ /**
+ * The XBox One Remote navigation menu button.
+ **/
+ NavigationMenu,
+ /**
+ * The XBox One Remote navigation up button.
+ **/
+ NavigationUp,
+ /**
+ * The XBox One Remote navigation down button.
+ **/
+ NavigationDown,
+ /**
+ * The XBox One Remote navigation left button.
+ **/
+ NavigationLeft,
+ /**
+ * The XBox One Remote navigation right button.
+ **/
+ NavigationRight,
+ /**
+ * The XBox One Remote navigation accept button.
+ **/
+ NavigationAccept,
+ /**
+ * The XBox One Remote navigation cancel button.
+ **/
+ NavigationCancel,
/**
* The NUMBER LOCK key.
**/
@@ -8198,6 +9615,105 @@ declare module WinJS.Utilities {
/**
* The open bracket key ([).
**/
+ /**
+ * The XBox One gamepad A button.
+ **/
+ GamepadA,
+ /**
+ * The XBox One gamepad B button.
+ **/
+ GamepadB,
+ /**
+ * The XBox One gamepad X button.
+ **/
+ GamepadX,
+ /**
+ * The XBox One gamepad Y button.
+ **/
+ GamepadY,
+ /**
+ * The XBox One gamepad right shoulder.
+ **/
+ GamepadRightShoulder,
+ /**
+ * The XBox One gamepad left shoulder.
+ **/
+ GamepadLeftShoulder,
+ /**
+ * The XBox One gamepad left trigger.
+ **/
+ GamepadLeftTrigger,
+ /**
+ * The XBox One gamepad right trigger.
+ **/
+ GamepadRightTrigger,
+ /**
+ * The XBox One gamepad dpad up.
+ **/
+ GamepadDPadUp,
+ /**
+ * The XBox One gamepad dpad down.
+ **/
+ GamepadDPadDown,
+ /**
+ * The XBox One gamepad dpad left.
+ **/
+ GamepadDPadLeft,
+ /**
+ * The XBox One gamepad dpad right.
+ **/
+ GamepadDPadRight,
+ /**
+ * The XBox One gamepad menu button.
+ **/
+ GamepadMenu,
+ /**
+ * The XBox One gamepad view button.
+ **/
+ GamepadView,
+ /**
+ * The XBox One gamepad left thumbstick button.
+ **/
+ GamepadLeftThumbstick,
+ /**
+ * The XBox One gamepad right thumbstick button.
+ **/
+ GamepadRightThumbstick,
+ /**
+ * The XBox One gamepad left thumbstick's up.
+ **/
+ GamepadLeftThumbstickUp,
+ /**
+ * The XBox One gamepad left thumbstick's down.
+ **/
+ GamepadLeftThumbstickDown,
+ /**
+ * The XBox One gamepad left thumbstick's right.
+ **/
+ GamepadLeftThumbstickRight,
+ /**
+ * The XBox One gamepad left thumbstick's left.
+ **/
+ GamepadLeftThumbstickLeft,
+ /**
+ * The XBox One gamepad right thumbstick's up.
+ **/
+ GamepadRightThumbstickUp,
+ /**
+ * The XBox One gamepad right thumbstick's down.
+ **/
+ GamepadRightThumbstickDown,
+ /**
+ * The XBox One gamepad right thumbstick's right.
+ **/
+ GamepadRightThumbstickRight,
+ /**
+ * The XBox One gamepad right thumbstick's left.
+ **/
+ GamepadRightThumbstickLeft,
+ /**
+ * The open bracket key ([).
+ **/
openBracket,
/**
* The backslash key (\).
@@ -8210,7 +9726,11 @@ declare module WinJS.Utilities {
/**
* The single quote key (').
**/
- singleQuote
+ singleQuote,
+ /**
+ * Any IME input.
+ **/
+ IME,
}
//#endregion Enumerations
@@ -8254,7 +9774,7 @@ declare module WinJS.Utilities {
/**
* Represents the result of a query selector, and provides various operations that perform actions over the elements of the collection.
**/
- interface QueryCollection<T> extends Array<T> {
+ class QueryCollection<T> implements Array<T> {
//#region Methods
/**
@@ -8264,13 +9784,6 @@ declare module WinJS.Utilities {
**/
addClass(name: string): QueryCollection<T>;
- /**
- * Creates a QueryCollection that contains the children of the specified parent element.
- * @param element The parent element.
- * @returns The QueryCollection that contains the children of the element.
- **/
- children(element: HTMLElement): QueryCollection<T>;
-
/**
* Clears the specified style property for all the elements in the collection.
* @param name The name of the style property to be cleared.
@@ -8315,13 +9828,6 @@ declare module WinJS.Utilities {
**/
hasClass(name: string): boolean;
- /**
- * Looks up an element by ID and wraps the result in a QueryCollection.
- * @param id The ID of the element.
- * @returns A QueryCollection that contains the element, if it is found.
- **/
- id(id: string): QueryCollection<T>;
-
/**
* Adds a set of items to this QueryCollection.
* @param items The items to add to the QueryCollection. This may be an array-like object, a document fragment, or a single item.
@@ -8358,7 +9864,7 @@ declare module WinJS.Utilities {
/**
* Removes the specified class from all the elements in the collection.
* @param name The name of the class to be removed.
- * @returns his QueryCollection object.
+ * @returns This QueryCollection object.
**/
removeClass(name: string): QueryCollection<T>;
@@ -8405,14 +9911,161 @@ declare module WinJS.Utilities {
//#endregion Methods
- }
+ /**
+ * Indicates that the object is compatibile with declarative processing.
+ **/
+ static supportedForProcessing: boolean;
+
+ //#region Array<T>.prototype
+
+ /**
+ * Combines two or more arrays.
+ * @param items Additional items to add to the end of array1.
+ **/
+ concat<U extends T[]>(...items: U[]): T[];
+ /**
+ * Combines two or more arrays.
+ * @param items Additional items to add to the end of array1.
+ **/
+ concat(...items: T[]): T[];
+
+ /**
+ * Adds all the elements of an array separated by the specified separator string.
+ * @param separator A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
+ **/
+ join(separator?: string): string;
+
+ /**
+ * Removes the last element from an array and returns it.
+ **/
+ pop(): T;
+
+ /**
+ * Appends new elements to an array, and returns the new length of the array.
+ * @param items New elements of the Array.
+ **/
+ push(...items: T[]): number;
+
+ /**
+ * Reverses the elements in an Array.
+ **/
+ reverse(): T[];
+
+ /**
+ * Removes the first element from an array and returns it.
+ **/
+ shift(): T;
+
+ /**
+ * Returns a section of an array.
+ * @param start The beginning of the specified portion of the array.
+ * @param end The end of the specified portion of the array.
+ **/
+ slice(start?: number, end?: number): T[];
+
+ /**
+ * Sorts an array.
+ * @param compareFn The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
+ **/
+ sort(compareFn?: (a: T, b: T) => number): T[];
+
+ /**
+ * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+ * @param start The zero-based location in the array from which to start removing elements.
+ **/
+ splice(start: number): T[];
+
+ /**
+ * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+ * @param start The zero-based location in the array from which to start removing elements.
+ * @param deleteCount The number of elements to remove.
+ * @param items Elements to insert into the array in place of the deleted elements.
+ **/
+ splice(start: number, deleteCount: number, ...items: T[]): T[];
+
+ /**
+ * Inserts new elements at the start of an array.
+ * @param items Elements to insert at the start of the Array.
+ **/
+ unshift(...items: T[]): number;
+
+ /**
+ * Returns the index of the first occurrence of a value in an array.
+ * @param searchElement The value to locate in the array.
+ * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
+ **/
+ indexOf(searchElement: T, fromIndex?: number): number;
+
+ /**
+ * Returns the index of the last occurrence of a specified value in an array.
+ * @param searchElement The value to locate in the array.
+ * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
+ **/
+ lastIndexOf(searchElement: T, fromIndex?: number): number;
+
+ /**
+ * Determines whether all the members of an array satisfy the specified test.
+ * @param callbackfn A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
+ * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+ **/
+ every(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean;
+
+ /**
+ * Determines whether the specified callback function returns true for any element of an array.
+ * @param callbackfn A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
+ * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+ **/
+ some(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): boolean;
+
+ /**
+ * Calls a defined callback function on each element of an array, and returns an array that contains the results.
+ * @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
+ * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+ **/
+ map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[];
+
+ /**
+ * Returns the elements of an array that meet the condition specified in a callback function.
+ * @param callbackfn A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
+ * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+ **/
+ filter(callbackfn: (value: T, index: number, array: T[]) => boolean, thisArg?: any): T[];
+
+ /**
+ * Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+ * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+ * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+ **/
+ reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T;
+ /**
+ * Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+ * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+ * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+ **/
+ reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U;
+
+ /**
+ * Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+ * @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+ * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+ **/
+ reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue?: T): T;
+ /**
+ * Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+ * @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+ * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+ **/
+ reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U;
+
+ /**
+ * Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.
+ **/
+ length: number;
+
+ [n: number]: T;
+
+ //#endregion Array<T>.prototype
- /**
- * Constructor support for QueryCollection interface
- **/
- export var QueryCollection: {
- new <T>(items: T[]): QueryCollection<T>;
- prototype: QueryCollection<any>;
}
//#endregion Objects
@@ -8536,7 +10189,7 @@ declare module WinJS.Utilities {
* @param element The element.
* @returns An object with two properties: scrollLeft and scrollTop
**/
- function getScrollPosition(element: HTMLElement): { scrollLeft: number; scrollTop: number};
+ function getScrollPosition(element: HTMLElement): { scrollLeft: number; scrollTop: number };
/**
* Gets the tab index of the specified element.
@@ -8668,7 +10321,7 @@ declare module WinJS.Utilities {
* @param element The element.
* @param position An object describing the position to set.
**/
- function setScrollPosition(element: HTMLElement, position: { scrollLeft: number; scrollTop: number}): void;
+ function setScrollPosition(element: HTMLElement, position: { scrollLeft: number; scrollTop: number }): void;
/**
* Configures a logger that writes messages containing the specified tags to the JavaScript console.
@@ -8700,9 +10353,9 @@ declare module WinJS.Utilities {
var hasWinRT: boolean;
/**
- * Indicates whether the app is running on Windows Phone.
+ * Determines if strict declarative processing is enabled in this script context.
**/
- var isPhone: boolean;
+ var strictProcessing: boolean;
//#endregion Properties
diff --git a/xregexp/xregexp-tests.ts b/xregexp/xregexp-tests.ts
index 0a7f24ded..17e1d6bdf 100644
--- a/xregexp/xregexp-tests.ts
+++ b/xregexp/xregexp-tests.ts
@@ -8,6 +8,7 @@ import TokenOpts = X.TokenOpts;
var exp: RegExp;
var expArr: RegExp[];
+var expArrArr: RegExp[][];
var chain: RegExp[];
var groupChain: { regex: RegExp; backref: string }[];
var groupChain1: { regex: RegExp; backref: number }[];
@@ -19,6 +20,7 @@ var search: string;
var searchEx: RegExp;
var bool: boolean;
var strArr: string[];
+var strArrArr: string[][];
var pattern: string;
var flags: string;
var right: string;
@@ -42,6 +44,14 @@ str = XRegExp.version;
// -- -- -- -- -- -- -- -- -- -- -- -- --
+regex = X(str);
+regex = X(str, flags);
+regex = X(regex);
+
+str = X.version;
+
+// -- -- -- -- -- -- -- -- -- -- -- -- --
+
XRegExp.addToken(regex, (arr, scope) => {
matchArr = arr;
str = scope;
@@ -69,13 +79,6 @@ matchArr = XRegExp.exec(str, regex);
// -- -- -- -- -- -- -- -- -- -- -- -- --
-matchArr = XRegExp.forEach(str, regex, (match, index, input, regexp) => {
- exp = regexp;
- str = input;
- num = index;
- matchArr = match;
-}, obj);
-
matchArr = XRegExp.forEach(str, regex, (match, index, input, regexp) => {
exp = regexp;
str = input;
@@ -92,6 +95,11 @@ XRegExp.install(obj);
bool = XRegExp.isInstalled(str);
bool = XRegExp.isRegExp(value);
+
+strArr = XRegExp.match(str, regex);
+strArr = XRegExp.match(str, regex, scope);
+str = XRegExp.match(str, regex, "one");
+
strArr = XRegExp.matchChain(str, chain);
strArr = XRegExp.matchChain(str, groupChain);
strArr = XRegExp.matchChain(str, groupChain1);
@@ -113,6 +121,11 @@ str = XRegExp.replace(str, searchEx, str);
str = XRegExp.replace(str, searchEx, replacer, scope);
str = XRegExp.replace(str, searchEx, replacer);
+// -- -- -- -- -- -- -- -- -- -- -- -- --
+str = XRegExp.replaceEach(str, expArrArr);
+str = XRegExp.replaceEach(str, strArrArr);
+str = XRegExp.replaceEach(str, [[str, exp], [str, exp]]);
+
// -- -- -- -- -- -- -- -- -- -- -- -- --
strArr = XRegExp.split(str, search, limit);
@@ -135,4 +148,3 @@ regex = XRegExp.union(strArr, flags);
regex = XRegExp.union(strArr);
// -- -- -- -- -- -- -- -- -- -- -- -- --
-
diff --git a/xregexp/xregexp.d.ts b/xregexp/xregexp.d.ts
index 561c37f57..0bc29f07f 100644
--- a/xregexp/xregexp.d.ts
+++ b/xregexp/xregexp.d.ts
@@ -1,38 +1,58 @@
-// Type definitions for XRegExp 2.0.0
+// Type definitions for XRegExp 3.0.0
// Project: http://xregexp.com
-// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+// Definitions by: Bart van der Schoor <https://github.com/Bartvds>,
+// Johannes Fahrenkrug <https://github.com/jfahrenkrug>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
declare module 'xregexp' {
- // scopes: 'default', 'class', or 'all'
- /*
- Native flags:
- g - global
- i - ignore case
- m - multiline anchors
- y - sticky (Firefox 3+)
- Additional XRegExp flags:
- n - explicit capture
- s - dot matches all (aka singleline)
- x - free-spacing and line comments (aka extended)
- */
- export interface TokenOpts {
- scope?: string;
- trigger?: () => boolean;
- customFlags?: string;
- }
- export function XRegExp(pattern: string, flags?: string): RegExp;
- export function XRegExp(pattern: RegExp): RegExp;
+ function OuterXRegExp(pattern: string, flags?: string): RegExp;
+ function OuterXRegExp(pattern: RegExp): RegExp;
- export module XRegExp {
+ module OuterXRegExp {
+ // scopes: 'default', 'class', or 'all'
+ /*
+ Native flags:
+ g - global
+ i - ignore case
+ m - multiline anchors
+ y - sticky (Firefox 3+)
+ Additional XRegExp flags:
+ n - explicit capture
+ s - dot matches all (aka singleline)
+ x - free-spacing and line comments (aka extended)
+ */
+ interface TokenOpts {
+ scope?: string;
+ trigger?: () => boolean;
+ customFlags?: string;
+ }
+
+ function XRegExp(pattern: string, flags?: string): RegExp;
+ function XRegExp(pattern: RegExp): RegExp;
+
+ /* Since xregexp 3.0.0 can be used either via
+
+ import X = require('xregexp');
+ X();
+
+ or via
+
+ import XRegExp = X.XRegExp;
+ XRegExp()
+
+ I had to duplicate the function declarations. I could simply not
+ find another way to accomplish this with TypeScript.
+ */
+
+ // begin API definitions
function addToken(regex: RegExp, handler: (matchArr: RegExpExecArray, scope: string) => string, options?: TokenOpts): void;
function build(pattern: string, subs: string[], flags?: string): RegExp;
function cache(pattern: string, flags?: string): RegExp;
function escape(str: string): string;
function exec(str: string, regex: RegExp, pos?: number, sticky?: boolean): RegExpExecArray;
- function forEach(str: string, regex: RegExp, callback: (matchArr: RegExpExecArray, index: number, input: string, regexp: RegExp) => void, context?: Object): any;
+ function forEach(str: string, regex: RegExp, callback: (matchArr: RegExpExecArray, index: number, input: string, regexp: RegExp) => void): any;
function globalize(regex: RegExp): RegExp;
function install(options: string): void;
@@ -40,6 +60,10 @@ declare module 'xregexp' {
function isInstalled(feature: string): boolean;
function isRegExp(value: any): boolean;
+ function match(str: string, regex: RegExp, scope: string): any;
+ function match(str: string, regex: RegExp, scope: "one"): string;
+ function match(str: string, regex: RegExp, scope: "all"): string[];
+ function match(str: string, regex: RegExp): string[];
function matchChain(str: string, chain: RegExp[]): string[];
function matchChain(str: string, chain: { regex: RegExp; backref: string }[]): string[];
function matchChain(str: string, chain: { regex: RegExp; backref: number }[]): string[];
@@ -49,6 +73,7 @@ declare module 'xregexp' {
function replace(str: string, search: string, replacement: Function, scope?: string): string;
function replace(str: string, search: RegExp, replacement: string, scope?: string): string;
function replace(str: string, search: RegExp, replacement: Function, scope?: string): string;
+ function replaceEach(str: string, replacements: Array<RegExp|string>[]): string;
function split(str: string, separator: string, limit?: number): string[];
function split(str: string, separator: RegExp, limit?: number): string[];
@@ -60,5 +85,52 @@ declare module 'xregexp' {
function union(patterns: string[], flags?: string): RegExp;
var version: string;
+ // end API definitions
+
+ module XRegExp {
+ // begin API definitions
+ function addToken(regex: RegExp, handler: (matchArr: RegExpExecArray, scope: string) => string, options?: TokenOpts): void;
+
+ function build(pattern: string, subs: string[], flags?: string): RegExp;
+ function cache(pattern: string, flags?: string): RegExp;
+ function escape(str: string): string;
+ function exec(str: string, regex: RegExp, pos?: number, sticky?: boolean): RegExpExecArray;
+ function forEach(str: string, regex: RegExp, callback: (matchArr: RegExpExecArray, index: number, input: string, regexp: RegExp) => void): any;
+ function globalize(regex: RegExp): RegExp;
+
+ function install(options: string): void;
+ function install(options: Object): void;
+
+ function isInstalled(feature: string): boolean;
+ function isRegExp(value: any): boolean;
+ function match(str: string, regex: RegExp, scope: string): any;
+ function match(str: string, regex: RegExp, scope: "one"): string;
+ function match(str: string, regex: RegExp, scope: "all"): string[];
+ function match(str: string, regex: RegExp): string[];
+ function matchChain(str: string, chain: RegExp[]): string[];
+ function matchChain(str: string, chain: { regex: RegExp; backref: string }[]): string[];
+ function matchChain(str: string, chain: { regex: RegExp; backref: number }[]): string[];
+ function matchRecursive(str: string, left: string, right: string, flags?: string, options?: Object): string[];
+
+ function replace(str: string, search: string, replacement: string, scope?: string): string;
+ function replace(str: string, search: string, replacement: Function, scope?: string): string;
+ function replace(str: string, search: RegExp, replacement: string, scope?: string): string;
+ function replace(str: string, search: RegExp, replacement: Function, scope?: string): string;
+ function replaceEach(str: string, replacements: Array<RegExp|string>[]): string;
+
+ function split(str: string, separator: string, limit?: number): string[];
+ function split(str: string, separator: RegExp, limit?: number): string[];
+
+ function test(str: string, regex: RegExp, pos?: number, sticky?: boolean): boolean;
+
+ function uninstall(options: Object): void;
+ function uninstall(options: string): void;
+
+ function union(patterns: string[], flags?: string): RegExp;
+ var version: string;
+ // end API definitions
+ }
}
+
+ export = OuterXRegExp;
}