` ) 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-2.0.0-alpha.37.d.ts b/angular2/http-2.0.0-alpha.37.d.ts
index b1f284954c..01430949f3 100644
--- a/angular2/http-2.0.0-alpha.37.d.ts
+++ b/angular2/http-2.0.0-alpha.37.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.37.d.ts"/>
diff --git a/angular2/http-2.0.0-alpha.38.d.ts b/angular2/http-2.0.0-alpha.38.d.ts
index 415aec767b..7ab595516f 100644
--- a/angular2/http-2.0.0-alpha.38.d.ts
+++ b/angular2/http-2.0.0-alpha.38.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.38.d.ts"/>
diff --git a/angular2/http-2.0.0-alpha.39.d.ts b/angular2/http-2.0.0-alpha.39.d.ts
index 573d346a53..580908387a 100644
--- a/angular2/http-2.0.0-alpha.39.d.ts
+++ b/angular2/http-2.0.0-alpha.39.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.39.d.ts"/>
diff --git a/angular2/http.d.ts b/angular2/http.d.ts
deleted file mode 100644
index 573d346a53..0000000000
--- 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-2.0.0-alpha.31.d.ts b/angular2/router-2.0.0-alpha.31.d.ts
index 5804905404..cbf7507b57 100644
--- a/angular2/router-2.0.0-alpha.31.d.ts
+++ b/angular2/router-2.0.0-alpha.31.d.ts
@@ -8,7 +8,7 @@
// Please do not create manual edits or send pull requests
// modifying this file.
// ***********************************************************
-///<reference path="./angular2.d.ts"/>
+///<reference path="./angular2-2.0.0-alpha.31.d.ts"/>
diff --git a/angular2/router-2.0.0-alpha.35.d.ts b/angular2/router-2.0.0-alpha.35.d.ts
index 0bba14cbbc..0dd907b067 100644
--- a/angular2/router-2.0.0-alpha.35.d.ts
+++ b/angular2/router-2.0.0-alpha.35.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.35.d.ts"/>
diff --git a/angular2/router-2.0.0-alpha.36.d.ts b/angular2/router-2.0.0-alpha.36.d.ts
index c862376384..c03af414b3 100644
--- a/angular2/router-2.0.0-alpha.36.d.ts
+++ b/angular2/router-2.0.0-alpha.36.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.36.d.ts"/>
diff --git a/angular2/router-2.0.0-alpha.37.d.ts b/angular2/router-2.0.0-alpha.37.d.ts
index 69ea2a5afa..e29c76999a 100644
--- a/angular2/router-2.0.0-alpha.37.d.ts
+++ b/angular2/router-2.0.0-alpha.37.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.37.d.ts"/>
diff --git a/angular2/router-2.0.0-alpha.38.d.ts b/angular2/router-2.0.0-alpha.38.d.ts
index 43574e3d5a..5e35c037cf 100644
--- a/angular2/router-2.0.0-alpha.38.d.ts
+++ b/angular2/router-2.0.0-alpha.38.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.38.d.ts"/>
diff --git a/angular2/router-2.0.0-alpha.39.d.ts b/angular2/router-2.0.0-alpha.39.d.ts
index be33ebf937..2d6d7dd996 100644
--- a/angular2/router-2.0.0-alpha.39.d.ts
+++ b/angular2/router-2.0.0-alpha.39.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.39.d.ts"/>
diff --git a/angular2/router.d.ts b/angular2/router.d.ts
deleted file mode 100644
index be33ebf937..0000000000
--- 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-2.0.0-alpha.38.d.ts b/angular2/test_lib-2.0.0-alpha.38.d.ts
index f298b8e3cb..01149b2a10 100644
--- a/angular2/test_lib-2.0.0-alpha.38.d.ts
+++ b/angular2/test_lib-2.0.0-alpha.38.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.38.d.ts"/>
///<reference path="../jasmine/jasmine.d.ts"/>
diff --git a/angular2/test_lib-2.0.0-alpha.39.d.ts b/angular2/test_lib-2.0.0-alpha.39.d.ts
index ccd64b21ba..48824cb76c 100644
--- a/angular2/test_lib-2.0.0-alpha.39.d.ts
+++ b/angular2/test_lib-2.0.0-alpha.39.d.ts
@@ -13,7 +13,7 @@
// 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="./angular2-2.0.0-alpha.39.d.ts"/>
///<reference path="../jasmine/jasmine.d.ts"/>
diff --git a/angular2/test_lib.d.ts b/angular2/test_lib.d.ts
deleted file mode 100644
index ccd64b21ba..0000000000
--- 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/angularjs/angular-animate.d.ts b/angularjs/angular-animate.d.ts
index babc752b2d..be83611e07 100644
--- a/angularjs/angular-animate.d.ts
+++ b/angularjs/angular-animate.d.ts
@@ -121,7 +121,7 @@ declare module angular.animate {
}
/**
- * AngularProvider
+ * AnimateProvider
* see http://docs.angularjs.org/api/ngAnimate/provider/$animateProvider
*/
interface IAnimateProvider {
diff --git a/angularjs/angular-resource-tests.ts b/angularjs/angular-resource-tests.ts
index f7f248ea8a..cfa7712cc2 100644
--- a/angularjs/angular-resource-tests.ts
+++ b/angularjs/angular-resource-tests.ts
@@ -8,11 +8,24 @@ interface IMyResourceClass extends angular.resource.IResourceClass<IMyResource>
///////////////////////////////////////
var actionDescriptor: angular.resource.IActionDescriptor;
-actionDescriptor.url = '/api/test-url/'
-actionDescriptor.headers = { header: 'value' };
-actionDescriptor.isArray = true;
-actionDescriptor.method = 'method action';
-actionDescriptor.params = { key: 'value' };
+angular.injector(['ng']).invoke(function ($cacheFactory: angular.ICacheFactoryService, $timeout: angular.ITimeoutService) {
+ actionDescriptor.method = 'method action';
+ actionDescriptor.params = { key: 'value' };
+ actionDescriptor.url = '/api/test-url/';
+ actionDescriptor.isArray = true;
+ actionDescriptor.transformRequest = function () { };
+ actionDescriptor.transformRequest = [function () { }];
+ actionDescriptor.transformResponse = function () { };
+ actionDescriptor.transformResponse = [function () { }];
+ actionDescriptor.headers = { header: 'value' };
+ actionDescriptor.cache = true;
+ actionDescriptor.cache = $cacheFactory('cacheId');
+ actionDescriptor.timeout = 1000;
+ actionDescriptor.timeout = $timeout(function () { });
+ actionDescriptor.withCredentials = true;
+ actionDescriptor.responseType = 'response type';
+ actionDescriptor.interceptor = { key: 'value' };
+});
///////////////////////////////////////
diff --git a/angularjs/angular-resource.d.ts b/angularjs/angular-resource.d.ts
index 4688a9c6f5..76930196ba 100644
--- a/angularjs/angular-resource.d.ts
+++ b/angularjs/angular-resource.d.ts
@@ -46,11 +46,18 @@ declare module angular.resource {
// Just a reference to facilitate describing new actions
interface IActionDescriptor {
- url?: string;
method: string;
- isArray?: boolean;
params?: any;
+ url?: string;
+ isArray?: boolean;
+ transformRequest?: angular.IHttpRequestTransformer | angular.IHttpRequestTransformer[];
+ transformResponse?: angular.IHttpResponseTransformer | angular.IHttpResponseTransformer[];
headers?: any;
+ cache?: boolean | angular.ICacheObject;
+ timeout?: number | angular.IPromise<any>;
+ withCredentials?: boolean;
+ responseType?: string;
+ interceptor?: any;
}
// Baseclass for everyresource with default actions.
diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts
index 75f0b0e6aa..040622b51d 100644
--- a/angularjs/angular.d.ts
+++ b/angularjs/angular.d.ts
@@ -620,7 +620,7 @@ declare module angular {
}
///////////////////////////////////////////////////////////////////////////
- // AngularProvider
+ // AnimateProvider
// see http://docs.angularjs.org/api/ng/provider/$animateProvider
///////////////////////////////////////////////////////////////////////////
interface IAnimateProvider {
@@ -1390,7 +1390,7 @@ declare module angular {
}
// See the jsdoc for transformData() at https://github.com/angular/angular.js/blob/master/src/ng/http.js#L228
- interface IHttpResquestTransformer {
+ interface IHttpRequestTransformer {
(data: any, headersGetter: IHttpHeadersGetter): any;
}
@@ -1427,7 +1427,7 @@ declare module angular {
* headers and returns its transformed (typically serialized) version.
* @see {@link https://docs.angularjs.org/api/ng/service/$http#transforming-requests-and-responses}
*/
- transformRequest?: IHttpResquestTransformer |IHttpResquestTransformer[];
+ transformRequest?: IHttpRequestTransformer |IHttpRequestTransformer[];
/**
* Transform function or an array of such functions. The transform function takes the http response body and
diff --git a/archiver/archiver-test.ts b/archiver/archiver-tests.ts
similarity index 100%
rename from archiver/archiver-test.ts
rename to archiver/archiver-tests.ts
diff --git a/async/async.d.ts b/async/async.d.ts
index b908769151..418f5539b3 100644
--- a/async/async.d.ts
+++ b/async/async.d.ts
@@ -1,165 +1,165 @@
-// Type definitions for Async 1.4.2
-// Project: https://github.com/caolan/async
-// Definitions by: Boris Yankov <https://github.com/borisyankov/>, Arseniy Maximov <https://github.com/kern0>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-interface Dictionary<T> { [key: string]: T; }
-
-interface ErrorCallback { (err?: Error): void; }
-interface AsyncResultCallback<T> { (err: Error, result: T): void; }
-interface AsyncResultArrayCallback<T> { (err: Error, results: T[]): void; }
-interface AsyncResultObjectCallback<T> { (err: Error, results: Dictionary<T>): void; }
-
-interface AsyncFunction<T> { (callback: (err: Error, result?: T) => void): void; }
-interface AsyncIterator<T> { (item: T, callback: ErrorCallback): void; }
-interface AsyncForEachOfIterator<T> { (item: T, key: number, callback: ErrorCallback): void; }
-interface AsyncResultIterator<T, R> { (item: T, callback: AsyncResultCallback<R>): void; }
-interface AsyncMemoIterator<T, R> { (memo: R, item: T, callback: AsyncResultCallback<R>): void; }
-interface AsyncBooleanIterator<T> { (item: T, callback: (truthValue: boolean) => void): void; }
-
-interface AsyncWorker<T> { (task: T, callback: ErrorCallback): void; }
-interface AsyncVoidFunction { (callback: ErrorCallback): void; }
-
-interface AsyncQueue<T> {
- length(): number;
- started: boolean;
- running(): number;
- idle(): boolean;
- concurrency: number;
- push(task: T, callback?: ErrorCallback): void;
- push(task: T[], callback?: ErrorCallback): void;
- unshift(task: T, callback?: ErrorCallback): void;
- unshift(task: T[], callback?: ErrorCallback): void;
- saturated: () => any;
- empty: () => any;
- drain: () => any;
- paused: boolean;
- pause(): void
- resume(): void;
- kill(): void;
-}
-
-interface AsyncPriorityQueue<T> {
- length(): number;
- concurrency: number;
- started: boolean;
- paused: boolean;
- push(task: T, priority: number, callback?: AsyncResultArrayCallback<T>): void;
- push(task: T[], priority: number, callback?: AsyncResultArrayCallback<T>): void;
- saturated: () => any;
- empty: () => any;
- drain: () => any;
- running(): number;
- idle(): boolean;
- pause(): void;
- resume(): void;
- kill(): void;
-}
-
-interface AsyncCargo {
- length(): number;
- payload: number;
- push(task: any, callback? : Function): void;
- push(task: any[], callback? : Function): void;
- saturated(): void;
- empty(): void;
- drain(): void;
- idle(): boolean;
- pause(): void;
- resume(): void;
- kill(): void;
-}
-
-interface Async {
-
- // Collections
- 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<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<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<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;
- mapLimit<T, R>(arr: T[], limit: number, iterator: AsyncResultIterator<T, R>, callback?: AsyncResultArrayCallback<R>): any;
- filter<T>(arr: T[], iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- select<T>(arr: T[], iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- filterSeries<T>(arr: T[], iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- selectSeries<T>(arr: T[], iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- filterLimit<T>(arr: T[], limit: number, iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- selectLimit<T>(arr: T[], limit: number, iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- reject<T>(arr: T[], iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- rejectSeries<T>(arr: T[], iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- rejectLimit<T>(arr: T[], limit: number, iterator: AsyncResultIterator<T, boolean>, callback?: (results: T[]) => any): any;
- reduce<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback?: AsyncResultCallback<R>): any;
- inject<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback?: AsyncResultCallback<R>): any;
- foldl<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback?: AsyncResultCallback<R>): any;
- reduceRight<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback: AsyncResultCallback<R>): any;
- foldr<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback: AsyncResultCallback<R>): any;
- detect<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: T) => void): any;
- detectSeries<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: T) => void): any;
- detectLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (result: T) => void): any;
- sortBy<T, V>(arr: T[], iterator: AsyncResultIterator<T, V>, callback?: AsyncResultArrayCallback<T>): any;
- some<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => void): any;
- someLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => void): any;
- any<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => void): any;
- every<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => any): any;
- everyLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => any): any;
- all<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => any): any;
- concat<T, R>(arr: T[], iterator: AsyncResultIterator<T, R[]>, callback?: AsyncResultArrayCallback<R>): any;
- concatSeries<T, R>(arr: T[], iterator: AsyncResultIterator<T, R[]>, callback?: AsyncResultArrayCallback<R>): any;
-
- // Control Flow
- series<T>(tasks: AsyncFunction<T>[], callback?: AsyncResultArrayCallback<T>): void;
- series<T>(tasks: Dictionary<AsyncFunction<T>>, callback?: AsyncResultObjectCallback<T>): void;
- parallel<T>(tasks: Array<AsyncFunction<T>>, callback?: AsyncResultArrayCallback<T>): void;
- parallel<T>(tasks: Dictionary<AsyncFunction<T>>, callback?: AsyncResultObjectCallback<T>): void;
- parallelLimit<T>(tasks: Array<AsyncFunction<T>>, limit: number, callback?: AsyncResultArrayCallback<T>): void;
- parallelLimit<T>(tasks: Dictionary<AsyncFunction<T>>, limit: number, callback?: AsyncResultObjectCallback<T>): void;
- whilst(test: () => boolean, fn: AsyncVoidFunction, callback: (err: any) => void): void;
- doWhilst(fn: AsyncVoidFunction, test: () => boolean, callback: (err: any) => void): void;
- until(test: () => boolean, fn: AsyncVoidFunction, callback: (err: any) => void): void;
- doUntil(fn: AsyncVoidFunction, test: () => boolean, callback: (err: any) => void): void;
- during(test: (testCallback : (error: Error, truth: boolean) => void) => void, fn: AsyncVoidFunction, callback: (err: any) => void): void;
- doDuring(fn: AsyncVoidFunction, test: (testCallback: (error: Error, truth: boolean) => void) => void, callback: (err: any) => void): void;
- forever(next: (errCallback : (err: Error) => void) => void, errBack: (err: Error) => void) : void;
- waterfall(tasks: Function[], callback?: (err: Error, result: any) => void): void;
- compose(...fns: Function[]): void;
- seq(...fns: Function[]): void;
- applyEach(fns: Function[], argsAndCallback: any[]): void; // applyEach(fns, args..., callback). TS does not support ... for a middle argument. Callback is optional.
- applyEachSeries(fns: Function[], argsAndCallback: any[]): void; // applyEachSeries(fns, args..., callback). TS does not support ... for a middle argument. Callback is optional.
- queue<T>(worker: AsyncWorker<T>, concurrency?: number): AsyncQueue<T>;
- priorityQueue<T>(worker: AsyncWorker<T>, concurrency: number): AsyncPriorityQueue<T>;
- cargo(worker : (tasks: any[], callback : ErrorCallback) => void, payload? : number) : AsyncCargo;
- auto(tasks: any, callback?: (error: Error, results: any) => void): void;
- retry<T>(opts: number, task: (callback : AsyncResultCallback<T>, results: any) => void, callback: (error: Error, results: any) => void): void;
- retry<T>(opts: { times: number, interval: number }, task: (callback: AsyncResultCallback<T>, results : any) => void, callback: (error: Error, results: any) => void): void;
- iterator(tasks: Function[]): Function;
- apply(fn: Function, ...arguments: any[]): AsyncFunction<any>;
- nextTick(callback: Function): void;
- setImmediate(callback: Function): void;
-
- times<T> (n: number, iterator: AsyncResultIterator<number, T>, callback: AsyncResultArrayCallback<T>): void;
- timesSeries<T>(n: number, iterator: AsyncResultIterator<number, T>, callback: AsyncResultArrayCallback<T>): void;
- timesLimit<T>(n: number, limit: number, iterator: AsyncResultIterator<number, T>, callback: AsyncResultArrayCallback<T>): void;
-
- // Utils
- memoize(fn: Function, hasher?: Function): Function;
- unmemoize(fn: Function): Function;
- ensureAsync(fn: (... argsAndCallback: any[]) => void): Function;
- constant(...values: any[]): Function;
- asyncify(fn: Function): Function;
- wrapSync(fn: Function): Function;
- log(fn: Function, ...arguments: any[]): void;
- dir(fn: Function, ...arguments: any[]): void;
- noConflict(): Async;
-}
-
-declare var async: Async;
-
-declare module "async" {
- export = async;
-}
+// Type definitions for Async 1.4.2
+// Project: https://github.com/caolan/async
+// Definitions by: Boris Yankov <https://github.com/borisyankov/>, Arseniy Maximov <https://github.com/kern0>, Joe Herman <https://github.com/Penryn>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+interface Dictionary<T> { [key: string]: T; }
+
+interface ErrorCallback { (err?: Error): void; }
+interface AsyncResultCallback<T> { (err: Error, result: T): void; }
+interface AsyncResultArrayCallback<T> { (err: Error, results: T[]): void; }
+interface AsyncResultObjectCallback<T> { (err: Error, results: Dictionary<T>): void; }
+
+interface AsyncFunction<T> { (callback: (err?: Error, result?: T) => void): void; }
+interface AsyncIterator<T> { (item: T, callback: ErrorCallback): void; }
+interface AsyncForEachOfIterator<T> { (item: T, key: number, callback: ErrorCallback): void; }
+interface AsyncResultIterator<T, R> { (item: T, callback: AsyncResultCallback<R>): void; }
+interface AsyncMemoIterator<T, R> { (memo: R, item: T, callback: AsyncResultCallback<R>): void; }
+interface AsyncBooleanIterator<T> { (item: T, callback: (truthValue: boolean) => void): void; }
+
+interface AsyncWorker<T> { (task: T, callback: ErrorCallback): void; }
+interface AsyncVoidFunction { (callback: ErrorCallback): void; }
+
+interface AsyncQueue<T> {
+ length(): number;
+ started: boolean;
+ running(): number;
+ idle(): boolean;
+ concurrency: number;
+ push(task: T, callback?: ErrorCallback): void;
+ push(task: T[], callback?: ErrorCallback): void;
+ unshift(task: T, callback?: ErrorCallback): void;
+ unshift(task: T[], callback?: ErrorCallback): void;
+ saturated: () => any;
+ empty: () => any;
+ drain: () => any;
+ paused: boolean;
+ pause(): void
+ resume(): void;
+ kill(): void;
+}
+
+interface AsyncPriorityQueue<T> {
+ length(): number;
+ concurrency: number;
+ started: boolean;
+ paused: boolean;
+ push(task: T, priority: number, callback?: AsyncResultArrayCallback<T>): void;
+ push(task: T[], priority: number, callback?: AsyncResultArrayCallback<T>): void;
+ saturated: () => any;
+ empty: () => any;
+ drain: () => any;
+ running(): number;
+ idle(): boolean;
+ pause(): void;
+ resume(): void;
+ kill(): void;
+}
+
+interface AsyncCargo {
+ length(): number;
+ payload: number;
+ push(task: any, callback? : Function): void;
+ push(task: any[], callback? : Function): void;
+ saturated(): void;
+ empty(): void;
+ drain(): void;
+ idle(): boolean;
+ pause(): void;
+ resume(): void;
+ kill(): void;
+}
+
+interface Async {
+
+ // Collections
+ 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<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<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<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;
+ mapLimit<T, R>(arr: T[], limit: number, iterator: AsyncResultIterator<T, R>, callback?: AsyncResultArrayCallback<R>): any;
+ filter<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ select<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ filterSeries<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ selectSeries<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ filterLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ selectLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ reject<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ rejectSeries<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ rejectLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (results: T[]) => any): any;
+ reduce<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback?: AsyncResultCallback<R>): any;
+ inject<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback?: AsyncResultCallback<R>): any;
+ foldl<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback?: AsyncResultCallback<R>): any;
+ reduceRight<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback: AsyncResultCallback<R>): any;
+ foldr<T, R>(arr: T[], memo: R, iterator: AsyncMemoIterator<T, R>, callback: AsyncResultCallback<R>): any;
+ detect<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: T) => void): any;
+ detectSeries<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: T) => void): any;
+ detectLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (result: T) => void): any;
+ sortBy<T, V>(arr: T[], iterator: AsyncResultIterator<T, V>, callback?: AsyncResultArrayCallback<T>): any;
+ some<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => void): any;
+ someLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => void): any;
+ any<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => void): any;
+ every<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => any): any;
+ everyLimit<T>(arr: T[], limit: number, iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => any): any;
+ all<T>(arr: T[], iterator: AsyncBooleanIterator<T>, callback?: (result: boolean) => any): any;
+ concat<T, R>(arr: T[], iterator: AsyncResultIterator<T, R[]>, callback?: AsyncResultArrayCallback<R>): any;
+ concatSeries<T, R>(arr: T[], iterator: AsyncResultIterator<T, R[]>, callback?: AsyncResultArrayCallback<R>): any;
+
+ // Control Flow
+ series<T>(tasks: AsyncFunction<T>[], callback?: AsyncResultArrayCallback<T>): void;
+ series<T>(tasks: Dictionary<AsyncFunction<T>>, callback?: AsyncResultObjectCallback<T>): void;
+ parallel<T>(tasks: Array<AsyncFunction<T>>, callback?: AsyncResultArrayCallback<T>): void;
+ parallel<T>(tasks: Dictionary<AsyncFunction<T>>, callback?: AsyncResultObjectCallback<T>): void;
+ parallelLimit<T>(tasks: Array<AsyncFunction<T>>, limit: number, callback?: AsyncResultArrayCallback<T>): void;
+ parallelLimit<T>(tasks: Dictionary<AsyncFunction<T>>, limit: number, callback?: AsyncResultObjectCallback<T>): void;
+ whilst(test: () => boolean, fn: AsyncVoidFunction, callback: (err: any) => void): void;
+ doWhilst(fn: AsyncVoidFunction, test: () => boolean, callback: (err: any) => void): void;
+ until(test: () => boolean, fn: AsyncVoidFunction, callback: (err: any) => void): void;
+ doUntil(fn: AsyncVoidFunction, test: () => boolean, callback: (err: any) => void): void;
+ during(test: (testCallback : (error: Error, truth: boolean) => void) => void, fn: AsyncVoidFunction, callback: (err: any) => void): void;
+ doDuring(fn: AsyncVoidFunction, test: (testCallback: (error: Error, truth: boolean) => void) => void, callback: (err: any) => void): void;
+ forever(next: (errCallback : (err: Error) => void) => void, errBack: (err: Error) => void) : void;
+ waterfall(tasks: Function[], callback?: (err: Error, results?: any) => void): void;
+ compose(...fns: Function[]): void;
+ seq(...fns: Function[]): void;
+ applyEach(fns: Function[], argsAndCallback: any[]): void; // applyEach(fns, args..., callback). TS does not support ... for a middle argument. Callback is optional.
+ applyEachSeries(fns: Function[], argsAndCallback: any[]): void; // applyEachSeries(fns, args..., callback). TS does not support ... for a middle argument. Callback is optional.
+ queue<T>(worker: AsyncWorker<T>, concurrency?: number): AsyncQueue<T>;
+ priorityQueue<T>(worker: AsyncWorker<T>, concurrency: number): AsyncPriorityQueue<T>;
+ cargo(worker : (tasks: any[], callback : ErrorCallback) => void, payload? : number) : AsyncCargo;
+ auto(tasks: any, callback?: (error: Error, results: any) => void): void;
+ retry<T>(opts: number, task: (callback : AsyncResultCallback<T>, results: any) => void, callback: (error: Error, results: any) => void): void;
+ retry<T>(opts: { times: number, interval: number }, task: (callback: AsyncResultCallback<T>, results : any) => void, callback: (error: Error, results: any) => void): void;
+ iterator(tasks: Function[]): Function;
+ apply(fn: Function, ...arguments: any[]): AsyncFunction<any>;
+ nextTick(callback: Function): void;
+ setImmediate(callback: Function): void;
+
+ times<T> (n: number, iterator: AsyncResultIterator<number, T>, callback: AsyncResultArrayCallback<T>): void;
+ timesSeries<T>(n: number, iterator: AsyncResultIterator<number, T>, callback: AsyncResultArrayCallback<T>): void;
+ timesLimit<T>(n: number, limit: number, iterator: AsyncResultIterator<number, T>, callback: AsyncResultArrayCallback<T>): void;
+
+ // Utils
+ memoize(fn: Function, hasher?: Function): Function;
+ unmemoize(fn: Function): Function;
+ ensureAsync(fn: (... argsAndCallback: any[]) => void): Function;
+ constant(...values: any[]): Function;
+ asyncify(fn: Function): Function;
+ wrapSync(fn: Function): Function;
+ log(fn: Function, ...arguments: any[]): void;
+ dir(fn: Function, ...arguments: any[]): void;
+ noConflict(): Async;
+}
+
+declare var async: Async;
+
+declare module "async" {
+ export = async;
+}
diff --git a/backbone/backbone-global.d.ts b/backbone/backbone-global.d.ts
new file mode 100644
index 0000000000..764aa83d75
--- /dev/null
+++ b/backbone/backbone-global.d.ts
@@ -0,0 +1,390 @@
+// Type definitions for Backbone 1.0.0
+// Project: http://backbonejs.org/
+// Definitions by: Boris Yankov <https://github.com/borisyankov/>, Natan Vivo <https://github.com/nvivo/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts" />
+
+declare module Backbone {
+
+ interface AddOptions extends Silenceable {
+ at?: number;
+ }
+
+ interface HistoryOptions extends Silenceable {
+ pushState?: boolean;
+ root?: string;
+ }
+
+ interface NavigateOptions {
+ trigger?: boolean;
+ replace?: boolean;
+ }
+
+ interface RouterOptions {
+ routes: any;
+ }
+
+ interface Silenceable {
+ silent?: boolean;
+ }
+
+ interface Validable {
+ validate?: boolean;
+ }
+
+ interface Waitable {
+ wait?: boolean;
+ }
+
+ interface Parseable {
+ parse?: any;
+ }
+
+ interface PersistenceOptions {
+ url?: string;
+ beforeSend?: (jqxhr: JQueryXHR) => void;
+ success?: (modelOrCollection?: any, response?: any, options?: any) => void;
+ error?: (modelOrCollection?: any, jqxhr?: JQueryXHR, options?: any) => void;
+ }
+
+ interface ModelSetOptions extends Silenceable, Validable {
+ }
+
+ interface ModelFetchOptions extends PersistenceOptions, ModelSetOptions, Parseable {
+ }
+
+ interface ModelSaveOptions extends Silenceable, Waitable, Validable, Parseable, PersistenceOptions {
+ patch?: boolean;
+ }
+
+ interface ModelDestroyOptions extends Waitable, PersistenceOptions {
+ }
+
+ interface CollectionFetchOptions extends PersistenceOptions, Parseable {
+ reset?: boolean;
+ }
+
+ interface ObjectHash {
+ [key: string]: any;
+ }
+
+ interface RoutesHash {
+ [routePattern: string]: string | {(...urlParts: string[]): void};
+ }
+
+ interface EventsHash {
+ [selector: string]: string | {(eventObject: JQueryEventObject): void};
+ }
+
+ class Events {
+ on(eventName: string, callback?: Function, context?: any): any;
+ on(eventMap: EventsHash): any;
+ off(eventName?: string, callback?: Function, context?: any): any;
+ trigger(eventName: string, ...args: any[]): any;
+ bind(eventName: string, callback: Function, context?: any): any;
+ unbind(eventName?: string, callback?: Function, context?: any): any;
+
+ once(events: string, callback: Function, context?: any): any;
+ listenTo(object: any, events: string, callback: Function): any;
+ listenToOnce(object: any, events: string, callback: Function): any;
+ stopListening(object?: any, events?: string, callback?: Function): any;
+ }
+
+ class ModelBase extends Events {
+ url: any;
+ parse(response: any, options?: any): any;
+ toJSON(options?: any): any;
+ sync(...arg: any[]): JQueryXHR;
+ }
+
+ class Model extends ModelBase {
+
+ /**
+ * Do not use, prefer TypeScript's extend functionality.
+ **/
+ private static extend(properties: any, classProperties?: any): any;
+
+ attributes: any;
+ changed: any[];
+ cid: string;
+ collection: Collection<any>;
+
+ /**
+ * Default attributes for the model. It can be an object hash or a method returning an object hash.
+ * For assigning an object hash, do it like this: this.defaults = <any>{ attribute: value, ... };
+ * That works only if you set it in the constructor or the initialize method.
+ **/
+ defaults(): ObjectHash;
+ id: any;
+ idAttribute: string;
+ validationError: any;
+ urlRoot: any;
+
+ constructor(attributes?: any, options?: any);
+ initialize(attributes?: any, options?: any): void;
+
+ fetch(options?: ModelFetchOptions): JQueryXHR;
+
+ /**
+ * For strongly-typed access to attributes, use the `get` method only privately in public getter properties.
+ * @example
+ * get name(): string {
+ * return super.get("name");
+ * }
+ **/
+ /*private*/ get(attributeName: string): any;
+
+ /**
+ * For strongly-typed assignment of attributes, use the `set` method only privately in public setter properties.
+ * @example
+ * set name(value: string) {
+ * super.set("name", value);
+ * }
+ **/
+ /*private*/ set(attributeName: string, value: any, options?: ModelSetOptions): Model;
+ set(obj: any, options?: ModelSetOptions): Model;
+
+ change(): any;
+ changedAttributes(attributes?: any): any[];
+ clear(options?: Silenceable): any;
+ clone(): Model;
+ destroy(options?: ModelDestroyOptions): any;
+ escape(attribute: string): string;
+ has(attribute: string): boolean;
+ hasChanged(attribute?: string): boolean;
+ isNew(): boolean;
+ isValid(options?:any): boolean;
+ previous(attribute: string): any;
+ previousAttributes(): any[];
+ save(attributes?: any, options?: ModelSaveOptions): any;
+ unset(attribute: string, options?: Silenceable): Model;
+ validate(attributes: any, options?: any): any;
+
+ private _validate(attributes: any, options: any): boolean;
+
+ // mixins from underscore
+
+ keys(): string[];
+ values(): any[];
+ pairs(): any[];
+ invert(): any;
+ pick(keys: string[]): any;
+ pick(...keys: string[]): any;
+ omit(keys: string[]): any;
+ omit(...keys: string[]): any;
+ }
+
+ class Collection<TModel extends Model> extends ModelBase {
+
+ /**
+ * Do not use, prefer TypeScript's extend functionality.
+ **/
+ private static extend(properties: any, classProperties?: any): any;
+
+ model: new (...args:any[]) => TModel;
+ models: TModel[];
+ length: number;
+
+ constructor(models?: TModel[] | Object[], options?: any);
+ initialize(models?: TModel[] | Object[], options?: any): void;
+
+ fetch(options?: CollectionFetchOptions): JQueryXHR;
+
+ comparator(element: TModel): number;
+ comparator(compare: TModel, to?: TModel): number;
+
+ add(model: {}|TModel, options?: AddOptions): TModel;
+ add(models: ({}|TModel)[], options?: AddOptions): TModel[];
+ at(index: number): TModel;
+ /**
+ * Get a model from a collection, specified by an id, a cid, or by passing in a model.
+ **/
+ get(id: number|string|Model): TModel;
+ create(attributes: any, options?: ModelSaveOptions): TModel;
+ pluck(attribute: string): any[];
+ push(model: TModel, options?: AddOptions): TModel;
+ pop(options?: Silenceable): TModel;
+ remove(model: TModel, options?: Silenceable): TModel;
+ remove(models: TModel[], options?: Silenceable): TModel[];
+ reset(models?: TModel[], options?: Silenceable): TModel[];
+ set(models?: TModel[], options?: Silenceable): TModel[];
+ shift(options?: Silenceable): TModel;
+ sort(options?: Silenceable): Collection<TModel>;
+ unshift(model: TModel, options?: AddOptions): TModel;
+ where(properties: any): TModel[];
+ findWhere(properties: any): TModel;
+
+ private _prepareModel(attributes?: any, options?: any): any;
+ private _removeReference(model: TModel): void;
+ private _onModelEvent(event: string, model: TModel, collection: Collection<TModel>, options: any): void;
+
+ // mixins from underscore
+
+ all(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
+ any(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
+ collect(iterator: (element: TModel, index: number, context?: any) => any[], context?: any): any[];
+ chain(): any;
+ contains(value: any): boolean;
+ countBy(iterator: (element: TModel, index: number) => any): _.Dictionary<number>;
+ countBy(attribute: string): _.Dictionary<number>;
+ detect(iterator: (item: any) => boolean, context?: any): any; // ???
+ drop(): TModel;
+ drop(n: number): TModel[];
+ each(iterator: (element: TModel, index: number, list?: any) => void, context?: any): any;
+ every(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
+ filter(iterator: (element: TModel, index: number) => boolean, context?: any): TModel[];
+ find(iterator: (element: TModel, index: number) => boolean, context?: any): TModel;
+ first(): TModel;
+ first(n: number): TModel[];
+ foldl(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
+ forEach(iterator: (element: TModel, index: number, list?: any) => void, context?: any): any;
+ groupBy(iterator: (element: TModel, index: number) => string, context?: any): _.Dictionary<TModel[]>;
+ groupBy(attribute: string, context?: any): _.Dictionary<TModel[]>;
+ include(value: any): boolean;
+ indexOf(element: TModel, isSorted?: boolean): number;
+ initial(): TModel;
+ initial(n: number): TModel[];
+ inject(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
+ isEmpty(object: any): boolean;
+ invoke(methodName: string, args?: any[]): any;
+ last(): TModel;
+ last(n: number): TModel[];
+ lastIndexOf(element: TModel, fromIndex?: number): number;
+ map(iterator: (element: TModel, index: number, context?: any) => any, context?: any): any[];
+ max(iterator?: (element: TModel, index: number) => any, context?: any): TModel;
+ min(iterator?: (element: TModel, index: number) => any, context?: any): TModel;
+ reduce(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
+ select(iterator: any, context?: any): any[];
+ size(): number;
+ shuffle(): any[];
+ slice(min: number, max?: number): TModel[];
+ some(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
+ sortBy(iterator: (element: TModel, index: number) => number, context?: any): TModel[];
+ sortBy(attribute: string, context?: any): TModel[];
+ sortedIndex(element: TModel, iterator?: (element: TModel, index: number) => number): number;
+ reduceRight(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any[];
+ reject(iterator: (element: TModel, index: number) => boolean, context?: any): TModel[];
+ rest(): TModel;
+ rest(n: number): TModel[];
+ tail(): TModel;
+ tail(n: number): TModel[];
+ toArray(): any[];
+ without(...values: any[]): TModel[];
+ }
+
+ class Router extends Events {
+
+ /**
+ * Do not use, prefer TypeScript's extend functionality.
+ **/
+ private static extend(properties: any, classProperties?: any): any;
+
+ /**
+ * Routes hash or a method returning the routes hash that maps URLs with parameters to methods on your Router.
+ * For assigning routes as object hash, do it like this: this.routes = <any>{ "route": callback, ... };
+ * That works only if you set it in the constructor or the initialize method.
+ **/
+ routes: RoutesHash | any;
+
+ constructor(options?: RouterOptions);
+ initialize(options?: RouterOptions): void;
+ route(route: string|RegExp, name: string, callback?: Function): Router;
+ navigate(fragment: string, options?: NavigateOptions): Router;
+ navigate(fragment: string, trigger?: boolean): Router;
+
+ private _bindRoutes(): void;
+ private _routeToRegExp(route: string): RegExp;
+ private _extractParameters(route: RegExp, fragment: string): string[];
+ }
+
+ var history: History;
+
+ class History extends Events {
+
+ handlers: any[];
+ interval: number;
+
+ start(options?: HistoryOptions): boolean;
+
+ getHash(window?: Window): string;
+ getFragment(fragment?: string, forcePushState?: boolean): string;
+ stop(): void;
+ route(route: string, callback: Function): number;
+ checkUrl(e?: any): void;
+ loadUrl(fragmentOverride: string): boolean;
+ navigate(fragment: string, options?: any): boolean;
+ static started: boolean;
+ options: any;
+
+ private _updateHash(location: Location, fragment: string, replace: boolean): void;
+ }
+
+ interface ViewOptions<TModel extends Model> {
+ model?: TModel;
+ // TODO: quickfix, this can't be fixed easy. The collection does not need to have the same model as the parent view.
+ collection?: Backbone.Collection<any>; //was: Collection<TModel>;
+ el?: any;
+ id?: string;
+ className?: string;
+ tagName?: string;
+ attributes?: {[id: string]: any};
+ }
+
+ class View<TModel extends Model> extends Events {
+
+ /**
+ * Do not use, prefer TypeScript's extend functionality.
+ **/
+ private static extend(properties: any, classProperties?: any): any;
+
+ constructor(options?: ViewOptions<TModel>);
+ initialize(options?: ViewOptions<TModel>): void;
+
+ /**
+ * Events hash or a method returning the events hash that maps events/selectors to methods on your View.
+ * For assigning events as object hash, do it like this: this.events = <any>{ "event:selector": callback, ... };
+ * That works only if you set it in the constructor or the initialize method.
+ **/
+ events(): EventsHash;
+
+ $(selector: string): JQuery;
+ model: TModel;
+ collection: Collection<TModel>;
+ //template: (json, options?) => string;
+ setElement(element: HTMLElement|JQuery, delegate?: boolean): View<TModel>;
+ id: string;
+ cid: string;
+ className: string;
+ tagName: string;
+
+ el: any;
+ $el: JQuery;
+ setElement(element: any): View<TModel>;
+ attributes: any;
+ $(selector: any): JQuery;
+ render(): View<TModel>;
+ remove(): View<TModel>;
+ make(tagName: any, attributes?: any, content?: any): any;
+ delegateEvents(events?: EventsHash): any;
+ delegate(eventName: string, selector: string, listener: Function): View<TModel>;
+ undelegateEvents(): any;
+ undelegate(eventName: string, selector?: string, listener?: Function): View<TModel>;
+
+ _ensureElement(): void;
+ }
+
+ // SYNC
+ function sync(method: string, model: Model, options?: JQueryAjaxSettings): any;
+ function ajax(options?: JQueryAjaxSettings): JQueryXHR;
+ var emulateHTTP: boolean;
+ var emulateJSON: boolean;
+
+ // Utility
+ function noConflict(): typeof Backbone;
+ var $: JQueryStatic;
+}
+
+declare module "backbone" {
+ export = Backbone;
+}
diff --git a/backbone/backbone-global.d.ts.tscparams b/backbone/backbone-global.d.ts.tscparams
new file mode 100644
index 0000000000..7a0dec3079
--- /dev/null
+++ b/backbone/backbone-global.d.ts.tscparams
@@ -0,0 +1 @@
+--noImplicitAny ./underscore/underscore.d.ts
diff --git a/backbone/backbone-with-lodash-tests.ts b/backbone/backbone-with-lodash-tests.ts
new file mode 100644
index 0000000000..c4f5fdf4da
--- /dev/null
+++ b/backbone/backbone-with-lodash-tests.ts
@@ -0,0 +1,314 @@
+/// <reference path="../jquery/jquery.d.ts" />
+/// <reference path="../lodash/lodash.d.ts" />
+/// <reference path="./backbone-global.d.ts" />
+
+function test_events() {
+
+ var object = new Backbone.Events();
+ object.on("alert", (eventName: string) => alert("Triggered " + eventName));
+
+ object.trigger("alert", "an event");
+
+ var onChange = () => alert('whatever');
+ var context: any;
+
+ object.off("change", onChange);
+ object.off("change");
+ object.off(null, onChange);
+ object.off(null, null, context);
+ object.off();
+}
+
+class SettingDefaults extends Backbone.Model {
+
+ // 'defaults' could be set in one of the following ways:
+
+ defaults() {
+ return {
+ name: "Joe"
+ }
+ }
+
+ constructor(attributes?: any, options?: any) {
+ this.defaults = <any>{
+ name: "Joe"
+ }
+ // super has to come last
+ super(attributes, options);
+ }
+
+ // or set it like this
+ initialize() {
+ this.defaults = <any>{
+ name: "Joe"
+ }
+
+ }
+
+ // same patterns could be used for setting 'Router.routes' and 'View.events'
+}
+
+class Sidebar extends Backbone.Model {
+
+ promptColor() {
+ var cssColor = prompt("Please enter a CSS color:");
+ this.set({ color: cssColor });
+ }
+}
+
+class Note extends Backbone.Model {
+ initialize() { }
+ author() { }
+ coordinates() { }
+ allowedToEdit(account: any) {
+ return true;
+ }
+}
+
+class PrivateNote extends Note {
+ allowedToEdit(account: any) {
+ return account.owns(this);
+ }
+
+ set(attributes: any, options?: any): Backbone.Model {
+ return Backbone.Model.prototype.set.call(this, attributes, options);
+ }
+}
+
+function test_models() {
+
+ var sidebar = new Sidebar();
+ sidebar.on('change:color', (model: {}, color: string) => $('#sidebar').css({ background: color }));
+ sidebar.set({ color: 'white' });
+ sidebar.promptColor();
+
+ //////////
+
+ var note = new PrivateNote();
+
+ note.get("title");
+
+ note.set({ title: "March 20", content: "In his eyes she eclipses..." });
+
+ note.set("title", "A Scandal in Bohemia");
+}
+
+class Employee extends Backbone.Model {
+ reports: EmployeeCollection;
+
+ constructor(attributes?: any, options?: any) {
+ super(options);
+ this.reports = new EmployeeCollection();
+ this.reports.url = '../api/employees/' + this.id + '/reports';
+ }
+
+ more() {
+ this.reports.reset();
+ }
+}
+
+class EmployeeCollection extends Backbone.Collection<Employee> {
+ findByName(key: any) { }
+}
+
+class Book extends Backbone.Model {
+ title: string;
+ author: string;
+ published: boolean;
+}
+
+class Library extends Backbone.Collection<Book> {
+ // This model definition is here only to test type compatibility of the model, but it
+ // is not necessary in working code as it is automatically inferred through generics.
+ model: typeof Book;
+}
+
+class Books extends Backbone.Collection<Book> { }
+
+function test_collection() {
+
+ var books = new Books();
+
+ var book1: Book = new Book({ title: "Title 1", author: "Mike" });
+ books.add(book1);
+
+ // Objects can be added to collection by casting to model type.
+ // Compiler will check if object properties are valid for the cast.
+ // This gives better type checking than declaring an `any` overload.
+ books.add(<Book>{ title: "Title 2", author: "Mikey" });
+
+ var model: Book = book1.collection.first();
+ if (model !== book1) {
+ throw new Error("Error");
+ }
+
+ books.each(book =>
+ book.get("title"));
+
+ var titles = books.map(book =>
+ book.get("title"));
+
+ var publishedBooks = books.filter(book =>
+ book.get("published") === true);
+
+ var alphabetical = books.sortBy((book: Book): number => null);
+}
+
+//////////
+
+Backbone.history.start();
+
+module v1Changes {
+ module events {
+ function test_once() {
+ var model = new Employee;
+ model.once('invalid', () => { }, this);
+ model.once('invalid', () => { });
+ }
+
+ function test_listenTo() {
+ var model = new Employee;
+ var view = new Backbone.View<Employee>();
+ view.listenTo(model, 'invalid', () => { });
+ }
+
+ function test_listenToOnce() {
+ var model = new Employee;
+ var view = new Backbone.View<Employee>();
+ view.listenToOnce(model, 'invalid', () => { });
+ }
+
+ function test_stopListening() {
+ var model = new Employee;
+ var view = new Backbone.View<Employee>();
+ view.stopListening(model, 'invalid', () => { });
+ view.stopListening(model, 'invalid');
+ view.stopListening(model);
+ }
+ }
+
+ module ModelAndCollection {
+ function test_url() {
+ Employee.prototype.url = () => '/employees';
+ EmployeeCollection.prototype.url = () => '/employees';
+ }
+
+ function test_parse() {
+ var model = new Employee();
+ model.parse('{}', {});
+ var collection = new EmployeeCollection;
+ collection.parse('{}', {});
+ }
+
+ function test_toJSON() {
+ var model = new Employee();
+ model.toJSON({});
+ var collection = new EmployeeCollection;
+ collection.toJSON({});
+ }
+
+ function test_sync() {
+ var model = new Employee();
+ model.sync();
+ var collection = new EmployeeCollection;
+ collection.sync();
+ }
+ }
+
+ module Model {
+ function test_validationError() {
+ var model = new Employee;
+ if (model.validationError) {
+ console.log('has validation errors');
+ }
+ }
+
+ function test_fetch() {
+ var model = new Employee({ id: 1 });
+ model.fetch({
+ success: () => { },
+ error: () => { }
+ });
+ }
+
+ function test_set() {
+ var model = new Employee;
+ model.set({ name: 'JoeDoe', age: 21 }, { validate: false });
+ model.set('name', 'JoeDoes', { validate: false });
+ }
+
+ function test_destroy() {
+ var model = new Employee;
+ model.destroy({
+ wait: true,
+ success: (m?, response?, options?) => { },
+ error: (m?, jqxhr?, options?) => { }
+ });
+
+ model.destroy({
+ success: (m?, response?, options?) => { },
+ error: (m?, jqxhr?) => { }
+ });
+
+ model.destroy({
+ success: () => { },
+ error: (m?, jqxhr?) => { }
+ });
+ }
+
+ function test_save() {
+ var model = new Employee;
+
+ model.save({
+ name: 'Joe Doe',
+ age: 21
+ },
+ {
+ wait: true,
+ validate: false,
+ success: (m?, response?, options?) => { },
+ error: (m?, jqxhr?, options?) => { }
+ });
+
+ model.save({
+ name: 'Joe Doe',
+ age: 21
+ },
+ {
+ success: () => { },
+ error: (m?, jqxhr?) => { }
+ });
+ }
+
+ function test_validate() {
+ var model = new Employee;
+
+ model.validate({ name: 'JoeDoe', age: 21 }, { validateAge: false })
+ }
+ }
+
+ module Collection {
+ function test_fetch() {
+ var collection = new EmployeeCollection;
+ collection.fetch({ reset: true });
+ }
+
+ function test_create() {
+ var collection = new EmployeeCollection;
+ var model = new Employee;
+
+ collection.create(model, {
+ validate: false
+ });
+ }
+ }
+
+ module Router {
+ function test_navigate() {
+ var router = new Backbone.Router;
+
+ router.navigate('/employees', { trigger: true });
+ router.navigate('/employees', true);
+ }
+ }
+}
diff --git a/backbone/backbone.d.ts b/backbone/backbone.d.ts
index f7c5945ad3..3b777e581c 100644
--- a/backbone/backbone.d.ts
+++ b/backbone/backbone.d.ts
@@ -3,374 +3,5 @@
// Definitions by: Boris Yankov <https://github.com/borisyankov/>, Natan Vivo <https://github.com/nvivo/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-/// <reference path="../jquery/jquery.d.ts" />
/// <reference path="../underscore/underscore.d.ts" />
-
-declare module Backbone {
-
- interface AddOptions extends Silenceable {
- at?: number;
- }
-
- interface HistoryOptions extends Silenceable {
- pushState?: boolean;
- root?: string;
- }
-
- interface NavigateOptions {
- trigger?: boolean;
- replace?: boolean;
- }
-
- interface RouterOptions {
- routes: any;
- }
-
- interface Silenceable {
- silent?: boolean;
- }
-
- interface Validable {
- validate?: boolean;
- }
-
- interface Waitable {
- wait?: boolean;
- }
-
- interface Parseable {
- parse?: any;
- }
-
- interface PersistenceOptions {
- url?: string;
- beforeSend?: (jqxhr: JQueryXHR) => void;
- success?: (modelOrCollection?: any, response?: any, options?: any) => void;
- error?: (modelOrCollection?: any, jqxhr?: JQueryXHR, options?: any) => void;
- }
-
- interface ModelSetOptions extends Silenceable, Validable {
- }
-
- interface ModelFetchOptions extends PersistenceOptions, ModelSetOptions, Parseable {
- }
-
- interface ModelSaveOptions extends Silenceable, Waitable, Validable, Parseable, PersistenceOptions {
- patch?: boolean;
- }
-
- interface ModelDestroyOptions extends Waitable, PersistenceOptions {
- }
-
- interface CollectionFetchOptions extends PersistenceOptions, Parseable {
- reset?: boolean;
- }
-
- class Events {
- on(eventName: string, callback?: Function, context?: any): any;
- off(eventName?: string, callback?: Function, context?: any): any;
- trigger(eventName: string, ...args: any[]): any;
- bind(eventName: string, callback: Function, context?: any): any;
- unbind(eventName?: string, callback?: Function, context?: any): any;
-
- once(events: string, callback: Function, context?: any): any;
- listenTo(object: any, events: string, callback: Function): any;
- listenToOnce(object: any, events: string, callback: Function): any;
- stopListening(object?: any, events?: string, callback?: Function): any;
- }
-
- class ModelBase extends Events {
- url: any;
- parse(response: any, options?: any): any;
- toJSON(options?: any): any;
- sync(...arg: any[]): JQueryXHR;
- }
-
- class Model extends ModelBase {
-
- /**
- * Do not use, prefer TypeScript's extend functionality.
- **/
- private static extend(properties: any, classProperties?: any): any;
-
- attributes: any;
- changed: any[];
- cid: string;
- collection: Collection<any>;
-
- /**
- * Default attributes for the model. It can be an object hash or a method returning an object hash.
- * For assigning an object hash, do it like this: this.defaults = <any>{ attribute: value, ... };
- * That works only if you set it in the constructor or the initialize method.
- **/
- defaults(): any;
- id: any;
- idAttribute: string;
- validationError: any;
- urlRoot: any;
-
- constructor(attributes?: any, options?: any);
- initialize(attributes?: any, options?: any): void;
-
- fetch(options?: ModelFetchOptions): JQueryXHR;
-
- /**
- * For strongly-typed access to attributes, use the `get` method only privately in public getter properties.
- * @example
- * get name(): string {
- * return super.get("name");
- * }
- **/
- /*private*/ get(attributeName: string): any;
-
- /**
- * For strongly-typed assignment of attributes, use the `set` method only privately in public setter properties.
- * @example
- * set name(value: string) {
- * super.set("name", value);
- * }
- **/
- /*private*/ set(attributeName: string, value: any, options?: ModelSetOptions): Model;
- set(obj: any, options?: ModelSetOptions): Model;
-
- change(): any;
- changedAttributes(attributes?: any): any[];
- clear(options?: Silenceable): any;
- clone(): Model;
- destroy(options?: ModelDestroyOptions): any;
- escape(attribute: string): string;
- has(attribute: string): boolean;
- hasChanged(attribute?: string): boolean;
- isNew(): boolean;
- isValid(options?:any): boolean;
- previous(attribute: string): any;
- previousAttributes(): any[];
- save(attributes?: any, options?: ModelSaveOptions): any;
- unset(attribute: string, options?: Silenceable): Model;
- validate(attributes: any, options?: any): any;
-
- private _validate(attributes: any, options: any): boolean;
-
- // mixins from underscore
-
- keys(): string[];
- values(): any[];
- pairs(): any[];
- invert(): any;
- pick(keys: string[]): any;
- pick(...keys: string[]): any;
- omit(keys: string[]): any;
- omit(...keys: string[]): any;
- }
-
- class Collection<TModel extends Model> extends ModelBase {
-
- /**
- * Do not use, prefer TypeScript's extend functionality.
- **/
- private static extend(properties: any, classProperties?: any): any;
-
- model: new (...args:any[]) => TModel;
- models: TModel[];
- length: number;
-
- constructor(models?: TModel[] | Object[], options?: any);
- initialize(models?: TModel[] | Object[], options?: any): void;
-
- fetch(options?: CollectionFetchOptions): JQueryXHR;
-
- comparator(element: TModel): number;
- comparator(compare: TModel, to?: TModel): number;
-
- add(model: {}|TModel, options?: AddOptions): TModel;
- add(models: ({}|TModel)[], options?: AddOptions): TModel[];
- at(index: number): TModel;
- /**
- * Get a model from a collection, specified by an id, a cid, or by passing in a model.
- **/
- get(id: number|string|Model): TModel;
- create(attributes: any, options?: ModelSaveOptions): TModel;
- pluck(attribute: string): any[];
- push(model: TModel, options?: AddOptions): TModel;
- pop(options?: Silenceable): TModel;
- remove(model: TModel, options?: Silenceable): TModel;
- remove(models: TModel[], options?: Silenceable): TModel[];
- reset(models?: TModel[], options?: Silenceable): TModel[];
- set(models?: TModel[], options?: Silenceable): TModel[];
- shift(options?: Silenceable): TModel;
- sort(options?: Silenceable): Collection<TModel>;
- unshift(model: TModel, options?: AddOptions): TModel;
- where(properties: any): TModel[];
- findWhere(properties: any): TModel;
-
- private _prepareModel(attributes?: any, options?: any): any;
- private _removeReference(model: TModel): void;
- private _onModelEvent(event: string, model: TModel, collection: Collection<TModel>, options: any): void;
-
- // mixins from underscore
-
- all(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
- any(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
- collect(iterator: (element: TModel, index: number, context?: any) => any[], context?: any): any[];
- chain(): any;
- contains(value: any): boolean;
- countBy(iterator: (element: TModel, index: number) => any): _.Dictionary<number>;
- countBy(attribute: string): _.Dictionary<number>;
- detect(iterator: (item: any) => boolean, context?: any): any; // ???
- drop(): TModel;
- drop(n: number): TModel[];
- each(iterator: (element: TModel, index: number, list?: any) => void, context?: any): any;
- every(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
- filter(iterator: (element: TModel, index: number) => boolean, context?: any): TModel[];
- find(iterator: (element: TModel, index: number) => boolean, context?: any): TModel;
- first(): TModel;
- first(n: number): TModel[];
- foldl(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
- forEach(iterator: (element: TModel, index: number, list?: any) => void, context?: any): any;
- groupBy(iterator: (element: TModel, index: number) => string, context?: any): _.Dictionary<TModel[]>;
- groupBy(attribute: string, context?: any): _.Dictionary<TModel[]>;
- include(value: any): boolean;
- indexOf(element: TModel, isSorted?: boolean): number;
- initial(): TModel;
- initial(n: number): TModel[];
- inject(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
- isEmpty(object: any): boolean;
- invoke(methodName: string, args?: any[]): any;
- last(): TModel;
- last(n: number): TModel[];
- lastIndexOf(element: TModel, fromIndex?: number): number;
- map(iterator: (element: TModel, index: number, context?: any) => any, context?: any): any[];
- max(iterator?: (element: TModel, index: number) => any, context?: any): TModel;
- min(iterator?: (element: TModel, index: number) => any, context?: any): TModel;
- reduce(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any;
- select(iterator: any, context?: any): any[];
- size(): number;
- shuffle(): any[];
- slice(min: number, max?: number): TModel[];
- some(iterator: (element: TModel, index: number) => boolean, context?: any): boolean;
- sortBy(iterator: (element: TModel, index: number) => number, context?: any): TModel[];
- sortBy(attribute: string, context?: any): TModel[];
- sortedIndex(element: TModel, iterator?: (element: TModel, index: number) => number): number;
- reduceRight(iterator: (memo: any, element: TModel, index: number) => any, initialMemo: any, context?: any): any[];
- reject(iterator: (element: TModel, index: number) => boolean, context?: any): TModel[];
- rest(): TModel;
- rest(n: number): TModel[];
- tail(): TModel;
- tail(n: number): TModel[];
- toArray(): any[];
- without(...values: any[]): TModel[];
- }
-
- class Router extends Events {
-
- /**
- * Do not use, prefer TypeScript's extend functionality.
- **/
- private static extend(properties: any, classProperties?: any): any;
-
- /**
- * Routes hash or a method returning the routes hash that maps URLs with parameters to methods on your Router.
- * For assigning routes as object hash, do it like this: this.routes = <any>{ "route": callback, ... };
- * That works only if you set it in the constructor or the initialize method.
- **/
- routes: any;
-
- constructor(options?: RouterOptions);
- initialize(options?: RouterOptions): void;
- route(route: string|RegExp, name: string, callback?: Function): Router;
- navigate(fragment: string, options?: NavigateOptions): Router;
- navigate(fragment: string, trigger?: boolean): Router;
-
- private _bindRoutes(): void;
- private _routeToRegExp(route: string): RegExp;
- private _extractParameters(route: RegExp, fragment: string): string[];
- }
-
- var history: History;
-
- class History extends Events {
-
- handlers: any[];
- interval: number;
-
- start(options?: HistoryOptions): boolean;
-
- getHash(window?: Window): string;
- getFragment(fragment?: string, forcePushState?: boolean): string;
- stop(): void;
- route(route: string, callback: Function): number;
- checkUrl(e?: any): void;
- loadUrl(fragmentOverride: string): boolean;
- navigate(fragment: string, options?: any): boolean;
- started: boolean;
- options: any;
-
- private _updateHash(location: Location, fragment: string, replace: boolean): void;
- }
-
- interface ViewOptions<TModel extends Model> {
- model?: TModel;
- // TODO: quickfix, this can't be fixed easy. The collection does not need to have the same model as the parent view.
- collection?: Backbone.Collection<any>;
- el?: any;
- id?: string;
- className?: string;
- tagName?: string;
- attributes?: {[id: string]: any};
- }
-
- class View<TModel extends Model> extends Events {
-
- /**
- * Do not use, prefer TypeScript's extend functionality.
- **/
- private static extend(properties: any, classProperties?: any): any;
-
- constructor(options?: ViewOptions<TModel>);
- initialize(options?: ViewOptions<TModel>): void;
-
- /**
- * Events hash or a method returning the events hash that maps events/selectors to methods on your View.
- * For assigning events as object hash, do it like this: this.events = <any>{ "event:selector": callback, ... };
- * That works only if you set it in the constructor or the initialize method.
- **/
- events(): any;
-
- $(selector: string): JQuery;
- model: TModel;
- collection: Collection<TModel>;
- //template: (json, options?) => string;
- setElement(element: HTMLElement|JQuery, delegate?: boolean): View<TModel>;
- id: string;
- cid: string;
- className: string;
- tagName: string;
-
- el: any;
- $el: JQuery;
- setElement(element: any): View<TModel>;
- attributes: any;
- $(selector: any): JQuery;
- render(): View<TModel>;
- remove(): View<TModel>;
- make(tagName: any, attributes?: any, content?: any): any;
- delegateEvents(events?: any): any;
- undelegateEvents(): any;
-
- _ensureElement(): void;
- }
-
- // SYNC
- function sync(method: string, model: Model, options?: JQueryAjaxSettings): any;
- function ajax(options?: JQueryAjaxSettings): JQueryXHR;
- var emulateHTTP: boolean;
- var emulateJSON: boolean;
-
- // Utility
- function noConflict(): typeof Backbone;
- var $: JQueryStatic;
-}
-
-declare module "backbone" {
- export = Backbone;
-}
+/// <reference path="./backbone-global.d.ts" />
diff --git a/barcode/barcode-tests.ts b/barcode/barcode-tests.ts
new file mode 100644
index 0000000000..bb7b67187e
--- /dev/null
+++ b/barcode/barcode-tests.ts
@@ -0,0 +1,22 @@
+/// <reference path="barcode.d.ts" />
+import barcode = require('barcode');
+import path = require('path');
+
+var code39 = barcode('code39', {
+ data: "it works",
+ width: 400,
+ height: 100,
+});
+
+code39.getStream(function (err, readStream) {
+ if (err) throw err;
+
+ // 'readStream' is an instance of ReadableStream
+});
+
+var outfile = path.join(__dirname, 'imgs', 'mycode.png');
+code39.saveImage(outfile, function (err) {
+ if (err) throw err;
+
+ console.log('File has been written!');
+});
\ No newline at end of file
diff --git a/barcode/barcode.d.ts b/barcode/barcode.d.ts
new file mode 100644
index 0000000000..5f4c6cfd8c
--- /dev/null
+++ b/barcode/barcode.d.ts
@@ -0,0 +1,25 @@
+// Type definitions for barcode
+// Project: https://github.com/samt/barcode
+// Definitions by: Pascal Vomhoff <https://github.com/pvomhoff>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module "barcode" {
+
+ interface BarcodeOptions {
+ data:string|number;
+ width:number;
+ height:number;
+ }
+
+ interface BarcodeResult {
+ getStream(callback:(err:NodeJS.ErrnoException, stream:NodeJS.ReadableStream) => void):void;
+ saveImage(outputfilePath:string, callback:(err:NodeJS.ErrnoException) => void):void;
+ getBase64(callback:(err:NodeJS.ErrnoException, base64String:string) => void):void;
+ }
+
+ function barcode(type:string, options:BarcodeOptions):BarcodeResult;
+
+ export = barcode;
+}
diff --git a/benchmark/benchmark-tests.ts b/benchmark/benchmark-tests.ts
new file mode 100644
index 0000000000..363e522b0b
--- /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 0000000000..3365f335c1
--- /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/better-curry/better-curry-tests.ts b/better-curry/better-curry-tests.ts
index ba95326f5b..36e4936e0d 100644
--- a/better-curry/better-curry-tests.ts
+++ b/better-curry/better-curry-tests.ts
@@ -1,27 +1,27 @@
-/// <reference path="better-curry.d.ts" />
-
-import bc = require('better-curry');
-bc.flatten([1,2,3,[1,2],['a']]) === [];
-bc.MAX_OPTIMIZED = 5;
-
-function fn(...args: number[]): number[] {
- return [].concat([1]);
-}
-
-function fn2(arg1: string, arg2: any): number {
- return parseInt(arg1 + String(arg2)) + 1;
-}
-
-bc.predefine(fn, [1,2])() === [];
-bc.predefine(fn, [1,2]).__length === 3;
-
-var f = bc.wrap(fn2, {}, 10, true);
-f('1', 2) === 3;
-
-var delegate = bc.delegate({}, 'ok');
-delegate.access('ok') === delegate;
-delegate.getter('getter').setter('setter') === delegate;
-delegate.all(['1','2']);
-delegate.revoke('adsf').access('asdf');
-
+/// <reference path="better-curry.d.ts" />
+
+import bc = require('better-curry');
+bc.flatten([1,2,3,[1,2],['a']]) === [];
+bc.MAX_OPTIMIZED = 5;
+
+function fn(...args: number[]): number[] {
+ return [].concat([1]);
+}
+
+function fn2(arg1: string, arg2: any): number {
+ return parseInt(arg1 + String(arg2)) + 1;
+}
+
+bc.predefine(fn, [1,2])() === [];
+bc.predefine(fn, [1,2]).__length === 3;
+
+var f = bc.wrap(fn2, {}, 10, true);
+f('1', 2) === 3;
+
+var delegate = bc.delegate({}, 'ok');
+delegate.access('ok') === delegate;
+delegate.getter('getter').setter('setter') === delegate;
+delegate.all(['1','2']);
+delegate.revoke('adsf').access('asdf');
+
BetterCurry.wrap(fn2, {}, -1, false).__length === 10;
\ No newline at end of file
diff --git a/better-curry/better-curry.d.ts b/better-curry/better-curry.d.ts
index 59ebe0a37c..f6342bab2d 100644
--- a/better-curry/better-curry.d.ts
+++ b/better-curry/better-curry.d.ts
@@ -1,50 +1,50 @@
-// Type definitions for better-curry
-// Project: https://github.com/pocesar/js-bettercurry
-// Definitions by: Paulo Cesar <https://github.com/pocesar>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-declare var BetterCurry: BetterCurryModule.BetterCurry;
-
-declare module BetterCurryModule {
-
- export interface DelegateOptions {
- as?: string;
- len?: number;
- args?: any[];
- name?: string;
- }
-
- export class Delegate<T> {
- proto: T;
- target: string;
- methods: any[];
- getters: any[];
- setters: any[];
- all: (skip?: string[]) => void;
- method: (name: string|DelegateOptions) => Delegate<T>;
- getter: (name: string|DelegateOptions) => Delegate<T>;
- setter: (name: string|DelegateOptions) => Delegate<T>;
- access: (name: string|DelegateOptions) => Delegate<T>;
- revoke: (name: string) => Delegate<T>;
- constructor(proto: T, target: string);
- }
-
- export interface OriginalFunctionReminder<T> extends Function {
- __length: number;
- }
-
- export interface BetterCurry {
- predefine: <T extends Function>(fn: T, args: any[], context?: Object, len?: number, checkArguments?: boolean) => OriginalFunctionReminder<T>;
- wrap: <T extends Function>(fn: T, context?: Object, len?: number, checkArguments?: boolean) => OriginalFunctionReminder<T>;
- flatten: (...args: Array<Array<any>|any>) => any[];
- delegate: <T>(proto: T, target: string) => Delegate<T>;
- MAX_OPTIMIZED: number;
- }
-
-}
-
-declare module 'better-curry' {
- var bc: BetterCurryModule.BetterCurry;
-
- export = bc;
+// Type definitions for better-curry
+// Project: https://github.com/pocesar/js-bettercurry
+// Definitions by: Paulo Cesar <https://github.com/pocesar>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare var BetterCurry: BetterCurryModule.BetterCurry;
+
+declare module BetterCurryModule {
+
+ export interface DelegateOptions {
+ as?: string;
+ len?: number;
+ args?: any[];
+ name?: string;
+ }
+
+ export class Delegate<T> {
+ proto: T;
+ target: string;
+ methods: any[];
+ getters: any[];
+ setters: any[];
+ all: (skip?: string[]) => void;
+ method: (name: string|DelegateOptions) => Delegate<T>;
+ getter: (name: string|DelegateOptions) => Delegate<T>;
+ setter: (name: string|DelegateOptions) => Delegate<T>;
+ access: (name: string|DelegateOptions) => Delegate<T>;
+ revoke: (name: string) => Delegate<T>;
+ constructor(proto: T, target: string);
+ }
+
+ export interface OriginalFunctionReminder<T> extends Function {
+ __length: number;
+ }
+
+ export interface BetterCurry {
+ predefine: <T extends Function>(fn: T, args: any[], context?: Object, len?: number, checkArguments?: boolean) => OriginalFunctionReminder<T>;
+ wrap: <T extends Function>(fn: T, context?: Object, len?: number, checkArguments?: boolean) => OriginalFunctionReminder<T>;
+ flatten: (...args: Array<Array<any>|any>) => any[];
+ delegate: <T>(proto: T, target: string) => Delegate<T>;
+ MAX_OPTIMIZED: number;
+ }
+
+}
+
+declare module 'better-curry' {
+ var bc: BetterCurryModule.BetterCurry;
+
+ export = bc;
}
\ No newline at end of file
diff --git a/big-integer/big-integer-tests.ts b/big-integer/big-integer-tests.ts
index 3b9fb8745f..92633d2871 100644
--- a/big-integer/big-integer-tests.ts
+++ b/big-integer/big-integer-tests.ts
@@ -4,6 +4,9 @@
var noArgument = bigInt(),
numberArgument = bigInt( 93 ),
stringArgument = bigInt( "75643564363473453456342378564387956906736546456235345" ),
+ baseArgumentInt = bigInt( "101010", 2 ),
+ baseArgumentStr = bigInt( "101010", "2" ),
+ baseArgumentBi = bigInt( "101010", bigInt( 2 ) ),
bigIntArgument = bigInt( noArgument );
// method tests
@@ -111,4 +114,4 @@ isNumber = x.toJSNumber();
isString = x.toString();
-isNumber = x.valueOf();
\ No newline at end of file
+isNumber = x.valueOf();
diff --git a/big-integer/big-integer.d.ts b/big-integer/big-integer.d.ts
index 633432e199..9e9127e830 100644
--- a/big-integer/big-integer.d.ts
+++ b/big-integer/big-integer.d.ts
@@ -214,7 +214,7 @@ interface BigIntegerStatic {
/** Parse a Javascript number into a bigInt */
( number: number ): BigInteger;
/** Parse a string into a bigInt */
- ( string: string ): BigInteger;
+ ( string: string, base?: string | number | BigInteger): BigInteger;
/** no-op */
( bigInt: BigInteger ): BigInteger;
}
@@ -223,4 +223,4 @@ declare var bigInt: BigIntegerStatic;
declare module "big-integer" {
export = bigInt;
-}
\ No newline at end of file
+}
diff --git a/bingmaps/bingmaps-test.ts b/bingmaps/bingmaps-tests.ts
similarity index 98%
rename from bingmaps/bingmaps-test.ts
rename to bingmaps/bingmaps-tests.ts
index bccc5c8f28..5842ee82df 100644
--- a/bingmaps/bingmaps-test.ts
+++ b/bingmaps/bingmaps-tests.ts
@@ -1,4 +1,4 @@
-/// <reference path="Microsoft.Maps.d.ts"/>
+/// <reference path="Microsoft.Maps.d.ts"/>
/// <reference path="Microsoft.Maps.AdvancedShapes.d.ts"/>
/// <reference path="Microsoft.Maps.Directions.d.ts"/>
/// <reference path="Microsoft.Maps.Search.d.ts"/>
@@ -55,7 +55,7 @@ module BingMapsTests {
locations.push(location);
}
- // Sets the view of the map to the smallest size that contains all of the
+ // Sets the view of the map to the smallest size that contains all of the
// specified locations (in this case the pusphin locations)
map.setView({ bounds: Microsoft.Maps.LocationRect.fromLocations(locations) });
}
diff --git a/bluebird/bluebird-tests.ts b/bluebird/bluebird-tests.ts
index b8eecf2cad..ade4610743 100644
--- a/bluebird/bluebird-tests.ts
+++ b/bluebird/bluebird-tests.ts
@@ -36,6 +36,9 @@ interface Foo {
interface Bar {
bar(): string;
}
+interface Baz {
+ baz(): string;
+}
// - - - - - - - - - - - - - - - - -
@@ -61,6 +64,7 @@ interface StrBarArrMap {
var foo: Foo;
var bar: Bar;
+var baz: Baz;
var fooArr: Foo[];
var barArr: Bar[];
@@ -76,6 +80,7 @@ var voidProm: Promise<void>;
var fooProm: Promise<Foo>;
var barProm: Promise<Bar>;
+var bazProm: Promise<Baz>;
// - - - - - - - - - - - - - - - - -
@@ -499,6 +504,30 @@ barProm = fooProm.race<Bar>();
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+Promise.all([fooProm, barProm]).then(result => {
+ result[0].foo();
+ result[1].bar();
+});
+
+Promise.all([fooProm, fooProm]).then(result => {
+ result[0].foo();
+ result[1].foo();
+});
+
+Promise.all([fooProm, barProm, bazProm]).then(result => {
+ result[0].foo();
+ result[1].bar();
+ result[2].baz();
+});
+
+Promise.all([fooProm, barProm, fooProm]).then(result => {
+ result[0].foo();
+ result[1].bar();
+ result[2].foo();
+});
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
//TODO fix collection inference
barArrProm = fooProm.map<Foo, Bar>((item: Foo, index: number, arrayLength: number) => {
diff --git a/bluebird/bluebird.d.ts b/bluebird/bluebird.d.ts
index 350761fddc..878e1051e8 100644
--- a/bluebird/bluebird.d.ts
+++ b/bluebird/bluebird.d.ts
@@ -464,6 +464,11 @@ declare class Promise<R> implements Promise.Thenable<R>, Promise.Inspection<R> {
static all<R>(values: Promise.Thenable<R[]>): Promise<R[]>;
// array with promises of value
static all<R>(values: Promise.Thenable<R>[]): Promise<R[]>;
+ // array with promises of different types
+ static all<T1, T2>(values: [Promise.Thenable<T1>, Promise.Thenable<T2>]): Promise<[T1, T2]>;
+ static all<T1, T2, T3>(values: [Promise.Thenable<T1>, Promise.Thenable<T2>, Promise.Thenable<T3>]): Promise<[T1, T2, T3]>;
+ static all<T1, T2, T3, T4>(values: [Promise.Thenable<T1>, Promise.Thenable<T2>, Promise.Thenable<T3>, Promise.Thenable<T4>]): Promise<[T1, T2, T3, T4]>;
+ static all<T1, T2, T3, T4, T5>(values: [Promise.Thenable<T1>, Promise.Thenable<T2>, Promise.Thenable<T3>, Promise.Thenable<T4>, Promise.Thenable<T5>]): Promise<[T1, T2, T3, T4, T5]>;
// array with values
static all<R>(values: R[]): Promise<R[]>;
diff --git a/bootstrap-maxlength/bootstrap-maxlength-tests.ts b/bootstrap-maxlength/bootstrap-maxlength-tests.ts
new file mode 100644
index 0000000000..8a17cc7ff9
--- /dev/null
+++ b/bootstrap-maxlength/bootstrap-maxlength-tests.ts
@@ -0,0 +1,70 @@
+/// <reference path="bootstrap-maxlength.d.ts"/>
+/// <reference path="../jquery/jquery.d.ts"/>
+
+// Examples from the projects github page
+$('input[maxlength]').maxlength();
+
+$('input.className').maxlength({
+ threshold: 20
+});
+
+$('input.className').maxlength({
+ alwaysShow: true,
+ threshold: 10,
+ warningClass: "label label-info",
+ limitReachedClass: "label label-warning",
+ placement: 'top',
+ preText: 'used ',
+ separator: ' of ',
+ postText: ' chars.'
+});
+
+$('input.className').maxlength({
+ alwaysShow: true,
+ threshold: 10,
+ warningClass: "label label-info",
+ limitReachedClass: "label label-warning",
+ placement: 'top',
+ message: 'used %charsTyped% of %charsTotal% chars.'
+});
+// Testing the events
+$('input.className').on('maxlength.shown', function(){
+ console.log('shown');
+});
+$('input.className').on('maxlength.hidden', function(){
+ console.log('hidden');
+});
+$('textarea').on('autosize.resized', function () {
+ $(this).trigger('maxlength.reposition');
+});
+
+
+// using message string
+$('input.className').maxlength({
+ message: 'used %charsTyped% of %charsTotal% chars.'
+});
+// using message function
+$('input.className').maxlength({
+ threshold: 20,
+ message: function (currentText, maxLength) {
+ return '' + Math.ceil(currentText.length / 160) + ' SMS Message(s)';
+ }
+});
+
+
+// placement string
+$('input.className').maxlength({
+ placement: 'top-left'
+});
+// placement object
+$('input.className').maxlength({
+ placement: {
+ top: 10,
+ left: '30%'
+ }
+});
+// placement function
+$('input.className').maxlength({
+ placement: function (currentInput: JQuery, maxLengthIndicator: JQuery, currentInputPosition: BootstrapMaxlength.PositionParam) {
+ }
+});
diff --git a/bootstrap-maxlength/bootstrap-maxlength.d.ts b/bootstrap-maxlength/bootstrap-maxlength.d.ts
new file mode 100644
index 0000000000..4d36c70386
--- /dev/null
+++ b/bootstrap-maxlength/bootstrap-maxlength.d.ts
@@ -0,0 +1,158 @@
+// Type definitions for bootstrap-maxlength v1.7.0
+// Project: https://github.com/mimo84/bootstrap-maxlength
+// Definitions by: Dan Manastireanu <https://github.com/danmana>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts" />
+
+declare module BootstrapMaxlength {
+
+ /**
+ * Possible options for the position of the counter. (passed to $.fn.css)
+ */
+ interface PlacementOptions {
+ /**
+ * The top position of the counter (Number of pixels, or a px or percent string)
+ */
+ top?: Number | string,
+ /**
+ * The right position of the counter (Number of pixels, or a px or percent string)
+ */
+ right?: Number | string,
+ /**
+ * The bottom position of the counter (Number of pixels, or a px or percent string)
+ */
+ bottom?: Number | string,
+ /**
+ * The left position of the counter (Number of pixels, or a px or percent string)
+ */
+ left?: Number | string,
+ /**
+ * The positioning to use. For example 'relative', 'absolute'
+ */
+ position?: string
+ }
+
+ /**
+ * Representation of the current input position
+ */
+ interface PositionParam {
+ top: Number,
+ right: Number,
+ bottom: Number,
+ left: Number,
+ width: Number,
+ height: Number
+ }
+
+ export interface Options {
+ /**
+ * If true the threshold will be ignored and the remaining length indication will be always showing up while typing or on focus on the input
+ * @default false
+ */
+ alwaysShow?: Boolean,
+ /**
+ * This is a number indicating how many chars are left to start displaying the indications
+ * @default 10
+ */
+ threshold?: Number,
+ /**
+ * It's the class of the element with the indicator. By default is the bootstrap "label label-success" but can be changed to anything you'd like.
+ * @default 'label label-success'
+ */
+ warningClass?: string,
+ /**
+ * It's the class the element gets when the limit is reached. Default is "label label-important label-danger" (to support Bootstrap 2 and 3).
+ * @default 'label label-important label-danger'
+ */
+ limitReachedClass?: string,
+ /**
+ * Represents the separator between the number of typed chars and total number of available chars.
+ * @default ' / '
+ */
+ separator?: string,
+ /**
+ * Is a string of text that can be outputted in front of the indicator.
+ * @default ''
+ */
+ preText?: string,
+ /**
+ * Is a string outputted after the indicator.
+ * @default ''
+ */
+ postText?: string,
+ /**
+ * If false, will display just the number of typed characters, e.g. will not display the max length.
+ * @default true
+ */
+ showMaxLength?: Boolean,
+ /**
+ * If false, will display just the remaining length, e.g. will display remaining lenght instead of number of typed characters.
+ * @default true
+ */
+ showCharsTyped?: Boolean,
+ /**
+ * Is a string, define where to output the counter.
+ * Options: bottom, left, top, right, bottom-right, top-right, top-left, bottom-left and centered-right
+ * @default 'bottom'
+ */
+ placement?: string | PlacementOptions | ((currentInput: JQuery, maxLengthIndicator: JQuery, currentInputPosition: PositionParam) => void),
+ /**
+ * Appends the maxlength indicator badge to the parent of the input rather than to the body.
+ * @default false
+ */
+ appendToParent?: boolean,
+ /**
+ * An alternative way to provide the message text.
+ * String example: 'You have typed %charsTyped% chars, %charsRemaining% of %charsTotal% remaining'.
+ * %charsTyped%, %charsRemaining% and %charsTotal% will be replaced by the actual values. This overrides the options separator, preText, postText and showMaxLength.
+ * Alternatively you may supply a function that the current text and max length and returns the string to be displayed.
+ * Function example: function(currentText, maxLength) { return '' + Math.ceil(currentText.length / 160) + ' SMS Message(s)'; }
+ * @default null
+ */
+ message?: string | ((currentText : string, maxLength: Number) => string),
+ /**
+ * If true the input will count using utf8 bytesize/encoding. For example: the '' character is counted as two characters.
+ * @default false
+ */
+ utf8?: boolean,
+ /**
+ * Shows the badge as soon as it is added to the page, similar to alwaysShow
+ * @default false
+ */
+ showOnReady?: boolean,
+ /**
+ * Count linebreak as 2 characters to match IE/Chrome textarea validation. As well as DB storage.
+ * @default true
+ */
+ twoCharLinebreak?: boolean,
+ /**
+ * Allows a custom attribute to display indicator without triggering native maxlength behaviour.
+ * Ignored if value greater than a native maxlength attribute.
+ * 'overmax' class gets added when exceeded to allow user to implement form validation.
+ * @default null (use the maxlength attribute and browser functionality)
+ */
+ customMaxAttribute?: string,
+ /**
+ * Will allow the input to be over the customMaxLength. Useful in soft max situations.
+ * @default false
+ */
+ allowOverMax?: boolean,
+ /**
+ * If the browser doesn't support the maxlength attribute, attempt to type more than
+ * the indicated chars, will be prevented.
+ * @default false
+ */
+ validate?: boolean
+ }
+}
+
+
+interface JQuery {
+ /** Apply the maxlength plugin on the selected elemens */
+ maxlength(options?: BootstrapMaxlength.Options): JQuery;
+ on(events: 'maxlength.shown', handler: (eventObject: JQueryEventObject, ...args: any[]) => any): JQuery;
+ on(events: 'maxlength.hidden', handler: (eventObject: JQueryEventObject, ...args: any[]) => any): JQuery;
+ trigger(eventType: 'maxlength.reposition', extraParameters?: any[]|Object): JQuery;
+
+}
diff --git a/bootstrap-notify/bootstrap-notify-test.ts b/bootstrap-notify/bootstrap-notify-tests.ts
similarity index 98%
rename from bootstrap-notify/bootstrap-notify-test.ts
rename to bootstrap-notify/bootstrap-notify-tests.ts
index a71a835579..8461da8e48 100644
--- a/bootstrap-notify/bootstrap-notify-test.ts
+++ b/bootstrap-notify/bootstrap-notify-tests.ts
@@ -1,9 +1,9 @@
/// <reference path="bootstrap-notify.d.ts" />
/// <reference path="../jquery/jquery.d.ts" />
-
+
//Test for bootstrap-notify v3.1.3
//Copied example directly from Bootstrap-notify site
-
+
$.notify({
// options
icon: 'glyphicon glyphicon-warning-sign',
@@ -48,5 +48,5 @@ $.notify({
'<div class="progress-bar progress-bar-{0}" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%;"></div>' +
'</div>' +
'<a href="{3}" target="{4}" data-notify="url"></a>' +
- '</div>'
+ '</div>'
});
\ No newline at end of file
diff --git a/bootstrap-notify/bootstrap-notify.d.ts.tscparams b/bootstrap-notify/bootstrap-notify.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/bootstrap-notify/bootstrap-notify.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/bootstrap-switch/bootstrap-switch-tests.ts b/bootstrap-switch/bootstrap-switch-tests.ts
new file mode 100644
index 0000000000..542f71ebd4
--- /dev/null
+++ b/bootstrap-switch/bootstrap-switch-tests.ts
@@ -0,0 +1,25 @@
+/// <reference path="../jquery/jquery.d.ts"/>
+/// <reference path="bootstrap-switch.d.ts" />
+
+function test_cases() {
+ $('#switch').bootstrapSwitch();
+
+ $('#switch').bootstrapSwitch({
+ state: false
+ });
+
+ $('#switch').bootstrapSwitch({
+ state: false,
+ disabled: true
+ });
+
+ //var mySwitch = $('#switch').get(0);
+ //mySwitch.toggleAnimate();
+
+ $('#switch').bootstrapSwitch('state', true, true);
+
+
+ $('#switch').on('switchChange.bootstrapSwitch', (event) => {
+ console.log($(event.target).val());
+ });
+}
\ No newline at end of file
diff --git a/bootstrap-switch/bootstrap-switch.d.ts b/bootstrap-switch/bootstrap-switch.d.ts
new file mode 100644
index 0000000000..f562f9ef07
--- /dev/null
+++ b/bootstrap-switch/bootstrap-switch.d.ts
@@ -0,0 +1,102 @@
+// Type definitions for Bootstrap Switch
+// Project: http://www.bootstrap-switch.org/
+// Definitions by: John M. Baughman <https://github.com/johnmbaughman>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/**
+ * bootstrap-switch - v3.3.2 Copyright (c) 2012-2013 Mattia Larentis
+ * Available via the Apache license.
+ * see: http://www.bootstrap-switch.org/ or https://github.com/nostalgiaz/bootstrap-switch for details.
+ */
+
+/// <reference path="../jquery/jquery.d.ts"/>
+
+declare module BootstrapSwitch {
+ interface BootstrapSwitchChangeEventObject extends JQueryEventObject {
+ state: boolean
+ }
+
+ interface BootstrapSwitchEventObject extends JQueryEventObject { }
+
+ interface BootstrapSwitchOptions {
+ state?: boolean;
+ size?: string;
+ animate?: boolean;
+ disabled?: boolean;
+ readonly?: boolean;
+ indeterminate?: boolean;
+ invers?: boolean;
+ radioAllOff?: boolean;
+ onColor?: string;
+ offColor?: string;
+ onText?: string;
+ offText?: string;
+ labelText?: string;
+ handleWidth?: string;
+ labelWidth?: string;
+ baseClass?: string;
+ wrapperClass?: string;
+ onInit?: any;
+ onSwitchChange?: any;
+ }
+
+ interface Switch {
+ toggleAnimate(): JQuery;
+ toggleDisabled(): JQuery;
+ toggleReadonly(): JQuery;
+ toggleIndeterminate(): JQuery;
+ toggleInverse(): JQuery;
+ destroy(): JQuery;
+
+ state(): boolean;
+ state(value: any): JQuery;
+ state(value: any, skip: boolean): JQuery;
+ toggleState(skip?: boolean): JQuery;
+ radioAllOff(): boolean;
+ radioAllOff(state: boolean): JQuery;
+ size(): string;
+ size(size: string): JQuery;
+ animate(): boolean;
+ animate(state: boolean): JQuery;
+ disabled(): boolean;
+ disabled(state: boolean): JQuery;
+ toggleDisabled(): JQuery;
+ readonly(): boolean;
+ readonly(state: boolean): JQuery;
+ toggleReadOnly(): JQuery;
+ onColor(): string;
+ onColor(color: string): JQuery;
+ offColor(): string;
+ offColor(color: string): JQuery;
+ onText(): string;
+ onText(text: string): JQuery;
+ offText(): string;
+ offText(text: string): JQuery;
+ labelText(): string;
+ labelText(text: string): JQuery;
+ baseClass(): string;
+ baseClass(text: string): JQuery;
+ wrapperClass(): string;
+ wrapperClass(text: string): JQuery;
+ }
+}
+
+interface JQuery {
+ bootstrapSwitch(): JQuery;
+ bootstrapSwitch(options: BootstrapSwitch.BootstrapSwitchOptions): JQuery;
+ bootstrapSwitch(method: string): JQuery;
+ bootstrapSwitch(method: string, param: any): JQuery;
+ bootstrapSwitch(method: string, param1: any, param2: any): JQuery;
+
+ off(events: "init.bootstrapSwitch", selector?: string, handler?: (eventobject: BootstrapSwitch.BootstrapSwitchEventObject) => any): JQuery;
+ off(events: "init.bootstrapSwitch", handler?: (eventobject: BootstrapSwitch.BootstrapSwitchEventObject) => any): JQuery;
+
+ off(events: "switchChange.bootstrapSwitch", selector?: string, handler?: (eventobject: BootstrapSwitch.BootstrapSwitchChangeEventObject) => any): JQuery;
+ off(events: "switchChange.bootstrapSwitch", handler?: (eventobject: BootstrapSwitch.BootstrapSwitchChangeEventObject) => any): JQuery;
+
+ on(events: "init.bootstrapSwitch", selector?: string, handler?: (eventobject: BootstrapSwitch.BootstrapSwitchEventObject) => any): JQuery;
+ on(events: "init.bootstrapSwitch", handler?: (eventobject: BootstrapSwitch.BootstrapSwitchEventObject) => any): JQuery;
+
+ on(events: "switchChange.bootstrapSwitch", selector?: string, handler?: (eventobject: BootstrapSwitch.BootstrapSwitchChangeEventObject) => any): JQuery;
+ on(events: "switchChange.bootstrapSwitch", handler?: (eventobject: BootstrapSwitch.BootstrapSwitchChangeEventObject) => any): JQuery;
+}
\ No newline at end of file
diff --git a/bootstrap.datepicker/bootstrap.datepicker.d.ts b/bootstrap.datepicker/bootstrap.datepicker.d.ts
index da0ec1ab3d..23f51cb431 100644
--- a/bootstrap.datepicker/bootstrap.datepicker.d.ts
+++ b/bootstrap.datepicker/bootstrap.datepicker.d.ts
@@ -44,8 +44,8 @@ interface DatepickerEventObject extends JQueryEventObject {
interface JQuery {
datepicker(): JQuery;
- datepicker(methodName: string): JQuery;
- datepicker(methodName: string, params: any): JQuery;
+ datepicker(methodName: string): any;
+ datepicker(methodName: string, params: any): any;
datepicker(options: DatepickerOptions): JQuery;
off(events: "changeDate", selector?: string, handler?: (eventObject: DatepickerEventObject) => any): JQuery;
diff --git a/bootstrap/bootstrap-tests.ts b/bootstrap/bootstrap-tests.ts
index 71698101f7..fa4409fe30 100644
--- a/bootstrap/bootstrap-tests.ts
+++ b/bootstrap/bootstrap-tests.ts
@@ -17,6 +17,7 @@ $('#myModal').modal('toggle');
$('.dropdown-toggle').dropdown();
$('#navbar').scrollspy();
+$('body').scrollspy({ target: '#navbar-example' });
$('#element').tooltip('show');
@@ -42,4 +43,4 @@ $('.typeahead').typeahead({
highlighter: item => ""
});
-$('#navbar').affix();
\ No newline at end of file
+$('#navbar').affix();
diff --git a/bootstrap/bootstrap.d.ts b/bootstrap/bootstrap.d.ts
index 3545eb3109..491eb30451 100644
--- a/bootstrap/bootstrap.d.ts
+++ b/bootstrap/bootstrap.d.ts
@@ -22,6 +22,7 @@ interface ModalOptionsBackdropString {
interface ScrollSpyOptions {
offset?: number;
+ target?: string;
}
interface TooltipOptions {
diff --git a/bounce/bounce-tests.ts b/bounce/bounce-tests.ts
new file mode 100644
index 0000000000..bd90bfe4c1
--- /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 0000000000..9ff7c3a088
--- /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/bowser/bowser-tests.ts b/bowser/bowser-tests.ts
index 6006187655..2f7cb8904c 100644
--- a/bowser/bowser-tests.ts
+++ b/bowser/bowser-tests.ts
@@ -1,9 +1,9 @@
-/// <reference path="./bowser.d.ts" />
-
-import Bowser = require('bowser');
-
-Bowser.msedge === true;
-Bowser.test(['msie']) === true;
-Bowser.a === Bowser.c;
-Bowser.osversion > 10;
-Bowser.osversion === '10.1A';
+/// <reference path="./bowser.d.ts" />
+
+import Bowser = require('bowser');
+
+Bowser.msedge === true;
+Bowser.test(['msie']) === true;
+Bowser.a === Bowser.c;
+Bowser.osversion > 10;
+Bowser.osversion === '10.1A';
diff --git a/bowser/bowser.d.ts b/bowser/bowser.d.ts
index 834532d374..d3509a72b6 100644
--- a/bowser/bowser.d.ts
+++ b/bowser/bowser.d.ts
@@ -1,54 +1,54 @@
-// Type definitions for Bowser 1.x
-// Project: https://github.com/ded/bowser
-// Definitions by: Paulo Cesar <https://github.com/pocesar>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-declare module 'bowser' {
- var def: BowserModule.IBowser;
- export = def;
-}
-
-declare module BowserModule {
-
- export interface IBowserUA {
- msie: boolean;
- chrome: boolean;
- webkit: boolean;
- phantom: boolean;
- opera: boolean;
- safari: boolean;
- android: boolean;
- ios: boolean;
- webos: boolean;
- msedge: boolean;
- seamonkey: boolean;
- firefox: boolean;
- yandexbrowser: boolean;
- blackberry: boolean;
- tablet: boolean;
- mobile: boolean;
- silk: boolean;
- bada: boolean;
- tizen: boolean;
- windowsphone: boolean;
- firefoxos: boolean;
- gecko: boolean;
- sailfish: boolean;
- chromeBook: boolean;
- /** Grade A browser */
- a: boolean;
- /** Grade C browser */
- c: boolean;
- /** Grade X browser */
- x: boolean;
- name: string;
- version: string|number;
- osversion: string|number;
- }
-
- export interface IBowser extends IBowserUA {
- test(browserList: string[]): boolean;
- _detect(ua: string): IBowser;
- }
-
-}
+// Type definitions for Bowser 1.x
+// Project: https://github.com/ded/bowser
+// Definitions by: Paulo Cesar <https://github.com/pocesar>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module 'bowser' {
+ var def: BowserModule.IBowser;
+ export = def;
+}
+
+declare module BowserModule {
+
+ export interface IBowserUA {
+ msie: boolean;
+ chrome: boolean;
+ webkit: boolean;
+ phantom: boolean;
+ opera: boolean;
+ safari: boolean;
+ android: boolean;
+ ios: boolean;
+ webos: boolean;
+ msedge: boolean;
+ seamonkey: boolean;
+ firefox: boolean;
+ yandexbrowser: boolean;
+ blackberry: boolean;
+ tablet: boolean;
+ mobile: boolean;
+ silk: boolean;
+ bada: boolean;
+ tizen: boolean;
+ windowsphone: boolean;
+ firefoxos: boolean;
+ gecko: boolean;
+ sailfish: boolean;
+ chromeBook: boolean;
+ /** Grade A browser */
+ a: boolean;
+ /** Grade C browser */
+ c: boolean;
+ /** Grade X browser */
+ x: boolean;
+ name: string;
+ version: string|number;
+ osversion: string|number;
+ }
+
+ export interface IBowser extends IBowserUA {
+ test(browserList: string[]): boolean;
+ _detect(ua: string): IBowser;
+ }
+
+}
diff --git a/browser-sync/browser-sync-tests.ts b/browser-sync/browser-sync-tests.ts
index f5c02292c0..50042410f0 100644
--- a/browser-sync/browser-sync-tests.ts
+++ b/browser-sync/browser-sync-tests.ts
@@ -79,9 +79,12 @@ bs.init({
bs.reload();
-function browserSyncInit(): browserSync.BrowserSync {
+function browserSyncInit() {
var browser = browserSync.create();
browser.init();
+ console.log(browser.name);
+ console.log(browserSync.name);
return browser;
}
var browser = browserSyncInit();
+browser.exit();
diff --git a/browser-sync/browser-sync.d.ts b/browser-sync/browser-sync.d.ts
index 70e8dc1c15..03b751fabd 100644
--- a/browser-sync/browser-sync.d.ts
+++ b/browser-sync/browser-sync.d.ts
@@ -1,6 +1,6 @@
// Type definitions for browser-sync
// Project: http://www.browsersync.io/
-// Definitions by: Asana <https://asana.com>
+// Definitions by: Asana <https://asana.com>, Joe Skeen <http://github.com/joeskeen>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../chokidar/chokidar.d.ts"/>
@@ -12,55 +12,280 @@ declare module "browser-sync" {
import http = require("http");
interface Options {
+ /**
+ * Browsersync includes a user-interface that is accessed via a separate port. The UI allows to controls
+ * all devices, push sync updates and much more.
+ *
+ * port - Default: 3001
+ * weinre.port - Default: 8080
+ * Note: requires at least version 2.0.0
+ */
+ ui?: UIOptions;
+ /**
+ * Browsersync can watch your files as you work. Changes you make will either be injected into the page (CSS
+ * & images) or will cause all browsers to do a full-page refresh. See anymatch for more information on glob
+ * patterns.
+ * Default: false
+ */
files?: string | string[];
- watchOptions?: GazeOptions;
+ /**
+ * File watching options that get passed along to Chokidar. Check their docs for available options
+ * Default: undefined
+ * Note: requires at least version 2.6.0
+ */
+ watchOptions?: ChokidarOptions;
+ /**
+ * Use the built-in static server for basic HTML/JS/CSS websites.
+ * Default: false
+ */
server?: ServerOptions;
- proxy?: string | boolean;
+ /**
+ * Proxy an EXISTING vhost. Browsersync will wrap your vhost with a proxy URL to view your site.
+ * target - Default: undefined
+ * ws - Default: undefined
+ * middleware - Default: undefined
+ * reqHeaders - Default: undefined
+ * proxyRes - Default: undefined
+ */
+ proxy?: string | boolean | ProxyOptions;
+ /**
+ * Use a specific port (instead of the one auto-detected by Browsersync)
+ * Default: 3000
+ */
port?: number;
+ /**
+ * Add additional directories from which static files should be served.
+ * Should only be used in proxy or snippet mode.
+ * Default: []
+ * Note: requires at least version 2.8.0
+ */
+ serveStatic?: string[];
+ /**
+ * Enable https for localhost development.
+ * Note - this is not needed for proxy option as it will be inferred from your target url.
+ * Note: requires at least version 1.3.0
+ */
https?: boolean;
+ /**
+ * Clicks, Scrolls & Form inputs on any device will be mirrored to all others.
+ * clicks - Default: true
+ * scroll - Default: true
+ * forms - Default: true
+ */
ghostMode?: GhostOptions | boolean;
+ /**
+ * Can be either "info", "debug", "warn", or "silent"
+ * Default: info
+ */
logLevel?: string;
+ /**
+ * Change the console logging prefix. Useful if you're creating your own project based on Browsersync
+ * Default: BS
+ * Note: requires at least version 1.5.1
+ */
logPrefix?: string;
+ /**
+ * Whether or not to log connections
+ * Default: false
+ */
logConnections?: boolean;
+ /**
+ * Whether or not to log information about changed files
+ * Default: false
+ */
logFileChanges?: boolean;
+ /**
+ * Log the snippet to the console when you're in snippet mode (no proxy/server)
+ * Default: true
+ * Note: requires at least version 1.5.2
+ */
logSnippet?: boolean;
+ /**
+ * You can control how the snippet is injected onto each page via a custom regex + function.
+ * You can also provide patterns for certain urls that should be ignored from the snippet injection.
+ * Note: requires at least version 2.0.0
+ */
snippetOptions?: SnippetOptions;
+ /**
+ * Add additional HTML rewriting rules.
+ * Default: false
+ * Note: requires at least version 2.4.0
+ */
rewriteRules?: boolean | RewriteRules[];
+ /**
+ * Tunnel the Browsersync server through a random Public URL
+ * Default: null
+ */
tunnel?: string | boolean;
+ /**
+ * Some features of Browsersync (such as xip & tunnel) require an internet connection, but if you're
+ * working offline, you can reduce start-up time by setting this option to false
+ */
online?: boolean;
+ /**
+ * Default: true
+ * Decide which URL to open automatically when Browsersync starts. Defaults to "local" if none set.
+ * Can be true, local, external, ui, ui-external, tunnel or false
+ */
open?: string | boolean;
+ /**
+ * The browser(s) to open
+ * Default: default
+ */
browser?: string | string[];
+ /**
+ * Requires an internet connection - useful for services such as Typekit as it allows you to configure
+ * domains such as *.xip.io in your kit settings
+ * Default: false
+ */
xip?: boolean;
+ /**
+ * Reload each browser when Browsersync is restarted.
+ * Default: false
+ */
+ reloadOnRestart?: boolean;
+ /**
+ * The small pop-over notifications in the browser are not always needed/wanted.
+ * Default: true
+ */
notify?: boolean;
- scrollProportionally?: boolean;
+ /**
+ * scrollProportionally: false // Sync viewports to TOP position
+ * Default: true
+ */
+ scrollProportionally?: boolean
+ /**
+ * How often to send scroll events
+ * Default: 0
+ */
scrollThrottle?: number;
+ /**
+ * Decide which technique should be used to restore scroll position following a reload.
+ * Can be window.name or cookie
+ * Default: 'window.name'
+ */
+ scrollRestoreTechnique?: string;
+ /**
+ * Sync the scroll position of any element on the page. Add any amount of CSS selectors
+ * Default: []
+ * Note: requires at least version 2.9.0
+ */
+ scrollElements?: string[];
+ /**
+ * Default: []
+ * Note: requires at least version 2.9.0
+ * Sync the scroll position of any element on the page - where any scrolled element will cause
+ * all others to match scroll position. This is helpful when a breakpoint alters which element
+ * is actually scrolling
+ */
+ scrollElementMapping?: string[];
+ /**
+ * Time, in milliseconds, to wait before instructing the browser to reload/inject following a file change event
+ * Default: 0
+ */
reloadDelay?: number;
+ /**
+ * Restrict the frequency in which browser:reload events can be emitted to connected clients
+ * Default: 0
+ * Note: requires at least version 2.6.0
+ */
reloadDebounce?: number;
+ /**
+ * User provided plugins
+ * Default: []
+ * Note: requires at least version 2.6.0
+ */
plugins?: any[];
+ /**
+ * Whether to inject changes (rather than a page refresh)
+ * Default: true
+ */
injectChanges?: boolean;
+ /**
+ * The initial path to load
+ */
startPath?: string;
+ /**
+ * Whether to minify the client script
+ * Default: true
+ */
minify?: boolean;
+ /**
+ * Override host detection if you know the correct IP to use
+ */
host?: string;
+ /**
+ * Send file-change events to the browser
+ * Default: true
+ */
codeSync?: boolean;
+ /**
+ * Append timestamps to injected files
+ * Default: true
+ */
timestamps?: boolean;
+ /**
+ * Alter the script path for complete control over where the Browsersync Javascript is served
+ * from. Whatever you return from this function will be used as the script path.
+ * Note: requires at least version 1.5.0
+ */
scriptPath?: (path: string) => string;
+ /**
+ * Configure the Socket.IO path and namespace & domain to avoid collisions.
+ * path - Default: "/browser-sync/socket.io"
+ * clientPath - Default: "/browser-sync"
+ * namespace - Default: "/browser-sync"
+ * domain - Default: undefined
+ * port - Default: undefined
+ * clients.heartbeatTimeout - Default: 5000
+ * Note: requires at least version 1.6.2
+ */
socket?: SocketOptions;
}
- interface GazeOptions {
+ interface Hash<T> {
+ [path: string]: T;
+ }
+
+ interface ChokidarOptions {
interval?: number;
debounceDelay?: number;
mode?: string;
cwd?: string;
}
+
+ interface UIOptions {
+ /** set the default port */
+ port?: number;
+ /** set the default weinre port */
+ weinre?: {
+ port?: number;
+ };
+ }
interface ServerOptions {
+ /** set base directory */
baseDir?: string | string[];
+ /** enable directory listing */
directory?: boolean;
+ /** set index filename */
index?: string;
- routes?: {[path: string]: string};
+ /**
+ * key-value object hash, where the key is the url to match,
+ * and the value is the folder to serve (relative to your working directory)
+ * */
+ routes?: Hash<string>;
+ /** configure custom middleware */
middleware?: MiddlewareHandler[];
}
+
+ interface ProxyOptions {
+ target?: string;
+ middleware?: MiddlewareHandler;
+ ws: boolean;
+ reqHeaders: (config: any) => Hash<any>;
+ proxyRes: (res: http.ServerResponse, req: http.ServerRequest, next: Function) => any;
+ }
interface MiddlewareHandler {
(req: http.ServerRequest, res: http.ServerResponse, next: Function): any;
@@ -81,6 +306,9 @@ declare module "browser-sync" {
path?: string;
clientPath?: string;
namespace?: string;
+ domain?: string;
+ port?: number;
+ clients?: { heartbeatTimeout?: number; };
}
interface RewriteRules {
@@ -88,30 +316,99 @@ declare module "browser-sync" {
fn: (match: string) => string;
}
- module browserSync {
- interface BrowserSync {
- init(config?: Options, callback?: (err: Error, bs: Object) => any): void;
- reload(): void;
- reload(file: string): void;
- reload(files: string[]): void;
- reload(options: {stream: boolean}): NodeJS.ReadWriteStream;
- notify(message: string, timeout?: number): void;
- exit(): void;
- watch(patterns: string, opts?: chokidar.WatchOptions, fn?: (event: string, file: fs.Stats) => any): NodeJS.EventEmitter;
- pause(): void;
- resume(): void;
- emitter: NodeJS.EventEmitter;
- active: boolean;
- paused: boolean;
- }
+ interface BrowserSyncStatic extends BrowserSyncInstance {
+ /**
+ * Start the Browsersync service. This will launch a server, proxy or start the snippet mode
+ * depending on your use-case.
+ */
+ (config?: Options, callback?: (err: Error, bs: Object) => any): BrowserSyncInstance;
+ /**
+ * Create a Browsersync instance
+ * @param name an identifier that can used for retrieval later
+ */
+ create(name?: string): BrowserSyncInstance;
+ /**
+ * Get a single instance by name. This is useful if you have your build scripts in separate files
+ * @param name the identifier used for retrieval
+ */
+ get(name: string): BrowserSyncInstance;
}
- interface Exports extends browserSync.BrowserSync {
- create(): browserSync.BrowserSync;
- (config?: Options, callback?: (err: Error, bs: Object) => any): void;
+ interface BrowserSyncInstance {
+ /** the name of this instance of browser-sync */
+ name: string;
+ /**
+ * Start the Browsersync service. This will launch a server, proxy or start the snippet mode
+ * depending on your use-case.
+ */
+ init(config?: Options, callback?: (err: Error, bs: Object) => any): BrowserSyncInstance;
+ /**
+ * Reload the browser
+ * The reload method will inform all browsers about changed files and will either cause the browser
+ * to refresh, or inject the files where possible.
+ */
+ reload(): void;
+ /**
+ * Reload a single file
+ * The reload method will inform all browsers about changed files and will either cause the browser
+ * to refresh, or inject the files where possible.
+ */
+ reload(file: string): void;
+ /**
+ * Reload multiple files
+ * The reload method will inform all browsers about changed files and will either cause the browser
+ * to refresh, or inject the files where possible.
+ */
+ reload(files: string[]): void;
+ /**
+ * The reload method will inform all browsers about changed files and will either cause the browser
+ * to refresh, or inject the files where possible.
+ */
+ reload(options: {stream: boolean}): NodeJS.ReadWriteStream;
+ /**
+ * The stream method returns a transform stream and can act once or on many files.
+ * @param opts Configuration for the stream method
+ */
+ stream(opts: {once: boolean}): NodeJS.ReadWriteStream;
+ /**
+ * Helper method for browser notifications
+ * @param message Can be a simple message such as 'Connected' or HTML
+ * @param timeout How long the message will remain in the browser. @since 1.3.0
+ */
+ notify(message: string, timeout?: number): void;
+ /**
+ * This method will close any running server, stop file watching & exit the current process.
+ */
+ exit(): void;
+ /**
+ * Stand alone file-watcher. Use this along with Browsersync to create your own, minimal build system
+ */
+ watch(patterns: string, opts?: chokidar.WatchOptions, fn?: (event: string, file: fs.Stats) => any)
+ : NodeJS.EventEmitter;
+ /**
+ * Method to pause file change events
+ */
+ pause(): void;
+ /**
+ * Method to resume paused watchers
+ */
+ resume(): void;
+ /**
+ * The internal Event Emitter used by the running Browsersync instance (if there is one). You can use
+ * this to emit your own events, such as changed files, logging etc.
+ */
+ emitter: NodeJS.EventEmitter;
+ /**
+ * A simple true/false flag that you can use to determine if there's a currently-running Browsersync instance.
+ */
+ active: boolean;
+ /**
+ * A simple true/false flag to determine if the current instance is paused
+ */
+ paused: boolean;
}
- var browserSync: Exports;
+ const browserSync: BrowserSyncStatic;
export = browserSync;
}
diff --git a/bunyan-logentries/bunyan-logentries-test.ts b/bunyan-logentries/bunyan-logentries-tests.ts
similarity index 100%
rename from bunyan-logentries/bunyan-logentries-test.ts
rename to bunyan-logentries/bunyan-logentries-tests.ts
diff --git a/bunyan/bunyan-test.ts b/bunyan/bunyan-tests.ts
similarity index 100%
rename from bunyan/bunyan-test.ts
rename to bunyan/bunyan-tests.ts
diff --git a/c3/c3-tests.ts b/c3/c3-tests.ts
new file mode 100644
index 0000000000..5413db82d7
--- /dev/null
+++ b/c3/c3-tests.ts
@@ -0,0 +1,2536 @@
+/// <reference path="c3.d.ts" />
+
+//////////////////
+// Doc Examples
+//////////////////
+
+function chart_examples() {
+ var chart = c3.generate({
+ data: {},
+ bindto: "#myContainer",
+ size: {
+ width: 640,
+ height: 480
+ },
+ padding: {
+ top: 20, right: 20, bottom: 20, left: 20
+ },
+ color: {
+ pattern: ["#1f77b4", "#aec7e8"]
+ },
+ interaction: {
+ enabled: false
+ },
+ transition: {
+ duration: 500
+ },
+ oninit: function() { /* code*/ },
+ onrendered: function() { /* code*/ },
+ onmouseover: function() { /* code*/ },
+ onmouseout: function() { /* code*/ },
+ onresize: function() { /* code*/ },
+ onresized: function() { /* code*/ }
+ });
+
+ var chart2 = c3.generate({
+ bindto: document.getElementById("myContainer"),
+ data: {}
+ });
+
+ var chart3 = c3.generate({
+ bindto: d3.select("#myContainer"),
+ data: {}
+ });
+}
+
+function data_examples() {
+ var chart = c3.generate({
+ data: {
+ url: "/data/c3_test.csv",
+ json: [
+ { name: "www.site1.com", upload: 200, download: 200, total: 400 },
+ { name: "www.site2.com", upload: 100, download: 300, total: 400 },
+ { name: "www.site3.com", upload: 300, download: 200, total: 500 },
+ { name: "www.site4.com", upload: 400, download: 100, total: 500 },
+ ],
+ mimeType: "json",
+ rows: [
+ ["data1", "data2", "data3"],
+ [90, 120, 300],
+ [40, 160, 240],
+ [50, 200, 290],
+ [120, 160, 230],
+ [80, 130, 300],
+ [90, 220, 320],
+ ],
+ columns: [
+ ["data1", 30, 20, 50, 40, 60, 50],
+ ["data2", 200, 130, 90, 240, 130, 220],
+ ["data3", 300, 200, 160, 400, 250, 250]
+ ],
+ keys: {
+ x: "name", // it's possible to specify 'x' when category axis
+ value: ["upload", "download"],
+ },
+ x: "date",
+ xs: {
+ data1: "x1",
+ data2: "x2",
+ },
+ xFormat: "%Y-%m-%d %H:%M:%S",
+ names: {
+ data1: "Data Name 1",
+ data2: "Data Name 2",
+ },
+ classes: {
+ data1: "additional-data1-class",
+ data2: "additional-data2-class",
+ },
+ groups: [
+ ["data1", "data2"],
+ ["data3"],
+ ],
+ axes: {
+ data1: "y",
+ data2: "y2"
+ },
+ type: "bar",
+ types: {
+ data1: "bar",
+ data2: "spline"
+ },
+ labels: true,
+ order: "asc",
+ regions: {
+ data1: [{ "start": 1, "end": 2, "style": "dashed" }, { "start": 3 }],
+ },
+ color: function(color, d) { return "#ff0000"; },
+ colors: {
+ data1: "#ff0000"
+ /* ... */
+ },
+ hide: true,
+ empty: {
+ label: {
+ text: "No Data"
+ }
+ },
+ selection: {
+ enabled: true,
+ grouped: true,
+ multiple: true,
+ draggable: true,
+ isselectable: function(d) { return true; }
+ },
+ onclick: function(d, element) { /* code */ },
+ onmouseover: function(d) { /* code */ },
+ onmouseout: function(d) { /* code */ }
+ }
+ });
+
+ var chart2 = c3.generate({
+ data: {
+ labels: { format: function(v, id, i, j) { /* code */ } },
+ hide: ["data1"]
+ }
+ });
+}
+
+function axis_examples() {
+ var chart = c3.generate({
+ data: {},
+ axis: {
+ rotated: true,
+ x: {
+ show: true,
+ type: "timeseries",
+ localtime: true,
+ categories: ["Category 1", "Category 2"],
+ tick: {
+ centered: true,
+ format: function(x: Date) { return x.getFullYear(); },
+ culling: false,
+ count: 5,
+ fit: true,
+ values: [1, 2, 4, 8, 16, 32],
+ rotate: 60,
+ outer: false
+ },
+ max: 100,
+ min: -100,
+ padding: {
+ left: 0,
+ right: 0,
+ },
+ height: 20,
+ extent: [5, 10],
+ label: "Your X Axis"
+ },
+ y: {
+ show: false,
+ inner: true,
+ max: 1000,
+ min: 1000,
+ inverted: true,
+ center: 0,
+ label: "Your Y Axis",
+ tick: {
+ format: d3.format("$,"),
+ outer: false,
+ values: [100, 1000, 10000],
+ count: 5
+ },
+ padding: {
+ top: 100,
+ bottom: 100
+ },
+ default: [0, 1000]
+ },
+ y2: {
+ show: true,
+ inner: true,
+ max: 1000,
+ min: 1000,
+ inverted: true,
+ center: 0,
+ label: "Your Y2 Axis",
+ tick: {
+ format: d3.format("$,"),
+ outer: false,
+ values: [100, 1000, 10000],
+ count: 5
+ },
+ padding: {
+ top: 100,
+ bottom: 100
+ },
+ default: [0, 1000]
+ }
+ }
+ });
+
+ var chart2 = c3.generate({
+ data: {},
+ axis: {
+ x: {
+ tick: {
+ culling: {
+ max: 5
+ },
+ },
+ label: {
+ text: "Your X Axis",
+ position: "outer-center",
+ }
+ },
+ y: {
+ label: {
+ text: "Your X Axis",
+ position: "outer-middle",
+ },
+ tick: {
+ format: function(d) { return "$" + d; }
+ }
+ },
+ y2: {
+ label: {
+ text: "Your X Axis",
+ position: "outer-middle",
+ }
+ }
+ }
+ });
+}
+
+function grid_examples() {
+ var chart = c3.generate({
+ data: {},
+ grid: {
+ x: {
+ show: true,
+ lines: [
+ { value: 2, text: "Label on 2" },
+ { value: 5, text: "Label on 5", class: "label-5" },
+ { value: 6, text: "Label on 6", position: "start" }
+ ]
+ },
+ y: {
+ show: true,
+ lines: [
+ { value: 100, text: "Label on 100" },
+ { value: 200, text: "Label on 200", class: "label-200" },
+ { value: 300, text: "Label on 300", position: "middle" }
+ ]
+ }
+ }
+ });
+}
+
+function region_examples() {
+ var chart = c3.generate({
+ data: {},
+ regions: [
+ { axis: "x", start: 1, end: 4, class: "region-1-4" },
+ ]
+ });
+}
+
+function legend_examples() {
+ var chart = c3.generate({
+ data: {},
+ legend: {
+ show: true,
+ hide: true,
+ position: "bottom",
+ inset: {
+ anchor: "top-left",
+ x: 10,
+ y: 0,
+ step: undefined
+ },
+ item: {
+ onclick: function(id) { /* code */ },
+ onmoouseover: function(id) { /* code */ },
+ onmouseout: function(id) { /* code */ },
+ }
+ }
+ });
+
+ var chart2 = c3.generate({
+ data: {},
+ legend: {
+ hide: "data1",
+ inset: {
+ anchor: "top-right",
+ x: 20,
+ y: 10,
+ step: 2
+ }
+ }
+ });
+
+ var chart3 = c3.generate({
+ data: {},
+ legend: {
+ hide: ["data1", "data2"]
+ }
+ });
+}
+
+function subchart_examples() {
+ var chart = c3.generate({
+ data: {},
+ subchart: {
+ show: true,
+ size: {
+ height: 20
+ },
+ onbrush: function(domain) { /* code */ }
+ }
+ });
+}
+
+function zoom_examples() {
+ var chart = c3.generate({
+ data: {},
+ zoom: {
+ enabled: false,
+ rescale: true,
+ extent: [1, 100], // enable more zooming
+ onzoom: function(domain) { /* code */ },
+ onzoomstart: function(event) { /* code */ },
+ onzoomend: function(domain) { /* code */ }
+ }
+ });
+}
+
+function point_examples() {
+ var chart = c3.generate({
+ data: {},
+ point: {
+ show: false,
+ r: 5,
+ focus: {
+ expand: {
+ enabled: true,
+ r: 1
+ }
+ },
+ select: {
+ r: 3
+ }
+ }
+ });
+}
+
+function line_examples() {
+ var chart = c3.generate({
+ data: {},
+ line: {
+ connectNull: true,
+ step_type: "step-after"
+ }
+ });
+}
+
+function area_examples() {
+ var chart = c3.generate({
+ data: {},
+ area: {
+ zerobased: false
+ }
+ });
+}
+
+function bar_examples() {
+ var chart = c3.generate({
+ data: {},
+ bar: {
+ width: 10,
+ zerobased: false
+ }
+ });
+
+ var chart2 = c3.generate({
+ data: {},
+ bar: {
+ width: {
+ ratio: 0.2
+ },
+ zerobased: false
+ }
+ });
+}
+
+function pie_examples() {
+ var chart = c3.generate({
+ data: {},
+ pie: {
+ label: {
+ show: false,
+ format: function(value, ratio, id) {
+ return d3.format("$")(value);
+ },
+ threshold: 0.1
+ },
+ expand: false
+ }
+ });
+}
+
+function donut_examples() {
+ var chart = c3.generate({
+ data: {},
+ donut: {
+ label: {
+ show: false,
+ format: function(value, ratio, id) {
+ return d3.format("$")(value);
+ },
+ threshold: 0.05
+ },
+ expand: false,
+ width: 10,
+ title: "Title"
+ }
+ });
+}
+
+function gauge_examples() {
+ var chart = c3.generate({
+ data: {},
+ gauge: {
+ label: {
+ show: false,
+ format: function(value, ratio) {
+ return d3.format("$")(value);
+ }
+ },
+ expand: false,
+ min: -100,
+ max: 100,
+ units: " %",
+ width: 10,
+ }
+ });
+}
+
+//////////////////
+// Chart tests
+/////////////////
+
+function simple_multiple() {
+
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ]
+ }
+ });
+
+ chart.load({
+ columns: [
+ ["data1", 230, 190, 300, 500, 300, 400]
+ ]
+ });
+
+ chart.unload({
+ ids: "data1"
+ });
+};
+
+function timeseries() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ xFormat: "%Y%m%d", // 'xFormat' can be used as custom format of 'x'
+ columns: [
+ ["x", "20130101", "20130102", "20130103", "20130104", "20130105", "20130106"],
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 340, 200, 500, 250, 350]
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ tick: {
+ format: "%Y-%m-%d"
+ }
+ }
+ }
+ });
+}
+
+function chart_spline() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "spline"
+ }
+ });
+}
+
+function simple_xy() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", 30, 50, 100, 230, 300, 310],
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 300, 200, 300, 250, 450]
+ ]
+ }
+ });
+}
+
+function simple_xy_multiple() {
+ var chart = c3.generate({
+ data: {
+ xs: {
+ "data1": "x1",
+ "data2": "x2",
+ },
+ columns: [
+ ["x1", 10, 30, 45, 50, 70, 100],
+ ["x2", 30, 50, 75, 100, 120],
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 20, 180, 240, 100, 190]
+ ]
+ }
+ });
+}
+
+function simple_regions() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ regions: {
+ "data1": [{ "start": 1, "end": 2, "style": "dashed" }, { "start": 3 }], // currently 'dashed' style only
+ "data2": [{ "end": 3 }]
+ }
+ }
+ });
+}
+
+function chart_step() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 300, 350, 300, 0, 0, 100],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ types: {
+ data1: "step",
+ data2: "area-step"
+ }
+ }
+ });
+}
+
+function area_chart() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 300, 350, 300, 0, 0, 0],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ types: {
+ data1: "area",
+ data2: "area-spline"
+ }
+ }
+ });
+}
+
+function chart_area_stacked() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 300, 350, 300, 0, 0, 120],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ types: {
+ data1: "area-spline",
+ data2: "area-spline"
+ // 'line', 'spline', 'step', 'area', 'area-step' are also available to stack
+ },
+ groups: [["data1", "data2"]]
+ }
+ });
+}
+
+function chart_bar() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "bar"
+ },
+ bar: {
+ width: {
+ ratio: 0.5 // this makes bar width 50% of length between ticks
+ }
+ // or
+ //width: 100 // this makes bar width 100px
+ }
+ });
+}
+
+function chart_bar_stacked() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", -30, 200, 200, 400, -150, 250],
+ ["data2", 130, 100, -100, 200, -150, 50],
+ ["data3", -230, 200, 200, -300, 250, 250]
+ ],
+ type: "bar",
+ groups: [
+ ["data1", "data2"]
+ ]
+ },
+ grid: {
+ y: {
+ lines: [{ value: 0 }]
+ }
+ }
+ });
+}
+
+function chart_scatter() {
+ var chart = c3.generate({
+ data: {
+ xs: {
+ setosa: "setosa_x",
+ versicolor: "versicolor_x",
+ },
+ // iris data from R
+ columns: [
+ ["setosa_x", 3.5, 3.0, 3.2, 3.1, 3.6, 3.9, 3.4, 3.4, 2.9, 3.1, 3.7, 3.4, 3.0, 3.0, 4.0, 4.4, 3.9, 3.5, 3.8, 3.8, 3.4, 3.7, 3.6, 3.3, 3.4, 3.0, 3.4, 3.5, 3.4, 3.2, 3.1, 3.4, 4.1, 4.2, 3.1, 3.2, 3.5, 3.6, 3.0, 3.4, 3.5, 2.3, 3.2, 3.5, 3.8, 3.0, 3.8, 3.2, 3.7, 3.3],
+ ["versicolor_x", 3.2, 3.2, 3.1, 2.3, 2.8, 2.8, 3.3, 2.4, 2.9, 2.7, 2.0, 3.0, 2.2, 2.9, 2.9, 3.1, 3.0, 2.7, 2.2, 2.5, 3.2, 2.8, 2.5, 2.8, 2.9, 3.0, 2.8, 3.0, 2.9, 2.6, 2.4, 2.4, 2.7, 2.7, 3.0, 3.4, 3.1, 2.3, 3.0, 2.5, 2.6, 3.0, 2.6, 2.3, 2.7, 3.0, 2.9, 2.9, 2.5, 2.8],
+ ["setosa", 0.2, 0.2, 0.2, 0.2, 0.2, 0.4, 0.3, 0.2, 0.2, 0.1, 0.2, 0.2, 0.1, 0.1, 0.2, 0.4, 0.4, 0.3, 0.3, 0.3, 0.2, 0.4, 0.2, 0.5, 0.2, 0.2, 0.4, 0.2, 0.2, 0.2, 0.2, 0.4, 0.1, 0.2, 0.2, 0.2, 0.2, 0.1, 0.2, 0.2, 0.3, 0.3, 0.2, 0.6, 0.4, 0.3, 0.2, 0.2, 0.2, 0.2],
+ ["versicolor", 1.4, 1.5, 1.5, 1.3, 1.5, 1.3, 1.6, 1.0, 1.3, 1.4, 1.0, 1.5, 1.0, 1.4, 1.3, 1.4, 1.5, 1.0, 1.5, 1.1, 1.8, 1.3, 1.5, 1.2, 1.3, 1.4, 1.4, 1.7, 1.5, 1.0, 1.1, 1.0, 1.2, 1.6, 1.5, 1.6, 1.5, 1.3, 1.3, 1.3, 1.2, 1.4, 1.2, 1.0, 1.3, 1.2, 1.3, 1.3, 1.1, 1.3],
+ ],
+ type: "scatter"
+ },
+ axis: {
+ x: {
+ label: "Sepal.Width",
+ tick: {
+ fit: false
+ }
+ },
+ y: {
+ label: "Petal.Width"
+ }
+ }
+ });
+}
+
+function chart_pie() {
+ var chart = c3.generate({
+ data: {
+ // iris data from R
+ columns: [
+ ["data1", 30],
+ ["data2", 120],
+ ],
+ type: "pie",
+ onclick: function(d, i) { console.log("onclick", d, i); },
+ onmouseover: function(d, i) { console.log("onmouseover", d, i); },
+ onmouseout: function(d, i) { console.log("onmouseout", d, i); }
+ }
+ });
+}
+
+function chart_donut() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30],
+ ["data2", 120],
+ ],
+ type: "donut",
+ onclick: function(d, i) { console.log("onclick", d, i); },
+ onmouseover: function(d, i) { console.log("onmouseover", d, i); },
+ onmouseout: function(d, i) { console.log("onmouseout", d, i); }
+ },
+ donut: {
+ title: "Iris Petal Width"
+ }
+ });
+}
+
+function gauge_chart() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data", 91.4]
+ ],
+ type: "gauge",
+ onclick: function(d, i) { console.log("onclick", d, i); },
+ onmouseover: function(d, i) { console.log("onmouseover", d, i); },
+ onmouseout: function(d, i) { console.log("onmouseout", d, i); }
+ },
+ gauge: {
+ label: {
+ format: function(value, ratio) {
+ return value;
+ },
+ show: false // to turn off the min/max labels.
+ },
+ min: 0, // 0 is default, //can handle negative min e.g. vacuum / voltage / current flow / rate of change
+ max: 100, // 100 is default
+ units: " %",
+ width: 39 // for adjusting arc thickness
+ },
+ color: {
+ pattern: ["#FF0000", "#F97600", "#F6C600", "#60B044"], // the three color levels for the percentage values.
+ threshold: {
+ unit: "value", // percentage is default
+ max: 200, // 100 is default
+ values: [30, 60, 90, 100]
+ }
+ },
+ size: {
+ height: 180
+ }
+ });
+}
+
+function chart_combination() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 20, 50, 40, 60, 50],
+ ["data2", 200, 130, 90, 240, 130, 220],
+ ["data3", 300, 200, 160, 400, 250, 250],
+ ["data4", 200, 130, 90, 240, 130, 220],
+ ["data5", 130, 120, 150, 140, 160, 150],
+ ["data6", 90, 70, 20, 50, 60, 120],
+ ],
+ type: "bar",
+ types: {
+ data3: "spline",
+ data4: "line",
+ data6: "area",
+ },
+ groups: [
+ ["data1", "data2"]
+ ]
+ }
+ });
+}
+
+////////////////////
+// Axis tests
+////////////////////
+
+function categorized() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250, 50, 100, 250]
+ ]
+ },
+ axis: {
+ x: {
+ type: "category",
+ categories: ["cat1", "cat2", "cat3", "cat4", "cat5", "cat6", "cat7", "cat8", "cat9"]
+ }
+ }
+ });
+}
+
+function axes_rotated() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ types: {
+ data1: "bar",
+ }
+ },
+ axis: {
+ rotated: true
+ }
+ });
+}
+
+function axes_y2() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ axes: {
+ data1: "y",
+ data2: "y2"
+ }
+ },
+ axis: {
+ y2: {
+ show: true
+ }
+ }
+ });
+}
+
+function axes_x_tick_format() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "2010-01-01", "2011-01-01", "2012-01-01", "2013-01-01", "2014-01-01", "2015-01-01"],
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ tick: {
+ format: function(x: Date) { return x.getFullYear(); }
+ //format: '%Y' // format string is also available for timeseries data
+ }
+ }
+ }
+ });
+}
+
+function axes_x_tick_count() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "2013-01-01", "2013-01-02", "2013-01-03", "2013-01-04", "2013-01-05", "2013-01-06", "2013-01-07", "2013-01-08", "2013-01-09", "2013-01-10", "2013-01-11", "2013-01-12"],
+ ["sample", 30, 200, 100, 400, 150, 250, 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ tick: {
+ count: 4,
+ format: "%Y-%m-%d"
+ }
+ }
+ }
+ });
+}
+
+function axes_x_tick_values() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "2013-01-01", "2013-01-02", "2013-01-03", "2013-01-04", "2013-01-05", "2013-01-06", "2013-01-07", "2013-01-08", "2013-01-09", "2013-01-10", "2013-01-11", "2013-01-12"],
+ ["sample", 30, 200, 100, 400, 150, 250, 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ tick: {
+ // this also works for non timeseries data
+ values: ["2013-01-05", "2013-01-10"]
+ }
+ }
+ }
+ });
+}
+
+function axes_x_tick_culling() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250, 30, 200, 100, 400, 150, 250, 30, 200, 100, 400, 150, 250, 200, 100, 400, 150, 250]
+ ]
+ },
+ axis: {
+ x: {
+ type: "category",
+ tick: {
+ culling: {
+ max: 4 // the number of tick texts will be adjusted to less than this value
+ }
+ // for normal axis, default on
+ // for category axis, default off
+ }
+ }
+ }
+ });
+}
+
+function axes_x_tick_fit() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "2013-10-31", "2013-12-31", "2014-01-31", "2014-02-28"],
+ ["sample", 30, 100, 400, 150],
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ tick: {
+ fit: true,
+ format: "%e %b %y"
+ }
+ }
+ }
+ });
+}
+
+function axes_x_localtime() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ xFormat: "%Y",
+ columns: [
+ // ["x", "2012-12-31", "2013-01-01", "2013-01-02", "2013-01-03", "2013-01-04", "2013-01-05"],
+ ["x", "2010", "2011", "2012", "2013", "2014", "2015"],
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 340, 200, 500, 250, 350]
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ // if true, treat x value as localtime (Default)
+ // if false, convert to UTC internally
+ localtime: false,
+ tick: {
+ format: "%Y-%m-%d %H:%M:%S"
+ }
+ }
+ }
+ });
+}
+
+function axes_x_tick_rotate() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "www.somesitename1.com", "www.somesitename2.com", "www.somesitename3.com", "www.somesitename4.com", "www.somesitename5.com", "www.somesitename6.com", "www.somesitename7.com", "www.somesitename8.com", "www.somesitename9.com", "www.somesitename10.com", "www.somesitename11.com", "www.somesitename12.com"],
+ ["pv", 90, 100, 140, 200, 100, 400, 90, 100, 140, 200, 100, 400],
+ ],
+ type: "bar"
+ },
+ axis: {
+ x: {
+ type: "category",
+ tick: {
+ rotate: 75,
+ multiline: false
+ },
+ height: 130
+ }
+ }
+ });
+}
+
+function axes_y_tick_format() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 2500]
+ ]
+ },
+ axis: {
+ y: {
+ tick: {
+ format: d3.format("$,")
+ // format: function (d) { return "$" + d; }
+ }
+ }
+ }
+ });
+}
+
+function axes_y_padding() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ axes: {
+ data1: "y",
+ data2: "y2"
+ }
+ },
+ axis: {
+ y: {
+ padding: { top: 200, bottom: 0 }
+ },
+ y2: {
+ padding: { top: 100, bottom: 100 },
+ show: true
+ }
+ }
+ });
+}
+
+function axes_y_range() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ axis: {
+ y: {
+ max: 400,
+ min: -400,
+ // Range includes padding, set 0 if no padding needed
+ // padding: {top:0, bottom:0}
+ }
+ }
+ });
+}
+
+function axes_label() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250],
+ ["sample2", 130, 300, 200, 500, 250, 350]
+ ],
+ axes: {
+ sample2: "y2"
+ }
+ },
+ axis: {
+ x: {
+ label: "X Label"
+ },
+ y: {
+ label: "Y Label"
+ },
+ y2: {
+ show: true,
+ label: "Y2 Label"
+ }
+ }
+ });
+}
+
+function axes_label_position() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample1", 30, 200, 100, 400, 150, 250],
+ ["sample2", 430, 300, 500, 400, 650, 250]
+ ],
+ axes: {
+ sample1: "y",
+ sample2: "y2"
+ }
+ },
+ axis: {
+ x: {
+ label: {
+ text: "X Label",
+ position: "outer-center"
+ // inner-right : default
+ // inner-center
+ // inner-left
+ // outer-right
+ // outer-center
+ // outer-left
+ }
+ },
+ y: {
+ label: {
+ text: "Y Label",
+ position: "outer-middle"
+ // inner-top : default
+ // inner-middle
+ // inner-bottom
+ // outer-top
+ // outer-middle
+ // outer-bottom
+ }
+ },
+ y2: {
+ show: true,
+ label: {
+ text: "Y2 Label",
+ position: "outer-middle"
+ // inner-top : default
+ // inner-middle
+ // inner-bottom
+ // outer-top
+ // outer-middle
+ // outer-bottom
+ }
+ }
+ }
+ });
+}
+
+///////////////////
+// Data Tests
+///////////////////
+
+function data_columned() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 20, 50, 40, 60, 50],
+ ["data2", 200, 130, 90, 240, 130, 220],
+ ["data3", 300, 200, 160, 400, 250, 250]
+ ]
+ }
+ });
+}
+
+function data_rowed() {
+ var chart = c3.generate({
+ data: {
+ rows: [
+ ["data1", "data2", "data3"],
+ [90, 120, 300],
+ [40, 160, 240],
+ [50, 200, 290],
+ [120, 160, 230],
+ [80, 130, 300],
+ [90, 220, 320],
+ ]
+ }
+ });
+}
+
+function data_json() {
+ var chart = c3.generate({
+ data: {
+ json: {
+ data1: [30, 20, 50, 40, 60, 50],
+ data2: [200, 130, 90, 240, 130, 220],
+ data3: [300, 200, 160, 400, 250, 250]
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart = c3.generate({
+ data: {
+ json: [
+ { name: "www.site1.com", upload: 200, download: 200, total: 400 },
+ { name: "www.site2.com", upload: 100, download: 300, total: 400 },
+ { name: "www.site3.com", upload: 300, download: 200, total: 500 },
+ { name: "www.site4.com", upload: 400, download: 100, total: 500 },
+ ],
+ keys: {
+ // x: "name", // it's possible to specify 'x' when category axis
+ value: ["upload", "download"],
+ }
+ },
+ axis: {
+ x: {
+ // type: "category"
+ }
+ }
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.load({
+ json: [
+ { name: "www.site1.com", upload: 800, download: 500, total: 400 },
+ { name: "www.site2.com", upload: 600, download: 600, total: 400 },
+ { name: "www.site3.com", upload: 400, download: 800, total: 500 },
+ { name: "www.site4.com", upload: 400, download: 700, total: 500 },
+ ],
+ keys: {
+ value: ["upload", "download"],
+ }
+ });
+ }, 2000);
+}
+
+function data_url() {
+ var chart = c3.generate({
+ data: {
+ url: "/data/c3_test.csv"
+ }
+ });
+
+ setTimeout(function() {
+ c3.generate({
+ data: {
+ url: "/data/c3_test.json",
+ mimeType: "json"
+ }
+ });
+ }, 1000);
+}
+
+function data_stringx() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "www.site1.com", "www.site2.com", "www.site3.com", "www.site4.com"],
+ ["download", 30, 200, 100, 400],
+ ["loading", 90, 100, 140, 200],
+ ],
+ groups: [
+ ["download", "loading"]
+ ],
+ type: "bar"
+ },
+ axis: {
+ x: {
+ type: "category" // this needed to load string x value
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["x", "www.siteA.com", "www.siteB.com", "www.siteC.com", "www.siteD.com"],
+ ["download", 130, 200, 150, 350],
+ ["loading", 190, 180, 190, 140],
+ ],
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["x", "www.siteE.com", "www.siteF.com", "www.siteG.com"],
+ ["download", 30, 300, 200],
+ ["loading", 90, 130, 240],
+ ],
+ });
+ }, 2000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["x", "www.site1.com", "www.site2.com", "www.site3.com", "www.site4.com"],
+ ["download", 130, 300, 200, 470],
+ ["loading", 190, 130, 240, 340],
+ ],
+ });
+ }, 3000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["download", 30, 30, 20, 170],
+ ["loading", 90, 30, 40, 40],
+ ],
+ });
+ }, 4000);
+
+ setTimeout(function() {
+ chart.load({
+ url: "/data/c3_string_x.csv"
+ });
+ }, 5000);
+}
+
+function data_load() {
+ var chart = c3.generate({
+ data: {
+ url: "/data/c3_test.csv",
+ type: "line"
+ }
+ });
+
+ setTimeout(function() {
+ chart.load({
+ url: "/data/c3_test2.csv"
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data1", 130, 120, 150, 140, 160, 150],
+ ["data4", 30, 20, 50, 40, 60, 50],
+ ],
+ unload: ["data2", "data3"],
+ });
+ }, 2000);
+
+ setTimeout(function() {
+ chart.load({
+ rows: [
+ ["data2", "data3"],
+ [120, 300],
+ [160, 240],
+ [200, 290],
+ [160, 230],
+ [130, 300],
+ [220, 320],
+ ],
+ unload: "data4",
+ });
+ }, 3000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data4", 30, 20, 50, 40, 60, 50, 100, 200]
+ ],
+ type: "bar"
+ });
+ }, 4000);
+
+ setTimeout(function() {
+ chart.unload({
+ ids: "data4"
+ });
+ }, 5000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data2", null, 30, 20, 50, 40, 60, 50]
+ ]
+ });
+ }, 6000);
+
+ setTimeout(function() {
+ chart.unload();
+ }, 7000);
+
+ setTimeout(function() {
+ chart.load({
+ rows: [
+ ["data4", "data2", "data3"],
+ [90, 120, 300],
+ [40, 160, 240],
+ [50, 200, 290],
+ [120, 160, 230],
+ [80, 130, 300],
+ [90, 220, 320],
+ ],
+ type: "bar"
+ });
+ }, 8000);
+
+ setTimeout(function() {
+ chart.load({
+ rows: [
+ ["data5", "data6"],
+ [190, 420],
+ [140, 460],
+ [150, 500],
+ [220, 460],
+ [180, 430],
+ [190, 520],
+ ],
+ type: "line"
+ });
+ }, 9000);
+
+ setTimeout(function() {
+ chart.unload({
+ ids: ["data2", "data3"]
+ });
+ }, 10000);
+}
+
+function data_name() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ names: {
+ data1: "Name 1",
+ data2: "Name 2"
+ }
+ }
+ });
+}
+
+function data_color() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 20, 50, 40, 60, 50],
+ ["data2", 200, 130, 90, 240, 130, 220],
+ ["data3", 300, 200, 160, 400, 250, 250]
+ ],
+ type: "bar",
+ colors: {
+ data1: "#ff0000",
+ data2: "#00ff00",
+ data3: "#0000ff"
+ },
+ color: function(color, d) {
+ // d will be 'id' when called for legends
+ return d.id && d.id === "data3" ? d3.rgb(color).darker(d.value / 150) : color;
+ }
+ }
+ });
+}
+
+function data_order() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 130, 200, 320, 400, 530, 750],
+ ["data2", -130, 10, 130, 200, 150, 250],
+ ["data3", -130, -50, -10, -200, -250, -150]
+ ],
+ type: "bar",
+ groups: [
+ ["data1", "data2", "data3"]
+ ],
+ order: "desc" // stack order by sum of values descendantly. this is default.
+ // order: "asc" // stack order by sum of values ascendantly.
+ // order: null // stack order by data definition.
+ },
+ grid: {
+ y: {
+ lines: [{ value: 0 }]
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data4", 1200, 1300, 1450, 1600, 1520, 1820],
+ ]
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data5", 200, 300, 450, 600, 520, 820],
+ ]
+ });
+ }, 2000);
+
+ setTimeout(function() {
+ chart.groups([["data1", "data2", "data3", "data4", "data5"]]);
+ }, 3000);
+}
+
+function data_label() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, -200, -100, 400, 150, 250],
+ ["data2", -50, 150, -150, 150, -50, -150],
+ ["data3", -100, 100, -40, 100, -150, -50]
+ ],
+ groups: [
+ ["data1", "data2"]
+ ],
+ type: "bar",
+ labels: true
+ },
+ grid: {
+ y: {
+ lines: [{ value: 0 }]
+ }
+ }
+ });
+}
+
+function data_label_format() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, -200, -100, 400, 150, 250],
+ ["data2", -50, 150, -150, 150, -50, -150],
+ ["data3", -100, 100, -40, 100, -150, -50]
+ ],
+ groups: [
+ ["data1", "data2"]
+ ],
+ type: "bar",
+ labels: {
+ // format: function (v, id, i, j) { return "Default Format"; },
+ format: {
+ data1: d3.format("$"),
+ // data1: function (v, id, i, j) { return "Format for data1"; },
+ }
+ }
+ },
+ grid: {
+ y: {
+ lines: [{ value: 0 }]
+ }
+ }
+ });
+}
+
+///////////////////
+// Grid Tests
+///////////////////
+
+function options_gridline() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250, 120, 200]
+ ]
+ },
+ grid: {
+ x: {
+ show: true
+ },
+ y: {
+ show: true
+ }
+ }
+ });
+}
+
+function grid_x_lines() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ grid: {
+ x: {
+ lines: [
+ { value: 1, text: "Lable 1" },
+ { value: 3, text: "Lable 3", position: "middle" },
+ { value: 4.5, text: "Lable 4.5", position: "start" }
+ ]
+ }
+ }
+ });
+}
+
+function grid_y_lines() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250],
+ ["sample2", 1300, 1200, 1100, 1400, 1500, 1250],
+ ],
+ axes: {
+ sample2: "y2"
+ }
+ },
+ axis: {
+ y2: {
+ show: true
+ }
+ },
+ grid: {
+ y: {
+ lines: [
+ { value: 50, text: "Lable 50 for y" },
+ { value: 1300, text: "Lable 1300 for y2", axis: "y2", position: "start" },
+ { value: 350, text: "Lable 350 for y", position: "middle" }
+ ]
+ }
+ }
+ });
+}
+
+///////////////////
+// Region Tests
+///////////////////
+
+function region() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250, 400],
+ ["data2", 830, 1200, 1100, 1400, 1150, 1250, 1500],
+ ],
+ axes: {
+ data2: "y2"
+ }
+ },
+ axis: {
+ y2: {
+ show: true
+ }
+ },
+ regions: [
+ { axis: "x", end: 1, class: "regionX" },
+ { axis: "x", start: 2, end: 4, class: "regionX" },
+ { axis: "x", start: 5, class: "regionX" },
+ { axis: "y", end: 50, class: "regionY" },
+ { axis: "y", start: 80, end: 140, class: "regionY" },
+ { axis: "y", start: 400, class: "regionY" },
+ { axis: "y2", end: 900, class: "regionY2" },
+ { axis: "y2", start: 1150, end: 1250, class: "regionY2" },
+ { axis: "y2", start: 1300, class: "regionY2" },
+ ]
+ });
+}
+
+function region_timeseries() {
+ var chart = c3.generate({
+ data: {
+ x: "date",
+ columns: [
+ ["date", "2014-01-01", "2014-01-10", "2014-01-20", "2014-01-30", "2014-02-01"],
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries"
+ }
+ },
+ regions: [
+ { start: "2014-01-05", end: "2014-01-10" },
+ { start: new Date("2014/01/15"), end: new Date("20 Jan 2014") },
+ { start: 1390575600000, end: 1391007600000 } // start => 2014-01-25 00:00:00, end => 2014-01-30 00:00:00
+ ]
+ });
+}
+
+/////////////////////
+// Interaction Tests
+/////////////////////
+
+function options_subchart() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ subchart: {
+ show: true
+ }
+ });
+}
+
+function interaction_zoom() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250, 150, 200, 170, 240, 350, 150, 100, 400, 150, 250, 150, 200, 170, 240, 100, 150, 250, 150, 200, 170, 240, 30, 200, 100, 400, 150, 250, 150, 200, 170, 240, 350, 150, 100, 400, 350, 220, 250, 300, 270, 140, 150, 90, 150, 50, 120, 70, 40]
+ ]
+ },
+ zoom: {
+ enabled: true
+ }
+ });
+}
+
+/////////////////////
+// Legend Tests
+/////////////////////
+
+function options_legend() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ legend: {
+ show: false
+ }
+ });
+}
+
+function legend_position() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ]
+ },
+ legend: {
+ position: "right"
+ }
+ });
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data3", 130, 150, 200, 300, 200, 100]
+ ]
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.unload({
+ ids: "data1"
+ });
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("pie");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("line");
+ }, 4000);
+}
+
+function legend_custom() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 100],
+ ["data2", 300],
+ ["data3", 200]
+ ],
+ type: "pie"
+ },
+ legend: {
+ show: false
+ }
+ });
+
+ function toggle(id: any) {
+ chart.toggle(id);
+ }
+
+ d3.select(".container").insert("div", ".chart").attr("class", "legend").selectAll("span")
+ .data(["data1", "data2", "data3"])
+ .enter().append("span")
+ .attr("data-id", function(id) { return id; })
+ .html(function(id) { return id; })
+ .each(function(id) {
+ d3.select(this).style("background-color", chart.color(id));
+ })
+ .on("mouseover", function(id) {
+ chart.focus(id);
+ })
+ .on("mouseout", function(id) {
+ chart.revert();
+ })
+ .on("click", function(id) {
+ chart.toggle(id);
+ });
+
+}
+
+/////////////////////
+// Tooltip Tests
+/////////////////////
+
+function tooltip_show() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ]
+ },
+ tooltip: {
+ show: false
+ }
+ });
+}
+
+function tooltip_grouped() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25],
+ ["data3", 500, 320, 210, 340, 215, 125]
+ ]
+ },
+ tooltip: {
+ grouped: false // Default true
+ }
+ });
+}
+
+function tooltip_format() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30000, 20000, 10000, 40000, 15000, 250000],
+ ["data2", 100, 200, 100, 40, 150, 250]
+ ],
+ axes: {
+ data2: "y2"
+ }
+ },
+ axis: {
+ y: {
+ tick: {
+ format: d3.format("s")
+ }
+ },
+ y2: {
+ show: true,
+ tick: {
+ format: d3.format("$")
+ }
+ }
+ },
+ tooltip: {
+ format: {
+ title: function(d: any) { return "Data " + d; },
+ value: function(value: any, ratio: any, id: any) {
+ var format = id === "data1" ? d3.format(",") : d3.format("$");
+ return format(value);
+ }
+ // value: d3.format(",") // apply this format to both y and y2
+ }
+ }
+ });
+}
+
+////////////////////////
+// Chart options Tests
+////////////////////////
+
+function options_size() {
+ var chart = c3.generate({
+ size: {
+ height: 240,
+ width: 480
+ },
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ }
+ });
+}
+
+function options_padding() {
+ var chart = c3.generate({
+ padding: {
+ top: 40,
+ right: 100,
+ bottom: 40,
+ left: 100,
+ },
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250000000000]
+ ]
+ }
+ });
+}
+
+function options_color() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25],
+ ["data3", 130, 220, 140, 200, 250, 450],
+ ["data4", 250, 320, 210, 240, 215, 225],
+ ["data5", 430, 500, 400, 280, 290, 350],
+ ["data6", 100, 120, 310, 340, 415, 225]
+ ]
+ },
+ color: {
+ pattern: ["#1f77b4", "#aec7e8", "#ff7f0e", "#ffbb78", "#2ca02c", "#98df8a", "#d62728", "#ff9896", "#9467bd", "#c5b0d5", "#8c564b", "#c49c94", "#e377c2", "#f7b6d2", "#7f7f7f", "#c7c7c7", "#bcbd22", "#dbdb8d", "#17becf", "#9edae5"]
+ }
+ });
+}
+
+function transition_duration() {
+ var chart = c3.generate({
+ data: {
+ url: "/data/c3_test.csv"
+ },
+ transition: {
+ duration: 100
+ }
+ });
+
+ setTimeout(function() {
+ chart.load({
+ url: "/data/c3_test2.csv"
+ });
+ }, 500);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data1", 30, 20, 50, 40, 60, 50],
+ ["data2", 200, 130, 90, 240, 130, 220],
+ ["data3", 300, 200, 160, 400, 250, 250]
+ ]
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.load({
+ rows: [
+ ["data1", "data2", "data3"],
+ [90, 120, 300],
+ [40, 160, 240],
+ [50, 200, 290],
+ [120, 160, 230],
+ [80, 130, 300],
+ [90, 220, 320],
+ ]
+ });
+ }, 1500);
+
+ setTimeout(function() {
+ chart.load({
+ columns: [
+ ["data1", null, 30, 20, 50, 40, 60, 50, 100, 200]
+ ]
+ });
+ }, 2000);
+}
+
+/////////////////////////////
+// Line Chart options Tests
+/////////////////////////////
+
+function point_show() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ]
+ },
+ point: {
+ show: false
+ }
+ });
+}
+
+////////////////////////////
+// Pie Chart options Tests
+////////////////////////////
+
+function pie_label_format() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30],
+ ["data2", 50]
+ ],
+ type: "pie"
+ },
+ pie: {
+ label: {
+ format: function(value: any, ratio: any, id: any) {
+ return d3.format("$")(value);
+ }
+ }
+ }
+ });
+}
+
+/////////////////////
+// API Tests
+/////////////////////
+
+function api_flow() {
+ var chart = c3.generate({
+ data: {
+ x: "x",
+ columns: [
+ ["x", "2012-12-29", "2012-12-30", "2012-12-31"],
+ ["data1", 230, 300, 330],
+ ["data2", 190, 230, 200],
+ ["data3", 90, 130, 180],
+ ]
+ },
+ axis: {
+ x: {
+ type: "timeseries",
+ tick: {
+ format: "%m/%d",
+ }
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.flow({
+ columns: [
+ ["x", "2013-01-11", "2013-01-21"],
+ ["data1", 500, 200],
+ ["data2", 100, 300],
+ ["data3", 200, 120],
+ ],
+ duration: 1500,
+ done: function() {
+ chart.flow({
+ columns: [
+ ["x", "2013-02-11", "2013-02-12", "2013-02-13", "2013-02-14"],
+ ["data1", 200, 300, 100, 250],
+ ["data2", 100, 90, 40, 120],
+ ["data3", 100, 100, 300, 500]
+ ],
+ length: 0,
+ duration: 1500,
+ done: function() {
+ chart.flow({
+ columns: [
+ ["x", "2013-03-01", "2013-03-02"],
+ ["data1", 200, 300],
+ ["data2", 150, 250],
+ ["data3", 100, 100]
+ ],
+ length: 2,
+ duration: 1500,
+ done: function() {
+ chart.flow({
+ columns: [
+ ["x", "2013-03-21", "2013-04-01"],
+ ["data1", 500, 200],
+ ["data2", 100, 150],
+ ["data3", 200, 400]
+ ],
+ to: "2013-03-01",
+ duration: 1500,
+ });
+ }
+ });
+ }
+ });
+ },
+ });
+ }, 1000);
+}
+
+function api_data_name() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ names: {
+ data1: "Name 1",
+ data2: "Name 2"
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.data.names({ data1: "New name for data1", data2: "New name for data2" });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.data.names({ data1: "New name for data1 again" });
+ }, 2000);
+}
+
+function api_data_color() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 20, 50, 40, 60, 50],
+ ["data2", 200, 130, 90, 240, 130, 220],
+ ["data3", 300, 200, 160, 400, 250, 250]
+ ],
+ type: "bar",
+ colors: {
+ data1: "#ff0000",
+ data2: "#00ff00",
+ data3: "#0000ff"
+ },
+ labels: true
+ }
+ });
+
+ setTimeout(function() {
+ chart.data.colors({
+ data1: d3.rgb("#ff0000").darker(1),
+ data2: d3.rgb("#00ff00").darker(1),
+ data3: d3.rgb("#0000ff").darker(1),
+ });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.data.colors({
+ data1: d3.rgb("#ff0000").darker(2),
+ data2: d3.rgb("#00ff00").darker(2),
+ data3: d3.rgb("#0000ff").darker(2),
+ });
+ }, 2000);
+}
+
+function api_axis_label() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ axes: {
+ data1: "y",
+ data2: "y2"
+ }
+ },
+ axis: {
+ y: {
+ label: "Y Axis Label"
+ },
+ y2: {
+ show: true,
+ label: "Y2 Axis Label"
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.axis.labels({ y2: "New Y2 Axis Label" });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.axis.labels({ y: "New Y Axis Label", y2: "New Y2 Axis Label Again" });
+ }, 2000);
+}
+
+function api_axis_range() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ],
+ axes: {
+ data1: "y",
+ data2: "y2"
+ }
+ },
+ axis: {
+ y2: {
+ show: true,
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.axis.max(500);
+ }, 1000);
+
+ setTimeout(function() {
+ chart.axis.min(-500);
+ }, 2000);
+
+ setTimeout(function() {
+ chart.axis.max({ y: 600, y2: 100 });
+ }, 3000);
+
+ setTimeout(function() {
+ chart.axis.min({ y: -600, y2: -100 });
+ }, 4000);
+
+ setTimeout(function() {
+ chart.axis.range({ max: 1000, min: -1000 });
+ }, 5000);
+
+ setTimeout(function() {
+ chart.axis.range({ max: { y: 600, y2: 100 }, min: { y: -100, y2: 0 } });
+ }, 6000);
+
+ setTimeout(function() {
+ chart.axis.max({ x: 10 });
+ }, 7000);
+
+ setTimeout(function() {
+ chart.axis.min({ x: -10 });
+ }, 8000);
+
+ setTimeout(function() {
+ chart.axis.range({ max: { x: 5 }, min: { x: 0 } });
+ }, 9000);
+}
+
+function api_resize() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 50, 20, 10, 40, 15, 25]
+ ]
+ }
+ });
+
+ setTimeout(function() {
+ chart.resize({ height: 100, width: 300 });
+ }, 1000);
+
+ setTimeout(function() {
+ chart.resize({ height: 200 });
+ }, 2000);
+
+ setTimeout(function() {
+ chart.resize();
+ }, 3000);
+}
+
+function api_grid_x() {
+ var chart = c3.generate({
+ bindto: "#chart",
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ }
+ });
+
+ setTimeout(function() {
+ chart.xgrids([{ value: 1, text: "Label 1" }, { value: 4, text: "Label 4" }]);
+ }, 1000);
+
+ setTimeout(function() {
+ chart.xgrids([{ value: 2, text: "Label 2" }]);
+ }, 2000);
+
+ setTimeout(function() {
+ chart.xgrids.add([{ value: 3, text: "Label 3", class: "hoge" }]);
+ }, 3000);
+
+ setTimeout(function() {
+ chart.xgrids.remove({ value: 2 });
+ }, 4000);
+
+ setTimeout(function() {
+ chart.xgrids.remove({ class: "hoge" });
+ }, 5000);
+
+ setTimeout(function() {
+ chart.xgrids([{ value: 1, text: "Label 1" }, { value: 4, text: "Label 4" }]);
+ }, 6000);
+
+ setTimeout(function() {
+ chart.xgrids.remove();
+ }, 7000);
+}
+
+/////////////////////
+// Transform Tests
+/////////////////////
+
+function transform_line() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "bar"
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("line", "data1");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("line", "data2");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("bar");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("line");
+ }, 4000);
+}
+
+function transform_spline() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "bar"
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("spline", "data1");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("spline", "data2");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("bar");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("spline");
+ }, 4000);
+}
+
+function transform_bar() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "line"
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("bar", "data1");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("bar", "data2");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("line");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("bar");
+ }, 4000);
+}
+
+function transform_area() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "bar"
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("area", "data1");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("area", "data2");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("bar");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("area");
+ }, 4000);
+}
+
+function transform_areaspline() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ],
+ type: "bar"
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("area-spline", "data1");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("area-spline", "data2");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("bar");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("area-spline");
+ }, 4000);
+}
+
+function transform_scatter() {
+ var chart = c3.generate({
+ data: {
+ xs: {
+ setosa: "setosa_x",
+ versicolor: "versicolor_x",
+ },
+ // iris data from R
+ columns: [
+ ["setosa_x", 3.5, 3.0, 3.2, 3.1, 3.6, 3.9, 3.4, 3.4, 2.9, 3.1, 3.7, 3.4, 3.0, 3.0, 4.0, 4.4, 3.9, 3.5, 3.8, 3.8, 3.4, 3.7, 3.6, 3.3, 3.4, 3.0, 3.4, 3.5, 3.4, 3.2, 3.1, 3.4, 4.1, 4.2, 3.1, 3.2, 3.5, 3.6, 3.0, 3.4, 3.5, 2.3, 3.2, 3.5, 3.8, 3.0, 3.8, 3.2, 3.7, 3.3],
+ ["versicolor_x", 3.2, 3.2, 3.1, 2.3, 2.8, 2.8, 3.3, 2.4, 2.9, 2.7, 2.0, 3.0, 2.2, 2.9, 2.9, 3.1, 3.0, 2.7, 2.2, 2.5, 3.2, 2.8, 2.5, 2.8, 2.9, 3.0, 2.8, 3.0, 2.9, 2.6, 2.4, 2.4, 2.7, 2.7, 3.0, 3.4, 3.1, 2.3, 3.0, 2.5, 2.6, 3.0, 2.6, 2.3, 2.7, 3.0, 2.9, 2.9, 2.5, 2.8],
+ ["setosa", 0.2, 0.2, 0.2, 0.2, 0.2, 0.4, 0.3, 0.2, 0.2, 0.1, 0.2, 0.2, 0.1, 0.1, 0.2, 0.4, 0.4, 0.3, 0.3, 0.3, 0.2, 0.4, 0.2, 0.5, 0.2, 0.2, 0.4, 0.2, 0.2, 0.2, 0.2, 0.4, 0.1, 0.2, 0.2, 0.2, 0.2, 0.1, 0.2, 0.2, 0.3, 0.3, 0.2, 0.6, 0.4, 0.3, 0.2, 0.2, 0.2, 0.2],
+ ["versicolor", 1.4, 1.5, 1.5, 1.3, 1.5, 1.3, 1.6, 1.0, 1.3, 1.4, 1.0, 1.5, 1.0, 1.4, 1.3, 1.4, 1.5, 1.0, 1.5, 1.1, 1.8, 1.3, 1.5, 1.2, 1.3, 1.4, 1.4, 1.7, 1.5, 1.0, 1.1, 1.0, 1.2, 1.6, 1.5, 1.6, 1.5, 1.3, 1.3, 1.3, 1.2, 1.4, 1.2, 1.0, 1.3, 1.2, 1.3, 1.3, 1.1, 1.3],
+ ],
+ type: "pie"
+ },
+ axis: {
+ x: {
+ label: "Sepal.Width",
+ tick: {
+ fit: false
+ }
+ },
+ y: {
+ label: "Petal.Width"
+ }
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("scatter");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("pie");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("scatter");
+ }, 3000);
+}
+
+function transform_pie() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ]
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("pie");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("line");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("pie");
+ }, 3000);
+}
+
+function transform_donut() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 30, 200, 100, 400, 150, 250],
+ ["data2", 130, 100, 140, 200, 150, 50]
+ ]
+ }
+ });
+
+ setTimeout(function() {
+ chart.transform("donut");
+ }, 1000);
+
+ setTimeout(function() {
+ chart.transform("line");
+ }, 2000);
+
+ setTimeout(function() {
+ chart.transform("pie");
+ }, 3000);
+
+ setTimeout(function() {
+ chart.transform("donut");
+ }, 4000);
+}
+
+/////////////////////
+// Style Tests
+/////////////////////
+
+function style_region() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["sample", 30, 200, 100, 400, 150, 250]
+ ]
+ },
+ regions: [
+ { start: 0, end: 1 },
+ { start: 2, end: 4, class: "foo" }
+ ]
+ });
+}
+
+function style_grid() {
+ var chart = c3.generate({
+ data: {
+ columns: [
+ ["data1", 100, 200, 1000, 900, 500]
+ ]
+ },
+ grid: {
+ x: {
+ lines: [{ value: 2 }, { value: 4, class: "grid4", text: "LABEL 4" }]
+ },
+ y: {
+ lines: [{ value: 500 }, { value: 800, class: "grid800", text: "LABEL 800" }]
+ }
+ }
+ });
+}
diff --git a/c3/c3.d.ts b/c3/c3.d.ts
new file mode 100644
index 0000000000..3c7469b0aa
--- /dev/null
+++ b/c3/c3.d.ts
@@ -0,0 +1,1069 @@
+// Type definitions for C3js
+// Project: http://c3js.org/
+// Definitions by: Marc Climent <https://github.com/mcliment>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../d3/d3.d.ts"/>
+
+declare module c3 {
+
+ type PrimitiveArray = Array<string | boolean | number>;
+ type FormatFunction = (v: any, id: string, i: number, j: number) => void;
+
+ interface TargetIds {
+ ids: ArrayOrString;
+ }
+
+ type ArrayOrString = Array<string> | string;
+
+ interface ChartConfiguration {
+ /**
+ * The CSS selector or the element which the chart will be set to. D3 selection object can be specified. If other chart is set already, it will be replaced with the new one (only one chart can be set in one element).
+ * If this option is not specified, the chart will be generated but not be set. Instead, we can access the element by chart.element and set it by ourselves.
+ * Note: When chart is not binded, c3 starts observing if chart.element is binded by MutationObserver. In this case, polyfill is required in IE9 and IE10 becuase they do not support MutationObserver. On the other hand, if chart always will be binded, polyfill will not be required because MutationObserver will never be called.
+ */
+ bindto?: string | HTMLElement | d3.Selection<any>;
+ size?: {
+ /**
+ * The desired width of the chart element.
+ * If this option is not specified, the width of the chart will be calculated by the size of the parent element it's appended to.
+ * Note: This option should be specified if possible because it can improve its performance because some size calculations will be skipped by an explicit value.
+ */
+ width?: number;
+ /**
+ * The desired height of the chart element.
+ * If this option is not specified, the height of the chart will be calculated by the size of the parent element it's appended to.
+ */
+ height?: number;
+ };
+
+ padding?: {
+ /**
+ * The padding on the top of the chart.
+ */
+ top?: number;
+ /**
+ * The padding on the right of the chart.
+ */
+ right?: number;
+ /**
+ * The padding on the bottom of the chart.
+ */
+ bottom?: number;
+ /**
+ * The padding on the left of the chart.
+ */
+ left?: number;
+ };
+
+ color?: {
+ /**
+ * Set custom color pattern.
+ */
+ pattern?: Array<string>;
+ threshold?: any; // Undocumented
+ };
+
+ interaction?: {
+ /**
+ * Indicate if the chart should have interactions.
+ * If false is set, all of interactions (showing/hiding tooltip, selection, mouse events, etc) will be disabled.
+ */
+ enabled?: boolean;
+ };
+
+ transition?: {
+ /**
+ * Set duration of transition (in milliseconds) for chart animation.
+ * Note: If 0 or null set, transition will be skipped. So, this makes initial rendering faster especially in case you have a lot of data.
+ */
+ duration?: number;
+ };
+
+ /**
+ * Set a callback to execute when the chart is initialized.
+ */
+ oninit?: () => void;
+
+ /**
+ * Set a callback which is executed when the chart is rendered. Basically, this callback will be called in each time when the chart is redrawed.
+ */
+ onrendered?: () => void;
+
+ /**
+ * Set a callback to execute when mouse enters the chart.
+ */
+ onmouseover?: () => void;
+
+ /**
+ * Set a callback to execute when mouse leaves the chart.
+ */
+ onmouseout?: () => void;
+
+ /**
+ * Set a callback to execute when user resizes the screen.
+ */
+ onresize?: () => void;
+
+ /**
+ * Set a callback to execute when screen resize finished.
+ */
+ onresized?: () => void;
+
+ data: Data;
+
+ axis?: Axis;
+
+ grid?: Grid;
+
+ /**
+ * Show rectangles inside the chart.
+ * This option accepts array including object that has axis, start, end and class. The keys start, end and class are optional.
+ * axis must be x, y or y2. start and end should be the value where regions start and end. If not specified, the edge values will be used. If timeseries x axis, date string, Date object and unixtime integer can be used. If class is set, the region element will have it as class.
+ */
+ regions?: Array<RegionOptions>;
+
+ legend?: LegendOptions;
+
+ tooltip?: TooltipOptions;
+
+ subchart?: SubchartOptions;
+
+ zoom?: ZoomOptions;
+
+ point?: PointOptions;
+
+ line?: {
+ /**
+ * Set if null data point will be connected or not.
+ * If true set, the region of null data will be connected without any data point. If false set, the region of null data will not be connected and get empty.
+ */
+ connectNull?: boolean;
+ /**
+ * Change step type for step chart. 'step', 'step-before' and 'step-after' can be used.
+ */
+ step_type?: string;
+ };
+
+ area?: {
+ /**
+ * Set if min or max value will be 0 on area chart.
+ */
+ zerobased?: boolean;
+ };
+
+ bar?: {
+ /**
+ * Change the width of bar chart. If ratio is specified, change the width of bar chart by ratio.
+ */
+ width?: number | { ratio: number };
+ /**
+ * Set if min or max value will be 0 on bar chart.
+ */
+ zerobased?: boolean;
+ };
+
+ pie?: {
+ label?: {
+ /**
+ * Show or hide label on each pie piece.
+ */
+ show?: boolean;
+ /**
+ * Set formatter for the label on each pie piece.
+ */
+ format?: (value: number, ratio: number, id: string) => string;
+ /**
+ * Set threshold to show/hide labels.
+ */
+ threshold?: number
+ },
+ /**
+ * Enable or disable expanding pie pieces.
+ */
+ expand?: boolean;
+ };
+
+ donut?: {
+ label?: {
+ /**
+ * Show or hide label on each donut piece.
+ */
+ show?: boolean;
+ /**
+ * Set formatter for the label on each donut piece.
+ */
+ format?: (value: number, ratio: number, id: string) => string;
+ /**
+ * Set threshold to show/hide labels.
+ */
+ threshold?: number
+ },
+ /**
+ * Enable or disable expanding pie pieces.
+ */
+ expand?: boolean;
+ /**
+ * Set width of donut chart.
+ */
+ width?: number;
+ /**
+ * Set title of donut chart.
+ */
+ title?: string;
+ };
+
+ gauge?: {
+ label?: {
+ /**
+ * Show or hide label on gauge.
+ */
+ show?: boolean;
+ /**
+ * Set formatter for the label on gauge.
+ */
+ format?: (value: any, ratio: number) => string;
+ },
+ /**
+ * Enable or disable expanding gauge.
+ */
+ expand?: boolean;
+ /**
+ * Set min value of the gauge.
+ */
+ min?: number;
+ /**
+ * Set max value of the gauge.
+ */
+ max?: number;
+ /**
+ * Set units of the gauge.
+ */
+ units?: string;
+ /**
+ * Set width of gauge chart.
+ */
+ width?: number;
+ };
+ }
+
+ interface Data {
+ /**
+ * Load a CSV or JSON file from a URL. Note that this will not work if loading via the "file://" protocol as most browsers with block XMLHTTPRequests.
+ */
+ url?: string;
+ /**
+ * Parse a JSON object for data.
+ */
+ json?: Object;
+ /**
+ * Load data from a multidimensional array, with the first element containing the data names, the following containing related data in that order.
+ */
+ rows?: Array<PrimitiveArray>;
+ /*
+ * Load data from a multidimensional array, with each element containing an array consisting of a datum name and associated data values.
+ */
+ columns?: Array<PrimitiveArray>;
+ /**
+ * Used if loading JSON via data.url
+ */
+ mimeType?: string;
+ /**
+ * Choose which JSON object keys correspond to desired data.
+ */
+ keys?: { x?: string; value: Array<string>; };
+ /**
+ * Specify the key of x values in the data.
+ * We can show the data with non-index x values by this option. This option is required when the type of x axis is timeseries. If this option is set on category axis, the values of the data on the key will be used for category names.
+ */
+ x?: string;
+ /**
+ * Specify the keys of the x values for each data.
+ * This option can be used if we want to show the data that has different x values.
+ */
+ xs?: { [key: string]: string };
+ /**
+ * Set a format to parse string specifed as x.
+ * Default is %Y-%m-%d
+ */
+ xFormat?: string;
+ //xLocaltime?: any;
+ //xSort?: any;
+ /**
+ * Set custom data name.
+ */
+ names?: { [key: string]: string };
+ /**
+ * Set custom data class.
+ * If this option is specified, the element g for the data has an additional class that has the prefix c3-target- (e.g. c3-target-additional-data1-class).
+ */
+ classes?: { [key: string]: string };
+ /**
+ * Set groups for the data for stacking.
+ */
+ groups?: Array<Array<string>>;
+ /**
+ * Set y axis the data related to. y and y2 can be used.
+ */
+ axes?: { [key: string]: string };
+ /**
+ * Set chart type at once.
+ * If this option is specified, the type will be applied to every data. This setting can be overwritten by data.types.
+ * Available Values: line, spline, step, area, area-spline, area-step, bar, scatter, pie, donut, gauge
+ */
+ type?: string;
+ /**
+ * Set chart type for each data.
+ * This setting overwrites data.type setting.
+ */
+ types?: { [key: string]: string };
+ /**
+ * Show labels on each data points or set formatter function for data labels.
+ * The formatter function receives 4 arguments such as v, id, i, j and it must return a string that will be shown as the label. The arguments are:
+ * - v is the value of the data point where the label is shown.
+ * - id is the id of the data where the label is shown.
+ * - i is the index of the data point where the label is shown.
+ * - j is the sub index of the data point where the label is shown.
+ * Formatter function can be defined for each data by specifying as an object and D3 formatter function can be set (e.g. d3.format('$'))
+ */
+ labels?: boolean |
+ { format: FormatFunction } |
+ { format: { [key: string]: FormatFunction } };
+ /**
+ * Define the order of the data.
+ * This option changes the order of stacking the data and pieces of pie/donut. If null specified, it will be the order the data loaded. If function specified, it will be used to sort the data and it will recieve the data as argument.
+ * Available Values: desc, asc, function (data1, data2) { ... }, null
+ */
+ order?: string | ((...data: string[]) => void);
+ /**
+ * Define regions for each data.
+ * The values must be an array for each data and it should include an object that has start, end, style. If start is not set, the start will be the first data point. If end is not set, the end will be the last data point.
+ * Currently this option supports only line chart and dashed style. If this option specified, the line will be dashed only in the regions.
+ */
+ regions?: { [key: string]: any };
+ /**
+ * Set color converter function.
+ * This option should a function and the specified function receives color (e.g. '#ff0000') and d that has data parameters like id, value, index, etc. And it must return a string that represents color (e.g. '#00ff00').
+ */
+ color?: (color: string, d: any) => string | d3.Rgb;
+ /**
+ * Set color for each data.
+ */
+ colors?: { [key: string]: string | d3.Rgb };
+ /**
+ * Hide each data when the chart appears.
+ * If true specified, all of data will be hidden. If multiple ids specified as an array, those will be hidden.
+ */
+ hide?: boolean | Array<string>;
+ /**
+ * Set text displayed when empty data.
+ */
+ empty?: { label: { text: string } };
+
+ selection?: {
+ enabled?: boolean;
+ grouped?: boolean;
+ multiple?: boolean;
+ draggable?: boolean;
+ isselectable?: (d?: any) => boolean;
+ };
+ /**
+ * Set a callback for click event on each data point.
+ * This callback will be called when each data point clicked and will receive d and element as the arguments.
+ * - d is the data clicked and element is the element clicked. In this callback, this will be the Chart object.
+ */
+ onclick?: (d: any, element: any) => void;
+ /**
+ * Set a callback for mouseover event on each data point.
+ * This callback will be called when mouse cursor moves onto each data point and will receive d as the argument.
+ * - d is the data where mouse cursor moves onto. In this callback, this will be the Chart object.
+ */
+ onmouseover?: (d: any, element?: any) => void;
+ /**
+ * Set a callback for mouseout event on each data point.
+ * This callback will be called when mouse cursor moves out each data point and will receive d as the argument.
+ * - d is the data where mouse cursor moves out. In this callback, this will be the Chart object.
+ */
+ onmouseout?: (d: any, element?: any) => void;
+ // onselected?: any;
+ // onunselected?: any;
+ // ondragstart?: any;
+ // ondragend?: any;
+ }
+
+ interface Axis {
+ /**
+ * Switch x and y axis position.
+ */
+ rotated?: boolean;
+ x?: XAxisConfiguration;
+ y?: YAxisConfiguration;
+ y2?: YAxisConfiguration;
+ }
+
+ interface XAxisConfiguration {
+ /**
+ * Show or hide x axis.
+ */
+ show?: boolean;
+ /**
+ * Set type of x axis (timeseries, category, indexed)
+ */
+ type?: string;
+ /**
+ * Set how to treat the timezone of x values.
+ * If true, treat x value as localtime. If false, convert to UTC internally.
+ */
+ localtime?: boolean;
+ /**
+ * Set category names on category axis.
+ * This must be an array that includes category names in string. If category names are included in the date by data.x option, this is not required.
+ */
+ categories?: Array<string>;
+
+ tick?: XTickConfiguration;
+ /**
+ * Set max value of x axis range.
+ */
+ max?: number;
+ /**
+ * Set min value of x axis range.
+ */
+ min?: number;
+ /**
+ * Set padding for x axis.
+ * If this option is set, the range of x axis will increase/decrease according to the values. If no padding is needed in the ragen of x axis, 0 should be set. On category axis, this option will be ignored.
+ */
+ padding?: {
+ left?: number;
+ right?: number;
+ };
+ /**
+ * Set height of x axis.
+ * The height of x axis can be set manually by this option. If you need more space for x axis, please use this option for that. The unit is pixel.
+ */
+ height?: number;
+ /**
+ * Set default extent for subchart and zoom. This can be an array or function that returns an array.
+ */
+ extent?: Array<number> | (() => Array<number>);
+ /**
+ * Set label on x axis.
+ * You can set x axis label and change its position by this option. string and object can be passed and we can change the poisiton by passing object that has position key. Available position differs according to the axis direction (vertical or horizontal). If string set, the position will be the default.
+ * Valid horizontal positions: inner-right (Default), inner-center, inner-left, outer-right, outer-center, outer-left
+ * Valid vertical positions: inner-top, inner-middle, inner-bottom, outer-top, outer-middle, outer-bottom
+ */
+ label?: string | { text: string; position: string };
+ }
+
+ interface YAxisConfiguration {
+ /**
+ * Show or hide y axis.
+ */
+ show?: boolean;
+ /**
+ * Show y axis inside of the chart.
+ */
+ inner?: boolean;
+ /**
+ * Set max value of y axis.
+ */
+ max?: number;
+ /**
+ * Set min value of y axis.
+ */
+ min?: number;
+ /**
+ * Change the direction of y axis.
+ * If true set, the direction will be from the top to the bottom.
+ */
+ inverted?: boolean;
+ /**
+ * Set center value of y axis.
+ */
+ center?: number;
+ /**
+ * Set label on y axis. This option works in the same way as axis.x.label.
+ * Valid horizontal positions: inner-right (Default), inner-center, inner-left, outer-right, outer-center, outer-left
+ * Valid vertical positions: inner-top, inner-middle, inner-bottom, outer-top, outer-middle, outer-bottom
+ */
+ label?: string | { text: string; position: string };
+ tick?: YTickConfiguration;
+ /**
+ * Set padding for y axis.
+ * You can set padding for y axis to create more space on the edge of the axis. This option accepts object and it can include top and bottom. top, bottom will be treated as pixels.
+ */
+ padding?: {
+ top?: number;
+ bottom?: number;
+ };
+ /**
+ * Set default range of y axis. This option set the default value for y axis when there is no data on init.
+ */
+ default?: Array<number>;
+
+ }
+
+ interface XTickConfiguration {
+ /**
+ * Centerise ticks on category axis
+ */
+ centered?: boolean;
+ /**
+ * A function to format tick value. Format string is also available for timeseries data.
+ */
+ format?: string | ((x: number | Date) => string | number);
+ /**
+ * Setting for culling ticks.
+ * If true is set, the ticks will be culled, then only limitted tick text will be shown. This option does not hide the tick lines. If false is set, all of ticks will be shown.
+ */
+ culling?: boolean | CullingConfiguration;
+ /**
+ * The number of x axis ticks to show.
+ * This option hides tick lines together with tick text. If this option is used on timeseries axis, the ticks position will be determined precisely and not nicely positioned (e.g. it will have rough second value).
+ */
+ count?: number;
+ /**
+ * Fit x axis ticks.
+ * If true set, the ticks will be positioned nicely. If false set, the ticks will be positioned according to x value of the data points.
+ */
+ fit?: boolean;
+ /**
+ * Set the x values of ticks manually.
+ * If this option is provided, the position of the ticks will be determined based on those values. This option works with timeseries data and the x values will be parsed accoding to the type of the value and data.xFormat option.
+ */
+ values?: Array<number> | Array<string>;
+ /**
+ * Rotate x axis tick text. If you set negative value, it will rotate to opposite direction.
+ */
+ rotate?: number;
+ /**
+ * Show x axis outer tick.
+ */
+ outer?: boolean;
+ multiline?: boolean; // Undocumented
+ }
+
+ interface YTickConfiguration {
+ /**
+ * Set formatter for y axis tick text.
+ * This option accepts d3.format object as well as a function you define.
+ */
+ format?: (x: number) => string;
+ /**
+ * Show or hide outer tick.
+ */
+ outer?: boolean;
+ /**
+ * Set the y values of ticks manually.
+ */
+ values?: Array<number>;
+ /**
+ * The number of y axis ticks to show.
+ * The position of the ticks will be calculated precisely, so the values on the ticks will not be rounded nicely. In the case, axis.y.tick.format or axis.y.tick.values will be helpful.
+ */
+ count?: number;
+ }
+
+ interface CullingConfiguration {
+ /**
+ * The number of tick texts will be adjusted to less than this value.
+ */
+ max: number;
+ }
+
+ interface Grid {
+ x?: {
+ /**
+ * Show grids along x axis.
+ */
+ show?: boolean;
+ /**
+ * Show additional grid lines along x axis.
+ * This option accepts array including object that has value, text, position and class. text, position and class are optional. For position, start, middle and end (default) are available.
+ * If x axis is category axis, value can be category name. If x axis is timeseries axis, value can be date string, Date object and unixtime integer.
+ */
+ lines?: Array<LineOptions>;
+ };
+ y?: {
+ /**
+ * Show grids along y axis.
+ */
+ show?: boolean;
+ /**
+ * Show additional grid lines along y axis.
+ * This option accepts array including object that has value, text, position and class.
+ */
+ lines?: Array<LineOptions>;
+ };
+ }
+
+ interface LineOptions {
+ value: number;
+ text?: string;
+ axis?: string;
+ position?: string;
+ class?: string;
+ }
+
+ interface RegionOptions {
+ axis?: string;
+ start?: string | number | Date;
+ end?: string | number | Date;
+ class?: string;
+ }
+
+ interface LegendOptions {
+ /**
+ * Show or hide legend.
+ */
+ show?: boolean;
+ /**
+ * Hide legend
+ * If true given, all legend will be hidden. If string or array given, only the legend that has the id will be hidden.
+ */
+ hide?: boolean | ArrayOrString;
+ /**
+ * Change the position of legend.
+ * Currently bottom, right and inset are supported.
+ */
+ position?: string;
+ /**
+ * Change inset legend attributes.
+ * This option accepts object that has the keys anchor, x, y and step.
+ * anchor decides the position of the legend. These anchors are available: top-left, top-right, bottom-left, bottom-right
+ * x and y set the position of the legend based on the anchor.
+ * step defines the max step the lagend has (e.g. If 2 set and legend has 3 legend item, the legend 2 columns).
+ */
+ inset?: {
+ anchor?: string;
+ x?: number;
+ y?: number;
+ step?: number;
+ };
+
+ item?: {
+ /**
+ * Set click event handler to the legend item.
+ */
+ onclick?: (id: any) => void;
+ /**
+ * Set mouseover event handler to the legend item.
+ */
+ onmoouseover?: (id: any) => void;
+ /**
+ * Set mouseout event handler to the legend item.
+ */
+ onmouseout?: (id: any) => void;
+ };
+ }
+
+ interface TooltipOptions {
+ /**
+ * Show or hide tooltip.
+ */
+ show?: boolean;
+ /**
+ * Set if tooltip is grouped or not for the data points.
+ */
+ grouped?: boolean;
+ format?: {
+ /**
+ * Set format for the title of tooltip. Specified function receives x of the data point to show.
+ */
+ title?: (x: any) => string;
+ /**
+ * Set format for the name of each data in tooltip. Specified function receives name, ratio, id and index of the data point to show. ratio will be undefined if the chart is not donut/pie/gauge.
+ */
+ name?: (name: string, ratio: number, id: string, index: number) => string;
+ /**
+ * Set format for the value of each data in tooltip.
+ * Specified function receives name, ratio, id and index of the data point to show. ratio will be undefined if the chart is not donut/pie/gauge.
+ * If undefined returned, the row of that value will be skipped.
+ */
+ value?: (name: string, ratio: number, id: string, index: number) => string;
+ };
+ /**
+ * Set custom position for the tooltip. This option can be used to modify the tooltip position by returning object that has top and left.
+ */
+ position?: (data: any, width: number, height: number, element: any) => { top: number, left: number };
+ /**
+ * Set custom HTML for the tooltip.
+ * Specified function receives data, defaultTitleFormat, defaultValueFormat and color of the data point to show. If tooltip.grouped is true, data includes multiple data points.
+ */
+ contents?: (data: any, defaultTitleFormat: string, defaultValueFormat: string, color: any) => string;
+ }
+
+ interface SubchartOptions {
+ /**
+ * Show sub chart on the bottom of the chart.
+ */
+ show?: boolean;
+ size?: {
+ /**
+ * Change the height of the subchart.
+ */
+ height: number;
+ };
+ /**
+ * Set callback for brush event.
+ * Specified function receives the current zoomed x domain.
+ */
+ onbrush?: (domain: any) => void;
+ }
+
+ interface ZoomOptions {
+ /**
+ * Enable zooming.
+ */
+ enabled?: boolean;
+ /**
+ * Enable to rescale after zooming. If true set, y domain will be updated according to the zoomed region.
+ */
+ rescale?: boolean;
+ /**
+ * Change zoom extent.
+ */
+ extent?: [number, number];
+ /**
+ * Set callback that is called when the chart is zooming. Specified function receives the zoomed domain.
+ */
+ onzoom?: (domain: any) => void;
+ /**
+ * Set callback that is called when zooming starts. Specified function receives the zoom event.
+ */
+ onzoomstart?: (event: Event) => void;
+ /**
+ * Set callback that is called when zooming ends. Specified function receives the zoomed domain.
+ */
+ onzoomend?: (domain: any) => void;
+ }
+
+ interface PointOptions {
+ /**
+ * Whether to show each point in line.
+ */
+ show?: boolean;
+ /**
+ * The radius size of each point.
+ */
+ r?: number;
+
+ focus?: {
+ expand: {
+ /**
+ * Whether to expand each point on focus.
+ */
+ enabled?: boolean;
+ /**
+ * The radius size of each point on focus.
+ */
+ r?: number
+ };
+ };
+
+ select?: {
+ /**
+ * The radius size of each point on selected.
+ */
+ r?: number;
+ };
+ }
+
+ interface ChartAPI {
+ /**
+ * This API highlights specified targets and fade out the others.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be highlighted.
+ */
+ focus(targetIds?: ArrayOrString): void;
+ /**
+ * This API fades out specified targets and reverts the others.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be faded out.
+ */
+ defocus(targetIds?: ArrayOrString): void;
+ /**
+ * This API reverts specified targets.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be reverted.
+ */
+ revert(targetIds?: ArrayOrString): void;
+
+ /**
+ * This API shows specified targets.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be shown.
+ * If withLegend is set true, legend will be shown together with the specified data.
+ */
+ show(targetIds?: ArrayOrString, options?: { withLegend: boolean }): void;
+ /**
+ * This API hides specified targets.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be hidden.
+ * If withLegend is set true, legend will be hidden together with the specified data.
+ */
+ hide(targetIds?: ArrayOrString, options?: { withLegend: boolean }): void;
+ /**
+ * This API toggles (shows or hides) specified targets.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be toggles.
+ * If withLegend is set true, legend will be toggled together with the specified data.
+ */
+ toggle(targetIds?: ArrayOrString, options?: { withLegend: boolean }): void;
+ /**
+ * Load data to the chart.
+ * If url, json, rows and columns given, the data will be loaded. If data that has the same target id is given, the chart will be updated. Otherwise, new target will be added.
+ * If classes given, the classes specifed by data.classes will be updated. classes must be Object that has target id as keys.
+ * If categories given, the categories specifed by axis.x.categories or data.x will be updated. categories must be Array.
+ * If axes given, the axes specifed by data.axes will be updated. axes must be Object that has target id as keys.
+ * If colors given, the colors specifed by data.colors will be updated. colors must be Object that has target id as keys.
+ * If type or types given, the type of targets will be updated. type must be String and types must be Object.
+ * If unload given, data will be unloaded before loading new data. If true given, all of data will be unloaded. If target ids given as String or Array, specified targets will be unloaded.
+ * If done given, the specified function will be called after data loded.
+ * NOTE: unload should be used if some data needs to be unloaded simultaneously. If you call unload API soon after/before load instead of unload param, chart will not be rendered properly because of cancel of animation.
+ * NOTE: done will be called after data loaded, but it's not after rendering. It's because rendering will finish after some transition and there is some time lag between loading and rendering.
+ */
+ load(args: {
+ url?: string;
+ json?: Object;
+ keys?: { x?: string; value: Array<string>; }
+ rows?: Array<PrimitiveArray>;
+ columns?: Array<PrimitiveArray>;
+ classes?: { [key: string]: string };
+ categories?: Array<string>;
+ axes?: { [key: string]: string };
+ colors?: { [key: string]: string | d3.Rgb };
+ type?: string;
+ types?: { [key: string]: string };
+ unload?: boolean | ArrayOrString;
+ done?: () => any;
+ }): void;
+ /**
+ * Unload data to the chart.
+ * You can specify multiple targets by giving an array that includes id as String. If no argument is given, all of targets will be toggles.
+ * If ids given, the data that has specified target id will be unloaded. ids should be String or Array. If ids is not specified, all data will be unloaded.
+ * If done given, the specified function will be called after data loded.
+ * NOTE: If you call load API soon after/before unload, unload param of load should be used. Otherwise chart will not be rendered properly because of cancel of animation.
+ * NOTE: done will be called after data loaded, but it's not after rendering. It's because rendering will finish after some transition and there is some time lag between loading and rendering.
+ */
+ unload(targetIds?: TargetIds, done?: () => any): any;
+ /**
+ * Flow data to the chart. By this API, you can append new data points to the chart.
+ * If json, rows and columns given, the data will be loaded. If data that has the same target id is given, the chart will be appended. Otherwise, new target will be added. One of these is required when calling. If json specified, keys is required as well as data.json
+ * If to is given, the lower x edge will move to that point. If not given, the lower x edge will move by the number of given data points.
+ * If length is given, the lower x edge will move by the number of this argument.
+ * If duration is given, the duration of the transition will be specified value. If not given, transition.duration will be used as default.
+ * If done is given, the specified function will be called when flow ends.
+ */
+ flow(args: {
+ json?: Object;
+ keys?: { x?: string; value: Array<string>; }
+ rows?: Array<PrimitiveArray>;
+ columns?: Array<PrimitiveArray>;
+ to?: any;
+ length?: number;
+ duration?: number;
+ done?: () => any;
+ }): void;
+ /**
+ * Change data point state to selected. By this API, you can select data points. To use this API, data.selection.enabled needs to be set true.
+ * @param ids Specify target ids to be selected. If this argument is not given, all targets will be the candidate.
+ * @param indices Specify indices to be selected. If this argument is not given, all data points will be the candidate.
+ * @param resetOthers If this argument is set true, the data points that are not specified by ids, indices will be unselected.
+ */
+ select(ids?: Array<string>, indices?: Array<number>, resetOthers?: boolean): void;
+ /**
+ * Change data point state to unselected. By this API, you can unselect data points. To use this API, data.selection.enabled needs to be set true.
+ * @param ids Specify target ids to be unselected. If this argument is not given, all targets will be the candidate.
+ * @param indices Specify indices to be unselected. If this argument is not given, all data points will be the candidate.
+ */
+ unselect(ids?: Array<string>, indices?: Array<number>): void;
+ /**
+ * Get selected data points. By this API, you can get selected data points information. To use this API, data.selection.enabled needs to be set true.
+ * @param targetId You can filter the result by giving target id that you want to get. If not given, all of data points will be returned.
+ */
+ selected(targetId?: string): Data;
+ /**
+ * Change the type of the chart.
+ * @param type Specify the type to be transformed. The types listed in data.type can be used.
+ * @param targetIds Specify targets to be transformed. If not given, all targets will be the candidate.
+ */
+ transform(type: string, targetIds?: ArrayOrString): void;
+ /**
+ * Update groups for the targets.
+ * @param groups This argument needs to be an Array that includes one or more Array that includes target ids to be grouped.
+ */
+ groups(groups: Array<Array<string>>): void;
+
+ xgrids: GridOperations;
+
+ ygrids: GridOperations;
+
+ regions: {
+ /**
+ * Update regions.
+ * @param regions Regions will be replaced with this argument. The format of this argument is the same as regions.
+ */
+ (regions: Array<any>): void;
+ /**
+ * Add new region. This API adds new region instead of replacing like regions.
+ * @param grids New region will be added. The format of this argument is the same as regions and it's possible to give an Object if only one region will be added.
+ */
+ add(regions: Array<any> | Object): void;
+ /**
+ * Remove regions. This API removes regions.
+ * @param args This argument should include classes. If classes is given, the regions that have one of the specified classes will be removed. If args is not given, all of regions will be removed.
+ */
+ remove(args?: { value?: number | string, class?: string }): void;
+ };
+
+ data: {
+ /**
+ * Get data loaded in the chart.
+ * @param targetIds If this argument is given, this API returns the specified target data. If this argument is not given, all of data will be returned.
+ */
+ (targetIds?: ArrayOrString): Data;
+ /**
+ * Get data shown in the chart.
+ * @param targetIds If this argument is given, this API filters the data with specified target ids. If this argument is not given, all shown data will be returned.
+ */
+ shown(targetIds?: ArrayOrString): Data;
+ /**
+ * Get values of the data loaded in the chart.
+ * @param targetIds This API returns the values of specified target. If this argument is not given, null will be retruned.
+ */
+ values(targetIds?: ArrayOrString): Array<any>;
+ /**
+ * Get and set names of the data loaded in the chart.
+ * @param names If this argument is given, the names of data will be updated. If not given, the current names will be returned. The format of this argument is the same as data.names.
+ */
+ names(names?: { [key: string]: string }): { [key: string]: string };
+ /**
+ * Get and set colors of the data loaded in the chart.
+ * @param colors If this argument is given, the colors of data will be updated. If not given, the current colors will be returned. The format of this argument is the same as data.colors.
+ */
+ colors(colors?: { [key: string]: string | d3.Rgb }): { [key: string]: string };
+ /**
+ * Get and set axes of the data loaded in the chart.
+ * @param axes If this argument is given, the axes of data will be updated. If not given, the current axes will be returned. The format of this argument is the same as data.axes.
+ */
+ axes(axes?: { [key: string]: string }): { [key: string]: string };
+ };
+
+ /**
+ * Gets and sets the value a category
+ * @param index Index of the category to get or set
+ * @param category: Value of the category to update
+ */
+ category(index: number, category?: string): string;
+
+ /**
+ * Get and set the categories
+ * @param categories: Value of the categories to update
+ */
+ categories(categories?: Array<string>): Array<string>;
+
+ /**
+ * Get the color for the specified targetId
+ */
+ color(targetId: string): string;
+
+ /**
+ * Get and set x values for the chart.
+ * @param x If x is given, x values of every target will be updated. If no argument is given, current x values will be returned as an Object whose keys are the target ids.
+ */
+ x(x?: PrimitiveArray): PrimitiveArray;
+
+ /**
+ * Get and set x values for the chart.
+ * @param x If x is given, x values of every target will be updated. If no argument is given, current x values will be returned as an Object whose keys are the target ids.
+ */
+ xs(xs?: { [key: string]: PrimitiveArray }): { [key: string]: PrimitiveArray };
+
+ axis: {
+ /**
+ * Get and set axis labels.
+ * @param labels If labels is given, specified axis' label will be updated.
+ */
+ labels(labels?: { [key: string]: string }): { [key: string]: string }
+ /**
+ * Get and set axis min value.
+ * @param min If min is given, specified axis' min value will be updated. If no argument is given, the current min values for each axis will be returned.
+ */
+ min(min?: number | { [key: string]: number }): number | { [key: string]: number }
+ /**
+ * Get and set axis max value.
+ * @param max If max is given, specified axis' max value will be updated. If no argument is given, the current max values for each axis will be returned.
+ */
+ max(max?: number | { [key: string]: number }): number | { [key: string]: number }
+ /**
+ * Get and set axis min and max value.
+ * @param range If range is given, specified axis' min and max value will be updated. If no argument is given, the current min and max values for each axis will be returned.
+ */
+ range(range?: { min?: number | { [key: string]: number }, max?: number | { [key: string]: number } }): { min: number | { [key: string]: number }, max: number | { [key: string]: number } }
+ };
+
+ legend: {
+ /**
+ * Show legend for each target.
+ * @param targetIds If targetIds is given, specified target's legend will be shown. If only one target is the candidate, String can be passed. If no argument is given, all of target's legend will be shown.
+ */
+ show(targetIds?: ArrayOrString): void;
+ /**
+ * Hide legend for each target.
+ * @param targetIds If targetIds is given, specified target's legend will be hidden. If only one target is the candidate, String can be passed. If no argument is given, all of target's legend will be hidden.
+ */
+ hide(targetIds?: ArrayOrString): void;
+ };
+
+ zoom: {
+ /**
+ * Zoom by giving x domain.
+ * @param domain If domain is given, the chart will be zoomed to the given domain. If no argument is given, the current zoomed domain will be returned.
+ */
+ (domain?: Array<number>): Array<number>;
+
+ /**
+ * Enable and disable zooming.
+ * @param enabled If enabled is true, the feature of zooming will be enabled. If false is given, it will be disabled.
+ */
+ enable(enabled: boolean): void;
+ };
+
+ /**
+ * Unzoom to the original domain.
+ */
+ unzoom(): void;
+
+ /**
+ * Resize the chart. If no size is specified it will resize to fit.
+ * @param size This argument should include width and height in pixels.
+ */
+ resize(size?: { width?: number, height?: number }): void;
+
+ /**
+ * Force to redraw.
+ */
+ flush(): void;
+
+ /**
+ * Reset the chart object and remove element and events completely.
+ */
+ destroy(): void;
+ }
+
+ interface GridOperations {
+ /**
+ * Update the x/y grid lines.
+ * @param grids X/Y grid lines will be replaced with this argument. The format of this argument is the same as grid.x.lines or grid.y.lines.
+ */
+ (grids: Array<any>): void;
+ /**
+ * Add x/y grid lines. This API adds new x/y grid lines instead of replacing like xgrids.
+ * @param grids New x/y grid lines will be added. The format of this argument is the same as grid.x.lines or grid.y.lines and it's possible to give an Object if only one line will be added.
+ */
+ add(grids: Array<any> | Object): void;
+ /**
+ * Remove x/y grid lines. This API removes x/y grid lines.
+ * @param args This argument should include value or class. If value is given, the x/y grid lines that have specified x/y value will be removed. If class is given, the x/y grid lines that have specified class will be removed. If args is not given, all of x/y grid lines will be removed.
+ */
+ remove(args?: { class?: string, value?: number | string }): void;
+ }
+
+ export function generate(config: ChartConfiguration): ChartAPI;
+}
diff --git a/chai/chai-2.0.0.d.ts b/chai/chai-2.0.0.d.ts
index f693582c59..cb685f3efa 100644
--- a/chai/chai-2.0.0.d.ts
+++ b/chai/chai-2.0.0.d.ts
@@ -305,4 +305,4 @@ declare module "chai" {
interface Object {
should: Chai.Assertion;
-}
+}
diff --git a/chai/chai.d.ts b/chai/chai.d.ts
index da4d718e1b..28aaf48c25 100644
--- a/chai/chai.d.ts
+++ b/chai/chai.d.ts
@@ -1,388 +1,388 @@
-// Type definitions for chai 3.2.0
-// Project: http://chaijs.com/
-// Definitions by: Jed Mao <https://github.com/jedmao/>,
-// Bart van der Schoor <https://github.com/Bartvds>,
-// Andrew Brown <https://github.com/AGBrown>,
-// Olivier Chevet <https://github.com/olivr70>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-// <reference path="../assertion-error/assertion-error.d.ts"/>
-
-declare module Chai {
-
- interface ChaiStatic {
- expect: ExpectStatic;
- should(): Should;
- /**
- * Provides a way to extend the internals of Chai
- */
- use(fn: (chai: any, utils: any) => void): any;
- assert: AssertStatic;
- config: Config;
- AssertionError: AssertionError;
- }
-
- export interface ExpectStatic extends AssertionStatic {
- fail(actual?: any, expected?: any, message?: string, operator?: string): void;
- }
-
- export interface AssertStatic extends Assert {
- }
-
- export interface AssertionStatic {
- (target: any, message?: string): Assertion;
- }
-
- interface ShouldAssertion {
- equal(value1: any, value2: any, message?: string): void;
- Throw: ShouldThrow;
- throw: ShouldThrow;
- exist(value: any, message?: string): void;
- }
-
- interface Should extends ShouldAssertion {
- not: ShouldAssertion;
- fail(actual: any, expected: any, message?: string, operator?: string): void;
- }
-
- interface ShouldThrow {
- (actual: Function): void;
- (actual: Function, expected: string|RegExp, message?: string): void;
- (actual: Function, constructor: Error|Function, expected?: string|RegExp, message?: string): void;
- }
-
- interface Assertion extends LanguageChains, NumericComparison, TypeComparison {
- not: Assertion;
- deep: Deep;
- any: KeyFilter;
- all: KeyFilter;
- a: TypeComparison;
- an: TypeComparison;
- include: Include;
- includes: Include;
- contain: Include;
- contains: Include;
- ok: Assertion;
- true: Assertion;
- false: Assertion;
- null: Assertion;
- undefined: Assertion;
- NaN: Assertion;
- exist: Assertion;
- empty: Assertion;
- arguments: Assertion;
- Arguments: Assertion;
- equal: Equal;
- equals: Equal;
- eq: Equal;
- eql: Equal;
- eqls: Equal;
- property: Property;
- ownProperty: OwnProperty;
- haveOwnProperty: OwnProperty;
- ownPropertyDescriptor: OwnPropertyDescriptor;
- haveOwnPropertyDescriptor: OwnPropertyDescriptor;
- length: Length;
- lengthOf: Length;
- match: Match;
- matches: Match;
- string(string: string, message?: string): Assertion;
- keys: Keys;
- key(string: string): Assertion;
- throw: Throw;
- throws: Throw;
- Throw: Throw;
- respondTo: RespondTo;
- respondsTo: RespondTo;
- itself: Assertion;
- satisfy: Satisfy;
- satisfies: Satisfy;
- closeTo(expected: number, delta: number, message?: string): Assertion;
- members: Members;
- increase: PropertyChange;
- increases: PropertyChange;
- decrease: PropertyChange;
- decreases: PropertyChange;
- change: PropertyChange;
- changes: PropertyChange;
- extensible: Assertion;
- sealed: Assertion;
- frozen: Assertion;
-
- }
-
- interface LanguageChains {
- to: Assertion;
- be: Assertion;
- been: Assertion;
- is: Assertion;
- that: Assertion;
- which: Assertion;
- and: Assertion;
- has: Assertion;
- have: Assertion;
- with: Assertion;
- at: Assertion;
- of: Assertion;
- same: Assertion;
- }
-
- interface NumericComparison {
- above: NumberComparer;
- gt: NumberComparer;
- greaterThan: NumberComparer;
- least: NumberComparer;
- gte: NumberComparer;
- below: NumberComparer;
- lt: NumberComparer;
- lessThan: NumberComparer;
- most: NumberComparer;
- lte: NumberComparer;
- within(start: number, finish: number, message?: string): Assertion;
- }
-
- interface NumberComparer {
- (value: number, message?: string): Assertion;
- }
-
- interface TypeComparison {
- (type: string, message?: string): Assertion;
- instanceof: InstanceOf;
- instanceOf: InstanceOf;
- }
-
- interface InstanceOf {
- (constructor: Object, message?: string): Assertion;
- }
-
- interface Deep {
- equal: Equal;
- include: Include;
- property: Property;
- members: Members;
- }
-
- interface KeyFilter {
- keys: Keys;
- }
-
- interface Equal {
- (value: any, message?: string): Assertion;
- }
-
- interface Property {
- (name: string, value?: any, message?: string): Assertion;
- }
-
- interface OwnProperty {
- (name: string, message?: string): Assertion;
- }
-
- interface OwnPropertyDescriptor {
- (name: string, descriptor: PropertyDescriptor, message?: string): Assertion;
- (name: string, message?: string): Assertion;
- }
-
- interface Length extends LanguageChains, NumericComparison {
- (length: number, message?: string): Assertion;
- }
-
- interface Include {
- (value: Object, message?: string): Assertion;
- (value: string, message?: string): Assertion;
- (value: number, message?: string): Assertion;
- keys: Keys;
- members: Members;
- any: KeyFilter;
- all: KeyFilter;
- }
-
- interface Match {
- (regexp: RegExp|string, message?: string): Assertion;
- }
-
- interface Keys {
- (...keys: string[]): Assertion;
- (keys: any[]): Assertion;
- (keys: Object): Assertion;
- }
-
- interface Throw {
- (): Assertion;
- (expected: string, message?: string): Assertion;
- (expected: RegExp, message?: string): Assertion;
- (constructor: Error, expected?: string, message?: string): Assertion;
- (constructor: Error, expected?: RegExp, message?: string): Assertion;
- (constructor: Function, expected?: string, message?: string): Assertion;
- (constructor: Function, expected?: RegExp, message?: string): Assertion;
- }
-
- interface RespondTo {
- (method: string, message?: string): Assertion;
- }
-
- interface Satisfy {
- (matcher: Function, message?: string): Assertion;
- }
-
- interface Members {
- (set: any[], message?: string): Assertion;
- }
-
- interface PropertyChange {
- (object: Object, prop: string, msg?: string): Assertion;
- }
-
- export interface Assert {
- /**
- * @param expression Expression to test for truthiness.
- * @param message Message to display on error.
- */
- (expression: any, message?: string): void;
-
- fail(actual?: any, expected?: any, msg?: string, operator?: string): void;
-
- ok(val: any, msg?: string): void;
- isOk(val: any, msg?: string): void;
- notOk(val: any, msg?: string): void;
- isNotOk(val: any, msg?: string): void;
-
- equal(act: any, exp: any, msg?: string): void;
- notEqual(act: any, exp: any, msg?: string): void;
-
- strictEqual(act: any, exp: any, msg?: string): void;
- notStrictEqual(act: any, exp: any, msg?: string): void;
-
- deepEqual(act: any, exp: any, msg?: string): void;
- notDeepEqual(act: any, exp: any, msg?: string): void;
-
- isTrue(val: any, msg?: string): void;
- isFalse(val: any, msg?: string): void;
-
- isNull(val: any, msg?: string): void;
- isNotNull(val: any, msg?: string): void;
-
- isUndefined(val: any, msg?: string): void;
- isDefined(val: any, msg?: string): void;
-
- isNaN(val: any, msg?: string): void;
- isNotNaN(val: any, msg?: string): void;
-
- isAbove(val: number, abv: number, msg?: string): void;
- isBelow(val: number, blw: number, msg?: string): void;
-
- isFunction(val: any, msg?: string): void;
- isNotFunction(val: any, msg?: string): void;
-
- isObject(val: any, msg?: string): void;
- isNotObject(val: any, msg?: string): void;
-
- isArray(val: any, msg?: string): void;
- isNotArray(val: any, msg?: string): void;
-
- isString(val: any, msg?: string): void;
- isNotString(val: any, msg?: string): void;
-
- isNumber(val: any, msg?: string): void;
- isNotNumber(val: any, msg?: string): void;
-
- isBoolean(val: any, msg?: string): void;
- isNotBoolean(val: any, msg?: string): void;
-
- typeOf(val: any, type: string, msg?: string): void;
- notTypeOf(val: any, type: string, msg?: string): void;
-
- instanceOf(val: any, type: Function, msg?: string): void;
- notInstanceOf(val: any, type: Function, msg?: string): void;
-
- include(exp: string, inc: any, msg?: string): void;
- include(exp: any[], inc: any, msg?: string): void;
-
- notInclude(exp: string, inc: any, msg?: string): void;
- notInclude(exp: any[], inc: any, msg?: string): void;
-
- match(exp: any, re: RegExp, msg?: string): void;
- notMatch(exp: any, re: RegExp, msg?: string): void;
-
- property(obj: Object, prop: string, msg?: string): void;
- notProperty(obj: Object, prop: string, msg?: string): void;
- deepProperty(obj: Object, prop: string, msg?: string): void;
- notDeepProperty(obj: Object, prop: string, msg?: string): void;
-
- propertyVal(obj: Object, prop: string, val: any, msg?: string): void;
- propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void;
-
- deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void;
- deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void;
-
- lengthOf(exp: any, len: number, msg?: string): void;
- //alias frenzy
- throw(fn: Function, msg?: string): void;
- throw(fn: Function, regExp: RegExp): void;
- throw(fn: Function, errType: Function, msg?: string): void;
- throw(fn: Function, errType: Function, regExp: RegExp): void;
-
- throws(fn: Function, msg?: string): void;
- throws(fn: Function, regExp: RegExp): void;
- throws(fn: Function, errType: Function, msg?: string): void;
- throws(fn: Function, errType: Function, regExp: RegExp): void;
-
- Throw(fn: Function, msg?: string): void;
- Throw(fn: Function, regExp: RegExp): void;
- Throw(fn: Function, errType: Function, msg?: string): void;
- Throw(fn: Function, errType: Function, regExp: RegExp): void;
-
- doesNotThrow(fn: Function, msg?: string): void;
- doesNotThrow(fn: Function, regExp: RegExp): void;
- doesNotThrow(fn: Function, errType: Function, msg?: string): void;
- doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void;
-
- operator(val: any, operator: string, val2: any, msg?: string): void;
- closeTo(act: number, exp: number, delta: number, msg?: string): void;
-
- sameMembers(set1: any[], set2: any[], msg?: string): void;
- sameDeepMembers(set1: any[], set2: any[], msg?: string): void;
- includeMembers(superset: any[], subset: any[], msg?: string): void;
-
- ifError(val: any, msg?: string): void;
-
- isExtensible(obj: {}, msg?: string): void;
- extensible(obj: {}, msg?: string): void;
- isNotExtensible(obj: {}, msg?: string): void;
- notExtensible(obj: {}, msg?: string): void;
-
- isSealed(obj: {}, msg?: string): void;
- sealed(obj: {}, msg?: string): void;
- isNotSealed(obj: {}, msg?: string): void;
- notSealed(obj: {}, msg?: string): void;
-
- isFrozen(obj: Object, msg?: string): void;
- frozen(obj: Object, msg?: string): void;
- isNotFrozen(obj: Object, msg?: string): void;
- notFrozen(obj: Object, msg?: string): void;
-
-
- }
-
- export interface Config {
- includeStack: boolean;
- }
-
- export class AssertionError {
- constructor(message: string, _props?: any, ssf?: Function);
- name: string;
- message: string;
- showDiff: boolean;
- stack: string;
- }
-}
-
-declare var chai: Chai.ChaiStatic;
-
-declare module "chai" {
- export = chai;
-}
-
-interface Object {
- should: Chai.Assertion;
-}
+// Type definitions for chai 3.2.0
+// Project: http://chaijs.com/
+// Definitions by: Jed Mao <https://github.com/jedmao/>,
+// Bart van der Schoor <https://github.com/Bartvds>,
+// Andrew Brown <https://github.com/AGBrown>,
+// Olivier Chevet <https://github.com/olivr70>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+// <reference path="../assertion-error/assertion-error.d.ts"/>
+
+declare module Chai {
+
+ interface ChaiStatic {
+ expect: ExpectStatic;
+ should(): Should;
+ /**
+ * Provides a way to extend the internals of Chai
+ */
+ use(fn: (chai: any, utils: any) => void): any;
+ assert: AssertStatic;
+ config: Config;
+ AssertionError: AssertionError;
+ }
+
+ export interface ExpectStatic extends AssertionStatic {
+ fail(actual?: any, expected?: any, message?: string, operator?: string): void;
+ }
+
+ export interface AssertStatic extends Assert {
+ }
+
+ export interface AssertionStatic {
+ (target: any, message?: string): Assertion;
+ }
+
+ interface ShouldAssertion {
+ equal(value1: any, value2: any, message?: string): void;
+ Throw: ShouldThrow;
+ throw: ShouldThrow;
+ exist(value: any, message?: string): void;
+ }
+
+ interface Should extends ShouldAssertion {
+ not: ShouldAssertion;
+ fail(actual: any, expected: any, message?: string, operator?: string): void;
+ }
+
+ interface ShouldThrow {
+ (actual: Function): void;
+ (actual: Function, expected: string|RegExp, message?: string): void;
+ (actual: Function, constructor: Error|Function, expected?: string|RegExp, message?: string): void;
+ }
+
+ interface Assertion extends LanguageChains, NumericComparison, TypeComparison {
+ not: Assertion;
+ deep: Deep;
+ any: KeyFilter;
+ all: KeyFilter;
+ a: TypeComparison;
+ an: TypeComparison;
+ include: Include;
+ includes: Include;
+ contain: Include;
+ contains: Include;
+ ok: Assertion;
+ true: Assertion;
+ false: Assertion;
+ null: Assertion;
+ undefined: Assertion;
+ NaN: Assertion;
+ exist: Assertion;
+ empty: Assertion;
+ arguments: Assertion;
+ Arguments: Assertion;
+ equal: Equal;
+ equals: Equal;
+ eq: Equal;
+ eql: Equal;
+ eqls: Equal;
+ property: Property;
+ ownProperty: OwnProperty;
+ haveOwnProperty: OwnProperty;
+ ownPropertyDescriptor: OwnPropertyDescriptor;
+ haveOwnPropertyDescriptor: OwnPropertyDescriptor;
+ length: Length;
+ lengthOf: Length;
+ match: Match;
+ matches: Match;
+ string(string: string, message?: string): Assertion;
+ keys: Keys;
+ key(string: string): Assertion;
+ throw: Throw;
+ throws: Throw;
+ Throw: Throw;
+ respondTo: RespondTo;
+ respondsTo: RespondTo;
+ itself: Assertion;
+ satisfy: Satisfy;
+ satisfies: Satisfy;
+ closeTo(expected: number, delta: number, message?: string): Assertion;
+ members: Members;
+ increase: PropertyChange;
+ increases: PropertyChange;
+ decrease: PropertyChange;
+ decreases: PropertyChange;
+ change: PropertyChange;
+ changes: PropertyChange;
+ extensible: Assertion;
+ sealed: Assertion;
+ frozen: Assertion;
+
+ }
+
+ interface LanguageChains {
+ to: Assertion;
+ be: Assertion;
+ been: Assertion;
+ is: Assertion;
+ that: Assertion;
+ which: Assertion;
+ and: Assertion;
+ has: Assertion;
+ have: Assertion;
+ with: Assertion;
+ at: Assertion;
+ of: Assertion;
+ same: Assertion;
+ }
+
+ interface NumericComparison {
+ above: NumberComparer;
+ gt: NumberComparer;
+ greaterThan: NumberComparer;
+ least: NumberComparer;
+ gte: NumberComparer;
+ below: NumberComparer;
+ lt: NumberComparer;
+ lessThan: NumberComparer;
+ most: NumberComparer;
+ lte: NumberComparer;
+ within(start: number, finish: number, message?: string): Assertion;
+ }
+
+ interface NumberComparer {
+ (value: number, message?: string): Assertion;
+ }
+
+ interface TypeComparison {
+ (type: string, message?: string): Assertion;
+ instanceof: InstanceOf;
+ instanceOf: InstanceOf;
+ }
+
+ interface InstanceOf {
+ (constructor: Object, message?: string): Assertion;
+ }
+
+ interface Deep {
+ equal: Equal;
+ include: Include;
+ property: Property;
+ members: Members;
+ }
+
+ interface KeyFilter {
+ keys: Keys;
+ }
+
+ interface Equal {
+ (value: any, message?: string): Assertion;
+ }
+
+ interface Property {
+ (name: string, value?: any, message?: string): Assertion;
+ }
+
+ interface OwnProperty {
+ (name: string, message?: string): Assertion;
+ }
+
+ interface OwnPropertyDescriptor {
+ (name: string, descriptor: PropertyDescriptor, message?: string): Assertion;
+ (name: string, message?: string): Assertion;
+ }
+
+ interface Length extends LanguageChains, NumericComparison {
+ (length: number, message?: string): Assertion;
+ }
+
+ interface Include {
+ (value: Object, message?: string): Assertion;
+ (value: string, message?: string): Assertion;
+ (value: number, message?: string): Assertion;
+ keys: Keys;
+ members: Members;
+ any: KeyFilter;
+ all: KeyFilter;
+ }
+
+ interface Match {
+ (regexp: RegExp|string, message?: string): Assertion;
+ }
+
+ interface Keys {
+ (...keys: string[]): Assertion;
+ (keys: any[]): Assertion;
+ (keys: Object): Assertion;
+ }
+
+ interface Throw {
+ (): Assertion;
+ (expected: string, message?: string): Assertion;
+ (expected: RegExp, message?: string): Assertion;
+ (constructor: Error, expected?: string, message?: string): Assertion;
+ (constructor: Error, expected?: RegExp, message?: string): Assertion;
+ (constructor: Function, expected?: string, message?: string): Assertion;
+ (constructor: Function, expected?: RegExp, message?: string): Assertion;
+ }
+
+ interface RespondTo {
+ (method: string, message?: string): Assertion;
+ }
+
+ interface Satisfy {
+ (matcher: Function, message?: string): Assertion;
+ }
+
+ interface Members {
+ (set: any[], message?: string): Assertion;
+ }
+
+ interface PropertyChange {
+ (object: Object, prop: string, msg?: string): Assertion;
+ }
+
+ export interface Assert {
+ /**
+ * @param expression Expression to test for truthiness.
+ * @param message Message to display on error.
+ */
+ (expression: any, message?: string): void;
+
+ fail(actual?: any, expected?: any, msg?: string, operator?: string): void;
+
+ ok(val: any, msg?: string): void;
+ isOk(val: any, msg?: string): void;
+ notOk(val: any, msg?: string): void;
+ isNotOk(val: any, msg?: string): void;
+
+ equal(act: any, exp: any, msg?: string): void;
+ notEqual(act: any, exp: any, msg?: string): void;
+
+ strictEqual(act: any, exp: any, msg?: string): void;
+ notStrictEqual(act: any, exp: any, msg?: string): void;
+
+ deepEqual(act: any, exp: any, msg?: string): void;
+ notDeepEqual(act: any, exp: any, msg?: string): void;
+
+ isTrue(val: any, msg?: string): void;
+ isFalse(val: any, msg?: string): void;
+
+ isNull(val: any, msg?: string): void;
+ isNotNull(val: any, msg?: string): void;
+
+ isUndefined(val: any, msg?: string): void;
+ isDefined(val: any, msg?: string): void;
+
+ isNaN(val: any, msg?: string): void;
+ isNotNaN(val: any, msg?: string): void;
+
+ isAbove(val: number, abv: number, msg?: string): void;
+ isBelow(val: number, blw: number, msg?: string): void;
+
+ isFunction(val: any, msg?: string): void;
+ isNotFunction(val: any, msg?: string): void;
+
+ isObject(val: any, msg?: string): void;
+ isNotObject(val: any, msg?: string): void;
+
+ isArray(val: any, msg?: string): void;
+ isNotArray(val: any, msg?: string): void;
+
+ isString(val: any, msg?: string): void;
+ isNotString(val: any, msg?: string): void;
+
+ isNumber(val: any, msg?: string): void;
+ isNotNumber(val: any, msg?: string): void;
+
+ isBoolean(val: any, msg?: string): void;
+ isNotBoolean(val: any, msg?: string): void;
+
+ typeOf(val: any, type: string, msg?: string): void;
+ notTypeOf(val: any, type: string, msg?: string): void;
+
+ instanceOf(val: any, type: Function, msg?: string): void;
+ notInstanceOf(val: any, type: Function, msg?: string): void;
+
+ include(exp: string, inc: any, msg?: string): void;
+ include(exp: any[], inc: any, msg?: string): void;
+
+ notInclude(exp: string, inc: any, msg?: string): void;
+ notInclude(exp: any[], inc: any, msg?: string): void;
+
+ match(exp: any, re: RegExp, msg?: string): void;
+ notMatch(exp: any, re: RegExp, msg?: string): void;
+
+ property(obj: Object, prop: string, msg?: string): void;
+ notProperty(obj: Object, prop: string, msg?: string): void;
+ deepProperty(obj: Object, prop: string, msg?: string): void;
+ notDeepProperty(obj: Object, prop: string, msg?: string): void;
+
+ propertyVal(obj: Object, prop: string, val: any, msg?: string): void;
+ propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void;
+
+ deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void;
+ deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void;
+
+ lengthOf(exp: any, len: number, msg?: string): void;
+ //alias frenzy
+ throw(fn: Function, msg?: string): void;
+ throw(fn: Function, regExp: RegExp): void;
+ throw(fn: Function, errType: Function, msg?: string): void;
+ throw(fn: Function, errType: Function, regExp: RegExp): void;
+
+ throws(fn: Function, msg?: string): void;
+ throws(fn: Function, regExp: RegExp): void;
+ throws(fn: Function, errType: Function, msg?: string): void;
+ throws(fn: Function, errType: Function, regExp: RegExp): void;
+
+ Throw(fn: Function, msg?: string): void;
+ Throw(fn: Function, regExp: RegExp): void;
+ Throw(fn: Function, errType: Function, msg?: string): void;
+ Throw(fn: Function, errType: Function, regExp: RegExp): void;
+
+ doesNotThrow(fn: Function, msg?: string): void;
+ doesNotThrow(fn: Function, regExp: RegExp): void;
+ doesNotThrow(fn: Function, errType: Function, msg?: string): void;
+ doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void;
+
+ operator(val: any, operator: string, val2: any, msg?: string): void;
+ closeTo(act: number, exp: number, delta: number, msg?: string): void;
+
+ sameMembers(set1: any[], set2: any[], msg?: string): void;
+ sameDeepMembers(set1: any[], set2: any[], msg?: string): void;
+ includeMembers(superset: any[], subset: any[], msg?: string): void;
+
+ ifError(val: any, msg?: string): void;
+
+ isExtensible(obj: {}, msg?: string): void;
+ extensible(obj: {}, msg?: string): void;
+ isNotExtensible(obj: {}, msg?: string): void;
+ notExtensible(obj: {}, msg?: string): void;
+
+ isSealed(obj: {}, msg?: string): void;
+ sealed(obj: {}, msg?: string): void;
+ isNotSealed(obj: {}, msg?: string): void;
+ notSealed(obj: {}, msg?: string): void;
+
+ isFrozen(obj: Object, msg?: string): void;
+ frozen(obj: Object, msg?: string): void;
+ isNotFrozen(obj: Object, msg?: string): void;
+ notFrozen(obj: Object, msg?: string): void;
+
+
+ }
+
+ export interface Config {
+ includeStack: boolean;
+ }
+
+ export class AssertionError {
+ constructor(message: string, _props?: any, ssf?: Function);
+ name: string;
+ message: string;
+ showDiff: boolean;
+ stack: string;
+ }
+}
+
+declare var chai: Chai.ChaiStatic;
+
+declare module "chai" {
+ export = chai;
+}
+
+interface Object {
+ should: Chai.Assertion;
+}
diff --git a/chance/chance-tests.ts b/chance/chance-tests.ts
index 5a2aa9a9cb..29d258cf70 100644
--- a/chance/chance-tests.ts
+++ b/chance/chance-tests.ts
@@ -34,3 +34,6 @@ chance.mixin({
});
var timeString: string = chance.time();
+
+var chanceConstructedWithSeed100 = new Chance(100);
+var chanceCalledWithSeed100 = Chance()
\ No newline at end of file
diff --git a/chance/chance.d.ts b/chance/chance.d.ts
index e79304c8d5..c77be4d282 100644
--- a/chance/chance.d.ts
+++ b/chance/chance.d.ts
@@ -5,7 +5,10 @@
declare module Chance {
interface ChanceStatic {
- Chance(): Chance;
+ (): Chance
+ (seed: number): Chance
+ (generator: () => any): Chance
+
new(): Chance;
new(seed: number): Chance;
new(generator: () => any): Chance;
@@ -209,5 +212,10 @@ declare var Chance: Chance.ChanceStatic;
// import Chance = require('chance');
declare module 'chance' {
+ interface ExportedChance extends Chance.ChanceStatic {
+ Chance: ExportedChance;
+ }
+ var Chance: ExportedChance;
+
export = Chance;
}
diff --git a/chrome/chrome.d.ts b/chrome/chrome.d.ts
index 34bb95205c..8829ab044e 100755
--- a/chrome/chrome.d.ts
+++ b/chrome/chrome.d.ts
@@ -1,9 +1,10 @@
// Type definitions for Chrome extension development
// Project: http://developer.chrome.com/extensions/
-// Definitions by: Matthew Kimber <https://github.com/matthewkimber>, otiai10 <https://github.com/otiai10>
+// Definitions by: Matthew Kimber <https://github.com/matthewkimber>, otiai10 <https://github.com/otiai10>, couven92 <https://gitbus.com/couven92>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path='../webrtc/MediaStream.d.ts'/>
+/// <reference path='../filesystem/filesystem.d.ts' />
////////////////////
// Global object
@@ -12,34 +13,191 @@ interface Window {
chrome: typeof chrome;
}
+////////////////////
+// Accessibility Features
+////////////////////
+/**
+ * Use the chrome.accessibilityFeatures API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request accessibilityFeatures.read permission. For modifying feature state, the extension needs accessibilityFeatures.modify permission. Note that accessibilityFeatures.modify does not imply accessibilityFeatures.read permission.
+ * Availability: Since Chrome 37.
+ * Permissions: "accessibilityFeatures.read"
+ * Important: This API works only on Chrome OS.
+ */
+declare module chrome.accessibilityFeatures {
+ interface AccessibilityFeaturesGetArg {
+ /** Optional. Whether to return the value that applies to the incognito session (default false). */
+ incognito?: boolean;
+ }
+
+ interface AccessibilityFeaturesCallbackArg {
+ /** The value of the setting. */
+ value: any;
+ /**
+ * One of
+ * • not_controllable: cannot be controlled by any extension
+ * • controlled_by_other_extensions: controlled by extensions with higher precedence
+ * • controllable_by_this_extension: can be controlled by this extension
+ * • controlled_by_this_extension: controlled by this extension
+ */
+ levelOfControl: string;
+ /** Optional. Whether the effective value is specific to the incognito session. This property will only be present if the incognito property in the details parameter of get() was true. */
+ incognitoSpecific?: boolean;
+ }
+
+ interface AccessibilityFeaturesSetArg {
+ /**
+ * The value of the setting.
+ * Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.
+ */
+ value: any;
+ /**
+ * Optional.
+ * The scope of the ChromeSetting. One of
+ * • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
+ * • regular_only: setting for the regular profile only (not inherited by the incognito profile),
+ * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
+ * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
+ */
+ scope?: string;
+ }
+
+ interface AccessibilityFeaturesClearArg {
+ /**
+ * Optional.
+ * The scope of the ChromeSetting. One of
+ * • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
+ * • regular_only: setting for the regular profile only (not inherited by the incognito profile),
+ * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
+ * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
+ */
+ scope?: string;
+ }
+
+ interface AccessibilityFeaturesSetting {
+ /**
+ * Gets the value of a setting.
+ * @param details Which setting to consider.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
+ get(details: AccessibilityFeaturesGetArg, callback: (details: AccessibilityFeaturesCallbackArg) => void): void;
+ /**
+ * Sets the value of a setting.
+ * @param details Which setting to change.
+ * @param callback Called at the completion of the set operation.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ set(details: AccessibilityFeaturesSetArg, callback?: () => void): void;
+ /**
+ * Clears the setting, restoring any default value.
+ * @param details Which setting to clear.
+ * @param callback Called at the completion of the clear operation.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ clear(details: AccessibilityFeaturesClearArg, callback?: () => void): void;
+ }
+
+ var spokenFeedback: AccessibilityFeaturesSetting;
+ var largeCursor: AccessibilityFeaturesSetting;
+ var stickyKeys: AccessibilityFeaturesSetting;
+ var highContrast: AccessibilityFeaturesSetting;
+ var screenMagnifier: AccessibilityFeaturesSetting;
+ var autoclick: AccessibilityFeaturesSetting;
+ var virtualKeyboard: AccessibilityFeaturesSetting;
+ var animationPolicy: AccessibilityFeaturesSetting;
+}
+
////////////////////
// Alarms
////////////////////
+/**
+ * Use the chrome.alarms API to schedule code to run periodically or at a specified time in the future.
+ * Availability: Since Chrome 22.
+ * Permissions: "alarms"
+ */
declare module chrome.alarms {
interface AlarmCreateInfo {
+ /** Optional. Length of time in minutes after which the onAlarm event should fire. */
delayInMinutes?: number;
+ /** Optional. If set, the onAlarm event should fire every periodInMinutes minutes after the initial event specified by when or delayInMinutes. If not set, the alarm will only fire once. */
periodInMinutes?: number;
+ /** Optional. Time at which the alarm should fire, in milliseconds past the epoch (e.g. Date.now() + n). */
when?: number;
}
interface Alarm {
+ /** Optional. If not null, the alarm is a repeating alarm and will fire again in periodInMinutes minutes. */
periodInMinutes?: number;
+ /** Time at which this alarm was scheduled to fire, in milliseconds past the epoch (e.g. Date.now() + n). For performance reasons, the alarm may have been delayed an arbitrary amount beyond this. */
scheduledTime: number;
+ /** Name of this alarm. */
name: string;
}
interface AlarmEvent extends chrome.events.Event {
+ /**
+ * The callback parameter should be a function that looks like this:
+ * function( Alarm alarm) {...};
+ */
addListener(callback: (alarm: Alarm) => void): void;
}
+ /**
+ * Creates an alarm. Near the time(s) specified by alarmInfo, the onAlarm event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+ * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting delayInMinutes or periodInMinutes to less than 1 will not be honored and will cause a warning. when can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.
+ * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+ * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either when or delayInMinutes (but not both). If periodInMinutes is set, the alarm will repeat every periodInMinutes minutes after the initial event. If neither when or delayInMinutes is set for a repeating alarm, periodInMinutes is used as the default for delayInMinutes.
+ */
export function create(alarmInfo: AlarmCreateInfo): void;
+ /**
+ * Creates an alarm. Near the time(s) specified by alarmInfo, the onAlarm event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+ * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting delayInMinutes or periodInMinutes to less than 1 will not be honored and will cause a warning. when can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.
+ * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+ * @param name Optional name to identify this alarm. Defaults to the empty string.
+ * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either when or delayInMinutes (but not both). If periodInMinutes is set, the alarm will repeat every periodInMinutes minutes after the initial event. If neither when or delayInMinutes is set for a repeating alarm, periodInMinutes is used as the default for delayInMinutes.
+ */
export function create(name: string, alarmInfo: AlarmCreateInfo): void;
+ /**
+ * Gets an array of all the alarms.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of Alarm alarms) {...};
+ */
export function getAll(callback: (alarms: Alarm[]) => void): void;
- export function clearAll(): void;
- export function clear(name?: string): void;
+ /**
+ * Clears all alarms.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean wasCleared) {...};
+ */
+ export function clearAll(callback?: (wasCleared: boolean) => void): void;
+ /**
+ * Clears the alarm with the given name.
+ * @param name The name of the alarm to clear. Defaults to the empty string.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean wasCleared) {...};
+ */
+ export function clear(name?: string, callback?: (wasCleared: boolean) => void): void;
+ /**
+ * Clears the alarm without a name.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean wasCleared) {...};
+ */
+ export function clear(callback: (wasCleared: boolean) => void): void;
+ /**
+ * Retrieves details about the specified alarm.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Alarm alarm) {...};
+ */
export function get(callback: (alarm: Alarm) => void): void;
+ /**
+ * Retrieves details about the specified alarm.
+ * @param name The name of the alarm to get. Defaults to the empty string.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Alarm alarm) {...};
+ */
export function get(name: string, callback: (alarm: Alarm) => void): void;
+ /** Fired when an alarm has elapsed. Useful for event pages. */
var onAlarm: AlarmEvent;
}
@@ -49,10 +207,8 @@ declare module chrome.alarms {
*/
declare module chrome.browser {
interface Options {
- /**
- * The URL to navigate to when the new tab is initially opened.
- */
- url:string;
+ /** The URL to navigate to when the new tab is initially opened. */
+ url: string;
}
/**
@@ -63,30 +219,50 @@ declare module chrome.browser {
* @param callback Called when the tab was successfully
* created, or failed to be created. If failed, runtime.lastError will be set.
*/
- export function openTab (options: Options, callback: () => void): void;
+ export function openTab(options: Options, callback: () => void): void;
- /**
- * Opens a new tab in a browser window associated with the current application
- * and Chrome profile. If no browser window for the Chrome profile is opened,
- * a new one is opened prior to creating the new tab. Since Chrome 42 only.
- * @param options Configures how the tab should be opened.
- */
- export function openTab (options: Options): void;
+ /**
+ * Opens a new tab in a browser window associated with the current application
+ * and Chrome profile. If no browser window for the Chrome profile is opened,
+ * a new one is opened prior to creating the new tab. Since Chrome 42 only.
+ * @param options Configures how the tab should be opened.
+ */
+ export function openTab(options: Options): void;
}
////////////////////
// Bookmarks
////////////////////
+/**
+ * Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks. Also see Override Pages, which you can use to create a custom Bookmark Manager page.
+ * Availability: Since Chrome 5.
+ * Permissions: "bookmarks"
+ */
declare module chrome.bookmarks {
+ /** A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder. */
interface BookmarkTreeNode {
+ /** Optional. The 0-based position of this node within its parent folder. */
index?: number;
+ /** Optional. When this node was created, in milliseconds since the epoch (new Date(dateAdded)). */
dateAdded?: number;
+ /** The text displayed for the node. */
title: string;
+ /** Optional. The URL navigated to when a user clicks the bookmark. Omitted for folders. */
url?: string;
+ /** Optional. When the contents of this folder last changed, in milliseconds since the epoch. */
dateGroupModified?: number;
+ /** The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted. */
id: string;
+ /** Optional. The id of the parent folder. Omitted for the root node. */
parentId?: string;
+ /** Optional. An ordered list of children of this node. */
children?: BookmarkTreeNode[];
+ /**
+ * Optional.
+ * Since Chrome 37.
+ * Indicates the reason why this node is unmodifiable. The managed value indicates that this node was configured by the system administrator or by the custodian of a supervised user. Omitted if the node can be modified by the user and the extension (default).
+ */
+ unmodifiable?: any;
}
interface BookmarkRemoveInfo {
@@ -111,243 +287,820 @@ declare module chrome.bookmarks {
}
interface BookmarkRemovedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id, object removeInfo) {...};
+ */
addListener(callback: (id: string, removeInfo: BookmarkRemoveInfo) => void): void;
}
interface BookmarkImportEndedEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
interface BookmarkMovedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id, object moveInfo) {...};
+ */
addListener(callback: (id: string, moveInfo: BookmarkMoveInfo) => void): void;
}
interface BookmarkImportBeganEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
interface BookmarkChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id, object changeInfo) {...};
+ */
addListener(callback: (id: string, changeInfo: BookmarkChangeInfo) => void): void;
}
interface BookmarkCreatedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id, BookmarkTreeNode bookmark) {...};
+ */
addListener(callback: (id: string, bookmark: BookmarkTreeNode) => void): void;
}
interface BookmarkChildrenReordered extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id, object reorderInfo) {...};
+ */
addListener(callback: (id: string, reorderInfo: BookmarkReorderInfo) => void): void;
}
+ interface BookmarkSearchQuery {
+ query?: string;
+ url?: string;
+ title?: string;
+ }
+
+ interface BookmarkCreateArg {
+ /** Optional. Defaults to the Other Bookmarks folder. */
+ parentId?: string;
+ index?: number;
+ title?: string;
+ url?: string;
+ }
+
+ interface BookmarkDestinationArg {
+ parentId?: string;
+ index?: number;
+ }
+
+ interface BookmarkChangesArg {
+ title?: string;
+ url?: string;
+ }
+
+ /** @deprecated since Chrome 38. Bookmark write operations are no longer limited by Chrome. */
var MAX_WRITE_OPERATIONS_PER_HOUR: number;
+ /** @deprecated since Chrome 38. Bookmark write operations are no longer limited by Chrome. */
var MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE: number;
+ /**
+ * Searches for BookmarkTreeNodes matching the given query. Queries specified with an object produce BookmarkTreeNodes matching all specified properties.
+ * @param query A string of words and quoted phrases that are matched against bookmark URLs and titles.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function search(query: string, callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Searches for BookmarkTreeNodes matching the given query. Queries specified with an object produce BookmarkTreeNodes matching all specified properties.
+ * @param query An object with one or more of the properties query, url, and title specified. Bookmarks matching all specified properties will be produced.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
+ export function search(query: BookmarkSearchQuery, callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Retrieves the entire Bookmarks hierarchy.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function getTree(callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Retrieves the recently added bookmarks.
+ * @param numberOfItems The maximum number of items to return.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function getRecent(numberOfItems: number, callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Retrieves the specified BookmarkTreeNode.
+ * @param id A single string-valued id
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function get(id: string, callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Retrieves the specified BookmarkTreeNode.
+ * @param idList An array of string-valued ids
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function get(idList: string[], callback: (results: BookmarkTreeNode[]) => void): void;
- export function create(bookmark: Object, callback?: (result: BookmarkTreeNode) => void): void;
- export function move(id: string, destination: Object, callback?: (result: BookmarkTreeNode) => void): void;
- export function update(id: string, changes: Object, callback?: (result: BookmarkTreeNode) => void): void;
+ /**
+ * Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( BookmarkTreeNode result) {...};
+ */
+ export function create(bookmark: BookmarkCreateArg, callback?: (result: BookmarkTreeNode) => void): void;
+ /**
+ * Moves the specified BookmarkTreeNode to the provided location.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( BookmarkTreeNode result) {...};
+ */
+ export function move(id: string, destination: BookmarkDestinationArg, callback?: (result: BookmarkTreeNode) => void): void;
+ /**
+ * Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties will be left unchanged. Note: Currently, only 'title' and 'url' are supported.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( BookmarkTreeNode result) {...};
+ */
+ export function update(id: string, changes: BookmarkChangesArg, callback?: (result: BookmarkTreeNode) => void): void;
+ /**
+ * Removes a bookmark or an empty bookmark folder.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function remove(id: string, callback?: Function): void;
+ /**
+ * Retrieves the children of the specified BookmarkTreeNode id.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function getChildren(id: string, callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Since Chrome 14.
+ * Retrieves part of the Bookmarks hierarchy, starting at the specified node.
+ * @param id The ID of the root of the subtree to retrieve.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of BookmarkTreeNode results) {...};
+ */
export function getSubTree(id: string, callback: (results: BookmarkTreeNode[]) => void): void;
+ /**
+ * Recursively removes a bookmark folder.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function removeTree(id: string, callback?: Function): void;
+ /** Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents. */
var onRemoved: BookmarkRemovedEvent;
+ /** Fired when a bookmark import session is ended. */
var onImportEnded: BookmarkImportEndedEvent;
+ /** Fired when a bookmark import session is begun. Expensive observers should ignore onCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately. */
var onImportBegan: BookmarkImportBeganEvent;
+ /** Fired when a bookmark or folder changes. Note: Currently, only title and url changes trigger this. */
var onChanged: BookmarkChangedEvent;
+ /** Fired when a bookmark or folder is moved to a different parent folder. */
var onMoved: BookmarkMovedEvent;
+ /** Fired when a bookmark or folder is created. */
var onCreated: BookmarkCreatedEvent;
+ /** Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a move(). */
var onChildrenReordered: BookmarkChildrenReordered;
}
////////////////////
// Browser Action
////////////////////
+/**
+ * Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup.
+ * Availability: Since Chrome 5.
+ * Manifest: "browser_action": {...}
+ */
declare module chrome.browserAction {
interface BadgeBackgroundColorDetails {
+ /** An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is [255, 0, 0, 255]. Can also be a string with a CSS value, with opaque red being #FF0000 or #F00. */
color: any;
+ /** Optional. Limits the change to when a particular tab is selected. Automatically resets when the tab is closed. */
tabId?: number;
}
interface BadgeTextDetails {
+ /** Any number of characters can be passed, but only about four can fit in the space. */
text: string;
+ /** Optional. Limits the change to when a particular tab is selected. Automatically resets when the tab is closed. */
tabId?: number;
}
interface TitleDetails {
+ /** The string the browser action should display when moused over. */
title: string;
+ /** Optional. Limits the change to when a particular tab is selected. Automatically resets when the tab is closed. */
tabId?: number;
}
interface TabDetails {
+ /** Optional. Specify the tab to get the information. If no tab is specified, the non-tab-specific information is returned. */
tabId?: number;
}
interface TabIconDetails {
+ /** Optional. Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}' */
path?: any;
+ /** Optional. Limits the change to when a particular tab is selected. Automatically resets when the tab is closed. */
tabId?: number;
+ /** Optional. Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}' */
imageData?: ImageData;
}
interface PopupDetails {
+ /** Optional. Limits the change to when a particular tab is selected. Automatically resets when the tab is closed. */
tabId?: number;
+ /** The html file to show in a popup. If set to the empty string (''), no popup is shown. */
popup: string;
}
interface BrowserClickedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( tabs.Tab tab) {...};
+ */
addListener(callback: (tab: chrome.tabs.Tab) => void): void;
}
+ /**
+ * Since Chrome 22.
+ * Enables the browser action for a tab. By default, browser actions are enabled.
+ * @param tabId The id of the tab for which you want to modify the browser action.
+ */
export function enable(tabId?: number): void;
+ /** Sets the background color for the badge. */
export function setBadgeBackgroundColor(details: BadgeBackgroundColorDetails): void;
+ /** Sets the badge text for the browser action. The badge is displayed on top of the icon. */
export function setBadgeText(details: BadgeTextDetails): void;
+ /** Sets the title of the browser action. This shows up in the tooltip. */
export function setTitle(details: TitleDetails): void;
+ /**
+ * Since Chrome 19.
+ * Gets the badge text of the browser action. If no tab is specified, the non-tab-specific badge text is returned.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string result) {...};
+ */
export function getBadgeText(details: TabDetails, callback: (result: string) => void): void;
+ /** Sets the html document to be opened as a popup when the user clicks on the browser action's icon. */
export function setPopup(details: PopupDetails): void;
+ /**
+ * Since Chrome 22.
+ * Disables the browser action for a tab.
+ * @param tabId The id of the tab for which you want to modify the browser action.
+ */
export function disable(tabId?: number): void;
+ /**
+ * Since Chrome 19.
+ * Gets the title of the browser action.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string result) {...};
+ */
export function getTitle(details: TabDetails, callback: (result: string) => void): void;
+ /**
+ * Since Chrome 19.
+ * Gets the background color of the browser action.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( ColorArray result) {...};
+ */
export function getBadgeBackgroundColor(details: TabDetails, callback: (result: number[]) => void): void;
+ /**
+ * Since Chrome 19.
+ * Gets the html document set as the popup for this browser action.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string result) {...};
+ */
export function getPopup(details: TabDetails, callback: (result: string) => void): void;
+ /**
+ * Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the path or the imageData property must be specified.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function setIcon(details: TabIconDetails, callback?: Function): void;
+ /** Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup. */
var onClicked: BrowserClickedEvent;
}
////////////////////
// Browsing Data
////////////////////
+/**
+ * Use the chrome.browsingData API to remove browsing data from a user's local profile.
+ * Availability: Since Chrome 19.
+ * Permissions: "browsingData"
+ */
declare module chrome.browsingData {
interface OriginTypes {
+ /** Optional. Websites that have been installed as hosted applications (be careful!). */
protectedWeb?: boolean;
+ /** Optional. Extensions and packaged applications a user has installed (be _really_ careful!). */
extension?: boolean;
+ /** Optional. Normal websites. */
unprotectedWeb?: boolean;
}
+ /** Options that determine exactly what data will be removed. */
interface RemovalOptions {
+ /**
+ * Optional.
+ * Since Chrome 21.
+ * An object whose properties specify which origin types ought to be cleared. If this object isn't specified, it defaults to clearing only "unprotected" origins. Please ensure that you really want to remove application data before adding 'protectedWeb' or 'extensions'.
+ */
originTypes?: OriginTypes;
+ /** Optional. Remove data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the getTime method of the JavaScript Date object). If absent, defaults to 0 (which would remove all browsing data). */
since?: number;
}
- interface DataToRemove {
+ /**
+ * Since Chrome 27.
+ * A set of data types. Missing data types are interpreted as false.
+ */
+ interface DataTypeSet {
+ /** Optional. Websites' WebSQL data. */
webSQL?: boolean;
+ /** Optional. Websites' IndexedDB data. */
indexedDB?: boolean;
+ /** Optional. The browser's cookies. */
cookies?: boolean;
+ /** Optional. Stored passwords. */
passwords?: boolean;
+ /** Optional. Server-bound certificates. */
serverBoundCertificates?: boolean;
+ /** Optional. The browser's download list. */
downloads?: boolean;
+ /** Optional. The browser's cache. Note: when removing data, this clears the entire cache: it is not limited to the range you specify. */
cache?: boolean;
+ /** Optional. Websites' appcaches. */
appcache?: boolean;
+ /** Optional. Websites' file systems. */
fileSystems?: boolean;
+ /** Optional. Plugins' data. */
pluginData?: boolean;
+ /** Optional. Websites' local storage data. */
localStorage?: boolean;
+ /** Optional. The browser's stored form data. */
formData?: boolean;
+ /** Optional. The browser's history. */
history?: boolean;
+ /**
+ * Optional.
+ * Since Chrome 39.
+ * Service Workers.
+ */
+ serviceWorkers?: boolean;
}
- export function removePluginData(options: RemovalOptions, callback?: Function): void;
- export function removeFormData(options: RemovalOptions, callback?: Function): void;
- export function removeFileSystems(options: RemovalOptions, callback?: Function): void;
- export function remove(options: RemovalOptions, dataToRemove: DataToRemove, callback?: Function): void;
- export function removePasswords(options: RemovalOptions, callback?: Function): void;
- export function removeCookies(options: RemovalOptions, callback?: Function): void;
- export function removeWebSQL(options: RemovalOptions, callback?: Function): void;
- export function removeAppcache(options: RemovalOptions, callback?: Function): void;
- export function removeDownloads(options: RemovalOptions, callback?: Function): void;
- export function removeLocalStorage(options: RemovalOptions, callback?: Function): void;
- export function removeCache(options: RemovalOptions, callback?: Function): void;
- export function removeHistory(options: RemovalOptions, callback?: Function): void;
- export function removeIndexedDB(options: RemovalOptions, callback?: Function): void;
+ interface SettingsCallback {
+ options: RemovalOptions;
+ /** All of the types will be present in the result, with values of true if they are both selected to be removed and permitted to be removed, otherwise false. */
+ dataToRemove: DataTypeSet;
+ /** All of the types will be present in the result, with values of true if they are permitted to be removed (e.g., by enterprise policy) and false if not. */
+ dataRemovalPermitted: DataTypeSet;
+ }
+
+ /**
+ * Since Chrome 26.
+ * Reports which types of data are currently selected in the 'Clear browsing data' settings UI. Note: some of the data types included in this API are not available in the settings UI, and some UI settings control more than one data type listed here.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object result) {...};
+ */
+ export function settings(callback: (result: SettingsCallback) => void): void;
+ /**
+ * Clears plugins' data.
+ * @param callback Called when plugins' data has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removePluginData(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears the browser's stored form data (autofill).
+ * @param callback Called when the browser's form data has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeFormData(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears websites' file system data.
+ * @param callback Called when websites' file systems have been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeFileSystems(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears various types of browsing data stored in a user's profile.
+ * @param dataToRemove The set of data types to remove.
+ * @param callback Called when deletion has completed.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function remove(options: RemovalOptions, dataToRemove: DataTypeSet, callback?: () => void): void;
+ /**
+ * Clears the browser's stored passwords.
+ * @param callback Called when the browser's passwords have been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removePasswords(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears the browser's cookies and server-bound certificates modified within a particular timeframe.
+ * @param callback Called when the browser's cookies and server-bound certificates have been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeCookies(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears websites' WebSQL data.
+ * @param callback Called when websites' WebSQL databases have been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeWebSQL(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears websites' appcache data.
+ * @param callback Called when websites' appcache data has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeAppcache(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears the browser's list of downloaded files (not the downloaded files themselves).
+ * @param callback Called when the browser's list of downloaded files has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeDownloads(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears websites' local storage data.
+ * @param callback Called when websites' local storage has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeLocalStorage(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears the browser's cache.
+ * @param callback Called when the browser's cache has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeCache(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears the browser's history.
+ * @param callback Called when the browser's history has cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeHistory(options: RemovalOptions, callback?: () => void): void;
+ /**
+ * Clears websites' IndexedDB data.
+ * @param callback Called when websites' IndexedDB data has been cleared.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeIndexedDB(options: RemovalOptions, callback?: () => void): void;
}
////////////////////
// Commands
////////////////////
+/**
+ * Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.
+ * Availability: Since Chrome 25.
+ * Manifest: "commands": {...}
+ */
declare module chrome.commands {
+ interface Command {
+ /** Optional. The name of the Extension Command */
+ name?: string;
+ /** Optional. The Extension Command description */
+ description?: string;
+ /** Optional. The shortcut active for this command, or blank if not active. */
+ shortcut?: string;
+ }
+
interface CommandEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string command) {...};
+ */
addListener(callback: (command: string) => void): void;
}
+ /**
+ * Returns all the registered extension commands for this extension and their shortcut (if active).
+ * @param callback Called to return the registered commands.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(array of Command commands) {...};
+ */
+ export function getAll(callback: (commands: Command[]) => void): void;
+
+ /** Fired when a registered command is activated using a keyboard shortcut. */
var onCommand: CommandEvent;
}
////////////////////
// Content Settings
////////////////////
+/**
+ * Use the chrome.contentSettings API to change settings that control whether websites can use features such as cookies, JavaScript, and plugins. More generally speaking, content settings allow you to customize Chrome's behavior on a per-site basis instead of globally.
+ * Availability: Since Chrome 16.
+ * Permissions: "contentSettings"
+ */
declare module chrome.contentSettings {
interface ClearDetails {
+ /**
+ * Optional.
+ * Where to clear the setting (default: regular).
+ * The scope of the ContentSetting. One of
+ * * regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
+ * * incognito_session_only: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings).
+ */
scope?: string;
}
interface SetDetails {
+ /** Optional. The resource identifier for the content type. */
resourceIdentifier?: ResourceIdentifier;
+ /** The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values. */
setting: any;
+ /** Optional. The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see Content Setting Patterns. */
secondaryPattern?: string;
+ /** Optional. Where to set the setting (default: regular). */
scope?: string;
+ /** The pattern for the primary URL. For details on the format of a pattern, see Content Setting Patterns. */
primaryPattern: string;
}
interface GetDetails {
+ /** Optional. The secondary URL for which the content setting should be retrieved. Defaults to the primary URL. Note that the meaning of a secondary URL depends on the content type, and not all content types use secondary URLs. */
secondaryUrl?: string;
+ /** Optional. A more specific identifier of the type of content for which the settings should be retrieved. */
resourceIdentifier?: ResourceIdentifier;
+ /** Optional. Whether to check the content settings for an incognito session. (default false) */
incognito?: boolean;
+ /** The primary URL for which the content setting should be retrieved. Note that the meaning of a primary URL depends on the content type. */
primaryUrl: string;
}
interface ReturnedDetails {
+ /** The content setting. See the description of the individual ContentSetting objects for the possible values. */
setting: any;
}
interface ContentSetting {
- clear(details: ClearDetails, callback?: Function): void;
- set(details: SetDetails, callback?: Function): void;
- getResourceIdentifiers(callback: (resourceIdentifiers: ResourceIdentifier[]) => void): void;
+ /**
+ * Clear all content setting rules set by this extension.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ clear(details: ClearDetails, callback?: () => void): void;
+ /**
+ * Applies a new content setting rule.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ set(details: SetDetails, callback?: () => void): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of ResourceIdentifier resourceIdentifiers) {...};
+ * Parameter resourceIdentifiers: A list of resource identifiers for this content type, or undefined if this content type does not use resource identifiers.
+ */
+ getResourceIdentifiers(callback: (resourceIdentifiers?: ResourceIdentifier[]) => void): void;
+ /**
+ * Gets the current content setting for a given pair of URLs.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
get(details: GetDetails, callback: (details: ReturnedDetails) => void): void;
}
+ /** The only content type using resource identifiers is contentSettings.plugins. For more information, see Resource Identifiers. */
interface ResourceIdentifier {
+ /** The resource identifier for the given content type. */
id: string;
+ /** Optional. A human readable description of the resource. */
description?: string;
}
+ /**
+ * Whether to allow cookies and other local data to be set by websites. One of
+ * allow: Accept cookies,
+ * block: Block cookies,
+ * session_only: Accept cookies only for the current session.
+ * Default is allow.
+ * The primary URL is the URL representing the cookie origin. The secondary URL is the URL of the top-level frame.
+ */
var cookies: ContentSetting;
+ /**
+ * Whether to allow sites to show pop-ups. One of
+ * allow: Allow sites to show pop-ups,
+ * block: Don't allow sites to show pop-ups.
+ * Default is block.
+ * The primary URL is the URL of the top-level frame. The secondary URL is not used.
+ */
var popups: ContentSetting;
+ /**
+ * Whether to run JavaScript. One of
+ * allow: Run JavaScript,
+ * block: Don't run JavaScript.
+ * Default is allow.
+ * The primary URL is the URL of the top-level frame. The secondary URL is not used.
+ */
var javascript: ContentSetting;
+ /**
+ * Whether to allow sites to show desktop notifications. One of
+ * allow: Allow sites to show desktop notifications,
+ * block: Don't allow sites to show desktop notifications,
+ * ask: Ask when a site wants to show desktop notifications.
+ * Default is ask.
+ * The primary URL is the URL of the document which wants to show the notification. The secondary URL is not used.
+ */
var notifications: ContentSetting;
+ /**
+ * Whether to run plugins. One of
+ * allow: Run plugins automatically,
+ * block: Don't run plugins automatically,
+ * detect_important_content: Only run automatically those plugins that are detected as the website's main content.
+ * Default is allow.
+ * The primary URL is the URL of the top-level frame. The secondary URL is not used.
+ */
var plugins: ContentSetting;
+ /**
+ * Whether to show images. One of
+ * allow: Show images,
+ * block: Don't show images.
+ * Default is allow.
+ * The primary URL is the URL of the top-level frame. The secondary URL is the URL of the image.
+ */
var images: ContentSetting;
+ /**
+ * Since Chrome 42.
+ * Whether to allow Geolocation. One of
+ * allow: Allow sites to track your physical location,
+ * block: Don't allow sites to track your physical location,
+ * ask: Ask before allowing sites to track your physical location.
+ * Default is ask.
+ * The primary URL is the URL of the document which requested location data. The secondary URL is the URL of the top-level frame (which may or may not differ from the requesting URL).
+ */
+ var location: ContentSetting;
+ /**
+ * Since Chrome 42.
+ * Whether to allow sites to toggle the fullscreen mode. One of
+ * allow: Allow sites to toggle the fullscreen mode,
+ * ask: Ask when a site wants to toggle the fullscreen mode.
+ * Default is ask.
+ * The primary URL is the URL of the document which requested to toggle the fullscreen mode. The secondary URL is the URL of the top-level frame (which may or may not differ from the requesting URL).
+ */
+ var fullscreen: ContentSetting;
+ /**
+ * Since Chrome 42.
+ * Whether to allow sites to disable the mouse cursor. One of
+ * allow: Allow sites to disable the mouse cursor,
+ * block: Don't allow sites to disable the mouse cursor,
+ * ask: Ask when a site wants to disable the mouse cursor.
+ * Default is ask.
+ * The primary URL is the URL of the top-level frame. The secondary URL is not used.
+ */
+ var mouselock: ContentSetting;
+ /**
+ * Since Chrome 42.
+ * Whether to allow sites to run plugins unsandboxed. One of
+ * allow: Allow sites to run plugins unsandboxed,
+ * block: Don't allow sites to run plugins unsandboxed,
+ * ask: Ask when a site wants to run a plugin unsandboxed.
+ * Default is ask.
+ * The primary URL is the URL of the top-level frame. The secondary URL is not used.
+ */
+ var unsandboxedPlugins: ContentSetting;
+ /**
+ * Since Chrome 42.
+ * Whether to allow sites to download multiple files automatically. One of
+ * allow: Allow sites to download multiple files automatically,
+ * block: Don't allow sites to download multiple files automatically,
+ * ask: Ask when a site wants to download files automatically after the first file.
+ * Default is ask.
+ * The primary URL is the URL of the top-level frame. The secondary URL is not used.
+ */
+ var automaticDownloads: ContentSetting;
}
////////////////////
// Context Menus
////////////////////
+/**
+ * Use the chrome.contextMenus API to add items to Google Chrome's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.
+ * Availability: Since Chrome 6.
+ * Permissions: "contextMenus"
+ */
declare module chrome.contextMenus {
interface OnClickData {
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * The text for the context selection, if any.
+ */
selectionText?: string;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * A flag indicating the state of a checkbox or radio item after it is clicked.
+ */
checked?: boolean;
+ /**
+ * Since Chrome 35.
+ * The ID of the menu item that was clicked.
+ */
menuItemId: any;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * The URL of the frame of the element where the context menu was clicked, if it was in a frame.
+ */
frameUrl?: string;
+ /**
+ * Since Chrome 35.
+ * A flag indicating whether the element is editable (text input, textarea, etc.).
+ */
editable: boolean;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.
+ */
mediaType?: string;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * A flag indicating the state of a checkbox or radio item before it was clicked.
+ */
wasChecked?: boolean;
+ /**
+ * Since Chrome 35.
+ * The URL of the page where the menu item was clicked. This property is not set if the click occured in a context where there is no current page, such as in a launcher context menu.
+ */
pageUrl: string;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * If the element is a link, the URL it points to.
+ */
linkUrl?: string;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * The parent ID, if any, for the item clicked.
+ */
parentMenuItemId?: any;
+ /**
+ * Optional.
+ * Since Chrome 35.
+ * Will be present for elements with a 'src' URL.
+ */
srcUrl?: string;
}
interface CreateProperties {
+ /** Optional. Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see Match Patterns. */
documentUrlPatterns?: string[];
+ /** Optional. The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items. */
checked?: boolean;
+ /** Optional. The text to be displayed in the item; this is required unless type is 'separator'. When the context is 'selection', you can use %s within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin". */
title?: string;
+ /** Optional. List of contexts this menu item will appear in. Defaults to ['page'] if not specified. */
contexts?: string[];
+ /**
+ * Optional.
+ * Since Chrome 20.
+ * Whether this context menu item is enabled or disabled. Defaults to true.
+ */
enabled?: boolean;
+ /** Optional. Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags. */
targetUrlPatterns?: string[];
+ /**
+ * Optional.
+ * A function that will be called back when the menu item is clicked. Event pages cannot use this; instead, they should register a listener for chrome.contextMenus.onClicked.
+ * @param info Information sent when a context menu item is clicked.
+ * @param tab The details of the tab where the click took place. Note: this parameter only present for extensions.
+ */
onclick?: (info: OnClickData, tab: chrome.tabs.Tab) => void;
+ /** Optional. The ID of a parent menu item; this makes the item a child of a previously added item. */
parentId?: any;
+ /** Optional. The type of menu item. Defaults to 'normal' if not specified. */
type?: string;
+ /**
+ * Optional.
+ * Since Chrome 21.
+ * The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
+ */
id?: string;
}
@@ -356,66 +1109,163 @@ declare module chrome.contextMenus {
checked?: boolean;
title?: string;
contexts?: string[];
+ /** Optional. Since Chrome 20. */
enabled?: boolean;
targetUrlPatterns?: string[];
onclick?: Function;
+ /** Optional. Note: You cannot change an item to be a child of one of its own descendants. */
parentId?: any;
type?: string;
}
interface MenuClickedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object info, tabs.Tab tab) {...};
+ * Parameter info: Information sent when a context menu item is clicked.
+ * Parameter tab: The details of the tab where the click took place. If the click did not take place in a tab, this parameter will be missing.
+ */
addListener(callback: (info: OnClickData, tab?: chrome.tabs.Tab) => void): void;
}
- export function removeAll(callback?: Function): void;
- export function create(createProperties: CreateProperties, callback?: Function): void;
- export function update(id: any, updateProperties: UpdateProperties, callback?: Function): void;
- export function remove(menuItemId: any, callback?: Function): void;
+ /**
+ * Since Chrome 38.
+ * The maximum number of top level extension items that can be added to an extension action context menu. Any items beyond this limit will be ignored.
+ */
+ var ACTION_MENU_TOP_LEVEL_LIMIT: number;
+ /**
+ * Removes all context menu items added by this extension.
+ * @param callback Called when removal is complete.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeAll(callback?: () => void): void;
+ /**
+ * Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.runtime.lastError).
+ * @param callback Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.runtime.lastError.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function create(createProperties: CreateProperties, callback?: () => void): void;
+ /**
+ * Updates a previously created context menu item.
+ * @param id The ID of the item to update.
+ * @param updateProperties The properties to update. Accepts the same values as the create function.
+ * @param callback Called when the context menu has been updated.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function update(id: string, updateProperties: UpdateProperties, callback?: () => void): void;
+ /**
+ * Updates a previously created context menu item.
+ * @param id The ID of the item to update.
+ * @param updateProperties The properties to update. Accepts the same values as the create function.
+ * @param callback Called when the context menu has been updated.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function update(id: number, updateProperties: UpdateProperties, callback?: () => void): void;
+ /**
+ * Removes a context menu item.
+ * @param menuItemId The ID of the context menu item to remove.
+ * @param callback Called when the context menu has been removed.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function remove(menuItemId: string, callback?: () => void): void;
+ /**
+ * Removes a context menu item.
+ * @param menuItemId The ID of the context menu item to remove.
+ * @param callback Called when the context menu has been removed.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function remove(menuItemId: number, callback?: () => void): void;
+
+ /**
+ * Since Chrome 21.
+ * Fired when a context menu item is clicked.
+ */
var onClicked: MenuClickedEvent;
}
////////////////////
// Cookies
////////////////////
+/**
+ * Use the chrome.cookies API to query and modify cookies, and to be notified when they change.
+ * Availability: Since Chrome 6.
+ * Permissions: "cookies", host permissions
+ */
declare module chrome.cookies {
+ /** Represents information about an HTTP cookie. */
interface Cookie {
+ /** The domain of the cookie (e.g. "www.google.com", "example.com"). */
domain: string;
+ /** The name of the cookie. */
name: string;
+ /** The ID of the cookie store containing this cookie, as provided in getAllCookieStores(). */
storeId: string;
+ /** The value of the cookie. */
value: string;
+ /** True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date. */
session: boolean;
+ /** True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie). */
hostOnly: boolean;
+ /** Optional. The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies. */
expirationDate?: number;
+ /** The path of the cookie. */
path: string;
+ /** True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts). */
httpOnly: boolean;
+ /** True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS). */
secure: boolean;
}
+ /** Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window. */
interface CookieStore {
+ /** The unique identifier for the cookie store. */
id: string;
+ /** Identifiers of all the browser tabs that share this cookie store. */
tabIds: number[];
}
interface GetAllDetails {
+ /** Optional. Restricts the retrieved cookies to those whose domains match or are subdomains of this one. */
domain?: string;
+ /** Optional. Filters the cookies by name. */
name?: string;
+ /** Optional. Restricts the retrieved cookies to those that would match the given URL. */
url?: string;
+ /** Optional. The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used. */
storeId?: string;
+ /** Optional. Filters out session vs. persistent cookies. */
session?: boolean;
+ /** Optional. Restricts the retrieved cookies to those whose path exactly matches this string. */
path?: string;
+ /** Optional. Filters the cookies by their Secure property. */
secure?: boolean;
}
interface SetDetails {
+ /** Optional. The domain of the cookie. If omitted, the cookie becomes a host-only cookie. */
domain?: string;
+ /** Optional. The name of the cookie. Empty by default if omitted. */
name?: string;
+ /** The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail. */
url: string;
+ /** Optional. The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store. */
storeId?: string;
+ /** Optional. The value of the cookie. Empty by default if omitted. */
value?: string;
+ /** Optional. The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. */
expirationDate?: number;
+ /** Optional. The path of the cookie. Defaults to the path portion of the url parameter. */
path?: string;
+ /** Optional. Whether the cookie should be marked as HttpOnly. Defaults to false. */
httpOnly?: boolean;
+ /** Optional. Whether the cookie should be marked as Secure. Defaults to false. */
secure?: boolean;
}
@@ -426,48 +1276,257 @@ declare module chrome.cookies {
}
interface CookieChangeInfo {
+ /** Information about the cookie that was set or removed. */
cookie: Cookie;
+ /** True if a cookie was removed. */
removed: boolean;
+ /**
+ * Since Chrome 12.
+ * The underlying reason behind the cookie's change.
+ */
cause: string;
}
interface CookieChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object changeInfo) {...};
+ */
addListener(callback: (changeInfo: CookieChangeInfo) => void): void;
}
+ /**
+ * Lists all existing cookie stores.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of CookieStore cookieStores) {...};
+ * Parameter cookieStores: All the existing cookie stores.
+ */
export function getAllCookieStores(callback: (cookieStores: CookieStore[]) => void): void;
+ /**
+ * Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.
+ * @param details Information to filter the cookies being retrieved.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of Cookie cookies) {...};
+ * Parameter cookies: All the existing, unexpired cookies that match the given cookie info.
+ */
export function getAll(details: GetAllDetails, callback: (cookies: Cookie[]) => void): void;
+ /**
+ * Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
+ * @param details Details about the cookie being set.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( Cookie cookie) {...};
+ * Optional parameter cookie: Contains details about the cookie that's been set. If setting failed for any reason, this will be "null", and "chrome.runtime.lastError" will be set.
+ */
export function set(details: SetDetails, callback?: (cookie?: Cookie) => void): void;
+ /**
+ * Deletes a cookie by name.
+ * @param details Information to identify the cookie to remove.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(object details) {...};
+ */
export function remove(details: Details, callback?: (details: Details) => void): void;
+ /**
+ * Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.
+ * @param details Details to identify the cookie being retrieved.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Cookie cookie) {...};
+ * Parameter cookie: Contains details about the cookie. This parameter is null if no such cookie was found.
+ */
export function get(details: Details, callback: (cookie?: Cookie) => void): void;
+ /** Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit". */
var onChanged: CookieChangedEvent;
}
////////////////////
// Debugger
////////////////////
+/**
+ * The chrome.debugger API serves as an alternate transport for Chrome's remote debugging protocol. Use chrome.debugger to attach to one or more tabs to instrument network interaction, debug JavaScript, mutate the DOM and CSS, etc. Use the Debuggee tabId to target tabs with sendCommand and route events by tabId from onEvent callbacks.
+ * Availability: Since Chrome 18.
+ * Permissions: "debugger"
+ */
declare module "chrome.debugger" {
+ /** Debuggee identifier. Either tabId or extensionId must be specified */
interface Debuggee {
- tabId: number;
+ /** Optional. The id of the tab which you intend to debug. */
+ tabId?: number;
+ /**
+ * Optional.
+ * Since Chrome 27.
+ * The id of the extension which you intend to debug. Attaching to an extension background page is only possible when 'silent-debugger-extension-api' flag is enabled on the target browser.
+ */
+ extensionId?: string;
+ /**
+ * Optional.
+ * Since Chrome 28.
+ * The opaque id of the debug target.
+ */
+ targetId?: string;
+ }
+
+ /**
+ * Since Chrome 28.
+ * Debug target information
+ */
+ interface TargetInfo {
+ /** Target type. */
+ type: string;
+ /** Target id. */
+ id: string;
+ /**
+ * Optional.
+ * Since Chrome 30.
+ * The tab id, defined if type == 'page'.
+ */
+ tabId?: number;
+ /**
+ * Optional.
+ * Since Chrome 30.
+ * The extension id, defined if type = 'background_page'.
+ */
+ extensionId?: string;
+ /** True if debugger is already attached. */
+ attached: boolean;
+ /** Target page title. */
+ title: string;
+ /** Target URL. */
+ url: string;
+ /** Optional. Target favicon URL. */
+ faviconUrl?: string;
}
interface DebuggerDetachedEvent extends chrome.events.Event {
- addListener(callback: (source: Debuggee) => void): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Debuggee source, DetachReason reason) {...};
+ * Parameter source: The debuggee that was detached.
+ * Parameter reason: Since Chrome 24. Connection termination reason.
+ */
+ addListener(callback: (source: Debuggee, reason: string) => void): void;
}
interface DebuggerEventEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Debuggee source, string method, object params) {...};
+ * Parameter source: The debuggee that generated this event.
+ * Parameter method: Method name. Should be one of the notifications defined by the remote debugging protocol.
+ * Parameter params: JSON object with the parameters. Structure of the parameters varies depending on the method name and is defined by the 'parameters' attribute of the event description in the remote debugging protocol.
+ */
addListener(callback: (source: Debuggee, method: string, params?: Object) => void): void;
}
- export function attach(target: Debuggee, requiredVersion: string, callback?: Function): void;
- export function detach(target: Debuggee, callback?: Function): void;
- export function sendCommand(target: Debuggee, method: string, commandParams?: Object, callback?: (result: Object) => void): void;
+ /**
+ * Attaches debugger to the given target.
+ * @param target Debugging target to which you want to attach.
+ * @param requiredVersion Required debugging protocol version ("0.1"). One can only attach to the debuggee with matching major version and greater or equal minor version. List of the protocol versions can be obtained in the documentation pages.
+ * @param callback Called once the attach operation succeeds or fails. Callback receives no arguments. If the attach fails, runtime.lastError will be set to the error message.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function attach(target: Debuggee, requiredVersion: string, callback?: () => void): void;
+ /**
+ * Detaches debugger from the given target.
+ * @param target Debugging target from which you want to detach.
+ * @param callback Called once the detach operation succeeds or fails. Callback receives no arguments. If the detach fails, runtime.lastError will be set to the error message.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function detach(target: Debuggee, callback?: () => void): void;
+ /**
+ * Sends given command to the debugging target.
+ * @param target Debugging target to which you want to send the command.
+ * @param method Method name. Should be one of the methods defined by the remote debugging protocol.
+ * @param commandParams Since Chrome 22.
+ * JSON object with request parameters. This object must conform to the remote debugging params scheme for given method.
+ * @param callback Response body. If an error occurs while posting the message, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(object result) {...};
+ */
+ export function sendCommand(target: Debuggee, method: string, commandParams?: Object, callback?: (result?: Object) => void): void;
+ /**
+ * Since Chrome 28.
+ * Returns the list of available debug targets.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of TargetInfo result) {...};
+ * Parameter result: Array of TargetInfo objects corresponding to the available debug targets.
+ */
+ export function getTargets(callback: (result: TargetInfo[]) => void): void;
+ /** Fired when browser terminates debugging session for the tab. This happens when either the tab is being closed or Chrome DevTools is being invoked for the attached tab. */
var onDetach: DebuggerDetachedEvent;
+ /** Fired whenever debugging target issues instrumentation event. */
var onEvent: DebuggerEventEvent;
}
+////////////////////
+// Declarative Content
+////////////////////
+/**
+ * Use the chrome.declarativeContent API to take actions depending on the content of a page, without requiring permission to read the page's content.
+ * Availability: Since Chrome 33.
+ * Permissions: "declarativeContent"
+ */
+declare module chrome.declarativeContent {
+ interface PageStateUrlDetails {
+ /** Optional. Matches if the host name of the URL contains a specified string. To test whether a host name component has a prefix 'foo', use hostContains: '.foo'. This matches 'www.foobar.com' and 'foo.com', because an implicit dot is added at the beginning of the host name. Similarly, hostContains can be used to match against component suffix ('foo.') and to exactly match against components ('.foo.'). Suffix- and exact-matching for the last components need to be done separately using hostSuffix, because no implicit dot is added at the end of the host name. */
+ hostContains?: string;
+ /** Optional. Matches if the host name of the URL is equal to a specified string. */
+ hostEquals?: string;
+ /** Optional. Matches if the host name of the URL starts with a specified string. */
+ hostPrefix?: string;
+ /** Optional. Matches if the host name of the URL ends with a specified string. */
+ hostSuffix?: string;
+ /** Optional. Matches if the path segment of the URL contains a specified string. */
+ pathContains?: string;
+ /** Optional. Matches if the path segment of the URL is equal to a specified string. */
+ pathEquals?: string;
+ /** Optional. Matches if the path segment of the URL starts with a specified string. */
+ pathPrefix?: string;
+ /** Optional. Matches if the path segment of the URL ends with a specified string. */
+ pathSuffix?: string;
+ /** Optional. Matches if the query segment of the URL contains a specified string. */
+ queryContains?: string;
+ /** Optional. Matches if the query segment of the URL is equal to a specified string. */
+ queryEquals?: string;
+ /** Optional. Matches if the query segment of the URL starts with a specified string. */
+ queryPrefix?: string;
+ /** Optional. Matches if the query segment of the URL ends with a specified string. */
+ querySuffix?: string;
+ /** Optional. Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if they match the default port number. */
+ urlContains?: string;
+ /** Optional. Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL if they match the default port number. */
+ urlEquals?: string;
+ /** Optional. Matches if the URL (without fragment identifier) matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the RE2 syntax. */
+ urlMatches?: string;
+ /** Optional. Matches if the URL without query segment and fragment identifier matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the RE2 syntax. */
+ originAndPathMatches?: string;
+ /** Optional. Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL if they match the default port number. */
+ urlPrefix?: string;
+ /** Optional. Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number. */
+ urlSuffix?: string;
+ /** Optional. Matches if the scheme of the URL is equal to any of the schemes specified in the array. */
+ schemes?: string[];
+ /** Optional. Matches if the port of the URL is contained in any of the specified port lists. For example [80, 443, [1000, 1200]] matches all requests on port 80, 443 and in the range 1000-1200. */
+ port?: any[];
+ }
+
+ /** Matches the state of a web page by various criteria. */
+ interface PageStateMatcher {
+ /** Optional. Filters URLs for various criteria. See event filtering. All criteria are case sensitive. */
+ pageUrl?: PageStateUrlDetails;
+ /** Optional. Matches if all of the CSS selectors in the array match displayed elements in a frame with the same origin as the page's main frame. All selectors in this array must be compound selectors to speed up matching. Note that listing hundreds of CSS selectors or CSS selectors that match hundreds of times per page can still slow down web sites. */
+ css?: string[];
+ /**
+ * Optional.
+ * Since Chrome 45. Warning: this is the current Beta channel. More information available on the API documentation pages.
+ * Matches if the bookmarked state of the page is equal to the specified value. Requres the bookmarks permission.
+ */
+ isBookmarked?: boolean;
+ }
+}
+
////////////////////
// Declarative Web Request
////////////////////
@@ -582,572 +1641,2382 @@ declare module chrome.declarativeWebRequest {
////////////////////
// DesktopCapture
////////////////////
+/**
+ * Desktop Capture API that can be used to capture content of screen, individual windows or tabs.
+ * Availability: Since Chrome 34.
+ * Permissions: "desktopCapture"
+ */
declare module chrome.desktopCapture {
- export function chooseDesktopMedia(sources: string[], targetTab?: chrome.tabs.Tab, callback?: (streamId: string) => void): void;
+ /**
+ * Shows desktop media picker UI with the specified set of sources.
+ * @param sources Set of sources that should be shown to the user.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string streamId) {...};
+ * Parameter streamId: An opaque string that can be passed to getUserMedia() API to generate media stream that corresponds to the source selected by the user. If user didn't select any source (i.e. canceled the prompt) then the callback is called with an empty streamId. The created streamId can be used only once and expires after a few seconds when it is not used.
+ */
+ export function chooseDesktopMedia(sources: string[], callback: (streamId: string) => void): number;
+ /**
+ * Shows desktop media picker UI with the specified set of sources.
+ * @param sources Set of sources that should be shown to the user.
+ * @param targetTab Optional tab for which the stream is created. If not specified then the resulting stream can be used only by the calling extension. The stream can only be used by frames in the given tab whose security origin matches tab.url.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string streamId) {...};
+ * Parameter streamId: An opaque string that can be passed to getUserMedia() API to generate media stream that corresponds to the source selected by the user. If user didn't select any source (i.e. canceled the prompt) then the callback is called with an empty streamId. The created streamId can be used only once and expires after a few seconds when it is not used.
+ */
+ export function chooseDesktopMedia(sources: string[], targetTab: chrome.tabs.Tab, callback: (streamId: string) => void): number;
+ /**
+ * Hides desktop media picker dialog shown by chooseDesktopMedia().
+ * @param desktopMediaRequestId Id returned by chooseDesktopMedia()
+ */
export function cancelChooseDesktopMedia(desktopMediaRequestId: number): void;
}
////////////////////
// Dev Tools - Inspected Window
////////////////////
+/**
+ * Use the chrome.devtools.inspectedWindow API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page.
+ * Availability: Since Chrome 18.
+ */
declare module chrome.devtools.inspectedWindow {
+ /** A resource within the inspected page, such as a document, a script, or an image. */
interface Resource {
+ /** The URL of the resource. */
url: string;
+ /**
+ * Gets the content of the resource.
+ * @param callback A function that receives resource content when the request completes.
+ * The callback parameter should be a function that looks like this:
+ * function(string content, string encoding) {...};
+ * Parameter content: Content of the resource (potentially encoded).
+ * Parameter encoding: Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported.
+ */
getContent(callback: (content: string, encoding: string) => void): void;
+ /**
+ * Sets the content of the resource.
+ * @param content New content of the resource. Only resources with the text type are currently supported.
+ * @param commit True if the user has finished editing the resource, and the new content of the resource should be persisted; false if this is a minor change sent in progress of the user editing the resource.
+ * @param callback A function called upon request completion.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(object error) {...};
+ * Optional parameter error: Set to undefined if the resource content was set successfully; describes error otherwise.
+ */
setContent(content: string, commit: boolean, callback?: (error: Object) => void): void;
}
interface ReloadOptions {
+ /** Optional. If specified, the string will override the value of the User-Agent HTTP header that's sent while loading the resources of the inspected page. The string will also override the value of the navigator.userAgent property that's returned to any scripts that are running within the inspected page. */
userAgent?: string;
+ /** Optional. When true, the loader will ignore the cache for all inspected page resources loaded before the load event is fired. The effect is similar to pressing Ctrl+Shift+R in the inspected window or within the Developer Tools window. */
ignoreCache?: boolean;
+ /** Optional. If specified, the script will be injected into every frame of the inspected page immediately upon load, before any of the frame's scripts. The script will not be injected after subsequent reloads—for example, if the user presses Ctrl+R. */
injectedScript?: boolean;
+ /**
+ * Optional.
+ * If specified, this script evaluates into a function that accepts three string arguments: the source to preprocess, the URL of the source, and a function name if the source is an DOM event handler. The preprocessorerScript function should return a string to be compiled by Chrome in place of the input source. In the case that the source is a DOM event handler, the returned source must compile to a single JS function.
+ * @deprecated Deprecated since Chrome 41. Please avoid using this parameter, it will be removed soon.
+ */
+ preprocessorScript?: string;
+ }
+
+ interface EvaluationExceptionInfo {
+ /** Set if the error occurred on the DevTools side before the expression is evaluated. */
+ isError: boolean;
+ /** Set if the error occurred on the DevTools side before the expression is evaluated. */
+ code: string;
+ /** Set if the error occurred on the DevTools side before the expression is evaluated. */
+ description: string;
+ /** Set if the error occurred on the DevTools side before the expression is evaluated, contains the array of the values that may be substituted into the description string to provide more information about the cause of the error. */
+ details: any[];
+ /** Set if the evaluated code produces an unhandled exception. */
+ isException: boolean;
+ /** Set if the evaluated code produces an unhandled exception. */
+ value: string;
}
interface ResourceAddedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Resource resource) {...};
+ */
addListener(callback: (resource: Resource) => void): void;
}
interface ResourceContentCommittedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Resource resource, string content) {...};
+ * Parameter content: New content of the resource.
+ */
addListener(callback: (resource: Resource, content: string) => void): void;
}
+ /** The ID of the tab being inspected. This ID may be used with chrome.tabs.* API. */
var tabId: number;
+ /** Reloads the inspected page. */
export function reload(reloadOptions: ReloadOptions): void;
- export function eval(expression: string, callback?: (result: Object, isException: boolean) => void): void;
+ /**
+ * Evaluates a JavaScript expression in the context of the main frame of the inspected page. The expression must evaluate to a JSON-compliant object, otherwise an exception is thrown. The eval function can report either a DevTools-side error or a JavaScript exception that occurs during evaluation. In either case, the result parameter of the callback is undefined. In the case of a DevTools-side error, the isException parameter is non-null and has isError set to true and code set to an error code. In the case of a JavaScript error, isException is set to true and value is set to the string value of thrown object.
+ * @param expression An expression to evaluate.
+ * @param callback A function called when evaluation completes.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(object result, object exceptionInfo) {...};
+ * Parameter result: The result of evaluation.
+ * Parameter exceptionInfo: An object providing details if an exception occurred while evaluating the expression.
+ */
+ export function eval(expression: string, callback?: (result: Object, exceptionInfo: EvaluationExceptionInfo) => void): void;
+ /**
+ * Retrieves the list of resources from the inspected page.
+ * @param callback A function that receives the list of resources when the request completes.
+ * The callback parameter should be a function that looks like this:
+ * function(array of Resource resources) {...};
+ */
export function getResources(callback: (resources: Resource[]) => void): void;
+ /** Fired when a new resource is added to the inspected page. */
var onResourceAdded: ResourceAddedEvent;
+ /** Fired when a new revision of the resource is committed (e.g. user saves an edited version of the resource in the Developer Tools). */
var onResourceContentCommitted: ResourceContentCommittedEvent;
}
////////////////////
// Dev Tools - Network
////////////////////
+/**
+ * Use the chrome.devtools.network API to retrieve the information about network requests displayed by the Developer Tools in the Network panel.
+ * Availability: Since Chrome 18.
+ */
declare module chrome.devtools.network {
+ /** Represents a network request for a document resource (script, image and so on). See HAR Specification for reference. */
interface Request {
+ /**
+ * Returns content of the response body.
+ * @param callback A function that receives the response body when the request completes.
+ * The callback parameter should be a function that looks like this:
+ * function(string content, string encoding) {...};
+ * Parameter content: Content of the response body (potentially encoded).
+ * Parameter encoding: Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported.
+ */
getContent(callback: (content: string, encoding: string) => void): void;
}
interface RequestFinishedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Request request) {...};
+ * Parameter request: Description of a network request in the form of a HAR entry. See HAR specification for details.
+ */
addListener(callback: (request: Request) => void): void;
}
interface NavigatedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string url) {...};
+ * Parameter url: URL of the new page.
+ */
addListener(callback: (url: string) => void): void;
}
+ /**
+ * Returns HAR log that contains all known network requests.
+ * @param callback A function that receives the HAR log when the request completes.
+ * The callback parameter should be a function that looks like this:
+ * function(object harLog) {...};
+ * Parameter harLog: A HAR log. See HAR specification for details.
+ */
export function getHAR(callback: (harLog: Object) => void): void;
+ /** Fired when a network request is finished and all request data are available. */
var onRequestFinished: RequestFinishedEvent;
+ /** Fired when the inspected window navigates to a new page. */
var onNavigated: NavigatedEvent;
}
////////////////////
// Dev Tools - Panels
////////////////////
+/**
+ * Use the chrome.devtools.panels API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars.
+ * Availability: Since Chrome 18.
+ */
declare module chrome.devtools.panels {
interface PanelShownEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(global window) {...};
+ * Parameter window: The JavaScript window object of panel's page.
+ */
addListener(callback: (window: chrome.windows.Window) => void): void;
}
interface PanelHiddenEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
interface PanelSearchEvent extends chrome.events.Event {
+ /**
+ * The callback parameter should be a function that looks like this:
+ * function(string action, string queryString) {...};
+ * Parameter action: Type of search action being performed.
+ * Optional parameter queryString: Query string (only for 'performSearch').
+ */
addListener(callback: (action: string, queryString?: string) => void): void;
}
+ /** Represents a panel created by extension. */
interface ExtensionPanel {
- createStatusButton(iconPath: string, tooltipText: string, disabled: boolean): Button;
+ /**
+ * Appends a button to the status bar of the panel.
+ * @param iconPath Path to the icon of the button. The file should contain a 64x24-pixel image composed of two 32x24 icons. The left icon is used when the button is inactive; the right icon is displayed when the button is pressed.
+ * @param tooltipText Text shown as a tooltip when user hovers the mouse over the button.
+ * @param disabled Whether the button is disabled.
+ */
+ createStatusBarButton(iconPath: string, tooltipText: string, disabled: boolean): Button;
+ /** Fired when the user switches to the panel. */
onShown: PanelShownEvent;
+ /** Fired when the user switches away from the panel. */
onHidden: PanelHiddenEvent;
+ /** Fired upon a search action (start of a new search, search result navigation, or search being canceled). */
onSearch: PanelSearchEvent;
}
interface ButtonClickedEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
+ /** A button created by the extension. */
interface Button {
+ /**
+ * Updates the attributes of the button. If some of the arguments are omitted or null, the corresponding attributes are not updated.
+ * @param iconPath Path to the new icon of the button.
+ * @param tooltipText Text shown as a tooltip when user hovers the mouse over the button.
+ * @param disabled Whether the button is disabled.
+ */
update(iconPath?: string, tooltipText?: string, disabled?: boolean): void;
+ /** Fired when the button is clicked. */
onClicked: ButtonClickedEvent;
}
interface SelectionChangedEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
+ /** Represents the Elements panel. */
interface ElementsPanel {
+ /**
+ * Creates a pane within panel's sidebar.
+ * @param title Text that is displayed in sidebar caption.
+ * @param callback A callback invoked when the sidebar is created.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function( ExtensionSidebarPane result) {...};
+ * Parameter result: An ExtensionSidebarPane object for created sidebar pane.
+ */
createSidebarPane(title: string, callback?: (result: ExtensionSidebarPane) => void): void;
+ /** Fired when an object is selected in the panel. */
+ onSelectionChanged: SelectionChangedEvent;
+ }
+
+ /**
+ * Since Chrome 41.
+ * Represents the Sources panel.
+ */
+ interface SourcesPanel {
+ /**
+ * Creates a pane within panel's sidebar.
+ * @param title Text that is displayed in sidebar caption.
+ * @param callback A callback invoked when the sidebar is created.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function( ExtensionSidebarPane result) {...};
+ * Parameter result: An ExtensionSidebarPane object for created sidebar pane.
+ */
+ createSidebarPane(title: string, callback?: (result: ExtensionSidebarPane) => void): void;
+ /** Fired when an object is selected in the panel. */
onSelectionChanged: SelectionChangedEvent;
}
interface ExtensionSidebarPaneShownEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(global window) {...};
+ * Parameter window: The JavaScript window object of the sidebar page, if one was set with the setPage() method.
+ */
addListener(callback: (window: chrome.windows.Window) => void): void;
}
interface ExtensionSidebarPaneHiddenEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
+ /** A sidebar created by the extension. */
interface ExtensionSidebarPane {
+ /**
+ * Sets the height of the sidebar.
+ * @param height A CSS-like size specification, such as '100px' or '12ex'.
+ */
setHeight(height: string): void;
- setExpression(expression: string, rootTitle?: string, callback?: Function): void;
- setObject(jsonObject: string, rootTitle?: string, callback?: Function): void;
+ /**
+ * Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.
+ * @param expression An expression to be evaluated in context of the inspected page. JavaScript objects and DOM nodes are displayed in an expandable tree similar to the console/watch.
+ * @param rootTitle An optional title for the root of the expression tree.
+ * @param callback A callback invoked after the sidebar pane is updated with the expression evaluation results.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ setExpression(expression: string, rootTitle?: string, callback?: () => void): void;
+ /**
+ * Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.
+ * @param expression An expression to be evaluated in context of the inspected page. JavaScript objects and DOM nodes are displayed in an expandable tree similar to the console/watch.
+ * @param callback A callback invoked after the sidebar pane is updated with the expression evaluation results.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ setExpression(expression: string, callback?: () => void): void;
+ /**
+ * Sets a JSON-compliant object to be displayed in the sidebar pane.
+ * @param jsonObject An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).
+ * @param rootTitle An optional title for the root of the expression tree.
+ * @param callback A callback invoked after the sidebar is updated with the object.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ setObject(jsonObject: string, rootTitle?: string, callback?: () => void): void;
+ /**
+ * Sets a JSON-compliant object to be displayed in the sidebar pane.
+ * @param jsonObject An object to be displayed in context of the inspected page. Evaluated in the context of the caller (API client).
+ * @param callback A callback invoked after the sidebar is updated with the object.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ setObject(jsonObject: string, callback?: () => void): void;
+ /**
+ * Sets an HTML page to be displayed in the sidebar pane.
+ * @param path Relative path of an extension page to display within the sidebar.
+ */
setPage(path: string): void;
+ /** Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it. */
onShown: ExtensionSidebarPaneShownEvent;
+ /** Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane. */
onHidden: ExtensionSidebarPaneHiddenEvent;
}
+ /** Elements panel. */
var elements: ElementsPanel;
+ /**
+ * Since Chrome 38.
+ * Sources panel.
+ */
+ var sources: SourcesPanel;
+ /**
+ * Creates an extension panel.
+ * @param title Title that is displayed next to the extension icon in the Developer Tools toolbar.
+ * @param iconPath Path of the panel's icon relative to the extension directory.
+ * @param pagePath Path of the panel's HTML page relative to the extension directory.
+ * @param callback A function that is called when the panel is created.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function( ExtensionPanel panel) {...};
+ * Parameter panel: An ExtensionPanel object representing the created panel.
+ */
export function create(title: string, iconPath: string, pagePath: string, callback?: (panel: ExtensionPanel) => void): void;
- export function setOpenResourceHandler(callback: (resource: chrome.devtools.inspectedWindow.Resource) => void): void;
+ /**
+ * Specifies the function to be called when the user clicks a resource link in the Developer Tools window. To unset the handler, either call the method with no parameters or pass null as the parameter.
+ * @param callback A function that is called when the user clicks on a valid resource link in Developer Tools window. Note that if the user clicks an invalid URL or an XHR, this function is not called.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function( devtools.inspectedWindow.Resource resource) {...};
+ * Parameter resource: A devtools.inspectedWindow.Resource object for the resource that was clicked.
+ */
+ export function setOpenResourceHandler(callback?: (resource: chrome.devtools.inspectedWindow.Resource) => void): void;
+ /**
+ * Since Chrome 38.
+ * Requests DevTools to open a URL in a Developer Tools panel.
+ * @param url The URL of the resource to open.
+ * @param lineNumber Specifies the line number to scroll to when the resource is loaded.
+ * @param callback A function that is called when the resource has been successfully loaded.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function openResource(url: string, lineNumber: number, callback: () => void): void;
+}
+
+////////////////////
+// Document Scan
+////////////////////
+/**
+ * Use the chrome.documentScan API to discover and retrieve images from attached paper document scanners.
+ * Availability: Since Chrome 44.
+ * Permissions: "documentScan"
+ * Important: This API works only on Chrome OS.
+ */
+declare module chrome.documentScan {
+ interface DocumentScanOptions {
+ /** Optional. The MIME types that are accepted by the caller. */
+ mimeTypes?: string[];
+ /** Optional. The number of scanned images allowed (defaults to 1). */
+ maxImages?: number;
+ }
+
+ interface DocumentScanCallbackArg {
+ /** The data image URLs in a form that can be passed as the "src" value to an image tag. */
+ dataUrls: string[];
+ /** The MIME type of dataUrls. */
+ mimeType: string;
+ }
+
+ /**
+ * Performs a document scan. On success, the PNG data will be sent to the callback.
+ * @param options Object containing scan parameters.
+ * @param callback Called with the result and data from the scan.
+ * The callback parameter should be a function that looks like this:
+ * function(object result) {...};
+ */
+ export function scan(options: DocumentScanOptions, callback: (result: DocumentScanCallbackArg) => void): void;
}
////////////////////
// Dev Tools - Downloads
////////////////////
+/**
+ * Use the chrome.downloads API to programmatically initiate, monitor, manipulate, and search for downloads.
+ * Availability: Since Chrome 31.
+ * Permissions: "downloads"
+ */
declare module chrome.downloads {
interface HeaderNameValuePair {
+ /** Name of the HTTP header. */
name: string;
+ /** Value of the HTTP header. */
value: string;
}
interface DownloadOptions {
+ /** Optional. Post body. */
body?: string;
+ /** Optional. Use a file-chooser to allow the user to select a filename regardless of whether filename is set or already exists. */
saveAs?: boolean;
+ /** The URL to download. */
url: string;
+ /** Optional. A file path relative to the Downloads directory to contain the downloaded file, possibly containing subdirectories. Absolute paths, empty paths, and paths containing back-references ".." will cause an error. onDeterminingFilename allows suggesting a filename after the file's MIME type and a tentative filename have been determined. */
filename?: string;
+ /** Optional. Extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol. Each header is represented as a dictionary containing the keys name and either value or binaryValue, restricted to those allowed by XMLHttpRequest. */
headers?: HeaderNameValuePair[];
+ /** Optional. The HTTP method to use if the URL uses the HTTP[S] protocol. */
method?: string;
+ /** Optional. The action to take if filename already exists. */
+ conflictAction?: string;
}
interface DownloadDelta {
- danger?: DownloadStringDiff;
- url?: DownloadStringDiff;
- totalBytes?: DownloadStringDiff;
- dangerAccepted?: DownloadBooleanDiff;
- filename?: DownloadStringDiff;
- paused?: DownloadBooleanDiff;
- state?: DownloadStringDiff;
- mime?: DownloadStringDiff;
- fileSize?: DownloadLongDiff;
- startTime?: DownloadLongDiff;
- error?: DownloadLongDiff;
- endTime?: DownloadLongDiff;
+ /** Optional. The change in danger, if any. */
+ danger?: StringDelta;
+ /** Optional. The change in url, if any. */
+ url?: StringDelta;
+ /** Optional. The change in totalBytes, if any. */
+ totalBytes?: DoubleDelta;
+ /** Optional. The change in filename, if any. */
+ filename?: StringDelta;
+ /** Optional. The change in paused, if any. */
+ paused?: BooleanDelta;
+ /** Optional. The change in state, if any. */
+ state?: StringDelta;
+ /** Optional. The change in mime, if any. */
+ mime?: StringDelta;
+ /** Optional. The change in fileSize, if any. */
+ fileSize?: DoubleDelta;
+ /** Optional. The change in startTime, if any. */
+ startTime?: DoubleDelta;
+ /** Optional. The change in error, if any. */
+ error?: StringDelta;
+ /** Optional. The change in endTime, if any. */
+ endTime?: DoubleDelta;
+ /** The id of the DownloadItem that changed. */
id: number;
+ /** Optional. The change in canResume, if any. */
+ canResume?: BooleanDelta;
+ /** Optional. The change in exists, if any. */
+ exists?: BooleanDelta;
}
- interface DownloadBooleanDiff {
+ interface BooleanDelta {
current?: boolean;
previous?: boolean;
}
- interface DownloadLongDiff {
+ /** Since Chrome 34. */
+ interface DoubleDelta {
current?: number;
previous?: number;
}
- interface DownloadStringDiff {
+ interface StringDelta {
current?: string;
previous?: string;
}
interface DownloadItem {
+ /** Number of bytes received so far from the host, without considering file compression. */
bytesReceived: number;
+ /** Indication of whether this download is thought to be safe or known to be suspicious. */
danger: string;
+ /** Absolute URL. */
url: string;
+ /** Number of bytes in the whole file, without considering file compression, or -1 if unknown. */
totalBytes: number;
- dangerAccepted?: boolean;
+ /** Absolute local path. */
filename: string;
+ /** True if the download has stopped reading data from the host, but kept the connection open. */
paused: boolean;
+ /** Indicates whether the download is progressing, interrupted, or complete. */
state: string;
+ /** The file's MIME type. */
mime: string;
+ /** Number of bytes in the whole file post-decompression, or -1 if unknown. */
fileSize: number;
- startTime: number;
- error?: number;
- endTime?: number;
+ /** The time when the download began in ISO 8601 format. May be passed directly to the Date constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})}) */
+ startTime: string;
+ /** Optional. Why the download was interrupted. Several kinds of HTTP errors may be grouped under one of the errors beginning with SERVER_. Errors relating to the network begin with NETWORK_, errors relating to the process of writing the file to the file system begin with FILE_, and interruptions initiated by the user begin with USER_. */
+ error?: string;
+ /** Optional. The time when the download ended in ISO 8601 format. May be passed directly to the Date constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})}) */
+ endTime?: string;
+ /** An identifier that is persistent across browser sessions. */
id: number;
+ /** False if this download is recorded in the history, true if it is not recorded. */
incognito: boolean;
+ /** Absolute URL. */
+ referrer: string;
+ /** Optional. Estimated time when the download will complete in ISO 8601 format. May be passed directly to the Date constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})}) */
+ estimatedEndTime?: string;
+ /** True if the download is in progress and paused, or else if it is interrupted and can be resumed starting from where it was interrupted. */
+ canResume: boolean;
+ /** Whether the downloaded file still exists. This information may be out of date because Chrome does not automatically watch for file removal. Call search() in order to trigger the check for file existence. When the existence check completes, if the file has been deleted, then an onChanged event will fire. Note that search() does not wait for the existence check to finish before returning, so results from search() may not accurately reflect the file system. Also, search() may be called as often as necessary, but will not check for file existence any more frequently than once every 10 seconds. */
+ exists: boolean;
+ /** Optional. The identifier for the extension that initiated this download if this download was initiated by an extension. Does not change once it is set. */
+ byExtensionId?: string;
+ /** Optional. The localized name of the extension that initiated this download if this download was initiated by an extension. May change if the extension changes its name or if the user changes their locale. */
+ byExtensionName?: string;
}
interface GetFileIconOptions {
+ /** Optional. * The size of the returned icon. The icon will be square with dimensions size * size pixels. The default and largest size for the icon is 32x32 pixels. The only supported sizes are 16 and 32. It is an error to specify any other size.
+ */
size?: number;
}
interface DownloadQuery {
- orderBy?: string;
+ /** Optional. Set elements of this array to DownloadItem properties in order to sort search results. For example, setting orderBy=['startTime'] sorts the DownloadItem by their start time in ascending order. To specify descending order, prefix with a hyphen: '-startTime'. */
+ orderBy?: string[];
+ /** Optional. Limits results to DownloadItem whose url matches the given regular expression. */
urlRegex?: string;
+ /** Optional. Limits results to DownloadItem that ended before the given ms since the epoch. */
endedBefore?: number;
+ /** Optional. Limits results to DownloadItem whose totalBytes is greater than the given integer. */
totalBytesGreater?: number;
+ /** Optional. Indication of whether this download is thought to be safe or known to be suspicious. */
danger?: string;
+ /** Optional. Number of bytes in the whole file, without considering file compression, or -1 if unknown. */
totalBytes?: number;
+ /** Optional. True if the download has stopped reading data from the host, but kept the connection open. */
paused?: boolean;
+ /** Optional. Limits results to DownloadItem whose filename matches the given regular expression. */
filenameRegex?: string;
- query?: string;
+ /** Optional. This array of search terms limits results to DownloadItem whose filename or url contain all of the search terms that do not begin with a dash '-' and none of the search terms that do begin with a dash. */
+ query?: string[];
+ /** Optional. Limits results to DownloadItem whose totalBytes is less than the given integer. */
totalBytesLess?: number;
+ /** Optional. The id of the DownloadItem to query. */
id?: number;
+ /** Optional. Number of bytes received so far from the host, without considering file compression. */
bytesReceived?: number;
+ /** Optional. Limits results to DownloadItem that ended after the given ms since the epoch. */
endedAfter?: number;
+ /** Optional. Absolute local path. */
filename?: string;
+ /** Optional. Indicates whether the download is progressing, interrupted, or complete. */
state?: string;
+ /** Optional. Limits results to DownloadItem that started after the given ms since the epoch. */
startedAfter?: number;
- dangerAccepted?: boolean;
+ /** Optional. The file's MIME type. */
mime?: string;
+ /** Optional. Number of bytes in the whole file post-decompression, or -1 if unknown. */
fileSize?: number;
+ /** Optional. The time when the download began in ISO 8601 format. */
startTime?: number;
+ /** Optional. Absolute URL. */
url?: string;
+ /** Optional. Limits results to DownloadItem that started before the given ms since the epoch. */
startedBefore?: number;
+ /** Optional. The maximum number of matching DownloadItem returned. Defaults to 1000. Set to 0 in order to return all matching DownloadItem. See search for how to page through results. */
limit?: number;
+ /** Optional. Why a download was interrupted. */
error?: number;
+ /** Optional. The time when the download ended in ISO 8601 format. */
endTime?: number;
+ /** Optional. Whether the downloaded file exists; */
+ exists?: boolean;
}
+ interface DownloadFilenameSuggestion {
+ /** The DownloadItem's new target DownloadItem.filename, as a path relative to the user's default Downloads directory, possibly containing subdirectories. Absolute paths, empty paths, and paths containing back-references ".." will be ignored. */
+ filename: string;
+ /** Optional. The action to take if filename already exists. */
+ conflictAction?: string;
+ }
+
interface DownloadChangedEvent extends chrome.events.Event {
+ /**
+ * When any of a DownloadItem's properties except bytesReceived and estimatedEndTime changes, this event fires with the downloadId and an object containing the properties that changed.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object downloadDelta) {...};
+ */
addListener(callback: (downloadDelta: DownloadDelta) => void): void;
}
interface DownloadCreatedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( DownloadItem downloadItem) {...};
+ */
addListener(callback: (downloadItem: DownloadItem) => void): void;
}
interface DownloadErasedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(integer downloadId) {...};
+ * Parameter downloadId: The id of the DownloadItem that was erased.
+ */
addListener(callback: (downloadId: number) => void): void;
}
+ interface DownloadDeterminingFilenameEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( DownloadItem downloadItem, function suggest) {...};
+ */
+ addListener(callback: (downloadItem: DownloadItem, suggest: (suggestion?: DownloadFilenameSuggestion) => void) => void): void;
+ }
+
+ /**
+ * Find DownloadItem. Set query to the empty object to get all DownloadItem. To get a specific DownloadItem, set only the id field. To page through a large number of items, set orderBy: ['-startTime'], set limit to the number of items per page, and set startedAfter to the startTime of the last item from the last page.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of DownloadItem results) {...};
+ */
export function search(query: DownloadQuery, callback: (results: DownloadItem[]) => void): void;
- export function pause(downloadId: number, callback?: Function): void;
+ /**
+ * Pause the download. If the request was successful the download is in a paused state. Otherwise runtime.lastError contains an error message. The request will fail if the download is not active.
+ * @param downloadId The id of the download to pause.
+ * @param callback Called when the pause request is completed.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function pause(downloadId: number, callback?: () => void): void;
+ /**
+ * Retrieve an icon for the specified download. For new downloads, file icons are available after the onCreated event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform. The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, runtime.lastError will contain an error message.
+ * @param downloadId The identifier for the download.
+ * @param callback A URL to an image that represents the download.
+ * The callback parameter should be a function that looks like this:
+ * function(string iconURL) {...};
+ */
export function getFileIcon(downloadId: number, callback: (iconURL: string) => void): void;
+ /**
+ * Retrieve an icon for the specified download. For new downloads, file icons are available after the onCreated event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform. The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, runtime.lastError will contain an error message.
+ * @param downloadId The identifier for the download.
+ * @param callback A URL to an image that represents the download.
+ * The callback parameter should be a function that looks like this:
+ * function(string iconURL) {...};
+ */
export function getFileIcon(downloadId: number, options: GetFileIconOptions, callback: (iconURL: string) => void): void;
- export function resume(downloadId: number, callback?: Function): void;
- export function cancel(downloadId: number, callback?: Function): void;
+ /**
+ * Resume a paused download. If the request was successful the download is in progress and unpaused. Otherwise runtime.lastError contains an error message. The request will fail if the download is not active.
+ * @param downloadId The id of the download to resume.
+ * @param callback Called when the resume request is completed.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function resume(downloadId: number, callback?: () => void): void;
+ /**
+ * Cancel a download. When callback is run, the download is cancelled, completed, interrupted or doesn't exist anymore.
+ * @param downloadId The id of the download to cancel.
+ * @param callback Called when the cancel request is completed.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function cancel(downloadId: number, callback?: () => void): void;
+ /**
+ * Download a URL. If the URL uses the HTTP[S] protocol, then the request will include all cookies currently set for its hostname. If both filename and saveAs are specified, then the Save As dialog will be displayed, pre-populated with the specified filename. If the download started successfully, callback will be called with the new DownloadItem's downloadId. If there was an error starting the download, then callback will be called with downloadId=undefined and runtime.lastError will contain a descriptive string. The error strings are not guaranteed to remain backwards compatible between releases. Extensions must not parse it.
+ * @param options What to download and how.
+ * @param callback Called with the id of the new DownloadItem.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(integer downloadId) {...};
+ */
export function download(options: DownloadOptions, callback?: (downloadId: number) => void): void;
+ /**
+ * Open the downloaded file now if the DownloadItem is complete; otherwise returns an error through runtime.lastError. Requires the "downloads.open" permission in addition to the "downloads" permission. An onChanged event will fire when the item is opened for the first time.
+ * @param downloadId The identifier for the downloaded file.
+ */
export function open(downloadId: number): void;
+ /**
+ * Show the downloaded file in its folder in a file manager.
+ * @param downloadId The identifier for the downloaded file.
+ */
export function show(downloadId: number): void;
+ /** Show the default Downloads folder in a file manager. */
export function showDefaultFolder(): void;
- export function erase(query: DownloadQuery, callback: (results: DownloadItem[]) => void): void;
- export function removeFile(downloadId: number, callback: () => void): void;
+ /**
+ * Erase matching DownloadItem from history without deleting the downloaded file. An onErased event will fire for each DownloadItem that matches query, then callback will be called.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(array of integer erasedIds) {...};
+ */
+ export function erase(query: DownloadQuery, callback: (erasedIds: number[]) => void): void;
+ /**
+ * Remove the downloaded file if it exists and the DownloadItem is complete; otherwise return an error through runtime.lastError.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeFile(downloadId: number, callback?: () => void): void;
+ /**
+ * Prompt the user to accept a dangerous download. Can only be called from a visible context (tab, window, or page/browser action popup). Does not automatically accept dangerous downloads. If the download is accepted, then an onChanged event will fire, otherwise nothing will happen. When all the data is fetched into a temporary file and either the download is not dangerous or the danger has been accepted, then the temporary file is renamed to the target filename, the |state| changes to 'complete', and onChanged fires.
+ * @param downloadId The identifier for the DownloadItem.
+ * @param callback Called when the danger prompt dialog closes.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function acceptDanger(downloadId: number, callback: () => void): void;
+ /** Initiate dragging the downloaded file to another application. Call in a javascript ondragstart handler. */
export function drag(downloadId: number): void;
+ /** Enable or disable the gray shelf at the bottom of every window associated with the current browser profile. The shelf will be disabled as long as at least one extension has disabled it. Enabling the shelf while at least one other extension has disabled it will return an error through runtime.lastError. Requires the "downloads.shelf" permission in addition to the "downloads" permission. */
export function setShelfEnabled(enabled: boolean): void;
+ /** When any of a DownloadItem's properties except bytesReceived and estimatedEndTime changes, this event fires with the downloadId and an object containing the properties that changed. */
var onChanged: DownloadChangedEvent;
+ /** This event fires with the DownloadItem object when a download begins. */
var onCreated: DownloadCreatedEvent;
+ /** Fires with the downloadId when a download is erased from history. */
var onErased: DownloadErasedEvent;
+ /** During the filename determination process, extensions will be given the opportunity to override the target DownloadItem.filename. Each extension may not register more than one listener for this event. Each listener must call suggest exactly once, either synchronously or asynchronously. If the listener calls suggest asynchronously, then it must return true. If the listener neither calls suggest synchronously nor returns true, then suggest will be called automatically. The DownloadItem will not complete until all listeners have called suggest. Listeners may call suggest without any arguments in order to allow the download to use downloadItem.filename for its filename, or pass a suggestion object to suggest in order to override the target filename. If more than one extension overrides the filename, then the last extension installed whose listener passes a suggestion object to suggest wins. In order to avoid confusion regarding which extension will win, users should not install extensions that may conflict. If the download is initiated by download and the target filename is known before the MIME type and tentative filename have been determined, pass filename to download instead. */
+ var onDeterminingFilename: DownloadDeterminingFilenameEvent;
+}
+
+////////////////////
+// Enterprise Platform Keys
+////////////////////
+/**
+ * Use the chrome.enterprise.platformKeys API to generate hardware-backed keys and to install certificates for these keys. The certificates will be managed by the platform and can be used for TLS authentication, network access or by other extension through chrome.platformKeys.
+ * Availability: Since Chrome 37.
+ * Permissions: "enterprise.platformKeys"
+ * Important: This API works only on Chrome OS.
+ * Note: This API is only for extensions pre-installed by policy.
+ */
+declare module chrome.enterprise.platformKeys {
+ interface Token {
+ /**
+ * Uniquely identifies this Token.
+ * Static IDs are "user" and "system", referring to the platform's user-specific and the system-wide hardware token, respectively. Any other tokens (with other identifiers) might be returned by enterprise.platformKeys.getTokens.
+ */
+ id: string;
+ /**
+ * Implements the WebCrypto's SubtleCrypto interface. The cryptographic operations, including key generation, are hardware-backed.
+ * Only non-extractable RSASSA-PKCS1-V1_5 keys with modulusLength up to 2048 can be generated. Each key can be used for signing data at most once.
+ * Keys generated on a specific Token cannot be used with any other Tokens, nor can they be used with window.crypto.subtle. Equally, Key objects created with window.crypto.subtle cannot be used with this interface.
+ */
+ subtleCrypto: SubtleCrypto;
+ }
+
+ /**
+ * Returns the available Tokens. In a regular user's session the list will always contain the user's token with id "user". If a system-wide TPM token is available, the returned list will also contain the system-wide token with id "system". The system-wide token will be the same for all sessions on this device (device in the sense of e.g. a Chromebook).
+ * @param callback Invoked by getTokens with the list of available Tokens.
+ * The callback parameter should be a function that looks like this:
+ * function(array of Token tokens) {...};
+ * Parameter tokens: The list of available tokens.
+ */
+ export function getToken(callback: (tokens: Token[]) => void): void;
+ /**
+ * Returns the list of all client certificates available from the given token. Can be used to check for the existence and expiration of client certificates that are usable for a certain authentication.
+ * @param tokenId The id of a Token returned by getTokens.
+ * @param callback Called back with the list of the available certificates.
+ * The callback parameter should be a function that looks like this:
+ * function(array of ArrayBuffer certificates) {...};
+ * Parameter certificates: The list of certificates, each in DER encoding of a X.509 certificate.
+ */
+ export function getCertificates(tokenId: string, callback: (certificates: ArrayBuffer) => void): void;
+ /**
+ * Imports certificate to the given token if the certified key is already stored in this token. After a successful certification request, this function should be used to store the obtained certificate and to make it available to the operating system and browser for authentication.
+ * @param tokenId The id of a Token returned by getTokens.
+ * @param certificate The DER encoding of a X.509 certificate.
+ * @param callback Called back when this operation is finished.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function importCertificate(tokenId: string, certificate: ArrayBuffer, callback?: () => void): void;
+ /**
+ * Removes certificate from the given token if present. Should be used to remove obsolete certificates so that they are not considered during authentication and do not clutter the certificate choice. Should be used to free storage in the certificate store.
+ * @param tokenId The id of a Token returned by getTokens.
+ * @param certificate The DER encoding of a X.509 certificate.
+ * @param callback Called back when this operation is finished.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeCertificate(tokenId: string, certificate: ArrayBuffer, callback?: () => void): void;
}
////////////////////
// Events
////////////////////
+/**
+ * The chrome.events namespace contains common types used by APIs dispatching events to notify you when something interesting happens.
+ * Availability: Since Chrome 21.
+ */
declare module chrome.events {
+ /** Filters URLs for various criteria. See event filtering. All criteria are case sensitive. */
interface UrlFilter {
+ /** Optional. Matches if the scheme of the URL is equal to any of the schemes specified in the array. */
schemes?: string[];
+ /**
+ * Optional.
+ * Since Chrome 23.
+ * Matches if the URL (without fragment identifier) matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the RE2 syntax.
+ */
urlMatches?: string;
+ /** Optional. Matches if the path segment of the URL contains a specified string. */
pathContains?: string;
+ /** Optional. Matches if the host name of the URL ends with a specified string. */
hostSuffix?: string;
+ /** Optional. Matches if the host name of the URL starts with a specified string. */
hostPrefix?: string;
+ /** Optional. Matches if the host name of the URL contains a specified string. To test whether a host name component has a prefix 'foo', use hostContains: '.foo'. This matches 'www.foobar.com' and 'foo.com', because an implicit dot is added at the beginning of the host name. Similarly, hostContains can be used to match against component suffix ('foo.') and to exactly match against components ('.foo.'). Suffix- and exact-matching for the last components need to be done separately using hostSuffix, because no implicit dot is added at the end of the host name. */
hostContains?: string;
+ /** Optional. Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if they match the default port number. */
urlContains?: string;
+ /** Optional. Matches if the query segment of the URL ends with a specified string. */
querySuffix?: string;
+ /** Optional. Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL if they match the default port number. */
urlPrefix?: string;
+ /** Optional. Matches if the host name of the URL is equal to a specified string. */
hostEquals?: string;
+ /** Optional. Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL if they match the default port number. */
urlEquals?: string;
+ /** Optional. Matches if the query segment of the URL contains a specified string. */
queryContains?: string;
+ /** Optional. Matches if the path segment of the URL starts with a specified string. */
pathPrefix?: string;
+ /** Optional. Matches if the path segment of the URL is equal to a specified string. */
pathEquals?: string;
+ /** Optional. Matches if the path segment of the URL ends with a specified string. */
pathSuffix?: string;
+ /** Optional. Matches if the query segment of the URL is equal to a specified string. */
queryEquals?: string;
+ /** Optional. Matches if the query segment of the URL starts with a specified string. */
queryPrefix?: string;
+ /** Optional. Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number. */
urlSuffix?: string;
+ /** Optional. Matches if the port of the URL is contained in any of the specified port lists. For example [80, 443, [1000, 1200]] matches all requests on port 80, 443 and in the range 1000-1200. */
ports?: any[];
+ /**
+ * Optional.
+ * Since Chrome 28.
+ * Matches if the URL without query segment and fragment identifier matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number. The regular expressions use the RE2 syntax.
+ */
+ originAndPathMatches?: string;
}
+ /** An object which allows the addition and removal of listeners for a Chrome event. */
interface Event {
+ /**
+ * Registers an event listener callback to an event.
+ * @param callback Called when an event occurs. The parameters of this function depend on the type of event.
+ * The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
addListener(callback: Function): void;
+ /**
+ * Returns currently registered rules.
+ * @param callback Called with registered rules.
+ * The callback parameter should be a function that looks like this:
+ * function(array of Rule rules) {...};
+ * Parameter rules: Rules that were registered, the optional parameters are filled with values.
+ */
getRules(callback: (rules: Rule[]) => void): void;
+ /**
+ * Returns currently registered rules.
+ * @param ruleIdentifiers If an array is passed, only rules with identifiers contained in this array are returned.
+ * @param callback Called with registered rules.
+ * The callback parameter should be a function that looks like this:
+ * function(array of Rule rules) {...};
+ * Parameter rules: Rules that were registered, the optional parameters are filled with values.
+ */
getRules(ruleIdentifiers: string[], callback: (rules: Rule[]) => void): void;
+ /**
+ * @param callback Listener whose registration status shall be tested.
+ */
hasListener(callback: Function): boolean;
- removeRules(ruleIdentifiers?: string[], callback?: Function): void;
+ /**
+ * Unregisters currently registered rules.
+ * @param ruleIdentifiers If an array is passed, only rules with identifiers contained in this array are unregistered.
+ * @param callback Called when rules were unregistered.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ removeRules(ruleIdentifiers?: string[], callback?: () => void): void;
+ /**
+ * Unregisters currently registered rules.
+ * @param callback Called when rules were unregistered.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ removeRules(callback?: () => void): void;
+ /**
+ * Registers rules to handle events.
+ * @param rules Rules to be registered. These do not replace previously registered rules.
+ * @param callback Called with registered rules.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(array of Rule rules) {...};
+ * Parameter rules: Rules that were registered, the optional parameters are filled with values.
+ */
addRules(rules: Rule[], callback?: (rules: Rule[]) => void): void;
- removeListener(callback: Function): void;
+ /**
+ * Deregisters an event listener callback from an event.
+ * @param callback Listener that shall be unregistered.
+ * The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ removeListener(callback: () => void): void;
hasListeners(): boolean;
}
+ /** Description of a declarative rule for handling events. */
interface Rule {
+ /** Optional. Optional priority of this rule. Defaults to 100. */
priority?: number;
+ /** List of conditions that can trigger the actions. */
conditions: any[];
+ /** Optional. Optional identifier that allows referencing this rule. */
id?: string;
+ /** List of actions that are triggered if one of the condtions is fulfilled. */
actions: any[];
+ /**
+ * Optional.
+ * Since Chrome 28.
+ * Tags can be used to annotate rules and perform operations on sets of rules.
+ */
+ tags?: string[];
}
}
////////////////////
// Extension
////////////////////
+/**
+ * The chrome.extension API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in Message Passing.
+ * Availability: Since Chrome 5.
+ */
declare module chrome.extension {
interface FetchProperties {
+ /** Optional. The window to restrict the search to. If omitted, returns all views. */
windowId?: number;
+ /** Optional. The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'notification', 'popup'. */
type?: string;
}
interface LastError {
- message?: string;
+ /** Description of the error that has taken place. */
+ message: string;
}
+ interface OnRequestEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(any request, runtime.MessageSender sender, function sendResponse) {...};
+ * Parameter request: The request sent by the calling script.
+ * Parameter sendResponse: Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response. If you have more than one onRequest listener in the same document, then only one may send a response.
+ */
+ addListener(callback: (request: any, sender: runtime.MessageSender, sendResponse: () => void) => void): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(runtime.MessageSender sender, function sendResponse) {...};
+ * Parameter sendResponse: Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response. If you have more than one onRequest listener in the same document, then only one may send a response.
+ */
+ addListener(callback: (sender: runtime.MessageSender, sendResponse: () => void) => void): void;
+ }
+
+ /**
+ * Since Chrome 7.
+ * True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior.
+ */
var inIncognitoContext: boolean;
+ /** Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be undefined. */
var lastError: LastError;
+ /** Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page. */
export function getBackgroundPage(): Window;
+ /**
+ * Converts a relative path within an extension install directory to a fully-qualified URL.
+ * @param path A path to a resource within an extension expressed relative to its install directory.
+ */
export function getURL(path: string): string;
+ /**
+ * Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the Chrome Extension Gallery.
+ * Since Chrome 9.
+ */
export function setUpdateUrlData(data: string): void;
+ /** Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension. */
export function getViews(fetchProperties?: FetchProperties): Window[];
+ /**
+ * Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.
+ * Since Chrome 12.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(boolean isAllowedAccess) {...};
+ * Parameter isAllowedAccess: True if the extension can access the 'file://' scheme, false otherwise.
+ */
export function isAllowedFileSchemeAccess(callback: (isAllowedAccess: boolean) => void): void;
+ /**
+ * Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.
+ * Since Chrome 12.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(boolean isAllowedAccess) {...};
+ * Parameter isAllowedAccess: True if the extension has access to Incognito mode, false otherwise.
+ */
export function isAllowedIncognitoAccess(callback: (isAllowedAccess: boolean) => void): void;
+ /**
+ * Sends a single request to other listeners within the extension. Similar to runtime.connect, but only sends a single request with an optional response. The extension.onRequest event is fired in each page of the extension.
+ * @deprecated Deprecated since Chrome 33. Please use runtime.sendMessage.
+ * @param extensionId The extension ID of the extension you want to connect to. If omitted, default is your own extension.
+ * @param responseCallback If you specify the responseCallback parameter, it should be a function that looks like this:
+ * function(any response) {...};
+ * Parameter response: The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
+ export function sendRequest(extensionId: string, request: any, responseCallback?: (response: any) => void): void;
+ /**
+ * Sends a single request to other listeners within the extension. Similar to runtime.connect, but only sends a single request with an optional response. The extension.onRequest event is fired in each page of the extension.
+ * @deprecated Deprecated since Chrome 33. Please use runtime.sendMessage.
+ * @param responseCallback If you specify the responseCallback parameter, it should be a function that looks like this:
+ * function(any response) {...};
+ * Parameter response: The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
+ export function sendRequest(request: any, responseCallback?: (response: any) => void): void;
+ /**
+ * Returns an array of the JavaScript 'window' objects for each of the tabs running inside the current extension. If windowId is specified, returns only the 'window' objects of tabs attached to the specified window.
+ * @deprecated Deprecated since Chrome 33. Please use extension.getViews {type: "tab"}.
+ */
+ export function getExtensionTabs(windowId?: number): Window[];
+
+ /**
+ * Fired when a request is sent from either an extension process or a content script.
+ * @deprecated Deprecated since Chrome 33. Please use runtime.onMessage.
+ */
+ var onRequest: OnRequestEvent;
+ /**
+ * Fired when a request is sent from another extension.
+ * @deprecated Deprecated since Chrome 33. Please use runtime.onMessageExternal.
+ */
+ var onRequestExternal: OnRequestEvent;
}
////////////////////
// File Browser Handler
////////////////////
+/**
+ * Use the chrome.fileBrowserHandler API to extend the Chrome OS file browser. For example, you can use this API to enable users to upload files to your website.
+ * Availability: Since Chrome 12.
+ * Permissions: "fileBrowserHandler"
+ * Important: This API works only on Chrome OS.
+ */
declare module chrome.fileBrowserHandler {
interface SelectionParams {
+ /**
+ * Optional.
+ * List of file extensions that the selected file can have. The list is also used to specify what files to be shown in the select file dialog. Files with the listed extensions are only shown in the dialog. Extensions should not include the leading '.'. Example: ['jpg', 'png']
+ * Since Chrome 23.
+ */
allowedFileExtensions?: string[];
+ /** Suggested name for the file. */
suggestedName: string;
}
interface SelectionResult {
+ /** Optional. Selected file entry. It will be null if a file hasn't been selected. */
entry?: Object;
+ /** Whether the file has been selected. */
success: boolean;
}
+ /** Event details payload for fileBrowserHandler.onExecute event. */
interface FileHandlerExecuteEventDetails {
+ /** Optional. The ID of the tab that raised this event. Tab IDs are unique within a browser session. */
tab_id?: number;
+ /** Array of Entry instances representing files that are targets of this action (selected in ChromeOS file browser). */
entries: any[];
- selectFile(selectionParams: SelectionParams, callback: (result: SelectionResult) => void): void;
}
interface FileBrowserHandlerExecuteEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id, FileHandlerExecuteEventDetails details) {...};
+ * Parameter id: File browser action id as specified in the listener component's manifest.
+ * Parameter details: File handler execute event details.
+ */
addListener(callback: (id: string, details: FileHandlerExecuteEventDetails) => void): void;
}
+ /**
+ * Prompts user to select file path under which file should be saved. When the file is selected, file access permission required to use the file (read, write and create) are granted to the caller. The file will not actually get created during the function call, so function caller must ensure its existence before using it. The function has to be invoked with a user gesture.
+ * Since Chrome 21.
+ * @param selectionParams Parameters that will be used while selecting the file.
+ * @param callback Function called upon completion.
+ * The callback parameter should be a function that looks like this:
+ * function(object result) {...};
+ * Parameter result: Result of the method.
+ */
+ export function selectFile(selectionParams: SelectionParams, callback: (result: SelectionResult) => void): void;
+
+ /** Fired when file system action is executed from ChromeOS file browser. */
var onExecute: FileBrowserHandlerExecuteEvent;
}
+////////////////////
+// File System Provider
+////////////////////
+/**
+ * Use the chrome.fileSystemProvider API to create file systems, that can be accessible from the file manager on Chrome OS.
+ * Availability: Since Chrome 40.
+ * Permissions: "fileSystemProvider"
+ * Important: This API works only on Chrome OS.
+ */
+declare module chrome.fileSystemProvider {
+ interface OpenedFileInfo {
+ /** A request ID to be be used by consecutive read/write and close requests. */
+ openRequestId: number;
+ /** The path of the opened file. */
+ filePath: string;
+ /** Whether the file was opened for reading or writing. */
+ mode: string;
+ }
+
+ interface FileWatchersInfo {
+ /** The path of the entry being observed. */
+ entryPath: string;
+ /** Whether watching should include all child entries recursively. It can be true for directories only. */
+ recursive: boolean;
+ /** Optional. Tag used by the last notification for the watcher. */
+ lastTag?: string;
+ }
+
+ interface EntryMetadata {
+ /** True if it is a directory. */
+ isDirectory: boolean;
+ /** Name of this entry (not full path name). Must not contain '/'. For root it must be empty. */
+ name: string;
+ /** File size in bytes. */
+ size: number;
+ /** The last modified time of this entry. */
+ modificationTime: Date;
+ /** Optional. Mime type for the entry. */
+ mimeType?: string;
+ /** Optional. Thumbnail image as a data URI in either PNG, JPEG or WEBP format, at most 32 KB in size. Optional, but can be provided only when explicitly requested by the onGetMetadataRequested event. */
+ thumbnail?: string;
+ }
+
+ interface FileSystemInfo {
+ /** The identifier of the file system. */
+ fileSystemId: string;
+ /** A human-readable name for the file system. */
+ displayName: string;
+ /** Whether the file system supports operations which may change contents of the file system (such as creating, deleting or writing to files). */
+ writable: boolean;
+ /**
+ * The maximum number of files that can be opened at once. If 0, then not limited.
+ * @since Since Chrome 42.
+ */
+ openedFilesLimit: number;
+ /**
+ * List of currently opened files.
+ * @since Since Chrome 42.
+ */
+ openedFiles: OpenedFileInfo[];
+ /**
+ * Optional.
+ * Whether the file system supports the tag field for observing directories.
+ * @since Since Chrome 45. Warning: this is the current Beta channel.
+ */
+ supportsNotifyTag?: boolean;
+ /**
+ * List of watchers.
+ * @since Since Chrome 45. Warning: this is the current Beta channel.
+ */
+ watchers: FileWatchersInfo[];
+ }
+
+ /** @since Since Chrome 45. Warning: this is the current Beta channel. */
+ interface GetActionsRequestedOptions {
+ /** The identifier of the file system related to this operation. */
+ fileSystemId: string;
+ /** The unique identifier of this request. */
+ requestId: number;
+ /** The path of the entry to return the list of actions for. */
+ entryPath: string;
+ }
+
+ /** @since Since Chrome 45. Warning: this is the current Beta channel. */
+ interface Action {
+ /** The identifier of the action. Any string or CommonActionId for common actions. */
+ id: string;
+ /** Optional. The title of the action. It may be ignored for common actions. */
+ title?: string;
+ }
+
+ /** @since Since Chrome 45. Warning: this is the current Beta channel. */
+ interface ExecuteActionRequestedOptions {
+ /** The identifier of the file system related to this operation. */
+ fileSystemId: string;
+ /** The unique identifier of this request. */
+ requestId: number;
+ /** The path of the entry to be used for the action. */
+ entryPath: string;
+ /** The identifier of the action to be executed. */
+ actionId: string;
+ }
+
+ interface MountOptions {
+ /** The string indentifier of the file system. Must be unique per each extension. */
+ fileSystemId: string;
+ /** A human-readable name for the file system. */
+ displayName: string;
+ /** Optional. Whether the file system supports operations which may change contents of the file system (such as creating, deleting or writing to files). */
+ writable?: boolean;
+ /**
+ * Optional.
+ * The maximum number of files that can be opened at once. If not specified, or 0, then not limited.
+ * @since Since Chrome 41.
+ */
+ openedFilesLimit?: number;
+ /**
+ * Optional.
+ * Whether the file system supports the tag field for observed directories.
+ * @since Since Chrome 45. Warning: this is the current Beta channel.
+ */
+ supportsNotifyTag?: boolean;
+ }
+
+ interface UnmountOptions {
+ /** The identifier of the file system to be unmounted. */
+ fileSystemId: string;
+ }
+
+ interface NotificationChange {
+ /** The path of the changed entry. */
+ entryPath: string;
+ /** The type of the change which happened to the entry. */
+ changeType: string;
+ }
+
+ interface NotificationOptions {
+ /** The identifier of the file system related to this change. */
+ fileSystemId: string;
+ /** The path of the observed entry. */
+ observedPath: string;
+ /** Mode of the observed entry. */
+ recursive: boolean;
+ /** The type of the change which happened to the observed entry. If it is DELETED, then the observed entry will be automatically removed from the list of observed entries. */
+ changeType: string;
+ /** Optional. List of changes to entries within the observed directory (including the entry itself) */
+ changes?: NotificationChange[];
+ /** Optional. Tag for the notification. Required if the file system was mounted with the supportsNotifyTag option. Note, that this flag is necessary to provide notifications about changes which changed even when the system was shutdown. */
+ tag?: string;
+ }
+
+ interface RequestedEventOptions {
+ /** The identifier of the file system related to this operation. */
+ fileSystemId: string;
+ /** The unique identifier of this request. */
+ requestId: number;
+ }
+
+ interface EntryPathRequestedEventOptions extends RequestedEventOptions {
+ /** The path of the entry to which this operation is related to. */
+ entryPath: string;
+ }
+
+ interface MetadataRequestedEventOptions extends EntryPathRequestedEventOptions {
+ /** Set to true if the thumbnail is requested. */
+ thumbnail: boolean;
+ }
+
+ interface DirectoryPathRequestedEventOptions extends RequestedEventOptions {
+ /** The path of the directory which is to be operated on. */
+ directoryPath: string;
+ }
+
+ interface FilePathRequestedEventOptions extends RequestedEventOptions {
+ /** The path of the entry for the operation */
+ filePath: string;
+ }
+
+ interface OpenFileRequestedEventOptions extends FilePathRequestedEventOptions {
+ /** Whether the file will be used for reading or writing. */
+ mode: string;
+ }
+
+ interface OpenedFileRequestedEventOptions extends RequestedEventOptions {
+ /** A request ID used to open the file. */
+ openRequestId: number;
+ }
+
+ interface OpenedFileOffsetRequestedEventOptions extends OpenedFileRequestedEventOptions {
+ /** Position in the file (in bytes) to start reading from. */
+ offset: number;
+ /** Number of bytes to be returned. */
+ length: number;
+ }
+
+ interface DirectoryPathRecursiveRequestedEventOptions extends DirectoryPathRequestedEventOptions {
+ /** Whether the operation is recursive (for directories only). */
+ recursive: boolean;
+ }
+
+ interface EntryPathRecursiveRequestedEventOptions extends EntryPathRequestedEventOptions {
+ /** Whether the operation is recursive (for directories only). */
+ recursive: boolean;
+ }
+
+ interface SourceTargetPathRequestedEventOptions extends RequestedEventOptions {
+ /** The source path for the operation. */
+ sourcePath: string;
+ /** The destination path for the operation. */
+ targetPath: string;
+ }
+
+ interface FilePathLengthRequestedEventOptions extends FilePathRequestedEventOptions {
+ /** Number of bytes to be retained after the operation completes. */
+ length: number;
+ }
+
+ interface OpenedFileIoRequestedEventOptions extends OpenedFileRequestedEventOptions {
+ /** Position in the file (in bytes) to start operating from. */
+ offset: number;
+ /** Buffer of bytes to be operated on the file. */
+ data: ArrayBuffer;
+ }
+
+ interface OperationRequestedEventOptions extends RequestedEventOptions {
+ /** An ID of the request to which this operation is related. */
+ operationRequestId: number;
+ }
+
+ interface RequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: RequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface MetadataRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: MetadataRequestedEventOptions, successCallback: (metadata: EntryMetadata) => void, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface DirectoryPathRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: DirectoryPathRequestedEventOptions, successCallback: (entries: EntryMetadata[], hasMore: boolean) => void, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface OpenFileRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: OpenFileRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface OpenedFileRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: OpenedFileRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface OpenedFileOffsetRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: OpenedFileOffsetRequestedEventOptions, successCallback: (data: ArrayBuffer, hasMore: boolean) => void, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface DirectoryPathRecursiveRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: DirectoryPathRecursiveRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface EntryPathRecursiveRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: EntryPathRecursiveRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface FilePathRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: FilePathRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface SourceTargetPathRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: SourceTargetPathRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface FilePathLengthRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: FilePathLengthRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface OpenedFileIoRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: OpenedFileIoRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface OperationRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object options, function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (options: OperationRequestedEventOptions, successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ interface OptionlessRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(function successCallback, function errorCallback) {...};
+ */
+ addListener(callback: (successCallback: Function, errorCallback: (error: string) => void) => void): void;
+ }
+
+ /**
+ * Mounts a file system with the given fileSystemId and displayName. displayName will be shown in the left panel of Files.app. displayName can contain any characters including '/', but cannot be an empty string. displayName must be descriptive but doesn't have to be unique. The fileSystemId must not be an empty string.
+ * Depending on the type of the file system being mounted, the source option must be set appropriately.
+ * In case of an error, runtime.lastError will be set with a corresponding error code.
+ * @param callback A generic result callback to indicate success or failure.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function mount(options: MountOptions, callback?: () => void): void;
+ /**
+ * Unmounts a file system with the given fileSystemId. It must be called after onUnmountRequested is invoked. Also, the providing extension can decide to perform unmounting if not requested (eg. in case of lost connection, or a file error).
+ * In case of an error, runtime.lastError will be set with a corresponding error code.
+ * @param callback A generic result callback to indicate success or failure.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function unmount(options: UnmountOptions, callback?: () => void): void;
+ /**
+ * Returns all file systems mounted by the extension.
+ * @param callback Callback to receive the result of getAll function.
+ * The callback parameter should be a function that looks like this:
+ * function(array of FileSystemInfo fileSystems) {...};
+ */
+ export function getAll(callback: (fileSystems: FileSystemInfo[]) => void): void;
+ /**
+ * Returns information about a file system with the passed fileSystemId.
+ * @since Since Chrome 42.
+ * @param callback Callback to receive the result of get function.
+ * The callback parameter should be a function that looks like this:
+ * function(FileSystemInfo fileSystem) {...};
+ */
+ export function get(fileSystemId: string, callback: (fileSystem: FileSystemInfo) => void): void;
+ /**
+ * Notifies about changes in the watched directory at observedPath in recursive mode. If the file system is mounted with supportsNofityTag, then tag must be provided, and all changes since the last notification always reported, even if the system was shutdown. The last tag can be obtained with getAll.
+ * To use, the file_system_provider.notify manifest option must be set to true.
+ * Value of tag can be any string which is unique per call, so it's possible to identify the last registered notification. Eg. if the providing extension starts after a reboot, and the last registered notification's tag is equal to "123", then it should call notify for all changes which happened since the change tagged as "123". It cannot be an empty string.
+ * Not all providers are able to provide a tag, but if the file system has a changelog, then the tag can be eg. a change number, or a revision number.
+ * Note that if a parent directory is removed, then all descendant entries are also removed, and if they are watched, then the API must be notified about the fact. Also, if a directory is renamed, then all descendant entries are in fact removed, as there is no entry under their original paths anymore.
+ * In case of an error, runtime.lastError will be set will a corresponding error code.
+ * @param callback A generic result callback to indicate success or failure.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function notify(options: NotificationOptions, callback: () => void): void;
+
+ /** Raised when unmounting for the file system with the fileSystemId identifier is requested. In the response, the unmount API method must be called together with successCallback. If unmounting is not possible (eg. due to a pending operation), then errorCallback must be called. */
+ var onUnmountRequested: RequestedEvent;
+ /** Raised when metadata of a file or a directory at entryPath is requested. The metadata must be returned with the successCallback call. In case of an error, errorCallback must be called. */
+ var onGetMetadataRequested: MetadataRequestedEvent;
+ /** Raised when contents of a directory at directoryPath are requested. The results must be returned in chunks by calling the successCallback several times. In case of an error, errorCallback must be called. */
+ var onReadDirectoryRequested: DirectoryPathRequestedEvent;
+ /** Raised when opening a file at filePath is requested. If the file does not exist, then the operation must fail. Maximum number of files opened at once can be specified with MountOptions. */
+ var onOpenFileRequested: OpenFileRequestedEvent;
+ /** Raised when opening a file previously opened with openRequestId is requested to be closed. */
+ var onCloseFileRequested: OpenedFileRequestedEvent;
+ /** Raised when reading contents of a file opened previously with openRequestId is requested. The results must be returned in chunks by calling successCallback several times. In case of an error, errorCallback must be called. */
+ var onReadFileRequested: OpenedFileOffsetRequestedEvent;
+ /** Raised when creating a directory is requested. The operation must fail with the EXISTS error if the target directory already exists. If recursive is true, then all of the missing directories on the directory path must be created. */
+ var onCreateDirectoryRequested: DirectoryPathRecursiveRequestedEvent;
+ /** Raised when deleting an entry is requested. If recursive is true, and the entry is a directory, then all of the entries inside must be recursively deleted as well. */
+ var onDeleteEntryRequested: EntryPathRecursiveRequestedEvent;
+ /** Raised when creating a file is requested. If the file already exists, then errorCallback must be called with the "EXISTS" error code. */
+ var onCreateFileRequested: FilePathRequestedEvent;
+ /** Raised when copying an entry (recursively if a directory) is requested. If an error occurs, then errorCallback must be called. */
+ var onCopyEntryRequested: SourceTargetPathRequestedEvent;
+ /** Raised when moving an entry (recursively if a directory) is requested. If an error occurs, then errorCallback must be called. */
+ var onMoveEntryRequested: SourceTargetPathRequestedEvent;
+ /** Raised when truncating a file to a desired length is requested. If an error occurs, then errorCallback must be called. */
+ var onTruncateRequested: FilePathLengthRequestedEvent;
+ /** Raised when writing contents to a file opened previously with openRequestId is requested. */
+ var onWriteFileRequested: OpenedFileIoRequestedEvent;
+ /** Raised when aborting an operation with operationRequestId is requested. The operation executed with operationRequestId must be immediately stopped and successCallback of this abort request executed. If aborting fails, then errorCallback must be called. Note, that callbacks of the aborted operation must not be called, as they will be ignored. Despite calling errorCallback, the request may be forcibly aborted. */
+ var onAbortRequested: OperationRequestedEvent;
+ /**
+ * Raised when showing a configuration dialog for fileSystemId is requested. If it's handled, the file_system_provider.configurable manfiest option must be set to true.
+ * @since Since Chrome 44.
+ */
+ var onConfigureRequested: RequestedEvent;
+ /**
+ * Raised when showing a dialog for mounting a new file system is requested. If the extension/app is a file handler, then this event shouldn't be handled. Instead app.runtime.onLaunched should be handled in order to mount new file systems when a file is opened. For multiple mounts, the file_system_provider.multiple_mounts manifest option must be set to true.
+ * @since Since Chrome 44.
+ */
+ var onMountRequested: OptionlessRequestedEvent;
+ /**
+ * Raised when setting a new directory watcher is requested. If an error occurs, then errorCallback must be called.
+ * @since Since Chrome 45. Warning: this is the current Beta channel.
+ */
+ var onAddWatcherRequested: EntryPathRecursiveRequestedEvent;
+ /**
+ * Raised when the watcher should be removed. If an error occurs, then errorCallback must be called.
+ * @since Since Chrome 45. Warning: this is the current Beta channel.
+ */
+ var onRemoveWatcherRequested: EntryPathRecursiveRequestedEvent;
+}
+
////////////////////
// Font Settings
////////////////////
+/**
+ * Use the chrome.fontSettings API to manage Chrome's font settings.
+ * Availability: Since Chrome 22.
+ * Permissions: "fontSettings"
+ */
declare module chrome.fontSettings {
+ /** Represents a font name. */
interface FontName {
+ /** The display name of the font. */
displayName: string;
+ /** The font ID. */
fontId: string;
}
interface DefaultFontSizeDetails {
+ /** The font size in pixels. */
pixelSize: number;
}
interface FontDetails {
+ /** The generic font family for the font. */
genericFamily: string;
+ /** Optional. The script for the font. If omitted, the global script font setting is affected. */
script?: string;
}
interface FullFontDetails {
+ /** The generic font family for which the font setting has changed. */
genericFamily: string;
+ /** The level of control this extension has over the setting. */
levelOfControl: string;
+ /** Optional. The script code for which the font setting has changed. */
script?: string;
+ /** The font ID. See the description in getFont. */
fontId: string;
}
interface FontDetailsResult {
+ /** The level of control this extension has over the setting. */
levelOfControl: string;
+ /** The font ID. Rather than the literal font ID preference value, this may be the ID of the font that the system resolves the preference value to. So, fontId can differ from the font passed to setFont, if, for example, the font is not available on the system. The empty string signifies fallback to the global script font setting. */
fontId: string;
}
interface FontSizeDetails {
+ /** The font size in pixels. */
pixelSize: number;
+ /** The level of control this extension has over the setting. */
levelOfControl: string;
}
interface SetFontSizeDetails {
+ /** The font size in pixels. */
pixelSize: number;
}
- interface SetFontDetails {
- genericFamily: string;
- script?: string;
+ interface SetFontDetails extends FontDetails {
+ /** The font ID. The empty string means to fallback to the global script font setting. */
fontId: string;
}
interface DefaultFixedFontSizeChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
addListener(callback: (details: FontSizeDetails) => void): void;
}
interface DefaultFontSizeChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
addListener(callback: (details: FontSizeDetails) => void): void;
}
interface MinimumFontSizeChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
addListener(callback: (details: FontSizeDetails) => void): void;
}
interface FontChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
addListener(callback: (details: FullFontDetails) => void): void;
}
+ /**
+ * Sets the default font size.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function setDefaultFontSize(details: DefaultFontSizeDetails, callback?: Function): void;
+ /**
+ * Gets the font for a given script and generic font family.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(object details) {...};
+ */
export function getFont(details: FontDetails, callback?: (details: FontDetailsResult) => void): void;
- export function getDefaultFontSize(details?: FontSizeDetails, callback?: (options: FontSizeDetails) => void): void;
+ /**
+ * Gets the default font size.
+ * @param details This parameter is currently unused.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(object details) {...};
+ */
+ export function getDefaultFontSize(details?: Object, callback?: (options: FontSizeDetails) => void): void;
+ /**
+ * Gets the minimum font size.
+ * @param details This parameter is currently unused.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(object details) {...};
+ */
export function getMinimumFontSize(details?: FontSizeDetails, callback?: (options: FontSizeDetails) => void): void;
+ /**
+ * Sets the minimum font size.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function setMinimumFontSize(details: SetFontSizeDetails, callback?: Function): void;
+ /**
+ * Gets the default size for fixed width fonts.
+ * @param details This parameter is currently unused.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(object details) {...};
+ */
export function getDefaultFixedFontSize(details?: Object, callback?: (details: FontSizeDetails) => void): void;
+ /**
+ * Clears the default font size set by this extension, if any.
+ * @param details This parameter is currently unused.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function clearDefaultFontSize(details?: Object, callback?: Function): void;
+ /**
+ * Sets the default size for fixed width fonts.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function setDefaultFixedFontSize(details: SetFontSizeDetails, callback?: Function): void;
+ /**
+ * Clears the font set by this extension, if any.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function clearFont(details: FontDetails, callback?: Function): void;
+ /**
+ * Sets the font for a given script and generic font family.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(object details) {...};
+ */
export function setFont(details: SetFontDetails, callback?: Function): void;
+ /**
+ * Clears the minimum font size set by this extension, if any.
+ * @param details This parameter is currently unused.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function clearMinimumFontSize(details?: Object, callback?: Function): void;
+ /**
+ * Gets a list of fonts on the system.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of FontName results) {...};
+ */
export function getFontList(callback: (results: FontName[]) => void): void;
+ /**
+ * Clears the default fixed font size set by this extension, if any.
+ * @param details This parameter is currently unused.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
export function clearDefaultFixedFontSize(details: Object, callback?: Function): void;
+ /** Fired when the default fixed font size setting changes. */
var onDefaultFixedFontSizeChanged: DefaultFixedFontSizeChangedEvent;
+ /** Fired when the default font size setting changes. */
var onDefaultFontSizeChanged: DefaultFontSizeChangedEvent;
+ /** Fired when the minimum font size setting changes. */
var onMinimumFontSizeChanged: MinimumFontSizeChangedEvent;
+ /** Fired when a font setting changes. */
var onFontChanged: FontChangedEvent;
}
+////////////////////
+// Google Cloud Messaging
+////////////////////
+/**
+ * Use chrome.gcm to enable apps and extensions to send and receive messages through the Google Cloud Messaging Service.
+ * Availability: Since Chrome 35.
+ * Permissions: "gcm"
+ */
+declare module chrome.gcm {
+ interface OutgoingMessage {
+ /** The ID of the server to send the message to as assigned by Google API Console. */
+ destinationId: string;
+ /** The ID of the message. It must be unique for each message in scope of the applications. See the Cloud Messaging documentation for advice for picking and handling an ID. */
+ messageId: string;
+ /** Optional. Time-to-live of the message in seconds. If it is not possible to send the message within that time, an onSendError event will be raised. A time-to-live of 0 indicates that the message should be sent immediately or fail if it's not possible. The maximum and a default value of time-to-live is 86400 seconds (1 day). */
+ timeToLive?: number;
+ /** Message data to send to the server. Case-insensitive goog. and google, as well as case-sensitive collapse_key are disallowed as key prefixes. Sum of all key/value pairs should not exceed gcm.MAX_MESSAGE_SIZE. */
+ data: Object;
+ }
+
+ interface IncomingMessage {
+ /** The message data. */
+ data: Object;
+ /**
+ * Optional.
+ * The sender who issued the message.
+ * @since Since Chrome 41.
+ */
+ from?: string;
+ /**
+ * Optional.
+ * The collapse key of a message. See Collapsible Messages section of Cloud Messaging documentation for details.
+ */
+ collapseKey?: string;
+ }
+
+ interface GcmError {
+ /** The error message describing the problem. */
+ errorMessage: string;
+ /** Optional. The ID of the message with this error, if error is related to a specific message. */
+ messageId?: string;
+ /** Additional details related to the error, when available. */
+ detail: Object;
+ }
+
+ interface MessageReceptionEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object message) {...};
+ * Parameter message: A message received from another party via GCM.
+ */
+ addListener(callback: (message: IncomingMessage) => void): void;
+ }
+
+ interface MessageDeletionEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
+ }
+
+ interface GcmErrorEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object error) {...};
+ * Parameter error: An error that occured while trying to send the message either in Chrome or on the GCM server. Application can retry sending the message with a reasonable backoff and possibly longer time-to-live.
+ */
+ addListener(callback: (error: GcmError) => void): void;
+ }
+
+ /** The maximum size (in bytes) of all key/value pairs in a message. */
+ var MAX_MESSAGE_SIZE: number;
+
+ /**
+ * Registers the application with GCM. The registration ID will be returned by the callback. If register is called again with the same list of senderIds, the same registration ID will be returned.
+ * @param senderIds A list of server IDs that are allowed to send messages to the application. It should contain at least one and no more than 100 sender IDs.
+ * @param callback Function called when registration completes. It should check runtime.lastError for error when registrationId is empty.
+ * The callback parameter should be a function that looks like this:
+ * function(string registrationId) {...};
+ * Parameter registrationId: A registration ID assigned to the application by the GCM.
+ */
+ export function register(senderIds: string[], callback: (registrationId: string) => void): void;
+ /**
+ * Unregisters the application from GCM.
+ * @param callback A function called after the unregistration completes. Unregistration was successful if runtime.lastError is not set.
+ * The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ export function unregister(callback: () => void): void;
+ /**
+ * Sends a message according to its contents.
+ * @param message A message to send to the other party via GCM.
+ * @param callback A function called after the message is successfully queued for sending. runtime.lastError should be checked, to ensure a message was sent without problems.
+ * The callback parameter should be a function that looks like this:
+ * function(string messageId) {...};
+ * Parameter messageId: The ID of the message that the callback was issued for.
+ */
+ export function send(message: OutgoingMessage, callback: (messageId: string) => void): void;
+
+ /** Fired when a message is received through GCM. */
+ var onMessage: MessageReceptionEvent;
+ /** Fired when a GCM server had to delete messages sent by an app server to the application. See Messages deleted event section of Cloud Messaging documentation for details on handling this event. */
+ var onMessagesDeleted: MessageDeletionEvent;
+ /** Fired when it was not possible to send a message to the GCM server. */
+ var onSendError: GcmErrorEvent;
+}
+
////////////////////
// History
////////////////////
+/**
+ * Use the chrome.history API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see Override Pages.
+ * Availability: Since Chrome 5.
+ * Permissions: "history"
+ */
declare module chrome.history {
+ /** An object encapsulating one visit to a URL. */
interface VisitItem {
+ /** The transition type for this visit from its referrer. */
transition: string;
+ /** Optional. When this visit occurred, represented in milliseconds since the epoch. */
visitTime?: number;
+ /** The unique identifier for this visit. */
visitId: string;
+ /** The visit ID of the referrer. */
referringVisitId: string;
+ /** The unique identifier for the item. */
id: string;
}
+ /** An object encapsulating one result of a history query. */
interface HistoryItem {
+ /** Optional. The number of times the user has navigated to this page by typing in the address. */
typedCount?: number;
+ /** Optional. The title of the page when it was last loaded. */
title?: string;
+ /** Optional. The URL navigated to by a user. */
url?: string;
+ /** Optional. When this page was last loaded, represented in milliseconds since the epoch. */
lastVisitTime?: number;
+ /** Optional. The number of times the user has navigated to this page. */
visitCount?: number;
+ /** The unique identifier for the item. */
id: string;
}
interface HistoryQuery {
+ /** A free-text query to the history service. Leave empty to retrieve all pages. */
text: string;
+ /** Optional. The maximum number of results to retrieve. Defaults to 100. */
maxResults?: number;
+ /** Optional. Limit results to those visited after this date, represented in milliseconds since the epoch. */
startTime?: number;
+ /** Optional. Limit results to those visited before this date, represented in milliseconds since the epoch. */
endTime?: number;
}
interface Url {
+ /** The URL for the operation. It must be in the format as returned from a call to history.search. */
url: string;
}
interface Range {
+ /** Items added to history before this date, represented in milliseconds since the epoch. */
endTime: number;
+ /** Items added to history after this date, represented in milliseconds since the epoch. */
startTime: number;
}
interface RemovedResult {
+ /** True if all history was removed. If true, then urls will be empty. */
allHistory: boolean;
+ /** Optional. */
urls?: string[];
}
interface HistoryVisitedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( HistoryItem result) {...};
+ */
addListener(callback: (result: HistoryItem) => void): void;
}
interface HistoryVisitRemovedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object removed) {...};
+ */
addListener(callback: (removed: RemovedResult) => void): void;
}
+ /**
+ * Searches the history for the last visit time of each page matching the query.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of HistoryItem results) {...};
+ */
export function search(query: HistoryQuery, callback: (results: HistoryItem[]) => void): void;
- export function addUrl(details: Url, callback?: Function): void;
- export function deleteRange(range: Range, callback: Function): void;
- export function deleteAll(callback: Function): void;
+ /**
+ * Adds a URL to the history at the current time with a transition type of "link".
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function addUrl(details: Url, callback?: () => void): void;
+ /**
+ * Removes all items within the specified date range from the history. Pages will not be removed from the history unless all visits fall within the range.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ export function deleteRange(range: Range, callback: () => void): void;
+ /**
+ * Deletes all items from the history.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ export function deleteAll(callback: () => void): void;
+ /**
+ * Retrieves information about visits to a URL.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of VisitItem results) {...};
+ */
export function getVisits(details: Url, callback: (results: VisitItem[]) => void): void;
- export function deleteUrl(details: Url, callback?: Function): void;
+ /**
+ * Removes all occurrences of the given URL from the history.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function deleteUrl(details: Url, callback?: () => void): void;
+ /** Fired when a URL is visited, providing the HistoryItem data for that URL. This event fires before the page has loaded. */
var onVisited: HistoryVisitedEvent;
+ /** Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged from history. */
var onVisitRemoved: HistoryVisitRemovedEvent;
}
+////////////////////
+// i18n
+////////////////////
+/**
+ * Use the chrome.i18n infrastructure to implement internationalization across your whole app or extension.
+ * @since Chrome 5.
+ */
+declare module chrome.i18n {
+ /**
+ * Gets the accept-languages of the browser. This is different from the locale used by the browser; to get the locale, use i18n.getUILanguage.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of string languages) {...};
+ * Parameter languages: Array of the accept languages of the browser, such as en-US,en,zh-CN
+ */
+ export function getAcceptLanguages(callback: (languages: string[]) => void): void;
+ /**
+ * Gets the localized string for the specified message. If the message is missing, this method returns an empty string (''). If the format of the getMessage() call is wrong — for example, messageName is not a string or the substitutions array has more than 9 elements — this method returns undefined.
+ * @param messageName The name of the message, as specified in the messages.json file.
+ * @param substitutions Optional. Up to 9 substitution strings, if the message requires any.
+ */
+ export function getMessage(messageName: string, substitutions?: any): string;
+ /**
+ * Gets the browser UI language of the browser. This is different from i18n.getAcceptLanguages which returns the preferred user languages.
+ * @since Chrome 35.
+ */
+ export function getUILanguage(): string;
+}
////////////////////
// Identity
////////////////////
+/**
+ * Use the chrome.identity API to get OAuth2 access tokens.
+ * Permissions: "identity"
+ * @since Chrome 29.
+ */
declare module chrome.identity {
- var getAuthToken: (options: any, cb: (token: {}) => void) => void;
- var launchWebAuthFlow: (options: any, cb: (redirect_url: string) => void) => void;
-}
+ /** @since Chrome 32. */
+ interface AccountInfo {
+ /** A unique identifier for the account. This ID will not change for the lifetime of the account. */
+ id: string;
+ }
+ interface TokenDetails {
+ /**
+ * Optional.
+ * Fetching a token may require the user to sign-in to Chrome, or approve the application's requested scopes. If the interactive flag is true, getAuthToken will prompt the user as necessary. When the flag is false or omitted, getAuthToken will return failure any time a prompt would be required.
+ */
+ interactive?: boolean;
+ /**
+ * Optional.
+ * The account ID whose token should be returned. If not specified, the primary account for the profile will be used.
+ * account is only supported when the "enable-new-profile-management" flag is set.
+ * @since Chrome 37.
+ */
+ account?: AccountInfo;
+ /**
+ * Optional.
+ * A list of OAuth2 scopes to request.
+ * When the scopes field is present, it overrides the list of scopes specified in manifest.json.
+ * @since Chrome 37.
+ */
+ scopes?: string[];
+ }
-////////////////////
-// Internationalization
-////////////////////
-declare module chrome.i18n {
- export function getMessage(messageName: string, substitutions?: any): string;
- export function getAcceptLanguages(callback: (languages: string[]) => void): void;
- export function getUILanguage(): string;
+ interface UserInfo {
+ /** An email address for the user account signed into the current profile. Empty if the user is not signed in or the identity.email manifest permission is not specified. */
+ email: string;
+ /** A unique identifier for the account. This ID will not change for the lifetime of the account. Empty if the user is not signed in or (in M41+) the identity.email manifest permission is not specified. */
+ id: string;
+ }
+
+ interface TokenInformation {
+ /** The specific token that should be removed from the cache. */
+ token: string;
+ }
+
+ interface WebAuthFlowOptions {
+ /** The URL that initiates the auth flow. */
+ url: string;
+ /**
+ * Optional.
+ * Whether to launch auth flow in interactive mode.
+ * Since some auth flows may immediately redirect to a result URL, launchWebAuthFlow hides its web view until the first navigation either redirects to the final URL, or finishes loading a page meant to be displayed.
+ * If the interactive flag is true, the window will be displayed when a page load completes. If the flag is false or omitted, launchWebAuthFlow will return with an error if the initial navigation does not complete the flow.
+ */
+ interactive?: boolean;
+ }
+
+ interface SignInChangeEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( AccountInfo account, boolean signedIn) {...};
+ */
+ addListener(callback: (account: AccountInfo, signedIn: boolean) => void): void;
+ }
+
+ /**
+ * Retrieves a list of AccountInfo objects describing the accounts present on the profile.
+ * getAccounts is only supported on dev channel.
+ * Dev channel only.
+ */
+ export function getAccounts(callback: (accounts: AccountInfo[]) => void): void;
+ /**
+ * Gets an OAuth2 access token using the client ID and scopes specified in the oauth2 section of manifest.json.
+ * The Identity API caches access tokens in memory, so it's ok to call getAuthToken non-interactively any time a token is required. The token cache automatically handles expiration.
+ * For a good user experience it is important interactive token requests are initiated by UI in your app explaining what the authorization is for. Failing to do this will cause your users to get authorization requests, or Chrome sign in screens if they are not signed in, with with no context. In particular, do not use getAuthToken interactively when your app is first launched.
+ * @param details Token options.
+ * @param callback Called with an OAuth2 access token as specified by the manifest, or undefined if there was an error.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(string token) {...};
+ */
+ export function getAuthToken(details: TokenDetails, callback?: (token: string) => void): void;
+ /**
+ * Retrieves email address and obfuscated gaia id of the user signed into a profile.
+ * This API is different from identity.getAccounts in two ways. The information returned is available offline, and it only applies to the primary account for the profile.
+ * @since Chrome 37.
+ */
+ export function getProfileUserInfo(callback: (userInfo: UserInfo) => void): void;
+ /**
+ * Removes an OAuth2 access token from the Identity API's token cache.
+ * If an access token is discovered to be invalid, it should be passed to removeCachedAuthToken to remove it from the cache. The app may then retrieve a fresh token with getAuthToken.
+ * @param details Token information.
+ * @param callback Called when the token has been removed from the cache.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function removeCachedAuthToken(details: TokenInformation, callback?: () => void): void;
+ /**
+ * Starts an auth flow at the specified URL.
+ * This method enables auth flows with non-Google identity providers by launching a web view and navigating it to the first URL in the provider's auth flow. When the provider redirects to a URL matching the pattern https://<app-id>.chromiumapp.org/*, the window will close, and the final redirect URL will be passed to the callback function.
+ * For a good user experience it is important interactive auth flows are initiated by UI in your app explaining what the authorization is for. Failing to do this will cause your users to get authorization requests with no context. In particular, do not launch an interactive auth flow when your app is first launched.
+ * @param details WebAuth flow options.
+ * @param callback Called with the URL redirected back to your application.
+ * The callback parameter should be a function that looks like this:
+ * function(string responseUrl) {...};
+ */
+ export function launchWebAuthFlow(details: WebAuthFlowOptions, callback: (responseUrl?: string) => void): void;
+ /**
+ * Generates a redirect URL to be used in launchWebAuthFlow.
+ * The generated URLs match the pattern https://<app-id>.chromiumapp.org/*.
+ * @since Chrome 33.
+ * @param path Optional. The path appended to the end of the generated URL.
+ */
+ export function getRedirectURL(path?: string): void;
+
+ /**
+ * Fired when signin state changes for an account on the user's profile.
+ * @since Chrome 33.
+ */
+ var onSignInChanged: SignInChangeEvent;
}
////////////////////
// Idle
////////////////////
+/**
+ * Use the chrome.idle API to detect when the machine's idle state changes.
+ * Permissions: "idle"
+ * @since Chrome 6.
+ */
declare module chrome.idle {
interface IdleStateChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( IdleState newState) {...};
+ */
addListener(callback: (newState: string) => void): void;
}
- export function queryState(thresholdSeconds: number, callback: (newState: string) => void): void;
+ /**
+ * Returns "locked" if the system is locked, "idle" if the user has not generated any input for a specified number of seconds, or "active" otherwise.
+ * @param detectionIntervalInSeconds The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected.
+ * Since Chrome 25.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( IdleState newState) {...};
+ */
+ export function queryState(detectionIntervalInSeconds: number, callback: (newState: string) => void): void;
+ /**
+ * Sets the interval, in seconds, used to determine when the system is in an idle state for onStateChanged events. The default interval is 60 seconds.
+ * @since Chrome 25.
+ * @param intervalInSeconds Threshold, in seconds, used to determine when the system is in an idle state.
+ */
+ export function setDetectionInterval(intervalInSeconds: number): void;
+ /** Fired when the system changes to an active, idle or locked state. The event fires with "locked" if the screen is locked or the screensaver activates, "idle" if the system is unlocked and the user has not generated any input for a specified number of seconds, and "active" when the user generates input on an idle system. */
var onStateChanged: IdleStateChangedEvent;
}
////////////////////
// Input - IME
////////////////////
+/**
+ * Use the chrome.input.ime API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window.
+ * Permissions: "input"
+ * @since Chrome 21.
+ */
declare module chrome.input.ime {
+ /** See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent */
interface KeyboardEvent {
+ /**
+ * Optional.
+ * Whether or not the SHIFT key is pressed.
+ */
shiftKey?: boolean;
+ /**
+ * Optional.
+ * Whether or not the ALT key is pressed.
+ */
altKey?: boolean;
+ /** The ID of the request. */
requestId: string;
+ /** Value of the key being pressed */
key: string;
+ /**
+ * Optional.
+ * Whether or not the CTRL key is pressed.
+ */
ctrlKey?: boolean;
+ /** One of keyup or keydown. */
type: string;
+ /**
+ * Optional.
+ * The extension ID of the sender of this keyevent.
+ * @since Chrome 34.
+ */
+ extensionId?: string;
+ /**
+ * Optional.
+ * Value of the physical key being pressed. The value is not affected by current keyboard layout or modifier state.
+ * @since Chrome 26.
+ */
+ code: string;
+ /**
+ * Optional.
+ * The deprecated HTML keyCode, which is system- and implementation-dependent numerical code signifying the unmodified identifier associated with the key pressed.
+ * @since Chrome 37.
+ */
+ keyCode?: number;
+ /**
+ * Optional.
+ * Whether or not the CAPS_LOCK is enabled.
+ * @since Chrome 29.
+ */
+ capsLock?: boolean;
}
+ /** Describes an input Context */
interface InputContext {
+ /** This is used to specify targets of text field operations. This ID becomes invalid as soon as onBlur is called. */
contextID: number;
+ /** Type of value this text field edits, (Text, Number, URL, etc) */
type: string;
+ /**
+ * Whether the text field wants auto-correct.
+ * @since Chrome 40.
+ */
+ autoCorrect: boolean;
+ /**
+ * Whether the text field wants auto-complete.
+ * @since Chrome 40.
+ */
+ autoComplete: boolean;
+ /**
+ * Whether the text field wants spell-check.
+ * @since Chrome 40.
+ */
+ spellCheck: boolean;
+ }
+
+ /**
+ * A menu item used by an input method to interact with the user from the language menu.
+ * @since Chrome 30.
+ */
+ interface MenuItem {
+ /** String that will be passed to callbacks referencing this MenuItem. */
+ id: string;
+ /** Optional. Text displayed in the menu for this item. */
+ label?: string;
+ /** Optional. The type of menu item. */
+ style?: string;
+ /** Optional. Indicates this item is visible. */
+ visible?: boolean;
+ /** Indicates this item should be drawn with a check. */
+ checked?: boolean;
+ /** Indicates this item is enabled. */
+ enabled?: boolean;
}
interface ImeParameters {
- items: Object[];
+ /** MenuItems to use. */
+ items: MenuItem[];
+ /** ID of the engine to use */
engineID: string;
}
interface CommitTextParameters {
+ /** The text to commit */
text: string;
+ /** ID of the context where the text will be committed */
contextID: number;
}
+ interface CandidateUsage {
+ /** The title string of details description. */
+ title: string;
+ /** The body string of detail description. */
+ body: string;
+ }
+
+ interface CandidateTemplate {
+ /** The candidate */
+ candidate: string;
+ /** The candidate's id */
+ id: number;
+ /**
+ * Optional.
+ * The id to add these candidates under
+ */
+ parentId?: number;
+ /**
+ * Optional.
+ * Short string displayed to next to the candidate, often the shortcut key or index
+ */
+ label?: string;
+ /**
+ * Optional.
+ * Additional text describing the candidate
+ */
+ annotation?: string;
+ /**
+ * Optional.
+ * The usage or detail description of word.
+ */
+ usage?: CandidateUsage;
+ }
+
interface CandidatesParameters {
+ /** ID of the context that owns the candidate window. */
contextID: number;
- candidates: Object[];
+ /** List of candidates to show in the candidate window */
+ candidates: CandidateTemplate[];
+ }
+
+ interface CompositionParameterSegment {
+ /** Index of the character to start this segment at */
+ start: number;
+ /** Index of the character to end this segment after. */
+ end: number;
+ /** The type of the underline to modify this segment. */
+ style: string;
}
interface CompositionParameters {
+ /** ID of the context where the composition text will be set */
contextID: number;
+ /** Text to set */
text: string;
- segments: Object[];
+ /** Optional. List of segments and their associated types. */
+ segments: CompositionParameterSegment[];
+ /** Position in the text of the cursor. */
cursor: number;
+ /** Optional. Position in the text that the selection starts at. */
selectionStart?: number;
+ /** Optional. Position in the text that the selection ends at. */
selectionEnd?: number;
}
@@ -1156,142 +4025,638 @@ declare module chrome.input.ime {
engineId: string;
}
- interface CandidateWindowPropertiesParameters {
+ interface CandidateWindowParameterProperties {
+ /**
+ * Optional.
+ * True to show the cursor, false to hide it.
+ */
cursorVisible?: boolean;
+ /**
+ * Optional.
+ * True if the candidate window should be rendered vertical, false to make it horizontal.
+ */
vertical?: boolean;
+ /**
+ * Optional.
+ * The number of candidates to display per page.
+ */
pageSize?: number;
+ /**
+ * Optional.
+ * True to display the auxiliary text, false to hide it.
+ */
auxiliaryTextVisible?: boolean;
+ /**
+ * Optional.
+ * Text that is shown at the bottom of the candidate window.
+ */
auxiliaryText?: string;
+ /**
+ * Optional.
+ * True to show the Candidate window, false to hide it.
+ */
visible?: boolean;
+ /**
+ * Optional.
+ * Where to display the candidate window.
+ * @since Chrome 28.
+ */
+ windowPosition?: string;
+ }
+
+ interface CandidateWindowParameter {
+ /** ID of the engine to set properties on. */
+ engineID: string;
+ properties: CandidateWindowParameterProperties;
}
interface ClearCompositionParameters {
+ /** ID of the context where the composition will be cleared */
contextID: number;
}
interface CursorPositionParameters {
+ /** ID of the candidate to select. */
candidateID: number;
+ /** ID of the context that owns the candidate window. */
+ contextID: number;
+ }
+
+ interface SendKeyEventParameters {
+ /** ID of the context where the key events will be sent, or zero to send key events to non-input field. */
+ contextID: number;
+ /** Data on the key event. */
+ keyData: KeyboardEvent[];
+ }
+
+ interface DeleteSurroundingTextParameters {
+ /** ID of the engine receiving the event. */
+ engineID: string;
+ /** ID of the context where the surrounding text will be deleted. */
contextID: number;
+ /** The offset from the caret position where deletion will start. This value can be negative. */
+ offset: number;
+ /** The number of characters to be deleted */
+ length: number;
+ }
+
+ interface SurroundingTextInfo {
+ /** The text around cursor. */
+ text: string;
+ /** The ending position of the selection. This value indicates caret position if there is no selection. */
+ focus: number;
+ /** The beginning position of the selection. This value indicates caret position if is no selection. */
+ anchor: number;
}
interface BlurEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(integer contextID) {...};
+ * Parameter contextID: The ID of the text field that has lost focus. The ID is invalid after this call
+ */
addListener(callback: (contextID: number) => void): void;
}
interface CandidateClickedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID, integer candidateID, MouseButton button) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ * Parameter candidateID: ID of the candidate that was clicked.
+ * Parameter button: Which mouse buttons was clicked.
+ */
addListener(callback: (engineID: string, candidateID: number, button: string) => void): void;
}
interface KeyEventEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID, KeyboardEvent keyData) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ * Parameter keyData: Data on the key event
+ */
addListener(callback: (engineID: string, keyData: KeyboardEvent) => void): void;
}
interface DeactivatedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ */
addListener(callback: (engineID: string) => void): void;
}
interface InputContextUpdateEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( InputContext context) {...};
+ * Parameter context: An InputContext object describing the text field that has changed.
+ */
addListener(callback: (context: InputContext) => void): void;
}
interface ActivateEvent extends chrome.events.Event {
- addListener(callback: (engineID: string) => void): void;
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID, ScreenType screen) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ * Parameter The screen type under which the IME is activated.
+ */
+ addListener(callback: (engineID: string, screen: string) => void): void;
}
interface FocusEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( InputContext context) {...};
+ * Parameter context: Describes the text field that has acquired focus.
+ */
addListener(callback: (context: InputContext) => void): void;
}
interface MenuItemActivatedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID, string name) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ * Parameter name: Name of the MenuItem which was activated
+ */
addListener(callback: (engineID: string, name: string) => void): void;
}
- export function setMenuItems(parameters: ImeParameters, callback?: Function): void;
- export function commitText(parameters: CommitTextParameters, callback?: (success: boolean) => void): void;
- export function setCandidates(parameters: CandidatesParameters, callback?: (success: boolean) => void): void;
- export function setComposition(parameters: CompositionParameters, callback?: (success: boolean) => void): void;
- export function updateMenuItems(parameters: MenuItemParameters, callback?: Function): void;
- export function setCandidateWindowProperties(parameters: CandidateWindowPropertiesParameters, callback?: (success: boolean) => void): void;
- export function clearComposition(parameters: ClearCompositionParameters, callback?: (success: boolean) => void): void;
- export function setCursorPosition(parameters: CursorPositionParameters, callback?: (success: boolean) => void): void;
+ interface SurroundingTextChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID, object surroundingInfo) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ * Parameter surroundingInfo: The surrounding information.
+ */
+ addListener(callback: (engineID: string, surroundingInfo: SurroundingTextInfo) => void): void;
+ }
+ interface InputResetEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string engineID) {...};
+ * Parameter engineID: ID of the engine receiving the event
+ */
+ addListener(callback: (engineID: string) => void): void;
+ }
+
+ /**
+ * Adds the provided menu items to the language menu when this IME is active.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function setMenuItems(parameters: ImeParameters, callback?: () => void): void;
+ /**
+ * Commits the provided text to the current input.
+ * @param callback Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, chrome.runtime.lastError is set.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean success) {...};
+ */
+ export function commitText(parameters: CommitTextParameters, callback?: (success: boolean) => void): void;
+ /**
+ * Sets the current candidate list. This fails if this extension doesn't own the active IME
+ * @param callback Called when the operation completes.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean success) {...};
+ */
+ export function setCandidates(parameters: CandidatesParameters, callback?: (success: boolean) => void): void;
+ /**
+ * Set the current composition. If this extension does not own the active IME, this fails.
+ * @param callback Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, chrome.runtime.lastError is set.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean success) {...};
+ */
+ export function setComposition(parameters: CompositionParameters, callback?: (success: boolean) => void): void;
+ /**
+ * Updates the state of the MenuItems specified
+ * @param callback Called when the operation completes
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function updateMenuItems(parameters: MenuItemParameters, callback?: () => void): void;
+ /**
+ * Sets the properties of the candidate window. This fails if the extension doesn't own the active IME
+ * @param callback Called when the operation completes.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean success) {...};
+ */
+ export function setCandidateWindowProperties(parameters: CandidateWindowParameter, callback?: (success: boolean) => void): void;
+ /**
+ * Clear the current composition. If this extension does not own the active IME, this fails.
+ * @param callback Called when the operation completes with a boolean indicating if the text was accepted or not. On failure, chrome.runtime.lastError is set.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean success) {...};
+ */
+ export function clearComposition(parameters: ClearCompositionParameters, callback?: (success: boolean) => void): void;
+ /**
+ * Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.
+ * @param callback Called when the operation completes
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean success) {...};
+ */
+ export function setCursorPosition(parameters: CursorPositionParameters, callback?: (success: boolean) => void): void;
+ /**
+ * Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system.
+ * @since Chrome 33.
+ * @param callback Called when the operation completes.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function sendKeyEvents(parameters: SendKeyEventParameters, callback?: () => void): void;
+ /**
+ * Hides the input view window, which is popped up automatically by system. If the input view window is already hidden, this function will do nothing.
+ * @since Chrome 34.
+ */
+ export function hideInputView(): void;
+ /**
+ * Deletes the text around the caret.
+ * @since Chrome 27.
+ */
+ export function deleteSurroundingText(parameters: DeleteSurroundingTextParameters, callback?: () => void): void;
+ /**
+ * Indicates that the key event received by onKeyEvent is handled. This should only be called if the onKeyEvent listener is asynchronous.
+ * @since Chrome 25.
+ * @param requestId Request id of the event that was handled. This should come from keyEvent.requestId
+ * @param response True if the keystroke was handled, false if not
+ */
+ export function keyEventHandled(requestId: string, response: boolean): void;
+
+ /** This event is sent when focus leaves a text box. It is sent to all extensions that are listening to this event, and enabled by the user. */
var onBlur: BlurEvent;
+ /** This event is sent if this extension owns the active IME. */
var onCandidateClicked: CandidateClickedEvent;
+ /** This event is sent if this extension owns the active IME. */
var onKeyEvent: KeyEventEvent;
+ /** This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events. */
var onDeactivated: DeactivatedEvent;
+ /** This event is sent when the properties of the current InputContext change, such as the the type. It is sent to all extensions that are listening to this event, and enabled by the user. */
var onInputContextUpdate: InputContextUpdateEvent;
+ /** This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events. */
var onActivate: ActivateEvent;
+ /** This event is sent when focus enters a text box. It is sent to all extensions that are listening to this event, and enabled by the user. */
var onFocus: FocusEvent;
+ /** Called when the user selects a menu item */
var onMenuItemActivated: MenuItemActivatedEvent;
+ /**
+ * Called when the editable string around caret is changed or when the caret position is moved. The text length is limited to 100 characters for each back and forth direction.
+ * @since Chrome 27.
+ */
+ var onSurroundingTextChanged: SurroundingTextChangedEvent;
+ /**
+ * This event is sent when chrome terminates ongoing text input session.
+ * @since Chrome 29.
+ */
+ var onReset: InputResetEvent;
}
////////////////////
// Management
////////////////////
+/**
+ * The chrome.management API provides ways to manage the list of extensions/apps that are installed and running. It is particularly useful for extensions that override the built-in New Tab page.
+ * Permissions: "management"
+ * @since Chrome 8.
+ */
declare module chrome.management {
+ /** Information about an installed extension, app, or theme. */
interface ExtensionInfo {
+ /**
+ * Optional.
+ * A reason the item is disabled.
+ * @since Chrome 17.
+ */
disabledReason?: string;
+ /** Optional. The launch url (only present for apps). */
appLaunchUrl?: string;
+ /**
+ * The description of this extension, app, or theme.
+ * @since Chrome 9.
+ */
description: string;
+ /**
+ * Returns a list of API based permissions.
+ * @since Chrome 9.
+ */
permissions: string[];
+ /**
+ * Optional.
+ * A list of icon information. Note that this just reflects what was declared in the manifest, and the actual image at that url may be larger or smaller than what was declared, so you might consider using explicit width and height attributes on img tags referencing these images. See the manifest documentation on icons for more details.
+ */
icons?: IconInfo[];
+ /**
+ * Returns a list of host based permissions.
+ * @since Chrome 9.
+ */
hostPermissions: string[];
+ /** Whether it is currently enabled or disabled. */
enabled: boolean;
+ /**
+ * Optional.
+ * The URL of the homepage of this extension, app, or theme.
+ * @since Chrome 11.
+ */
homepageUrl?: string;
+ /**
+ * Whether this extension can be disabled or uninstalled by the user.
+ * @since Chrome 12.
+ */
mayDisable: boolean;
+ /**
+ * How the extension was installed.
+ * @since Chrome 22.
+ */
installType: string;
+ /** The version of this extension, app, or theme. */
version: string;
+ /** The extension's unique identifier. */
id: string;
+ /**
+ * Whether the extension, app, or theme declares that it supports offline.
+ * @since Chrome 15.
+ */
offlineEnabled: boolean;
+ /**
+ * Optional.
+ * The update URL of this extension, app, or theme.
+ * @since Chrome 16.
+ */
updateUrl?: string;
+ /**
+ * The type of this extension, app, or theme.
+ * @since Chrome 23.
+ */
type: string;
+ /** The url for the item's options page, if it has one. */
optionsUrl: string;
+ /** The name of this extension, app, or theme. */
name: string;
+ /**
+ * A short version of the name of this extension, app, or theme.
+ * @since Chrome 31.
+ */
+ shortName: string;
+ /**
+ * True if this is an app.
+ * @deprecated since Chrome 33. Please use management.ExtensionInfo.type.
+ */
+ isApp: boolean;
+ /**
+ * Optional.
+ * The app launch type (only present for apps).
+ * @since Chrome 37.
+ */
+ launchType?: string;
+ /**
+ * Optional.
+ * The currently available launch types (only present for apps).
+ * @since Chrome 37.
+ */
+ availableLaunchTypes?: string[];
}
+ /** Information about an icon belonging to an extension, app, or theme. */
interface IconInfo {
+ /** The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled, for example), append ?grayscale=true to the URL. */
url: string;
+ /** A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24, and 16. */
size: number;
}
interface UninstallOptions {
+ /**
+ * Optional.
+ * Whether or not a confirm-uninstall dialog should prompt the user. Defaults to false for self uninstalls. If an extension uninstalls another extension, this parameter is ignored and the dialog is always shown.
+ */
showConfirmDialog?: boolean;
}
interface ManagementDisabledEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( ExtensionInfo info) {...};
+ */
addListener(callback: (info: ExtensionInfo) => void): void;
}
interface ManagementUninstalledEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string id) {...};
+ * Parameter id: The id of the extension, app, or theme that was uninstalled.
+ */
addListener(callback: (id: string) => void): void;
}
interface ManagementInstalledEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( ExtensionInfo info) {...};
+ */
addListener(callback: (info: ExtensionInfo) => void): void;
}
interface ManagementEnabledEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( ExtensionInfo info) {...};
+ */
addListener(callback: (info: ExtensionInfo) => void): void;
}
- export function setEnabled(id: string, enabled: boolean, callback?: Function): void;
+ /**
+ * Enables or disables an app or extension.
+ * @param id This should be the id from an item of management.ExtensionInfo.
+ * @param enabled Whether this item should be enabled or disabled.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function setEnabled(id: string, enabled: boolean, callback?: () => void): void;
+ /**
+ * Returns a list of permission warnings for the given extension id.
+ * @since Chrome 15.
+ * @param id The ID of an already installed extension.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(array of string permissionWarnings) {...};
+ */
export function getPermissionWarningsById(id: string, callback?: (permissionWarnings: string[]) => void): void;
+ /**
+ * Returns information about the installed extension, app, or theme that has the given ID.
+ * @since Chrome 9.
+ * @param id The ID from an item of management.ExtensionInfo.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( ExtensionInfo result) {...};
+ */
export function get(id: string, callback?: (result: ExtensionInfo) => void): void;
+ /**
+ * Returns a list of information about installed extensions and apps.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(array of ExtensionInfo result) {...};
+ */
export function getAll(callback?: (result: ExtensionInfo[]) => void): void;
+ /**
+ * Returns a list of permission warnings for the given extension manifest string. Note: This function can be used without requesting the 'management' permission in the manifest.
+ * @since Chrome 15.
+ * @param manifestStr Extension manifest JSON string.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(array of string permissionWarnings) {...};
+ */
export function getPermissionWarningsByManifest(manifestStr: string, callback?: (permissionwarnings: string[]) => void): void;
- export function launchApp(id: string, callback?: Function): void;
- export function uninstall(id: string, options: UninstallOptions, callback?: Function): void;
+ /**
+ * Launches an application.
+ * @param id The extension id of the application.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function launchApp(id: string, callback?: () => void): void;
+ /**
+ * Uninstalls a currently installed app or extension.
+ * @since Chrome 21.
+ * @param id This should be the id from an item of management.ExtensionInfo.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function uninstall(id: string, options?: UninstallOptions, callback?: () => void): void;
+ /**
+ * Uninstalls a currently installed app or extension.
+ * @deprecated since Chrome 21. The options parameter was added to this function.
+ * @param id This should be the id from an item of management.ExtensionInfo.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function uninstall(id: string, callback?: () => void): void;
+ /**
+ * Returns information about the calling extension, app, or theme. Note: This function can be used without requesting the 'management' permission in the manifest.
+ * @since Chrome 39.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( ExtensionInfo result) {...};
+ */
+ export function getSelf(callback?: (result: ExtensionInfo) => void): void;
+ /**
+ * Uninstalls the calling extension.
+ * Note: This function can be used without requesting the 'management' permission in the manifest.
+ * @since Chrome 26.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function uninstallSelf(options?: UninstallOptions, callback?: () => void): void;
+ /**
+ * Uninstalls the calling extension.
+ * Note: This function can be used without requesting the 'management' permission in the manifest.
+ * @since Chrome 26.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function uninstallSelf(callback?: () => void): void;
+ /**
+ * Display options to create shortcuts for an app. On Mac, only packaged app shortcuts can be created.
+ * @since Chrome 37.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function createAppShortcut(id: string, callback?: () => void): void;
+ /**
+ * Set the launch type of an app.
+ * @since Chrome 37.
+ * @param id This should be the id from an app item of management.ExtensionInfo.
+ * @param launchType The target launch type. Always check and make sure this launch type is in ExtensionInfo.availableLaunchTypes, because the available launch types vary on different platforms and configurations.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function setLaunchType(id: string, launchType: string, callback?: () => void): void;
+ /**
+ * Generate an app for a URL. Returns the generated bookmark app.
+ * @since Chrome 37.
+ * @param url The URL of a web page. The scheme of the URL can only be "http" or "https".
+ * @param title The title of the generated app.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function( ExtensionInfo result) {...};
+ */
+ export function generateAppForLink(url: string, title: string, callback?: (result: ExtensionInfo) => void): void;
+ /** Fired when an app or extension has been disabled. */
var onDisabled: ManagementDisabledEvent;
+ /** Fired when an app or extension has been uninstalled. */
var onUninstalled: ManagementUninstalledEvent;
+ /** Fired when an app or extension has been installed. */
var onInstalled: ManagementInstalledEvent;
+ /** Fired when an app or extension has been enabled. */
var onEnabled: ManagementEnabledEvent;
}
+////////////////////
+// Notifications
+////////////////////
+/**
+ * Use the networking.config API to authenticate to captive portals.
+ * Permissions: "networking.config"
+ * Important: This API works only on Chrome OS.
+ * @since Chrome 43.
+ */
+declare module chrome.networking.config {
+ interface NetworkInfo {
+ /** Currently only WiFi supported. */
+ Type: string;
+ /** Optional. A unique identifier of the network. */
+ GUID?: string;
+ /** Optional. A hex-encoded byte sequence. */
+ HexSSID?: string;
+ /** Optional. The decoded SSID of the network (default encoding is UTF-8). To filter for non-UTF-8 SSIDs, use HexSSID instead. */
+ SSID?: string;
+ /** Optional. The basic service set identification (BSSID) uniquely identifying the basic service set. BSSID is represented as a human readable, hex-encoded string with bytes separated by colons, e.g. 45:67:89:ab:cd:ef. */
+ BSSID?: string;
+ /** Optional. Identifier indicating the security type of the network. Valid values are None, WEP-PSK, WPA-PSK and WPA-EAP. */
+ Security?: string;
+ }
+
+ interface CaptivePorttalDetectedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( NetworkInfo networkInfo) {...};
+ * Parameter networkInfo: Information about the network on which a captive portal was detected.
+ */
+ addListener(callback: (networkInfo: NetworkInfo) => void): void;
+ }
+
+ /**
+ * Allows an extension to define network filters for the networks it can handle. A call to this function will remove all filters previously installed by the extension before setting the new list.
+ * @param networks Network filters to set. Every NetworkInfo must either have the SSID or HexSSID set. Other fields will be ignored.
+ * @param callback Called back when this operation is finished.
+ * The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ export function setNetworkFilter(networks: NetworkInfo[], callback: () => void): void;
+ /**
+ * Called by the extension to notify the network config API that it finished a captive portal authentication attempt and hand over the result of the attempt. This function must only be called with the GUID of the latest onCaptivePortalDetected event.
+ * @param GUID Unique network identifier obtained from onCaptivePortalDetected.
+ * @param result The result of the authentication attempt.
+ * unhandled: The extension does not handle this network or captive portal (e.g. server end-point not found or not compatible).
+ * succeeded: The extension handled this network and authenticated successfully.
+ * rejected: The extension handled this network, tried to authenticate, however was rejected by the server.
+ * failed: The extension handled this network, tried to authenticate, however failed due to an unspecified error.
+ * @param callback Called back when this operation is finished.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function finishAuthentication(GUID: string, result: string, callback?: () => void): void;
+
+ /** This event fires everytime a captive portal is detected on a network matching any of the currently registered network filters and the user consents to use the extension for authentication. Network filters may be set using the setNetworkFilter. Upon receiving this event the extension should start its authentication attempt with the captive portal. When the extension finishes its attempt, it must call finishAuthentication with the GUID received with this event and the appropriate authentication result. */
+ var onCaptivePortalDetected: CaptivePorttalDetectedEvent;
+}
+
////////////////////
// Notifications
// https://developer.chrome.com/extensions/notifications
////////////////////
+/**
+ * Use the chrome.notifications API to create rich notifications using templates and show these notifications to users in the system tray.
+ * Permissions: "notifications"
+ * @since Chrome 28.
+ */
declare module chrome.notifications {
interface ButtonOptions {
title: string;
@@ -1299,176 +4664,640 @@ declare module chrome.notifications {
}
interface ItemOptions {
+ /** Title of one item of a list notification. */
title: string;
+ /** Additional details about this item. */
message: string;
}
interface NotificationOptions {
+ /** Optional. Which type of notification to display. Required for notifications.create method. */
type?: string;
+ /**
+ * Optional.
+ * A URL to the sender's avatar, app icon, or a thumbnail for image notifications.
+ * URLs can be a data URL, a blob URL, or a URL relative to a resource within this extension's .crx file Required for notifications.create method.
+ */
iconUrl?: string;
+ /** Optional. Title of the notification (e.g. sender name for email). Required for notifications.create method. */
title?: string;
+ /** Optional. Main notification content. Required for notifications.create method. */
message?: string;
+ /**
+ * Optional.
+ * Alternate notification content with a lower-weight font.
+ * @since Chrome 31.
+ */
contextMessage?: string;
+ /** Optional. Priority ranges from -2 to 2. -2 is lowest priority. 2 is highest. Zero is default. */
priority?: number;
+ /** Optional. A timestamp associated with the notification, in milliseconds past the epoch (e.g. Date.now() + n). */
eventTime?: number;
- buttons?: Array<ButtonOptions>;
- items?: Array<ItemOptions>;
+ /** Optional. Text and icons for up to two notification action buttons. */
+ buttons?: ButtonOptions[];
+ /** Optional. Items for multi-item notifications. */
+ items?: ItemOptions[];
+ /**
+ * Optional.
+ * Current progress ranges from 0 to 100.
+ * @since Chrome 30.
+ */
progress?: number;
+ /**
+ * Optional.
+ * Whether to show UI indicating that the app will visibly respond to clicks on the body of a notification.
+ * @since Chrome 32.
+ */
isClickable?: boolean;
+ /**
+ * Optional.
+ * A URL to the app icon mask. URLs have the same restrictions as iconUrl. The app icon mask should be in alpha channel, as only the alpha channel of the image will be considered.
+ * @since Chrome 38.
+ */
+ appIconMaskUrl?: string;
+ /** Optional. A URL to the image thumbnail for image-type notifications. URLs have the same restrictions as iconUrl. */
+ imageUrl?: string;
}
- interface OnClosed {
+ interface NotificationClosedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string notificationId, boolean byUser) {...};
+ */
addListener(callback: (notificationId: string, byUser: boolean) => void): void;
}
- interface OnClicked {
+ interface NotificationClickedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string notificationId) {...};
+ */
addListener(callback: (notificationId: string) => void): void;
}
- interface OnButtonClicked {
+ interface NotificationButtonClickedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string notificationId, integer buttonIndex) {...};
+ */
addListener(callback: (notificationId: string, buttonIndex: number) => void): void;
}
- interface OnPermissionLevelChanged {
+ interface NotificationPermissionLevelChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( PermissionLevel level) {...};
+ */
addListener(callback: (level: string) => void): void;
}
- interface OnShowSettings {
- addListener(callback: Function): void;
+ interface NotificationShowSettingsEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
- export var onClosed: OnClosed;
- export var onClicked: OnClicked;
- export var onButtonClicked: OnButtonClicked;
- export var onPermissionLevelChanged: OnPermissionLevelChanged;
- export var onShowSettings: OnShowSettings;
+ /** The notification closed, either by the system or by user action. */
+ export var onClosed: NotificationClosedEvent;
+ /** The user clicked in a non-button area of the notification. */
+ export var onClicked: NotificationClickedEvent;
+ /** The user pressed a button in the notification. */
+ export var onButtonClicked: NotificationButtonClickedEvent;
+ /**
+ * The user changes the permission level.
+ * @since Chrome 32.
+ */
+ export var onPermissionLevelChanged: NotificationPermissionLevelChangedEvent;
+ /**
+ * The user clicked on a link for the app's notification settings.
+ * @since Chrome 32.
+ */
+ export var onShowSettings: NotificationShowSettingsEvent;
- export function create(notificationId: string, options: NotificationOptions, callback: (notificationId: string) => void): void;
- export function update(notificationId: string, options: NotificationOptions, callback: (wasUpdated: boolean) => void): void;
- export function clear(notificationId: string, callback: (wasCleared: boolean) => void): void;
- export function getAll(callback: (notifications: any) => void): void;
+ /**
+ * Creates and displays a notification.
+ * @param notificationId Identifier of the notification. If not set or empty, an ID will automatically be generated. If it matches an existing notification, this method first clears that notification before proceeding with the create operation.
+ * The notificationId parameter is required before Chrome 42.
+ * @param options Contents of the notification.
+ * @param callback Returns the notification id (either supplied or generated) that represents the created notification.
+ * The callback is required before Chrome 42.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(string notificationId) {...};
+ */
+ export function create(notificationId: string, options: NotificationOptions, callback?: (notificationId: string) => void): void;
+ /**
+ * Creates and displays a notification.
+ * @param notificationId Identifier of the notification. If not set or empty, an ID will automatically be generated. If it matches an existing notification, this method first clears that notification before proceeding with the create operation.
+ * The notificationId parameter is required before Chrome 42.
+ * @param options Contents of the notification.
+ * @param callback Returns the notification id (either supplied or generated) that represents the created notification.
+ * The callback is required before Chrome 42.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(string notificationId) {...};
+ */
+ export function create(options: NotificationOptions, callback?: (notificationId: string) => void): void;
+ /**
+ * Updates an existing notification.
+ * @param notificationId The id of the notification to be updated. This is returned by notifications.create method.
+ * @param options Contents of the notification to update to.
+ * @param callback Called to indicate whether a matching notification existed.
+ * The callback is required before Chrome 42.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean wasUpdated) {...};
+ */
+ export function update(notificationId: string, options: NotificationOptions, callback?: (wasUpdated: boolean) => void): void;
+ /**
+ * Clears the specified notification.
+ * @param notificationId The id of the notification to be cleared. This is returned by notifications.create method.
+ * @param callback Called to indicate whether a matching notification existed.
+ * The callback is required before Chrome 42.
+ * If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean wasCleared) {...};
+ */
+ export function clear(notificationId: string, callback?: (wasCleared: boolean) => void): void;
+ /**
+ * Retrieves all the notifications.
+ * @since Chrome 29.
+ * @param callback Returns the set of notification_ids currently in the system.
+ * The callback parameter should be a function that looks like this:
+ * function(object notifications) {...};
+ */
+ export function getAll(callback: (notifications: Object) => void): void;
+ /**
+ * Retrieves whether the user has enabled notifications from this app or extension.
+ * @since Chrome 32.
+ * @param callback Returns the current permission level.
+ * The callback parameter should be a function that looks like this:
+ * function( PermissionLevel level) {...};
+ */
export function getPermissionLevel(callback: (level: string) => void): void;
}
////////////////////
// Omnibox
////////////////////
+/**
+ * The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.
+ * Manifest: "omnibox": {...}
+ * @since Chrome 9.
+ */
declare module chrome.omnibox {
+ /** A suggest result. */
interface SuggestResult {
+ /** The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry. */
content: string;
+ /** The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. dimmed match. You must escape the five predefined entities to display them as text: stackoverflow.com/a/1091953/89484 */
description: string;
}
interface Suggestion {
+ /** The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. dimmed match. */
description: string;
}
interface OmniboxInputEnteredEvent extends chrome.events.Event {
+ /**
+ * The callback parameter should be a function that looks like this:
+ * function(string text, OnInputEnteredDisposition disposition) {...};
+ */
addListener(callback: (text: string) => void): void;
}
interface OmniboxInputChangedEvent extends chrome.events.Event {
+ /**
+ * The callback parameter should be a function that looks like this:
+ * function(string text, function suggest) {...};
+ * Parameter suggest: A callback passed to the onInputChanged event used for sending suggestions back to the browser.
+ * The suggest parameter should be a function that looks like this:
+ * function(array of SuggestResult suggestResults) {...};
+ */
addListener(callback: (text: string, suggest: (suggestResults: SuggestResult[]) => void) => void): void;
}
interface OmniboxInputStartedEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
interface OmniboxInputCancelledEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ /**
+ * The callback parameter should be a function that looks like this:
+ * function() {...};
+ */
+ addListener(callback: () => void): void;
}
+ /**
+ * Sets the description and styling for the default suggestion. The default suggestion is the text that is displayed in the first suggestion row underneath the URL bar.
+ * @param suggestion A partial SuggestResult object, without the 'content' parameter.
+ */
export function setDefaultSuggestion(suggestion: Suggestion): void;
+ /** User has accepted what is typed into the omnibox. */
var onInputEntered: OmniboxInputEnteredEvent;
+ /** User has changed what is typed into the omnibox. */
var onInputChanged: OmniboxInputChangedEvent;
+ /** User has started a keyword input session by typing the extension's keyword. This is guaranteed to be sent exactly once per input session, and before any onInputChanged events. */
var onInputStarted: OmniboxInputStartedEvent;
+ /** User has ended the keyword input session without accepting the input. */
var onInputCancelled: OmniboxInputCancelledEvent;
}
////////////////////
// Page Action
////////////////////
+/**
+ * Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.
+ * Manifest: "page_action": {...}
+ * @since Chrome 5.
+ */
declare module chrome.pageAction {
interface PageActionClickedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( tabs.Tab tab) {...};
+ */
addListener(callback: (tab: chrome.tabs.Tab) => void): void;
}
interface TitleDetails {
+ /** The id of the tab for which you want to modify the page action. */
tabId: number;
+ /** The tooltip string. */
title: string;
}
interface GetDetails {
+ /** Specify the tab to get the title from. */
tabId: number;
}
interface PopupDetails {
+ /** The id of the tab for which you want to modify the page action. */
tabId: number;
+ /** The html file to show in a popup. If set to the empty string (''), no popup is shown. */
popup: string;
}
interface IconDetails {
+ /** The id of the tab for which you want to modify the page action. */
tabId: number;
+ /**
+ * Optional.
+ * @deprecated This argument is ignored.
+ */
iconIndex?: number;
+ /**
+ * Optional.
+ * Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}'
+ */
imageData?: ImageData;
+ /**
+ * Optional.
+ * Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'
+ */
path?: any;
}
+ /**
+ * Shows the page action. The page action is shown whenever the tab is selected.
+ * @param tabId The id of the tab for which you want to modify the page action.
+ */
export function hide(tabId: number): void;
+ /**
+ * Shows the page action. The page action is shown whenever the tab is selected.
+ * @param tabId The id of the tab for which you want to modify the page action.
+ */
export function show(tabId: number): void;
+ /** Sets the title of the page action. This is displayed in a tooltip over the page action. */
export function setTitle(details: TitleDetails): void;
+ /** Sets the html document to be opened as a popup when the user clicks on the page action's icon. */
export function setPopup(details: PopupDetails): void;
+ /**
+ * Gets the title of the page action.
+ * @since Chrome 19.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string result) {...};
+ */
export function getTitle(details: GetDetails, callback: (result: string) => void): void;
+ /**
+ * Gets the html document set as the popup for this page action.
+ * @since Chrome 19.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string result) {...};
+ */
export function getPopup(details: GetDetails, callback: (result: string) => void): void;
- export function setIcon(details: IconDetails, callback?: Function): void;
+ /**
+ * Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the path or the imageData property must be specified.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function() {...};
+ */
+ export function setIcon(details: IconDetails, callback?: () => void): void;
+ /** Fired when a page action icon is clicked. This event will not fire if the page action has a popup. */
var onClicked: PageActionClickedEvent;
}
////////////////////
// Page Capture
////////////////////
+/**
+ * Use the chrome.pageCapture API to save a tab as MHTML.
+ * Permissions: "pageCapture"
+ * @since Chrome 18.
+ */
declare module chrome.pageCapture {
interface SaveDetails {
+ /** The id of the tab to save as MHTML. */
tabId: number;
}
+ /**
+ * Saves the content of the tab with given id as MHTML.
+ * @param callback Called when the MHTML has been generated.
+ * The callback parameter should be a function that looks like this:
+ * function(binary mhtmlData) {...};
+ * Parameter mhtmlData: The MHTML data as a Blob.
+ */
export function saveAsMHTML(details: SaveDetails, callback: (mhtmlData: any) => void): void;
}
////////////////////
// Permissions
////////////////////
+/**
+ * Use the chrome.permissions API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary.
+ * @since Chrome 16.
+ */
declare module chrome.permissions {
interface Permissions {
+ /**
+ * Optional.
+ * List of named permissions (does not include hosts or origins). Anything listed here must appear in the optional_permissions list in the manifest.
+ */
origins?: string[];
+ /**
+ * Optional.
+ * List of origin permissions. Anything listed here must be a subset of a host that appears in the optional_permissions list in the manifest. For example, if http://*.example.com/ or http://* appears in optional_permissions, you can request an origin of http://help.example.com/. Any path is ignored.
+ */
permissions?: string[];
}
interface PermissionsRemovedEvent {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Permissions permissions) {...};
+ * Parameter permissions: The permissions that have been removed.
+ */
addListener(callback: (permissions: Permissions) => void): void;
}
interface PermissionsAddedEvent {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Permissions permissions) {...};
+ * Parameter permissions: The newly acquired permissions.
+ */
addListener(callback: (permissions: Permissions) => void): void;
}
+ /**
+ * Checks if the extension has the specified permissions.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(boolean result) {...};
+ * Parameter result: True if the extension has the specified permissions.
+ */
export function contains(permissions: Permissions, callback: (result: boolean) => void): void;
+ /**
+ * Gets the extension's current set of permissions.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( Permissions permissions) {...};
+ * Parameter permissions: The extension's active permissions.
+ */
export function getAll(callback: (permissions: Permissions) => void): void;
+ /**
+ * Requests access to the specified permissions. These permissions must be defined in the optional_permissions field of the manifest. If there are any problems requesting the permissions, runtime.lastError will be set.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean granted) {...};
+ * Parameter granted: True if the user granted the specified permissions.
+ */
export function request(permissions: Permissions, callback?: (granted: boolean) => void): void;
+ /**
+ * Removes access to the specified permissions. If there are any problems removing the permissions, runtime.lastError will be set.
+ * @param callback If you specify the callback parameter, it should be a function that looks like this:
+ * function(boolean removed) {...};
+ * Parameter removed: True if the permissions were removed.
+ */
export function remove(permissions: Permissions, callback?: (removed: boolean) => void): void;
+ /** Fired when access to permissions has been removed from the extension. */
var onRemoved: PermissionsRemovedEvent;
+ /** Fired when the extension acquires new permissions. */
var onAdded: PermissionsAddedEvent;
}
+////////////////////
+// Platform Keys
+////////////////////
+/**
+ * Use the chrome.platformKeys API to access client certificates managed by the platform. If the user or policy grants the permission, an extension can use such a certficate in its custom authentication protocol. E.g. this allows usage of platform managed certificates in third party VPNs (see chrome.vpnProvider).
+ * Permissions: "platformKeys"
+ * Important: This API works only on Chrome OS.
+ * @since Chrome 45.
+ */
+declare module chrome.platformKeys {
+ interface Match {
+ /** The DER encoding of a X.509 certificate. */
+ certificate: ArrayBuffer;
+ /** The KeyAlgorithm of the certified key. This contains algorithm parameters that are inherent to the key of the certificate (e.g. the key length). Other parameters like the hash function used by the sign function are not included. */
+ keyAlgorithm: KeyAlgorithm;
+ }
+
+ interface ClientCertificateSelectRequestDetails {
+ /** This field is a list of the types of certificates requested, sorted in order of the server's preference. Only certificates of a type contained in this list will be retrieved. If certificateTypes is the empty list, however, certificates of any type will be returned. */
+ certificateTypes: string[];
+ /** List of distinguished names of certificate authorities allowed by the server. Each entry must be a DER-encoded X.509 DistinguishedName. */
+ certificateAuthorities: ArrayBuffer[];
+ }
+
+ interface ClientCertificateSelectDetails {
+ /** Only certificates that match this request will be returned. */
+ request: ClientCertificateSelectRequestDetails;
+ /**
+ * Optional.
+ * If given, the selectClientCertificates operates on this list. Otherwise, obtains the list of all certificates from the platform's certificate stores that are available to this extensions. Entries that the extension doesn't have permission for or which doesn't match the request, are removed.
+ */
+ clientCerts?: ArrayBuffer[];
+ /** If true, the filtered list is presented to the user to manually select a certificate and thereby granting the extension access to the certificate(s) and key(s). Only the selected certificate(s) will be returned. If is false, the list is reduced to all certificates that the extension has been granted access to (automatically or manually). */
+ interactive: boolean;
+ }
+
+ interface ServerCertificateVerificationDetails {
+ /** Each chain entry must be the DER encoding of a X.509 certificate, the first entry must be the server certificate and each entry must certify the entry preceding it. */
+ serverCertificateChain: ArrayBuffer[];
+ /** The hostname of the server to verify the certificate for, e.g. the server that presented the serverCertificateChain. */
+ hostname: string;
+ }
+
+ interface ServerCertificateVerificationResult {
+ /** The result of the trust verification: true if trust for the given verification details could be established and false if trust is rejected for any reason. */
+ trusted: boolean;
+ /**
+ * If the trust verification failed, this array contains the errors reported by the underlying network layer. Otherwise, this array is empty.
+ * Note: This list is meant for debugging only and may not contain all relevant errors. The errors returned may change in future revisions of this API, and are not guaranteed to be forwards or backwards compatible.
+ */
+ debug_errors: string[];
+ }
+
+ /**
+ * This function filters from a list of client certificates the ones that are known to the platform, match request and for which the extension has permission to access the certificate and its private key. If interactive is true, the user is presented a dialog where he can select from matching certificates and grant the extension access to the certificate. The selected/filtered client certificates will be passed to callback.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(array of Match matches) {...};
+ * Parameter matches: The list of certificates that match the request, that the extension has permission for and, if interactive is true, that were selected by the user.
+ */
+ export function selectClientCertificates(details: ClientCertificateSelectDetails, callback: (matches: Match[]) => void): void;
+ /**
+ * Passes the key pair of certificate for usage with platformKeys.subtleCrypto to callback.
+ * @param certificate The certificate of a Match returned by selectClientCertificates.
+ * @param parameters Determines signature/hash algorithm parameters additionally to the parameters fixed by the key itself. The same parameters are accepted as by WebCrypto's importKey function, e.g. RsaHashedImportParams for a RSASSA-PKCS1-v1_5 key. For RSASSA-PKCS1-v1_5 keys, additionally the parameters { 'hash': { 'name': 'none' } } are supported. The sign function will then apply PKCS#1 v1.5 padding and but not hash the given data.
+ * @param callback The public and private CryptoKey of a certificate which can only be used with platformKeys.subtleCrypto.
+ * The callback parameter should be a function that looks like this:
+ * function(object publicKey, object privateKey) {...};
+ * Optional parameter privateKey: Might be null if this extension does not have access to it.
+ */
+ export function getKeyPair(certificate: ArrayBuffer, parameters: Object, callback: (publicKey: CryptoKey, privateKey?: CryptoKey) => void): void;
+ /** An implementation of WebCrypto's SubtleCrypto that allows crypto operations on keys of client certificates that are available to this extension. */
+ export function subtleCrypto(): SubtleCrypto;
+ /**
+ * Checks whether details.serverCertificateChain can be trusted for details.hostname according to the trust settings of the platform. Note: The actual behavior of the trust verification is not fully specified and might change in the future. The API implementation verifies certificate expiration, validates the certification path and checks trust by a known CA. The implementation is supposed to respect the EKU serverAuth and to support subject alternative names.
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object result) {...};
+ */
+ export function verifyTLSServerCertificate(details: ServerCertificateVerificationDetails, callback: (result: ServerCertificateVerificationResult) => void): void;
+}
+
+////////////////////
+// Power
+////////////////////
+/**
+ * Use the chrome.power API to override the system's power management features.
+ * Permissions: "power"
+ * @since Chrome 27.
+ */
+declare module chrome.power {
+ /** Requests that power management be temporarily disabled. |level| describes the degree to which power management should be disabled. If a request previously made by the same app is still active, it will be replaced by the new request. */
+ export function requestKeepAwake(level: string): void;
+ /** Releases a request previously made via requestKeepAwake(). */
+ export function releaseKeepAwake(): void;
+}
+
+////////////////////
+// Printer Provider
+////////////////////
+/**
+ * The chrome.printerProvider API exposes events used by print manager to query printers controlled by extensions, to query their capabilities and to submit print jobs to these printers.
+ * Permissions: "printerProvider"
+ * @since Chrome 44.
+ */
+declare module chrome.printerProvider {
+ interface PrinterInfo {
+ /** Unique printer ID. */
+ id: string;
+ /** Printer's human readable name. */
+ name: string;
+ /** Optional. Printer's human readable description. */
+ description?: string;
+ }
+
+ interface PrinterCapabilities {
+ /** Device capabilities in CDD format. */
+ capabilities: any;
+ }
+
+ interface PrintJob {
+ /** ID of the printer which should handle the job. */
+ printerId: string;
+ /** The print job title. */
+ title: string;
+ /** Print ticket in CJT format. */
+ ticket: Object;
+ /** The document content type. Supported formats are "application/pdf" and "image/pwg-raster". */
+ contentType: string;
+ /** Blob containing the document data to print. Format must match |contentType|. */
+ document: Blob;
+ }
+
+ interface PrinterRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(function resultCallback) {...};
+ * Parameter resultCallback: Callback to return printer list. Every listener must call callback exactly once.
+ */
+ addListener(callback: (resultCallback: (printerInfo: PrinterInfo[]) => void) => void): void;
+ }
+
+ interface PrinterInfoRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function( usb.Device device, function resultCallback) {...};
+ * Parameter device: The USB device.
+ * Parameter resultCallback: Callback to return printer info. The receiving listener must call callback exactly once. If the parameter to this callback is undefined that indicates that the application has determined that the device is not supported.
+ */
+ addListener(callback: (device: any, resultCallback: (printerInfo?: PrinterInfo) => void) => void): void;
+ }
+
+ interface CapabilityRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(string printerId, function resultCallback) {...};
+ * Parameter printerId: Unique ID of the printer whose capabilities are requested.
+ * Parameter resultCallback: Callback to return device capabilities in CDD format. The receiving listener must call callback exectly once.
+ */
+ addListener(callback: (printerId: string, resultCallback: (capabilities: PrinterCapabilities) => void) => void): void;
+ }
+
+ interface PrintRequestedEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object printJob, function resultCallback) {...};
+ * Parameter printJob: The printing request parameters.
+ * Parameter resultCallback: Callback that should be called when the printing request is completed.
+ * Parameter result (for resultCallback): OK: Operation completed successfully. FAILED: General failure. INVALID_TICKET: Print ticket is invalid. For example, ticket is inconsistent with capabilities or extension is not able to handle all settings from the ticket. INVALID_DATA: Document is invalid. For example, data may be corrupted or the format is incompatible with the extension.
+ */
+ addListener(callback: (printJob: PrintJob, resultCallback: (result: string) => void) => void): void;
+ }
+
+ /** Event fired when print manager requests printers provided by extensions. */
+ export var onGetPrintersRequested: PrinterRequestedEvent;
+ /**
+ * Event fired when print manager requests information about a USB device that may be a printer.
+ * Note: An application should not rely on this event being fired more than once per device. If a connected device is supported it should be returned in the onGetPrintersRequested event.
+ * @since Chrome 45.
+ */
+ export var onGetUsbPrinterInfoRequested: PrinterInfoRequestedEvent;
+ /** Event fired when print manager requests printer capabilities. */
+ export var onGetCapabilityRequested: CapabilityRequestedEvent;
+ /** Event fired when print manager requests printing. */
+ export var onPrintRequested: PrintRequestedEvent;
+}
+
////////////////////
// Privacy
////////////////////
+/**
+ * Use the chrome.privacy API to control usage of the features in Chrome that can affect a user's privacy. This API relies on the ChromeSetting prototype of the type API for getting and setting Chrome's configuration.
+ * Permissions: "privacy"
+ * The Chrome Privacy Whitepaper gives background detail regarding the features which this API can control.
+ * @since Chrome 18.
+ */
declare module chrome.privacy {
interface Services {
+ /** since Chrome 20. */
spellingServiceEnabled: chrome.types.ChromeSetting;
searchSuggestEnabled: chrome.types.ChromeSetting;
instantEnabled: chrome.types.ChromeSetting;
@@ -1476,77 +5305,136 @@ declare module chrome.privacy {
safeBrowsingEnabled: chrome.types.ChromeSetting;
autofillEnabled: chrome.types.ChromeSetting;
translationServiceEnabled: chrome.types.ChromeSetting;
+ /** @since Chrome 38. */
+ passwordSavingEnabled: chrome.types.ChromeSetting;
+ /** @since Chrome 42. */
+ hotwordSearchEnabled: chrome.types.ChromeSetting;
+ /** @since Chrome 42. */
+ safeBrowsingExtendedReportingEnabled: chrome.types.ChromeSetting;
}
interface Network {
networkPredictionEnabled: chrome.types.ChromeSetting;
+ /** @since Chrome 42. */
+ webRTCMultipleRoutesEnabled: chrome.types.ChromeSetting;
+ /** @since Chrome 47. Warning: this is the current Dev channel. */
+ webRTCNonProxiedUdpEnabled: chrome.types.ChromeSetting;
}
interface Websites {
thirdPartyCookiesAllowed: chrome.types.ChromeSetting;
referrersEnabled: chrome.types.ChromeSetting;
hyperlinkAuditingEnabled: chrome.types.ChromeSetting;
+ /** @since Chrome 21. */
protectedContentEnabled: chrome.types.ChromeSetting;
}
+ /** Settings that enable or disable features that require third-party network services provided by Google and your default search provider. */
var services: Services;
+ /** Settings that influence Chrome's handling of network connections in general. */
var network: Network;
+ /** Settings that determine what information Chrome makes available to websites. */
var websites: Websites;
}
////////////////////
// Proxy
////////////////////
+/**
+ * Use the chrome.proxy API to manage Chrome's proxy settings. This API relies on the ChromeSetting prototype of the type API for getting and setting the proxy configuration.
+ * Permissions: "proxy"
+ * @since Chrome 13.
+ */
declare module chrome.proxy {
+ /** An object holding proxy auto-config information. Exactly one of the fields should be non-empty. */
interface PacScript {
+ /** Optional. URL of the PAC file to be used. */
url?: string;
+ /** Optional. If true, an invalid PAC script will prevent the network stack from falling back to direct connections. Defaults to false. */
mandatory?: boolean;
+ /** Optional. A PAC script. */
data?: string;
}
+ /** An object encapsulating a complete proxy configuration. */
interface ProxyConfig {
+ /** Optional. The proxy rules describing this configuration. Use this for 'fixed_servers' mode. */
rules?: ProxyRules;
+ /** Optional. The proxy auto-config (PAC) script for this configuration. Use this for 'pac_script' mode. */
pacScript?: PacScript;
+ /**
+ * 'direct' = Never use a proxy
+ * 'auto_detect' = Auto detect proxy settings
+ * 'pac_script' = Use specified PAC script
+ * 'fixed_servers' = Manually specify proxy servers
+ * 'system' = Use system proxy settings
+ */
mode: string;
}
+ /** An object encapsulating a single proxy server's specification. */
interface ProxyServer {
+ /** The URI of the proxy server. This must be an ASCII hostname (in Punycode format). IDNA is not supported, yet. */
host: string;
+ /** Optional. The scheme (protocol) of the proxy server itself. Defaults to 'http'. */
scheme?: string;
+ /** Optional. The port of the proxy server. Defaults to a port that depends on the scheme. */
port?: number;
}
+ /** An object encapsulating the set of proxy rules for all protocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHttps', 'proxyForFtp' and 'fallbackProxy'. */
interface ProxyRules {
+ /** Optional. The proxy server to be used for FTP requests. */
proxyForFtp?: ProxyServer;
+ /** Optional. The proxy server to be used for HTTP requests. */
proxyForHttp?: ProxyServer;
- facllbackProxy?: ProxyServer;
+ /** Optional. The proxy server to be used for everthing else or if any of the specific proxyFor... is not specified. */
+ fallbackProxy?: ProxyServer;
+ /** Optional. The proxy server to be used for all per-URL requests (that is http, https, and ftp). */
singleProxy?: ProxyServer;
+ /** Optional. The proxy server to be used for HTTPS requests. */
proxyForHttps?: ProxyServer;
+ /** Optional. List of servers to connect to without a proxy server. */
bypassList?: string[];
}
interface ErrorDetails {
+ /** Additional details about the error such as a JavaScript runtime error. */
details: string;
+ /** The error description. */
error: string;
+ /** If true, the error was fatal and the network transaction was aborted. Otherwise, a direct connection is used instead. */
fatal: boolean;
}
interface ProxyErrorEvent extends chrome.events.Event {
+ /**
+ * @param callback The callback parameter should be a function that looks like this:
+ * function(object details) {...};
+ */
addListener(callback: (details: ErrorDetails) => void): void;
}
var settings: chrome.types.ChromeSetting;
+ /** Notifies about proxy errors. */
var onProxyError: ProxyErrorEvent;
}
////////////////////
// Runtime
////////////////////
+/**
+ * Use the chrome.runtime API to retrieve the background page, return details about the manifest, and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs.
+ * @since Chrome 22
+ */
declare module chrome.runtime {
+ /** This will be defined during an API method callback if there was an error */
var lastError: LastError;
+ /** The ID of the extension/app. */
var id: string;
interface LastError {
+ /** Optional. Details about the error which occurred. */
message?: string;
}
@@ -1555,42 +5443,103 @@ declare module chrome.runtime {
}
interface InstalledDetails {
+ /**
+ * The reason that this event is being dispatched.
+ * One of: "install", "update", "chrome_update", or "shared_module_update"
+ */
reason: string;
+ /**
+ * Optional.
+ * Indicates the previous version of the extension, which has just been updated. This is present only if 'reason' is 'update'.
+ */
previousVersion?: string;
+ /**
+ * Optional.
+ * Indicates the ID of the imported shared module extension which updated. This is present only if 'reason' is 'shared_module_update'.
+ * @since Chrome 29.
+ */
+ id?: string;
}
interface MessageOptions {
+ /** Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event. */
includeTlsChannelId?: boolean;
}
+ /**
+ * An object containing information about the script context that sent a message or request.
+ * @since Chrome 26.
+ */
interface MessageSender {
+ /** The ID of the extension or app that opened the connection, if any. */
id?: string;
+ /** The tabs.Tab which opened the connection, if any. This property will only be present when the connection was opened from a tab (including content scripts), and only if the receiver is an extension, not an app. */
tab?: chrome.tabs.Tab;
+ /**
+ * The frame that opened the connection. 0 for top-level frames, positive for child frames. This will only be set when tab is set.
+ * @since Chrome 41.
+ */
frameId?: number;
+ /**
+ * The URL of the page or frame that opened the connection. If the sender is in an iframe, it will be iframe's URL not the URL of the page which hosts it.
+ * @since Chrome 28.
+ */
url?: string;
+ /**
+ * The TLS channel ID of the page or frame that opened the connection, if requested by the extension or app, and if available.
+ * @since Chrome 32.
+ */
tlsChannelId?: string;
}
+ /**
+ * An object containing information about the current platform.
+ * @since Chrome 36.
+ */
interface PlatformInfo {
+ /**
+ * The operating system chrome is running on.
+ * One of: "mac", "win", "android", "cros", "linux", or "openbsd"
+ */
os: string;
+ /**
+ * The machine's processor architecture.
+ * One of: "arm", "x86-32", or "x86-64"
+ */
arch: string;
+ /**
+ * The native client architecture. This may be different from arch on some platforms.
+ * One of: "arm", "x86-32", or "x86-64"
+ */
nacl_arch: string;
}
+ /**
+ * An object which allows two way communication with other pages.
+ * @since Chrome 26.
+ */
interface Port {
postMessage: (message: Object) => void;
disconnect: () => void;
+ /**
+ * Optional.
+ * This property will only be present on ports passed to onConnect/onConnectExternal listeners.
+ */
sender?: MessageSender;
+ /** An object which allows the addition and removal of listeners for a Chrome event. */
onDisconnect: chrome.events.Event;
+ /** An object which allows the addition and removal of listeners for a Chrome event. */
onMessage: PortMessageEvent;
name: string;
}
interface UpdateAvailableDetails {
+ /** The version number of the available update. */
version: string;
}
interface UpdateCheckDetails {
+ /** The version of the available update. */
version: string;
}
@@ -1599,10 +5548,11 @@ declare module chrome.runtime {
}
interface ExtensionMessageEvent extends chrome.events.Event {
- addListener(callback: (message: any, sender: MessageSender, sendResponse: Function) => void): void;
- }
-
- interface ExtensionMessageExternalEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Optional parameter message: The message sent by the calling script.
+ * Parameter sendResponse: Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object. If you have more than one onMessage listener in the same document, then only one may send a response. This function becomes invalid when the event listener returns, unless you return true from the event listener to indicate you wish to send a response asynchronously (this will keep the message channel open to the other end until sendResponse is called).
+ */
addListener(callback: (message: any, sender: MessageSender, sendResponse: Function) => void): void;
}
@@ -1610,67 +5560,190 @@ declare module chrome.runtime {
addListener(callback: (port: Port) => void): void;
}
- interface ExtensionConnectExternalEvent extends chrome.events.Event {
- addListener(callback: (port: Port) => void): void;
- }
-
- interface RuntimeSuspendEvent extends chrome.events.Event {
- addListener(callback: Function): void;
- }
-
- interface RuntimeStartupEvent extends chrome.events.Event {
- addListener(callback: Function): void;
- }
-
interface RuntimeInstalledEvent extends chrome.events.Event {
addListener(callback: (details: InstalledDetails) => void): void;
}
- interface RuntimeSuspendCanceledEvent extends chrome.events.Event {
- addListener(callback: Function): void;
- }
- interface RuntimeMessageEvent extends chrome.events.Event {
- addListener(callback: Function): void;
+ interface RuntimeEvent extends chrome.events.Event {
+ addListener(callback: () => void): void;
}
interface RuntimeRestartRequiredEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter reason: The reason that the event is being dispatched. One of: "app_update", "os_update", or "periodic"
+ */
addListener(callback: (reason: string) => void): void;
}
interface RuntimeUpdateAvailableEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter details: The manifest details of the available update.
+ */
addListener(callback: (details: UpdateAvailableDetails) => void): void;
}
+ /**
+ * Attempts to connect to connect listeners within an extension/app (such as the background page), or other extensions/apps. This is useful for content scripts connecting to their extension processes, inter-app/extension communication, and web messaging. Note that this does not connect to any listeners in a content script. Extensions may connect to content scripts embedded in tabs via tabs.connect.
+ * @since Chrome 26.
+ */
export function connect(connectInfo?: ConnectInfo): Port;
+ /**
+ * Attempts to connect to connect listeners within an extension/app (such as the background page), or other extensions/apps. This is useful for content scripts connecting to their extension processes, inter-app/extension communication, and web messaging. Note that this does not connect to any listeners in a content script. Extensions may connect to content scripts embedded in tabs via tabs.connect.
+ * @since Chrome 26.
+ * @param extensionId Optional.
+ * The ID of the extension or app to connect to. If omitted, a connection will be attempted with your own extension. Required if sending messages from a web page for web messaging.
+ */
export function connect(extensionId: string, connectInfo?: ConnectInfo): Port;
+ /**
+ * Connects to a native application in the host machine.
+ * @since Chrome 28.
+ * @param application The name of the registered application to connect to.
+ */
export function connectNative(application: string): Port;
+ /** Retrieves the JavaScript 'window' object for the background page running inside the current extension/app. If the background page is an event page, the system will ensure it is loaded before calling the callback. If there is no background page, an error is set. */
export function getBackgroundPage(callback: (backgroundPage?: Window) => void): void;
+ /**
+ * Returns details about the app or extension from the manifest. The object returned is a serialization of the full manifest file.
+ * @returns The manifest details.
+ */
export function getManifest(): Object;
- export function getPackageDirectoryEntry(callback: (directoryEntry: any) => void): void;
+ /**
+ * Returns a DirectoryEntry for the package directory.
+ * @since Chrome 29.
+ */
+ export function getPackageDirectoryEntry(callback: (directoryEntry: DirectoryEntry) => void): void;
+ /**
+ * Returns information about the current platform.
+ * @since Chrome 29.
+ * @param callback Called with results
+ */
export function getPlatformInfo(callback: (platformInfo: PlatformInfo) => void): void;
+ /**
+ * Converts a relative path within an app/extension install directory to a fully-qualified URL.
+ * @param path A path to a resource within an app/extension expressed relative to its install directory.
+ */
export function getURL(path: string): string;
- export function openOptionsPage(callback?: () => void): void;
+ /**
+ * Reloads the app or extension.
+ * @since Chrome 25.
+ */
export function reload(): void;
+ /**
+ * Requests an update check for this app/extension.
+ * @since Chrome 25.
+ * @param callback
+ * Parameter status: Result of the update check. One of: "throttled", "no_update", or "update_available"
+ * Optional parameter details: If an update is available, this contains more information about the available update.
+ */
export function requestUpdateCheck(callback: (status: string, details?: UpdateCheckDetails) => void): void;
+ /**
+ * Restart the ChromeOS device when the app runs in kiosk mode. Otherwise, it's no-op.
+ * @since Chrome 32.
+ */
export function restart(): void;
+ /**
+ * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to runtime.connect but only sends a single message, with an optional response. If sending to your extension, the runtime.onMessage event will be fired in each page, or runtime.onMessageExternal, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use tabs.sendMessage.
+ * @since Chrome 26.
+ * @param responseCallback Optional
+ * Parameter response: The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
export function sendMessage(message: any, responseCallback?: (response: any) => void): void;
+ /**
+ * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to runtime.connect but only sends a single message, with an optional response. If sending to your extension, the runtime.onMessage event will be fired in each page, or runtime.onMessageExternal, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use tabs.sendMessage.
+ * @since Chrome 32.
+ * @param responseCallback Optional
+ * Parameter response: The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
export function sendMessage(message: any, options: MessageOptions, responseCallback?: (response: any) => void): void;
+ /**
+ * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to runtime.connect but only sends a single message, with an optional response. If sending to your extension, the runtime.onMessage event will be fired in each page, or runtime.onMessageExternal, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use tabs.sendMessage.
+ * @since Chrome 26.
+ * @param extensionId The ID of the extension/app to send the message to. If omitted, the message will be sent to your own extension/app. Required if sending messages from a web page for web messaging.
+ * @param responseCallback Optional
+ * Parameter response: The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
export function sendMessage(extensionId: string, message: any, responseCallback?: (response: any) => void): void;
+ /**
+ * Sends a single message to event listeners within your extension/app or a different extension/app. Similar to runtime.connect but only sends a single message, with an optional response. If sending to your extension, the runtime.onMessage event will be fired in each page, or runtime.onMessageExternal, if a different extension. Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use tabs.sendMessage.
+ * @since Chrome 32.
+ * @param extensionId The ID of the extension/app to send the message to. If omitted, the message will be sent to your own extension/app. Required if sending messages from a web page for web messaging.
+ * @param responseCallback Optional
+ * Parameter response: The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
export function sendMessage(extensionId: string, message: any, options: MessageOptions, responseCallback?: (response: any) => void): void;
- export function sendNativeMessage(application: string, message: any, responseCallback?: (response: any) => void): void;
- export function setUninstallUrl(url: string): void;
+ /**
+ * Send a single message to a native application.
+ * @since Chrome 28.
+ * @param application The of the native messaging host.
+ * @param message The message that will be passed to the native messaging host.
+ * @param responseCallback Optional.
+ * Parameter response: The response message sent by the native messaging host. If an error occurs while connecting to the native messaging host, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
+ export function sendNativeMessage(application: string, message: Object, responseCallback?: (response: any) => void): void;
+ /**
+ * Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.
+ * @since Chrome 41.
+ * @param url Since Chrome 34.
+ * URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation.
+ * @param callback Called when the uninstall URL is set. If the given URL is invalid, runtime.lastError will be set.
+ */
+ export function setUninstallUrl(url: string, callback?: () => void): void;
+ /**
+ * Open your Extension's options page, if possible.
+ * The precise behavior may depend on your manifest's options_ui or options_page key, or what Chrome happens to support at the time. For example, the page may be opened in a new tab, within chrome://extensions, within an App, or it may just focus an open options page. It will never cause the caller page to reload.
+ * If your Extension does not declare an options page, or Chrome failed to create one for some other reason, the callback will set lastError.
+ * @since Chrome 42.
+ */
+ export function openOptionsPage(callback?: () => void): void;
+ /**
+ * Fired when a connection is made from either an extension process or a content script.
+ * @since Chrome 26.
+ */
var onConnect: ExtensionConnectEvent;
- var onConnectExternal: ExtensionConnectExternalEvent;
- var onSuspend: RuntimeSuspendEvent;
- var onStartup: RuntimeStartupEvent;
+ /**
+ * Fired when a connection is made from another extension.
+ * @since Chrome 26.
+ */
+ var onConnectExternal: RuntimeEvent;
+ /** Sent to the event page just before it is unloaded. This gives the extension opportunity to do some clean up. Note that since the page is unloading, any asynchronous operations started while handling this event are not guaranteed to complete. If more activity for the event page occurs before it gets unloaded the onSuspendCanceled event will be sent and the page won't be unloaded. */
+ var onSuspend: RuntimeEvent;
+ /**
+ * Fired when a profile that has this extension installed first starts up. This event is not fired when an incognito profile is started, even if this extension is operating in 'split' incognito mode.
+ * @since Chrome 23.
+ */
+ var onStartup: RuntimeEvent;
+ /** Fired when the extension is first installed, when the extension is updated to a new version, and when Chrome is updated to a new version. */
var onInstalled: RuntimeInstalledEvent;
- var onSuspendCanceled: RuntimeSuspendCanceledEvent;
+ /** Sent after onSuspend to indicate that the app won't be unloaded after all. */
+ var onSuspendCanceled: RuntimeEvent;
+ /**
+ * Fired when a message is sent from either an extension process or a content script.
+ * @since Chrome 26.
+ */
var onMessage: ExtensionMessageEvent;
- var onMessageExternal: ExtensionMessageExternalEvent;
+ /**
+ * Fired when a message is sent from another extension/app. Cannot be used in a content script.
+ * @since Chrome 26.
+ */
+ var onMessageExternal: ExtensionMessageEvent;
+ /**
+ * Fired when an app or the device that it runs on needs to be restarted. The app should close all its windows at its earliest convenient time to let the restart to happen. If the app does nothing, a restart will be enforced after a 24-hour grace period has passed. Currently, this event is only fired for Chrome OS kiosk apps.
+ * @since Chrome 29.
+ */
var onRestartRequired: RuntimeRestartRequiredEvent;
+ /**
+ * Fired when an update is available, but isn't installed immediately because the app is currently running. If you do nothing, the update will be installed the next time the background page gets unloaded, if you want it to be installed sooner you can explicitly call chrome.runtime.reload(). If your extension is using a persistent background page, the background page of course never gets unloaded, so unless you call chrome.runtime.reload() manually in response to this event the update will not get installed until the next time chrome itself restarts. If no handlers are listening for this event, and your extension has a persistent background page, it behaves as if chrome.runtime.reload() is called in response to this event.
+ * @since Chrome 25.
+ */
var onUpdateAvailable: RuntimeUpdateAvailableEvent;
-
+ /**
+ * @deprecated since Chrome 33. Please use chrome.runtime.onRestartRequired.
+ * Fired when a Chrome update is available, but isn't installed immediately because a browser restart is required.
+ */
+ var onBrowserUpdateAvailable: RuntimeEvent;
}
////////////////////
@@ -1701,48 +5774,230 @@ declare module chrome.scriptBadge {
var onClicked: ScriptBadgeClickedEvent;
}
+////////////////////
+// Sessions
+////////////////////
+/**
+ * Use the chrome.sessions API to query and restore tabs and windows from a browsing session.
+ * Permissions: "sessions"
+ * @since Chrome 37.
+ */
+declare module chrome.sessions {
+ interface Filter {
+ /**
+ * Optional.
+ * The maximum number of entries to be fetched in the requested list. Omit this parameter to fetch the maximum number of entries (sessions.MAX_SESSION_RESULTS).
+ */
+ maxResults?: number;
+ }
+
+ interface Session {
+ /** The time when the window or tab was closed or modified, represented in milliseconds since the epoch. */
+ lastModified: number;
+ /**
+ * Optional.
+ * The tabs.Tab, if this entry describes a tab. Either this or sessions.Session.window will be set.
+ */
+ tab?: tabs.Tab;
+ /**
+ * Optional.
+ * The windows.Window, if this entry describes a window. Either this or sessions.Session.tab will be set.
+ */
+ window?: windows.Window;
+ }
+
+ interface Device {
+ /** The name of the foreign device. */
+ deviceName: string;
+ /** A list of open window sessions for the foreign device, sorted from most recently to least recently modified session. */
+ sessions: Session[];
+ }
+
+ interface SessionChangedEvent extends chrome.events.Event {
+ addListener(callback: () => void): void;
+ }
+
+ /** The maximum number of sessions.Session that will be included in a requested list. */
+ export var MAX_SESSION_RESULTS: number;
+
+ /**
+ * Gets the list of recently closed tabs and/or windows.
+ * @param callback
+ * Parameter sessions: The list of closed entries in reverse order that they were closed (the most recently closed tab or window will be at index 0). The entries may contain either tabs or windows.
+ */
+ export function getRecentlyClosed(filter: Filter, callback: (sessions: Session[]) => void): void;
+ /**
+ * Gets the list of recently closed tabs and/or windows.
+ * @param callback
+ * Parameter sessions: The list of closed entries in reverse order that they were closed (the most recently closed tab or window will be at index 0). The entries may contain either tabs or windows.
+ */
+ export function getRecentlyClosed(callback: (sessions: Session[]) => void): void;
+ /**
+ * Retrieves all devices with synced sessions.
+ * @param callback
+ * Parameter devices: The list of sessions.Device objects for each synced session, sorted in order from device with most recently modified session to device with least recently modified session. tabs.Tab objects are sorted by recency in the windows.Window of the sessions.Session objects.
+ */
+ export function getDevices(filter: Filter, callback: (devices: Device[]) => void): void;
+ /**
+ * Retrieves all devices with synced sessions.
+ * @param callback
+ * Parameter devices: The list of sessions.Device objects for each synced session, sorted in order from device with most recently modified session to device with least recently modified session. tabs.Tab objects are sorted by recency in the windows.Window of the sessions.Session objects.
+ */
+ export function getDevices(callback: (devices: Device[]) => void): void;
+ /**
+ * Reopens a windows.Window or tabs.Tab, with an optional callback to run when the entry has been restored.
+ * @param sessionId Optional.
+ * The windows.Window.sessionId, or tabs.Tab.sessionId to restore. If this parameter is not specified, the most recently closed session is restored.
+ * @param callback Optional.
+ * Parameter restoredSession: A sessions.Session containing the restored windows.Window or tabs.Tab object.
+ */
+ export function restore(sessionId?: string, callback?: (restoredSession: Session) => void): void;
+
+ /** Fired when recently closed tabs and/or windows are changed. This event does not monitor synced sessions changes. */
+ export var onChanged: SessionChangedEvent;
+}
+
////////////////////
// Storage
////////////////////
+/**
+ * Use the chrome.storage API to store, retrieve, and track changes to user data.
+ * Permissions: "storage"
+ * @since Chrome 20.
+ */
declare module chrome.storage {
interface StorageArea {
+ /**
+ * Gets the amount of space (in bytes) being used by one or more items.
+ * @param callback Callback with the amount of space being used by storage, or on failure (in which case runtime.lastError will be set).
+ * Parameter bytesInUse: Amount of space being used in storage, in bytes.
+ */
getBytesInUse(callback: (bytesInUse: number) => void): void;
- getBytesInUse(keys: string, callback: (bytesInUse: number) => void): void;
+ /**
+ * Gets the amount of space (in bytes) being used by one or more items.
+ * @param key A single key to get the total usage for. Pass in null to get the total usage of all of storage.
+ * @param callback Callback with the amount of space being used by storage, or on failure (in which case runtime.lastError will be set).
+ * Parameter bytesInUse: Amount of space being used in storage, in bytes.
+ */
+ getBytesInUse(key: string, callback: (bytesInUse: number) => void): void;
+ /**
+ * Gets the amount of space (in bytes) being used by one or more items.
+ * @param keys A list of keys to get the total usage for. An empty list will return 0. Pass in null to get the total usage of all of storage.
+ * @param callback Callback with the amount of space being used by storage, or on failure (in which case runtime.lastError will be set).
+ * Parameter bytesInUse: Amount of space being used in storage, in bytes.
+ */
getBytesInUse(keys: string[], callback: (bytesInUse: number) => void): void;
- clear(callback?: Function): void;
- set(items: Object, callback?: Function): void;
- remove(keys: string, callback?: Function): void;
- remove(keys: string[], callback?: Function): void;
+ /**
+ * Removes all items from storage.
+ * @param callback Optional.
+ * Callback on success, or on failure (in which case runtime.lastError will be set).
+ */
+ clear(callback?: () => void): void;
+ /**
+ * Sets multiple items.
+ * @param items An object which gives each key/value pair to update storage with. Any other key/value pairs in storage will not be affected.
+ * Primitive values such as numbers will serialize as expected. Values with a typeof "object" and "function" will typically serialize to {}, with the exception of Array (serializes as expected), Date, and Regex (serialize using their String representation).
+ * @param callback Optional.
+ * Callback on success, or on failure (in which case runtime.lastError will be set).
+ */
+ set(items: Object, callback?: () => void): void;
+ /**
+ * Removes one item from storage.
+ * @param key A single key for items to remove.
+ * @param callback Optional.
+ * Callback on success, or on failure (in which case runtime.lastError will be set).
+ */
+ remove(key: string, callback?: () => void): void;
+ /**
+ * Removes items from storage.
+ * @param keys A list of keys for items to remove.
+ * @param callback Optional.
+ * Callback on success, or on failure (in which case runtime.lastError will be set).
+ */
+ remove(keys: string[], callback?: () => void): void;
+ /**
+ * Gets one or more items from storage.
+ * @param callback Callback with storage items, or on failure (in which case runtime.lastError will be set).
+ * Parameter items: Object with items in their key-value mappings.
+ */
get(callback: (items: Object) => void): void;
- get(keys: string, callback: (items: Object) => void): void;
+ /**
+ * Gets one or more items from storage.
+ * @param key A single key to get. Pass in null to get the entire contents of storage.
+ * @param callback Callback with storage items, or on failure (in which case runtime.lastError will be set).
+ * Parameter items: Object with items in their key-value mappings.
+ */
+ get(key: string, callback: (items: Object) => void): void;
+ /**
+ * Gets one or more items from storage.
+ * @param keys A list of keys to get. An empty list or object will return an empty result object. Pass in null to get the entire contents of storage.
+ * @param callback Callback with storage items, or on failure (in which case runtime.lastError will be set).
+ * Parameter items: Object with items in their key-value mappings.
+ */
get(keys: string[], callback: (items: Object) => void): void;
+ /**
+ * Gets one or more items from storage.
+ * @param keys A dictionary specifying default values. Pass in null to get the entire contents of storage.
+ * @param callback Callback with storage items, or on failure (in which case runtime.lastError will be set).
+ * Parameter items: Object with items in their key-value mappings.
+ */
get(keys: Object, callback: (items: Object) => void): void;
}
interface StorageChange {
+ /** Optional. The new value of the item, if there is a new value. */
newValue?: any;
+ /** Optional. The old value of the item, if there was an old value. */
oldValue?: any;
}
- interface Local extends StorageArea {
+ interface LocalStorageArea extends StorageArea {
+ /** The maximum amount (in bytes) of data that can be stored in local storage, as measured by the JSON stringification of every value plus every key's length. This value will be ignored if the extension has the unlimitedStorage permission. Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError. */
QUOTA_BYTES: number;
}
- interface Sync extends StorageArea {
+ interface SyncStorageArea extends StorageArea {
+ /** @deprecated since Chrome 40. The storage.sync API no longer has a sustained write operation quota. */
MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE: number;
+ /** The maximum total amount (in bytes) of data that can be stored in sync storage, as measured by the JSON stringification of every value plus every key's length. Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError. */
QUOTA_BYTES: number;
+ /** The maximum size (in bytes) of each individual item in sync storage, as measured by the JSON stringification of its value plus its key length. Updates containing items larger than this limit will fail immediately and set runtime.lastError. */
QUOTA_BYTES_PER_ITEM: number;
+ /** The maximum number of items that can be stored in sync storage. Updates that would cause this limit to be exceeded will fail immediately and set runtime.lastError. */
MAX_ITEMS: number;
+ /**
+ * The maximum number of set, remove, or clear operations that can be performed each hour. This is 1 every 2 seconds, a lower ceiling than the short term higher writes-per-minute limit.
+ * Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError.
+ */
MAX_WRITE_OPERATIONS_PER_HOUR: number;
+ /**
+ * The maximum number of set, remove, or clear operations that can be performed each minute. This is 2 per second, providing higher throughput than writes-per-hour over a shorter period of time.
+ * Updates that would cause this limit to be exceeded fail immediately and set runtime.lastError.
+ * @since Chrome 40.
+ */
+ MAX_WRITE_OPERATIONS_PER_MINUTE: number;
}
interface StorageChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter changes: Object mapping each key that changed to its corresponding storage.StorageChange for that item.
+ * Parameter areaName: Since Chrome 22. The name of the storage area ("sync", "local" or "managed") the changes are for.
+ */
addListener(callback: (changes: Object, areaName: string) => void): void;
}
- var local: Local;
- var sync: Sync;
+ /** Items in the local storage area are local to each machine. */
+ var local: LocalStorageArea;
+ /** Items in the sync storage area are synced using Chrome Sync. */
+ var sync: SyncStorageArea;
+ /**
+ * Items in the managed storage area are set by the domain administrator, and are read-only for the extension; trying to modify this namespace results in an error.
+ * @since Chrome 33.
+ */
+ var managed: StorageArea;
+ /** Fired when one or more items change. */
var onChanged: StorageChangedEvent;
}
@@ -1806,105 +6061,524 @@ declare module chrome.socket {
export function getNetworkList(callback: (result: NetworkInterface[]) => void): void;
}
+////////////////////
+// System CPU
+////////////////////
+/**
+ * Use the system.cpu API to query CPU metadata.
+ * Permissions: "system.cpu"
+ * @since Chrome 32.
+ */
+declare module chrome.system.cpu {
+ interface ProcessorUsage {
+ /** The cumulative time used by userspace programs on this processor. */
+ user: number;
+ /** The cumulative time used by kernel programs on this processor. */
+ kernel: number;
+ /** The cumulative time spent idle by this processor. */
+ idle: number;
+ /** The total cumulative time for this processor. This value is equal to user + kernel + idle. */
+ total: number;
+ }
+
+ interface ProcessorInfo {
+ /** Cumulative usage info for this logical processor. */
+ usage: ProcessorUsage;
+ }
+
+ interface CpuInfo {
+ /** The number of logical processors. */
+ numOfProcessors: number;
+ /** The architecture name of the processors. */
+ archName: string;
+ /** The model name of the processors. */
+ modelName: string;
+ /**
+ * A set of feature codes indicating some of the processor's capabilities.
+ * The currently supported codes are "mmx", "sse", "sse2", "sse3", "ssse3", "sse4_1", "sse4_2", and "avx".
+ */
+ features: string[];
+ /** Information about each logical processor. */
+ processors: ProcessorInfo[];
+ }
+
+ /** Queries basic CPU information of the system. */
+ export function getInfo(callback: (info: CpuInfo) => void): void;
+}
+
+////////////////////
+// System Memory
+////////////////////
+/**
+ * The chrome.system.memory API.
+ * Permissions: "system.memory"
+ * @since Chrome 32.
+ */
+declare module chrome.system.memory {
+ interface MemoryInfo {
+ /** The total amount of physical memory capacity, in bytes. */
+ capacity: number;
+ /** The amount of available capacity, in bytes. */
+ availableCapacity: number;
+ }
+
+ /** Get physical memory information. */
+ export function getInfo(callback: (info: MemoryInfo) => void): void;
+}
+
+////////////////////
+// System Storage
+////////////////////
+/**
+ * Use the chrome.system.storage API to query storage device information and be notified when a removable storage device is attached and detached.
+ * Permissions: "system.storage"
+ * @since Chrome 30.
+ */
+declare module chrome.system.storage {
+ interface StorageUnitInfo {
+ /** The transient ID that uniquely identifies the storage device. This ID will be persistent within the same run of a single application. It will not be a persistent identifier between different runs of an application, or between different applications. */
+ id: string;
+ /** The name of the storage unit. */
+ name: string;
+ /**
+ * The media type of the storage unit.
+ * fixed: The storage has fixed media, e.g. hard disk or SSD.
+ * removable: The storage is removable, e.g. USB flash drive.
+ * unknown: The storage type is unknown.
+ */
+ type: string;
+ /** The total amount of the storage space, in bytes. */
+ capacity: number;
+ }
+
+ interface StorageCapacityInfo {
+ /** A copied |id| of getAvailableCapacity function parameter |id|. */
+ id: string;
+ /** The available capacity of the storage device, in bytes. */
+ availableCapacity: number;
+ }
+
+ interface SystemStorageAttachedEvent extends chrome.events.Event {
+ addListener(callback: (info: StorageUnitInfo) => void): void;
+ }
+
+ interface SystemStorageDetachedEvent extends chrome.events.Event {
+ addListener(callback: (id: string) => void): void;
+ }
+
+ /** Get the storage information from the system. The argument passed to the callback is an array of StorageUnitInfo objects. */
+ export function getInfo(callback: (info: StorageUnitInfo[]) => void): void;
+ /**
+ * Ejects a removable storage device.
+ * @param callback
+ * Parameter result: success: The ejection command is successful -- the application can prompt the user to remove the device; in_use: The device is in use by another application. The ejection did not succeed; the user should not remove the device until the other application is done with the device; no_such_device: There is no such device known. failure: The ejection command failed.
+ */
+ export function ejectDevice(id: string, callback: (result: string) => void): void;
+ /**
+ * Get the available capacity of a specified |id| storage device. The |id| is the transient device ID from StorageUnitInfo.
+ * @since Dev channel only.
+ */
+ export function getAvailableCapacity(id: string, callback: (info: StorageCapacityInfo) => void): void;
+
+ /** Fired when a new removable storage is attached to the system. */
+ export var onAttached: SystemStorageAttachedEvent;
+ /** Fired when a removable storage is detached from the system. */
+ export var onDetached: SystemStorageDetachedEvent;
+}
+
////////////////////
// TabCapture
////////////////////
+/**
+ * Use the chrome.tabCapture API to interact with tab media streams.
+ * Permissions: "tabCapture"
+ * @since Chrome 31.
+ */
declare module chrome.tabCapture {
interface CaptureInfo {
+ /** The id of the tab whose status changed. */
tabId: number;
+ /**
+ * The new capture status of the tab.
+ * One of: "pending", "active", "stopped", or "error"
+ */
status: string;
+ /** Whether an element in the tab being captured is in fullscreen mode. */
fullscreen: boolean;
}
interface CaptureOptions {
+ /** Optional. */
audio?: boolean;
+ /** Optional. */
video?: boolean;
- audioConstraints?: MediaTrackConstraints;
- videoConstraints?: MediaTrackConstraints;
+ /** Optional. */
+ audioConstraints?: MediaStreamConstraints;
+ /** Optional. */
+ videoConstraints?: MediaStreamConstraints;
+ }
+
+ interface CaptureStatusChangedEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter info: CaptureInfo with new capture status for the tab.
+ */
+ addListener(callback: (info: CaptureInfo) => void): void;
}
+ /**
+ * Captures the visible area of the currently active tab. Capture can only be started on the currently active tab after the extension has been invoked. Capture is maintained across page navigations within the tab, and stops when the tab is closed, or the media stream is closed by the extension.
+ * @param options Configures the returned media stream.
+ * @param callback Callback with either the tab capture stream or null.
+ */
export function capture(options: CaptureOptions, callback: (stream: MediaStream) => void): void;
+ /**
+ * Returns a list of tabs that have requested capture or are being captured, i.e. status != stopped and status != error. This allows extensions to inform the user that there is an existing tab capture that would prevent a new tab capture from succeeding (or to prevent redundant requests for the same tab).
+ * @param callback Callback invoked with CaptureInfo[] for captured tabs.
+ */
export function getCapturedTabs(callback: (result: CaptureInfo[]) => void): void;
+
+ /** Event fired when the capture status of a tab changes. This allows extension authors to keep track of the capture status of tabs to keep UI elements like page actions in sync. */
+ var onStatusChanged: CaptureStatusChangedEvent;
}
////////////////////
// Tabs
////////////////////
+/**
+ * Use the chrome.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser.
+ * Permissions: The majority of the chrome.tabs API can be used without declaring any permission. However, the "tabs" permission is required in order to populate the url, title, and favIconUrl properties of Tab.
+ * @since Chrome 5.
+ */
declare module chrome.tabs {
+ /**
+ * Tab muted state and the reason for the last state change.
+ * @since Chrome 46. Warning: this is the current Beta channel.
+ */
+ interface MutedInfo {
+ /** Whether the tab is prevented from playing sound (but hasn't necessarily recently produced sound). Equivalent to whether the muted audio indicator is showing. */
+ muted: boolean;
+ /**
+ * Optional.
+ * The reason the tab was muted or unmuted. Not set if the tab's mute state has never been changed.
+ * "user": A user input action has set/overridden the muted state.
+ * "capture": Tab capture started, forcing a muted state change.
+ * "extension": An extension, identified by the extensionId field, set the muted state.
+ */
+ reason?: string;
+ /**
+ * Optional.
+ * The ID of the extension that changed the muted state. Not set if an extension was not the reason the muted state last changed.
+ */
+ extensionId?: string;
+ }
+
interface Tab {
+ /**
+ * Optional.
+ * Either loading or complete.
+ */
status?: string;
+ /** The zero-based index of the tab within its window. */
index: number;
+ /**
+ * Optional.
+ * The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists.
+ * @since Chrome 18.
+ */
openerTabId?: number;
+ /**
+ * Optional.
+ * The title of the tab. This property is only present if the extension's manifest includes the "tabs" permission.
+ */
title?: string;
+ /**
+ * Optional.
+ * The URL the tab is displaying. This property is only present if the extension's manifest includes the "tabs" permission.
+ */
url?: string;
+ /**
+ * Whether the tab is pinned.
+ * @since Chrome 9.
+ */
pinned: boolean;
+ /**
+ * Whether the tab is highlighted.
+ * @since Chrome 16.
+ */
highlighted: boolean;
+ /** The ID of the window the tab is contained within. */
windowId: number;
+ /**
+ * Whether the tab is active in its window. (Does not necessarily mean the window is focused.)
+ * @since Chrome 16.
+ */
active: boolean;
+ /**
+ * Optional.
+ * The URL of the tab's favicon. This property is only present if the extension's manifest includes the "tabs" permission. It may also be an empty string if the tab is loading.
+ */
favIconUrl?: string;
- id: number;
+ /**
+ * Optional.
+ * The ID of the tab. Tab IDs are unique within a browser session. Under some circumstances a Tab may not be assigned an ID, for example when querying foreign tabs using the sessions API, in which case a session ID may be present. Tab ID can also be set to chrome.tabs.TAB_ID_NONE for apps and devtools windows.
+ */
+ id?: number;
+ /** Whether the tab is in an incognito window. */
incognito: boolean;
+ /**
+ * Whether the tab is selected.
+ * @deprecated since Chrome 33. Please use tabs.Tab.highlighted.
+ */
+ selected: boolean;
+ /**
+ * Optional.
+ * Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the speaker audio indicator is showing.
+ * @since Chrome 45.
+ */
+ audible?: boolean;
+ /**
+ * Optional.
+ * Current tab muted state and the reason for the last state change.
+ * @since Chrome 46. Warning: this is the current Beta channel.
+ */
+ mutedInfo?: MutedInfo;
+ /**
+ * Optional. The width of the tab in pixels.
+ * @since Chrome 31.
+ */
+ width?: number;
+ /**
+ * Optional. The height of the tab in pixels.
+ * @since Chrome 31.
+ */
+ height?: number;
+ /**
+ * Optional. The session ID used to uniquely identify a Tab obtained from the sessions API.
+ * @since Chrome 31.
+ */
+ sessionId?: string;
}
+ /**
+ * Defines how zoom changes in a tab are handled and at what scope.
+ * @since Chrome 38.
+ */
+ interface ZoomSettings {
+ /**
+ * Optional.
+ * Defines how zoom changes are handled, i.e. which entity is responsible for the actual scaling of the page; defaults to "automatic".
+ * "automatic": Zoom changes are handled automatically by the browser.
+ * "manual": Overrides the automatic handling of zoom changes. The onZoomChange event will still be dispatched, and it is the responsibility of the extension to listen for this event and manually scale the page. This mode does not support per-origin zooming, and will thus ignore the scope zoom setting and assume per-tab.
+ * "disabled": Disables all zooming in the tab. The tab will revert to the default zoom level, and all attempted zoom changes will be ignored.
+ */
+ mode?: string;
+ /**
+ * Optional.
+ * Defines whether zoom changes will persist for the page's origin, or only take effect in this tab; defaults to per-origin when in automatic mode, and per-tab otherwise.
+ * "per-origin": Zoom changes will persist in the zoomed page's origin, i.e. all other tabs navigated to that same origin will be zoomed as well. Moreover, per-origin zoom changes are saved with the origin, meaning that when navigating to other pages in the same origin, they will all be zoomed to the same zoom factor. The per-origin scope is only available in the automatic mode.
+ * "per-tab": Zoom changes only take effect in this tab, and zoom changes in other tabs will not affect the zooming of this tab. Also, per-tab zoom changes are reset on navigation; navigating a tab will always load pages with their per-origin zoom factors.
+ */
+ scope?: string;
+ /**
+ * Optional.
+ * Used to return the default zoom level for the current tab in calls to tabs.getZoomSettings.
+ * @since Chrome 43.
+ */
+ defaultZoomFactor?: number;
+ }
+
interface InjectDetails {
+ /**
+ * Optional.
+ * If allFrames is true, implies that the JavaScript or CSS should be injected into all frames of current page. By default, it's false and is only injected into the top frame.
+ */
allFrames?: boolean;
+ /**
+ * Optional. JavaScript or CSS code to inject.
+ * Warning: Be careful using the code parameter. Incorrect use of it may open your extension to cross site scripting attacks.
+ */
code?: string;
+ /**
+ * Optional. The soonest that the JavaScript or CSS will be injected into the tab.
+ * One of: "document_start", "document_end", or "document_idle"
+ * @since Chrome 20.
+ */
runAt?: string;
+ /** Optional. JavaScript or CSS file to inject. */
file?: string;
+ /**
+ * Optional.
+ * If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is false.
+ * @since Chrome 39.
+ */
+ matchAboutBlank?: boolean;
}
interface CreateProperties {
+ /** Optional. The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window. */
index?: number;
+ /**
+ * Optional.
+ * The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as the newly created tab.
+ * @since Chrome 18.
+ */
openerTabId?: number;
+ /**
+ * Optional.
+ * The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.
+ */
url?: string;
+ /**
+ * Optional. Whether the tab should be pinned. Defaults to false
+ * @since Chrome 9.
+ */
pinned?: boolean;
+ /** Optional. The window to create the new tab in. Defaults to the current window. */
windowId?: number;
+ /**
+ * Optional.
+ * Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see windows.update). Defaults to true.
+ * @since Chrome 16.
+ */
active?: boolean;
+ /**
+ * Optional. Whether the tab should become the selected tab in the window. Defaults to true
+ * @deprecated since Chrome 33. Please use active.
+ */
+ selected?: boolean;
}
interface MoveProperties {
+ /** The position to move the window to. -1 will place the tab at the end of the window. */
index: number;
+ /** Optional. Defaults to the window the tab is currently in. */
windowId?: number;
}
interface UpdateProperties {
+ /**
+ * Optional. Whether the tab should be pinned.
+ * @since Chrome 9.
+ */
pinned?: boolean;
+ /**
+ * Optional. The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as this tab.
+ * @since Chrome 18.
+ */
openerTabId?: number;
+ /** Optional. A URL to navigate the tab to. */
url?: string;
+ /**
+ * Optional. Adds or removes the tab from the current selection.
+ * @since Chrome 16.
+ */
highlighted?: boolean;
+ /**
+ * Optional. Whether the tab should be active. Does not affect whether the window is focused (see windows.update).
+ * @since Chrome 16.
+ */
active?: boolean;
+ /**
+ * Optional. Whether the tab should be selected.
+ * @deprecated since Chrome 33. Please use highlighted.
+ */
+ selected?: boolean;
+ /**
+ * Optional. Whether the tab should be muted.
+ * @since Chrome 45.
+ */
+ muted?: boolean;
}
interface CaptureVisibleTabOptions {
+ /**
+ * Optional.
+ * When format is "jpeg", controls the quality of the resulting image. This value is ignored for PNG images. As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease.
+ */
quality?: number;
+ /**
+ * Optional. The format of an image.
+ * One of: "jpeg", or "png"
+ */
format?: string;
}
interface ReloadProperties {
+ /** Optional. Whether using any local cache. Default is false. */
bypassCache?: boolean;
}
interface ConnectInfo {
+ /** Optional. Will be passed into onConnect for content scripts that are listening for the connection event. */
name?: string;
+ /**
+ * Open a port to a specific frame identified by frameId instead of all frames in the tab.
+ * @since Chrome 41.
+ */
+ frameId?: number;
}
+ interface MessageSendOptions {
+ /** Optional. Send a message to a specific frame identified by frameId instead of all frames in the tab. */
+ frameId?: number;
+ }
+
interface HighlightInfo {
- tabs: number[];
+ /** One or more tab indices to highlight. */
+ tabs: number | number[];
+ /** Optional. The window that contains the tabs. */
windowId?: number;
}
interface QueryInfo {
+ /**
+ * Optional. Whether the tabs have completed loading.
+ * One of: "loading", or "complete"
+ */
status?: string;
+ /**
+ * Optional. Whether the tabs are in the last focused window.
+ * @since Chrome 19.
+ */
lastFocusedWindow?: boolean;
+ /** Optional. The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window. */
windowId?: number;
+ /**
+ * Optional. The type of window the tabs are in.
+ * One of: "normal", "popup", "panel", "app", or "devtools"
+ */
windowType?: string;
+ /** Optional. Whether the tabs are active in their windows. */
active?: boolean;
+ /**
+ * Optional. The position of the tabs within their windows.
+ * @since Chrome 18.
+ */
index?: number;
+ /** Optional. Match page titles against a pattern. */
title?: string;
+ /** Optional. Match tabs against one or more URL patterns. Note that fragment identifiers are not matched. */
url?: string | string[];
+ /**
+ * Optional. Whether the tabs are in the current window.
+ * @since Chrome 19.
+ */
currentWindow?: boolean;
+ /** Optional. Whether the tabs are highlighted. */
highlighted?: boolean;
+ /** Optional. Whether the tabs are pinned. */
pinned?: boolean;
+ /**
+ * Optional. Whether the tabs are audible.
+ * @since Chrome 45.
+ */
+ audible?: boolean;
+ /**
+ * Optional. Whether the tabs are muted.
+ * @since Chrome 45.
+ */
+ muted?: boolean;
}
interface TabHighlightInfo {
@@ -1913,7 +6587,12 @@ declare module chrome.tabs {
}
interface TabRemoveInfo {
+ /**
+ * The window whose tab is closed.
+ * @since Chrome 25.
+ */
windowId: number;
+ /** True when the tab is being closed because its window is being closed. */
isWindowClosing: boolean;
}
@@ -1923,9 +6602,30 @@ declare module chrome.tabs {
}
interface TabChangeInfo {
+ /** Optional. The status of the tab. Can be either loading or complete. */
status?: string;
+ /**
+ * The tab's new pinned state.
+ * @since Chrome 9.
+ */
pinned?: boolean;
+ /** Optional. The tab's URL if it has changed. */
url?: string;
+ /**
+ * The tab's new audible state.
+ * @since Chrome 45.
+ */
+ audible?: boolean;
+ /**
+ * The tab's new muted state and the reason for the change.
+ * @since Chrome 46. Warning: this is the current Beta channel.
+ */
+ mutedInfo?: MutedInfo;
+ /**
+ * The tab's new favicon URL.
+ * @since Chrome 27.
+ */
+ faviconUrl?: string;
}
interface TabMoveInfo {
@@ -1940,10 +6640,24 @@ declare module chrome.tabs {
}
interface TabActiveInfo {
+ /** The ID of the tab that has become active. */
tabId: number;
+ /** The ID of the window the active tab changed inside of. */
windowId: number;
}
+ interface TabWindowInfo {
+ /** The ID of the window of where the tab is located. */
+ windowId: number;
+ }
+
+ interface ZoomChangeInfo {
+ tabId: number;
+ oldZoomFactor: number;
+ newZoomFactor: number;
+ zoomSettings: ZoomSettings;
+ }
+
interface TabHighlightedEvent extends chrome.events.Event {
addListener(callback: (highlightInfo: HighlightInfo) => void): void;
}
@@ -1953,6 +6667,11 @@ declare module chrome.tabs {
}
interface TabUpdatedEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter changeInfo: Lists the changes to the state of the tab that was updated.
+ * Parameter tab: Gives the state of the tab that was updated.
+ */
addListener(callback: (tabId: number, changeInfo: TabChangeInfo, tab: Tab) => void): void;
}
@@ -1969,6 +6688,10 @@ declare module chrome.tabs {
}
interface TabCreatedEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter tab: Details of the tab that was created.
+ */
addListener(callback: (tab: Tab) => void): void;
}
@@ -1980,138 +6703,576 @@ declare module chrome.tabs {
addListener(callback: (addedTabId: number, removedTabId: number) => void): void;
}
- export function executeScript(details: InjectDetails, callback?: (result: any[]) => void): void;
- export function executeScript(tabId: number, details: InjectDetails, callback?: (result: any[]) => void): void;
- export function get(tabId: number, callback: (tab: Tab) => void): void;
- export function getCurrent(callback: (tab?: Tab) => void): void;
- export function create(createProperties: CreateProperties, callback?: (tab: Tab) => void): void;
- export function move(tabId: number, moveProperties: MoveProperties, callback?: (tab: Tab) => void): void;
- export function move(tabIds: number[], moveProperties: MoveProperties, callback?: (tabs: Tab[]) => void): void;
- export function update(updateProperties: UpdateProperties, callback?: (tab?: Tab) => void): void;
- export function update(tabId: number, updateProperties: UpdateProperties, callback?: (tab?: Tab) => void): void;
- export function remove(tabId: number, callback?: Function): void;
- export function remove(tabIds: number[], callback?: Function): void;
- export function captureVisibleTab(callback: (dataUrl: string) => void): void;
- export function captureVisibleTab(windowId: number, callback: (dataUrl: string) => void): void;
- export function captureVisibleTab(options: CaptureVisibleTabOptions, callback: (dataUrl: string) => void): void;
- export function captureVisibleTab(windowId: number, options: CaptureVisibleTabOptions, callback: (dataUrl: string) => void): void;
- export function reload(tabId?: number, reloadProperties?: ReloadProperties, func?: Function): void;
- export function duplicate(tabId: number, callback?: (tab?: Tab) => void): void;
- export function sendMessage(tabId: number, message: any, responseCallback?: (response: any) => void): void;
- export function connect(tabId: number, connectInfo?: ConnectInfo): runtime.Port;
- export function insertCSS(tabId: number, details: InjectDetails, callback?: Function): void;
- export function highlight(highlightInfo: HighlightInfo, callback: (window: chrome.windows.Window) => void): void;
- export function query(queryInfo: QueryInfo, callback: (result: Tab[]) => void): void;
- export function detectLanguage(callback: (language: string) => void): void;
- export function detectLanguage(tabId: number, callback: (language: string) => void): void;
+ interface TabSelectedEvent extends chrome.events.Event {
+ addListener(callback: (tabId: number, selectInfo: TabWindowInfo) => void): void;
+ }
+ interface TabZoomChangeEvent extends chrome.events.Event {
+ addListener(callback: (ZoomChangeInfo: ZoomChangeInfo) => void): void;
+ }
+
+ /**
+ * Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.
+ * @param details Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.
+ * @param callback Optional. Called after all the JavaScript has been executed.
+ * Parameter result: The result of the script in every injected frame.
+ */
+ export function executeScript(details: InjectDetails, callback?: (result: any[]) => void): void;
+ /**
+ * Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.
+ * @param tabId Optional. The ID of the tab in which to run the script; defaults to the active tab of the current window.
+ * @param details Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.
+ * @param callback Optional. Called after all the JavaScript has been executed.
+ * Parameter result: The result of the script in every injected frame.
+ */
+ export function executeScript(tabId: number, details: InjectDetails, callback?: (result: any[]) => void): void;
+ /** Retrieves details about the specified tab. */
+ export function get(tabId: number, callback: (tab: Tab) => void): void;
+ /**
+ * Gets details about all tabs in the specified window.
+ * @deprecated since Chrome 33. Please use tabs.query {windowId: windowId}.
+ */
+ export function getAllInWindow(callback: (tab: Tab) => void): void;
+ /**
+ * Gets details about all tabs in the specified window.
+ * @deprecated since Chrome 33. Please use tabs.query {windowId: windowId}.
+ * @param windowId Optional. Defaults to the current window.
+ */
+ export function getAllInWindow(windowId: number, callback: (tab: Tab) => void): void;
+ /** Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example: a background page or popup view). */
+ export function getCurrent(callback: (tab?: Tab) => void): void;
+ /**
+ * Gets the tab that is selected in the specified window.
+ * @deprecated since Chrome 33. Please use tabs.query {active: true}.
+ */
+ export function getSelected(callback: (tab: Tab) => void): void;
+ /**
+ * Gets the tab that is selected in the specified window.
+ * @deprecated since Chrome 33. Please use tabs.query {active: true}.
+ * @param windowId Optional. Defaults to the current window.
+ */
+ export function getSelected(windowId: number, callback: (tab: Tab) => void): void;
+ /**
+ * Creates a new tab.
+ * @param callback Optional.
+ * Parameter tab: Details about the created tab. Will contain the ID of the new tab.
+ */
+ export function create(createProperties: CreateProperties, callback?: (tab: Tab) => void): void;
+ /**
+ * Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === "normal") windows.
+ * @param tabId The tab to move.
+ * @param callback Optional.
+ * Parameter tab: Details about the moved tab.
+ */
+ export function move(tabId: number, moveProperties: MoveProperties, callback?: (tab: Tab) => void): void;
+ /**
+ * Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === "normal") windows.
+ * @param tabIds The tabs to move.
+ * @param callback Optional.
+ * Parameter tabs: Details about the moved tabs.
+ */
+ export function move(tabIds: number[], moveProperties: MoveProperties, callback?: (tabs: Tab[]) => void): void;
+ /**
+ * Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.
+ * @param callback Optional.
+ * Optional parameter tab: Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested.
+ */
+ export function update(updateProperties: UpdateProperties, callback?: (tab?: Tab) => void): void;
+ /**
+ * Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.
+ * @param tabId Defaults to the selected tab of the current window.
+ * @param callback Optional.
+ * Optional parameter tab: Details about the updated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested.
+ */
+ export function update(tabId: number, updateProperties: UpdateProperties, callback?: (tab?: Tab) => void): void;
+ /**
+ * Closes a tab.
+ * @param tabId The tab to close.
+ */
+ export function remove(tabId: number, callback?: Function): void;
+ /**
+ * Closes several tabs.
+ * @param tabIds The list of tabs to close.
+ */
+ export function remove(tabIds: number[], callback?: Function): void;
+ /**
+ * Captures the visible area of the currently active tab in the specified window. You must have <all_urls> permission to use this method.
+ * @param callback
+ * Parameter dataUrl: A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.
+ */
+ export function captureVisibleTab(callback: (dataUrl: string) => void): void;
+ /**
+ * Captures the visible area of the currently active tab in the specified window. You must have <all_urls> permission to use this method.
+ * @param windowId Optional. The target window. Defaults to the current window.
+ * @param callback
+ * Parameter dataUrl: A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.
+ */
+ export function captureVisibleTab(windowId: number, callback: (dataUrl: string) => void): void;
+ /**
+ * Captures the visible area of the currently active tab in the specified window. You must have <all_urls> permission to use this method.
+ * @param options Optional. Details about the format and quality of an image.
+ * @param callback
+ * Parameter dataUrl: A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.
+ */
+ export function captureVisibleTab(options: CaptureVisibleTabOptions, callback: (dataUrl: string) => void): void;
+ /**
+ * Captures the visible area of the currently active tab in the specified window. You must have <all_urls> permission to use this method.
+ * @param windowId Optional. The target window. Defaults to the current window.
+ * @param options Optional. Details about the format and quality of an image.
+ * @param callback
+ * Parameter dataUrl: A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.
+ */
+ export function captureVisibleTab(windowId: number, options: CaptureVisibleTabOptions, callback: (dataUrl: string) => void): void;
+ /**
+ * Reload a tab.
+ * @since Chrome 16.
+ * @param tabId The ID of the tab to reload; defaults to the selected tab of the current window.
+ */
+ export function reload(tabId: number, reloadProperties?: ReloadProperties, callback?: () => void): void;
+ /**
+ * Reload the selected tab of the current window.
+ * @since Chrome 16.
+ */
+ export function reload(reloadProperties: ReloadProperties, callback?: () => void): void;
+ /**
+ * Reload the selected tab of the current window.
+ * @since Chrome 16.
+ */
+ export function reload(callback?: () => void): void;
+ /**
+ * Duplicates a tab.
+ * @since Chrome 23.
+ * @param tabId The ID of the tab which is to be duplicated.
+ * @param callback Optional.
+ * Optional parameter tab: Details about the duplicated tab. The tabs.Tab object doesn't contain url, title and favIconUrl if the "tabs" permission has not been requested.
+ */
+ export function duplicate(tabId: number, callback?: (tab?: Tab) => void): void;
+ /**
+ * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The runtime.onMessage event is fired in each content script running in the specified tab for the current extension.
+ * @since Chrome 20.
+ */
+ export function sendMessage(tabId: number, message: any, responseCallback?: (response: any) => void): void;
+ /**
+ * Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The runtime.onMessage event is fired in each content script running in the specified tab for the current extension.
+ * @since Chrome 41.
+ * @param responseCallback Optional.
+ * Parameter response: The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
+ export function sendMessage(tabId: number, message: any, options: MessageSendOptions, responseCallback?: (response: any) => void): void;
+ /**
+ * Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The extension.onRequest event is fired in each content script running in the specified tab for the current extension.
+ * @deprecated since Chrome 33. Please use runtime.sendMessage.
+ * @param responseCallback Optional.
+ * Parameter response: The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and runtime.lastError will be set to the error message.
+ */
+ export function sendRequest(tabId: number, request: any, responseCallback?: (response: any) => void): void;
+ /** Connects to the content script(s) in the specified tab. The runtime.onConnect event is fired in each content script running in the specified tab for the current extension. */
+ export function connect(tabId: number, connectInfo?: ConnectInfo): runtime.Port;
+ /**
+ * Injects CSS into a page. For details, see the programmatic injection section of the content scripts doc.
+ * @param details Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.
+ * @param callback Optional. Called when all the CSS has been inserted.
+ */
+ export function insertCSS(details: InjectDetails, callback?: Function): void;
+ /**
+ * Injects CSS into a page. For details, see the programmatic injection section of the content scripts doc.
+ * @param tabId Optional. The ID of the tab in which to insert the CSS; defaults to the active tab of the current window.
+ * @param details Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.
+ * @param callback Optional. Called when all the CSS has been inserted.
+ */
+ export function insertCSS(tabId: number, details: InjectDetails, callback?: Function): void;
+ /**
+ * Highlights the given tabs.
+ * @since Chrome 16.
+ * @param callback Optional.
+ * Parameter window: Contains details about the window whose tabs were highlighted.
+ */
+ export function highlight(highlightInfo: HighlightInfo, callback: (window: chrome.windows.Window) => void): void;
+ /**
+ * Gets all tabs that have the specified properties, or all tabs if no properties are specified.
+ * @since Chrome 16.
+ */
+ export function query(queryInfo: QueryInfo, callback: (result: Tab[]) => void): void;
+ /**
+ * Detects the primary language of the content in a tab.
+ * @param callback
+ * Parameter language: An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. The 2nd to 4th columns will be checked and the first non-NULL value will be returned except for Simplified Chinese for which zh-CN will be returned. For an unknown language, und will be returned.
+ */
+ export function detectLanguage(callback: (language: string) => void): void;
+ /**
+ * Detects the primary language of the content in a tab.
+ * @param tabId Optional. Defaults to the active tab of the current window.
+ * @param callback
+ * Parameter language: An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. The 2nd to 4th columns will be checked and the first non-NULL value will be returned except for Simplified Chinese for which zh-CN will be returned. For an unknown language, und will be returned.
+ */
+ export function detectLanguage(tabId: number, callback: (language: string) => void): void;
+ /**
+ * Zooms a specified tab.
+ * @since Chrome 42.
+ * @param zoomFactor The new zoom factor. Use a value of 0 here to set the tab to its current default zoom factor. Values greater than zero specify a (possibly non-default) zoom factor for the tab.
+ * @param callback Optional. Called after the zoom factor has been changed.
+ */
+ export function setZoom(zoomFactor: number, callback?: () => void): void;
+ /**
+ * Zooms a specified tab.
+ * @since Chrome 42.
+ * @param tabId Optional. The ID of the tab to zoom; defaults to the active tab of the current window.
+ * @param zoomFactor The new zoom factor. Use a value of 0 here to set the tab to its current default zoom factor. Values greater than zero specify a (possibly non-default) zoom factor for the tab.
+ * @param callback Optional. Called after the zoom factor has been changed.
+ */
+ export function setZoom(tabId: number, zoomFactor: number, callback?: () => void): void;
+ /**
+ * Gets the current zoom factor of a specified tab.
+ * @since Chrome 42.
+ * @param callback Called with the tab's current zoom factor after it has been fetched.
+ * Parameter zoomFactor: The tab's current zoom factor.
+ */
+ export function getZoom(callback: (zoomFactor: number) => void): void;
+ /**
+ * Gets the current zoom factor of a specified tab.
+ * @since Chrome 42.
+ * @param tabId Optional. The ID of the tab to get the current zoom factor from; defaults to the active tab of the current window.
+ * @param callback Called with the tab's current zoom factor after it has been fetched.
+ * Parameter zoomFactor: The tab's current zoom factor.
+ */
+ export function getZoom(tabId: number, callback: (zoomFactor: number) => void): void;
+ /**
+ * Sets the zoom settings for a specified tab, which define how zoom changes are handled. These settings are reset to defaults upon navigating the tab.
+ * @since Chrome 42.
+ * @param zoomSettings Defines how zoom changes are handled and at what scope.
+ * @param callback Optional. Called after the zoom settings have been changed.
+ */
+ export function setZoomSettings(zoomSettings: ZoomSettings, callback?: () => void): void;
+ /**
+ * Sets the zoom settings for a specified tab, which define how zoom changes are handled. These settings are reset to defaults upon navigating the tab.
+ * @since Chrome 42.
+ * @param tabId Optional. The ID of the tab to change the zoom settings for; defaults to the active tab of the current window.
+ * @param zoomSettings Defines how zoom changes are handled and at what scope.
+ * @param callback Optional. Called after the zoom settings have been changed.
+ */
+ export function setZoomSettings(tabId: number, zoomSettings: ZoomSettings, callback?: () => void): void;
+ /**
+ * Gets the current zoom settings of a specified tab.
+ * @since Chrome 42.
+ * @param callback Called with the tab's current zoom settings.
+ * Paramater zoomSettings: The tab's current zoom settings.
+ */
+ export function getZoomSettings(callback: (zoomSettings: ZoomSettings) => void): void;
+ /**
+ * Gets the current zoom settings of a specified tab.
+ * @since Chrome 42.
+ * @param tabId Optional. The ID of the tab to get the current zoom settings from; defaults to the active tab of the current window.
+ * @param callback Called with the tab's current zoom settings.
+ * Paramater zoomSettings: The tab's current zoom settings.
+ */
+ export function getZoomSettings(tabId: number, callback: (zoomSettings: ZoomSettings) => void): void;
+
+ /**
+ * Fired when the highlighted or selected tabs in a window changes.
+ * @since Chrome 18.
+ */
var onHighlighted: TabHighlightedEvent;
+ /** Fired when a tab is closed. */
var onRemoved: TabRemovedEvent;
+ /** Fired when a tab is updated. */
var onUpdated: TabUpdatedEvent;
+ /** Fired when a tab is attached to a window, for example because it was moved between windows. */
var onAttached: TabAttachedEvent;
+ /**
+ * Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see tabs.onDetached.
+ */
var onMoved: TabMovedEvent;
+ /** Fired when a tab is detached from a window, for example because it is being moved between windows. */
var onDetached: TabDetachedEvent;
+ /** Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to be notified when a URL is set. */
var onCreated: TabCreatedEvent;
+ /**
+ * Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to be notified when a URL is set.
+ * @since Chrome 18.
+ */
var onActivated: TabActivatedEvent;
+ /**
+ * Fired when a tab is replaced with another tab due to prerendering or instant.
+ * @since Chrome 26.
+ */
var onReplaced: TabReplacedEvent;
+ /**
+ * @deprecated since Chrome 33. Please use tabs.onActivated.
+ * Fires when the selected tab in a window changes.
+ */
+ var onSelectionChanged: TabSelectedEvent;
+ /**
+ * @deprecated since Chrome 33. Please use tabs.onActivated.
+ * Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to tabs.onUpdated events to be notified when a URL is set.
+ */
+ var onActiveChanged: TabSelectedEvent;
+ /**
+ * @deprecated since Chrome 33. Please use tabs.onHighlighted.
+ * Fired when the highlighted or selected tabs in a window changes.
+ */
+ var onHighlightChanged: TabHighlightedEvent;
+ /**
+ * Fired when a tab is zoomed.
+ * @since Chrome 38.
+ */
+ var onZoomChange: TabZoomChangeEvent;
}
////////////////////
// Top Sites
////////////////////
+/**
+ * Use the chrome.topSites API to access the top sites that are displayed on the new tab page.
+ * Permissions: "topSites"
+ * @since Chrome 19.
+ */
declare module chrome.topSites {
+ /** An object encapsulating a most visited URL, such as the URLs on the new tab page. */
interface MostVisitedURL {
+ /** The most visited URL. */
url: string;
+ /** The title of the page */
title: string;
}
- export function get(callback: (data: MostVisitedURL) => void): void;
+ /** Gets a list of top sites. */
+ export function get(callback: (data: MostVisitedURL[]) => void): void;
}
////////////////////
// Text to Speech
////////////////////
+/**
+ * Use the chrome.tts API to play synthesized text-to-speech (TTS). See also the related ttsEngine API, which allows an extension to implement a speech engine.
+ * Permissions: "tts"
+ * @since Chrome 14.
+ */
declare module chrome.tts {
+ /** An event from the TTS engine to communicate the status of an utterance. */
interface TtsEvent {
+ /** Optional. The index of the current character in the utterance. */
charIndex?: number;
+ /** Optional. The error description, if the event type is 'error'. */
errorMessage?: string;
+ /**
+ * The type can be 'start' as soon as speech has started, 'word' when a word boundary is reached, 'sentence' when a sentence boundary is reached, 'marker' when an SSML mark element is reached, 'end' when the end of the utterance is reached, 'interrupted' when the utterance is stopped or interrupted before reaching the end, 'cancelled' when it's removed from the queue before ever being synthesized, or 'error' when any other error occurs. When pausing speech, a 'pause' event is fired if a particular utterance is paused in the middle, and 'resume' if an utterance resumes speech. Note that pause and resume events may not fire if speech is paused in-between utterances.
+ * One of: "start", "end", "word", "sentence", "marker", "interrupted", "cancelled", "error", "pause", or "resume"
+ */
type: string;
}
+ /** A description of a voice available for speech synthesis. */
interface TtsVoice {
+ /** Optional. The language that this voice supports, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'. */
lang?: string;
+ /**
+ * Optional. This voice's gender.
+ * One of: "male", or "female"
+ */
gender?: string;
+ /** Optional. The name of the voice. */
voiceName?: string;
+ /** The ID of the extension providing this voice. */
extensionsId?: string;
+ /** All of the callback event types that this voice is capable of sending. */
eventTypes?: string[];
+ /**
+ * If true, the synthesis engine is a remote network resource. It may be higher latency and may incur bandwidth costs.
+ * @since Chrome 33.
+ */
+ remote?: boolean;
}
interface SpeakOptions {
+ /** Optional. Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0. */
volume?: number;
+ /**
+ * Optional.
+ * If true, enqueues this utterance if TTS is already in progress. If false (the default), interrupts any current speech and flushes the speech queue before speaking this new utterance.
+ */
enqueue?: boolean;
+ /**
+ * Optional.
+ * Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. Values below 0.1 or above 10.0 are strictly disallowed, but many voices will constrain the minimum and maximum rates further—for example a particular voice may not actually speak faster than 3 times normal even if you specify a value larger than 3.0.
+ */
rate?: number;
+ /**
+ * Optional. This function is called with events that occur in the process of speaking the utterance.
+ * @param event The update event from the text-to-speech engine indicating the status of this utterance.
+ */
onEvent?: (event: TtsEvent) => void;
+ /**
+ * Optional.
+ * Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to a voice's default pitch.
+ */
pitch?: number;
+ /** Optional. The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'. */
lang?: string;
+ /** Optional. The name of the voice to use for synthesis. If empty, uses any available voice. */
voiceName?: string;
+ /** Optional. The extension ID of the speech engine to use, if known. */
extensionId?: string;
+ /**
+ * Optional. Gender of voice for synthesized speech.
+ * One of: "male", or "female"
+ */
gender?: string;
+ /** Optional. The TTS event types the voice must support. */
requiredEventTypes?: string[];
+ /** Optional. The TTS event types that you are interested in listening to. If missing, all event types may be sent. */
desiredEventTypes?: string[];
}
+ /** Checks whether the engine is currently speaking. On Mac OS X, the result is true whenever the system speech engine is speaking, even if the speech wasn't initiated by Chrome. */
export function isSpeaking(callback?: (speaking: boolean) => void): void;
+ /** Stops any current speech and flushes the queue of any pending utterances. In addition, if speech was paused, it will now be un-paused for the next call to speak. */
export function stop(): void;
+ /** Gets an array of all available voices. */
export function getVoices(callback?: (voices: TtsVoice[]) => void): void;
- export function speak(utterance: string, options?: SpeakOptions, callback?: Function): void;
+ /**
+ * Speaks text using a text-to-speech engine.
+ * @param utterance The text to speak, either plain text or a complete, well-formed SSML document. Speech engines that do not support SSML will strip away the tags and speak the text. The maximum length of the text is 32,768 characters.
+ * @param callback Optional. Called right away, before speech finishes. Check chrome.runtime.lastError to make sure there were no errors. Use options.onEvent to get more detailed feedback.
+ */
+ export function speak(utterance: string, callback?: Function): void;
+ /**
+ * Speaks text using a text-to-speech engine.
+ * @param utterance The text to speak, either plain text or a complete, well-formed SSML document. Speech engines that do not support SSML will strip away the tags and speak the text. The maximum length of the text is 32,768 characters.
+ * @param options Optional. The speech options.
+ * @param callback Optional. Called right away, before speech finishes. Check chrome.runtime.lastError to make sure there were no errors. Use options.onEvent to get more detailed feedback.
+ */
+ export function speak(utterance: string, options: SpeakOptions, callback?: Function): void;
+ /**
+ * Pauses speech synthesis, potentially in the middle of an utterance. A call to resume or stop will un-pause speech.
+ * @since Chrome 29.
+ */
+ export function pause(): void;
+ /**
+ * If speech was paused, resumes speaking where it left off.
+ * @since Chrome 29.
+ */
+ export function resume(): void;
}
////////////////////
// Text to Speech Engine
////////////////////
+/**
+ * Use the chrome.ttsEngine API to implement a text-to-speech(TTS) engine using an extension. If your extension registers using this API, it will receive events containing an utterance to be spoken and other parameters when any extension or Chrome App uses the tts API to generate speech. Your extension can then use any available web technology to synthesize and output the speech, and send events back to the calling function to report the status.
+ * Permissions: "ttsEngine"
+ * @since Chrome 14.
+ */
declare module chrome.ttsEngine {
interface SpeakOptions {
+ /** Optional. The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'. */
lang?: string;
+ /** Optional. The name of the voice to use for synthesis. */
voiceName?: string;
+ /**
+ * Optional. Gender of voice for synthesized speech.
+ * One of: "male", or "female"
+ */
gender?: string;
+ /** Optional. Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0. */
volume?: number;
+ /**
+ * Optional.
+ * Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. This value is guaranteed to be between 0.1 and 10.0, inclusive. When a voice does not support this full range of rates, don't return an error. Instead, clip the rate to the range the voice supports.
+ */
rate?: number;
+ /** Optional. Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to this voice's default pitch. */
pitch?: number;
}
interface TtsEngineSpeakEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter utterance: The text to speak, specified as either plain text or an SSML document. If your engine does not support SSML, you should strip out all XML markup and synthesize only the underlying text content. The value of this parameter is guaranteed to be no more than 32,768 characters. If this engine does not support speaking that many characters at a time, the utterance should be split into smaller chunks and queued internally without returning an error.
+ * Parameter options: Options specified to the tts.speak() method.
+ * Parameter sendTtsEvent: Call this function with events that occur in the process of speaking the utterance.
+ */
addListener(callback: (utterance: string, options: SpeakOptions, sendTtsEvent: (event: chrome.tts.TtsEvent) => void) => void): void;
}
- interface TtsEngineStopEvent extends chrome.events.Event {
- addListener(callback: Function): void;
- }
-
+ /** Called when the user makes a call to tts.speak() and one of the voices from this extension's manifest is the first to match the options object. */
var onSpeak: TtsEngineSpeakEvent;
- var onStop: TtsEngineStopEvent;
+ /** Fired when a call is made to tts.stop and this extension may be in the middle of speaking. If an extension receives a call to onStop and speech is already stopped, it should do nothing (not raise an error). If speech is in the paused state, this should cancel the paused state. */
+ var onStop: chrome.events.Event;
+ /**
+ * Optional: if an engine supports the pause event, it should pause the current utterance being spoken, if any, until it receives a resume event or stop event. Note that a stop event should also clear the paused state.
+ * @since Chrome 29.
+ */
+ var onPause: chrome.events.Event;
+ /**
+ * Optional: if an engine supports the pause event, it should also support the resume event, to continue speaking the current utterance, if any. Note that a stop event should also clear the paused state.
+ * @since Chrome 29.
+ */
+ var onResume: chrome.events.Event;
}
////////////////////
// Types
////////////////////
+/**
+ * The chrome.types API contains type declarations for Chrome.
+ * @since Chrome 13.
+ */
declare module chrome.types {
interface ChromeSettingClearDetails {
+ /**
+ * Optional.
+ * The scope of the ChromeSetting. One of
+ * • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
+ * • regular_only: setting for the regular profile only (not inherited by the incognito profile),
+ * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
+ * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
+ */
scope?: string;
}
interface ChromeSettingSetDetails extends ChromeSettingClearDetails {
+ /**
+ * The value of the setting.
+ * Note that every setting has a specific value type, which is described together with the setting. An extension should not set a value of a different type.
+ */
value: any;
+ /**
+ * Optional.
+ * The scope of the ChromeSetting. One of
+ * • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
+ * • regular_only: setting for the regular profile only (not inherited by the incognito profile),
+ * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
+ * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
+ */
+ scope?: string;
}
interface ChromeSettingGetDetails {
+ /** Optional. Whether to return the value that applies to the incognito session (default false). */
incognito?: boolean;
}
+ /**
+ * @param details Details of the currently effective value.
+ */
type DetailsCallback = (details: ChromeSettingGetResultDetails) => void;
interface ChromeSettingGetResultDetails {
+ /**
+ * One of
+ * • not_controllable: cannot be controlled by any extension
+ * • controlled_by_other_extensions: controlled by extensions with higher precedence
+ * • controllable_by_this_extension: can be controlled by this extension
+ * • controlled_by_this_extension: controlled by this extension
+ */
levelOfControl: string;
+ /** The value of the setting. */
value: any;
+ /**
+ * Optional.
+ * Whether the effective value is specific to the incognito session.
+ * This property will only be present if the incognito property in the details parameter of get() was true.
+ */
incognitoSpecific?: boolean;
}
@@ -2119,404 +7280,951 @@ declare module chrome.types {
addListener(callback: DetailsCallback): void;
}
+ /** An interface that allows access to a Chrome browser setting. See accessibilityFeatures for an example. */
interface ChromeSetting {
- details: {
- scope?: string;
- callback?: Function;
- };
+ /**
+ * Sets the value of a setting.
+ * @param details Which setting to change.
+ * @param callback Optional. Called at the completion of the set operation.
+ */
set(details: ChromeSettingSetDetails, callback?: Function): void;
+ /**
+ * Gets the value of a setting.
+ * @param details Which setting to consider.
+ */
get(details: ChromeSettingGetDetails, callback?: DetailsCallback): void;
+ /**
+ * Clears the setting, restoring any default value.
+ * @param details Which setting to clear.
+ * @param callback Optional. Called at the completion of the clear operation.
+ */
clear(details: ChromeSettingClearDetails, callback?: Function): void;
+ /** Fired after the setting changes. */
onChange: ChromeSettingChangedEvent;
}
}
+////////////////////
+// VPN Provider
+////////////////////
+/**
+ * Use the chrome.vpnProvider API to implement a VPN client.
+ * Permissions: "vpnProvider"
+ * Important: This API works only on Chrome OS.
+ * @since Chrome 43.
+ */
+declare module chrome.vpnProvider {
+ interface VpnSessionParameters {
+ /** IP address for the VPN interface in CIDR notation. IPv4 is currently the only supported mode. */
+ address: string;
+ /** Optional. Broadcast address for the VPN interface. (default: deduced from IP address and mask) */
+ broadcastAddress?: string;
+ /** Optional. MTU setting for the VPN interface. (default: 1500 bytes) */
+ mtu?: string;
+ /**
+ * Exclude network traffic to the list of IP blocks in CIDR notation from the tunnel. This can be used to bypass traffic to and from the VPN server. When many rules match a destination, the rule with the longest matching prefix wins. Entries that correspond to the same CIDR block are treated as duplicates. Such duplicates in the collated (exclusionList + inclusionList) list are eliminated and the exact duplicate entry that will be eliminated is undefined.
+ */
+ exclusionList: string[];
+ /**
+ * Include network traffic to the list of IP blocks in CIDR notation to the tunnel. This parameter can be used to set up a split tunnel. By default no traffic is directed to the tunnel. Adding the entry "0.0.0.0/0" to this list gets all the user traffic redirected to the tunnel. When many rules match a destination, the rule with the longest matching prefix wins. Entries that correspond to the same CIDR block are treated as duplicates. Such duplicates in the collated (exclusionList + inclusionList) list are eliminated and the exact duplicate entry that will be eliminated is undefined.
+ */
+ inclusionList: string[];
+ /** Optional. A list of search domains. (default: no search domain) */
+ domainSearch?: string[];
+ /** A list of IPs for the DNS servers. */
+ dnsServer: string[];
+ }
+
+ interface VpnPlatformMessageEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter id: ID of the configuration the message is intended for.
+ * Parameter message: The message received from the platform.
+ * * connected: VPN configuration connected.
+ * * disconnected: VPN configuration disconnected.
+ * * error: An error occurred in VPN connection, for example a timeout. A description of the error is give as the error argument to onPlatformMessage.
+ * Parameter error: Error message when there is an error.
+ */
+ addListener(callback: (id: string, message: string, error: string) => void): void;
+ }
+
+ interface VpnPacketReceptionEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter data: The IP packet received from the platform.
+ */
+ addListener(callback: (data: ArrayBuffer) => void): void;
+ }
+
+ interface VpnConfigRemovalEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter id: ID of the removed configuration.
+ */
+ addListener(callback: (id: string) => void): void;
+ }
+
+ interface VpnConfigCreationEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter id: ID of the configuration created.
+ * Parameter name: Name of the configuration created.
+ * Parameter data: Configuration data provided by the administrator.
+ */
+ addListener(callback: (id: string, name: string, data: Object) => void): void;
+ }
+
+ interface VpnUiEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter event: The UI event that is triggered.
+ * * showAddDialog: Request the VPN client to show add configuration dialog to the user.
+ * * showConfigureDialog: Request the VPN client to show configuration settings dialog to the user.
+ * Optional parameter id: ID of the configuration for which the UI event was triggered.
+ */
+ addListener(callback: (event: string, id?: string) => void): void;
+ }
+
+ /**
+ * Creates a new VPN configuration that persists across multiple login sessions of the user.
+ * @param name The name of the VPN configuration.
+ * @param callback Called when the configuration is created or if there is an error.
+ * Parameter id: A unique ID for the created configuration, empty string on failure.
+ */
+ export function createConfig(name: string, callback: (id: string) => void): void;
+ /**
+ * Destroys a VPN configuration created by the extension.
+ * @param id ID of the VPN configuration to destroy.
+ * @param callback Optional. Called when the configuration is destroyed or if there is an error.
+ */
+ export function destroyConfig(id: string, callback?: Function): void;
+ /**
+ * Sets the parameters for the VPN session. This should be called immediately after "connected" is received from the platform. This will succeed only when the VPN session is owned by the extension.
+ * @param parameters The parameters for the VPN session.
+ * @param callback Called when the parameters are set or if there is an error.
+ */
+ export function setParameters(parameters: VpnSessionParameters, callback: Function): void;
+ /**
+ * Sends an IP packet through the tunnel created for the VPN session. This will succeed only when the VPN session is owned by the extension.
+ * @param data The IP packet to be sent to the platform.
+ * @param callback Optional. Called when the packet is sent or if there is an error.
+ */
+ export function sendPacket(data: ArrayBuffer, callback?: Function): void;
+ /**
+ * Notifies the VPN session state to the platform. This will succeed only when the VPN session is owned by the extension.
+ * @param state The VPN session state of the VPN client.
+ * connected: VPN connection was successful.
+ * failure: VPN connection failed.
+ * @param callback Optional. Called when the notification is complete or if there is an error.
+ */
+ export function notifyConnectionStateChanged(state: string, callback?: Function): void;
+
+ /** Triggered when a message is received from the platform for a VPN configuration owned by the extension. */
+ var onPlatformMessage: VpnPlatformMessageEvent;
+ /** Triggered when an IP packet is received via the tunnel for the VPN session owned by the extension. */
+ var onPacketReceived: VpnPacketReceptionEvent;
+ /** Triggered when a configuration created by the extension is removed by the platform. */
+ var onConfigRemoved: VpnConfigRemovalEvent;
+ /** Triggered when a configuration is created by the platform for the extension. */
+ var onConfigCreated: VpnConfigCreationEvent;
+ /** Triggered when there is a UI event for the extension. UI events are signals from the platform that indicate to the app that a UI dialog needs to be shown to the user. */
+ var onUIEvent: VpnUiEvent;
+}
+
+////////////////////
+// Wallpaper
+////////////////////
+/**
+ * Use the chrome.wallpaper API to change the ChromeOS wallpaper.
+ * Permissions: "wallpaper"
+ * Important: This API works only on Chrome OS.
+ * @since Chrome 43.
+ */
+declare module chrome.wallpaper {
+ interface WallpaperDetails {
+ /** Optional. The jpeg or png encoded wallpaper image. */
+ data?: any;
+ /** Optional. The URL of the wallpaper to be set. */
+ url?: string;
+ /**
+ * The supported wallpaper layouts.
+ * One of: "STRETCH", "CENTER", or "CENTER_CROPPED"
+ */
+ layout: string;
+ /** The file name of the saved wallpaper. */
+ filename: string;
+ /** Optional. True if a 128x60 thumbnail should be generated. */
+ thumbnail?: boolean;
+ }
+
+ /**
+ * Sets wallpaper to the image at url or wallpaperData with the specified layout
+ * @param callback
+ * Optional parameter thumbnail: The jpeg encoded wallpaper thumbnail. It is generated by resizing the wallpaper to 128x60.
+ */
+ export function setWallpaper(details: WallpaperDetails, callback: (thumbnail: any) => void): void;
+}
+
////////////////////
// Web Navigation
////////////////////
+/**
+ * Use the chrome.webNavigation API to receive notifications about the status of navigation requests in-flight.
+ * Permissions: "webNavigation"
+ * @since Chrome 16.
+ */
declare module chrome.webNavigation {
interface GetFrameDetails {
+ /**
+ * The ID of the process runs the renderer for this tab.
+ * @since Chrome 22.
+ */
processId: number;
+ /** The ID of the tab in which the frame is. */
tabId: number;
+ /** The ID of the frame in the given tab. */
frameId: number;
}
interface GetFrameResultDetails {
+ /** The URL currently associated with this frame, if the frame identified by the frameId existed at one point in the given tab. The fact that an URL is associated with a given frameId does not imply that the corresponding frame still exists. */
url: string;
+ /** True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired. */
errorOccurred: boolean;
+ /** ID of frame that wraps the frame. Set to -1 of no parent frame exists. */
parentFrameId: number;
}
interface GetAllFrameDetails {
+ /** The ID of the tab. */
tabId: number;
}
interface GetAllFrameResultDetails extends GetFrameResultDetails {
+ /** The ID of the process runs the renderer for this tab. */
processId: number;
+ /** The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe. */
frameId: number;
}
- interface CallbackBasicDetails {
+ interface WebNavigationCallbackDetails {
+ /** The ID of the tab in which the navigation is about to occur. */
tabId: number;
+ /** The time when the browser was about to start the navigation, in milliseconds since the epoch. */
timeStamp: number;
}
- interface CallbackDetails extends CallbackBasicDetails {
- processId: number;
+ interface WebNavigationUrlCallbackDetails extends WebNavigationCallbackDetails {
url: string;
- frameId: number;
}
- interface CallbackTransitionDetails extends CallbackDetails {
- transitionType: string;
- transitionQualifiers: string[];
+ interface WebNavigationReplacementCallbackDetails extends WebNavigationCallbackDetails {
+ /** The ID of the tab that was replaced. */
+ replacedTabId: number;
}
- interface ReferenceFragmentUpdatedDetails extends CallbackTransitionDetails {
+ interface WebNavigationFramedCallbackDetails extends WebNavigationUrlCallbackDetails {
+ /** 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique for a given tab and process. */
+ frameId: number;
+ /**
+ * The ID of the process runs the renderer for this tab.
+ * @since Chrome 22.
+ */
+ processId: number;
}
- interface CompletedDetails extends CallbackDetails {
+ interface WebNavigationFramedErrorCallbackDetails extends WebNavigationFramedCallbackDetails {
+ /** The error description. */
+ error: string;
}
- interface HistoryStateUpdatedDetails extends CallbackTransitionDetails {
- }
-
- interface CreatedNavigationTargetDetails extends CallbackBasicDetails {
- url: string;
+ interface WebNavigationSourceCallbackDetails extends WebNavigationUrlCallbackDetails {
+ /** The ID of the tab in which the navigation is triggered. */
sourceTabId: number;
+ /**
+ * The ID of the process runs the renderer for the source tab.
+ * @since Chrome 22.
+ */
sourceProcessId: number;
+ /** The ID of the frame with sourceTabId in which the navigation is triggered. 0 indicates the main frame. */
sourceFrameId: number;
}
- interface TabReplacedDetails extends CallbackBasicDetails {
- replacedTabId: number;
- }
-
- interface BeforeNavigateDetails extends CallbackDetails {
+ interface WebNavigationParentedCallbackDetails extends WebNavigationFramedCallbackDetails {
+ /**
+ * ID of frame that wraps the frame. Set to -1 of no parent frame exists.
+ * @since Chrome 24.
+ */
parentFrameId: number;
}
- interface CommittedDetails extends CallbackTransitionDetails {
+ interface WebNavigationTransitionCallbackDetails extends WebNavigationFramedCallbackDetails {
+ /**
+ * Cause of the navigation.
+ * One of: "link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", or "keyword_generated"
+ */
+ transitionType: string;
+ /**
+ * A list of transition qualifiers.
+ * Each element one of: "client_redirect", "server_redirect", "forward_back", or "from_address_bar"
+ */
+ transitionQualifiers: string[];
}
- interface DomContentLoadedDetails extends CallbackDetails {
- }
-
- interface ErrorOccurredDetails extends CallbackDetails {
- error: string;
- }
-
- interface WebNavigationEventFilters {
+ interface WebNavigationEventFilter {
+ /** Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event. */
url: chrome.events.UrlFilter[];
}
- interface WebNavigationReferenceFragmentUpdatedEvent extends chrome.events.Event {
- addListener(callback: (details: ReferenceFragmentUpdatedDetails) => void, filters?: WebNavigationEventFilters): void;
+ interface WebNavigationEvent extends chrome.events.Event {
+ addListener(callback: (details: WebNavigationCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
- interface WebNavigationCompletedEvent extends chrome.events.Event {
- addListener(callback: (details: CompletedDetails) => void, filters?: WebNavigationEventFilters): void;
+ interface WebNavigationFramedEvent extends WebNavigationEvent {
+ addListener(callback: (details: WebNavigationFramedCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
- interface WebNavigationHistoryStateUpdatedEvent extends chrome.events.Event {
- addListener(callback: (details: HistoryStateUpdatedDetails) => void, filters?: WebNavigationEventFilters): void;
+ interface WebNavigationFramedErrorEvent extends WebNavigationFramedEvent {
+ addListener(callback: (details: WebNavigationFramedErrorCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
- interface WebNavigationCreatedNavigationTargetEvent extends chrome.events.Event {
- addListener(callback: (details: CreatedNavigationTargetDetails) => void, filters?: WebNavigationEventFilters): void;
+ interface WebNavigationSourceEvent extends WebNavigationEvent {
+ addListener(callback: (details: WebNavigationSourceCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
- interface WebNavigationTabReplacedEvent extends chrome.events.Event {
- addListener(callback: (details: TabReplacedDetails) => void): void;
+ interface WebNavigationParentedEvent extends WebNavigationEvent {
+ addListener(callback: (details: WebNavigationParentedCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
- interface WebNavigationBeforeNavigateEvent extends chrome.events.Event {
- addListener(callback: (details: BeforeNavigateDetails) => void, filters?: WebNavigationEventFilters): void;
+ interface WebNavigationTransitionalEvent extends WebNavigationEvent {
+ addListener(callback: (details: WebNavigationTransitionCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
- interface WebNavigationCommittedEvent extends chrome.events.Event {
- addListener(callback: (details: CommittedDetails) => void, filters?: WebNavigationEventFilters): void;
- }
-
- interface WebNavigationDomContentLoadedEvent extends chrome.events.Event {
- addListener(callback: (details: DomContentLoadedDetails) => void, filters?: WebNavigationEventFilters): void;
- }
-
- interface WebNavigationErrorOccurredEvent extends chrome.events.Event {
- addListener(callback: (details: ErrorOccurredDetails) => void, filters?: WebNavigationEventFilters): void;
+ interface WebNavigationReplacementEvent extends WebNavigationEvent {
+ addListener(callback: (details: WebNavigationReplacementCallbackDetails, filters?: WebNavigationEventFilter) => void): void;
}
+ /**
+ * Retrieves information about the given frame. A frame refers to an <iframe> or a <frame> of a web page and is identified by a tab ID and a frame ID.
+ * @param details Information about the frame to retrieve information about.
+ * @param callback
+ * Optional parameter details: Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.
+ */
export function getFrame(details: GetFrameDetails, callback: (details?: GetFrameResultDetails) => void): void;
+ /**
+ * Retrieves information about all frames of a given tab.
+ * @param details Information about the tab to retrieve all frames from.
+ * @param callback
+ * Optional parameter details: A list of frames in the given tab, null if the specified tab ID is invalid.
+ */
export function getAllFrames(details: GetAllFrameDetails, callback: (details?: GetAllFrameResultDetails[]) => void): void;
- var onReferenceFragmentUpdated: WebNavigationReferenceFragmentUpdatedEvent;
- var onCompleted: WebNavigationCompletedEvent;
- var onHistoryStateUpdated: WebNavigationHistoryStateUpdatedEvent;
- var onCreatedNavigationTarget: WebNavigationCreatedNavigationTargetEvent;
- var onTabReplaced: WebNavigationTabReplacedEvent;
- var onBeforeNavigate: WebNavigationBeforeNavigateEvent;
- var onCommitted: WebNavigationCommittedEvent;
- var onDOMContentLoaded: WebNavigationDomContentLoadedEvent;
- var onErrorOccurred: WebNavigationErrorOccurredEvent;
+ /** Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL. */
+ var onReferenceFragmentUpdated: WebNavigationTransitionalEvent;
+ /** Fired when a document, including the resources it refers to, is completely loaded and initialized. */
+ var onCompleted: WebNavigationFramedEvent;
+ /**
+ * Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.
+ * @since Chrome 22.
+ */
+ var onHistoryStateUpdated: WebNavigationTransitionalEvent;
+ /** Fired when a new window, or a new tab in an existing window, is created to host a navigation. */
+ var onCreatedNavigationTarget: WebNavigationSourceEvent;
+ /**
+ * Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.
+ * @since Chrome 22.
+ */
+ var onTabReplaced: WebNavigationReplacementEvent;
+ /** Fired when a navigation is about to occur. */
+ var onBeforeNavigate: WebNavigationParentedEvent;
+ /** Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the browser has decided to switch to the new document. */
+ var onCommitted: WebNavigationTransitionalEvent;
+ /** Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading. */
+ var onDOMContentLoaded: WebNavigationFramedEvent;
+ /** Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation. */
+ var onErrorOccurred: WebNavigationFramedErrorEvent;
}
////////////////////
// Web Request
////////////////////
+/**
+ * Use the chrome.webRequest API to observe and analyze traffic and to intercept, block, or modify requests in-flight.
+ * Permissions: "webRequest", host permissions
+ * @since Chrome 17.
+ */
declare module chrome.webRequest {
interface AuthCredentials {
username: string;
password: string;
}
+ /** An HTTP Header, represented as an object containing a key and either a value or a binaryValue. */
interface HttpHeader {
name: string;
value?: string;
binaryValue?: ArrayBuffer;
}
+ /** Returns value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests. */
interface BlockingResponse {
+ /** Optional. If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent. */
cancel?: boolean;
+ /**
+ * Optional.
+ * Only used as a response to the onBeforeRequest and onHeadersReceived events. If set, the original request is prevented from being sent/completed and is instead redirected to the given URL. Redirections to non-HTTP schemes such as data: are allowed. Redirects initiated by a redirect action use the original request method for the redirect, with one exception: If the redirect is initiated at the onHeadersReceived stage, then the redirect will be issued using the GET method.
+ */
redirectUrl?: string;
+ /**
+ * Optional.
+ * Only used as a response to the onHeadersReceived event. If set, the server is assumed to have responded with these response headers instead. Only return responseHeaders if you really want to modify the headers in order to limit the number of conflicts (only one extension may modify responseHeaders for each request).
+ */
responseHeaders?: HttpHeader[];
+ /** Optional. Only used as a response to the onAuthRequired event. If set, the request is made using the supplied credentials. */
authCredentials?: AuthCredentials;
+ /**
+ * Optional.
+ * Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead.
+ */
requestHeaders?: HttpHeader[];
}
+ /** An object describing filters to apply to webRequest events. */
interface RequestFilter {
+ /** Optional. */
tabId?: number;
+ /**
+ * A list of request types. Requests that cannot match any of the types will be filtered out.
+ * Each element one of: "main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", or "other"
+ */
types?: string[];
+ /** A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out. */
urls: string[];
+ /** Optional. */
windowId?: number;
}
+ /**
+ * Contains data uploaded in a URL request.
+ * @since Chrome 23.
+ */
interface UploadData {
+ /** Optional. An ArrayBuffer with a copy of the data. */
bytes?: ArrayBuffer;
+ /** Optional. A string with the file's path and name. */
file?: string;
}
- interface CallbackDetails {
+ interface WebRequestBody {
+ /** Optional. Errors when obtaining request body data. */
+ error?: string;
+ /**
+ * Optional.
+ * If the request method is POST and the body is a sequence of key-value pairs encoded in UTF8, encoded as either multipart/form-data, or application/x-www-form-urlencoded, this dictionary is present and for each key contains the list of all values for that key. If the data is of another media type, or if it is malformed, the dictionary is not present. An example value of this dictionary is {'key': ['value1', 'value2']}.
+ */
+ formData?: Object;
+ /**
+ * Optional.
+ * If the request method is PUT or POST, and the body is not already parsed in formData, then the unparsed request body elements are contained in this array.
+ */
+ raw?: UploadData[];
+ }
+
+ interface WebAuthChallenger {
+ host: string;
+ port: number;
+ }
+
+ interface ResourceRequest {
+ /** The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request. */
requestId: string;
- url: string;
- method: string;
- tabId: number;
+ /** The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (type is main_frame or sub_frame), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab. */
frameId: number;
+ /** ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists. */
parentFrameId: number;
- timeStamp: number;
+ /** The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab. */
+ tabId: number;
+ /**
+ * How the requested resource will be used.
+ * One of: "main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", or "other"
+ */
type: string;
+ /** The time when this signal is triggered, in milliseconds since the epoch. */
+ timeStamp: number;
}
- interface OnCompletedDetails extends CallbackDetails {
+ interface WebRequestDetails extends ResourceRequest {
+ url: string;
+ /** Standard HTTP method. */
+ method: string;
+ }
+
+ interface WebRequestHeadersDetails extends WebRequestDetails {
+ /** Optional. The HTTP request headers that are going to be sent out with this request. */
+ requestHeaders?: HttpHeader[];
+ }
+
+ interface WebRequestBodyDetails extends WebRequestDetails {
+ /**
+ * Contains the HTTP request body data. Only provided if extraInfoSpec contains 'requestBody'.
+ * @since Chrome 23.
+ */
+ requestBody: WebRequestBody;
+ }
+
+ interface WebRequestFullDetails extends WebRequestHeadersDetails, WebRequestBodyDetails {
+ }
+
+ interface WebResponseDetails extends ResourceRequest {
+ /** HTTP status line of the response or the 'HTTP/0.9 200 OK' string for HTTP/0.9 responses (i.e., responses that lack a status line). */
+ statusLine: string;
+ /**
+ * Standard HTTP status code returned by the server.
+ * @since Chrome 43.
+ */
+ statusCode: number;
+ }
+
+ interface WebResponseHeadersDetails extends WebResponseDetails {
+ /** Optional. The HTTP response headers that have been received with this response. */
+ responseHeaders?: HttpHeader[];
+ }
+
+ interface WebResponseCacheDetails extends WebResponseHeadersDetails {
+ /**
+ * Optional.
+ * The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.
+ */
ip?: string;
- statusLine: string;
- responseHeaders?: HttpHeader[];
+ /** Indicates if this response was fetched from disk cache. */
fromCache: boolean;
- statusCode: number;
}
- interface OnHeadersReceivedDetails extends CallbackDetails {
- statusLine: string;
- responseHeaders?: HttpHeader[];
+ interface WebRedirectionResponseDetails extends WebResponseCacheDetails {
+ /** The new URL. */
+ redirectUrl: string;
}
- interface OnBeforeRedirectDetails extends CallbackDetails {
- ip?: string;
- statusLine: string;
- responseHeaders?: HttpHeader[];
- fromCache: boolean;
- redirectUrl: string;
- statusCode: number;
+ interface WebAuthenticationChallengeDetails extends WebResponseHeadersDetails {
+ /** The authentication scheme, e.g. Basic or Digest. */
+ schema: string;
+ /** The authentication realm provided by the server, if there is one. */
+ realm?: string;
+ /** The server requesting authentication. */
+ challenger: WebAuthChallenger;
+ /** True for Proxy-Authenticate, false for WWW-Authenticate. */
+ isProxy: boolean;
}
- interface Challenger {
- host: string;
- port: number;
+ interface WebResponseErrorDetails extends WebResponseCacheDetails {
+ /** The error description. This string is not guaranteed to remain backwards compatible between releases. You must not parse and act based upon its content. */
+ error: string;
}
- interface OnAuthRequiredDetails extends CallbackDetails {
- statusLine: string;
- challenger: Challenger;
- responseHeaders?: HttpHeader[];
- isProxy: boolean;
- realm?: string;
- scheme: string;
+ interface WebRequestBodyEvent extends chrome.events.Event {
+ addListener(callback: (details: WebRequestBodyDetails) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
}
- interface OnBeforeSendHeadersDetails extends CallbackDetails {
- requestHeaders?: HttpHeader[];
+ interface WebRequestHeadersEvent extends chrome.events.Event {
+ addListener(callback: (details: WebRequestHeadersDetails) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
}
- interface OnErrorOccurredDetails extends CallbackDetails {
- ip?: string;
- fromCache: boolean;
- error: string;
+ interface WebResponseHeadersEvent extends chrome.events.Event {
+ addListener(callback: (details: WebResponseHeadersDetails) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
}
- interface OnResponseStartedDetails extends CallbackDetails {
- ip?: string;
- statusLine: string;
- responseHeaders?: HttpHeader[];
- fromCache: boolean;
- statusCode: number;
+ interface WebResponseCacheEvent extends WebResponseHeadersEvent {
+ addListener(callback: (details: WebResponseCacheDetails) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
}
- interface OnSendHeadersDetails extends CallbackDetails {
- requestHeaders?: HttpHeader[];
+ interface WebRedirectionResponseEvent extends WebResponseCacheEvent {
+ addListener(callback: (details: WebRedirectionResponseDetails) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
}
- interface FormData {
- [key: string]: string[];
+ interface WebAuthenticationChallengeEvent extends chrome.events.Event {
+ addListener(callback: (details: WebAuthenticationChallengeDetails, callback?: (response: BlockingResponse) => void) => void): void;
}
- interface RequestBody {
- raw?: UploadData[];
- error?: string;
- formData?: FormData;
- }
-
- interface OnBeforeRequestDetails extends CallbackDetails {
- requestBody?: RequestBody;
- }
-
- interface WebRequestCompletedEvent extends chrome.events.Event {
- addListener(callback: (details: OnCompletedDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnCompletedDetails) => BlockingResponse): void;
- }
-
- interface WebRequestHeadersReceivedEvent extends chrome.events.Event {
- addListener(callback: (details: OnHeadersReceivedDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnHeadersReceivedDetails) => BlockingResponse): void;
- }
-
- interface WebRequestBeforeRedirectEvent extends chrome.events.Event {
- addListener(callback: (details: OnBeforeRedirectDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnBeforeRedirectDetails) => BlockingResponse): void;
- }
-
- interface WebRequestAuthRequiredEvent extends chrome.events.Event {
- addListener(callback: (details: OnAuthRequiredDetails, callback?: (response: BlockingResponse) => void) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnAuthRequiredDetails, callback?: (response: BlockingResponse) => void) => void): void;
- }
-
- interface WebRequestBeforeSendHeadersEvent extends chrome.events.Event {
- addListener(callback: (details: OnBeforeSendHeadersDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnBeforeSendHeadersDetails) => BlockingResponse): void;
- }
-
- interface WebRequestErrorOccurredEvent extends chrome.events.Event {
- addListener(callback: (details: OnErrorOccurredDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnErrorOccurredDetails) => BlockingResponse): void;
- }
-
- interface WebRequestResponseStartedEvent extends chrome.events.Event {
- addListener(callback: (details: OnResponseStartedDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnResponseStartedDetails) => BlockingResponse): void;
- }
-
- interface WebRequestSendHeadersEvent extends chrome.events.Event {
- addListener(callback: (details: OnSendHeadersDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnSendHeadersDetails) => BlockingResponse): void;
- }
-
- interface WebRequestBeforeRequestEvent extends chrome.events.Event {
- addListener(callback: (details: OnBeforeRequestDetails) => BlockingResponse, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
- removeListener(callback: (details: OnBeforeRequestDetails) => BlockingResponse): void;
+ interface WebResponseErrorEvent extends WebResponseCacheEvent {
+ addListener(callback: (details: WebResponseErrorDetails) => void, filter?: RequestFilter, opt_extraInfoSpec?: string[]): void;
}
+ /**
+ * The maximum number of times that handlerBehaviorChanged can be called per 10 minute sustained interval. handlerBehaviorChanged is an expensive function call that shouldn't be called often.
+ * @since Chrome 23.
+ */
var MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES: number;
+ /** Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often. */
export function handlerBehaviorChanged(callback?: Function): void;
- var onCompleted: WebRequestCompletedEvent;
- var onHeadersReceived: WebRequestHeadersReceivedEvent;
- var onBeforeRedirect: WebRequestBeforeRedirectEvent;
- var onAuthRequired: WebRequestAuthRequiredEvent;
- var onBeforeSendHeaders: WebRequestBeforeSendHeadersEvent;
- var onErrorOccurred: WebRequestErrorOccurredEvent;
- var onResponseStarted: WebRequestResponseStartedEvent;
- var onSendHeaders: WebRequestSendHeadersEvent;
- var onBeforeRequest: WebRequestBeforeRequestEvent;
+ /** Fired when a request is about to occur. */
+ var onBeforeRequest: WebRequestBodyEvent;
+ /** Fired before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent. */
+ var onBeforeSendHeaders: WebRequestHeadersEvent;
+ /** Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired). */
+ var onSendHeaders: WebRequestHeadersEvent;
+ /** Fired when HTTP response headers of a request have been received. */
+ var onHeadersReceived: WebResponseHeadersEvent;
+ /** Fired when an authentication failure is received. The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. If bad user credentials are provided, this may be called multiple times for the same request. */
+ var onAuthRequired: WebAuthenticationChallengeEvent;
+ /** Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available. */
+ var onResponseStarted: WebResponseCacheEvent;
+ /** Fired when a server-initiated redirect is about to occur. */
+ var onBeforeRedirect: WebRedirectionResponseEvent;
+ /** Fired when a request is completed. */
+ var onCompleted: WebResponseCacheEvent;
+ /** Fired when an error occurs. */
+ var onErrorOccurred: WebResponseErrorEvent;
}
////////////////////
// Web Store
////////////////////
+/**
+ * Use the chrome.webstore API to initiate app and extension installations "inline" from your site.
+ * @since Chrome 15.
+ */
declare module chrome.webstore {
- export function install(url?: string, successCallback?: Function, failureCallback?: (error: string) => void): void;
+ /**
+ * @param url Optional. If you have more than one <link> tag on your page with the chrome-webstore-item relation, you can choose which item you'd like to install by passing in its URL here. If it is omitted, then the first (or only) link will be used. An exception will be thrown if the passed in URL does not exist on the page.
+ * @param successCallback Optional. This function is invoked when inline installation successfully completes (after the dialog is shown and the user agrees to add the item to Chrome). You may wish to use this to hide the user interface element that prompted the user to install the app or extension.
+ * @param failureCallback Optional. This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site.
+ * Parameter error: The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back.
+ * Optional parameter errorCode: The error code from the stable set of possible errors.
+ * * Enum of the possible install results, including error codes sent back in the event that an inline installation has failed.
+ * * * "otherError": An uncommon, unrecognized, or unexpected error. In some cases, the readable error string can provide more information.
+ * * * "aborted": The operation was aborted as the requestor is no longer alive.
+ * * * "installInProgress": An installation of the same extension is in progress.
+ * * * "notPermitted": The installation is not permitted.
+ * * * "invalidId": Invalid Chrome Web Store item ID.
+ * * * "webstoreRequestError": Failed to retrieve extension metadata from the Web Store.
+ * * * "invalidWebstoreResponse": The extension metadata retrieved from the Web Store was invalid.
+ * * * "invalidManifest": An error occurred while parsing the extension manifest retrieved from the Web Store.
+ * * * "iconError": Failed to retrieve the extension's icon from the Web Store, or the icon was invalid.
+ * * * "userCanceled": The user canceled the operation.
+ * * * "blacklisted": The extension is blacklisted.
+ * * * "missingDependencies": Unsatisfied dependencies, such as shared modules.
+ * * * "requirementViolations": Unsatisfied requirements, such as webgl.
+ * * * "blockedByPolicy": The extension is blocked by management policies.
+ * * * "launchFeatureDisabled": The launch feature is not available.
+ * * * "launchUnsupportedExtensionType": The launch feature is not supported for the extension type.
+ * * * "launchInProgress": A launch of the same extension is in progress.
+ */
+ export function install(url: string, successCallback?: Function, failureCallback?: (error: string, errorCode?: string) => void): void;
+ /**
+ * @param successCallback Optional. This function is invoked when inline installation successfully completes (after the dialog is shown and the user agrees to add the item to Chrome). You may wish to use this to hide the user interface element that prompted the user to install the app or extension.
+ * @param failureCallback Optional. This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site.
+ * Parameter error: The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back.
+ * Optional parameter errorCode: The error code from the stable set of possible errors.
+ * * Enum of the possible install results, including error codes sent back in the event that an inline installation has failed.
+ * * * "otherError": An uncommon, unrecognized, or unexpected error. In some cases, the readable error string can provide more information.
+ * * * "aborted": The operation was aborted as the requestor is no longer alive.
+ * * * "installInProgress": An installation of the same extension is in progress.
+ * * * "notPermitted": The installation is not permitted.
+ * * * "invalidId": Invalid Chrome Web Store item ID.
+ * * * "webstoreRequestError": Failed to retrieve extension metadata from the Web Store.
+ * * * "invalidWebstoreResponse": The extension metadata retrieved from the Web Store was invalid.
+ * * * "invalidManifest": An error occurred while parsing the extension manifest retrieved from the Web Store.
+ * * * "iconError": Failed to retrieve the extension's icon from the Web Store, or the icon was invalid.
+ * * * "userCanceled": The user canceled the operation.
+ * * * "blacklisted": The extension is blacklisted.
+ * * * "missingDependencies": Unsatisfied dependencies, such as shared modules.
+ * * * "requirementViolations": Unsatisfied requirements, such as webgl.
+ * * * "blockedByPolicy": The extension is blocked by management policies.
+ * * * "launchFeatureDisabled": The launch feature is not available.
+ * * * "launchUnsupportedExtensionType": The launch feature is not supported for the extension type.
+ * * * "launchInProgress": A launch of the same extension is in progress.
+ */
+ export function install(successCallback: Function, failureCallback?: (error: string, errorCode?: string) => void): void;
+ /**
+ * @param failureCallback Optional. This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site.
+ * Parameter error: The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back.
+ * Optional parameter errorCode: The error code from the stable set of possible errors.
+ * * Enum of the possible install results, including error codes sent back in the event that an inline installation has failed.
+ * * * "otherError": An uncommon, unrecognized, or unexpected error. In some cases, the readable error string can provide more information.
+ * * * "aborted": The operation was aborted as the requestor is no longer alive.
+ * * * "installInProgress": An installation of the same extension is in progress.
+ * * * "notPermitted": The installation is not permitted.
+ * * * "invalidId": Invalid Chrome Web Store item ID.
+ * * * "webstoreRequestError": Failed to retrieve extension metadata from the Web Store.
+ * * * "invalidWebstoreResponse": The extension metadata retrieved from the Web Store was invalid.
+ * * * "invalidManifest": An error occurred while parsing the extension manifest retrieved from the Web Store.
+ * * * "iconError": Failed to retrieve the extension's icon from the Web Store, or the icon was invalid.
+ * * * "userCanceled": The user canceled the operation.
+ * * * "blacklisted": The extension is blacklisted.
+ * * * "missingDependencies": Unsatisfied dependencies, such as shared modules.
+ * * * "requirementViolations": Unsatisfied requirements, such as webgl.
+ * * * "blockedByPolicy": The extension is blocked by management policies.
+ * * * "launchFeatureDisabled": The launch feature is not available.
+ * * * "launchUnsupportedExtensionType": The launch feature is not supported for the extension type.
+ * * * "launchInProgress": A launch of the same extension is in progress.
+ */
+ export function install(failureCallback?: (error: string, errorCode?: string) => void): void;
+
+ interface InstallationStageEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter stage: The InstallStage that just began.
+ * * One of: "installing", or "downloading"
+ */
+ addListener(callback: (stage: string) => void): void;
+ }
+
+ interface DownloadProgressEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter percentDownloaded: The progress of the download, between 0 and 1. 0 indicates no progress; 1.0 indicates complete.
+ */
+ addListener(callback: (percentDownloaded: number) => void): void;
+ }
+
+ /**
+ * Fired when an inline installation enters a new InstallStage. In order to receive notifications about this event, listeners must be registered before the inline installation begins.
+ * @since Chrome 35.
+ */
+ var onInstallStageChanged: InstallationStageEvent;
+ /**
+ * Fired periodically with the download progress of an inline install. In order to receive notifications about this event, listeners must be registered before the inline installation begins.
+ * @since Chrome 35.
+ */
+ var onDownloadProgress: DownloadProgressEvent;
}
////////////////////
// Windows
////////////////////
+/**
+ * Use the chrome.windows API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser.
+ * Permissions: The chrome.windows API can be used without declaring any permission. However, the "tabs" permission is required in order to populate the url, title, and favIconUrl properties of Tab objects.
+ * @since Chrome 5.
+ */
declare module chrome.windows {
interface Window {
+ /** Array of tabs.Tab objects representing the current tabs in the window. */
tabs?: chrome.tabs.Tab[];
- top: number;
- height: number;
- width: number;
+ /** Optional. The offset of the window from the top edge of the screen in pixels. Under some circumstances a Window may not be assigned top property, for example when querying closed windows from the sessions API. */
+ top?: number;
+ /** Optional. The height of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned height property, for example when querying closed windows from the sessions API. */
+ height?: number;
+ /** Optional. The width of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned width property, for example when querying closed windows from the sessions API. */
+ width?: number;
+ /**
+ * The state of this browser window.
+ * One of: "normal", "minimized", "maximized", "fullscreen", or "docked"
+ * @since Chrome 17.
+ */
state: string;
+ /** Whether the window is currently the focused window. */
focused: boolean;
+ /**
+ * Whether the window is set to be always on top.
+ * @since Chrome 19.
+ */
alwaysOnTop: boolean;
+ /** Whether the window is incognito. */
incognito: boolean;
+ /**
+ * The type of browser window this is.
+ * One of: "normal", "popup", "panel", "app", or "devtools"
+ */
type: string;
+ /** Optional. The ID of the window. Window IDs are unique within a browser session. Under some circumstances a Window may not be assigned an ID, for example when querying windows using the sessions API, in which case a session ID may be present. */
id: number;
- left: number;
+ /** Optional. The offset of the window from the left edge of the screen in pixels. Under some circumstances a Window may not be assigned left property, for example when querying closed windows from the sessions API. */
+ left?: number;
+ /**
+ * The session ID used to uniquely identify a Window obtained from the sessions API.
+ * @since Chrome 31.
+ */
+ sessionId?: string;
}
interface GetInfo {
+ /**
+ * Optional.
+ * If true, the windows.Window object will have a tabs property that contains a list of the tabs.Tab objects. The Tab objects only contain the url, title and favIconUrl properties if the extension's manifest file includes the "tabs" permission.
+ */
populate?: boolean;
+ /**
+ * If set, the windows.Window returned will be filtered based on its type. If unset the default filter is set to ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.
+ * Each one of: "normal", "popup", "panel", "app", or "devtools"
+ * @since Chrome 46. Warning: this is the current Beta channel.
+ */
+ windowTypes?: string[];
}
interface CreateData {
+ /**
+ * Optional. The id of the tab for which you want to adopt to the new window.
+ * @since Chrome 10.
+ */
tabId?: number;
- url?: string;
+ /**
+ * Optional.
+ * A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.
+ */
+ url?: string | string[];
+ /**
+ * Optional.
+ * The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels.
+ */
top?: number;
+ /**
+ * Optional.
+ * The height in pixels of the new window, including the frame. If not specified defaults to a natural height.
+ */
height?: number;
+ /**
+ * Optional.
+ * The width in pixels of the new window, including the frame. If not specified defaults to a natural width.
+ */
width?: number;
+ /**
+ * Optional. If true, opens an active window. If false, opens an inactive window.
+ * @since Chrome 12.
+ */
focused?: boolean;
+ /** Optional. Whether the new window should be an incognito window. */
incognito?: boolean;
+ /**
+ * Optional. Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the '--enable-panels' flag is set.
+ * One of: "normal", "popup", "panel", or "detached_panel"
+ */
type?: string;
+ /**
+ * Optional.
+ * The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels.
+ */
left?: number;
+ /**
+ * Optional. The initial state of the window. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'.
+ * One of: "normal", "minimized", "maximized", "fullscreen", or "docked"
+ * @since Chrome 44.
+ */
+ state?: string;
}
interface UpdateInfo {
+ /** Optional. The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels. */
top?: number;
+ /**
+ * Optional. If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous draw attention request.
+ * @since Chrome 14.
+ */
drawAttention?: boolean;
+ /** Optional. The height to resize the window to in pixels. This value is ignored for panels. */
height?: number;
+ /** Optional. The width to resize the window to in pixels. This value is ignored for panels. */
width?: number;
+ /**
+ * Optional. The new state of the window. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top', 'width' or 'height'.
+ * One of: "normal", "minimized", "maximized", "fullscreen", or "docked"
+ * @since Chrome 17.
+ */
state?: string;
+ /**
+ * Optional. If true, brings the window to the front. If false, brings the next window in the z-order to the front.
+ * @since Chrome 8.
+ */
focused?: boolean;
+ /** Optional. The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels. */
left?: number;
}
- interface WindowRemovedEvent extends chrome.events.Event {
- addListener(callback: (windowId: number) => void): void;
+ interface WindowEventFilter {
+ /**
+ * Conditions that the window's type being created must satisfy. By default it will satisfy ['app', 'normal', 'panel', 'popup'], with 'app' and 'panel' window types limited to the extension's own windows.
+ * Each one of: "normal", "popup", "panel", "app", or "devtools"
+ */
+ windowTypes: string[];
}
- interface WindowCreatedEvent extends chrome.events.Event {
- addListener(callback: (window: Window) => void): void;
+ interface WindowIdEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter windowId: The id of the window associated with this event.
+ */
+ addListener(callback: (windowId: number, filters?: WindowEventFilter) => void): void;
}
- interface WindowFocusChangedEvent extends chrome.events.Event {
- addListener(callback: (windowId: number) => void): void;
+ interface WindowReferenceEvent extends chrome.events.Event {
+ /**
+ * @param callback
+ * Parameter window: The window object associated with this event.
+ */
+ addListener(callback: (window: Window, filters?: WindowEventFilter) => void): void;
}
+ /**
+ * The windowId value that represents the current window.
+ * @since Chrome 18.
+ */
var WINDOW_ID_CURRENT: number;
+ /**
+ * The windowId value that represents the absence of a chrome browser window.
+ * @since Chrome 6.
+ */
var WINDOW_ID_NONE: number;
+ /** Gets details about a window. */
export function get(windowId: number, callback: (window: chrome.windows.Window) => void): void;
+ /**
+ * Gets details about a window.
+ * @since Chrome 18.
+ */
export function get(windowId: number, getInfo: GetInfo, callback: (window: chrome.windows.Window) => void): void;
+ /**
+ * Gets the current window.
+ */
export function getCurrent(callback: (window: chrome.windows.Window) => void): void;
+ /**
+ * Gets the current window.
+ * @since Chrome 18.
+ */
export function getCurrent(getInfo: GetInfo, callback: (window: chrome.windows.Window) => void): void;
- export function create(createData?: CreateData, callback?: (window: chrome.windows.Window) => void): void;
+ /**
+ * Creates (opens) a new browser with any optional sizing, position or default URL provided.
+ * @param callback
+ * Optional parameter window: Contains details about the created window.
+ */
+ export function create(callback?: (window?: chrome.windows.Window) => void): void;
+ /**
+ * Creates (opens) a new browser with any optional sizing, position or default URL provided.
+ * @param callback
+ * Optional parameter window: Contains details about the created window.
+ */
+ export function create(createData: CreateData, callback?: (window?: chrome.windows.Window) => void): void;
+ /**
+ * Gets all windows.
+ */
export function getAll(callback: (windows: chrome.windows.Window[]) => void): void;
+ /**
+ * Gets all windows.
+ * @since Chrome 18.
+ */
export function getAll(getInfo: GetInfo, callback: (windows: chrome.windows.Window[]) => void): void;
+ /** Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be left unchanged. */
export function update(windowId: number, updateInfo: UpdateInfo, callback?: (window: chrome.windows.Window) => void): void;
+ /** Removes (closes) a window, and all the tabs inside it. */
export function remove(windowId: number, callback?: Function): void;
+ /**
+ * Gets the window that was most recently focused — typically the window 'on top'.
+ */
export function getLastFocused(callback: (window: chrome.windows.Window) => void): void;
+ /**
+ * Gets the window that was most recently focused — typically the window 'on top'.
+ * @since Chrome 18.
+ */
export function getLastFocused(getInfo: GetInfo, callback: (window: chrome.windows.Window) => void): void;
- var onRemoved: WindowRemovedEvent;
- var onCreated: WindowCreatedEvent;
- var onFocusChanged: WindowFocusChangedEvent;
+ /** Fired when a window is removed (closed). */
+ var onRemoved: WindowIdEvent;
+ /** Fired when a window is created. */
+ var onCreated: WindowReferenceEvent;
+ /**
+ * Fired when the currently focused window changes. Will be chrome.windows.WINDOW_ID_NONE if all chrome windows have lost focus.
+ * Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one chrome window to another.
+ */
+ var onFocusChanged: WindowIdEvent;
}
diff --git a/ckeditor/ckeditor.d.ts b/ckeditor/ckeditor.d.ts
index a8f2680742..cab51f72c0 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 0000000000..e0bd650a36
--- /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 0000000000..0d1aba7416
--- /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/commander/commander.d.ts b/commander/commander.d.ts
index 278a491a62..cf04591bb0 100644
--- a/commander/commander.d.ts
+++ b/commander/commander.d.ts
@@ -155,7 +155,7 @@ declare module commander {
* @return {Command} for chaining
* @api public
*/
- option(flags:string, description?:string, fn?:(arg1:any, arg2:any)=>void, defaultValue?:any):ICommand;
+ option(flags:string, description?:string, fn?:((arg1:any, arg2:any)=>void)|RegExp, defaultValue?:any):ICommand;
option(flags:string, description?:string, defaultValue?:any):ICommand;
/**
diff --git a/connect-livereload/connect-livereload-tests.ts b/connect-livereload/connect-livereload-tests.ts
new file mode 100644
index 0000000000..2609871e98
--- /dev/null
+++ b/connect-livereload/connect-livereload-tests.ts
@@ -0,0 +1,69 @@
+/// <reference path="./connect-livereload.d.ts" />
+
+import * as connect from "connect";
+import * as livereload from "connect-livereload";
+
+const app = connect();
+
+// With no options
+app.use(livereload());
+
+// With string options
+app.use(livereload({
+ port: 35729,
+ ignore: [".js", ".svg"]
+}));
+
+// With RegExp options
+app.use(livereload({
+ port: 35729,
+ ignore: [/\.js(\?.*)?$/, /\.css(\?.*)?$/]
+}));
+
+// With default options
+app.use(livereload({
+ ignore: [
+ /\.js(\?.*)?$/, /\.css(\?.*)?$/, /\.svg(\?.*)?$/, /\.ico(\?.*)?$/, /\.woff(\?.*)?$/,
+ /\.png(\?.*)?$/, /\.jpg(\?.*)?$/, /\.jpeg(\?.*)?$/, /\.gif(\?.*)?$/, /\.pdf(\?.*)?$/
+ ],
+
+ // include all urls by default
+ include: [/.*/],
+
+ // this function is used to determine if the content of `res.write` or `res.end` is html.
+ html: function (str) {
+ if (!str) return false;
+ return /<[:_-\w\s\!\/\=\"\']+>/i.test(str);
+ },
+
+ // rules are provided to find the place where the snippet should be inserted.
+ // the main problem is that on the server side it can be tricky to determine if a string will be valid html on the client.
+ // the function `fn` of the first `match` is executed like this `body.replace(rule.match, rule.fn);`
+ // the function `fn` has got the arguments `fn(w, s)` where `w` is the matches string and `s` is the snippet.
+ rules: [{
+ match: /<\/body>(?![\s\S]*<\/body>)/i,
+ fn: prepend
+ }, {
+ match: /<\/html>(?![\s\S]*<\/html>)/i,
+ fn: prepend
+ }, {
+ match: /<\!DOCTYPE.+?>/i,
+ fn: append
+ }],
+
+ // port where the script is loaded
+ port: 35729,
+
+ // location where the script is provided (not by connect-livereload). Change this e.g. when serving livereload with a proxy.
+ src: "http://localhost:35729/livereload.js?snipver=1",
+
+ // Set this option to `true` to set `req.headers['accept-encoding']` to 'identity' (disabling compression)
+ disableCompression: false
+}));
+
+function prepend(w: string, s: string): string {
+ return s + w;
+}
+function append(w: string, s: string): string {
+ return w + s;
+}
\ No newline at end of file
diff --git a/connect-livereload/connect-livereload.d.ts b/connect-livereload/connect-livereload.d.ts
new file mode 100644
index 0000000000..98e851fec6
--- /dev/null
+++ b/connect-livereload/connect-livereload.d.ts
@@ -0,0 +1,38 @@
+// Type definitions for connect-livereload v0.5.3
+// Project: https://github.com/intesso/connect-livereload
+// Definitions by: Maxime LUCE <https://github.com/SomaticIT/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../connect/connect.d.ts" />
+
+declare module "connect-livereload" {
+ import { HandleFunction } from "connect";
+
+ function livereload(): HandleFunction;
+ function livereload(options: livereload.Options): HandleFunction;
+
+ module livereload {
+ export type FileMatcher = string | RegExp;
+
+ export interface Rule {
+ match: RegExp;
+ fn: (w: string, s: string) => string;
+ }
+
+ export interface Options {
+ ignore?: FileMatcher[];
+ excludeList?: FileMatcher[];
+
+ include?: FileMatcher[];
+ html?: (val: string) => boolean;
+ rules?: Rule[];
+ disableCompression?: boolean;
+
+ hostname?: string;
+ port?: number;
+ src?: string;
+ }
+ }
+
+ export = livereload;
+}
\ No newline at end of file
diff --git a/connect/connect-tests.ts b/connect/connect-tests.ts
new file mode 100644
index 0000000000..e8665f8f91
--- /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 0000000000..575a341b60
--- /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/content-type/content-type-test.ts b/content-type/content-type-tests.ts
similarity index 100%
rename from content-type/content-type-test.ts
rename to content-type/content-type-tests.ts
diff --git a/cookie/cookie-test.ts b/cookie/cookie-tests.ts
similarity index 100%
rename from cookie/cookie-test.ts
rename to cookie/cookie-tests.ts
diff --git a/cordova/cordova-tests.ts b/cordova/cordova-tests.ts
index 491b49773a..d0e6e68897 100644
--- a/cordova/cordova-tests.ts
+++ b/cordova/cordova-tests.ts
@@ -1,5 +1,5 @@
// Copyright (c) Microsoft Open Technologies, Inc.
-// Licensed under the MIT license.
+// Licensed under the MIT license.
/// <reference path="cordova.d.ts"/>
@@ -203,7 +203,7 @@ file.abort();
// InAppBrowser plugin
//----------------------------------------------------------------------
-// signature of window.open() added by InAppBrowser plugin
+// signature of window.open() added by InAppBrowser plugin
// is similar to native window.open signature, so the compiler can's
// select proper overload, but we cast result to InAppBrowser manually.
var iab = <InAppBrowser>window.open('google.com', '_self');
@@ -307,3 +307,28 @@ db.transaction(
navigator.notification.vibrate(100);
navigator.notification.vibrateWithPattern([100, 200, 200, 150, 50], 3);
setTimeout(navigator.notification.cancelVibration, 1000);
+
+// Keyboard plugin
+//----------------------------------------------------------------------
+Keyboard.shrinkView(true);
+Keyboard.shrinkView(false);
+Keyboard.hideFormAccessoryBar(true);
+Keyboard.hideFormAccessoryBar(false);
+Keyboard.disableScrollingInShrinkView(true);
+Keyboard.disableScrollingInShrinkView(false);
+if (Keyboard.isVisible) {
+ console.log('Keyboard is visible');
+}
+Keyboard.automaticScrollToTopOnHiding = true;
+Keyboard.onshow = function () {
+ console.log('onshow');
+};
+Keyboard.onhide = function () {
+ console.log('onhide');
+};
+Keyboard.onshowing = function () {
+ console.log('onshowing');
+};
+Keyboard.onhiding= function () {
+ console.log('onhiding');
+};
diff --git a/cordova/cordova.d.ts b/cordova/cordova.d.ts
index 32ef0a76b6..fcef3b9fe7 100644
--- a/cordova/cordova.d.ts
+++ b/cordova/cordova.d.ts
@@ -25,6 +25,7 @@
/// <reference path="plugins/StatusBar.d.ts"/>
/// <reference path="plugins/Vibration.d.ts"/>
/// <reference path="plugins/WebSQL.d.ts"/>
+/// <reference path="plugins/Keyboard.d.ts"/>
interface Cordova {
/** Invokes native functionality by specifying corresponding service name, action and optional parameters.
@@ -94,3 +95,7 @@ interface UrlUtil {
/** Apache Cordova instance */
declare var cordova: Cordova;
+
+declare module 'cordova' {
+ export = cordova;
+}
diff --git a/cordova/plugins/Globalization.d.ts b/cordova/plugins/Globalization.d.ts
index f49e2bf4b0..e6a36af908 100644
--- a/cordova/plugins/Globalization.d.ts
+++ b/cordova/plugins/Globalization.d.ts
@@ -48,9 +48,9 @@ interface Globalization {
date: Date,
onSuccess: (date: { value: string; }) => void,
onError: (error: GlobalizationError) => void,
- options?: {
+ options?: {
formatLength?: string; // "short" | "medium" | "long" | "full"
- selector?: string; // "date" | "time" | "date and time"
+ selector?: string; // "date" | "time" | "date and time"
}): void;
/**
* Parses a date formatted as a string, according to the client's user preferences
diff --git a/cordova/plugins/Keyboard.d.ts b/cordova/plugins/Keyboard.d.ts
new file mode 100644
index 0000000000..414cd87fac
--- /dev/null
+++ b/cordova/plugins/Keyboard.d.ts
@@ -0,0 +1,174 @@
+// Type definitions for Apache Cordova Keyboard plugin v0.1.2
+// Project: https://github.com/apache/cordova-plugins/tree/master/keyboard
+// Definitions by: Dan Manastireanu <https://github.com/danmana>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/**
+ * The Keyboard object provides some functions to customize the iOS keyboard.
+ *
+ * <i>Supported Platforms: iOS</i>
+ *
+ * This plugin has only been tested in Cordova 3.2 or greater,
+ * and its use in previous Cordova versions is not recommended
+ * (potential conflict with keyboard customization code present in the core in previous Cordova versions).
+ *
+ * If you do use this plugin in an older Cordova version (again, not recommended),
+ * you have to make sure the HideKeyboardFormAccessoryBar and KeyboardShrinksView preference values are always false,
+ * and only use the API functions to turn things on/off.
+ *
+ * This plugin supports the HideKeyboardFormAccessoryBar (boolean)
+ * and KeyboardShrinksView (boolean) preferences in config.xml.
+ *
+ * Permissions in config.xml
+ * <code>
+ * <feature name="Keyboard">
+ * <param name="ios-package" value="CDVKeyboard" onload="true" />
+ * </feature>
+ * </code>
+ *
+ */
+interface Keyboard {
+
+ // Methods
+
+ /**
+ * Shrink the WebView when the keyboard comes up.
+ *
+ * Set to true to shrink the WebView when the keyboard comes up.
+ * The WebView shrinks instead of the viewport shrinking and the page scrollable.
+ * This applies to apps that position their elements relative to the bottom of the WebView.
+ * This is the default behaviour on Android, and makes a lot of sense when building apps as opposed to webpages.
+ *
+ * Example:
+ * <code>
+ * Keyboard.shrinkView(true);
+ * Keyboard.shrinkView(false);
+ * </code>
+ *
+ * @param shrink
+ */
+ shrinkView(shrink:boolean): void,
+
+ /**
+ * Hide the keyboard toolbar.
+ *
+ * Set to true to hide the additional toolbar that is on top of the keyboard.
+ * This toolbar features the Prev, Next, and Done buttons.
+ *
+ * Example:
+ * <code>
+ * Keyboard.hideFormAccessoryBar(true);
+ * Keyboard.hideFormAccessoryBar(false);
+ * </code>
+ *
+ * @param hide
+ */
+ hideFormAccessoryBar(hide:boolean): void,
+
+ /**
+ * Disable scrolling when the the WebView is shrunk.
+ *
+ * Set to true to disable scrolling when the WebView is shrunk.
+ *
+ * Example:
+ * <code>
+ * Keyboard.disableScrollingInShrinkView(true);
+ * Keyboard.disableScrollingInShrinkView(false);
+ * </code>
+ *
+ * @param disable
+ */
+ disableScrollingInShrinkView(disable:boolean): void,
+
+ // Properties
+
+ /**
+ * Determine if the keyboard is visible.
+ *
+ * Read this property to determine if the keyboard is visible.
+ *
+ * Example:
+ * <code>
+ * if (Keyboard.isVisible) {
+ * // do something
+ * }
+ * </code>
+ *
+ */
+ isVisible: boolean,
+ /**
+ * Specifies whenether content of page would be autoamtically scrolled to the top of the page when keyboard is hiding.
+ *
+ * Set this to true if you need that page scroll to beginning when keyboard is hiding.
+ * This is allows to fix issue with elements declared with position: fixed, after keyboard is hiding.
+ *
+ * Example:
+ * <code>
+ * Keyboard.automaticScrollToTopOnHiding = true;
+ * </code>
+ *
+ */
+ automaticScrollToTopOnHiding: boolean,
+
+ // Events
+
+ /**
+ * If defined, this function is fired when keyboard fully shown.
+ *
+ * Attach handler to this event to be able to receive notification when keyboard is shown.
+ *
+ * Example:
+ * <code>
+ * Keyboard.onshow = function () {
+ * // Describe your logic which will be run each time keyboard is shown.
+ * }
+ * </code>
+ *
+ */
+ onshow():void,
+ /**
+ * If defined, this function is fired when keyboard fully closed.
+ *
+ * Attach handler to this event to be able to receive notification when keyboard is closed.
+ *
+ * Example:
+ * <code>
+ * Keyboard.onhide = function () {
+ * // Describe your logic which will be run each time keyboard is closed.
+ * }
+ * </code>
+ *
+ */
+ onhide():void,
+ /**
+ * If defined, this function is fired before keyboard will be shown.
+ *
+ * Attach handler to this event to be able to receive notification when keyboard is about to be shown on the screen.
+ *
+ * Example:
+ * <code>
+ * Keyboard.onshowing = function () {
+ * // Describe your logic which will be run each time when keyboard is about to be shown.
+ * }
+ * </code>
+ *
+ */
+ onshowing():void,
+ /**
+ * If defined, this function is fired when keyboard is about to be closed.
+ *
+ * Attach handler to this event to be able to receive notification when keyboard is about to be closed.
+ *
+ * Example:
+ * <code>
+ * Keyboard.onhiding = function () {
+ * // Describe your logic which will be run each time when keyboard is about to be closed.
+ * }
+ * </code>
+ *
+ */
+ onhiding():void,
+
+}
+
+declare var Keyboard:Keyboard;
diff --git a/csurf/csurf.d.ts b/csurf/csurf.d.ts
index cc78f95997..4284ff39ce 100644
--- a/csurf/csurf.d.ts
+++ b/csurf/csurf.d.ts
@@ -16,7 +16,7 @@ declare module "csurf" {
function csurf(options?: {
value?: (req: express.Request) => string;
- cookie?: csurf.CookieOptions;
+ cookie?: csurf.CookieOptions | boolean;
}): express.RequestHandler;
module csurf {
@@ -27,4 +27,3 @@ declare module "csurf" {
export = csurf;
}
-
diff --git a/d3/d3-tests.ts b/d3/d3-tests.ts
index 98888dde76..f4efa75d40 100644
--- a/d3/d3-tests.ts
+++ b/d3/d3-tests.ts
@@ -1450,7 +1450,7 @@ function quadtree() {
// Collapse the quadtree into an array of rectangles.
function nodes(quadtree: d3.geom.quadtree.Quadtree<[number, number]>) {
var nodes: Array<{x: number; y: number; width: number; height: number}> = [];
- quadtree.visit(function (node, x1, y1, x2, y2) {
+ quadtree.visit(function (node: d3.geom.quadtree.Node<[number, number]>, x1: number, y1: number, x2:number, y2: number) {
nodes.push({ x: x1, y: y1, width: x2 - x1, height: y2 - y1 });
} );
return nodes;
@@ -1458,7 +1458,7 @@ function quadtree() {
// Find the nodes within the specified rectangle.
function search(quadtree: d3.geom.quadtree.Quadtree<{ scanned?: boolean; selected?: boolean; 0: number; 1: number }>, x0: number, y0: number, x3: number, y3: number) {
- quadtree.visit(function (node, x1, y1, x2, y2) {
+ quadtree.visit(function (node: d3.geom.quadtree.Node<{ scanned?: boolean; selected?: boolean; 0: number; 1: number }>, x1: number, y1: number, x2:number, y2: number) {
var p = node.point;
if (p) {
p.scanned = true;
diff --git a/d3/d3.d.ts b/d3/d3.d.ts
index fbeca365e2..87e6ef0e0f 100644
--- a/d3/d3.d.ts
+++ b/d3/d3.d.ts
@@ -3251,7 +3251,7 @@ declare module d3 {
export function delaunay(vertices: Array<[number, number]>): Array<[[number, number], [number, number], [number, number]]>;
export function quadtree(): Quadtree<[number, number]>;
- export function quadtree<T>(): Quadtree<T>;
+ export function quadtree<T>(nodes: T[], x1?: number, y1?: number, x2?: number, y2?: number): quadtree.Quadtree<T>;
module quadtree {
interface Node<T> {
diff --git a/decorum/decorum-tests.ts b/decorum/decorum-tests.ts
new file mode 100644
index 0000000000..4a51b09555
--- /dev/null
+++ b/decorum/decorum-tests.ts
@@ -0,0 +1,115 @@
+/// <reference path="./decorum.d.ts" />
+
+import {Required} from 'decorum';
+import {Email} from 'decorum';
+import {MinLength} from 'decorum';
+import {MaxLength} from 'decorum';
+import {Length} from 'decorum';
+import {FieldName} from 'decorum';
+import {Validation} from 'decorum';
+import {Pattern} from 'decorum';
+import {Alpha} from 'decorum';
+import {AlphaNumeric} from 'decorum';
+import {Validator} from 'decorum';
+import {BaseValidator} from 'decorum';
+import {IMessageOpts} from 'decorum';
+import {MessageHandlers} from 'decorum';
+
+class MyModel {
+ @FieldName('User name')
+ @Required()
+ @MaxLength(50)
+ username = '';
+
+ @FieldName('Email address')
+ @Email()
+ @Required('Your email address will be used to send you a confirmation email. You must fill it out')
+ emailAddress = '';
+
+ @Required()
+ @MinLength(10)
+ @MaxLength(30)
+ password = '';
+
+ @FieldName('Confirm password')
+ @Validation<MyModel>(
+ 'The passwords do not match.',
+ (pwd, model) => model.password === pwd
+ )
+ confirmPassword = '';
+
+ @Pattern(/^[a-z0-9-]+$/i, 'Must be a valid slug tag')
+ slug = 'foo';
+
+ @Length(6, 'Alias must be 6 characters long')
+ alias: string;
+
+ @Alpha((opts: IMessageOpts) => 'Message overridden for field ' + opts.property + ' with friendly name ' + opts.friendlyName)
+ alpha: string;
+
+ @AlphaNumeric((opts: IMessageOpts) => 'Message overridden for field ' + opts.property + ' with friendly name ' + opts.friendlyName)
+ alphaNumeric: string;
+}
+
+// ES6-style
+class MyController {
+ model = new MyModel();
+ validator = Validator.new(this.model);
+
+ doStuff(): void {
+ var opts = this.validator.getValidationOptions('alias');
+ var fieldName = opts.getFriendlyName();
+ var errs = opts.validateValue('foo', this.model);
+ opts.setFriendlyName('Foo');
+ opts.addValidator(null);
+ var validators = opts.getValidators();
+ }
+
+ validate(): void {
+ var result = this.validator.validate();
+ if (!result.isValid) {
+ for(var i = 0; i < result.errors.length; i++) {
+ var current = result.errors[i];
+ console.error(current.fieldName, current.errors);
+ }
+ }
+ }
+}
+
+// ES5-style
+function MyOtherModel() {
+ this.foo = '';
+ this.bar = '';
+}
+
+Validator.decorate(MyOtherModel, {
+ foo: [
+ decorum.Required()
+ ],
+ bar: [
+ decorum.Pattern(/^[a-z][0-9]$/i),
+ decorum.FieldName('My bar')
+ ]
+});
+
+var otherValidator = Validator.new(new MyOtherModel());
+otherValidator.validateField('foo', '');
+
+// Custom validator
+class MyValidator extends BaseValidator {
+
+ validatesEmptyValue(): boolean {
+ return false;
+ }
+
+ getMessage(opts: IMessageOpts): string {
+ return opts.friendlyName + ' is not a valid thing because of value ' + opts.value + '! Fyi... its property name is ' + opts.property;
+ }
+
+ isValid(value: any, model: any): boolean {
+ return false;
+ }
+}
+
+// Message overrides
+MessageHandlers['alpha'] = (opts: IMessageOpts) => 'The value ' + opts.value + ' for property ' + opts.property + ' is invalid!';
diff --git a/decorum/decorum-tests.ts.tscparams b/decorum/decorum-tests.ts.tscparams
new file mode 100644
index 0000000000..5300ee7222
--- /dev/null
+++ b/decorum/decorum-tests.ts.tscparams
@@ -0,0 +1,2 @@
+--experimentalDecorators
+--target ES5
diff --git a/decorum/decorum.d.ts b/decorum/decorum.d.ts
new file mode 100644
index 0000000000..4a966e9d2b
--- /dev/null
+++ b/decorum/decorum.d.ts
@@ -0,0 +1,436 @@
+// Type definitions for Decorum JS v0.2.0
+// Project: https://github.com/dflor003/decorum
+// Definitions by: Danil Flores <https://github.com/dflor003>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module 'decorum' {
+ export = decorum;
+}
+
+declare namespace decorum {
+ /**
+ * A generic custom validation. Takes a predicate that will receive the proposed value as the first parameter and
+ * the current model state as the second.
+ * @param message The message to display when the predicate fails.
+ * @param predicate A lambda expression/function that determines if the value is valid. If it returns a falsy
+ * value, the field will be considered invalid and will return the passed error message upon validation.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function Validation<TModel>(message: string | MessageHandler<CustomValidator<TModel>>, predicate: (value: any, model: TModel) => boolean): PropertyDecorator;
+
+ /**
+ * Validate's that the field is a valid email address. The format used is the same as the webkit browser's internal
+ * email validation format. For looser or stricter formats, use your own validation based on the @Pattern decorator.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function Email(message?: string | MessageHandler<EmailValidator>): PropertyDecorator;
+
+ /**
+ * Sets the field's "friendly" name in validation error messages.
+ * @param name The field's friendly name
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function FieldName(name: string): PropertyDecorator;
+
+ /**
+ * Validate's a field's EXACT length. Validation fails if the field is not EXACTLY the length passed.
+ * @param length The exact length the field must be.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function Length(length: number, message?: string | MessageHandler<LengthValidator>): PropertyDecorator;
+
+ /**
+ * Validates a field's maximum length.
+ * @param maxLength The field's maximum length. Must be a positive integer greater than 1.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function MaxLength(maxLength: number, message?: string | MessageHandler<MaxLengthValidator>): PropertyDecorator;
+
+ /**
+ * Validates the field's minimum length.
+ * @param minLength The field's minimum length. Must be a positive integer greater than 0
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function MinLength(minLength: number, message?: string | MessageHandler<MinLengthValidator>): PropertyDecorator;
+
+ /**
+ * Validates the field against a regular expression pattern.
+ * @param regex The regex to validate against. Should be a valid JavaScript {RegExp} instance.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function Pattern(regex: RegExp, message?: string | MessageHandler<PatternValidator>): PropertyDecorator;
+
+ /**
+ * Marks the field as required.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function Required(message?: string | MessageHandler<RequiredFieldValidator>): PropertyDecorator;
+
+ /**
+ * Validates that a given field only contains alpha values.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function Alpha(message?: string | MessageHandler<PatternValidator>): PropertyDecorator;
+
+ /**
+ * Validates that a given field only contains alphanumeric values.
+ * @param message [Optional] Overrides the default validation error message.
+ * @returns {function(Object, string): void} A field validation decorator.
+ */
+ export function AlphaNumeric(message?: string | MessageHandler<PatternValidator>): PropertyDecorator;
+
+ /**
+ * A map from field name to array of field validation decorators.
+ */
+ export type ValidationDefinitions = {
+ [field: string]: PropertyDecorator[];
+ };
+
+ /**
+ * Static container for convenience methods related to field validation.
+ */
+ export class Validator {
+ /**
+ * Creates a new model validator for the given model. Model should be a valid class that has a valid constructor
+ * and a prototype.
+ * @param model The model to create the validator for.
+ * @returns {ModelValidator} An instance of {ModelValidator}
+ */
+ static new(model: any): ModelValidator;
+
+ /**
+ * Decorates the passed class with model validations. Use this when you do not have access to ES7 decorators.
+ * The object passed should be a valid class (ES6 class or ES5 function constructor).
+ * @param objectType The class to decorate.
+ * @param definitions One or more field validation definitions of the form { "fieldName": [ decorators ] }.
+ */
+ static decorate(objectType: any, definitions: ValidationDefinitions): void;
+
+ /**
+ * Creates an anonymous validator, immediately validates the model, and returns any validation errors on the
+ * model as a result.
+ * @param model The model to validate.
+ */
+ static validate(model: any): IValidationResult;
+
+ /**
+ * Adds a validator to the given object prototype for the given property. Meant to be used inside of validation
+ * decorators to inject the validation onto the object property.
+ * @param targetPrototype A valid object prototype to add to.
+ * @param property The property to add the validator for.
+ * @param validator The validator to add.
+ */
+ static addValidator(targetPrototype: Object, property: string, validator: BaseValidator): void;
+ }
+
+ /**
+ * Details about validation errors on a field.
+ */
+ export interface IFieldValidationError {
+ /**
+ * The property name of the field on the model.
+ */
+ field: string;
+
+ /**
+ * The "friendly" name of the field. If not set on the model via @FieldName(...), it will default to "Field".
+ */
+ fieldName: string;
+
+ /**
+ * One or more field validation errors. Empty if no errors.
+ */
+ errors: string[];
+ }
+
+ /**
+ * Result returned when a model is validated.
+ */
+ export interface IValidationResult {
+ /**
+ * Whether or not the model is valid.
+ */
+ isValid: boolean;
+
+ /**
+ * A map of field name to validation errors.
+ */
+ errors: IFieldValidationError[];
+ }
+
+ /**
+ * Wraps a model to allow the consuming class to call validation methods.
+ */
+ export class ModelValidator {
+ /**
+ * Creates a new model validator.
+ * @param model The model to validate. Should be a class that has a valid constructor function and prototype.
+ */
+ constructor(model: any);
+
+ /**
+ * Gets the validation options for the given field name.
+ * @param fieldKey The name of the field to get options for.
+ * @returns {FieldOptions} The field options associated with that field or null if no validations defined
+ * for the field.
+ */
+ getValidationOptions(fieldKey: string): FieldOptions;
+
+ /**
+ * Validates the given field on this {ModelValidator}'s model. If a proposed value is passed, validate
+ * against that passed value; otherwise, use the field's current value on the model.
+ * @param fieldKey The name of the field to validate.
+ * @param proposedValue [Optional] The proposed value to set on the field.
+ * @returns {string[]} An array of field validation error messages if the field is invalid; otherwise,
+ * an empty array.
+ */
+ validateField(fieldKey: string, proposedValue?: any): string[];
+
+ /**
+ * Validate the entire model and return a result that indicates whether the model is valid or not and any
+ * errors
+ * that have occurred in an object indexed by field name on the model.
+ * @returns {IValidationResult} An object that contains whether the model is valid or not and errors by field
+ * name.
+ */
+ validate(): IValidationResult;
+ }
+
+ /**
+ * Callback invoked when a validation needs to return an error. The first parameter is an object
+ * wrapping metadata about the field such as the field name, friendly name, value, etc.
+ * The second parameter is the validator instance that triggered the error.
+ */
+ export interface MessageHandler<TValidator extends BaseValidator> {
+ (opts: IMessageOpts, validator: TValidator): string;
+ }
+
+ /**
+ * Options passed to a field to aid in generating a message. Contains data about
+ * the field such as name, friendly name, and value.
+ */
+ export interface IMessageOpts {
+ /**
+ * The property name from the model. I.e. 'emailAddress', 'username', etc.
+ */
+ property: string;
+
+ /**
+ * The friendly name for the field. I.e. 'Email address', 'Password Confirmation', etc.
+ */
+ friendlyName: string;
+
+ /**
+ * The current value of the field at the time the validation error was generated.
+ */
+ value: string;
+ }
+
+ /**
+ * A map of validation "key" (unique name for a given type of validation) to message handler callback.
+ */
+ export interface IMessageHandlerMap {
+ [key: string]: MessageHandler<any>;
+ }
+
+ /**
+ * Mechanism for overriding validation errors to provide for custom or localized error messages.
+ * @type {{IMessageHandlerMap}}
+ */
+ export let MessageHandlers: IMessageHandlerMap;
+
+ /**
+ * Custom validation class.
+ */
+ export class CustomValidator<TModel> extends BaseValidator {
+ constructor(predicate: (value: any, model: TModel) => boolean, message: string | MessageHandler<CustomValidator<TModel>>);
+
+ getMessage(opts: IMessageOpts): string;
+
+ isValid(value: any, model: any): boolean;
+ }
+
+ /**
+ * An email validator.
+ */
+ export class EmailValidator extends PatternValidator {
+ static EmailRegex: RegExp;
+
+ constructor(message?: string | MessageHandler<EmailValidator>);
+
+ getMessage(opts: IMessageOpts): string;
+
+ getKey(): string;
+ }
+
+ /**
+ * An exact length validator.
+ */
+ export class LengthValidator extends BaseValidator {
+ length: number;
+
+ constructor(length: number, message?: string | MessageHandler<LengthValidator>);
+
+ getMessage(opts: IMessageOpts): string;
+
+ isValid(value: any): boolean;
+ }
+
+ /**
+ * A maximum length validator.
+ */
+ export class MaxLengthValidator extends BaseValidator {
+ maxLength: number;
+
+ constructor(maxLength: number, message?: string | MessageHandler<MaxLengthValidator>);
+
+ getMessage(opts: IMessageOpts): string;
+
+ isValid(value: string): boolean;
+ }
+
+ /**
+ * A minimum length validator.
+ */
+ export class MinLengthValidator extends BaseValidator {
+ minLength: number;
+
+ constructor(minLength: number, message?: string | MessageHandler<MinLengthValidator>);
+
+ getMessage(opts: IMessageOpts): string;
+
+ isValid(value: string): boolean;
+ }
+
+ /**
+ * A regular expression validator.
+ */
+ export class PatternValidator extends BaseValidator {
+ pattern: RegExp;
+
+ constructor(pattern: RegExp, message?: string | MessageHandler<PatternValidator>);
+
+ getMessage(opts: IMessageOpts): string;
+
+ isValid(value: any): boolean;
+ }
+
+ /**
+ * A field requiredness validator.
+ */
+ export class RequiredFieldValidator extends BaseValidator {
+ constructor(message?: string | MessageHandler<RequiredFieldValidator>);
+
+ validatesEmptyValue(): boolean;
+
+ getMessage(opts: IMessageOpts): string;
+
+ isValid(value: any): boolean;
+ }
+
+ /**
+ * Base abstract class for all validators. Methods that must be overridden:
+ * getMessage(...) - Get error message to return when field is invalid.
+ * isValid(...) - Check validity of field given proposed value and the rest of the model.
+ */
+ export abstract class BaseValidator {
+ /**
+ * Initializes the {BaseValidator}
+ * @param validatorKey A unique "key" by which to identify this field validator i.e. length, maxlength,
+ * required. Should be a valid JS property name.
+ * @param message A custom error message to return. Should be passed down from concrete class' constructors to
+ * enable customizing error messages.
+ */
+ constructor(validatorKey: string, message: string | MessageHandler<any>);
+
+ /**
+ * Returns true if the validator instance was passed a custom error message.
+ */
+ hasCustomMessage: boolean;
+
+ /**
+ * Check whether this validator should process an "empty" value (i.e. null, undefined, empty string). Override
+ * this in derived classes to skip validators if the field value hasn't been set. Things like email, min/max
+ * length, and pattern should return false for this to ensure they don't get fired when the model is initially
+ * empty before a user has had a chance to input a value. Things like required should override this to true so
+ * that they are fired for empty values. Base implementation defaults to false
+ * @returns {boolean}
+ */
+ validatesEmptyValue(): boolean;
+
+ /**
+ * Gets the custom error message set on this validator.
+ * @param opts Metadata about the field such as name and friendly name.
+ * @returns {string} The custom error message or null if none has been set.
+ */
+ getCustomMessage(opts: IMessageOpts): string;
+
+ /**
+ * Gets the unique name for this validator.
+ * @returns {string} The unique name for this validator.
+ */
+ getKey(): string;
+
+ /**
+ * [Abstract] Gets the error message to display when a field fails validation by this validator.
+ * @param opts Metadata about the field such as name and friendly name.
+ */
+ abstract getMessage(opts: IMessageOpts): string;
+
+ /**
+ * [Abstract] Checks the passed value for validity.
+ * @param value The field's proposed value.
+ * @param model The rest of the model if cross-field validity checks are necessary.
+ */
+ abstract isValid(value: any, model: any): boolean;
+ }
+
+ /**
+ * Validation options for a given field including actual validators and meta data such as the field name.
+ */
+ export class FieldOptions {
+ constructor(property: string);
+
+ /**
+ * Gets the "friendly" name of the field for use in validation error messages. Defaults to just "Field".
+ * @returns {string}
+ */
+ getFriendlyName(): string;
+
+ /**
+ * Sets the "friendly" name of the field for use in validation error messages. This name will be used in the
+ * text of validation errors.
+ * @param name The new name to set.
+ */
+ setFriendlyName(name: string): void;
+
+ /**
+ * Add a validator to the list of validators for this field.
+ * @param validator The validator to add. Should be a class that extends from {BaseValidator}.
+ */
+ addValidator(validator: BaseValidator): void;
+
+ /**
+ * Gets the validators assigned to this field.
+ * @returns {BaseValidator[]} The validators for this field.
+ */
+ getValidators(): BaseValidator[];
+
+ /**
+ * Runs through all of the validators for the field given a particular value and returns any validation errors
+ * that may have occurred.
+ * @param value The value to validate.
+ * @param model The rest of the model. Used in custom cross-field validations.
+ * @returns {string[]} Any validation errors that may have occurred or an empty array if the value passed is
+ * valid for the field.
+ */
+ validateValue(value: any, model: any): string[];
+ }
+}
diff --git a/del/del-tests.ts b/del/del-tests.ts
index b0dd984349..867781d63d 100644
--- a/del/del-tests.ts
+++ b/del/del-tests.ts
@@ -7,11 +7,11 @@ del(["tmp/*.js", "!tmp/unicorn.js"]);
del(["tmp/*.js", "!tmp/unicorn.js"], {force: true});
-del(["tmp/*.js", "!tmp/unicorn.js"], (err, paths) => {
+del(["tmp/*.js", "!tmp/unicorn.js"]).then((paths: string[]) => {
console.log('Deleted files/folders:\n', paths.join('\n'));
});
-del(["tmp/*.js", "!tmp/unicorn.js"], {force: true}, (err, paths) => {
+del(["tmp/*.js", "!tmp/unicorn.js"], {force: true}).then((paths: string[]) => {
console.log('Deleted files/folders:\n', paths.join('\n'));
});
@@ -19,18 +19,19 @@ del("tmp/*.js");
del("tmp/*.js", {force: true});
-del("tmp/*.js", (err, paths) => {
+del("tmp/*.js").then((paths: string[]) => {
console.log('Deleted files/folders:\n', paths.join('\n'));
});
-del("tmp/*.js", {force: true}, (err, paths) => {
+del("tmp/*.js", {force: true}).then((paths: string[]) => {
console.log('Deleted files/folders:\n', paths.join('\n'));
});
-del.sync(["tmp/*.js", "!tmp/unicorn.js"]);
+var paths: string[];
+paths = del.sync(["tmp/*.js", "!tmp/unicorn.js"]);
-del.sync(["tmp/*.js", "!tmp/unicorn.js"], {force: true});
+paths = del.sync(["tmp/*.js", "!tmp/unicorn.js"], {force: true});
-del.sync("tmp/*.js");
+paths = del.sync("tmp/*.js");
-del.sync("tmp/*.js", {force: true});
+paths = del.sync("tmp/*.js", {force: true});
diff --git a/del/del.d.ts b/del/del.d.ts
index b20bac92ce..060861d8a1 100644
--- a/del/del.d.ts
+++ b/del/del.d.ts
@@ -4,23 +4,20 @@
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../glob/glob.d.ts"/>
+/// <reference path="../es6-promise/es6-promise.d.ts" />
declare module "del" {
import glob = require("glob");
- function Del(pattern: string): void;
- function Del(pattern: string, options: Del.Options): void;
- function Del(pattern: string, callback: (err: Error, deletedFiles: string[]) => any): void;
- function Del(pattern: string, options: Del.Options, callback: (err: Error, deletedFiles: string[]) => any): void;
+ function Del(pattern: string): Promise<string[]>;
+ function Del(pattern: string, options: Del.Options): Promise<string[]>;
- function Del(patterns: string[]): void;
- function Del(patterns: string[], options: Del.Options): void;
- function Del(patterns: string[], callback: (err: Error, deletedFiles: string[]) => any): void;
- function Del(patterns: string[], options: Del.Options, callback: (err: Error, deletedFiles: string[]) => any): void;
+ function Del(patterns: string[]): Promise<string[]>;
+ function Del(patterns: string[], options: Del.Options): Promise<string[]>;
module Del {
- function sync(pattern: string, options?: Options): void;
- function sync(patterns: string[], options?: Options): void;
+ function sync(pattern: string, options?: Options): string[];
+ function sync(patterns: string[], options?: Options): string[];
interface Options extends glob.IOptions {
force?: boolean
diff --git a/denodeify/denodeify-tests.ts b/denodeify/denodeify-tests.ts
new file mode 100644
index 0000000000..0cd6a0c988
--- /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 0000000000..fec2fbf3cc
--- /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/devextreme/dx.devextreme-15.1.3.d.ts b/devextreme/devextreme-15.1.3.d.ts
similarity index 100%
rename from devextreme/dx.devextreme-15.1.3.d.ts
rename to devextreme/devextreme-15.1.3.d.ts
diff --git a/devextreme/dx.devextreme-15.1.4.d.ts b/devextreme/devextreme-15.1.4.d.ts
similarity index 100%
rename from devextreme/dx.devextreme-15.1.4.d.ts
rename to devextreme/devextreme-15.1.4.d.ts
diff --git a/devextreme/dx.devextreme-15.1.5.d.ts b/devextreme/devextreme-15.1.5.d.ts
similarity index 100%
rename from devextreme/dx.devextreme-15.1.5.d.ts
rename to devextreme/devextreme-15.1.5.d.ts
diff --git a/devextreme/dx.devextreme.d.ts b/devextreme/devextreme-15.1.6.d.ts
similarity index 99%
rename from devextreme/dx.devextreme.d.ts
rename to devextreme/devextreme-15.1.6.d.ts
index c2bf7a1a22..fdb7df96ca 100644
--- a/devextreme/dx.devextreme.d.ts
+++ b/devextreme/devextreme-15.1.6.d.ts
@@ -3041,7 +3041,7 @@ declare module DevExpress.ui {
lookup?: {
/** Specifies whether or not a user can nullify values of a lookup column. */
allowClearing?: boolean;
- /**
+ /**
* Specifies the data source providing data for a lookup column.
*/
dataSource?: any;
@@ -3076,9 +3076,6 @@ declare module DevExpress.ui {
showInColumnChooser?: boolean;
/** Specifies the identifier of the column. */
name?: string;
- // NOTE https://github.com/borisyankov/DefinitelyTyped/pull/5590
- text?: string;
- value?: any;
}
export interface dxDataGridOptions extends WidgetOptions {
/** Specifies whether the outer borders of the grid are visible or not. */
@@ -3174,7 +3171,7 @@ declare module DevExpress.ui {
cancel?: string;
}
};
- /**
+ /**
* An array of grid columns.
*/
columns?: dxDataGridColumn[];
@@ -3274,7 +3271,7 @@ declare module DevExpress.ui {
autoExpandAll?: boolean;
/** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */
groupContinuedMessage?: string;
- /**
+ /**
* Specifies the message displayed in a group row when the corresponding group continues on the next page.
*/
groupContinuesMessage?: string;
@@ -3656,7 +3653,7 @@ declare module DevExpress.ui {
removeRow(rowIndex: number): void;
/** Saves changes made in a grid. */
saveEditData(): void;
- /**
+ /**
* Searches grid records by a search string.
*/
searchByText(text: string): void;
@@ -5955,7 +5952,7 @@ declare module DevExpress.viz.rangeSelector {
behavior?: {
/** Indicates whether or not you can swap sliders. */
allowSlidersSwap?: boolean;
- /**
+ /**
Indicates whether or not animation is enabled.
*/
animationEnabled?: boolean;
@@ -6070,7 +6067,7 @@ Indicates whether or not animation is enabled.
maxRange?: any;
/** Specifies the number of minor ticks between neighboring major ticks. */
minorTickCount?: number;
- /**
+ /**
Specifies an interval between minor ticks.
*/
minorTickInterval?: any;
diff --git a/devextreme/dx.devextreme-tests.ts b/devextreme/devextreme-tests.ts
similarity index 99%
rename from devextreme/dx.devextreme-tests.ts
rename to devextreme/devextreme-tests.ts
index 78b09d15ae..6a05825749 100644
--- a/devextreme/dx.devextreme-tests.ts
+++ b/devextreme/devextreme-tests.ts
@@ -1,4 +1,4 @@
-/// <reference path="dx.devextreme.d.ts" />
+/// <reference path="devextreme.d.ts" />
module Tests.ui {
var dataGridOptions: DevExpress.ui.dxDataGridOptions = {
diff --git a/devextreme/devextreme.d.ts b/devextreme/devextreme.d.ts
new file mode 100644
index 0000000000..fc593db200
--- /dev/null
+++ b/devextreme/devextreme.d.ts
@@ -0,0 +1,6572 @@
+// Type definitions for DevExtreme 15.1.7
+// Project: http://js.devexpress.com/
+// Definitions by: DevExpress Inc. <http://devexpress.com/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts" />
+
+declare module DevExpress {
+ /** A mixin that provides a capability to fire and subscribe to events. */
+ export interface EventsMixin<T> {
+ /** Subscribes to a specified event. */
+ on(eventName: string, eventHandler: Function): T;
+ /** Subscribes to the specified events. */
+ on(events: { [eventName: string]: Function; }): T;
+ /** Detaches all event handlers from the specified event. */
+ off(eventName: string): Object;
+ /** Detaches a particular event handler from the specified event. */
+ off(eventName: string, eventHandler: Function): T;
+ }
+ /** An object that serves as a namespace for the methods required to perform validation. */
+ export module validationEngine {
+ export interface IValidator {
+ validate(): ValidatorValidationResult;
+ reset(): void;
+ }
+ export interface ValidatorValidationResult {
+ isValid: boolean;
+ name?: string;
+ value: any;
+ brokenRule: any;
+ validationRules: any[];
+ }
+ export interface ValidationGroupValidationResult {
+ isValid: boolean;
+ brokenRules: any[];
+ validators: IValidator[];
+ }
+ export interface GroupConfig extends EventsMixin<GroupConfig> {
+ group: any;
+ validators: IValidator[];
+ validate(): ValidationGroupValidationResult;
+ reset(): void;
+ }
+ /** Provides access to the object that represents the specified validation group. */
+ export function getGroupConfig(group: any): GroupConfig
+ /** Provides access to the object that represents the default validation group. */
+ export function getGroupConfig(): GroupConfig
+ /** Validates rules of the validators that belong to the specified validation group. */
+ export function validateGroup(group: any): ValidationGroupValidationResult;
+ /** Validates rules of the validators that belong to the default validation group. */
+ export function validateGroup(): ValidationGroupValidationResult;
+ /** Resets the values and validation result of the editors that belong to the specified validation group. */
+ export function resetGroup(group: any): void;
+ /** Resets the values and validation result of the editors that belong to the default validation group. */
+ export function resetGroup(): void;
+ /** Validates the rules that are defined within the dxValidator objects that are registered for the specified ViewModel. */
+ export function validateModel(model: Object): ValidationGroupValidationResult;
+ /** Registers all the dxValidator objects by which the fields of the specified ViewModel are extended. */
+ export function registerModelForValidation(model: Object): void;
+ }
+ export var hardwareBackButton: JQueryCallback;
+ /** Processes the hardware back button click. */
+ export function processHardwareBackButton(): void;
+ /** Hides the last displayed overlay widget. */
+ export function hideTopOverlay(): boolean;
+ /** Specifies whether or not the entire application/site supports right-to-left representation. */
+ export var rtlEnabled: boolean;
+ /** Registers a new component in the DevExpress.ui namespace as a jQuery plugin, Angular directive and Knockout binding. */
+ export function registerComponent(name: string, componentClass: Object): void;
+ /** Registers a new component in the specified namespace as a jQuery plugin, Angular directive and Knockout binding. */
+ export function registerComponent(name: string, namespace: Object, componentClass: Object): void;
+ /** Requests that the browser call a specified function to update animation before the next repaint. */
+ export function requestAnimationFrame(callback: Function): number;
+ /** Cancels an animation frame request scheduled with the requestAnimationFrame method. */
+ export function cancelAnimationFrame(requestID: number): void;
+ /** Custom Knockout binding that links an HTML element with a specific action. */
+ export class Action { }
+ /** Used to get URLs that vary in a locally running application and the application running on production. */
+ export class EndpointSelector {
+ constructor(options: {
+ [key: string]: {
+ local?: string;
+ production?: string;
+ }
+ });
+ /** Returns a local or a productional URL depending on how the application is currently running. */
+ urlFor(key: string): string;
+ }
+ /** An object that serves as a namespace for the methods that are used to animate UI elements. */
+ export module fx {
+ /** Defines animation options. */
+ export interface AnimationOptions {
+ /** A function called after animation is completed. */
+ complete?: (element: JQuery, config: AnimationOptions) => void;
+ /** A number specifying wait time before animation execution. */
+ delay?: number;
+ /** A number specifying the time period to wait before the animation of the next stagger item starts. */
+ staggerDelay?: number;
+ /** A number specifying the time in milliseconds spent on animation. */
+ duration?: number;
+ /** A string specifying the type of an easing function used for animation. */
+ easing?: string;
+ /** Specifies the initial animation state. */
+ from?: any;
+ /** A function called before animation is started. */
+ start?: (element: JQuery, config: AnimationOptions) => void;
+ /** Specifies a final animation state. */
+ to?: any;
+ /** A string value specifying the animation type. */
+ type?: string;
+ /** Specifies the animation direction for the "slideIn" and "slideOut" animation types. */
+ direction?: string;
+ }
+ /** Animates the specified element. */
+ export function animate(element: HTMLElement, config: AnimationOptions): Object;
+ /** Returns a value indicating whether the specified element is being animated. */
+ export function isAnimating(element: HTMLElement): boolean;
+ /** Stops the animation. */
+ export function stop(element: HTMLElement, jumpToEnd: boolean): void;
+ }
+ /** The manager that performs several specified animations at a time. */
+ export class TransitionExecutor {
+ /** Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods. */
+ reset(): void;
+ /** Registers a set of elements that should be animated as "entering" using the specified animation configuration. */
+ enter(elements: JQuery, animation: any): void;
+ /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */
+ leave(elements: JQuery, animation: any): void;
+ /** Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand. */
+ start(config: Object): JQueryPromise<void>;
+ }
+ export class AnimationPresetCollection {
+ /** Resets all the changes made in the animation repository. */
+ resetToDefaults(): void;
+ /** Deletes the specified animation or clears all the animation repository, if an animation name is not passed. */
+ clear(name: string): void;
+ /** Adds the specified animation preset to the animation repository by the specified name. */
+ registerPreset(name: string, config: any): void;
+ /** Applies the changes made in the animation repository. */
+ applyChanges(): void;
+ /** Returns the configuration of the animation found in the animation repository by the specified name for the current device. */
+ getPreset(name: string): void;
+ /** Registers predefined animations in the animation repository. */
+ registerDefaultPresets(): void;
+ }
+ /** A repository of animations. */
+ export var animationPresets: AnimationPresetCollection;
+ /** The device object defines the device on which the application is running. */
+ export interface Device {
+ /** Indicates whether or not the device platform is Android. */
+ android?: boolean;
+ /** Specifies the type of the device on which the application is running. */
+ deviceType?: string;
+ /** Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic "light" or "dark" theme. */
+ generic?: boolean;
+ /** Indicates whether or not the device platform is iOS. */
+ ios?: boolean;
+ /** Indicates whether or not the device type is 'phone'. */
+ phone?: boolean;
+ /** Specifies the platform of the device on which the application is running. */
+ platform?: string;
+ /** Indicates whether or not the device type is 'tablet'. */
+ tablet?: boolean;
+ /** Specifies an array with the major and minor versions of the device platform. */
+ version?: Array<number>;
+ /** Indicates whether or not the device platform is Windows8. */
+ win8?: boolean;
+ /** Specifies a performance grade of the current device. */
+ grade?: string;
+ }
+ export class Devices implements EventsMixin<Devices> {
+ constructor(options: { window: Window });
+ /** Overrides actual device information to force the application to operate as if it was running on the specified device. */
+ current(deviceName: any): void;
+ /** Returns information about the current device. */
+ current(): Device;
+ orientationChanged: JQueryCallback;
+ /** Returns the current device orientation. */
+ orientation(): string;
+ /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */
+ real(): Device;
+ on(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices;
+ on(eventName: string, eventHandler: Function): Devices;
+ on(events: { [eventName: string]: Function; }): Devices;
+ off(eventName: "orientationChanged"): Devices;
+ off(eventName: string): Devices;
+ off(eventName: "orientationChanged", eventHandler: (e: { orientation: string }) => void): Devices;
+ off(eventName: string, eventHandler: Function): Devices;
+ }
+ /** An object that serves as a namespace for the methods and events specifying information on the current device. */
+ export var devices: Devices;
+ /** The position object specifies the widget positioning options. */
+ export interface PositionOptions {
+ /** The target element position that the widget is positioned against. */
+ at?: string;
+ /** The element within which the widget is positioned. */
+ boundary?: Element;
+ /** A string value holding horizontal and vertical offset from the window's boundaries. */
+ boundaryOffset?: string;
+ /** Specifies how to move the widget if it overflows the screen. */
+ collision?: any;
+ /** The position of the widget to align against the target element. */
+ my?: string;
+ /** The target element that the widget is positioned against. */
+ of?: HTMLElement;
+ /** A string value holding horizontal and vertical offset in pixels, separated by a space (e.g., "5 -10"). */
+ offset?: string;
+ }
+ export interface ComponentOptions {
+ /** A handler for the initialized event. */
+ onInitialized?: Function;
+ /** A handler for the optionChanged event. */
+ onOptionChanged?: Function;
+ /** A handler for the disposing event. */
+ onDisposing?: Function;
+ }
+ /** A base class for all components and widgets. */
+ export class Component {
+ constructor(options?: ComponentOptions)
+ /** Prevents the component from refreshing until the endUpdate method is called. */
+ beginUpdate(): void;
+ /** Enables the component to refresh after the beginUpdate method call. */
+ endUpdate(): void;
+ /** Returns an instance of this component class. */
+ instance(): Component;
+ /** Sets one or more options of this component. */
+ option(options: Object): void;
+ /** Returns the configuration options of this component. */
+ option(): Object;
+ /** Gets the value of the specified configuration option of this component. */
+ option(optionName: string): any;
+ /** Sets a value to the specified configuration option of this component. */
+ option(optionName: string, optionValue: any): void;
+ }
+ export interface DOMComponentOptions extends ComponentOptions {
+ /** Specifies whether or not the current component supports a right-to-left representation. */
+ rtlEnabled?: boolean;
+ /** Specifies the height of the widget. */
+ height?: any;
+ /** Specifies the width of the widget. */
+ width?: any;
+ }
+ /** A base class for all components. */
+ export class DOMComponent extends Component {
+ constructor(element: JQuery, options?: DOMComponentOptions);
+ constructor(element: HTMLElement, options?: DOMComponentOptions);
+ /** Returns the root HTML element of the widget. */
+ element(): JQuery;
+ /** Specifies the device-dependent default configuration options for this component. */
+ static defaultOptions(rule: {
+ device?: any;
+ options?: any;
+ }): void;
+ }
+ export module data {
+ export interface ODataError extends Error {
+ httpStatus?: number;
+ errorDetails?: any;
+ }
+ export interface StoreOptions {
+ inserted?: (values: Object, key: any) => void;
+ inserting?: (values: Object) => void;
+ loaded?: (result: Array<any>) => void;
+ loading?: (loadOptions: LoadOptions) => void;
+ modified?: () => void;
+ modifying?: () => void;
+ removed?: (key: any) => void;
+ removing?: (key: any) => void;
+ updated?: (key: any, values: Object) => void;
+ updating?: (key: any, values: Object) => void;
+ /** A handler for the modified event. */
+ onModified?: () => void;
+ /** A handler for the modifying event. */
+ onModifying?: () => void;
+ /** A handler for the removed event. */
+ onRemoved?: (key: any) => void;
+ /** A handler for the removing event. */
+ onRemoving?: (key: any) => void;
+ /** A handler for the updated event. */
+ onUpdated?: (key: any, values: Object) => void;
+ /** A handler for the updating event. */
+ onUpdating?: (key: any, values: Object) => void;
+ /** A handler for the loaded event. */
+ onLoaded?: (result: Array<any>) => void;
+ /** A handler for the loading event. */
+ onLoading?: (loadOptions: LoadOptions) => void;
+ /** A handler for the inserted event. */
+ onInserted?: (values: Object, key: any) => void;
+ /** A handler for the inserting event. */
+ onInserting?: (values: Object) => void;
+ /** Specifies the function called when the Store causes an error. */
+ errorHandler?: (e: Error) => void;
+ /** Specifies the key properties within the data associated with the Store. */
+ key?: any;
+ }
+ export interface LoadOptions {
+ filter?: Object;
+ sort?: Object;
+ select?: Object;
+ expand?: Object;
+ group?: Object;
+ skip?: number;
+ take?: number;
+ userData?: Object;
+ requireTotalCount?: boolean;
+ }
+ /** The base class for all Stores. */
+ export class Store implements EventsMixin<Store> {
+ inserted: JQueryCallback;
+ inserting: JQueryCallback;
+ loaded: JQueryCallback;
+ loading: JQueryCallback;
+ modified: JQueryCallback;
+ modifying: JQueryCallback;
+ removed: JQueryCallback;
+ removing: JQueryCallback;
+ updated: JQueryCallback;
+ updating: JQueryCallback;
+ constructor(options?: StoreOptions);
+ /** Returns the data item specified by the key. */
+ byKey(key: any): JQueryPromise<any>;
+ /** Adds an item to the data associated with this Store. */
+ insert(values: Object): JQueryPromise<any>;
+ /** Returns the key expression specified via the key configuration option. */
+ key(): any;
+ /** Returns the key of the Store item that matches the specified object. */
+ keyOf(obj: Object): any;
+ /** Starts loading data. */
+ load(obj?: LoadOptions): JQueryPromise<any[]>;
+ /** Removes the data item specified by the key. */
+ remove(key: any): JQueryPromise<any>;
+ /** Obtains the total count of items that will be returned by the load() function. */
+ totalCount(options?: {
+ filter?: Object;
+ group?: Object;
+ }): JQueryPromise<any>;
+ /** Updates the data item specified by the key. */
+ update(key: any, values: Object): JQueryPromise<any>;
+ on(eventName: "removing", eventHandler: (key: any) => void): Store;
+ on(eventName: "removed", eventHandler: (key: any) => void): Store;
+ on(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store;
+ on(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store;
+ on(eventName: "inserting", eventHandler: (values: Object) => void): Store;
+ on(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store;
+ on(eventName: "modifying", eventHandler: () => void): Store;
+ on(eventName: "modified", eventHandler: () => void): Store;
+ on(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store;
+ on(eventName: "loaded", eventHandler: (result: Array<any>) => void): Store;
+ on(eventName: string, eventHandler: Function): Store;
+ on(events: { [eventName: string]: Function; }): Store;
+ off(eventName: "removing"): Store;
+ off(eventName: "removed"): Store;
+ off(eventName: "updating"): Store;
+ off(eventName: "updated"): Store;
+ off(eventName: "inserting"): Store;
+ off(eventName: "inserted"): Store;
+ off(eventName: "modifying"): Store;
+ off(eventName: "modified"): Store;
+ off(eventName: "loading"): Store;
+ off(eventName: "loaded"): Store;
+ off(eventName: string): Store;
+ off(eventName: "removing", eventHandler: (key: any) => void): Store;
+ off(eventName: "removed", eventHandler: (key: any) => void): Store;
+ off(eventName: "updating", eventHandler: (key: any, values: Object) => void): Store;
+ off(eventName: "updated", eventHandler: (key: any, values: Object) => void): Store;
+ off(eventName: "inserting", eventHandler: (values: Object) => void): Store;
+ off(eventName: "inserted", eventHandler: (values: Object, key: any) => void): Store;
+ off(eventName: "modifying", eventHandler: () => void): Store;
+ off(eventName: "modified", eventHandler: () => void): Store;
+ off(eventName: "loading", eventHandler: (loadOptions: LoadOptions) => void): Store;
+ off(eventName: "loaded", eventHandler: (result: Array<any>) => void): Store;
+ off(eventName: string, eventHandler: Function): Store;
+ }
+ export interface ArrayStoreOptions extends StoreOptions {
+ /** Specifies the array associated with this Store. */
+ data?: Array<any>;
+ }
+ /** A Store accessing an in-memory array. */
+ export class ArrayStore extends Store {
+ constructor(options?: ArrayStoreOptions);
+ /** Clears all data associated with the current ArrayStore. */
+ clear(): void;
+ /** Creates the Query object for the underlying array. */
+ createQuery(): Query;
+ }
+ interface Promise {
+ then(doneFn?: Function, failFn?: Function, progressFn?: Function): Promise;
+ }
+ export interface CustomStoreOptions extends StoreOptions {
+ /** The user implementation of the byKey(key, extraOptions) method. */
+ byKey?: (key: any) => Promise;
+ /** The user implementation of the insert(values) method. */
+ insert?: (values: Object) => Promise;
+ /** The user implementation of the load(options) method. */
+ load?: (options?: LoadOptions) => Promise;
+ /** The user implementation of the remove(key) method. */
+ remove?: (key: any) => Promise;
+ /** The user implementation of the totalCount(options) method. */
+ totalCount?: (options?: {
+ filter?: Object;
+ group?: Object;
+ }) => Promise;
+ /** The user implementation of the update(key, values) method. */
+ update?: (key: any, values: Object) => Promise;
+ }
+ /** A Store object that enables you to implement your own data access logic. */
+ export class CustomStore extends Store {
+ constructor(options: CustomStoreOptions);
+ }
+ export interface DataSourceOptions {
+ /** Specifies data filtering conditions. */
+ filter?: Object;
+ /** Specifies data grouping conditions. */
+ group?: Object;
+ /** The item mapping function. */
+ map?: (record: any) => any;
+ /** Specifies the maximum number of items the page can contain. */
+ pageSize?: number;
+ /** Specifies whether a DataSource loads data by pages, or all items at once. */
+ paginate?: boolean;
+ /** The data post processing function. */
+ postProcess?: (data: any[]) => any[];
+ /** Specifies a value by which the required items are searched. */
+ searchExpr?: Object;
+ /** Specifies the comparison operation used to search for the required items. */
+ searchOperation?: string;
+ /** Specifies the value to which the search expression is compared. */
+ searchValue?: Object;
+ /** Specifies the initial select option value. */
+ select?: Object;
+ /** An array of the strings that represent the names of the navigation properties to be loaded simultaneously with the OData store's entity. */
+ expand?: Object;
+ /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */
+ requireTotalCount?: boolean;
+ /** Specifies the initial sort option value. */
+ sort?: Object;
+ /** Specifies the underlying Store instance used to access data. */
+ store?: any;
+ /** A handler for the changed event. */
+ onChanged?: () => void;
+ /** A handler for the loadingChanged event. */
+ onLoadingChanged?: (isLoading: boolean) => void;
+ /** A handler for the loadError event. */
+ onLoadError?: (e?: Error) => void;
+ }
+ /** An object that provides access to a data web service or local data storage for collection container widgets. */
+ export class DataSource implements EventsMixin<DataSource> {
+ constructor(options?: DataSourceOptions);
+ changed: JQueryCallback;
+ loadError: JQueryCallback;
+ loadingChanged: JQueryCallback;
+ /** Disposes all resources associated with this DataSource. */
+ dispose(): void;
+ /** Returns the current filter option value. */
+ filter(): Object;
+ /** Sets the filter option value. */
+ filter(filterExpr: Object): void;
+ /** Returns the current group option value. */
+ group(): Object;
+ /** Sets the group option value. */
+ group(groupExpr: Object): void;
+ /** Indicates whether or not the current page contains fewer items than the number of items specified by the pageSize configuration option. */
+ isLastPage(): boolean;
+ /** Indicates whether or not at least one load() method execution has successfully finished. */
+ isLoaded(): boolean;
+ /** Indicates whether or not the DataSource is currently being loaded. */
+ isLoading(): boolean;
+ /** Returns the array of items currently operated by the DataSource. */
+ items(): Array<any>;
+ /** Returns the key expression. */
+ key(): any;
+ /** Starts loading data. */
+ load(): JQueryPromise<Array<any>>;
+ /** Returns an object that would be passed to the load() method of the underlying Store according to the current data shaping option values of the current DataSource instance. */
+ loadOptions(): Object;
+ /** Returns the current pageSize option value. */
+ pageSize(): number;
+ /** Sets the pageSize option value. */
+ pageSize(value: number): void;
+ /** Specifies the index of the currently loaded page. */
+ pageIndex(): number;
+ /** Specifies the index of the page to be loaded during the next load() method execution. */
+ pageIndex(newIndex: number): void;
+ /** Returns the current paginate option value. */
+ paginate(): boolean;
+ /** Sets the paginate option value. */
+ paginate(value: boolean): void;
+ /** Returns the searchExpr option value. */
+ searchExpr(): Object;
+ /** Sets the searchExpr option value. */
+ searchExpr(expr: Object): void;
+ /** Returns the currently specified search operation. */
+ searchOperation(): string;
+ /** Sets the current search operation. */
+ searchOperation(op: string): void;
+ /** Returns the searchValue option value. */
+ searchValue(): Object;
+ /** Sets the searchValue option value. */
+ searchValue(value: Object): void;
+ /** Returns the current select option value. */
+ select(): Object;
+ /** Sets the select option value. */
+ select(expr: Object): void;
+ /** Returns the current requireTotalCount option value. */
+ requireTotalCount(): boolean;
+ /** Sets the requireTotalCount option value. */
+ requireTotalCount(value: boolean): void;
+ /** Returns the current sort option value. */
+ sort(): Object;
+ /** Sets the sort option value. */
+ sort(sortExpr: Object): void;
+ /** Returns the underlying Store instance. */
+ store(): Store;
+ /** Returns the number of data items available in an underlying Store after the last load() operation without paging. */
+ totalCount(): number;
+ on(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource;
+ on(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource;
+ on(eventName: "changed", eventHandler: () => void): DataSource;
+ on(eventName: string, eventHandler: Function): DataSource;
+ on(events: { [eventName: string]: Function; }): DataSource;
+ off(eventName: "loadingChanged"): DataSource;
+ off(eventName: "loadError"): DataSource;
+ off(eventName: "changed"): DataSource;
+ off(eventName: string): DataSource;
+ off(eventName: "loadingChanged", eventHandler: (isLoading: boolean) => void): DataSource;
+ off(eventName: "loadError", eventHandler: (e?: Error) => void): DataSource;
+ off(eventName: "changed", eventHandler: () => void): DataSource;
+ off(eventName: string, eventHandler: Function): DataSource;
+ }
+ /** An object used to work with primitive data types not supported by JavaScript when accessing an OData web service. */
+ export class EdmLiteral {
+ /** Creates an EdmLiteral instance and assigns the specified value to it. */
+ constructor(value: string);
+ /** Returns a string representation of the value associated with this EdmLiteral object. */
+ valueOf(): string;
+ }
+ /** An object used to generate and hold the GUID. */
+ export class Guid {
+ /** Creates a new Guid instance that holds the specified GUID. */
+ constructor(value: string);
+ /** Creates a new Guid instance holding the generated GUID. */
+ constructor();
+ /** Returns a string representation of the Guid instance. */
+ toString(): string;
+ /** Returns a string representation of the Guid instance. */
+ valueOf(): string;
+ }
+ export interface LocalStoreOptions extends ArrayStoreOptions {
+ /** Specifies the time (in miliseconds) after the change operation, before the data is flushed. */
+ flushInterval?: number;
+ /** Specifies whether the data is flushed immediatelly after each change operation, or after the delay specified via the flushInterval option. */
+ immediate?: boolean;
+ /** The unique identifier used to distinguish the data within the HTML5 Web Storage. */
+ name?: string;
+ }
+ /** A Store providing access to the HTML5 Web Storage. */
+ export class LocalStore extends ArrayStore {
+ constructor(options?: LocalStoreOptions);
+ /** Removes all data associated with this Store. */
+ clear(): void;
+ }
+ export interface ODataContextOptions extends ODataStoreOptions {
+ /** Specifies the list of entities to be accessed via the ODataContext. */
+ entities?: Object;
+ /** Specifies the function called if the ODataContext causes an error. */
+ errorHandler?: (e: Error) => void;
+ }
+ /** Provides access to the entire OData service. */
+ export class ODataContext {
+ constructor(options?: ODataContextOptions);
+ /** Initiates the specified WebGet service operation that returns a value. For the information on service operations, refer to the OData documentation. */
+ get(operationName: string, params: Object): JQueryPromise<any>;
+ /** Initiates the specified WebGet service operation that returns nothing. For the information on service operations, refer to the OData documentation. */
+ invoke(operationName: string, params: Object, httpMethod: Object): JQueryPromise<any>;
+ /** Return a special proxy object to describe the entity link. */
+ objectLink(entityAlias: string, key: any): Object;
+ }
+ export interface ODataStoreOptions extends StoreOptions {
+ /** A function used to customize a web request before it is sent. */
+ beforeSend?: (request: {
+ url: string;
+ method: string;
+ timeout: number;
+ params: Object;
+ payload: Object;
+ headers: Object;
+ }) => void;
+ /** Specifies whether the ODataStore uses the JSONP approach to access non-CORS-compatible remote services. */
+ jsonp?: boolean;
+ /** Specifies the type of the ODataStore key property. The following key types are supported out of the box: String, Int32, Int64, and Guid. */
+ keyType?: any;
+ /** Specifies the URL of the data service being accessed via the current ODataContext. */
+ url?: string;
+ /** Specifies the version of the OData protocol used to interact with the data service. */
+ version?: number;
+ /** Specifies the value of the withCredentials field of the underlying jqXHR object. */
+ withCredentials?: boolean;
+ }
+ /** A Store providing access to a separate OData web service entity. */
+ export class ODataStore extends Store {
+ constructor(options?: ODataStoreOptions);
+ /** Creates the Query object for the OData endpoint. */
+ createQuery(loadOptions: Object): Object;
+ /** Returns the data item specified by the key. */
+ byKey(key: any, extraOptions?: { expand?: Object }): JQueryPromise<any>;
+ }
+ /** An universal chainable data query interface object. */
+ export interface Query {
+ /** Calculates a custom summary for the items in the current Query. */
+ aggregate(step: (accumulator: any, value: any) => any): JQueryPromise<any>;
+ /** Calculates a custom summary for the items in the current Query. */
+ aggregate(seed: any, step: (accumulator: any, value: any) => any, finalize: (result: any) => any): JQueryPromise<any>;
+ /** Calculates the average item value for the current Query. */
+ avg(getter: Object): JQueryPromise<any>;
+ /** Finds the item with the maximum getter value. */
+ max(getter: Object): JQueryPromise<any>;
+ /** Finds the item with the maximum value in the Query. */
+ max(): JQueryPromise<any>;
+ /** Finds the item with the minimum value in the Query. */
+ min(): JQueryPromise<any>;
+ /** Finds the item with the minimum getter value. */
+ min(getter: Object): JQueryPromise<any>;
+ /** Calculates the average item value for the current Query, if each Query item has a numeric type. */
+ avg(): JQueryPromise<any>;
+ /** Returns the total count of items in the current Query. */
+ count(): JQueryPromise<any>;
+ /** Executes the Query. */
+ enumerate(): JQueryPromise<any>;
+ /** Filters the current Query data. */
+ filter(criteria: Array<any>): Query;
+ /** Groups the current Query data. */
+ groupBy(getter: Object): Query;
+ /** Applies the specified transformation to each item. */
+ select(getter: Object): Query;
+ /** Limits the data item count. */
+ slice(skip: number, take?: number): Query;
+ /** Sorts current Query data. */
+ sortBy(getter: Object, desc: boolean): Query;
+ /** Sorts current Query data. */
+ sortBy(getter: Object): Query;
+ /** Calculates the sum of item getter values in the current Query. */
+ sum(getter: Object): JQueryPromise<any>;
+ /** Calculates the sum of item values in the current Query. */
+ sum(): JQueryPromise<any>;
+ /** Adds one more sorting condition to the current Query. */
+ thenBy(getter: Object): Query;
+ /** Adds one more sorting condition to the current Query. */
+ thenBy(getter: Object, desc: boolean): Query;
+ /** Returns the array of current Query items. */
+ toArray(): Array<any>;
+ }
+ /** The global data layer error handler. */
+ export var errorHandler: (e: Error) => void;
+ /** Encodes the specified string or array of bytes to base64 encoding. */
+ export function base64_encode(input: any): string;
+ /** Creates a Query instance. */
+ export function query(array: Array<any>): Query;
+ /** Creates a Query instance for accessing the remote service specified by a URL. */
+ export function query(url: string, queryOptions: Object): Query;
+ /** This section describes the utility objects provided by the DevExtreme data layer. */
+ export var utils: {
+ /** Compiles a getter function from the getter expression. */
+ compileGetter(expr: any): Function;
+ /** Compiles a setter function from the setter expression. */
+ compileSetter(expr: any): Function;
+ odata: {
+ /** Holds key value converters for OData. */
+ keyConverters: {
+ String(value: any): string;
+ Int32(value: any): number;
+ Int64(value: any): EdmLiteral;
+ Guid(value: any): Guid;
+ Boolean(value: any): boolean;
+ Single(value: any): EdmLiteral;
+ Decimal(value: any): EdmLiteral;
+ };
+ }
+ }
+ }
+ /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */
+ export module ui {
+ export interface WidgetOptions extends DOMComponentOptions {
+ /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */
+ activeStateEnabled?: boolean;
+ /** A Boolean value specifying whether or not the widget can respond to user interaction. */
+ disabled?: boolean;
+ /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */
+ hoverStateEnabled?: boolean;
+ /** Specifies whether or not the widget can be focused. */
+ focusStateEnabled?: boolean;
+ /** Specifies a shortcut key that sets focus on the widget element. */
+ accessKey?: string;
+ /** A Boolean value specifying whether or not the widget is visible. */
+ visible?: boolean;
+ /** Specifies the widget tab index. */
+ tabIndex?: number;
+ /** Specifies the text of the hint displayed for the widget. */
+ hint?: string;
+ }
+ /** The base class for widgets. */
+ export class Widget extends DOMComponent {
+ constructor(options?: WidgetOptions);
+ /** Redraws the widget. */
+ repaint(): void;
+ /** Sets focus on the widget. */
+ focus(): void;
+ /** Registers a handler when a specified key is pressed. */
+ registerKeyHandler(key: string, handler: Function): void;
+ }
+ export interface CollectionWidgetOptions extends WidgetOptions {
+ /** A data source used to fetch data to be displayed by the widget. */
+ dataSource?: any;
+ itemClickAction?: any;
+ itemHoldAction?: Function;
+ /** The time period in milliseconds before the onItemHold event is raised. */
+ itemHoldTimeout?: number;
+ itemRender?: any;
+ itemRenderedAction?: Function;
+ /** An array of items displayed by the widget. */
+ items?: Array<any>;
+ /**
+ * A function performed when a widget item is selected.
+ * @deprecated onSelectionChanged.md
+ */
+ itemSelectAction?: Function;
+ /** The template to be used for rendering items. */
+ itemTemplate?: any;
+ loopItemFocus?: boolean;
+ /** The text or HTML markup displayed by the widget if the item collection is empty. */
+ noDataText?: string;
+ onContentReady?: any;
+ contentReadyAction?: any;
+ /** A handler for the itemClick event. */
+ onItemClick?: any;
+ /** A handler for the itemContextMenu event. */
+ onItemContextMenu?: Function;
+ /** A handler for the itemHold event. */
+ onItemHold?: Function;
+ /** A handler for the itemRendered event. */
+ onItemRendered?: Function;
+ /** A handler for the selectionChanged event. */
+ onSelectionChanged?: Function;
+ /** The index of the currently selected widget item. */
+ selectedIndex?: number;
+ /** The selected item object. */
+ selectedItem?: Object;
+ /** An array of currently selected item objects. */
+ selectedItems?: Array<any>;
+ /** A handler for the itemDeleting event. */
+ onItemDeleting?: Function;
+ /** A handler for the itemDeleted event. */
+ onItemDeleted?: Function;
+ /** A handler for the itemReordered event. */
+ onItemReordered?: Function;
+ }
+ /** The base class for widgets containing an item collection. */
+ export class CollectionWidget extends Widget {
+ constructor(element: JQuery, options?: CollectionWidgetOptions);
+ constructor(element: HTMLElement, options?: CollectionWidgetOptions);
+ selectItem(itemElement: any): void;
+ unselectItem(itemElement: any): void;
+ deleteItem(itemElement: any): JQueryPromise<void>;
+ isItemSelected(itemElement: any): boolean;
+ reorderItem(itemElement: any, toItemElement: any): JQueryPromise<void>;
+ }
+ export interface DataExpressionMixinOptions {
+ /** A data source used to fetch data to be displayed by the widget. */
+ dataSource?: any;
+ /** Specifies the name of the data source item field whose value is displayed by the widget. */
+ displayExpr?: any;
+ /** Specifies the name of a data source item field whose value is held in the value configuration option. */
+ valueExpr?: any;
+ itemRender?: any;
+ /** An array of items displayed by the widget. */
+ items?: Array<any>;
+ /** The template to be used for rendering items. */
+ itemTemplate?: any;
+ /** The currently selected value in the widget. */
+ value?: Object;
+ }
+ export interface EditorOptions extends WidgetOptions {
+ /** The currently specified value. */
+ value?: Object;
+ /** A handler for the valueChanged event. */
+ onValueChanged?: Function;
+ valueChangeAction?: Function;
+ /** A Boolean value specifying whether or not the widget is read-only. */
+ readOnly?: boolean;
+ /** Holds the object that defines the error that occurred during validation. */
+ validationError?: Object;
+ /** Specifies whether the editor's value is valid. */
+ isValid?: boolean;
+ /** Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */
+ validationMessageMode?: string;
+ }
+ /** A base class for editors. */
+ export class Editor extends Widget {
+ /** Resets the editor's value to undefined. */
+ reset(): void;
+ }
+ /** An object that serves as a namespace for methods displaying a message in an application/site. */
+ export var dialog: {
+ /** Creates an alert dialog message containing a single "OK" button. */
+ alert(message: string, title: string): JQueryPromise<void>;
+ /** Creates a confirm dialog that contains "Yes" and "No" buttons. */
+ confirm(message: string, title: string): JQueryPromise<boolean>;
+ /** Creates a custom dialog using the options specified by the passed configuration object. */
+ custom(options: { title?: string; message?: string; buttons?: Array<Object>; }): {
+ show(): JQueryPromise<any>;
+ hide(): void;
+ hide(value: any): void;
+ };
+ };
+ /** Creates a toast message. */
+ export function notify(message: any, type: string, displayTime: number): void;
+ /** Creates a toast message. */
+ export function notify(options: Object): void;
+ /** An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */
+ export var themes: {
+ /** Returns the name of the currently applied theme. */
+ current(): string;
+ /** Changes the current theme to the specified one. */
+ current(themeName: string): void;
+ };
+ /** Sets a specified template engine. */
+ export function setTemplateEngine(name: string): void;
+ /** Sets a custom template engine defined via custom compile and render functions. */
+ export function setTemplateEngine(options: Object): void;
+ }
+ /** An object that serves as a namespace for utility methods that can be helpful when working with the DevExtreme framework and UI widgets. */
+ export var utils: {
+ /** Sets parameters for the viewport meta tag. */
+ initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean }): void;
+ };
+ /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */
+ export module viz {
+ /** Applies a theme for the entire page with several DevExtreme visualization widgets. */
+ export function currentTheme(theme: string): void;
+ /** Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets. */
+ export function currentTheme(platform: string, colorScheme: string): void;
+ /** Registers a new theme based on the existing one. */
+ export function registerTheme(customTheme: Object, baseTheme: string): void;
+ /** Applies a predefined or registered custom palette to all visualization widgets at once. */
+ export function currentPalette(paletteName: string): void;
+ /** Obtains the color sets of a predefined or registered palette. */
+ export function getPalette(paletteName: string): Object;
+ /** Registers a new palette. */
+ export function registerPalette(paletteName: string, palette: Object): void;
+ }
+}
+declare module DevExpress.ui {
+ export interface dxValidatorOptions extends DOMComponentOptions {
+ /** An array of validation rules to be checked for the editor with which the dxValidator object is associated. */
+ validationRules?: Array<any>;
+ /** Specifies the editor name to be used in the validation default messages. */
+ name?: string;
+ /** An object that specifies what and when to validate and how to apply the validation result. */
+ adapter?: Object;
+ /** Specifies the validation group the editor will be related to. */
+ validationGroup?: string;
+ /** A handler for the validated event. */
+ onValidated?: (params: validationEngine.ValidatorValidationResult) => void;
+ }
+ /** A widget that is used to validate the associated DevExtreme editors against the defined validation rules. */
+ export class dxValidator extends DOMComponent implements validationEngine.IValidator {
+ constructor(element: JQuery, options?: dxValidatorOptions);
+ constructor(element: Element, options?: dxValidatorOptions);
+ /** Validates the value of the editor that is controlled by the current dxValidator object against the list of the specified validation rules. */
+ validate(): validationEngine.ValidatorValidationResult;
+ /** Resets the value and validation result of the editor associated with the current dxValidator object. */
+ reset(): void;
+ }
+ /** The widget that is used in the Knockout and Angular approaches to combine the editors to be validated. */
+ export class dxValidationGroup extends DOMComponent {
+ constructor(element: JQuery);
+ constructor(element: Element);
+ /** Validates rules of the validators that belong to the current validation group. */
+ validate(): validationEngine.ValidationGroupValidationResult;
+ /** Resets the value and validation result of the editors that are included to the current validation group. */
+ reset(): void;
+ }
+ export interface dxValidationSummaryOptions extends CollectionWidgetOptions {
+ /** Specifies the validation group for which summary should be generated. */
+ validationGroup?: string;
+ }
+ /** A widget for displaying the result of checking validation rules for editors. */
+ export class dxValidationSummary extends CollectionWidget {
+ constructor(element: JQuery, options?: dxValidationSummaryOptions);
+ constructor(element: Element, options?: dxValidationSummaryOptions);
+ }
+ export interface dxResizableOptions extends DOMComponentOptions {
+ /** Specifies which borders of the widget element are used as a handle. */
+ handles?: string;
+ /** Specifies the lower width boundary for resizing. */
+ minWidth?: number;
+ /** Specifies the upper width boundary for resizing. */
+ maxWidth?: number;
+ /** Specifies the lower height boundary for resizing. */
+ minHeight?: number;
+ /** Specifies the upper height boundary for resizing. */
+ maxHeight?: number;
+ /** A handler for the resizeStart event. */
+ onResizeStart?: Function;
+ /** A handler for the resize event. */
+ onResize?: Function;
+ /** A handler for the resizeEnd event. */
+ onResizeEnd?: Function;
+ }
+ /** A widget that displays required content in a resizable element. */
+ export class dxResizable extends DOMComponent {
+ constructor(element: JQuery, options?: dxResizableOptions);
+ constructor(element: Element, options?: dxResizableOptions);
+ }
+ export interface dxTooltipOptions extends dxPopoverOptions {
+ }
+ /** A tooltip widget. */
+ export class dxTooltip extends dxPopover {
+ constructor(element: JQuery, options?: dxTooltipOptions);
+ constructor(element: Element, options?: dxTooltipOptions);
+ }
+ export interface dxDropDownListOptions extends dxDropDownEditorOptions, DataExpressionMixinOptions {
+ /** Returns the value currently displayed by the widget. */
+ displayValue?: string;
+ /** The minimum number of characters that must be entered into the text box to begin a search. */
+ minSearchLength?: number;
+ /** Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */
+ searchExpr?: Object;
+ /** Specifies the binary operation used to filter data. */
+ searchMode?: string;
+ /** Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */
+ searchTimeout?: number;
+ /** A handler for the valueChanged event. */
+ onValueChanged?: Function;
+ /** Specifies DOM event names that update a widget's value. */
+ valueChangeEvent?: string;
+ /** Specifies whether or not the widget supports searching. */
+ searchEnabled?: boolean;
+ /**
+ * Specifies whether or not the widget displays items by pages.
+ * @deprecated dataSource.paginate.md
+ */
+ pagingEnabled?: boolean;
+ /** The text or HTML markup displayed by the widget if the item collection is empty. */
+ noDataText?: string;
+ /** A handler for the selectionChanged event. */
+ onSelectionChanged?: Function;
+ /** A handler for the itemClick event. */
+ onItemClick?: Function;
+ onContentReady?: Function;
+ }
+ /** A base class for drop-down list widgets. */
+ export class dxDropDownList extends dxDropDownEditor {
+ constructor(element: JQuery, options?: dxDropDownListOptions);
+ constructor(element: Element, options?: dxDropDownListOptions);
+ }
+ export interface dxToolbarOptions extends CollectionWidgetOptions {
+ menuItemRender?: any;
+ /** The template used to render menu items. */
+ menuItemTemplate?: any;
+ /** Informs the widget about its location in a view HTML markup. */
+ renderAs?: string;
+ }
+ /** A toolbar widget. */
+ export class dxToolbar extends CollectionWidget {
+ constructor(element: JQuery, options?: dxToolbarOptions);
+ constructor(element: Element, options?: dxToolbarOptions);
+ }
+ export interface dxToastOptions extends dxOverlayOptions {
+ animation?: fx.AnimationOptions;
+ /** The time span in milliseconds during which the dxToast widget is visible. */
+ displayTime?: number;
+ height?: any;
+ /** The dxToast message text. */
+ message?: string;
+ position?: PositionOptions;
+ shading?: boolean;
+ /** Specifies the dxToast widget type. */
+ type?: string;
+ width?: any;
+ closeOnBackButton?: boolean;
+ }
+ /** The toast message widget. */
+ export class dxToast extends dxOverlay {
+ constructor(element: JQuery, options?: dxToastOptions);
+ constructor(element: Element, options?: dxToastOptions);
+ }
+ export interface dxTextEditorOptions extends EditorOptions {
+ /** A handler for the change event. */
+ onChange?: Function;
+ changeAction?: Function;
+ /** A handler for the copy event. */
+ onCopy?: Function;
+ copyAction?: Function;
+ /** A handler for the cut event. */
+ onCut?: Function;
+ cutAction?: Function;
+ /** A handler for the enterKey event. */
+ onEnterKey?: Function;
+ enterKeyAction?: Function;
+ /** A handler for the focusIn event. */
+ onFocusIn?: Function;
+ focusInAction?: Function;
+ /** A handler for the focusOut event. */
+ onFocusOut?: Function;
+ focusOutAction?: Function;
+ /** A handler for the input event. */
+ onInput?: Function;
+ inputAction?: Function;
+ /** A handler for the keyDown event. */
+ onKeyDown?: Function;
+ keyDownAction?: Function;
+ /** A handler for the keyPress event. */
+ onKeyPress?: Function;
+ keyPressAction?: Function;
+ /** A handler for the keyUp event. */
+ onKeyUp?: Function;
+ keyUpAction?: Function;
+ /** A handler for the paste event. */
+ onPaste?: Function;
+ pasteAction?: Function;
+ /** The text displayed by the widget when the widget value is empty. */
+ placeholder?: string;
+ /** Specifies whether to display the Clear button in the widget. */
+ showClearButton?: boolean;
+ /** Specifies the current value displayed by the widget. */
+ value?: any;
+ /** Specifies DOM event names that update a widget's value. */
+ valueChangeEvent?: string;
+ /** Specifies whether or not the widget checks the inner text for spelling mistakes. */
+ spellcheck?: boolean;
+ /** Specifies HTML attributes applied to the inner input element of the widget. */
+ attr?: Object;
+ /** The read-only option that holds the text displayed by the widget input element. */
+ text?: string;
+ /** Specifies whether or not the widget supports the focused state and keyboard navigation. */
+ focusStateEnabled?: boolean;
+ /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */
+ hoverStateEnabled?: boolean;
+ /** The editor mask that specifies the format of the entered string. */
+ mask?: string;
+ /** Specifies a mask placeholder character. */
+ maskChar?: string;
+ /** Specifies custom mask rules. */
+ maskRules?: Object;
+ /** A message displayed when the entered text does not match the specified pattern. */
+ maskInvalidMessage?: string;
+ }
+ /** A base class for text editing widgets. */
+ export class dxTextEditor extends Editor {
+ constructor(element: JQuery, options?: dxTextEditorOptions);
+ constructor(element: Element, options?: dxTextEditorOptions);
+ /** Removes focus from the input element. */
+ blur(): void;
+ /** Sets focus to the input element representing the widget. */
+ focus(): void;
+ }
+ export interface dxTextBoxOptions extends dxTextEditorOptions {
+ /** Specifies the maximum number of characters you can enter into the textbox. */
+ maxLength?: any;
+ /** The "mode" attribute value of the actual HTML input element representing the text box. */
+ mode?: string;
+ }
+ /** A single-line text box widget. */
+ export class dxTextBox extends dxTextEditor {
+ constructor(element: JQuery, options?: dxTextBoxOptions);
+ constructor(element: Element, options?: dxTextBoxOptions);
+ }
+ export interface dxTextAreaOptions extends dxTextBoxOptions {
+ /** Specifies whether or not the widget checks the inner text for spelling mistakes. */
+ spellcheck?: boolean;
+ }
+ /** A widget used to display and edit multi-line text. */
+ export class dxTextArea extends dxTextBox {
+ constructor(element: JQuery, options?: dxTextAreaOptions);
+ constructor(element: Element, options?: dxTextAreaOptions);
+ }
+ export interface dxTabsOptions extends CollectionWidgetOptions {
+ /** Specifies whether the widget enables an end-user to select only a single item or multiple items. */
+ selectionMode?: string;
+ /** Specifies whether or not an end-user can scroll tabs by swiping. */
+ scrollByContent?: boolean;
+ /** Specifies whether or not an end-user can scroll tabs. */
+ scrollingEnabled?: boolean;
+ /** A Boolean value that specifies the availability of navigation buttons. */
+ showNavButtons?: boolean;
+ }
+ /** A tab strip used to switch between pages. */
+ export class dxTabs extends CollectionWidget {
+ constructor(element: JQuery, options?: dxTabsOptions);
+ constructor(element: Element, options?: dxTabsOptions);
+ }
+ export interface dxTabPanelOptions extends dxMultiViewOptions {
+ /** A handler for the titleClick event. */
+ onTitleClick?: any;
+ /** A handler for the titleHold event. */
+ onTitleHold?: Function;
+ /** A handler for the titleRendered event. */
+ onTitleRendered?: Function;
+ titleTemplate?: any;
+ /** The template to be used for rendering an item title. */
+ itemTitleTemplate?: any;
+ }
+ /** A widget used to display a view and to switch between several views by clicking the appropriate tabs. */
+ export class dxTabPanel extends dxMultiView {
+ constructor(element: JQuery, options?: dxTabPanelOptions);
+ constructor(element: Element, options?: dxTabPanelOptions);
+ }
+ export interface dxSelectBoxOptions extends dxDropDownListOptions {
+ /** The template to be used for rendering the widget text field. */
+ fieldTemplate?: any;
+ /** The text that is provided as a hint in the select box editor. */
+ placeholder?: string;
+ /** Specifies whether or not the widget allows an end-user to enter a custom value. */
+ fieldEditEnabled?: boolean;
+ }
+ /** A widget that allows you to select an item in a dropdown list. */
+ export class dxSelectBox extends dxDropDownList {
+ constructor(element: JQuery, options?: dxSelectBoxOptions);
+ constructor(element: Element, options?: dxSelectBoxOptions);
+ }
+ export interface dxTagBoxOptions extends dxSelectBoxOptions {
+ /** Holds the list of selected values. */
+ values?: Array<any>;
+ }
+ /** A widget that allows you to select multiple items from a dropdown list. */
+ export class dxTagBox extends dxSelectBox {
+ constructor(element: JQuery, options?: dxTagBoxOptions);
+ constructor(element: Element, options?: dxTagBoxOptions);
+ }
+ export interface dxScrollViewOptions extends dxScrollableOptions {
+ /** A handler for the pullDown event. */
+ onPullDown?: Function;
+ pullDownAction?: Function;
+ /** Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */
+ pulledDownText?: string;
+ /** Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */
+ pullingDownText?: string;
+ /** A handler for the reachBottom event. */
+ onReachBottom?: Function;
+ reachBottomAction?: Function;
+ /** Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */
+ reachBottomText?: string;
+ /** Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */
+ refreshingText?: string;
+ /** Returns a value indicating if the scrollView content is larger then the widget container. */
+ isFull(): boolean;
+ /** Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event. */
+ refresh(): void;
+ /** Notifies the scroll view that data loading is finished. */
+ release(preventScrollBottom: boolean): JQueryPromise<void>;
+ /** Toggles the loading state of the widget. */
+ toggleLoading(showOrHide: boolean): void;
+ }
+ /** A widget used to display scrollable content. */
+ export class dxScrollView extends dxScrollable {
+ constructor(element: JQuery, options?: dxScrollViewOptions);
+ constructor(element: Element, options?: dxScrollViewOptions);
+ }
+ export interface dxScrollableLocation {
+ top?: number;
+ left?: number;
+ }
+ export interface dxScrollableOptions extends DOMComponentOptions {
+ /** A string value specifying the available scrolling directions. */
+ direction?: string;
+ /** A Boolean value specifying whether or not the widget can respond to user interaction. */
+ disabled?: boolean;
+ /** A handler for the scroll event. */
+ onScroll?: Function;
+ scrollAction?: Function;
+ /** Specifies when the widget shows the scrollbar. */
+ showScrollbar?: string;
+ /** A handler for the update event. */
+ onUpdated?: Function;
+ updateAction?: Function;
+ /** Indicates whether to use native or simulated scrolling. */
+ useNative?: boolean;
+ /** A Boolean value specifying whether to enable or disable the bounce-back effect. */
+ bounceEnabled?: boolean;
+ /** A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. */
+ scrollByContent?: boolean;
+ /** A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar. */
+ scrollByThumb?: boolean;
+ }
+ /** A widget used to display scrollable content. */
+ export class dxScrollable extends DOMComponent {
+ constructor(element: JQuery, options?: dxScrollableOptions);
+ constructor(element: Element, options?: dxScrollableOptions);
+ /** Returns the height of the scrollable widget in pixels. */
+ clientHeight(): number;
+ /** Returns the width of the scrollable widget in pixels. */
+ clientWidth(): number;
+ /** Returns an HTML element of the widget. */
+ content(): JQuery;
+ /** Scrolls the widget content by the specified number of pixels. */
+ scrollBy(distance: number): void;
+ /** Scrolls widget content by the specified number of pixels in horizontal and vertical directions. */
+ scrollBy(distanceObject: dxScrollableLocation): void;
+ /** Returns the height of the scrollable content in pixels. */
+ scrollHeight(): number;
+ /** Returns the current scroll position against the leftmost position. */
+ scrollLeft(): number;
+ /** Returns how far the scrollable content is scrolled from the top and from the left. */
+ scrollOffset(): dxScrollableLocation;
+ /** Scrolls widget content to the specified position. */
+ scrollTo(targetLocation: number): void;
+ /** Scrolls widget content to a specified position. */
+ scrollTo(targetLocation: dxScrollableLocation): void;
+ /** Scrolls widget content to the specified element. */
+ scrollToElement(element: Element): void;
+ /** Returns the current scroll position against the topmost position. */
+ scrollTop(): number;
+ /** Returns the width of the scrollable content in pixels. */
+ scrollWidth(): number;
+ /** Updates the dimensions of the scrollable contents. */
+ update(): void;
+ }
+ export interface dxRadioGroupOptions extends CollectionWidgetOptions, DataExpressionMixinOptions {
+ /** Specifies the radio group layout. */
+ layout?: string;
+ }
+ /** A widget that enables a user to select one item within a list of items represented by radio buttons. */
+ export class dxRadioGroup extends CollectionWidget {
+ constructor(element: JQuery, options?: dxRadioGroupOptions);
+ constructor(element: Element, options?: dxRadioGroupOptions);
+ }
+ export interface dxPopupOptions extends dxOverlayOptions {
+ animation?: fx.AnimationOptions;
+ /** Specifies whether or not to allow a user to drag the popup window. */
+ dragEnabled?: boolean;
+ /** A Boolean value specifying whether or not to display the widget in full-screen mode. */
+ fullScreen?: boolean;
+ position?: PositionOptions;
+ /** A Boolean value specifying whether or not to display the title in the popup window. */
+ showTitle?: boolean;
+ /** The title in the overlay window. */
+ title?: string;
+ /** A template to be used for rendering the widget title. */
+ titleTemplate?: any;
+ width?: any;
+ /** Specifies items displayed on the top or bottom toolbar of the popup window. */
+ buttons?: Array<any>;
+ /** Specifies whether or not the widget displays the Close button. */
+ showCloseButton?: boolean;
+ /** A handler for the titleRendered event. */
+ onTitleRendered?: Function;
+ }
+ /** A widget that displays required content in a popup window. */
+ export class dxPopup extends dxOverlay {
+ constructor(element: JQuery, options?: dxPopupOptions);
+ constructor(element: Element, options?: dxPopupOptions);
+ }
+ export interface dxPopoverOptions extends dxPopupOptions {
+ /** An object defining animation options of the widget. */
+ animation?: fx.AnimationOptions;
+ /** Specifies the height of the widget. */
+ height?: any;
+ /** An object defining widget positioning options. */
+ position?: PositionOptions;
+ shading?: boolean;
+ /** A Boolean value specifying whether or not to display the title in the overlay window. */
+ showTitle?: boolean;
+ /** The target element associated with a popover. */
+ target?: any;
+ /** Specifies the width of the widget. */
+ width?: any;
+ }
+ /** A widget that displays the required content in a popup window. */
+ export class dxPopover extends dxPopup {
+ constructor(element: JQuery, options?: dxPopoverOptions);
+ constructor(element: Element, options?: dxPopoverOptions);
+ /** Displays the widget for the specified target element. */
+ show(target?: any): JQueryPromise<void>;
+ }
+ export interface dxOverlayOptions extends WidgetOptions {
+ /** An object that defines the animation options of the widget. */
+ animation?: fx.AnimationOptions;
+ /** A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button. */
+ closeOnBackButton?: boolean;
+ /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window. */
+ closeOnOutsideClick?: any;
+ /** A template to be used for rendering widget content. */
+ contentTemplate?: any;
+ /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */
+ deferRendering?: boolean;
+ /** Specifies whether or not an end-user can drag the widget. */
+ dragEnabled?: boolean;
+ /** Specifies whether or not an end user can resize the widget. */
+ resizeEnabled?: boolean;
+ /** The height of the widget in pixels. */
+ height?: any;
+ /** A handler for the hidden event. */
+ onHidden?: Function;
+ hiddenAction?: Function;
+ /** A handler for the hiding event. */
+ onHiding?: Function;
+ hidingAction?: Function;
+ /** An object defining widget positioning options. */
+ position?: PositionOptions;
+ /** A Boolean value specifying whether or not the main screen is inactive while the widget is active. */
+ shading?: boolean;
+ /** Specifies the shading color. */
+ shadingColor?: string;
+ /** A handler for the showing event. */
+ onShowing?: Function;
+ showingAction?: Function;
+ /** A handler for the shown event. */
+ onShown?: Function;
+ shownAction?: Function;
+ /** A Boolean value specifying whether or not the widget is visible. */
+ visible?: boolean;
+ /** The widget width in pixels. */
+ width?: any;
+ }
+ /** A widget displaying the required content in an overlay window. */
+ export class dxOverlay extends Widget {
+ constructor(element: JQuery, options?: dxOverlayOptions);
+ constructor(element: Element, options?: dxOverlayOptions);
+ /** An HTML element of the widget. */
+ content(): JQuery;
+ /** Hides the widget. */
+ hide(): JQueryPromise<void>;
+ /** Recalculates the overlay's size and position. */
+ repaint(): void;
+ /** Shows the widget. */
+ show(): JQueryPromise<void>;
+ /** Toggles the visibility of the widget. */
+ toggle(showing: boolean): JQueryPromise<void>;
+ /** A static method that specifies the base z-index for all overlay widgets. */
+ static baseZIndex(zIndex: number): void;
+ }
+ export interface dxNumberBoxOptions extends dxTextEditorOptions {
+ /** The maximum value accepted by the number box. */
+ max?: number;
+ /** The minimum value accepted by the number box. */
+ min?: number;
+ /** Specifies whether or not to show spin buttons. */
+ showSpinButtons?: boolean;
+ useTouchSpinButtons?: boolean;
+ /** Specifies by which value the widget value changes when a spin button is clicked. */
+ step?: number;
+ /** The current number box value. */
+ value?: number;
+ }
+ /** A textbox widget that enables a user to enter numeric values. */
+ export class dxNumberBox extends dxTextEditor {
+ constructor(element: JQuery, options?: dxNumberBoxOptions);
+ constructor(element: Element, options?: dxNumberBoxOptions);
+ }
+ export interface dxNavBarOptions extends dxTabsOptions {
+ scrollingEnabled?: boolean;
+ }
+ /** A widget that contains items used to navigate through application views. */
+ export class dxNavBar extends dxTabs {
+ constructor(element: JQuery, options?: dxNavBarOptions);
+ constructor(element: Element, options?: dxNavBarOptions);
+ }
+ export interface dxMultiViewOptions extends CollectionWidgetOptions {
+ /** Specifies whether or not to animate the displayed item change. */
+ animationEnabled?: boolean;
+ /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */
+ loop?: boolean;
+ /** The index of the currently displayed item. */
+ selectedIndex?: number;
+ /** A Boolean value specifying whether or not to allow users to change the selected index by swiping. */
+ swipeEnabled?: boolean;
+ /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */
+ deferRendering?: boolean;
+ }
+ /** A widget used to display a view and to switch between several views. */
+ export class dxMultiView extends CollectionWidget {
+ constructor(element: JQuery, options?: dxMultiViewOptions);
+ constructor(element: Element, options?: dxMultiViewOptions);
+ }
+ export interface dxMapOptions extends WidgetOptions {
+ /** Specifies whether or not the widget automatically adjusts center and zoom option values when adding a new marker or route. */
+ autoAdjust?: boolean;
+ /** An object, a string, or an array specifying the location displayed at the center of the widget. */
+ center?: {
+ /** The latitude location displayed in the center of the widget. */
+ lat?: number;
+ /** The longitude location displayed in the center of the widget. */
+ lng?: number;
+ };
+ /** A handler for the click event. */
+ onClick?: any;
+ clickAction?: any;
+ /** Specifies whether or not map widget controls are available. */
+ controls?: boolean;
+ /** Specifies the height of the widget. */
+ height?: number;
+ /** A key used to authenticate the application within the required map provider. */
+ key?: {
+ /** A key used to authenticate the application within the "Bing" map provider. */
+ bing?: string;
+ /** A key used to authenticate the application within the "Google" map provider. */
+ google?: string;
+ /** A key used to authenticate the application within the "Google Static" map provider. */
+ googleStatic?: string;
+ }
+ /** A handler for the markerAdded event. */
+ onMarkerAdded?: Function;
+ markerAddedAction?: Function;
+ /** A URL pointing to the custom icon to be used for map markers. */
+ markerIconSrc?: string;
+ /** A handler for the markerRemoved event. */
+ onMarkerRemoved?: Function;
+ markerRemovedAction?: Function;
+ /** An array of markers displayed on a map. */
+ markers?: Array<any>;
+ /** The name of the current map data provider. */
+ provider?: string;
+ /** A handler for the ready event. */
+ onReady?: Function;
+ readyAction?: Function;
+ /** A handler for the routeAdded event. */
+ onRouteAdded?: Function;
+ routeAddedAction?: Function;
+ /** A handler for the routeRemoved event. */
+ onRouteRemoved?: Function;
+ routeRemovedAction?: Function;
+ /** An array of routes shown on the map. */
+ routes?: Array<any>;
+ /** The type of a map to display. */
+ type?: string;
+ /** Specifies the width of the widget. */
+ width?: number;
+ /** The zoom level of the map. */
+ zoom?: number;
+ }
+ /** An interactive map widget. */
+ export class dxMap extends Widget {
+ constructor(element: JQuery, options?: dxMapOptions);
+ constructor(element: Element, options?: dxMapOptions);
+ /** Adds a marker to the map. */
+ addMarker(markerOptions: Object): JQueryPromise<Object>;
+ /** Adds a route to the map. */
+ addRoute(options: Object): JQueryPromise<Object>;
+ /** Removes a marker from the map. */
+ removeMarker(marker: Object): JQueryPromise<void>;
+ /** Removes a route from the map. */
+ removeRoute(route: any): JQueryPromise<void>;
+ }
+ export interface dxLookupOptions extends dxDropDownListOptions {
+ /** An object defining widget animation options. */
+ animation?: fx.AnimationOptions;
+ /** The text displayed on the Cancel button. */
+ cancelButtonText?: string;
+ /** The text displayed on the Clear button. */
+ clearButtonText?: string;
+ /** Specifies whether or not the widget cleans the search box when the popup window is displayed. */
+ cleanSearchOnOpening?: boolean;
+ /** A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlaying window. */
+ closeOnOutsideClick?: any;
+ /** The text displayed on the Apply button. */
+ applyButtonText?: string;
+ /** A Boolean value specifying whether or not to display the lookup in full-screen mode. */
+ fullScreen?: boolean;
+ focusStateEnabled?: boolean;
+ /** A Boolean value specifying whether or not to group widget items. */
+ grouped?: boolean;
+ groupRender?: any;
+ /** The name of the template used to display a group header. */
+ groupTemplate?: any;
+ /** The text displayed on the button used to load the next page from the data source. */
+ nextButtonText?: string;
+ /** A handler for the pageLoading event. */
+ onPageLoading?: Function;
+ /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */
+ pageLoadMode?: string;
+ pageLoadingAction?: Function;
+ /** Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom. */
+ pageLoadingText?: string;
+ /** The text displayed by the widget when nothing is selected. */
+ placeholder?: string;
+ /** The height of the widget popup element. */
+ popupHeight?: any;
+ /** The width of the widget popup element. */
+ popupWidth?: any;
+ /** An object defining widget positioning options. */
+ position?: PositionOptions;
+ /** Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold. */
+ pulledDownText?: string;
+ /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */
+ pullingDownText?: string;
+ /** A handler for the pullRefresh event. */
+ onPullRefresh?: Function;
+ pullRefreshAction?: Function;
+ /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */
+ pullRefreshEnabled?: boolean;
+ /** Specifies the text displayed in the pullDown panel while the widget is being refreshed. */
+ refreshingText?: string;
+ /** A handler for the scroll event. */
+ onScroll?: Function;
+ scrollAction?: Function;
+ /** A Boolean value specifying whether or not the search bar is visible. */
+ searchEnabled?: boolean;
+ /** The text that is provided as a hint in the lookup's search bar. */
+ searchPlaceholder?: string;
+ /** A Boolean value specifying whether or not the main screen is inactive while the lookup is active. */
+ shading?: boolean;
+ /** Specifies whether to display the Cancel button in the lookup window. */
+ showCancelButton?: boolean;
+ /**
+ * A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked.
+ * @deprecated pageLoadMode.md
+ */
+ showNextButton?: boolean;
+ /** The title of the lookup window. */
+ title?: string;
+ /** A template to be used for rendering the widget title. */
+ titleTemplate?: any;
+ /** Specifies whether or not the widget uses native scrolling. */
+ useNativeScrolling?: boolean;
+ /** Specifies whether or not to show lookup contents in a dxPopover widget. */
+ usePopover?: boolean;
+ /** A handler for the valueChanged event. */
+ onValueChanged?: Function;
+ contentReadyAction?: Function;
+ titleRender?: any;
+ /** A handler for the titleRendered event. */
+ onTitleRendered?: Function;
+ /** A Boolean value specifying whether or not to display the title in the popup window. */
+ showPopupTitle?: boolean;
+ }
+ /** A widget that allows a user to select predefined values from a lookup window. */
+ export class dxLookup extends dxDropDownList {
+ constructor(element: JQuery, options?: dxLookupOptions);
+ constructor(element: Element, options?: dxLookupOptions);
+ /** This section lists the data source fields that are used in a default template for lookup drop-down items. */
+ }
+ export interface dxLoadPanelOptions extends dxOverlayOptions {
+ /** An object defining the animation options of the widget. */
+ animation?: fx.AnimationOptions;
+ /** The delay in milliseconds after which the load panel is displayed. */
+ delay?: number;
+ /** The height of the widget. */
+ height?: number;
+ /** A URL pointing to an image to be used as a load indicator. */
+ indicatorSrc?: string;
+ /** The text displayed in the load panel. */
+ message?: string;
+ /** A Boolean value specifying whether or not to show a load indicator. */
+ showIndicator?: boolean;
+ /** A Boolean value specifying whether or not to show the pane behind the load indicator. */
+ showPane?: boolean;
+ /** The width of the widget. */
+ width?: number;
+ }
+ /** A widget used to indicate whether or not an element is loading. */
+ export class dxLoadPanel extends dxOverlay {
+ constructor(element: JQuery, options?: dxLoadPanelOptions);
+ constructor(element: Element, options?: dxLoadPanelOptions);
+ }
+ export interface dxLoadIndicatorOptions extends WidgetOptions {
+ /** Specifies the path to an image used as the indicator. */
+ indicatorSrc?: string;
+ }
+ /** The widget used to indicate the loading process. */
+ export class dxLoadIndicator extends Widget {
+ constructor(element: JQuery, options?: dxLoadIndicatorOptions);
+ constructor(element: Element, options?: dxLoadIndicatorOptions);
+ }
+ export interface dxListOptions extends CollectionWidgetOptions {
+ /** A Boolean value specifying whether or not to display a grouped list. */
+ grouped?: boolean;
+ groupRender?: any;
+ /** The template to be used for rendering item groups. */
+ groupTemplate?: any;
+ onItemDeleting?: Function;
+ /** A handler for the itemDeleted event. */
+ onItemDeleted?: Function;
+ /** A handler for the groupRendered event. */
+ onGroupRendered?: Function;
+ itemDeleteAction?: Function;
+ /** A handler for the itemReordered event. */
+ onItemReordered?: Function;
+ itemReorderAction?: Function;
+ /** A handler for the itemClick event. */
+ onItemClick?: any;
+ /** A handler for the itemSwipe event. */
+ onItemSwipe?: Function;
+ itemSwipeAction?: Function;
+ /** The text displayed on the button used to load the next page from the data source. */
+ nextButtonText?: string;
+ /** A handler for the pageLoading event. */
+ onPageLoading?: Function;
+ pageLoadingAction?: Function;
+ /** Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */
+ pageLoadingText?: string;
+ /** Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */
+ pulledDownText?: string;
+ /** Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */
+ pullingDownText?: string;
+ /** A handler for the pullRefresh event. */
+ onPullRefresh?: Function;
+ pullRefreshAction?: Function;
+ /** A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */
+ pullRefreshEnabled?: boolean;
+ /** Specifies the text displayed in the pullDown panel while the list is being refreshed. */
+ refreshingText?: string;
+ /** A handler for the scroll event. */
+ onScroll?: Function;
+ scrollAction?: Function;
+ /** A Boolean value specifying whether to enable or disable list scrolling. */
+ scrollingEnabled?: boolean;
+ /** Specifies when the widget shows the scrollbar. */
+ showScrollbar?: string;
+ /** Specifies whether or not the widget uses native scrolling. */
+ useNativeScrolling?: boolean;
+ /** A Boolean value specifying whether to enable or disable the bounce-back effect. */
+ bounceEnabled?: boolean;
+ /** A Boolean value specifying if the list is scrolled by content. */
+ scrollByContent?: boolean;
+ /** A Boolean value specifying if the list is scrolled using the scrollbar. */
+ scrollByThumb?: boolean;
+ itemUnselectAction?: Function;
+ onItemContextMenu?: Function;
+ onItemHold?: Function;
+ /** Specifies whether or not an end-user can collapse groups. */
+ collapsibleGroups?: boolean;
+ /** Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */
+ pageLoadMode?: string;
+ /** Specifies whether or not to display controls used to select list items. */
+ showSelectionControls?: boolean;
+ /** Specifies item selection mode. */
+ selectionMode?: string;
+ selectAllText?: string;
+ /** Specifies the array of items for a context menu called for a list item. */
+ menuItems?: Array<any>;
+ /** Specifies whether an item context menu is shown when a user holds or swipes an item. */
+ menuMode?: string;
+ /** Specifies whether or not an end user can delete list items. */
+ allowItemDeleting?: boolean;
+ /** Specifies the way a user can delete items from the list. */
+ itemDeleteMode?: string;
+ /** Specifies whether or not an end user can reorder list items. */
+ allowItemReordering?: boolean;
+ /** Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */
+ indicateLoading?: boolean;
+ activeStateEnabled?: boolean;
+ }
+ /** A list widget. */
+ export class dxList extends CollectionWidget {
+ constructor(element: JQuery, options?: dxListOptions);
+ constructor(element: Element, options?: dxListOptions);
+ /** Returns the height of the widget in pixels. */
+ clientHeight(): number;
+ /** Removes the specified item from the list. */
+ deleteItem(itemIndex: any): JQueryPromise<void>;
+ /** Removes the specified item from the list. */
+ deleteItem(itemElement: Element): JQueryPromise<void>;
+ /** Returns a Boolean value that indicates whether or not the specified item is selected. */
+ isItemSelected(itemIndex: any): boolean;
+ /** Returns a Boolean value that indicates whether or not the specified item is selected. */
+ isItemSelected(itemElement: Element): boolean;
+ /** Reloads list data. */
+ reload(): void;
+ /** Moves the specified item to the specified position in the list. */
+ reorderItem(itemElement: Element, toItemElement: Element): JQueryPromise<void>;
+ /** Moves the specified item to the specified position in the list. */
+ reorderItem(itemIndex: any, toItemIndex: any): JQueryPromise<void>;
+ /** Scrolls the list content by the specified number of pixels. */
+ scrollBy(distance: number): void;
+ /** Returns the height of the list content in pixels. */
+ scrollHeight(): number;
+ /** Scrolls list content to the specified position. */
+ scrollTo(location: number): void;
+ /** Scrolls the list to the specified item. */
+ scrollToItem(itemElement: Element): void;
+ /** Scrolls the list to the specified item. */
+ scrollToItem(itemIndex: any): void;
+ /** Returns how far the list content is scrolled from the top. */
+ scrollTop(): number;
+ /** Selects the specified item from the list. */
+ selectItem(itemElement: Element): void;
+ /** Selects the specified item from the list. */
+ selectItem(itemIndex: any): void;
+ /** Deselects the specified item from the list. */
+ unselectItem(itemElement: Element): void;
+ /** Unselects the specified item from the list. */
+ unselectItem(itemIndex: any): void;
+ /** Updates the widget scrollbar according to widget content size. */
+ updateDimensions(): JQueryPromise<void>;
+ /** Expands the specified group. */
+ expandGroup(groupIndex: number): JQueryPromise<void>;
+ /** Collapses the specified group. */
+ collapseGroup(groupIndex: number): JQueryPromise<void>;
+ }
+ export interface dxGalleryOptions extends CollectionWidgetOptions {
+ /** The time, in milliseconds, spent on slide animation. */
+ animationDuration?: number;
+ /** Specifies whether or not to animate the displayed item change. */
+ animationEnabled?: boolean;
+ /** A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */
+ indicatorEnabled?: boolean;
+ /** A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */
+ loop?: boolean;
+ /** The index of the currently active gallery item. */
+ selectedIndex?: number;
+ /** A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */
+ showIndicator?: boolean;
+ /** A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. */
+ showNavButtons?: boolean;
+ /** The time interval in milliseconds, after which the gallery switches to the next item. */
+ slideshowDelay?: number;
+ /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */
+ swipeEnabled?: boolean;
+ /** Specifies whether or not to display parts of previous and next images along the sides of the current image. */
+ wrapAround?: boolean;
+ /** Specifies if the widget stretches images to fit the total gallery width. */
+ stretchImages?: boolean;
+ /** Specifies the width of an area used to display a single image. */
+ initialItemWidth?: number;
+ }
+ /** An image gallery widget. */
+ export class dxGallery extends CollectionWidget {
+ constructor(element: JQuery, options?: dxGalleryOptions);
+ constructor(element: Element, options?: dxGalleryOptions);
+ /** Shows the specified gallery item. */
+ goToItem(itemIndex: number, animation: boolean): JQueryPromise<any>;
+ /** Shows the next gallery item. */
+ nextItem(animation: boolean): JQueryPromise<any>;
+ /** Shows the previous gallery item. */
+ prevItem(animation: boolean): JQueryPromise<any>;
+ }
+ export interface dxDropDownEditorOptions extends dxTextBoxOptions {
+ /** Specifies the current value displayed by the widget. */
+ value?: Object;
+ /** A handler for the closed event. */
+ onClosed?: Function;
+ /** A handler for the opened event. */
+ onOpened?: Function;
+ /** Specifies whether or not the drop-down editor is displayed. */
+ opened?: boolean;
+ closeAction?: Function;
+ openAction?: Function;
+ shownAction?: Function;
+ hiddenAction?: Function;
+ /** Specifies whether or not the widget allows an end-user to enter a custom value. */
+ fieldEditEnabled?: boolean;
+ editEnabled?: boolean;
+ /** Specifies the way an end-user applies the selected value. */
+ applyValueMode?: string;
+ /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */
+ deferRendering?: boolean;
+ }
+ /** A drop-down editor widget. */
+ export class dxDropDownEditor extends dxTextBox {
+ constructor(element: JQuery, options?: dxDropDownEditorOptions);
+ constructor(element: Element, options?: dxDropDownEditorOptions);
+ /** Closes the drop-down editor. */
+ close(): void;
+ /** Opens the drop-down editor. */
+ open(): void;
+ /** Resets the widget's value to null. */
+ reset(): void;
+ /** Returns an <input> element of the widget. */
+ field(): JQuery;
+ /** Returns an HTML element of the popup window content. */
+ content(): JQuery;
+ }
+ export interface dxDateBoxOptions extends dxTextEditorOptions {
+ /** A format used to display date/time information. */
+ format?: string;
+ /** A Globalize format string specifying the date display format. */
+ formatString?: string;
+ /** The last date that can be selected within the widget. */
+ max?: any;
+ /** The minimum date that can be selected within the widget. */
+ min?: any;
+ /** The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker. */
+ placeholder?: string;
+ /**
+ * Specifies whether or not a user can pick out a date using the drop-down calendar.
+ * @deprecated Use 'pickerType' option instead.
+ */
+ useCalendar?: boolean;
+ /** An object or a value, specifying the date and time currently selected using the date box. */
+ value?: any;
+ /**
+ * Specifies whether or not the widget uses the native HTML input element.
+ * @deprecated Use 'pickerType' option instead.
+ */
+ useNative?: boolean;
+ /** Specifies the interval between neighboring values in the popup list in minutes. */
+ interval?: number;
+ /** Specifies the maximum zoom level of a calendar, which is used to pick the date. */
+ maxZoomLevel?: string;
+ /** Specifies the minimal zoom level of a calendar, which is used to pick the date. */
+ minZoomLevel?: string;
+ /** Specifies the type of date/time picker. */
+ pickerType?: string;
+ }
+ /** A date box widget. */
+ export class dxDateBox extends dxDropDownEditor {
+ constructor(element: JQuery, options?: dxDateBoxOptions);
+ constructor(element: Element, options?: dxDateBoxOptions);
+ }
+ export interface dxCheckBoxOptions extends EditorOptions {
+ /** Specifies the widget state. */
+ value?: boolean;
+ /** Specifies the text displayed by the check box. */
+ text?: string;
+ }
+ /** A check box widget. */
+ export class dxCheckBox extends Editor {
+ constructor(element: JQuery, options?: dxCheckBoxOptions);
+ constructor(element: Element, options?: dxCheckBoxOptions);
+ }
+ export interface dxCalendarOptions extends EditorOptions {
+ /** Specifies a date displayed on the current calendar page. */
+ currentDate?: Date;
+ /** Specifies the first day of a week. */
+ firstDayOfWeek?: number;
+ /** The latest date the widget allows to select. */
+ max?: Date;
+ /** The earliest date the widget allows to select. */
+ min?: Date;
+ /** Specifies whether or not the widget displays a button that selects the current date. */
+ showTodayButton?: boolean;
+ /** Specifies the current calendar zoom level. */
+ zoomLevel?: string;
+ /** Specifies the maximum zoom level of the calendar. */
+ maxZoomLevel?: string;
+ /** Specifies the minimum zoom level of the calendar. */
+ minZoomLevel?: string;
+ /** The template to be used for rendering calendar cells. */
+ cellTemplate?: any;
+ }
+ /** A calendar widget. */
+ export class dxCalendar extends Editor {
+ constructor(element: JQuery, options?: dxCalendarOptions);
+ constructor(element: Element, options?: dxCalendarOptions);
+ }
+ export interface dxButtonOptions extends WidgetOptions {
+ /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */
+ activeStateEnabled?: boolean;
+ /** A handler for the click event. */
+ onClick?: any;
+ clickAction?: any;
+ /** Specifies the icon to be displayed on the button. */
+ icon?: string;
+ iconSrc?: string;
+ /** A template to be used for rendering the dxButton widget. */
+ template?: any;
+ /** The text displayed on the button. */
+ text?: string;
+ /** Specifies the button type. */
+ type?: string;
+ /** Specifies the name of the validation group to be accessed in the click event handler. */
+ validationGroup?: string;
+ }
+ /** A button widget. */
+ export class dxButton extends Widget {
+ constructor(element: JQuery, options?: dxButtonOptions);
+ constructor(element: Element, options?: dxButtonOptions);
+ }
+ export interface dxBoxOptions extends CollectionWidget {
+ /** Specifies how widget items are aligned along the main direction. */
+ align?: string;
+ /** Specifies the direction of item positioning in the widget. */
+ direction?: string;
+ /** Specifies how widget items are aligned cross-wise. */
+ crossAlign?: string;
+ }
+ /** A container widget used to arrange inner elements. */
+ export class dxBox extends CollectionWidget {
+ constructor(element: JQuery, options?: dxBoxOptions);
+ constructor(element: Element, options?: dxBoxOptions);
+ }
+ export interface dxResponsiveBoxOptions extends CollectionWidgetOptions {
+ /** Specifies the collection of rows for the grid used to position layout elements. */
+ rows?: Array<Object>;
+ /** Specifies the collection of columns for the grid used to position layout elements. */
+ cols?: Array<Object>;
+ /** Specifies the function returning the screen factor depending on the screen width. */
+ screenByWidth?: (width: number) => string;
+ /** Specifies the screen factor with which all elements are located in a single column. */
+ singleColumnScreen?: string;
+ }
+ /** A widget used to build an adaptive markup that is dependent on screen resolution. */
+ export class dxResponsiveBox extends CollectionWidget {
+ constructor(element: JQuery, options?: dxBoxOptions);
+ constructor(element: Element, options?: dxBoxOptions);
+ }
+ export interface dxAutocompleteOptions extends dxDropDownListOptions {
+ /** Specifies the current value displayed by the widget. */
+ value?: string;
+ /** The minimum number of characters that must be entered into the text box to begin a search. */
+ minSearchLength?: number;
+ /** Specifies the maximum count of items displayed by the widget. */
+ maxItemCount?: number;
+ /** Gets the currently selected item. */
+ selectedItem?: Object;
+ }
+ /** A textbox widget that supports autocompletion. */
+ export class dxAutocomplete extends dxDropDownList {
+ constructor(element: JQuery, options?: dxAutocompleteOptions);
+ constructor(element: Element, options?: dxAutocompleteOptions);
+ /** Opens the drop-down editor. */
+ open(): void;
+ /** Closes the drop-down editor. */
+ close(): void;
+ }
+ export interface dxAccordionOptions extends CollectionWidgetOptions {
+ /** A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */
+ animationDuration?: number;
+ /** Specifies the height of the widget. */
+ height?: any;
+ /** Specifies whether all items can be collapsed or whether at least one item must always be expanded. */
+ collapsible?: boolean;
+ /** Specifies whether the widget can expand several items or only a single item at once. */
+ multiple?: boolean;
+ /** The template to be used for rendering dxAccordion items. */
+ itemTemplate?: any;
+ /** A handler for the itemTitleClick event. */
+ onItemTitleClick?: any;
+ /** A handler for the itemTitleHold event. */
+ onItemTitleHold?: Function;
+ /** The template to be used for rendering an item title. */
+ itemTitleTemplate?: any;
+ /** The index number of the currently selected item. */
+ selectedIndex?: number;
+ /** Specifies whether widget content is rendered when the widget is shown or when rendering the widget. */
+ deferRendering?: boolean;
+ }
+ /** A widget that displays data source items on collapsible panels. */
+ export class dxAccordion extends CollectionWidget {
+ constructor(element: JQuery, options?: dxAccordionOptions);
+ constructor(element: Element, options?: dxAccordionOptions);
+ /** Collapses the specified item. */
+ collapseItem(index: number): JQueryPromise<dxAccordion>;
+ /** Expands the specified item. */
+ expandItem(index: number): JQueryPromise<dxAccordion>;
+ /** Updates the dimensions of the widget contents. */
+ updateDimensions(): JQueryPromise<dxAccordion>;
+ }
+ export interface dxFileUploaderOptions extends EditorOptions {
+ /** A read-only option that holds a File instance representing the selected file. */
+ value?: File;
+ /** Holds the File instances representing files selected in the widget. */
+ values?: Array<File>;
+ buttonText?: string;
+ /** The text displayed on the button that opens the file browser. */
+ selectButtonText?: string;
+ /** The text displayed on the button that starts uploading. */
+ uploadButtonText?: string;
+ /** Specifies the text displayed on the area to which an end-user can drop a file. */
+ labelText?: string;
+ /** Specifies the value passed to the name attribute of the underlying input element. */
+ name?: string;
+ /** Specifies whether the widget enables an end-user to select a single file or multiple files. */
+ multiple?: boolean;
+ /** Specifies a file type or several types accepted by the widget. */
+ accept?: string;
+ /** Specifies a target Url for the upload request. */
+ uploadUrl?: string;
+ /** Specifies if an end user can remove a file from the selection and interrupt uploading. */
+ allowCanceling?: boolean;
+ /** Specifies whether or not the widget displays the list of selected files. */
+ showFileList?: boolean;
+ /** Gets the current progress in percentages. */
+ progress?: number;
+ /** The message displayed by the widget when it is ready to upload the specified files. */
+ readyToUploadMessage?: string;
+ /** The message displayed by the widget when uploading is finished. */
+ uploadedMessage?: string;
+ /** The message displayed by the widget on uploading failure. */
+ uploadFailedMessage?: string;
+ /** Specifies how the widget uploads files. */
+ uploadMode?: string;
+ /** A handler for the uploaded event. */
+ onUploaded?: Function;
+ /** A handler for the uploaded event. */
+ onProgress?: Function;
+ /** A handler for the uploadError event. */
+ onUploadError?: Function;
+ }
+ /** A widget used to select and upload a file or multiple files. */
+ export class dxFileUploader extends Editor {
+ constructor(element: JQuery, options?: dxFileUploaderOptions);
+ constructor(element: Element, options?: dxFileUploaderOptions);
+ }
+ export interface dxTrackBarOptions extends EditorOptions {
+ /** The minimum value the widget can accept. */
+ min?: number;
+ /** The maximum value the widget can accept. */
+ max?: number;
+ /** The current widget value. */
+ value?: number;
+ }
+ /** A base class for track bar widgets. */
+ export class dxTrackBar extends Editor {
+ constructor(element: JQuery, options?: dxTrackBarOptions);
+ constructor(element: Element, options?: dxTrackBarOptions);
+ }
+ export interface dxProgressBarOptions extends dxTrackBarOptions {
+ /** Specifies a format for the progress status. */
+ statusFormat?: any;
+ /** Specifies whether or not the widget displays a progress status. */
+ showStatus?: boolean;
+ /** A handler for the complete event. */
+ onComplete?: Function;
+ }
+ /** A widget used to indicate progress. */
+ export class dxProgressBar extends dxTrackBar {
+ constructor(element: JQuery, options?: dxProgressBarOptions);
+ constructor(element: Element, options?: dxProgressBarOptions);
+ }
+ export interface dxSliderOptions extends dxTrackBarOptions {
+ /** The slider step size. */
+ step?: number;
+ /** The current slider value. */
+ value?: number;
+ /** Specifies whether or not to highlight a range selected within the widget. */
+ showRange?: boolean;
+ /** Specifies the size of a step by which a slider handle is moved when a user uses the Page up or Page down keyboard shortcuts. */
+ keyStep?: number;
+ /** Specifies options for the slider tooltip. */
+ tooltip?: {
+ /** Specifies whether or not the tooltip is enabled. */
+ enabled?: boolean;
+ /** Specifies format for the tooltip. */
+ format?: any;
+ /** Specifies whether the tooltip is located over or under the slider. */
+ position?: string;
+ /** Specifies whether the widget always shows a tooltip or only when a pointer is over the slider. */
+ showMode?: string;
+ };
+ /** Specifies options for labels displayed at the min and max values. */
+ label?: {
+ /** Specifies whether or not slider labels are visible. */
+ visible?: boolean;
+ /** Specifies whether labels are located over or under the scale. */
+ position?: string;
+ /** Specifies a format for labels. */
+ format?: any;
+ };
+ }
+ /** A widget that allows a user to select a numeric value within a given range. */
+ export class dxSlider extends dxTrackBar {
+ constructor(element: JQuery, options?: dxSliderOptions);
+ constructor(element: Element, options?: dxSliderOptions);
+ }
+ export interface dxRangeSliderOptions extends dxSliderOptions {
+ /** The left edge of the interval currently selected using the range slider. */
+ start?: number;
+ /** The right edge of the interval currently selected using the range slider. */
+ end?: number;
+ }
+ /** A widget that enables a user to select a range of numeric values. */
+ export class dxRangeSlider extends dxSlider {
+ constructor(element: JQuery, options?: dxRangeSliderOptions);
+ constructor(element: Element, options?: dxRangeSliderOptions);
+ }
+}
+interface JQuery {
+ dxProgressBar(): JQuery;
+ dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar;
+ dxProgressBar(options: string): any;
+ dxProgressBar(options: string, ...params: any[]): any;
+ dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery;
+ dxSlider(): JQuery;
+ dxSlider(options: "instance"): DevExpress.ui.dxSlider;
+ dxSlider(options: string): any;
+ dxSlider(options: string, ...params: any[]): any;
+ dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery;
+ dxRangeSlider(): JQuery;
+ dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider;
+ dxRangeSlider(options: string): any;
+ dxRangeSlider(options: string, ...params: any[]): any;
+ dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery;
+ dxFileUploader(): JQuery;
+ dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader;
+ dxFileUploader(options: string): any;
+ dxFileUploader(options: string, ...params: any[]): any;
+ dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery;
+ dxValidator(): JQuery;
+ dxValidator(options: "instance"): DevExpress.ui.dxValidator;
+ dxValidator(options: string): any;
+ dxValidator(options: string, ...params: any[]): any;
+ dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery;
+ dxValidationGroup(): JQuery;
+ dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup;
+ dxValidationGroup(options: string): any;
+ dxValidationGroup(options: string, ...params: any[]): any;
+ dxValidationSummary(): JQuery;
+ dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary;
+ dxValidationSummary(options: string): any;
+ dxValidationSummary(options: string, ...params: any[]): any;
+ dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery;
+ dxTooltip(): JQuery;
+ dxTooltip(options: "instance"): DevExpress.ui.dxTooltip;
+ dxTooltip(options: string): any;
+ dxTooltip(options: string, ...params: any[]): any;
+ dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery;
+ dxResizable(): JQuery;
+ dxResizable(options: "instance"): DevExpress.ui.dxResizable;
+ dxResizable(options: string): any;
+ dxResizable(options: string, ...params: any[]): any;
+ dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery;
+ dxDropDownList(): JQuery;
+ dxDropDownList(options: "instance"): DevExpress.ui.dxDropDownList;
+ dxDropDownList(options: string): any;
+ dxDropDownList(options: string, ...params: any[]): any;
+ dxDropDownList(options: DevExpress.ui.dxDropDownListOptions): JQuery;
+ dxToolbar(): JQuery;
+ dxToolbar(options: "instance"): DevExpress.ui.dxToolbar;
+ dxToolbar(options: string): any;
+ dxToolbar(options: string, ...params: any[]): any;
+ dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery;
+ dxToast(): JQuery;
+ dxToast(options: "instance"): DevExpress.ui.dxToast;
+ dxToast(options: string): any;
+ dxToast(options: string, ...params: any[]): any;
+ dxToast(options: DevExpress.ui.dxToastOptions): JQuery;
+ dxTextEditor(): JQuery;
+ dxTextEditor(options: "instance"): DevExpress.ui.dxTextEditor;
+ dxTextEditor(options: string): any;
+ dxTextEditor(options: string, ...params: any[]): any;
+ dxTextEditor(options: DevExpress.ui.dxTextEditorOptions): JQuery;
+ dxTextBox(): JQuery;
+ dxTextBox(options: "instance"): DevExpress.ui.dxTextBox;
+ dxTextBox(options: string): any;
+ dxTextBox(options: string, ...params: any[]): any;
+ dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery;
+ dxTextArea(): JQuery;
+ dxTextArea(options: "instance"): DevExpress.ui.dxTextArea;
+ dxTextArea(options: string): any;
+ dxTextArea(options: string, ...params: any[]): any;
+ dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery;
+ dxTabs(): JQuery;
+ dxTabs(options: "instance"): DevExpress.ui.dxTabs;
+ dxTabs(options: string): any;
+ dxTabs(options: string, ...params: any[]): any;
+ dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery;
+ dxTabPanel(): JQuery;
+ dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel;
+ dxTabPanel(options: string): any;
+ dxTabPanel(options: string, ...params: any[]): any;
+ dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery;
+ dxSelectBox(): JQuery;
+ dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox;
+ dxSelectBox(options: string): any;
+ dxSelectBox(options: string, ...params: any[]): any;
+ dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery;
+ dxScrollView(): JQuery;
+ dxScrollView(options: "instance"): DevExpress.ui.dxScrollView;
+ dxScrollView(options: string): any;
+ dxScrollView(options: string, ...params: any[]): any;
+ dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery;
+ dxScrollable(): JQuery;
+ dxScrollable(options: "instance"): DevExpress.ui.dxScrollable;
+ dxScrollable(options: string): any;
+ dxScrollable(options: string, ...params: any[]): any;
+ dxScrollable(options: DevExpress.ui.dxScrollableOptions): JQuery;
+ dxRadioGroup(): JQuery;
+ dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup;
+ dxRadioGroup(options: string): any;
+ dxRadioGroup(options: string, ...params: any[]): any;
+ dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery;
+ dxPopup(): JQuery;
+ dxPopup(options: "instance"): DevExpress.ui.dxPopup;
+ dxPopup(options: string): any;
+ dxPopup(options: string, ...params: any[]): any;
+ dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery;
+ dxPopover(): JQuery;
+ dxPopover(options: "instance"): DevExpress.ui.dxPopover;
+ dxPopover(options: string): any;
+ dxPopover(options: string, ...params: any[]): any;
+ dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery;
+ dxOverlay(): JQuery;
+ dxOverlay(options: "instance"): DevExpress.ui.dxOverlay;
+ dxOverlay(options: string): any;
+ dxOverlay(options: string, ...params: any[]): any;
+ dxOverlay(options: DevExpress.ui.dxOverlayOptions): JQuery;
+ dxNumberBox(): JQuery;
+ dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox;
+ dxNumberBox(options: string): any;
+ dxNumberBox(options: string, ...params: any[]): any;
+ dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery;
+ dxNavBar(): JQuery;
+ dxNavBar(options: "instance"): DevExpress.ui.dxNavBar;
+ dxNavBar(options: string): any;
+ dxNavBar(options: string, ...params: any[]): any;
+ dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery;
+ dxMultiView(): JQuery;
+ dxMultiView(options: "instance"): DevExpress.ui.dxMultiView;
+ dxMultiView(options: string): any;
+ dxMultiView(options: string, ...params: any[]): any;
+ dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery;
+ dxMap(): JQuery;
+ dxMap(options: "instance"): DevExpress.ui.dxMap;
+ dxMap(options: string): any;
+ dxMap(options: string, ...params: any[]): any;
+ dxMap(options: DevExpress.ui.dxMapOptions): JQuery;
+ dxLookup(): JQuery;
+ dxLookup(options: "instance"): DevExpress.ui.dxLookup;
+ dxLookup(options: string): any;
+ dxLookup(options: string, ...params: any[]): any;
+ dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery;
+ dxLoadPanel(): JQuery;
+ dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel;
+ dxLoadPanel(options: string): any;
+ dxLoadPanel(options: string, ...params: any[]): any;
+ dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery;
+ dxLoadIndicator(): JQuery;
+ dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator;
+ dxLoadIndicator(options: string): any;
+ dxLoadIndicator(options: string, ...params: any[]): any;
+ dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery;
+ dxList(): JQuery;
+ dxList(options: "instance"): DevExpress.ui.dxList;
+ dxList(options: string): any;
+ dxList(options: string, ...params: any[]): any;
+ dxList(options: DevExpress.ui.dxListOptions): JQuery;
+ dxGallery(): JQuery;
+ dxGallery(options: "instance"): DevExpress.ui.dxGallery;
+ dxGallery(options: string): any;
+ dxGallery(options: string, ...params: any[]): any;
+ dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery;
+ dxDropDownEditor(): JQuery;
+ dxDropDownEditor(options: "instance"): DevExpress.ui.dxDropDownEditor;
+ dxDropDownEditor(options: string): any;
+ dxDropDownEditor(options: string, ...params: any[]): any;
+ dxDropDownEditor(options: DevExpress.ui.dxDropDownEditorOptions): JQuery;
+ dxDateBox(): JQuery;
+ dxDateBox(options: "instance"): DevExpress.ui.dxDateBox;
+ dxDateBox(options: string): any;
+ dxDateBox(options: string, ...params: any[]): any;
+ dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery;
+ dxCheckBox(): JQuery;
+ dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox;
+ dxCheckBox(options: string): any;
+ dxCheckBox(options: string, ...params: any[]): any;
+ dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery;
+ dxBox(): JQuery;
+ dxBox(options: "instance"): DevExpress.ui.dxBox;
+ dxBox(options: string): any;
+ dxBox(options: string, ...params: any[]): any;
+ dxBox(options: DevExpress.ui.dxBoxOptions): JQuery;
+ dxButton(): JQuery;
+ dxButton(options: "instance"): DevExpress.ui.dxButton;
+ dxButton(options: string): any;
+ dxButton(options: string, ...params: any[]): any;
+ dxButton(options: DevExpress.ui.dxButtonOptions): JQuery;
+ dxCalendar(): JQuery;
+ dxCalendar(options: "instance"): DevExpress.ui.dxCalendar;
+ dxCalendar(options: string): any;
+ dxCalendar(options: string, ...params: any[]): any;
+ dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery;
+ dxAccordion(): JQuery;
+ dxAccordion(options: "instance"): DevExpress.ui.dxAccordion;
+ dxAccordion(options: string): any;
+ dxAccordion(options: string, ...params: any[]): any;
+ dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery;
+ dxResponsiveBox(): JQuery;
+ dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox;
+ dxResponsiveBox(options: string): any;
+ dxResponsiveBox(options: string, ...params: any[]): any;
+ dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery;
+ dxAutocomplete(): JQuery;
+ dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete;
+ dxAutocomplete(options: string): any;
+ dxAutocomplete(options: string, ...params: any[]): any;
+ dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery;
+}
+
+declare module DevExpress.ui {
+ export interface dxTileViewOptions extends CollectionWidgetOptions {
+ /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */
+ activeStateEnabled?: boolean;
+ /** Specifies the height of the base tile view item. */
+ baseItemHeight?: number;
+ /** Specifies the width of the base tile view item. */
+ baseItemWidth?: number;
+ /** Specifies the height of the widget. */
+ height?: any;
+ /** Specifies the distance in pixels between adjacent tiles. */
+ itemMargin?: number;
+ /** A Boolean value specifying whether or not to display a scrollbar. */
+ showScrollbar?: boolean;
+ }
+ /** A widget displaying several blocks of data as tiles. */
+ export class dxTileView extends CollectionWidget {
+ constructor(element: JQuery, options?: dxTileViewOptions);
+ constructor(element: Element, options?: dxTileViewOptions);
+ /** Returns the current scroll position of the widget content. */
+ scrollPosition(): number;
+ }
+ export interface dxSwitchOptions extends EditorOptions {
+ /** Text displayed when the widget is in a disabled state. */
+ offText?: string;
+ /** Text displayed when the widget is in an enabled state. */
+ onText?: string;
+ /** A Boolean value specifying whether the current switch state is "On" or "Off". */
+ value?: boolean;
+ }
+ /** A switch widget. */
+ export class dxSwitch extends Editor {
+ constructor(element: JQuery, options?: dxSwitchOptions);
+ constructor(element: Element, options?: dxSwitchOptions);
+ }
+ export interface dxSlideOutViewOptions extends WidgetOptions {
+ /** Specifies whether or not the menu panel is visible. */
+ menuVisible?: boolean;
+ /** Specifies whether or not the menu is shown when a user swipes the widget content. */
+ swipeEnabled?: boolean;
+ /** A template to be used for rendering menu panel content. */
+ menuTemplate?: any;
+ /** A template to be used for rendering widget content. */
+ contentTemplate?: any;
+ }
+ /** The widget that allows you to slide-out the current view to reveal a custom menu. */
+ export class dxSlideOutView extends Widget {
+ constructor(element: JQuery, options?: dxSlideOutViewOptions);
+ constructor(element: Element, options?: dxSlideOutViewOptions);
+ /** Returns an HTML element of the widget menu block. */
+ menuContent(): JQuery;
+ /** Returns an HTML element of the widget content block. */
+ content(): JQuery;
+ /** Displays the widget's menu block. */
+ showMenu(): JQueryPromise<void>;
+ /** Hides the widget's menu block. */
+ hideMenu(): JQueryPromise<void>;
+ /** Toggles the visibility of the widget's menu block. */
+ toggleMenuVisibility(): JQueryPromise<void>;
+ }
+ export interface dxSlideOutOptions extends CollectionWidgetOptions {
+ /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */
+ activeStateEnabled?: boolean;
+ /** A Boolean value specifying whether or not to display a grouped menu. */
+ menuGrouped?: boolean;
+ menuGroupRender?: any;
+ /** The name of the template used to display a group header. */
+ menuGroupTemplate?: any;
+ menuItemRender?: any;
+ /** The template used to render menu items. */
+ menuItemTemplate?: any;
+ /** A handler for the menuGroupRendered event. */
+ onMenuGroupRendered?: Function;
+ /** A handler for the menuItemRendered event. */
+ onMenuItemRendered?: Function;
+ /** Specifies whether or not the slide-out menu is displayed. */
+ menuVisible?: boolean;
+ /** Indicates whether the menu can be shown/hidden by swiping the widget's main panel. */
+ swipeEnabled?: boolean;
+ /** A template to be used for rendering widget content. */
+ contentTemplate?: any;
+ }
+ /** The widget that allows you to slide-out the current view to reveal an item list. */
+ export class dxSlideOut extends CollectionWidget {
+ constructor(element: JQuery, options?: dxSlideOutOptions);
+ constructor(element: Element, options?: dxSlideOutOptions);
+ /** Hides the widget's slide-out menu. */
+ hideMenu(): JQueryPromise<void>;
+ /** Displays the widget's slide-out menu. */
+ showMenu(): JQueryPromise<void>;
+ /** Toggles the visibility of the widget's slide-out menu. */
+ toggleMenuVisibility(showing: boolean): JQueryPromise<void>;
+ }
+ export interface dxPivotOptions extends CollectionWidgetOptions {
+ /** The index of the currently active pivot item. */
+ selectedIndex?: number;
+ /** A Boolean value specifying whether or not to allow users to switch between items by swiping. */
+ swipeEnabled?: boolean;
+ /** A template to be used for rendering widget content. */
+ contentTemplate?: any;
+ /** The template to be used for rendering an item title. */
+ itemTitleTemplate?: any;
+ }
+ /** A widget that is similar to a traditional tab control, but optimized for the phone with simplified end-user interaction. */
+ export class dxPivot extends CollectionWidget {
+ constructor(element: JQuery, options?: dxPivotOptions);
+ constructor(element: Element, options?: dxPivotOptions);
+ }
+ export interface dxPanoramaOptions extends CollectionWidgetOptions {
+ /** An object exposing options for setting a background image for the panorama. */
+ backgroundImage?: {
+ /** Specifies the height of the panorama's background image. */
+ height?: number;
+ /** Specifies the URL of the image that is used as the panorama's background image. */
+ url?: string;
+ /** Specifies the width of the panorama's background image. */
+ width?: number;
+ };
+ /** The index of the currently active panorama item. */
+ selectedIndex?: number;
+ /** Specifies the widget content title. */
+ title?: string;
+ }
+ /** A widget displaying the required content in a long horizontal canvas that extends beyond the frames of the screen. */
+ export class dxPanorama extends CollectionWidget {
+ constructor(element: JQuery, options?: dxDropDownEditorOptions);
+ constructor(element: Element, options?: dxDropDownEditorOptions);
+ }
+ export interface dxDropDownMenuOptions extends WidgetOptions {
+ /** A handler for the buttonClick event. */
+ onButtonClick?: any;
+ buttonClickAction?: any;
+ /** The name of the icon to be displayed by the DropDownMenu button. */
+ buttonIcon?: string;
+ buttonIconSrc?: string;
+ /** The text displayed in the DropDownMenu button. */
+ buttonText?: string;
+ /** A data source used to fetch data to be displayed by the widget. */
+ dataSource?: any;
+ /** A handler for the itemClick event. */
+ onItemClick?: any;
+ itemClickAction?: any;
+ itemRender?: any;
+ /** An array of items displayed by the widget. */
+ items?: Array<any>;
+ /** The template to be used for rendering items. */
+ itemTemplate?: any;
+ /** Specifies whether or not to show the drop down menu within a dxPopover widget. */
+ usePopover?: boolean;
+ /** The width of the menu popup in pixels. */
+ popupWidth?: any;
+ /** The height of the menu popup in pixels. */
+ popupHeight?: any;
+ /** Specifies whether or not the drop-down menu is displayed. */
+ opened?: boolean;
+ /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */
+ hoverStateEnabled?: boolean;
+ }
+ /** A drop-down menu widget. */
+ export class dxDropDownMenu extends Widget {
+ constructor(element: JQuery, options?: dxDropDownEditorOptions);
+ constructor(element: Element, options?: dxDropDownEditorOptions);
+ /** This section lists the data source fields that are used in a default template for drop-down menu items. */
+ /** Opens the drop-down menu. */
+ open(): void;
+ /** Closes the drop-down menu. */
+ close(): void;
+ }
+ export interface dxActionSheetOptions extends CollectionWidgetOptions {
+ cancelClickAction?: any;
+ /** A handler for the cancelClick event. */
+ onCancelClick?: any;
+ /** The text displayed in the button that closes the action sheet. */
+ cancelText?: string;
+ /** Specifies whether or not to display the Cancel button in action sheet. */
+ showCancelButton?: boolean;
+ /** A Boolean value specifying whether or not the title of the action sheet is visible. */
+ showTitle?: boolean;
+ /** Specifies the element the action sheet popover points at. */
+ target?: any;
+ /** The title of the action sheet. */
+ title?: string;
+ /** Specifies whether or not to show the action sheet within a dxPopover widget. */
+ usePopover?: boolean;
+ /** A Boolean value specifying whether or not the dxActionSheet widget is visible. */
+ visible?: boolean;
+ }
+ /** A widget consisting of a set of choices related to a certain task. */
+ export class dxActionSheet extends CollectionWidget {
+ constructor(element: JQuery, options?: dxActionSheetOptions);
+ constructor(element: Element, options?: dxActionSheetOptions);
+ /** Hides the widget. */
+ hide(): JQueryPromise<dxActionSheet>;
+ /** Shows the widget. */
+ show(): JQueryPromise<dxActionSheet>;
+ /** Shows or hides the widget depending on the Boolean value passed as the parameter. */
+ toggle(showing: boolean): JQueryPromise<dxActionSheet>;
+ }
+}
+interface JQuery {
+ dxTileView(): JQuery;
+ dxTileView(options: "instance"): DevExpress.ui.dxTileView;
+ dxTileView(options: string): any;
+ dxTileView(options: string, ...params: any[]): any;
+ dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery;
+ dxSwitch(): JQuery;
+ dxSwitch(options: "instance"): DevExpress.ui.dxSwitch;
+ dxSwitch(options: string): any;
+ dxSwitch(options: string, ...params: any[]): any;
+ dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery;
+ dxSlideOut(): JQuery;
+ dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut;
+ dxSlideOut(options: string): any;
+ dxSlideOut(options: string, ...params: any[]): any;
+ dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery;
+ dxPivot(): JQuery;
+ dxPivot(options: "instance"): DevExpress.ui.dxPivot;
+ dxPivot(options: string): any;
+ dxPivot(options: string, ...params: any[]): any;
+ dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery;
+ dxPanorama(): JQuery;
+ dxPanorama(options: "instance"): DevExpress.ui.dxPanorama;
+ dxPanorama(options: string): any;
+ dxPanorama(options: string, ...params: any[]): any;
+ dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery;
+ dxActionSheet(): JQuery;
+ dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet;
+ dxActionSheet(options: string): any;
+ dxActionSheet(options: string, ...params: any[]): any;
+ dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery;
+ dxDropDownMenu(): JQuery;
+ dxDropDownMenu(options: "instance"): DevExpress.ui.dxDropDownMenu;
+ dxDropDownMenu(options: string): any;
+ dxDropDownMenu(options: string, ...params: any[]): any;
+ dxDropDownMenu(options: DevExpress.ui.dxDropDownMenuOptions): JQuery;
+}
+declare module DevExpress.data {
+ export interface XmlaStoreOptions {
+ /** The HTTP address to an XMLA OLAP server. */
+ url?: string;
+ /** The name of the database associated with the Store. */
+ catalog?: string;
+ /** The cube name. */
+ cube?: string;
+ beforeSend?: (request: Object) => void;
+ }
+ /** A Store that provides access to an OLAP cube using the XMLA standard. */
+ export class XmlaStore {
+ constructor(options: XmlaStoreOptions);
+ }
+ export interface PivotGridField {
+ index?: number;
+ /** A boolean value specifying whether or not the field is visible in the pivot grid and the Field Chooser. */
+ visible?: boolean;
+ /** Name of the data source field containing data for the pivot grid field. */
+ dataField?: string;
+ /** A caption that will be displayed in the pivot grid's field chooser to identify the field. */
+ caption?: string;
+ /** Specifies a type of field values. */
+ dataType?: string;
+ /** Specifies how the values of the current field are combined into groups. Cannot be used for the XmlaStore store type. */
+ groupInterval?: any;
+ /** Specifies how to aggregate field data. Cannot be used for th XmlaStore store type. */
+ summaryType?: string;
+ /** Allows you to use a custom aggregate function to calculate the summary values. Cannot be used for the XmlaStore store type. */
+ calculateCustomSummary?: (options: {
+ summaryProcess?: string;
+ value?: any;
+ totalValue?: any;
+ }) => void;
+ /** Specifies the function that determines how to split data from the data source into ranges for header items. Cannot be used for the XmlaStore store type. */
+ selector?: (data: Object) => any;
+ /** Type of the area where the field is located. */
+ area?: string;
+ /** Index among the other fields displayed within the same area. */
+ areaIndex?: number;
+ /** The name of the folder in which the field is located. */
+ displayFolder?: string;
+ /** The name of the group to which the field belongs. */
+ groupName?: string;
+ /** The index of the field within a group. */
+ groupIndex?: number;
+ /** Specifies the initial sort order of field values. */
+ sortOrder?: string;
+ /** Specifies how field data should be sorted. Can be used for the XmlaStore store type only. */
+ sortBy?: string;
+ /** Specifies the data field against which the header items of this field should be sorted. */
+ sortBySummaryField?: string;
+ /** The array of field names that specify a path to column/row whose summary field is used for sorting of this field's header items. */
+ sortBySummaryPath?: Array<any>;
+ /** The filter values for the current field. */
+ filterValues?: Array<any>;
+ /** The filter type for the current field. */
+ filterType?: string;
+ /** Indicates whether all header items of the field's header level are expanded. */
+ expanded?: boolean;
+ /** Specifies whether the field should be treated as a Data Field. */
+ isMeasure?: boolean;
+ /** Specifies a display format for field values. */
+ format?: string;
+ /** Specifies a callback function that returns the text to be displayed in the cells of a field. */
+ customizeText?: (cellInfo: { value: any; valueText: string }) => string;
+ /** Specifies a precision for formatted field values. */
+ precision?: number;
+ /** Specifies how to sort the header items. */
+ sortingMethod?: (a: Object, b: Object) => number;
+ /** Allows an end-user to change sorting options. */
+ allowSorting?: boolean;
+ /** Allows an end-user to sort columns by summary values. */
+ allowSortingBySummary?: boolean;
+ /** Allows an end-user to change filtering options. */
+ allowFiltering?: boolean;
+ /** Allows an end-user to expand/collapse all header items within a header level. */
+ allowExpandAll?: boolean;
+ /** Specifies the absolute width of the field in the pivot grid. */
+ width?: number;
+ }
+ export interface PivotGridDataSourceOptions {
+ /** Specifies the underlying Store instance used to access data. */
+ store?: any;
+ /** Indicates whether or not the automatic field generation from data in the Store is enabled. */
+ retrieveFields?: boolean;
+ /** Specifies data filtering conditions. */
+ filter?: Object;
+ /** An array of pivot grid fields. */
+ fields?: Array<PivotGridField>;
+ /** Indicates whether or not the local sorting of the XMLA data should be performed. */
+ localSorting?: boolean;
+ /** A handler for the changed event. */
+ onChanged?: () => void;
+ /** A handler for the loadingChanged event. */
+ onLoadingChanged?: (isLoading: boolean) => void;
+ /** A handler for the loadError event. */
+ onLoadError?: (e?: Object) => void;
+ /** A handler for the fieldsPrepared event. */
+ onFieldsPrepared?: (e?: Array<PivotGridField>) => void;
+ }
+ /** An object that provides access to data for the dxPivotGrid widget. */
+ export class PivotGridDataSource implements EventsMixin<PivotGridDataSource> {
+ constructor(options?: PivotGridDataSource);
+ /** Starts loading data. */
+ load(): JQueryPromise<any>;
+ /** Indicates whether or not the PivotGridDataSource is currently being loaded. */
+ isLoading(): boolean;
+ /** Gets data displayed in a PivotGrid. */
+ getData(): Object;
+ /** Gets all fields within a specified area. */
+ getAreaFields(area: string, collectGroups: boolean): Array<PivotGridField>;
+ /** Gets all fields from the data source. */
+ fields(): Array<PivotGridField>;
+ /** Sets the fields option. */
+ fields(fields: Array<PivotGridField>): void;
+ /** Gets current options of a specified field. */
+ field(id: any): PivotGridField;
+ /** Sets one or more options of a specified field. */
+ field(id: any, field: PivotGridField): void;
+ /** Collapses a specified header item. */
+ collapseHeaderItem(area: string, path: Array<any>): void;
+ /** Expands a specified header item. */
+ expandHeaderItem(area: string, path: Array<any>): void;
+ /** Expands all header items of a field. */
+ expandAll(id: any): void;
+ /** Collapses all header items of a field. */
+ collapseAll(id: any): void;
+ /** Disposes of all resources associated with this PivotGridDataSource. */
+ dispose(): void;
+ on(eventName: string, eventHandler: Function): PivotGridDataSource;
+ on(events: { [eventName: string]: Function; }): PivotGridDataSource;
+ off(eventName: string): PivotGridDataSource;
+ off(eventName: string, eventHandler: Function): PivotGridDataSource;
+ }
+}
+declare module DevExpress.ui {
+ export interface dxSchedulerOptions extends WidgetOptions {
+ /** Specifies a date displayed on the current scheduler view by default. */
+ currentDate?: Date;
+ /** The earliest date the widget allows you to select. */
+ min?: Date;
+ /** The latest date the widget allows you to select. */
+ max?: Date;
+ /** Specifies the view used in the scheduler by default. */
+ currentView?: string;
+ /** A data source used to fetch data to be displayed by the widget. */
+ dataSource?: any;
+ /** Specifies the first day of a week. */
+ firstDayOfWeek?: number;
+ /** The template to be used for rendering appointments. */
+ appointmentTemplate?: any;
+ /** Lists the views to be available within the scheduler's View Selector. */
+ views?: Array<string>;
+ /** Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */
+ groups?: Array<string>;
+ /** Specifies a start hour in the scheduler view's time interval. */
+ startDayHour?: number;
+ /** Specifies an end hour in the scheduler view's time interval. */
+ endDayHour?: number;
+ /** Specifies whether the scheduler data can be edited at runtime. */
+ editing?: boolean;
+ /** Specifies an array of resources available in the scheduler. */
+ resources?: Array<{
+ /** Indicates whether or not several resources of this kind can be assigned to an appointment. */
+ allowMultiple?: boolean;
+ /** Indicates whether or not resources of this kind have priority in the color identification of the appointments that have resources of different kinds assigned. */
+ mainColor?: boolean;
+ /** A data source used to fetch resources to be available in the scheduler. */
+ dataSource?: any;
+ /** Specifies the resource object field whose value is displayed by the Resource editor in the Appointment popup window. */
+ displayExpr?: any;
+ /** Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */
+ valueExpr?: any;
+ /** The name of the appointment object field that specifies a resource of this kind. */
+ field?: string;
+ /** Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */
+ label?: string;
+ }>;
+ /** A handler for the AppointmentAdding event. */
+ onAppointmentAdding?: Function;
+ /** A handler for the appointmentAdded event. */
+ onAppointmentAdded?: Function;
+ /** A handler for the AppointmentUpdating event. */
+ onAppointmentUpdating?: Function;
+ /** A handler for the appointmentUpdated event. */
+ onAppointmentUpdated?: Function;
+ /** A handler for the AppointmentDeleting event. */
+ onAppointmentDeleting?: Function;
+ /** A handler for the appointmentDeleted event. */
+ onAppointmentDeleted?: Function;
+ /** A handler for the appointmentRendered event. */
+ onAppointmentRendered?: Function;
+ }
+ /** A widget that displays scheduled data using different views and provides the capability to load, add and edit appointments. */
+ export class dxScheduler extends Widget {
+ constructor(element: JQuery, options?: dxSchedulerOptions);
+ constructor(element: Element, options?: dxSchedulerOptions);
+ /** Add the appointment defined by the object passed as a parameter to the data associated with the widget. */
+ addAppointment(appointment: Object): void;
+ /** Updates the appointment specified by the first method parameter by the appointment object specified by the second method parameter in the the data associated with the widget. */
+ updateAppointment(target: Object, appointment: Object): void;
+ /** Deletes the appointment defined by the parameter from the the data associated with the widget. */
+ deleteAppointment(appointment: Object): void;
+ /** Scrolls the scheduler work space to the specified time. */
+ scrollToTime(hours: number, minutes: number): void;
+ }
+ export interface dxColorBoxOptions extends dxDropDownEditorOptions {
+ /** Specifies the text displayed on the button that applies changes and closes the drop-down editor. */
+ applyButtonText?: string;
+ applyValueMode?: string;
+ /** Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */
+ cancelButtonText?: string;
+ /** Specifies whether or not the widget value includes the alpha channel component. */
+ editAlphaChannel?: boolean;
+ /** Specifies the size of a step by which a handle is moved using a keyboard shortcut. */
+ keyStep?: number;
+ }
+ /** A widget used to specify a color value. */
+ export class dxColorBox extends dxDropDownEditor {
+ constructor(element: JQuery, options?: dxColorBoxOptions);
+ constructor(element: Element, options?: dxColorBoxOptions);
+ }
+ export interface dxColorPickerOptions extends dxColorBoxOptions { }
+ /**
+ * A widget used to specify a color value.
+ * @deprecated Use the dxColorBox widget instead
+ */
+ export class dxColorPicker extends dxColorBox {
+ constructor(element: JQuery, options?: dxColorPickerOptions);
+ constructor(element: Element, options?: dxColorPickerOptions);
+ }
+ export interface dxTreeViewOptions extends CollectionWidgetOptions {
+ /** Specifies whether or not to animate item collapsing and expanding. */
+ animationEnabled?: boolean;
+ /** Specifies whether a nested or plain array is used as a data source. */
+ dataStructure?: string;
+ /** Specifies whether or not a user can expand all tree view items by the "*" hot key. */
+ expandAllEnabled?: boolean;
+ /**
+ * An array of currently expanded item objects.
+ * @deprecated Use item.expanded field instead
+ */
+ expandedItems?: Array<any>;
+ /** Specifies whether or not a check box is displayed at each tree view item. */
+ showCheckBoxes?: boolean;
+ /** Specifies whether or not to select nodes recursively. */
+ selectNodesRecursive?: boolean;
+ /** Specifies whether the "Select All" check box is displayed over the tree view. */
+ selectAllEnabled?: boolean;
+ /** Specifies the text displayed at the "Select All" check box. */
+ selectAllText?: string;
+ /** Specifies the name of the data source item field used as a key. */
+ keyExpr?: any;
+ /** Specifies the name of the data source item field whose value is displayed by the widget. */
+ displayExpr?: any;
+ /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is selected. */
+ selectedExpr?: any;
+ /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is expanded. */
+ expandedExpr?: any;
+ /** Specifies the name of the data source item field that contains an array of nested items. */
+ itemsExpr?: any;
+ /** Specifies the name of the data source item field that holds the key of the parent item. */
+ parentIdExpr?: any;
+ /** Specifies the name of the data source item field whose value defines whether or not the corresponding node is disabled. */
+ disabledExpr?: any;
+ /** Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */
+ hasItemsExpr?: any;
+ /** Specifies if the virtual mode is enabled. */
+ virtualModeEnabled?: boolean;
+ /** Specifies the parent ID value of the root item. */
+ rootValue?: any;
+ /** A string value specifying available scrolling directions. */
+ scrollDirection?: string;
+ /** A handler for the itemSelected event. */
+ onItemSelected?: Function;
+ /** A handler for the itemExpanded event. */
+ onItemExpanded?: Function;
+ /** A handler for the itemCollapsed event. */
+ onItemCollapsed?: Function;
+ onItemClick?: Function;
+ onItemContextMenu?: Function;
+ onItemRendered?: Function;
+ onItemHold?: Function;
+ hoverStateEnabled?: boolean;
+ focusStateEnabled?: boolean;
+ }
+ /** A widget displaying specified data items as a tree. */
+ export class dxTreeView extends CollectionWidget {
+ constructor(element: JQuery, options?: dxTreeViewOptions);
+ constructor(element: Element, options?: dxTreeViewOptions);
+ /** Updates the tree view scrollbars according to the current size of the widget content. */
+ updateDimensions(): JQueryPromise<void>;
+ /** Selects the specified item. */
+ selectItem(itemElement: any): void;
+ /** Unselects the specified item. */
+ unselectItem(itemElement: any): void;
+ /** Expands the specified item. */
+ expandItem(itemElement: any): void;
+ /** Collapses the specified item. */
+ collapseItem(itemElement: any): void;
+ /** Returns all nodes of the tree view. */
+ getNodes(): Array<Object>;
+ /** Selects all widget items. */
+ selectAll(): void;
+ /** Unselects all widget items. */
+ unselectAll(): void;
+ }
+ export interface dxMenuBaseOptions extends CollectionWidgetOptions {
+ /** An object that defines the animation options of the widget. */
+ animation?: fx.AnimationOptions;
+ /** A Boolean value specifying whether or not the widget changes its state when interacting with a user. */
+ activeStateEnabled?: boolean;
+ /** Specifies the name of the CSS class associated with the menu. */
+ cssClass?: string;
+ /** Holds an array of menu items. */
+ items?: Array<any>;
+ /** Specifies whether or not an item becomes selected if an end-user clicks it. */
+ selectionByClick?: boolean;
+ /** Specifies the selection mode supported by the menu. */
+ selectionMode?: string;
+ /** Specifies options of submenu showing and hiding. */
+ showSubmenuMode?: {
+ /** Specifies the mode name. */
+ name?: string;
+ /** Specifies the delay of submenu show and hiding. */
+ delay?: {
+ /** The time span after which the submenu is shown. */
+ show?: number;
+ /** The time span after which the submenu is hidden. */
+ hide?: number;
+ };
+ };
+ /** A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. */
+ hoverStateEnabled?: boolean;
+ }
+ export class dxMenuBase extends CollectionWidget {
+ constructor(element: JQuery, options?: dxMenuBaseOptions);
+ constructor(element: Element, options?: dxMenuBaseOptions);
+ /** Selects the specified item. */
+ selectItem(itemElement: any): void;
+ /** Unselects the specified item. */
+ unselectItem(itemElement: any): void;
+ }
+ export interface dxMenuOptions extends dxMenuBaseOptions {
+ /** Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */
+ hideSubmenuOnMouseLeave?: boolean;
+ /** Specifies whether the menu has horizontal or vertical orientation. */
+ orientation?: string;
+ /** Specifies options for showing and hiding the first level submenu. */
+ showFirstSubmenuMode?: {
+ /** Specifies the mode name. */
+ name?: string;
+ /** Specifies the delay of submenu showing and hiding. */
+ delay?: {
+ /** The time span after which the submenu is shown. */
+ show?: number;
+ /** The time span after which the submenu is hidden. */
+ hide?: number;
+ };
+ };
+ /** Specifies the direction at which the submenus are displayed. */
+ submenuDirection?: string;
+ /** A handler for the submenuHidden event. */
+ onSubmenuHidden?: Function;
+ submenuHiddenAction?: Function;
+ /** A handler for the submenuHiding event. */
+ onSubmenuHiding?: Function;
+ submenuHidingAction?: Function;
+ /** A handler for the submenuShowing event. */
+ onSubmenuShowing?: Function;
+ submenuShowingAction?: Function;
+ /** A handler for the submenuShown event. */
+ onSubmenuShown?: Function;
+ submenuShownAction?: Function;
+ }
+ /** A menu widget. */
+ export class dxMenu extends dxMenuBase {
+ constructor(element: JQuery, options?: dxMenuOptions);
+ constructor(element: Element, options?: dxMenuOptions);
+ }
+ export interface dxContextMenuOptions extends dxMenuBaseOptions {
+ /** Holds an object that specifies options of alternative menu invocation. */
+ alternativeInvocationMode?: {
+ /** Specifies whether or not the standard context menu invocation (on a right mouse click or on a long tap) is disabled. */
+ enabled?: Boolean;
+ /** Specifies the element used to invoke the context menu. */
+ invokingElement?: any;
+ };
+ /** A handler for the hidden event. */
+ onHidden?: Function;
+ /** A handler for the hiding event. */
+ onHiding?: Function;
+ /** A handler for the positioning event. */
+ onPositioning?: Function;
+ /** A handler for the showing event. */
+ onShowing?: Function;
+ /** A handler for the shown event. */
+ onShown?: Function;
+ /** An object defining widget positioning options. */
+ position?: PositionOptions;
+ /** Specifies the direction at which submenus are displayed. */
+ submenuDirection?: string;
+ /** The target element associated with a popover. */
+ target?: any;
+ /** A Boolean value specifying whether or not the widget is visible. */
+ visible?: boolean;
+ }
+ /** A context menu widget. */
+ export class dxContextMenu extends dxMenuBase {
+ constructor(element: JQuery, options?: dxContextMenuOptions);
+ constructor(element: Element, options?: dxContextMenuOptions);
+ /** Toggles the visibility of the widget. */
+ toggle(showing: boolean): JQueryPromise<void>;
+ /** Shows the widget. */
+ show(): JQueryPromise<void>;
+ /** Hides the widget. */
+ hide(): JQueryPromise<void>;
+ }
+ export interface dxRemoteOperations {
+ /** Specifies whether or not filtering must be performed on the server side. */
+ filtering?: boolean;
+ /** Specifies whether or not paging must be performed on the server side. */
+ paging?: boolean;
+ /** Specifies whether or not sorting must be performed on the server side. */
+ sorting?: boolean;
+ }
+ export interface dxDataGridColumn {
+ /** Specifies the content alignment within column cells. */
+ alignment?: string;
+ /** Specifies whether the values in a column can be edited at runtime. Setting this option makes sense only when editing is enabled for a grid. */
+ allowEditing?: boolean;
+ /** Specifies whether or not a column can be used for filtering grid records. Setting this option makes sense only when the filter row and column header filtering are visible. */
+ allowFiltering?: boolean;
+ /** Specifies whether or not the column can be anchored to a grid edge by end users. Setting this option makes sense only when the columnFixing | enabled option is set to true. */
+ allowFixing?: boolean;
+ /** Specifies if a column can be used for searching grid records. Setting this option makes sense only when the search panel is visible. */
+ allowSearch?: boolean;
+ /** Specifies whether a column can be used for grouping grid records at runtime. Setting this option makes sense only when the group panel is visible. */
+ allowGrouping?: boolean;
+ /** Specifies whether or not a column can be hidden by a user. Setting this option makes sense only when the column chooser is visible. */
+ allowHiding?: boolean;
+ /** Specifies whether or not a particular column can be used in column reordering. Setting this option makes sense only when the allowColumnReordering option is set to true. */
+ allowReordering?: boolean;
+ /** Specifies whether or not a particular column can be resized by a user. Setting this option makes sense only when the allowColumnResizing option is true. */
+ allowResizing?: boolean;
+ /** Specifies whether grid records can be sorted by a specific column at runtime. Setting this option makes sense only when the sorting mode differs from none. */
+ allowSorting?: boolean;
+ /** Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column. */
+ autoExpandGroup?: boolean;
+ /** Specifies a callback function that returns a value to be displayed in a column cell. */
+ calculateCellValue?: (rowData: Object) => string;
+ /** Specifies a callback function that defines filters for customary calculated grid cells. */
+ calculateFilterExpression?: (filterValue: any, selectedFilterOperation: string) => Array<any>;
+ /** Specifies a caption for a column. */
+ caption?: string;
+ /** Specifies a custom template for grid column cells. */
+ cellTemplate?: any;
+ /** Specifies a CSS class to be applied to a column. */
+ cssClass?: string;
+ /** Specifies a field name or a function that returns a field name or a value to be used for grouping column cells. */
+ calculateGroupValue?: any;
+ /** Specifies a field name or a function that returns a field name or a value to be used for sorting column cells. */
+ calculateSortValue?: any;
+ /** Specifies a callback function that returns the text to be displayed in the cells of a column. */
+ customizeText?: (cellInfo: { value: any; valueText: string }) => string;
+ /** Specifies the field of a data source that provides data for a column. */
+ dataField?: string;
+ /** Specifies the required type of column values. */
+ dataType?: string;
+ /** Specifies a custom template for the cell of a grid column when it is in an editing state. */
+ editCellTemplate?: any;
+ /** Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */
+ encodeHtml?: boolean;
+ /** In a boolean column, replaces all false items with a specified text. */
+ falseText?: string;
+ /** Specifies the set of available filter operations. */
+ filterOperations?: Array<any>;
+ /** Specifies a filter value for a column. */
+ filterValue?: any;
+ /** Specifies initial filter values for the column's header filter. */
+ filterValues?: Array<any>;
+ /** Specifies whether to include or exclude the records with the values selected in the column's header filter. */
+ filterType?: string;
+ /** Indicates whether the column takes part in horizontal grid scrolling or is anchored to a grid edge. */
+ fixed?: boolean;
+ /** Specifies the grid edge to which the column is anchored. */
+ fixedPosition?: string;
+ /** Specifies a format for the values displayed in a column. */
+ format?: string;
+ /** Specifies a custom template for the group cell of a grid column. */
+ groupCellTemplate?: any;
+ /** Specifies the index of a column when grid records are grouped by the values of this column. */
+ groupIndex?: number;
+ /** Specifies a custom template for the header of a grid column. */
+ headerCellTemplate?: any;
+ /** Specifies options of a lookup column. */
+ lookup?: {
+ /** Specifies whether or not a user can nullify values of a lookup column. */
+ allowClearing?: boolean;
+ /** Specifies the data source providing data for a lookup column. */
+ dataSource?: any;
+ /** Specifies the expression defining the data source field whose values must be displayed. */
+ displayExpr?: any;
+ /** Specifies the expression defining the data source field whose values must be replaced. */
+ valueExpr?: string;
+ };
+ /** Specifies a precision for formatted values displayed in a column. */
+ precision?: number;
+ /** Specifies a filter operation applied to a column. */
+ selectedFilterOperation?: string;
+ /** Specifies whether or not the column displays its values by using editors. */
+ showEditorAlways?: boolean;
+ /** Specifies whether or not to display the column when grid records are grouped by it. */
+ showWhenGrouped?: boolean;
+ /** Specifies the index of a column when grid records are sorted by the values of this column. */
+ sortIndex?: number;
+ /** Specifies the initial sort order of column values. */
+ sortOrder?: string;
+ /** In a boolean column, replaces all true items with a specified text. */
+ trueText?: string;
+ /** Specifies whether a column is visible or not. */
+ visible?: boolean;
+ /** Specifies the sequence number of the column in the grid. */
+ visibleIndex?: number;
+ /** Specifies a column width in pixels or percentages. */
+ width?: any;
+ /** Specifies an array of validation rules to be checked when updating column cell values. */
+ validationRules?: Array<Object>;
+ /** Specifies whether or not to display the header of a hidden column in the column chooser. */
+ showInColumnChooser?: boolean;
+ /** Specifies the identifier of the column. */
+ name?: string;
+ // NOTE https://github.com/borisyankov/DefinitelyTyped/pull/5590
+ text?: string;
+ value?: any;
+ }
+ export interface dxDataGridOptions extends WidgetOptions {
+ /** Specifies whether the outer borders of the grid are visible or not. */
+ showBorders?: boolean;
+ /** Indicates whether to show the error row for the grid. */
+ errorRowEnabled?: boolean;
+ /** A handler for the rowValidating event. */
+ onRowValidating?: (e: Object) => void;
+ /** A handler for the contextMenuPreparing event. */
+ onContextMenuPreparing?: (e: Object) => void;
+ initNewRow?: (e: { data: Object }) => void;
+ /** A handler for the initNewRow event. */
+ onInitNewRow?: (e: { data: Object }) => void;
+ rowInserted?: (e: { data: Object; key: any }) => void;
+ /** A handler for the rowInserted event. */
+ onRowInserted?: (e: { data: Object; key: any }) => void;
+ rowInserting?: (e: { data: Object; cancel: boolean }) => void;
+ /** A handler for the rowInserting event. */
+ onRowInserting?: (e: { data: Object; cancel: boolean }) => void;
+ rowRemoved?: (e: { data: Object; key: any }) => void;
+ /** A handler for the rowRemoved event. */
+ onRowRemoved?: (e: { data: Object; key: any }) => void;
+ rowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void;
+ /** A handler for the rowRemoving event. */
+ onRowRemoving?: (e: { data: Object; key: any; cancel: boolean }) => void;
+ rowUpdated?: (e: { data: Object; key: any }) => void;
+ /** A handler for the rowUpdated event. */
+ onRowUpdated?: (e: { data: Object; key: any }) => void;
+ rowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void;
+ /** A handler for the rowUpdating event. */
+ onRowUpdating?: (e: { oldData: Object; newData: Object; key: any; cancel: boolean }) => void;
+ /** Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */
+ cellHintEnabled?: boolean;
+ /** Specifies whether or not grid columns can be reordered by a user. */
+ allowColumnReordering?: boolean;
+ /** Specifies whether or not grid columns can be resized by a user. */
+ allowColumnResizing?: boolean;
+ cellClick?: any;
+ /** A handler for the cellClick event. */
+ onCellClick?: any;
+ cellHoverChanged?: (e: Object) => void;
+ /** A handler for the cellHoverChanged event. */
+ onCellHoverChanged?: (e: Object) => void;
+ cellPrepared?: (e: Object) => void;
+ /** A handler for the cellPrepared event. */
+ onCellPrepared?: (e: Object) => void;
+ /** Specifies whether or not the width of grid columns depends on column content. */
+ columnAutoWidth?: boolean;
+ /** Specifies the options of a column chooser. */
+ columnChooser?: {
+ /** Specifies text displayed by the column chooser panel when it does not contain any columns. */
+ emptyPanelText?: string;
+ /** Specifies whether a user can invoke the column chooser or not. */
+ enabled?: boolean;
+ /** Specifies the height of the column chooser panel. */
+ height?: number;
+ /** Specifies text displayed in the title of the column chooser panel. */
+ title?: string;
+ /** Specifies the width of the column chooser panel. */
+ width?: number;
+ };
+ /** Specifies options for column fixing. */
+ columnFixing?: {
+ /** Indicates if column fixing is enabled. */
+ enabled?: boolean;
+ /** Contains options that specify texts for column-fixing related commands in the column header's context menu. */
+ texts?: {
+ /** Specifies text for a context menu item that fixes the column for which the context menu is invoked. */
+ fix?: string;
+ /** Specifies text for a context menu item that unfixes the column for which the context menu is invoked. */
+ unfix?: string;
+ /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the left grid edge. */
+ leftPosition?: string;
+ /** Specifies text for a context menu subitem that fixes a column, for which the context menu is invoked, to the right grid edge. */
+ rightPosition?: string;
+ };
+ };
+ /** Specifies options for filtering using a column header filter. */
+ headerFilter?: {
+ /** Indicates whether or not the column header filter button is visible. */
+ visible?: boolean;
+ /** Specifies the height of the dropdown menu invoked when using a column header filter. */
+ height?: number;
+ /** Specifies the width of the dropdown menu invoked when using a column header filter. */
+ width?: number;
+ /** Contains options that specify texts for the dropdown menu invoked when you use a column header filter. */
+ texts?: {
+ /** Specifies text for the item specifying an empty value in the column header filter's dropdown menu. */
+ emptyValue?: string;
+ /** Specifies text for a button that closes the column header filter's dropdown menu and applies specified filtering. */
+ ok?: string;
+ /** Specifies text for a button that closes the column header filter's dropdown menu without applying performed selection. */
+ cancel?: string;
+ }
+ };
+ /** An array of grid columns. */
+ columns?: Array<dxDataGridColumn>;
+ onContentReady?: Function;
+ contentReadyAction?: Function;
+ /** Specifies a function that customizes grid columns after they are created. */
+ customizeColumns?: (columns: Array<dxDataGridColumn>) => void;
+ dataErrorOccurred?: (errorObject: Error) => void;
+ /** Specifies a data source for the grid. */
+ dataSource?: any;
+ editingStart?: (e: {
+ data: Object;
+ key: any;
+ cancel: boolean;
+ column: dxDataGridColumn
+ }) => void;
+ /** A handler for the editingStart event. */
+ onEditingStart?: (e: {
+ data: Object;
+ key: any;
+ cancel: boolean;
+ column: dxDataGridColumn
+ }) => void;
+ editorPrepared?: (e: Object) => void;
+ /** A handler for the editorPrepared event. */
+ onEditorPrepared?: (e: Object) => void;
+ editorPreparing?: (e: Object) => void;
+ /** A handler for the editorPreparing event. */
+ onEditorPreparing?: (e: Object) => void;
+ /** Contains options that specify how grid content can be changed. */
+ editing?: {
+ /** Specifies whether or not grid records can be edited at runtime. */
+ editEnabled?: boolean;
+ /** Specifies how grid values can be edited manually. */
+ editMode?: string;
+ /** Specifies whether or not new records can be inserted into a grid. */
+ insertEnabled?: boolean;
+ /** Specifies whether or not records can be deleted from a grid. */
+ removeEnabled?: boolean;
+ /** Contains options that specify texts for editing-related grid controls. */
+ texts?: {
+ /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Save" button. Setting this option makes sense only when the editMode option is set to batch. */
+ saveAllChanges?: string;
+ /** Specifies text for a cancel button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */
+ cancelRowChanges?: string;
+ /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Revert" button. Setting this option makes sense only when the editMode option is set to batch. */
+ cancelAllChanges?: string;
+ /** Specifies a message to be displayed by a confirmation window. Setting this option makes sense only when the edit mode is "row". */
+ confirmDeleteMessage?: string;
+ /** Specifies text to be displayed in the title of a confirmation window. Setting this option makes sense only when the edit mode is "row". */
+ confirmDeleteTitle?: string;
+ /** Specifies text for a button that deletes a row from a grid. Setting this option makes sense only when the removeEnabled option is set to true. */
+ deleteRow?: string;
+ /** Specifies text for a hint that appears when a user hovers the mouse pointer over the "Add" button. Setting this option makes sense only when the insertEnabled option is true. */
+ addRow?: string;
+ /** Specifies text for a button that turns a row into the editing state. Setting this option makes sense only when the editEnabled option is set to true. */
+ editRow?: string;
+ /** Specifies text for a save button displayed when a row is in the editing state. Setting this option makes sense only when the editEnabled option is set to true. */
+ saveRowChanges?: string;
+ /** Specifies text for a button that recovers a deleted row. Setting this option makes sense only if the grid uses the batch edit mode and the removeEnabled option is set to true. */
+ undeleteRow?: string;
+ };
+ };
+ /** Specifies filter row options. */
+ filterRow?: {
+ /** Specifies when to apply a filter. */
+ applyFilter?: string;
+ /** Specifies text for the hint that pops up when a user hovers the mouse pointer over the "Apply Filter" button. */
+ applyFilterText?: string;
+ /** Specifies descriptions for filter operations. */
+ operationDescriptions?: {
+ "=": string;
+ "<>": string;
+ "<": string;
+ "<=": string;
+ ">": string;
+ ">=": string;
+ "startswith": string;
+ "contains": string;
+ "notcontains": string;
+ "endswith": string;
+ };
+ /** Specifies text for the reset operation in a filter list. */
+ resetOperationText?: string;
+ /** Specifies text for the operation of clearing the applied filter when a select box is used. */
+ showAllText?: string;
+ /** Specifies whether or not an icon that allows the user to choose a filter operation is visible. */
+ showOperationChooser?: boolean;
+ /** Specifies whether the filter row is visible or not. */
+ visible?: boolean;
+ };
+ /** Specifies the behavior of grouped grid records. */
+ grouping?: {
+ /** Specifies whether the user can collapse grouped records in a grid or not. */
+ allowCollapsing?: boolean;
+ /** Specifies whether groups appear expanded or not. */
+ autoExpandAll?: boolean;
+ /** Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */
+ groupContinuedMessage?: string;
+ /** Specifies the message displayed in a group row when the corresponding group continues on the next page. */
+ groupContinuesMessage?: string;
+ };
+ /** Specifies options that configure the group panel. */
+ groupPanel?: {
+ /** Specifies whether columns can be dragged onto or from the group panel. */
+ allowColumnDragging?: boolean;
+ /** Specifies text displayed by the group panel when it does not contain any columns. */
+ emptyPanelText?: string;
+ /** Specifies whether the group panel is visible or not. */
+ visible?: boolean;
+ };
+ /** Specifies options configuring the load panel. */
+ loadPanel?: {
+ /** Specifies whether to show the load panel or not. */
+ enabled?: boolean;
+ /** Specifies the height of the load panel in pixels. */
+ height?: number;
+ /** Specifies a URL pointing to an image to be used as a loading indicator. */
+ indicatorSrc?: string;
+ /** Specifies whether or not a loading indicator must be displayed on the load panel. */
+ showIndicator?: boolean;
+ /** Specifies whether or not the pane of the load panel must be displayed. */
+ showPane?: boolean;
+ /** Specifies text displayed by the load panel. */
+ text?: string;
+ /** Specifies the width of the load panel in pixels. */
+ width?: number;
+ };
+ /** Specifies text displayed when a grid does not contain any records. */
+ noDataText?: string;
+ /** Specifies the options of a grid pager. */
+ pager?: {
+ /** Specifies the page sizes that can be selected at runtime. */
+ allowedPageSizes?: any;
+ /** Specifies whether to show the page size selector or not. */
+ showPageSizeSelector?: boolean;
+ /** Specifies whether to show the pager or not. */
+ visible?: any;
+ /** Specifies the text accompanying the page navigator. */
+ infoText?: string;
+ /** Specifies whether or not to display the text accompanying the page navigator. This text is specified by the infoText option. */
+ showInfo?: boolean;
+ /** Specifies whether or not to display buttons that switch the grid to the previous or next page. */
+ showNavigationButtons?: boolean;
+ };
+ /** Specifies paging options. */
+ paging?: {
+ /** Specifies whether dxDataGrid loads data page by page or all at once. */
+ enabled?: boolean;
+ /** Specifies the grid page that should be displayed by default. */
+ pageIndex?: number;
+ /** Specifies the size of grid pages. */
+ pageSize?: number;
+ };
+ /** Specifies whether or not grid rows must be shaded in a different way. */
+ rowAlternationEnabled?: boolean;
+ rowClick?: any;
+ /** A handler for the rowClick event. */
+ onRowClick?: any;
+ rowPrepared?: (e: Object) => void;
+ /** A handler for the rowPrepared event. */
+ onRowPrepared?: (e: Object) => void;
+ /** Specifies a custom template for grid rows. */
+ rowTemplate?: any;
+ /** A configuration object specifying scrolling options. */
+ scrolling?: {
+ /** Specifies the scrolling mode. */
+ mode?: string;
+ /** Specifies whether or not a grid must preload pages adjacent to the current page when using virtual scrolling. */
+ preloadEnabled?: boolean;
+ };
+ /** Specifies options of the search panel. */
+ searchPanel?: {
+ /** Specifies whether or not search strings in the located grid records should be highlighted. */
+ highlightSearchText?: boolean;
+ /** Specifies text displayed by the search panel when no search string was typed. */
+ placeholder?: string;
+ /** Specifies whether the search panel is visible or not. */
+ visible?: boolean;
+ /** Specifies the width of the search panel in pixels. */
+ width?: number;
+ /** Sets a search string for the search panel. */
+ text?: string;
+ };
+ /** Specifies the operations that must be performed on the server side. */
+ remoteOperations?: any;
+ /** Allows you to sort groups according to the values of group summary items. */
+ sortByGroupSummaryInfo?: Array<{
+ /** Specifies the group summary item whose values must be used to sort groups. */
+ summaryItem?: string;
+ /** Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */
+ groupColumn?: string;
+ /** Specifies the sort order of group summary item values. */
+ sortOrder?: string;
+ }>;
+ /** Allows you to build a master-detail interface in the grid. */
+ masterDetail?: {
+ /** Enables an end-user to expand/collapse detail sections. */
+ enabled?: boolean;
+ /** Specifies whether detail sections appear expanded or collapsed. */
+ autoExpandAll?: boolean;
+ /** Specifies the template for detail sections. */
+ template?: any;
+ };
+ /** Specifies options for exporting grid data. */
+ export?: {
+ /** Indicates if the export feature is enabled in the grid. */
+ enabled?: boolean;
+ /** Specifies a default name for the file to which grid data is exported. */
+ fileName?: string;
+ /** Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file. */
+ excelFilterEnabled?: boolean;
+ /** Specifies whether to enable word wrapping for the exported data in the resulting XLSX file. */
+ excelWrapTextEnabled?: boolean;
+ /** Specifies the URL of the server-side proxy that streams the resulting file to the end user to enable export in IE8, IE9 and Safari browsers. */
+ proxyUrl?: string;
+ /** Indicates whether to allow end users to export not only the data displayed in the grid, but the selected rows only. */
+ allowExportSelectedData?: boolean;
+ /** Contains options that specify texts for the export-related commands and hints. */
+ texts?: {
+ /** Specifies text for the Export button when this button invokes a dropdown menu so you can choose the required export format. */
+ exportTo?: string;
+ /** Specifies text for the Export button when this button exports to the XSLX format. */
+ exportToExcel?: string;
+ /** Specifies text for the item in the Export dropdown menu that exports grid data to Excel. */
+ excelFormat?: string;
+ /** Specifies text for the option in the Export dropdown menu that allows you to choose whether to export all the grid data or the selected rows only. */
+ selectedRows?: string;
+ }
+ };
+ /** Specifies the keys of the records that must appear selected initially. */
+ selectedRowKeys?: Array<any>;
+ /** Specifies options of runtime selection. */
+ selection?: {
+ /** Specifies whether the user can select all grid records at once. */
+ allowSelectAll?: boolean;
+ /** Specifies the selection mode. */
+ mode?: string;
+ };
+ selectionChanged?: (e: {
+ currentSelectedRowKeys: Array<any>;
+ currentDeselectedRowKeys: Array<any>;
+ selectedRowKeys: Array<any>;
+ selectedRowsData: Array<any>;
+ }) => void;
+ /** A handler for the dataErrorOccured event. */
+ onDataErrorOccurred?: (e: { error: Error }) => void;
+ /** A handler for the selectionChanged event. */
+ onSelectionChanged?: (e: {
+ currentSelectedRowKeys: Array<any>;
+ currentDeselectedRowKeys: Array<any>;
+ selectedRowKeys: Array<any>;
+ selectedRowsData: Array<any>;
+ }) => void;
+ /** A handler for the exporting event. */
+ onExporting?: (e: {
+ fileName: string;
+ format: string;
+ cancel: boolean;
+ }) => void;
+ /** A handler for the exported event. */
+ onExported?: (e: Object) => void;
+ /** A handler for the keyDown event. */
+ onKeyDown?: (e: Object) => void;
+ /** A handler for the rowExpanding event. */
+ onRowExpanding?: (e: Object) => void;
+ /** A handler for the rowExpanded event. */
+ onRowExpanded?: (e: Object) => void;
+ /** A handler for the rowCollapsing event. */
+ onRowCollapsing?: (e: Object) => void;
+ /** A handler for the rowCollapsed event. */
+ onRowCollapsed?: (e: Object) => void;
+ /** Specifies whether column headers are visible or not. */
+ showColumnHeaders?: boolean;
+ /** Specifies whether or not vertical lines separating one grid column from another are visible. */
+ showColumnLines?: boolean;
+ /** Specifies whether or not horizontal lines separating one grid row from another are visible. */
+ showRowLines?: boolean;
+ /** Specifies options of runtime sorting. */
+ sorting?: {
+ /** Specifies text for the context menu item that sets an ascending sort order in a column. */
+ ascendingText?: string;
+ /** Specifies text for the context menu item that resets sorting settings for a column. */
+ clearText?: string;
+ /** Specifies text for the context menu item that sets a descending sort order in a column. */
+ descendingText?: string;
+ /** Specifies the runtime sorting mode. */
+ mode?: string;
+ };
+ /** Specifies options of state storing. */
+ stateStoring?: {
+ /** Specifies a callback function that performs specific actions on state loading. */
+ customLoad?: () => JQueryPromise<Object>;
+ /** Specifies a callback function that performs specific actions on state saving. */
+ customSave?: (gridState: Object) => void;
+ /** Specifies whether or not a grid saves its state. */
+ enabled?: boolean;
+ /** Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */
+ savingTimeout?: number;
+ /** Specifies a unique key to be used for storing the grid state. */
+ storageKey?: string;
+ /** Specifies the type of storage to be used for state storing. */
+ type?: string;
+ };
+ /** Specifies the options of the grid summary. */
+ summary?: {
+ /** Contains options that specify text patterns for summary items. */
+ texts?: {
+ /** Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */
+ sum?: string;
+ /** Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */
+ sumOtherColumn?: string;
+ /** Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */
+ min?: string;
+ /** Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */
+ minOtherColumn?: string;
+ /** Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */
+ max?: string;
+ /** Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */
+ maxOtherColumn?: string;
+ /** Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */
+ avg?: string;
+ /** Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */
+ avgOtherColumn?: string;
+ /** Specifies a pattern for the 'count' summary items. */
+ count?: string;
+ };
+ /** Specifies items of the group summary. */
+ groupItems?: Array<{
+ /** Specifies the identifier of a summary item. */
+ name?: string;
+ /** Specifies the column that provides data for a group summary item. */
+ column?: string;
+ /** Customizes the text to be displayed in the summary item. */
+ customizeText?: (itemInfo: {
+ value: any;
+ valueText: string;
+ }) => string;
+ /** Specifies a pattern for the summary item text. */
+ displayFormat?: string;
+ /** Specifies a precision for the summary item value of a numeric format. */
+ precision?: number;
+ /** Specifies whether or not a summary item must be displayed in the group footer. */
+ showInGroupFooter?: boolean;
+ /** Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */
+ alignByColumn?: boolean;
+ /** Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */
+ showInColumn?: string;
+ /** Specifies how to aggregate data for a summary item. */
+ summaryType?: string;
+ /** Specifies a format for the summary item value. */
+ valueFormat?: string;
+ }>;
+ /** Specifies items of the total summary. */
+ totalItems?: Array<{
+ /** Specifies the identifier of a summary item. */
+ name?: string;
+ /** Specifies the alignment of a summary item. */
+ alignment?: string;
+ /** Specifies the column that provides data for a summary item. */
+ column?: string;
+ /** Specifies a CSS class to be applied to a summary item. */
+ cssClass?: string;
+ /** Customizes the text to be displayed in the summary item. */
+ customizeText?: (itemInfo: {
+ value: any;
+ valueText: string;
+ }) => string;
+ /** Specifies a pattern for the summary item text. */
+ displayFormat?: string;
+ /** Specifies a precision for the summary item value of a numeric format. */
+ precision?: number;
+ /** Specifies the column that must hold the summary item. */
+ showInColumn?: string;
+ /** Specifies how to aggregate data for a summary item. */
+ summaryType?: string;
+ /** Specifies a format for the summary item value. */
+ valueFormat?: string;
+ }>;
+ /** Allows you to use a custom aggregate function to calculate the value of a summary item. */
+ calculateCustomSummary?: (options: {
+ component: dxDataGrid;
+ name?: string;
+ value: any;
+ totalValue: any;
+ summaryProcess: string
+ }) => void;
+ };
+ /** Specifies whether text that does not fit into a column should be wrapped. */
+ wordWrapEnabled?: boolean;
+ }
+ /** A data grid widget. */
+ export class dxDataGrid extends Widget {
+ constructor(element: JQuery, options?: dxDataGridOptions);
+ constructor(element: Element, options?: dxDataGridOptions);
+ /** Ungroups grid records. */
+ clearGrouping(): void;
+ /** Clears sorting settings of all grid columns at once. */
+ clearSorting(): void;
+ /** Allows you to obtain a cell by its row index and the data field of its column. */
+ getCellElement(rowIndex: number, dataField: string): any;
+ /** Allows you to obtain a cell by its row index and the visible index of its column. */
+ getCellElement(rowIndex: number, visibleColumnIndex: number): any;
+ /** Returns the current state of the grid. */
+ state(): Object;
+ /** Sets the grid state. */
+ state(state: Object): void;
+ /** Allows you to obtain the row index by a data key. */
+ getRowIndexByKey(key: any): number;
+ /** Allows you to obtain the data key by a row index. */
+ getKeyByRowIndex(rowIndex: number): any;
+ /** Adds a new column to a grid. */
+ addColumn(columnOptions: dxDataGridColumn): void;
+ /** Displays the load panel. */
+ beginCustomLoading(messageText: string): void;
+ /** Discards changes made in a grid. */
+ cancelEditData(): void;
+ /** Clears all the filters of a specific type applied to grid records. */
+ clearFilter(): void;
+ /** Deselects all grid records. */
+ clearSelection(): void;
+ /** Draws the cell being edited from the editing state. Use this method when the edit mode is batch. */
+ closeEditCell(): void;
+ /** Collapses groups or master rows in a grid. */
+ collapseAll(groupIndex?: number): void;
+ /** Returns the number of data columns in a grid. */
+ columnCount(): number;
+ /** Returns the value of a specific column option. */
+ columnOption(id: any, optionName: string): any;
+ /** Sets an option of a specific column. */
+ columnOption(id: any, optionName: string, optionValue: any): void;
+ /** Returns the options of a column by an identifier. */
+ columnOption(id: any): Object;
+ /** Sets several options of a column at once. */
+ columnOption(id: any, options: Object): void;
+ /** Sets a specific cell into the editing state. */
+ editCell(rowIndex: number, columnIndex: number): void;
+ /** Sets a specific row into the editing state. */
+ editRow(rowIndex: number): void;
+ /** Hides the load panel. */
+ endCustomLoading(): void;
+ /** Expands groups or master rows in a grid. */
+ expandAll(groupIndex: number): void;
+ /** Allows you to find out whether a specific group or master row is expanded or collapsed. */
+ isRowExpanded(key: any): boolean;
+ /** Allows you to expand a specific group or master row by its key. */
+ expandRow(key: any): void;
+ /** Allows you to collapse a specific group or master row by its key. */
+ collapseRow(key: any): void;
+ /** Applies a filter to the grid's data source. */
+ filter(filterExpr?: any): void;
+ /** Returns a filter expression applied to the grid's data source using the filter(filterExpr) method. */
+ filter(): any;
+ /** Returns a filter expression applied to the grid using all possible scenarious. */
+ getCombinedFilter(): any;
+ /** Gets the keys of currently selected grid records. */
+ getSelectedRowKeys(): Array<Object>;
+ /** Gets the data objects of currently selected grid records. */
+ getSelectedRowsData(): Array<Object>;
+ /** Hides the column chooser panel. */
+ hideColumnChooser(): void;
+ /** Adds a new data row to a grid. */
+ insertRow(): void;
+ /** Returns the key corresponding to the passed data object. */
+ keyOf(obj: Object): any;
+ /** Switches a grid to a specified page. */
+ pageIndex(newIndex: number): void;
+ /** Gets the index of the current page. */
+ pageIndex(): number;
+ /** Sets the page size. */
+ pageSize(value: number): void;
+ /** Gets the current page size. */
+ pageSize(): number;
+ /** Refreshes grid data. */
+ refresh(): void;
+ /** Removes a specific row from a grid. */
+ removeRow(rowIndex: number): void;
+ /** Saves changes made in a grid. */
+ saveEditData(): void;
+ /** Searches grid records by a search string. */
+ searchByText(text: string): void;
+ /** Selects all grid records. */
+ selectAll(): void;
+ /** Deselects the rows that are currently selected within the applied filter. */
+ deselectAll(): void;
+ /** Selects specific grid records. */
+ selectRows(keys: Array<any>, preserve: boolean): void;
+ /** Deselects specific grid records. */
+ deselectRows(keys: Array<any>): void;
+ /** Selects grid rows by indexes. */
+ selectRowsByIndexes(indexes: Array<any>): void;
+ /** Allows you to find out whether a row is selected or not. */
+ isRowSelected(key: any): boolean;
+ /** Invokes the column chooser panel. */
+ showColumnChooser(): void;
+ startSelectionWithCheckboxes(): boolean;
+ /** Returns the number of records currently held by a grid. */
+ totalCount(): number;
+ /** Recovers a row deleted in the batch edit mode. */
+ undeleteRow(rowIndex: number): void;
+ /** Allows you to obtain a data object by its key. */
+ byKey(key: any): JQueryPromise<any>;
+ /** Gets the value of a total summary item. */
+ getTotalSummaryValue(summaryItemName: string): any;
+ /** Exports grid data to Excel. */
+ exportToExcel(selectionOnly: boolean): void;
+ /** Updates the grid to the size of its content. */
+ updateDimensions(): void;
+ /** Focuses the specified cell element in the grid. */
+ focus(element?: JQuery): void;
+ }
+ export interface dxPivotGridOptions extends WidgetOptions {
+ onContentReady?: Function;
+ /** Specifies a data source for the pivot grid. */
+ dataSource?: any;
+ /** Specifies whether or not the widget uses native scrolling. */
+ useNativeScrolling?: any;
+ /** Allows an end-user to change sorting options. */
+ allowSorting?: boolean;
+ /** Allows an end-user to sort columns by summary values. */
+ allowSortingBySummary?: boolean;
+ /** Allows an end-user to change filtering options. */
+ allowFiltering?: boolean;
+ /** Allows an end-user to expand/collapse all header items within a header level. */
+ allowExpandAll?: boolean;
+ /** Specifies whether to display the Total rows. */
+ showRowTotals?: boolean;
+ /** Specifies whether to display the Grand Total row. */
+ showRowGrandTotals?: boolean;
+ /** Specifies whether to display the Total columns. */
+ showColumnTotals?: boolean;
+ /** Specifies whether to display the Grand Total column. */
+ showColumnGrandTotals?: boolean;
+ /** The Field Chooser configuration options. */
+ fieldChooser?: {
+ /** Enables or disables the field chooser. */
+ enabled?: boolean;
+ /** Specifies the field chooser layout. */
+ layout?: number;
+ /** Specifies the text to display as a title of the field chooser popup window. */
+ title?: string;
+ /** Specifies the field chooser width. */
+ width?: number;
+ /** Specifies the field chooser height. */
+ height?: number;
+ /** Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */
+ texts?: {
+ /** The string to display instead of Row Fields. */
+ rowFields?: string;
+ /** The string to display instead of Column Fields. */
+ columnFields?: string;
+ /** The string to display instead of Data Fields. */
+ dataFields?: string;
+ /** The string to display instead of Filter Fields. */
+ filterFields?: string;
+ /** The string to display instead of All Fields. */
+ allFields?: string;
+ };
+ }
+ /** Strings that can be changed or localized in the dxPivotGrid widget. */
+ texts?: {
+ /** The string to display as a header of the Grand Total row and column. */
+ grandTotal?: string;
+ /** The string to display as a header of the Total row and column. */
+ total?: string;
+ /** Specifies the text displayed when a pivot grid does not contain any fields. */
+ noData?: string;
+ /** The string to display as a Show Field Chooser context menu item. */
+ showFieldChooser?: string;
+ /** The string to display as an Expand All context menu item. */
+ expandAll?: string;
+ /** The string to display as a Collapse All context menu item. */
+ collapseAll?: string;
+ /** The string to display as a Sort Column by Summary Value context menu item. */
+ sortColumnBySummary?: string;
+ /** The string to display as a Sort Row by Summary Value context menu item. */
+ sortRowBySummary?: string;
+ /** The string to display as a Remove All Sorting context menu item. */
+ removeAllSorting?: string;
+ };
+ /** The Load panel configuration options. */
+ loadPanel?: {
+ /** Enables or disables the load panel. */
+ enabled?: boolean;
+ /** Specifies the height of the load panel. */
+ height?: number;
+ /** Specifies the URL pointing to an image that will be used as a load indicator. */
+ indicatorSrc?: string;
+ /** Specifies whether or not to show a load indicator. */
+ showIndicator?: boolean;
+ /** Specifies whether or not to show load panel background. */
+ showPane?: boolean;
+ /** Specifies the text to display inside a load panel. */
+ text?: string;
+ /** Specifies the width of the load panel. */
+ width?: number;
+ };
+ /** A handler for the cellClick event. */
+ onCellClick?: (e: any) => void;
+ /** A handler for the cellPrepared event. */
+ onCellPrepared?: (e: any) => void;
+ /** A handler for the contextMenuPreparing event. */
+ onContextMenuPreparing?: (e: Object) => void;
+ }
+ /** A data summarization widget for multi-dimensional data analysis and data mining. */
+ export class dxPivotGrid extends Widget {
+ constructor(element: JQuery, options?: dxPivotGridOptions);
+ constructor(element: Element, options?: dxPivotGridOptions);
+ /** Gets the PivotGridDataSource instance. */
+ getDataSource(): DevExpress.data.PivotGridDataSource;
+ /** Updates the widget to the size of its content. */
+ updateDimensions(): void;
+ }
+ export interface dxPivotGridFieldChooserOptions extends WidgetOptions {
+ /** Specifies the height of the widget. */
+ height?: any;
+ /** Specifies the field chooser layout. */
+ layout?: number;
+ /** The data source of a dxPivotGrid widget. */
+ dataSource?: DevExpress.data.PivotGridDataSource;
+ onContentReady?: Function;
+ /** Strings that can be changed or localized in the dxPivotGridFieldChooser widget. */
+ texts?: {
+ /** The string to display instead of Row Fields. */
+ rowFields?: string;
+ /** The string to display instead of Column Fields. */
+ columnFields?: string;
+ /** The string to display instead of Data Fields. */
+ dataFields?: string;
+ /** The string to display instead of Filter Fields. */
+ filterFields?: string;
+ /** The string to display instead of All Fields. */
+ allFields?: string;
+ };
+ }
+ /** A complementary widget for dxPivotGrid that allows you to manage data displayed in the dxPivotGrid. */
+ export class dxPivotGridFieldChooser extends Widget {
+ constructor(element: JQuery, options?: dxPivotGridFieldChooserOptions);
+ constructor(element: Element, options?: dxPivotGridFieldChooserOptions);
+ /** Updates the widget to the size of its content. */
+ updateDimensions(): void;
+ }
+}
+interface JQuery {
+ dxTreeView(): JQuery;
+ dxTreeView(options: "instance"): DevExpress.ui.dxTreeView;
+ dxTreeView(options: string): any;
+ dxTreeView(options: string, ...params: any[]): any;
+ dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery;
+ dxMenuBase(): JQuery;
+ dxMenuBase(options: "instance"): DevExpress.ui.dxMenuBase;
+ dxMenuBase(options: string): any;
+ dxMenuBase(options: string, ...params: any[]): any;
+ dxMenuBase(options: DevExpress.ui.dxMenuBaseOptions): JQuery;
+ dxMenu(): JQuery;
+ dxMenu(options: "instance"): DevExpress.ui.dxMenu;
+ dxMenu(options: string): any;
+ dxMenu(options: string, ...params: any[]): any;
+ dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery;
+ dxContextMenu(): JQuery;
+ dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu;
+ dxContextMenu(options: string): any;
+ dxContextMenu(options: string, ...params: any[]): any;
+ dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery;
+ dxColorBox(): JQuery;
+ dxColorBox(options: "instance"): DevExpress.ui.dxColorBox;
+ dxColorBox(options: string): any;
+ dxColorBox(options: string, ...params: any[]): any;
+ dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery;
+ dxDataGrid(): JQuery;
+ dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid;
+ dxDataGrid(options: string): any;
+ dxDataGrid(options: string, ...params: any[]): any;
+ dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery;
+ dxPivotGrid(): JQuery;
+ dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid;
+ dxPivotGrid(options: string): any;
+ dxPivotGrid(options: string, ...params: any[]): any;
+ dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery;
+ dxPivotGridFieldChooser(): JQuery;
+ dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser;
+ dxPivotGridFieldChooser(options: string): any;
+ dxPivotGridFieldChooser(options: string, ...params: any[]): any;
+ dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery;
+ dxScheduler(): JQuery;
+ dxScheduler(options: "instance"): DevExpress.ui.dxScheduler;
+ dxScheduler(options: string): any;
+ dxScheduler(options: string, ...params: any[]): any;
+ dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery;
+}
+declare module DevExpress.framework {
+ /** An object used to store information on the views displayed in an application. */
+ export class ViewCache {
+ viewRemoved: JQueryCallback;
+ /** Removes all the viewInfo objects from the cache. */
+ clear(): void;
+ /** Obtains a viewInfo object from the cache by the specified key. */
+ getView(key: string): Object;
+ /** Checks whether or not a viewInfo object is contained in the view cache under the specified key. */
+ hasView(key: string): boolean;
+ /** Removes a viewInfo object from the cache by the specified key. */
+ removeView(key: string): Object;
+ /** Adds the specified viewInfo object to the cache under the specified key. */
+ setView(key: string, viewInfo: Object): void;
+ }
+ export interface dxCommandOptions extends DOMComponentOptions {
+ action?: any;
+ /** Specifies an action performed when the execute() method of the command is called. */
+ onExecute?: any;
+ /** Indicates whether or not the widget that displays this command is disabled. */
+ disabled?: boolean;
+ /** Specifies whether the current command is rendered when a view is being rendered or after a view is shown. */
+ renderStage?: string;
+ /** Specifies the name of the icon shown inside the widget associated with this command. */
+ icon?: string;
+ iconSrc?: string;
+ /** The identifier of the command. */
+ id?: string;
+ /** Specifies the title of the widget associated with this command. */
+ title?: string;
+ /** Specifies the type of the button, if the command is rendered as a dxButton widget. */
+ type?: string;
+ /** A Boolean value specifying whether or not the widget associated with this command is visible. */
+ visible?: boolean;
+ }
+ /** A markup component used to define markup options for a command. */
+ export class dxCommand extends DOMComponent {
+ constructor(element: JQuery, options: dxCommandOptions);
+ constructor(options: dxCommandOptions);
+ /** Executes the action associated with this command. */
+ execute(): void;
+ }
+ /** An object responsible for routing. */
+ export class Router {
+ /** Adds a routing rule to the list of registered rules. */
+ register(pattern: string, defaults?: Object, constraints?: Object): void;
+ /** Decodes the specified URI to an object using the registered routing rules. */
+ parse(uri: string): Object;
+ /** Formats an object to a URI. */
+ format(obj: Object): string;
+ }
+ export interface StateManagerOptions {
+ /** A storage to which the state manager saves the application state. */
+ storage?: Object;
+ }
+ /** An object used to store the current application state. */
+ export class StateManager {
+ constructor(options?: StateManagerOptions);
+ /** Adds an object that implements an interface of a state source to the state manager's collection of state sources. */
+ addStateSource(stateSource: Object): void;
+ /** Removes a specified state source from the state manager's collection of state sources. */
+ removeStateSource(stateSource: Object): void;
+ /** Saves the current application state. */
+ saveState(): void;
+ /** Restores the application state that has been saved by the saveState() method to the state storage. */
+ restoreState(): void;
+ /** Removes the application state that has been saved by the saveState() method to the state storage. */
+ clearState(): void;
+ }
+ export module html {
+ export var layoutSets: Array<string>;
+ export var animationSets: { [animationSetName: string]: AnimationSet };
+ export interface AnimationSet {
+ [animationName: string]: any
+ }
+ export interface HtmlApplicationOptions {
+ /** Specifies where the commands that are defined in the application's views must be displayed. */
+ commandMapping?: Object;
+ /** Specifies whether or not view caching is disabled. */
+ disableViewCache?: boolean;
+ /** An array of layout controllers that should be used to show application views in the current navigation context. */
+ layoutSet?: any;
+ /** Specifies the animation presets that are used to animate different UI elements in the current application. */
+ animationSet?: AnimationSet;
+ /** Specifies whether the current application must behave as a mobile or web application. */
+ mode?: string;
+ /** Specifies the object that represents a root namespace of the application. */
+ namespace?: Object;
+ /** Specifies application behavior when the user navigates to a root view. */
+ navigateToRootViewMode?: string;
+ /** An array of dxCommand configuration objects used to define commands available from the application's global navigation. */
+ navigation?: Array<any>;
+ /** A state manager to be used in the application. */
+ stateManager?: StateManager;
+ /** Specifies the storage to be used by the application's state manager to store the application state. */
+ stateStorage?: Object;
+ /** Indicates whether on not to use the title of the previously displayed view as text on the Back button. */
+ useViewTitleAsBackText?: boolean;
+ /** A custom view cache to be used in the application. */
+ viewCache?: Object;
+ /** Specifies a limit for the views that can be cached. */
+ viewCacheSize?: number;
+ /** Specifies options for the viewport meta tag of a mobile browser. */
+ viewPort?: JQuery;
+ /** A custom router to be used in the application. */
+ router?: Router;
+ }
+ /** An object used to manage views, as well as control the application life cycle. */
+ export class HtmlApplication implements EventsMixin<HtmlApplication> {
+ constructor(options: HtmlApplicationOptions);
+ afterViewSetup: JQueryCallback;
+ beforeViewSetup: JQueryCallback;
+ initialized: JQueryCallback;
+ navigating: JQueryCallback;
+ navigatingBack: JQueryCallback;
+ resolveLayoutController: JQueryCallback;
+ viewDisposed: JQueryCallback;
+ viewDisposing: JQueryCallback;
+ viewHidden: JQueryCallback;
+ viewRendered: JQueryCallback;
+ viewShowing: JQueryCallback;
+ viewShown: JQueryCallback;
+ /** Provides access to the ViewCache object. */
+ viewCache: ViewCache;
+ /** An array of dxCommand components that are created based on the application's navigation option value. */
+ navigation: Array<any>;
+ /** Provides access to the StateManager object. */
+ stateManager: StateManager;
+ /** Provides access to the Router object. */
+ router: Router;
+ /** Navigates to the URI preceding the current one in the navigation history. */
+ back(): void;
+ /** Returns a Boolean value indicating whether or not backwards navigation is currently possible. */
+ canBack(): boolean;
+ /** Calls the clearState() method of the application's StateManager object. */
+ clearState(): void;
+ /** Creates global navigation commands. */
+ createNavigation(navigationConfig: Array<any>): void;
+ /** Returns an HTML template of the specified view. */
+ getViewTemplate(viewName: string): JQuery;
+ /** Returns a configuration object used to create a dxView component for a specified view. */
+ getViewTemplateInfo(viewName: string): Object;
+ /** Adds a specified HTML template to a collection of view or layout templates. */
+ loadTemplates(source: any): JQueryPromise<any>;
+ /** Navigates to the specified URI. */
+ navigate(uri?: any, options?: Object): void;
+ /** Renders navigation commands to the navigation command containers that are located in the layouts used in the application. */
+ renderNavigation(): void;
+ /** Calls the restoreState() method of the application's StateManager object. */
+ restoreState(): void;
+ /** Calls the saveState method of the application's StateManager object. */
+ saveState(): void;
+ /** Provides access to the object that defines the current context to be considered when choosing an appropriate template for a view. */
+ templateContext(): Object;
+ on(eventName: "initialized", eventHandler: () => void): HtmlApplication;
+ on(eventName: "afterViewSetup", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ on(eventName: "beforeViewSetup", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ on(eventName: "navigating", eventHandler: (e: {
+ currentUri: string;
+ uri: string;
+ cancel: boolean;
+ options: {
+ root: boolean;
+ target: string;
+ direction: string;
+ rootInDetailPane: boolean;
+ modal: boolean;
+ };
+ }) => void): HtmlApplication;
+ on(eventName: "navigatingBack", eventHandler: (e: {
+ cancel: boolean;
+ isHardwareButton: boolean;
+ }) => void): HtmlApplication;
+ on(eventName: "resolveLayoutController", eventHandler: (e: {
+ viewInfo: Object;
+ layoutController: Object;
+ availableLayoutControllers: Array<Object>;
+ }) => void): HtmlApplication;
+ on(eventName: "viewDisposed", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ on(eventName: "viewDisposing", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ on(eventName: "viewHidden", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ on(eventName: "viewRendered", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ on(eventName: "viewShowing", eventHandler: (e: {
+ viewInfo: Object;
+ direction: string;
+ }) => void): HtmlApplication;
+ on(eventName: "viewShown", eventHandler: (e: {
+ viewInfo: Object;
+ direction: string;
+ }) => void): HtmlApplication;
+ on(eventName: string, eventHandler: Function): HtmlApplication;
+ on(events: { [eventName: string]: Function; }): HtmlApplication;
+ off(eventName: "initialized"): HtmlApplication;
+ off(eventName: "afterViewSetup"): HtmlApplication;
+ off(eventName: "beforeViewSetup"): HtmlApplication;
+ off(eventName: "navigating"): HtmlApplication;
+ off(eventName: "navigatingBack"): HtmlApplication;
+ off(eventName: "resolveLayoutController"): HtmlApplication;
+ off(eventName: "viewDisposed"): HtmlApplication;
+ off(eventName: "viewDisposing"): HtmlApplication;
+ off(eventName: "viewHidden"): HtmlApplication;
+ off(eventName: "viewRendered"): HtmlApplication;
+ off(eventName: "viewShowing"): HtmlApplication;
+ off(eventName: "viewShown"): HtmlApplication;
+ off(eventName: string): HtmlApplication;
+ off(eventName: "initialized", eventHandler: () => void): HtmlApplication;
+ off(eventName: "afterViewSetup", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ off(eventName: "beforeViewSetup", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ off(eventName: "navigating", eventHandler: (e: {
+ currentUri: string;
+ uri: string;
+ cancel: boolean;
+ options: {
+ root: boolean;
+ target: string;
+ direction: string;
+ rootInDetailPane: boolean;
+ modal: boolean;
+ };
+ }) => void): HtmlApplication;
+ off(eventName: "navigatingBack", eventHandler: (e: {
+ cancel: boolean;
+ isHardwareButton: boolean;
+ }) => void): HtmlApplication;
+ off(eventName: "resolveLayoutController", eventHandler: (e: {
+ viewInfo: Object;
+ layoutController: Object;
+ availableLayoutControllers: Array<Object>;
+ }) => void): HtmlApplication;
+ off(eventName: "viewDisposed", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ off(eventName: "viewDisposing", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ off(eventName: "viewHidden", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ off(eventName: "viewRendered", eventHandler: (e: {
+ viewInfo: Object;
+ }) => void): HtmlApplication;
+ off(eventName: "viewShowing", eventHandler: (e: {
+ viewInfo: Object;
+ direction: string;
+ }) => void): HtmlApplication;
+ off(eventName: "viewShown", eventHandler: (e: {
+ viewInfo: Object;
+ direction: string;
+ }) => void): HtmlApplication;
+ off(eventName: string, eventHandler: Function): HtmlApplication;
+ }
+ }
+}
+declare module DevExpress.viz.core {
+ /**
+ * Applies a theme for the entire page with several DevExtreme visualization widgets.
+ * @deprecated Use the DevExpress.viz.currentTheme(theme) method instead.
+ */
+ export function currentTheme(theme: string): void;
+ /**
+ * Applies a new theme (with the color scheme defined separately) for the entire page with several DevExtreme visualization widgets.
+ * @deprecated Use the DevExpress.viz.currentTheme(platform, colorScheme) method instead.
+ */
+ export function currentTheme(platform: string, colorScheme: string): void;
+ /**
+ * Registers a new theme based on the existing one.
+ * @deprecated Use the DevExpress.viz.registerTheme(customTheme, baseTheme) method instead.
+ */
+ export function registerTheme(customTheme: Object, baseTheme: string): void;
+ /**
+ * Applies a predefined or registered custom palette to all visualization widgets at once.
+ * @deprecated Use the DevExpress.viz.currentPalette(paletteName) method instead.
+ */
+ export function currentPalette(paletteName: string): void;
+ /**
+ * Obtains the color sets of a predefined or registered palette.
+ * @deprecated Use the DevExpress.viz.getPalette(paletteName) method instead.
+ */
+ export function getPalette(paletteName: string): Object;
+ /**
+ * Registers a new palette.
+ * @deprecated Use the DevExpress.viz.registerPalette(paletteName, palette) method instead.
+ */
+ export function registerPalette(paletteName: string, palette: Object): void;
+ export interface Border {
+ /** Sets a border color for a selected series. */
+ color?: string;
+ /** Sets border visibility for a selected series. */
+ visible?: boolean;
+ /** Sets a border width for a selected series. */
+ width?: number;
+ }
+ export interface DashedBorder extends Border {
+ /** Specifies a dash style for the border of a selected series point. */
+ dashStyle?: string;
+ }
+ export interface DashedBorderWithOpacity extends DashedBorder {
+ /** Specifies the opacity of the tooltip's border. */
+ opacity?: number;
+ }
+ export interface Font {
+ /** Specifies the font color for a strip label. */
+ color?: string;
+ /** Specifies the font family for a strip label. */
+ family?: string;
+ /** Specifies the font opacity for a strip label. */
+ opacity?: number;
+ /** Specifies the font size for a strip label. */
+ size?: any;
+ /** Specifies the font weight for the text displayed in strips. */
+ weight?: number;
+ }
+ export interface Hatching {
+ direction?: string;
+ /** Specifies the opacity of hatching lines. */
+ opacity?: number;
+ /** Specifies the distance between hatching lines in pixels. */
+ step?: number;
+ /** Specifies the width of hatching lines in pixels. */
+ width?: number;
+ }
+ export interface Margins {
+ /** Specifies the legend's bottom margin in pixels. */
+ bottom?: number;
+ /** Specifies the legend's left margin in pixels. */
+ left?: number;
+ /** Specifies the legend's right margin in pixels. */
+ right?: number;
+ /** Specifies the legend's bottom margin in pixels. */
+ top?: number;
+ }
+ export interface Size {
+ /** Specifies the width of the widget. */
+ width?: number;
+ /** Specifies the height of the widget. */
+ height?: number;
+ }
+ export interface Tooltip {
+ /** Specifies the length of the tooltip's arrow in pixels. */
+ arrowLength?: number;
+ /** Specifies the appearance of the tooltip's border. */
+ border?: viz.core.DashedBorderWithOpacity;
+ /** Specifies a color for the tooltip. */
+ color?: string;
+ /** Specifies the z-index for tooltips. */
+ zIndex?: number;
+ container?: any;
+ /** Specifies text and appearance of a set of tooltips. */
+ customizeTooltip?: (arg: Object) => { color?: string; text?: string };
+ /** Specifies whether or not the tooltip is enabled. */
+ enabled?: boolean;
+ /** Specifies font options for the text displayed by the tooltip. */
+ font?: Font;
+ /** Specifies a format for the text displayed by the tooltip. */
+ format?: string;
+ /** Specifies the opacity of a tooltip. */
+ opacity?: number;
+ /** Specifies a distance from the tooltip's left/right boundaries to the inner text in pixels. */
+ paddingLeftRight?: number;
+ /** Specifies a distance from the tooltip's top/bottom boundaries to the inner text in pixels. */
+ paddingTopBottom?: number;
+ /** Specifies a precision for formatted values displayed by the tooltip. */
+ precision?: number;
+ /** Specifies options of the tooltip's shadow. */
+ shadow?: {
+ /** Specifies the blur distance of the tooltip's shadow. */
+ blur?: number;
+ /** Specifies the color of the tooltip's shadow. */
+ color?: string;
+ /** Specifies the horizontal offset of the tooltip's shadow relative to the tooltip in pixels. */
+ offsetX?: number;
+ /** Specifies the vertical offset of the tooltip's shadow relative to the tooltip in pixels. */
+ offsetY?: number;
+ /** Specifies the opacity of the tooltip's shadow. */
+ opacity?: number;
+ };
+ }
+ export interface Animation {
+ /** Determines how long animation runs. */
+ duration?: number;
+ /** Specifies the animation easing mode. */
+ easing?: string;
+ /** Indicates whether or not animation is enabled. */
+ enabled?: boolean;
+ }
+ export interface LoadingIndicator {
+ /** Specifies a color for the loading indicator background. */
+ backgroundColor?: string;
+ /** Specifies font options for the loading indicator text. */
+ font?: viz.core.Font;
+ /** Specifies whether to show the loading indicator or not. */
+ show?: boolean;
+ /** Specifies a text to be displayed by the loading indicator. */
+ text?: string;
+ }
+ export interface LegendBorder extends viz.core.DashedBorderWithOpacity {
+ /** Specifies a radius for the corners of the legend border. */
+ cornerRadius?: number;
+ }
+ export interface BaseLegend {
+ /** Specifies the color of the legend's background. */
+ backgroundColor?: string;
+ /** Specifies legend border settings. */
+ border?: viz.core.LegendBorder;
+ /** Specifies how many columns must be taken to arrange legend items. */
+ columnCount?: number;
+ /** Specifies the spacing between a pair of neighboring legend columns in pixels. */
+ columnItemSpacing?: number;
+ /** Specifies font options for legend items. */
+ font?: viz.core.Font;
+ /** Specifies the legend's position on the map. */
+ horizontalAlignment?: string;
+ /** Specifies the alignment of legend items. */
+ itemsAlignment?: string;
+ /** Specifies the position of text relative to the item marker. */
+ itemTextPosition?: string;
+ /** Specifies the distance between the legend and the container borders in pixels. */
+ margin?: viz.core.Margins;
+ /** Specifies the size of item markers in the legend in pixels. */
+ markerSize?: number;
+ /** Specifies whether to arrange legend items horizontally or vertically. */
+ orientation?: string;
+ /** Specifies the spacing between the legend left/right border and legend items in pixels. */
+ paddingLeftRight?: number;
+ /** Specifies the spacing between the legend top/bottom border and legend items in pixels. */
+ paddingTopBottom?: number;
+ /** Specifies how many rows must be taken to arrange legend items. */
+ rowCount?: number;
+ /** Specifies the spacing between a pair of neighboring legend rows in pixels. */
+ rowItemSpacing?: number;
+ /** Specifies the legend's position on the map. */
+ verticalAlignment?: string;
+ /** Specifies whether or not the legend is visible on the map. */
+ visible?: boolean;
+ }
+ export interface BaseWidgetOptions {
+ drawn?: (widget: Object) => void;
+ /** A handler for the drawn event. */
+ onDrawn?: (e: {
+ component: BaseWidget;
+ element: Element;
+ }) => void;
+ incidentOccured?: (incidentInfo: {
+ id: string;
+ type: string;
+ args: any;
+ text: string;
+ widget: string;
+ version: string;
+ }) => void;
+ /** A handler for the incidentOccurred event. */
+ onIncidentOccurred?: (
+ component: BaseWidget,
+ element: Element,
+ target: {
+ id: string;
+ type: string;
+ args: any;
+ text: string;
+ widget: string;
+ version: string;
+ }
+ ) => void;
+ /** Notifies a widget that it is embedded into an HTML page that uses a path modifier. */
+ pathModified?: boolean;
+ /** Specifies whether or not the widget supports right-to-left representation. */
+ rtlEnabled?: boolean;
+ /** Sets the name of the theme to be used in the widget. */
+ theme?: string;
+ }
+ /** This section describes options and methods that are common to all widgets. */
+ export class BaseWidget extends DOMComponent {
+ /** Returns the widget's SVG markup. */
+ svg(): string;
+ }
+}
+declare module DevExpress.viz.charts {
+ /** This section describes the fields and methods that can be used in code to manipulate the Series object. */
+ export interface BaseSeries {
+ /** Provides information about the state of the series object. */
+ fullState: number;
+ /** Returns the type of the series. */
+ type: string;
+ /** Unselects all the selected points of the series. The points are displayed in an initial style. */
+ clearSelection(): void;
+ /** Gets the color of a particular series. */
+ getColor(): string;
+ /**
+ * Gets a point from the series point collection based on the specified argument.
+ * @deprecated getPointsByArg(pointArg).md
+ */
+ getPointByArg(pointArg: any): Object;
+ /** Gets points from the series point collection based on the specified argument. */
+ getPointsByArg(pointArg: any): Array<BasePoint>;
+ /** Gets a point from the series point collection based on the specified point position. */
+ getPointByPos(positionIndex: number): Object;
+ /** Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically. */
+ select(): void;
+ /** Selects the specified point. The point is displayed in a 'selected' style. */
+ selectPoint(point: BasePoint): void;
+ /** Deselects the specified point. The point is displayed in an initial style. */
+ deselectPoint(point: BasePoint): void;
+ /** Returns an array of all points in the series. */
+ getAllPoints(): Array<BasePoint>;
+ /** Returns visible series points. */
+ getVisiblePoints(): Array<BasePoint>;
+ }
+ /** This section describes the methods that can be used in code to manipulate the Point object. */
+ export interface BasePoint {
+ /** Provides information about the state of the point object. */
+ fullState: number;
+ /** Returns the point's argument value that was set in the data source. */
+ originalArgument: any;
+ /** Returns the point's value that was set in the data source. */
+ originalValue: any;
+ /** Returns the tag of the point. */
+ tag: string;
+ /** Deselects the point. */
+ clearSelection(): void;
+ /** Gets the color of a particular point. */
+ getColor(): string;
+ /** Hides the tooltip of the point. */
+ hideTooltip(): void;
+ /** Provides information about the hover state of a point. */
+ isHovered(): any;
+ /** Provides information about the selection state of a point. */
+ isSelected(): any;
+ /** Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */
+ select(): void;
+ /** Shows the tooltip of the point. */
+ showTooltip(): void;
+ /** Allows you to obtain the label of a series point. */
+ getLabel(): any;
+ /** Returns the series object to which the point belongs. */
+ series: BaseSeries;
+ }
+ /** This section describes the fields and methods that can be used in code to manipulate the Series object. */
+ export interface ChartSeries extends BaseSeries {
+ /** Returns the name of the series pane. */
+ pane: string;
+ /** Returns the name of the value axis of the series. */
+ axis: string;
+ /** Returns the name of the series. */
+ name: string;
+ /** Returns the tag of the series. */
+ tag: string;
+ /** Hides a series. */
+ hide(): void;
+ /** Provides information about the hover state of a series. */
+ isHovered(): any;
+ /** Provides information about the selection state of a series. */
+ isSelected(): any;
+ /** Provides information about the visibility state of a series. */
+ isVisible(): boolean;
+ /** Makes a particular series visible. */
+ show(): void;
+ selectPoint(point: ChartPoint): void;
+ deselectPoint(point: ChartPoint): void;
+ getAllPoints(): Array<ChartPoint>;
+ getVisiblePoints(): Array<ChartPoint>;
+ }
+ /** This section describes the methods that can be used in code to manipulate the Point object. */
+ export interface ChartPoint extends BasePoint {
+ /** Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
+ originalCloseValue: any;
+ /** Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
+ originalHighValue: any;
+ /** Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
+ originalLowValue: any;
+ /** Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */
+ originalMinValue: any;
+ /** Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */
+ originalOpenValue: any;
+ /** Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */
+ size: any;
+ /** Gets the parameters of the point's minimum bounding rectangle (MBR). */
+ getBoundingRect(): { x: number; y: number; width: number; height: number; };
+ series: ChartSeries;
+ }
+ /** This section describes the methods that can be used in code to manipulate the Label object. */
+ export interface Label {
+ /** Gets the parameters of the label's minimum bounding rectangle (MBR). */
+ getBoundingRect(): { x: number; y: number; width: number; height: number; };
+ /** Hides the point label. */
+ hide(): void;
+ /** Shows the point label. */
+ show(): void;
+ }
+ export interface PieSeries extends BaseSeries {
+ selectPoint(point: PiePoint): void;
+ deselectPoint(point: PiePoint): void;
+ getAllPoints(): Array<PiePoint>;
+ getVisiblePoints(): Array<PiePoint>;
+ }
+ /** This section describes the methods that can be used in code to manipulate the Point object. */
+ export interface PiePoint extends BasePoint {
+ /** Gets the percentage value of the specific point. */
+ percent: any;
+ /** Provides information about the visibility state of a point. */
+ isVisible(): boolean;
+ /** Makes a specific point visible. */
+ show(): void;
+ /** Hides a specific point. */
+ hide(): void;
+ series: PieSeries;
+ }
+ /** This section describes the fields and methods that can be used in code to manipulate the Series object. */
+ export interface PolarSeries extends BaseSeries {
+ /** Returns the name of the value axis of the series. */
+ axis: string;
+ /** Returns the name of the series. */
+ name: string;
+ /** Returns the tag of the series. */
+ tag: string;
+ /** Hides a series. */
+ hide(): void;
+ /** Provides information about the hover state of a series. */
+ isHovered(): any;
+ /** Provides information about the selection state of a series. */
+ isSelected(): any;
+ /** Provides information about the visibility state of a series. */
+ isVisible(): boolean;
+ /** Makes a particular series visible. */
+ show(): void;
+ selectPoint(point: PolarPoint): void;
+ deselectPoint(point: PolarPoint): void;
+ getAllPoints(): Array<PolarPoint>;
+ getVisiblePoints(): Array<PolarPoint>;
+ }
+ /** This section describes the methods that can be used in code to manipulate the Point object. */
+ export interface PolarPoint extends BasePoint {
+ series: PolarSeries;
+ }
+ export interface Strip {
+ /** Specifies a color for a strip. */
+ color?: string;
+ /** An object that defines the label configuration options of a strip. */
+ label?: {
+ /** Specifies the text displayed in a strip. */
+ text?: string;
+ };
+ /** Specifies a start value for a strip. */
+ startValue?: any;
+ /** Specifies an end value for a strip. */
+ endValue?: any;
+ }
+ export interface BaseSeriesConfigLabel {
+ /** Specifies a format for arguments displayed by point labels. */
+ argumentFormat?: string;
+ /** Specifies a precision for formatted point arguments displayed in point labels. */
+ argumentPrecision?: number;
+ /** Specifies a background color for point labels. */
+ backgroundColor?: string;
+ /** Specifies border options for point labels. */
+ border?: viz.core.DashedBorder;
+ /** Specifies connector options for series point labels. */
+ connector?: {
+ /** Specifies the color of label connectors. */
+ color?: string;
+ /** Indicates whether or not label connectors are visible. */
+ visible?: boolean;
+ /** Specifies the width of label connectors. */
+ width?: number;
+ };
+ /** Specifies a callback function that returns the text to be displayed by point labels. */
+ customizeText?: (pointInfo: Object) => string;
+ /** Specifies font options for the text displayed in point labels. */
+ font?: viz.core.Font;
+ /** Specifies a format for the text displayed by point labels. */
+ format?: string;
+ position?: string;
+ /** Specifies a precision for formatted point values displayed in point labels. */
+ precision?: number;
+ /** Specifies the angle used to rotate point labels from their initial position. */
+ rotationAngle?: number;
+ /** Specifies the visibility of point labels. */
+ visible?: boolean;
+ }
+ export interface SeriesConfigLabel extends BaseSeriesConfigLabel {
+ /** Specifies whether or not to show a label when the point has a zero value. */
+ showForZeroValues?: boolean;
+ }
+ export interface ChartSeriesConfigLabel extends SeriesConfigLabel {
+ /** Specifies how to align point labels relative to the corresponding data points that they represent. */
+ alignment?: string;
+ /** Specifies how to shift point labels horizontally from their initial positions. */
+ horizontalOffset?: number;
+ /** Specifies how to shift point labels vertically from their initial positions. */
+ verticalOffset?: number;
+ /** Specifies a precision for the percentage values displayed in the labels of a full-stacked-like series. */
+ percentPrecision?: number;
+ }
+ export interface BaseCommonSeriesConfig {
+ /** Specifies the data source field that provides arguments for series points. */
+ argumentField?: string;
+ axis?: string;
+ /** An object defining the label configuration options for a series in the dxChart widget. */
+ label?: ChartSeriesConfigLabel;
+ /** Specifies border options for point labels. */
+ border?: viz.core.DashedBorder;
+ /** Specifies a series color. */
+ color?: string;
+ /** Specifies the dash style of the series' line. */
+ dashStyle?: string;
+ hoverMode?: string;
+ hoverStyle?: {
+ /** An object defining the border options for a hovered series. */
+ border?: viz.core.DashedBorder;
+ /** <p>Sets a color for a series when it is hovered over.</p> */
+ color?: string;
+ /** Specifies the dash style for the line in a hovered series. */
+ dashStyle?: string;
+ hatching?: viz.core.Hatching;
+ /** Specifies the width of a line in a hovered series. */
+ width?: number;
+ };
+ /** Specifies whether a chart ignores null data points or not. */
+ ignoreEmptyPoints?: boolean;
+ /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */
+ maxLabelCount?: number;
+ /** Specifies the minimal length of a displayed bar in pixels. */
+ minBarSize?: number;
+ /** Specifies opacity for a series. */
+ opacity?: number;
+ /** Specifies the series elements to highlight when the series is selected. */
+ selectionMode?: string;
+ selectionStyle?: {
+ /** An object defining the border options for a selected series. */
+ border?: viz.core.DashedBorder;
+ /** Sets a color for a series when it is selected. */
+ color?: string;
+ /** Specifies the dash style for the line in a selected series. */
+ dashStyle?: string;
+ hatching?: viz.core.Hatching;
+ /** Specifies the width of a line in a selected series. */
+ width?: number;
+ };
+ /** Specifies whether or not to show the series in the chart's legend. */
+ showInLegend?: boolean;
+ /** Specifies the name of the stack where the values of the _stackedBar_ series must be located. */
+ stack?: string;
+ /** Specifies the name of the data source field that provides data about a point. */
+ tagField?: string;
+ /** Specifies the data source field that provides values for series points. */
+ valueField?: string;
+ /** Specifies the visibility of a series. */
+ visible?: boolean;
+ /** Specifies a line width. */
+ width?: number;
+ /** Configures error bars. */
+ valueErrorBar?: {
+ /** Specifies whether error bars must be displayed in full or partially. */
+ displayMode?: string;
+ /** Specifies the data field that provides data for low error values. */
+ lowValueField?: string;
+ /** Specifies the data field that provides data for high error values. */
+ highValueField?: string;
+ /** Specifies how error bar values must be calculated. */
+ type?: string;
+ /** Specifies the value to be used for generating error bars. */
+ value?: number;
+ /** Specifies the color of error bars. */
+ color?: string;
+ /** Specifies the opacity of error bars. */
+ opacity?: number;
+ /** Specifies the length of the lines that indicate the error bar edges. */
+ edgeLength?: number;
+ /** Specifies the width of the error bar line. */
+ lineWidth?: number;
+ };
+ }
+ export interface CommonPointOptions {
+ /** Specifies border options for points in the line and area series. */
+ border?: viz.core.Border;
+ /** Specifies the points color. */
+ color?: string;
+ /** Specifies what series points to highlight when a point is hovered over. */
+ hoverMode?: string;
+ /** An object defining configuration options for a hovered point. */
+ hoverStyle?: {
+ /** An object defining the border options for a hovered point. */
+ border?: viz.core.Border;
+ /** Sets a color for a point when it is hovered over. */
+ color?: string;
+ /** Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */
+ size?: number;
+ };
+ /** Specifies what series points to highlight when a point is selected. */
+ selectionMode?: string;
+ /** An object defining configuration options for a selected point. */
+ selectionStyle?: {
+ /** An object defining the border options for a selected point. */
+ border?: viz.core.Border;
+ /** <p>Sets a color for a point when it is selected.</p> */
+ color?: string;
+ /** Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */
+ size?: number;
+ };
+ /** Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */
+ size?: number;
+ /** Specifies a symbol for presenting points of the line and area series. */
+ symbol?: string;
+ visible?: boolean;
+ }
+ export interface ChartCommonPointOptions extends CommonPointOptions {
+ /** An object specifying the parameters of an image that is used as a point marker. */
+ image?: {
+ /** Specifies the height of an image that is used as a point marker. */
+ height?: any;
+ /** Specifies a URL leading to the image to be used as a point marker. */
+ url?: any;
+ /** Specifies the width of an image that is used as a point marker. */
+ width?: any;
+ };
+ }
+ export interface PolarCommonPointOptions extends CommonPointOptions {
+ /** An object specifying the parameters of an image that is used as a point marker. */
+ image?: {
+ /** Specifies the height of an image that is used as a point marker. */
+ height?: number;
+ /** Specifies a URL leading to the image to be used as a point marker. */
+ url?: string;
+ /** Specifies the width of an image that is used as a point marker. */
+ width?: number;
+ };
+ }
+ /** An object that defines configuration options for chart series. */
+ export interface CommonSeriesConfig extends BaseCommonSeriesConfig {
+ /** Specifies the data source field that provides a 'close' value for a _candleStick_ or _stock_ series. */
+ closeValueField?: string;
+ /** Specifies a radius for bar corners. */
+ cornerRadius?: number;
+ /** Specifies the data source field that provides a 'high' value for a _candleStick_ or _stock_ series. */
+ highValueField?: string;
+ /** Specifies the color for the body (rectangle) of a _candleStick_ series. */
+ innerColor?: string;
+ /** Specifies the data source field that provides a 'low' value for a _candleStick_ or _stock_ series. */
+ lowValueField?: string;
+ /** Specifies the data source field that provides an 'open' value for a _candleStick_ or _stock_ series. */
+ openValueField?: string;
+ /** Specifies the pane that will be used to display a series. */
+ pane?: string;
+ /** An object defining configuration options for points in line-, scatter- and area-like series. */
+ point?: ChartCommonPointOptions;
+ /** Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property. */
+ rangeValue1Field?: string;
+ /** Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property. */
+ rangeValue2Field?: string;
+ /** Specifies reduction options for the stock or candleStick series. */
+ reduction?: {
+ /** Specifies a color for the points whose reduction level price is lower in comparison to the value in the previous point. */
+ color?: string;
+ /** Specifies for which price level (open, high, low or close) to enable reduction options in the series. */
+ level?: string;
+ };
+ /** Specifies the data source field that defines the size of bubbles. */
+ sizeField?: string;
+ }
+ export interface CommonSeriesSettings extends CommonSeriesConfig {
+ /** <p>An object that specifies configuration options for all series of the <i>area</i> type in the chart.</p> */
+ area?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _bar_ type in the chart. */
+ bar?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the bubble type in the chart. */
+ bubble?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _candleStick_ type in the chart. */
+ candlestick?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _fullStackedArea_ type in the chart. */
+ fullstackedarea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart. */
+ fullstackedsplinearea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _fullStackedBar_ type in the chart. */
+ fullstackedbar?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _fullStackedLine_ type in the chart. */
+ fullstackedline?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart. */
+ fullstackedspline?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _line_ type in the chart. */
+ line?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _rangeArea_ type in the chart. */
+ rangearea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _rangeBar_ type in the chart. */
+ rangebar?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */
+ scatter?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _spline_ type in the chart. */
+ spline?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _splineArea_ type in the chart. */
+ splinearea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stackedArea_ type in the chart. */
+ stackedarea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the Stacked Spline Area type in the chart. */
+ stackedsplinearea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */
+ stackedbar?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stackedLine_ type in the chart. */
+ stackedline?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the Stacked Spline type in the chart. */
+ stackedspline?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stepArea_ type in the chart. */
+ steparea?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stepLine_ type in the chart. */
+ stepline?: CommonSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stock_ type in the chart. */
+ stock?: CommonSeriesConfig;
+ /** Sets a series type. */
+ type?: string;
+ }
+ export interface SeriesConfig extends CommonSeriesConfig {
+ /** Specifies the name that identifies the series. */
+ name?: string;
+ /** Specifies data about a series. */
+ tag?: any;
+ /** Sets the series type. */
+ type?: string;
+ }
+ /** An object that defines configuration options for polar chart series. */
+ export interface CommonPolarSeriesConfig extends BaseCommonSeriesConfig {
+ /** Specifies whether or not to close the chart by joining the end point with the first point. */
+ closed?: boolean;
+ label?: SeriesConfigLabel;
+ point?: PolarCommonPointOptions;
+ }
+ export interface CommonPolarSeriesSettings extends CommonPolarSeriesConfig {
+ /** An object that specifies configuration options for all series of the <i>area</i> type in the chart. */
+ area?: CommonPolarSeriesConfig;
+ /** An object that specifies configuration options for all series of the _bar_ type in the chart. */
+ bar?: CommonPolarSeriesConfig;
+ /** An object that specifies configuration options for all series of the _line_ type in the chart. */
+ line?: CommonPolarSeriesConfig;
+ /** An object that specifies configuration options for all series of the _scatter_ type in the chart. */
+ scatter?: CommonPolarSeriesConfig;
+ /** An object that specifies configuration options for all series of the _stackedBar_ type in the chart. */
+ stackedbar?: CommonPolarSeriesConfig;
+ /** Sets a series type. */
+ type?: string;
+ }
+ export interface PolarSeriesConfig extends CommonPolarSeriesConfig {
+ /** Specifies the name that identifies the series. */
+ name?: string;
+ /** Specifies data about a series. */
+ tag?: any;
+ /** Sets the series type. */
+ type?: string;
+ }
+ export interface PieSeriesConfigLabel extends BaseSeriesConfigLabel {
+ /** Specifies how to shift labels from their initial position in a radial direction in pixels. */
+ radialOffset?: number;
+ /** Specifies a precision for the percentage values displayed in labels. */
+ percentPrecision?: number;
+ }
+ /** An object that defines configuration options for chart series. */
+ export interface CommonPieSeriesConfig {
+ /** Specifies the data source field that provides arguments for series points. */
+ argumentField?: string;
+ /** Specifies the required type for series arguments. */
+ argumentType?: string;
+ /** An object defining the series border configuration options. */
+ border?: viz.core.DashedBorder;
+ /** Specifies a series color. */
+ color?: string;
+ /** Specifies the chart elements to highlight when a series is hovered over. */
+ hoverMode?: string;
+ /** An object defining configuration options for a hovered series. */
+ hoverStyle?: {
+ /** An object defining the border options for a hovered series. */
+ border?: viz.core.DashedBorder;
+ /** Sets a color for the series when it is hovered over. */
+ color?: string;
+ /** Specifies the hatching options to be applied when a point is hovered over. */
+ hatching?: viz.core.Hatching;
+ };
+ /** Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. */
+ innerRadius?: number;
+ /** An object defining the label configuration options. */
+ label?: PieSeriesConfigLabel;
+ /** Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */
+ maxLabelCount?: number;
+ /** Specifies a minimal size of a displayed pie segment. */
+ minSegmentSize?: number;
+ /** Specifies the direction in which the dxPieChart's series points are located. */
+ segmentsDirection?: string;
+ /** <p>Specifies the chart elements to highlight when the series is selected.</p> */
+ selectionMode?: string;
+ /** An object defining configuration options for the series when it is selected. */
+ selectionStyle?: {
+ /** An object defining the border options for a selected series. */
+ border?: viz.core.DashedBorder;
+ /** Sets a color for a series when it is selected. */
+ color?: string;
+ /** Specifies the hatching options to be applied when a point is selected. */
+ hatching?: viz.core.Hatching;
+ };
+ /** Specifies chart segment grouping options. */
+ smallValuesGrouping?: {
+ /** Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */
+ groupName?: string;
+ /** Specifies the segment grouping mode. */
+ mode?: string;
+ /** Specifies a threshold for segment values. */
+ threshold?: number;
+ /** Specifies how many segments must not be grouped. */
+ topCount?: number;
+ };
+ /** Specifies a start angle for a pie chart in arc degrees. */
+ startAngle?: number;
+ /** <p>Specifies the name of the data source field that provides data about a point.</p> */
+ tagField?: string;
+ /** Specifies the data source field that provides values for series points. */
+ valueField?: string;
+ }
+ export interface PieSeriesConfig extends CommonPieSeriesConfig {
+ /** Sets the series type. */
+ type?: string;
+ }
+ export interface SeriesTemplate {
+ /** Specifies a callback function that returns a series object with individual series settings. */
+ customizeSeries?: (seriesName: string) => SeriesConfig;
+ /** Specifies a data source field that represents the series name. */
+ nameField?: string;
+ }
+ export interface PolarSeriesTemplate {
+ /** Specifies a callback function that returns a series object with individual series settings. */
+ customizeSeries?: (seriesName: string) => PolarSeriesConfig;
+ /** Specifies a data source field that represents the series name. */
+ nameField?: string;
+ }
+ export interface ChartCommonConstantLineLabel {
+ /** Specifies font options for a constant line label. */
+ font?: viz.core.Font;
+ /** Specifies the position of the constant line label relative to the chart plot. */
+ position?: string;
+ /** Indicates whether or not to display labels for the axis constant lines. */
+ visible?: boolean;
+ }
+ export interface PolarCommonConstantLineLabel {
+ /** Indicates whether or not to display labels for the axis constant lines. */
+ visible?: boolean;
+ /** Specifies font options for a constant line label. */
+ font?: viz.core.Font;
+ }
+ export interface ConstantLineStyle {
+ /** Specifies a color for a constant line. */
+ color?: string;
+ /** Specifies a dash style for a constant line. */
+ dashStyle?: string;
+ /** Specifies a constant line width in pixels. */
+ width?: number;
+ }
+ export interface ChartCommonConstantLineStyle extends ConstantLineStyle {
+ /** An object defining constant line label options. */
+ label?: ChartCommonConstantLineLabel;
+ /** Specifies the space between the constant line label and the left/right side of the constant line. */
+ paddingLeftRight?: number;
+ /** Specifies the space between the constant line label and the top/bottom side of the constant line. */
+ paddingTopBottom?: number;
+ }
+ export interface PolarCommonConstantLineStyle extends ConstantLineStyle {
+ /** An object defining constant line label options. */
+ label?: PolarCommonConstantLineLabel;
+ }
+ export interface CommonAxisLabel {
+ /** Specifies font options for axis labels. */
+ font?: viz.core.Font;
+ /** Specifies the spacing between an axis and its labels in pixels. */
+ indentFromAxis?: number;
+ /** Indicates whether or not axis labels are visible. */
+ visible?: boolean;
+ }
+ export interface ChartCommonAxisLabel extends CommonAxisLabel {
+ /** Specifies the label's position relative to the tick (grid line). */
+ alignment?: string;
+ /** Specifies the overlap resolving algorithm to be applied to axis labels. */
+ overlappingBehavior?: {
+ /** Specifies how to arrange axis labels. */
+ mode?: string;
+ /** Specifies the angle used to rotate axis labels. */
+ rotationAngle?: number;
+ /** Specifies the spacing that must be set between staggered rows when the 'stagger' algorithm is applied. */
+ staggeringSpacing?: number;
+ };
+ }
+ export interface PolarCommonAxisLabel extends CommonAxisLabel {
+ /** Specifies the overlap resolving algorithm to be applied to axis labels. */
+ overlappingBehavior?: string;
+ }
+ export interface CommonAxisTitle {
+ /** Specifies font options for an axis title. */
+ font?: viz.core.Font;
+ /** Specifies a margin for an axis title in pixels. */
+ margin?: number;
+ }
+ export interface BaseCommonAxisSettings {
+ /** Specifies the color of the line that represents an axis. */
+ color?: string;
+ /** Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */
+ discreteAxisDivisionMode?: string;
+ /** An object defining the configuration options for the grid lines of an axis in the dxPolarChart widget. */
+ grid?: {
+ /** Specifies a color for grid lines. */
+ color?: string;
+ /** Specifies an opacity for grid lines. */
+ opacity?: number;
+ /** Indicates whether or not the grid lines of an axis are visible. */
+ visible?: boolean;
+ /** Specifies the width of grid lines. */
+ width?: number;
+ };
+ /** Specifies the options of the minor grid. */
+ minorGrid?: {
+ /** Specifies a color for the lines of the minor grid. */
+ color?: string;
+ /** Specifies an opacity for the lines of the minor grid. */
+ opacity?: number;
+ /** Indicates whether the minor grid is visible or not. */
+ visible?: boolean;
+ /** Specifies a width for the lines of the minor grid. */
+ width?: number;
+ };
+ /** Indicates whether or not an axis is inverted. */
+ inverted?: boolean;
+ /** Specifies the opacity of the line that represents an axis. */
+ opacity?: number;
+ /** Indicates whether or not to set ticks/grid lines of a continuous axis of the 'date-time' type at the beginning of each date-time interval. */
+ setTicksAtUnitBeginning?: boolean;
+ /** An object defining the configuration options for axis ticks. */
+ tick?: {
+ /** Specifies ticks color. */
+ color?: string;
+ /** Specifies tick opacity. */
+ opacity?: number;
+ /** Indicates whether or not ticks are visible on an axis. */
+ visible?: boolean;
+ };
+ /** Specifies the options of the minor ticks. */
+ minorTick?: {
+ /** Specifies a color for the minor ticks. */
+ color?: string;
+ /** Specifies an opacity for the minor ticks. */
+ opacity?: number;
+ /** Indicates whether or not the minor ticks are displayed on an axis. */
+ visible?: boolean;
+ };
+ /** Indicates whether or not the line that represents an axis in a chart is visible. */
+ visible?: boolean;
+ /** Specifies the width of the line that represents an axis in the chart. */
+ width?: number;
+ }
+ export interface ChartCommonAxisSettings extends BaseCommonAxisSettings {
+ /** Specifies the appearance of all the widget's constant lines. */
+ constantLineStyle?: ChartCommonConstantLineStyle;
+ /** An object defining the label configuration options that are common for all axes in the dxChart widget. */
+ label?: ChartCommonAxisLabel;
+ /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */
+ maxValueMargin?: number;
+ /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */
+ minValueMargin?: number;
+ /** Specifies, in pixels, the space reserved for an axis. */
+ placeholderSize?: number;
+ /** An object defining configuration options for strip style. */
+ stripStyle?: {
+ /** An object defining the configuration options for a strip label style. */
+ label?: {
+ /** Specifies font options for a strip label. */
+ font?: viz.core.Font;
+ /** Specifies the label's position on a strip. */
+ horizontalAlignment?: string;
+ /** Specifies a label's position on a strip. */
+ verticalAlignment?: string;
+ };
+ /** Specifies the spacing, in pixels, between the left/right strip border and the strip label. */
+ paddingLeftRight?: number;
+ /** Specifies the spacing, in pixels, between the top/bottom strip borders and the strip label. */
+ paddingTopBottom?: number;
+ };
+ /** An object defining the title configuration options that are common for all axes in the dxChart widget. */
+ title?: CommonAxisTitle;
+ /** Indicates whether or not to display series with indents from axis boundaries. */
+ valueMarginsEnabled?: boolean;
+ }
+ export interface PolarCommonAxisSettings extends BaseCommonAxisSettings {
+ /** Specifies the appearance of all the widget's constant lines. */
+ constantLineStyle?: PolarCommonConstantLineStyle;
+ /** An object defining the label configuration options that are common for all axes in the dxPolarChart widget. */
+ label?: PolarCommonAxisLabel;
+ /** An object defining configuration options for strip style. */
+ stripStyle?: {
+ /** An object defining the configuration options for a strip label style. */
+ label?: {
+ /** Specifies font options for a strip label. */
+ font?: viz.core.Font;
+ };
+ };
+ }
+ export interface ChartConstantLineLabel extends ChartCommonConstantLineLabel {
+ /** Specifies the horizontal alignment of a constant line label. */
+ horizontalAlignment?: string;
+ /** Specifies the vertical alignment of a constant line label. */
+ verticalAlignment?: string;
+ /** Specifies the text to be displayed in a constant line label. */
+ text?: string;
+ }
+ export interface PolarConstantLineLabel extends PolarCommonConstantLineLabel {
+ /** Specifies the text to be displayed in a constant line label. */
+ text?: string;
+ }
+ export interface AxisLabel {
+ /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */
+ customizeHint?: (argument: { value: any; valueText: string }) => string;
+ /** Specifies a callback function that returns the text to be displayed in value axis labels. */
+ customizeText?: (argument: { value: any; valueText: string }) => string;
+ /** Specifies a format for the text displayed by axis labels. */
+ format?: string;
+ /** Specifies a precision for the formatted value displayed in the axis labels. */
+ precision?: number;
+ }
+ export interface ChartAxisLabel extends ChartCommonAxisLabel, AxisLabel { }
+ export interface PolarAxisLabel extends PolarCommonAxisLabel, AxisLabel { }
+ export interface AxisTitle extends CommonAxisTitle {
+ /** Specifies the text for the value axis title. */
+ text?: string;
+ }
+ export interface ChartConstantLineStyle extends ChartCommonConstantLineStyle {
+ /** An object defining constant line label options. */
+ label?: ChartConstantLineLabel;
+ }
+ export interface ChartConstantLine extends ChartConstantLineStyle {
+ /** An object defining constant line label options. */
+ label?: ChartConstantLineLabel;
+ /** Specifies a value to be displayed by a constant line. */
+ value?: any;
+ }
+ export interface PolarConstantLine extends PolarCommonConstantLineStyle {
+ /** An object defining constant line label options. */
+ label?: PolarConstantLineLabel;
+ /** Specifies a value to be displayed by a constant line. */
+ value?: any;
+ }
+ export interface Axis {
+ /** Specifies a coefficient for dividing the value axis. */
+ axisDivisionFactor?: number;
+ /** Specifies the order in which discrete values are arranged on the value axis. */
+ categories?: Array<any>;
+ /** Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */
+ logarithmBase?: number;
+ /** Specifies an interval between axis ticks/grid lines. */
+ tickInterval?: any;
+ /** Specifies the interval between minor ticks. */
+ minorTickInterval?: any;
+ /** Specifies the number of minor ticks between two neighboring major ticks. */
+ minorTickCount?: number;
+ /** Specifies the required type of the value axis. */
+ type?: string;
+ /** Specifies the pane on which the current value axis will be displayed. */
+ pane?: string;
+ /** Specifies options for value axis strips. */
+ strips?: Array<Strip>;
+ }
+ export interface ChartAxis extends ChartCommonAxisSettings, Axis {
+ /** Defines an array of the value axis constant lines. */
+ constantLines?: Array<ChartConstantLine>;
+ /** Specifies the appearance options for the constant lines of the value axis. */
+ constantLineStyle?: ChartCommonConstantLineStyle;
+ /** Specifies options for value axis labels. */
+ label?: ChartAxisLabel;
+ /** Specifies the maximum value on the value axis. */
+ max?: any;
+ /** Specifies the minimum value on the value axis. */
+ min?: any;
+ /** Specifies the position of the value axis on a chart. */
+ position?: string;
+ /** Specifies the title for a value axis. */
+ title?: AxisTitle;
+ }
+ export interface PolarAxis extends PolarCommonAxisSettings, Axis {
+ /** Defines an array of the value axis constant lines. */
+ constantLines?: Array<PolarConstantLine>;
+ /** Specifies options for value axis labels. */
+ label?: PolarAxisLabel;
+ }
+ export interface ArgumentAxis {
+ /** Specifies the desired type of axis values. */
+ argumentType?: string;
+ /** Specifies the elements that will be highlighted when the argument axis is hovered over. */
+ hoverMode?: string;
+ }
+ export interface ChartArgumentAxis extends ChartAxis, ArgumentAxis { }
+ export interface PolarArgumentAxis extends PolarAxis, ArgumentAxis {
+ /** Specifies a start angle for the argument axis in degrees. */
+ startAngle?: number;
+ /** Specifies whether or not to display the first point at the angle specified by the startAngle option. */
+ firstPointOnStartAngle?: boolean;
+ /** Specifies the period of the argument values in the data source. */
+ period?: number;
+ }
+ export interface ValueAxis {
+ /** Specifies the name of the value axis. */
+ name?: string;
+ /** Specifies whether or not to indicate a zero value on the value axis. */
+ showZero?: boolean;
+ /** Specifies the desired type of axis values. */
+ valueType?: string;
+ }
+ export interface ChartValueAxis extends ChartAxis, ValueAxis {
+ /** Specifies the spacing, in pixels, between multiple value axes in a chart. */
+ multipleAxesSpacing?: number;
+ /** Specifies the value by which the chart's value axes are synchronized. */
+ synchronizedValue?: number;
+ }
+ export interface PolarValueAxis extends PolarAxis, ValueAxis {
+ /** Indicates whether to display series with indents from axis boundaries. */
+ valueMarginsEnabled?: boolean;
+ /** Specifies a coefficient that determines the spacing between the maximum series point and the axis. */
+ maxValueMargin?: number;
+ /** Specifies a coefficient that determines the spacing between the minimum series point and the axis. */
+ minValueMargin?: number;
+ tick?: {
+ visible?: boolean;
+ }
+ }
+ export interface CommonPane {
+ /** Specifies a background color in a pane. */
+ backgroundColor?: string;
+ /** Specifies the border options of a chart's pane. */
+ border?: PaneBorder;
+ }
+ export interface Pane extends CommonPane {
+ /** Specifies the name of a pane. */
+ name?: string;
+ }
+ export interface PaneBorder extends viz.core.DashedBorderWithOpacity {
+ /** Specifies the bottom border's visibility state in a pane. */
+ bottom?: boolean;
+ /** Specifies the left border's visibility state in a pane. */
+ left?: boolean;
+ /** Specifies the right border's visibility state in a pane. */
+ right?: boolean;
+ /** Specifies the top border's visibility state in a pane. */
+ top?: boolean;
+ }
+ export interface ChartAnimation extends viz.core.Animation {
+ /** Specifies the maximum series point count in the chart that the animation supports. */
+ maxPointCountSupported?: number;
+ }
+ export interface BaseChartTooltip extends viz.core.Tooltip {
+ /** Specifies a format for arguments of the chart's series points. */
+ argumentFormat?: string;
+ /** Specifies a precision for formatted arguments displayed in tooltips. */
+ argumentPrecision?: number;
+ /** Specifies a precision for a percent value displayed in tooltips for stacked series and dxPieChart series. */
+ percentPrecision?: number;
+ }
+ export interface BaseChartOptions<TPoint> extends viz.core.BaseWidgetOptions {
+ /** Specifies adaptive layout options. */
+ adaptiveLayout?: {
+ /** Specifies the width of the widget container that is small enough for the layout to begin adapting. */
+ width?: number;
+ /** Specifies the height of the widget container that is small enough for the layout to begin adapting. */
+ height?: number;
+ /** Specifies whether or not point labels can be hidden when the layout is adapting. */
+ keepLabels?: boolean;
+ };
+ /** Specifies animation options. */
+ animation?: ChartAnimation;
+ /** Specifies a callback function that returns an object with options for a specific point label. */
+ customizeLabel?: (labelInfo: Object) => Object;
+ /** Specifies a callback function that returns an object with options for a specific point. */
+ customizePoint?: (pointInfo: Object) => Object;
+ /** Specifies a data source for the chart. */
+ dataSource?: any;
+ done?: Function;
+ /** Specifies the appearance of the loading indicator. */
+ loadingIndicator?: viz.core.LoadingIndicator;
+ /** Specifies options of a dxChart's (dxPieChart's) legend. */
+ legend?: core.BaseLegend;
+ /** Specifies the blank space between the chart's extreme elements and the boundaries of the area provided for the widget (see size) in pixels. */
+ margin?: viz.core.Margins;
+ /** Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */
+ palette?: any;
+ /** A handler for the done event. */
+ onDone?: (e: {
+ component: BaseChart;
+ element: Element;
+ }) => void;
+ /** A handler for the pointClick event. */
+ onPointClick?: any;
+ pointClick?: any;
+ /** A handler for the pointHoverChanged event. */
+ onPointHoverChanged?: (e: {
+ component: BaseChart;
+ element: Element;
+ target: TPoint;
+ }) => void;
+ pointHoverChanged?: (point: TPoint) => void;
+ /** A handler for the pointSelectionChanged event. */
+ onPointSelectionChanged?: (e: {
+ component: BaseChart;
+ element: Element;
+ target: TPoint;
+ }) => void;
+ pointSelectionChanged?: (point: TPoint) => void;
+ /** Specifies whether a single point or multiple points can be selected in the chart. */
+ pointSelectionMode?: string;
+ /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */
+ redrawOnResize?: boolean;
+ /** Specifies options for the dxChart and dxPieChart widget series. */
+ series?: any;
+ /** Specifies the size of the widget in pixels. */
+ size?: viz.core.Size;
+ /** Specifies a title for the chart. */
+ title?: {
+ /** Specifies font options for the title. */
+ font?: viz.core.Font;
+ /** Specifies the title's horizontal position in the chart. */
+ horizontalAlignment?: string;
+ /** Specifies a title's position on the chart in the vertical direction. */
+ verticalAlignment?: string;
+ /** Specifies the distance between the title and surrounding chart elements in pixels. */
+ margin?: viz.core.Margins;
+ /** Specifies the height of the space reserved for the title. */
+ placeholderSize?: number;
+ /** Specifies a text for the chart's title. */
+ text?: string;
+ };
+ /** Specifies tooltip options. */
+ tooltip?: BaseChartTooltip;
+ /** A handler for the tooltipShown event. */
+ onTooltipShown?: (e: {
+ component: BaseChart;
+ element: Element;
+ target: BasePoint;
+ }) => void;
+ /** A handler for the tooltipHidden event. */
+ onTooltipHidden?: (e: {
+ component: BaseChart;
+ element: Element;
+ target: BasePoint;
+ }) => void;
+ tooltipHidden?: (point: TPoint) => void;
+ tooltipShown?: (point: TPoint) => void;
+ }
+ /** A base class for all chart widgets included in the ChartJS library. */
+ export class BaseChart extends viz.core.BaseWidget {
+ /** Deselects the chart's selected series. The series is displayed in an initial style. */
+ clearSelection(): void;
+ /** Gets the current size of the widget. */
+ getSize(): { width: number; height: number };
+ /** Displays the loading indicator. */
+ showLoadingIndicator(): void;
+ /** Conceals the loading indicator. */
+ hideLoadingIndicator(): void;
+ /** Hides all widget tooltips. */
+ hideTooltip(): void;
+ /** Redraws a widget. */
+ render(renderOptions?: {
+ force?: boolean;
+ animate?: boolean;
+ asyncSeriesRendering?: boolean;
+ }): void;
+ }
+ export interface AdvancedLegend extends core.BaseLegend {
+ /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */
+ customizeHint?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string;
+ /** <p>Specifies a callback function that returns the text to be displayed by legend items.</p> */
+ customizeText?: (seriesInfo: { seriesName: string; seriesIndex: number; seriesColor: string; }) => string;
+ /** Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */
+ hoverMode?: string;
+ }
+ export interface AdvancedOptions<TPoint, TSeries> extends BaseChartOptions<TPoint> {
+ /** A handler for the argumentAxisClick event. */
+ onArgumentAxisClick?: any;
+ /** Specifies the color of the parent page element. */
+ containerBackgroundColor?: string;
+ /** An object providing options for managing data from a data source. */
+ dataPrepareSettings?: {
+ /** Specifies whether or not to validate the values from a data source. */
+ checkTypeForAllData?: boolean;
+ /** Specifies whether or not to convert the values from a data source into the data type of an axis. */
+ convertToAxisDataType?: boolean;
+ /** Specifies how to sort the series points. */
+ sortingMethod?: any;
+ };
+ /** A handler for the legendClick event. */
+ onLegendClick?: any;
+ /** A handler for the seriesClick event. */
+ onSeriesClick?: any;
+ /** A handler for the seriesHoverChanged event. */
+ onSeriesHoverChanged?: (e: {
+ component: BaseChart;
+ element: Element;
+ target: TSeries;
+ }) => void;
+ /** A handler for the seriesSelectionChanged event. */
+ onSeriesSelectionChanged?: (e: {
+ component: BaseChart;
+ element: Element;
+ target: TSeries;
+ }) => void;
+ /** Specifies whether a single series or multiple series can be selected in the chart. */
+ seriesSelectionMode?: string;
+ /** Specifies how the chart must behave when series point labels overlap. */
+ resolveLabelOverlapping?: string;
+ }
+ export interface Legend extends AdvancedLegend {
+ /** Specifies whether the legend is located outside or inside the chart's plot. */
+ position?: string;
+ }
+ export interface ChartTooltip extends BaseChartTooltip {
+ /** Specifies whether the tooltip must be located in the center of a bar or on its edge. Applies to the Bar and Bubble series. */
+ location?: string;
+ /** Specifies the kind of information to display in a tooltip. */
+ shared?: boolean;
+ }
+ export interface dxChartOptions extends AdvancedOptions<ChartPoint, ChartSeries> {
+ /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */
+ equalBarWidth?: any;
+ adaptiveLayout?: {
+ keepLabels?: boolean;
+ };
+ /** Indicates whether or not to synchronize value axes when they are displayed on a single pane. */
+ synchronizeMultiAxes?: boolean;
+ /** Specifies whether or not to filter the series points depending on their quantity. */
+ useAggregation?: boolean;
+ /** Indicates whether or not to adjust a value axis to the current minimum and maximum values of a zoomed chart. */
+ adjustOnZoom?: boolean;
+ /** Specifies argument axis options for the dxChart widget. */
+ argumentAxis?: ChartArgumentAxis;
+ argumentAxisClick?: any;
+ /** An object defining the configuration options that are common for all axes of the dxChart widget. */
+ commonAxisSettings?: ChartCommonAxisSettings;
+ /** An object defining the configuration options that are common for all panes in the dxChart widget. */
+ commonPaneSettings?: CommonPane;
+ /** An object defining the configuration options that are common for all series of the dxChart widget. */
+ commonSeriesSettings?: CommonSeriesSettings;
+ /** An object that specifies the appearance options of the chart crosshair. */
+ crosshair?: {
+ /** Specifies a color for the crosshair lines. */
+ color?: string;
+ /** Specifies a dash style for the crosshair lines. */
+ dashStyle?: string;
+ /** Specifies whether to enable the crosshair or not. */
+ enabled?: boolean;
+ /** Specifies the opacity of the crosshair lines. */
+ opacity?: number;
+ /** Specifies the width of the crosshair lines. */
+ width?: number;
+ /** Specifies the appearance of the horizontal crosshair line. */
+ horizontalLine?: CrosshaierWithLabel;
+ /** Specifies the appearance of the vertical crosshair line. */
+ verticalLine?: CrosshaierWithLabel;
+ /** Specifies the options of the crosshair labels. */
+ label?: {
+ /** Specifies a color for the background of the crosshair labels. */
+ backgroundColor?: string;
+ /** Specifies whether the crosshair labels are visible or not. */
+ visible?: boolean;
+ /** Specifies font options for the text of the crosshair labels. */
+ font?: viz.core.Font;
+ }
+ };
+ /** Specifies a default pane for the chart's series. */
+ defaultPane?: string;
+ /** Specifies a coefficient determining the diameter of the largest bubble. */
+ maxBubbleSize?: number;
+ /** Specifies the diameter of the smallest bubble measured in pixels. */
+ minBubbleSize?: number;
+ /** Defines the dxChart widget's <a href="/Documentation/Guide/Data_Visualization/Charts/Chart_Elements?version=15_1#Panes">pane(s)</a>. */
+ panes?: Array<Pane>;
+ /** Swaps the axes round so that the value axis becomes horizontal and the argument axes becomes vertical. */
+ rotated?: boolean;
+ /** Specifies the options of a chart's legend. */
+ legend?: Legend;
+ /** Specifies options for dxChart widget series. */
+ series?: Array<SeriesConfig>;
+ legendClick?: any;
+ seriesClick?: any;
+ seriesHoverChanged?: (series: ChartSeries) => void;
+ seriesSelectionChanged?: (series: ChartSeries) => void;
+ /** Defines options for the series template. */
+ seriesTemplate?: SeriesTemplate;
+ /** Specifies tooltip options. */
+ tooltip?: ChartTooltip;
+ /** Specifies value axis options for the dxChart widget. */
+ valueAxis?: Array<ChartValueAxis>;
+ /** Enables scrolling in your chart. */
+ scrollingMode?: string;
+ /** Enables zooming in your chart. */
+ zoomingMode?: string;
+ /** Specifies the settings of the scroll bar. */
+ scrollBar?: {
+ /** Specifies whether the scroll bar is visible or not. */
+ visible?: boolean;
+ /** Specifies the spacing between the scroll bar and the chart's plot in pixels. */
+ offset?: number;
+ /** Specifies the color of the scroll bar. */
+ color?: string;
+ /** Specifies the width of the scroll bar in pixels. */
+ width?: number;
+ /** Specifies the opacity of the scroll bar. */
+ opacity?: number;
+ /** Specifies the position of the scroll bar in the chart. */
+ position?: string;
+ };
+ }
+ /** A widget used to embed charts into HTML JS applications. */
+ export class dxChart extends BaseChart {
+ constructor(element: JQuery, options?: dxChartOptions);
+ constructor(element: Element, options?: dxChartOptions);
+ /** Returns an array of all series in the chart. */
+ getAllSeries(): Array<ChartSeries>;
+ /** Gets a series within the chart's series collection by the specified name (see the name option). */
+ getSeriesByName(seriesName: string): ChartSeries;
+ /** Gets a series within the chart's series collection by its position number. */
+ getSeriesByPos(seriesIndex: number): ChartSeries;
+ /** Sets the specified start and end values for the chart's argument axis. */
+ zoomArgument(startValue: any, endValue: any): void;
+ }
+ interface CrosshaierWithLabel extends viz.core.DashedBorderWithOpacity {
+ /** Configures the label that belongs to the horizontal crosshair line. */
+ label?: {
+ /** Specifies a color for the background of the label that belongs to the horizontal crosshair line. */
+ backgroundColor?: string;
+ /** Specifies whether the label of the horizontal crosshair line is visible or not. */
+ visible?: boolean;
+ /** Specifies font options for the text of the label that belongs to the horizontal crosshair line. */
+ font?: viz.core.Font;
+ }
+ }
+ export interface PolarChartTooltip extends BaseChartTooltip {
+ /** Specifies the kind of information to display in a tooltip. */
+ shared?: boolean;
+ }
+ export interface dxPolarChartOptions extends AdvancedOptions<PolarPoint, PolarSeries> {
+ /** Specifies a value indicating whether all bars in a series must have the same angle, or may have different angles if any points in other series are missing. */
+ equalBarWidth?: boolean;
+ /** Specifies adaptive layout options. */
+ adaptiveLayout?: {
+ width?: number;
+ height?: number;
+ /** Specifies whether or not point labels can be hidden when the layout is adapting. */
+ keepLabels?: boolean;
+ };
+ /** Indicates whether or not to display a "spider web". */
+ useSpiderWeb?: boolean;
+ /** Specifies argument axis options for the dxPolarChart widget. */
+ argumentAxis?: PolarArgumentAxis;
+ /** An object defining the configuration options that are common for all axes of the dxPolarChart widget. */
+ commonAxisSettings?: PolarCommonAxisSettings;
+ /** An object defining the configuration options that are common for all series of the dxPolarChart widget. */
+ commonSeriesSettings?: CommonPolarSeriesSettings;
+ /** Specifies the options of a chart's legend. */
+ legend?: AdvancedLegend;
+ /** Specifies options for dxPolarChart widget series. */
+ series?: Array<PolarSeriesConfig>;
+ /** Defines options for the series template. */
+ seriesTemplate?: PolarSeriesTemplate;
+ /** Specifies tooltip options. */
+ tooltip?: PolarChartTooltip;
+ /** Specifies value axis options for the dxPolarChart widget. */
+ valueAxis?: PolarValueAxis;
+ }
+ /** A chart widget displaying data in a polar coordinate system. */
+ export class dxPolarChart extends BaseChart {
+ constructor(element: JQuery, options?: dxPolarChartOptions);
+ constructor(element: Element, options?: dxPolarChartOptions);
+ /** Returns an array of all series in the chart. */
+ getAllSeries(): Array<PolarSeries>;
+ /** Gets a series within the chart's series collection by the specified name (see the name option). */
+ getSeriesByName(seriesName: string): PolarSeries;
+ /** Gets a series within the chart's series collection by its position number. */
+ getSeriesByPos(seriesIndex: number): PolarSeries;
+ }
+ export interface PieLegend extends core.BaseLegend {
+ /** Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */
+ hoverMode?: string;
+ /** Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */
+ customizeHint?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string;
+ /** Specifies a callback function that returns the text to be displayed by a legend item. */
+ customizeText?: (pointInfo: { pointName: string; pointIndex: number; pointColor: string; }) => string;
+ }
+ export interface dxPieChartOptions extends BaseChartOptions<PiePoint> {
+ /** Specifies adaptive layout options. */
+ adaptiveLayout?: {
+ /** Specifies whether or not point labels can be hidden when the layout is adapting. */
+ keepLabels?: boolean;
+ };
+ /** Specifies dxPieChart legend options. */
+ legend?: PieLegend;
+ /** Specifies options for the series of the dxPieChart widget. */
+ series?: Array<PieSeriesConfig>;
+ /** Specifies the diameter of the pie. */
+ diameter?: number;
+ /** A handler for the legendClick event. */
+ onLegendClick?: any;
+ legendClick?: any;
+ /** Specifies how a chart must behave when series point labels overlap. */
+ resolveLabelOverlapping?: string;
+ }
+ /** A circular chart widget for HTML JS applications. */
+ export class dxPieChart extends BaseChart {
+ constructor(element: JQuery, options?: dxPieChartOptions);
+ constructor(element: Element, options?: dxPieChartOptions);
+ /** Provides access to the dxPieChart series. */
+ getSeries(): PieSeries;
+ }
+}
+interface JQuery {
+ dxChart(options?: DevExpress.viz.charts.dxChartOptions): JQuery;
+ dxChart(methodName: string, ...params: any[]): any;
+ dxChart(methodName: "instance"): DevExpress.viz.charts.dxChart;
+ dxPieChart(options?: DevExpress.viz.charts.dxPieChartOptions): JQuery;
+ dxPieChart(methodName: string, ...params: any[]): any;
+ dxPieChart(methodName: "instance"): DevExpress.viz.charts.dxPieChart;
+ dxPolarChart(options?: DevExpress.viz.charts.dxPolarChartOptions): JQuery;
+ dxPolarChart(methodName: string, ...params: any[]): any;
+ dxPolarChart(methodName: "instance"): DevExpress.viz.charts.dxPolarChart;
+}
+declare module DevExpress.viz.gauges {
+ export interface BaseRangeContainer {
+ /** Specifies a range container's background color. */
+ backgroundColor?: string;
+ /** Specifies the offset of the range container from an invisible scale line in pixels. */
+ offset?: number;
+ /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */
+ palette?: any;
+ /** An array of objects representing ranges contained in the range container. */
+ ranges?: Array<{ startValue: number; endValue: number; color: string }>;
+ /** Specifies a color of a range. */
+ color?: string;
+ /** Specifies an end value of a range. */
+ endValue?: number;
+ /** Specifies a start value of a range. */
+ startValue?: number;
+ }
+ export interface ScaleTick {
+ /** Specifies the color of the scale's minor ticks. */
+ color?: string;
+ /** Specifies an array of custom minor ticks. */
+ customTickValues?: Array<any>;
+ /** Specifies the length of the scale's minor ticks. */
+ length?: number;
+ /** Indicates whether automatically calculated minor ticks are visible or not. */
+ showCalculatedTicks?: boolean;
+ /** Specifies an interval between minor ticks. */
+ tickInterval?: number;
+ /** Indicates whether scale minor ticks are visible or not. */
+ visible?: boolean;
+ /** Specifies the width of the scale's minor ticks. */
+ width?: number;
+ }
+ export interface ScaleMajorTick extends ScaleTick {
+ /** Specifies whether or not to expand the current major tick interval if labels overlap each other. */
+ useTicksAutoArrangement?: boolean;
+ }
+ export interface BaseScaleLabel {
+ /** Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */
+ useRangeColors?: boolean;
+ /** Specifies a callback function that returns the text to be displayed in scale labels. */
+ customizeText?: (scaleValue: { value: number; valueText: string }) => string;
+ /** Specifies font options for the text displayed in the scale labels of the gauge. */
+ font?: viz.core.Font;
+ /** Specifies a format for the text displayed in scale labels. */
+ format?: string;
+ /** Specifies a precision for the formatted value displayed in the scale labels. */
+ precision?: number;
+ /** Specifies whether or not scale labels are visible on the gauge. */
+ visible?: boolean;
+ }
+ export interface BaseScale {
+ /** Specifies the end value for the scale of the gauge. */
+ endValue?: number;
+ /** Specifies whether or not to hide the first scale label. */
+ hideFirstLabel?: boolean;
+ /** Specifies whether or not to hide the first major tick on the scale. */
+ hideFirstTick?: boolean;
+ /** Specifies whether or not to hide the last scale label. */
+ hideLastLabel?: boolean;
+ /** Specifies whether or not to hide the last major tick on the scale. */
+ hideLastTick?: boolean;
+ /** Specifies common options for scale labels. */
+ label?: BaseScaleLabel;
+ /** Specifies options of the gauge's major ticks. */
+ majorTick?: ScaleMajorTick;
+ /** Specifies options of the gauge's minor ticks. */
+ minorTick?: ScaleTick;
+ /** Specifies the start value for the scale of the gauge. */
+ startValue?: number;
+ }
+ export interface BaseValueIndicator {
+ /** Specifies the type of subvalue indicators. */
+ type?: string;
+ /** Specifies the background color for the indicator of the rangeBar type. */
+ backgroundColor?: string;
+ /** Specifies the base value for the indicator of the rangeBar type. */
+ baseValue?: number;
+ /** Specifies a color of the indicator. */
+ color?: string;
+ /** Specifies the range bar size for an indicator of the rangeBar type. */
+ size?: number;
+ text?: {
+ /** Specifies a callback function that returns the text to be displayed in an indicator. */
+ customizeText?: (indicatedValue: { value: number; valueText: string }) => string;
+ font?: viz.core.Font;
+ /** Specifies a format for the text displayed in an indicator. */
+ format?: string;
+ /** Specifies the range bar's label indent in pixels. */
+ indent?: number;
+ /** Specifies a precision for the formatted value displayed by an indicator. */
+ precision?: number;
+ };
+ offset?: number;
+ length?: number;
+ width?: number;
+ /** Specifies the length of an arrow for the indicator of the textCloud type in pixels. */
+ arrowLength?: number;
+ /** Sets the array of colors to be used for coloring subvalue indicators. */
+ palette?: Array<any>;
+ /** Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */
+ indentFromCenter?: number;
+ /** Specifies the second color for the indicator of the twoColorNeedle type. */
+ secondColor?: string;
+ /** Specifies the length of a twoNeedleColor type indicator tip as a percentage. */
+ secondFraction?: number;
+ /** Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */
+ spindleSize?: number;
+ /** Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */
+ spindleGapSize?: number;
+ /** Specifies the orientation of the rangeBar indicator on a vertically oriented dxLinearGauge widget. */
+ horizontalOrientation?: string;
+ /** Specifies the orientation of the rangeBar indicator on a horizontally oriented dxLinearGauge widget. */
+ verticalOrientation?: string;
+ }
+ export interface SharedGaugeOptions {
+ /** Specifies animation options. */
+ animation?: viz.core.Animation;
+ /** Specifies the appearance of the loading indicator. */
+ loadingIndicator?: viz.core.LoadingIndicator;
+ /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */
+ redrawOnResize?: boolean;
+ /** Specifies the size of the widget in pixels. */
+ size?: viz.core.Size;
+ /** Specifies a subtitle for a gauge. */
+ subtitle?: {
+ /** Specifies font options for the subtitle. */
+ font?: viz.core.Font;
+ /** Specifies a text for the subtitle. */
+ text?: string;
+ };
+ /** Specifies a title for a gauge. */
+ title?: {
+ /** Specifies font options for the title. */
+ font?: viz.core.Font;
+ /** Specifies a title's position on the gauge. */
+ position?: string;
+ /** Specifies a text for the title. */
+ text?: string;
+ };
+ /** Specifies options for gauge tooltips. */
+ tooltip?: viz.core.Tooltip;
+ /** A handler for the tooltipShown event. */
+ onTooltipShown?: (e: {
+ component: dxBaseGauge;
+ element: Element;
+ target: {};
+ }) => void;
+ /** A handler for the tooltipHidden event. */
+ onTooltipHidden?: (e: {
+ component: dxBaseGauge;
+ element: Element;
+ target: {};
+ }) => void;
+ }
+ export interface BaseGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions {
+ /** Specifies the color of the parent page element. */
+ containerBackgroundColor?: string;
+ /** Specifies the blank space in pixels between the widget's extreme elements and the boundaries of the area provided for the widget (see the size option). */
+ margin?: viz.core.Margins;
+ /** Specifies options of the gauge's range container. */
+ rangeContainer?: BaseRangeContainer;
+ /** Specifies a gauge's scale options. */
+ scale?: BaseScale;
+ /** Specifies the appearance options of subvalue indicators. */
+ subvalueIndicator?: BaseValueIndicator;
+ /** Specifies a set of subvalues to be designated by the subvalue indicators. */
+ subvalues?: Array<number>;
+ /** Specifies the main value on a gauge. */
+ value?: number;
+ /** Specifies the appearance options of the value indicator. */
+ valueIndicator?: BaseValueIndicator;
+ }
+ /** A gauge widget. */
+ export class dxBaseGauge extends viz.core.BaseWidget {
+ /** Displays the loading indicator. */
+ showLoadingIndicator(): void;
+ /** Conceals the loading indicator. */
+ hideLoadingIndicator(): void;
+ /** Redraws a widget. */
+ render(): void;
+ /** Returns the main gauge value. */
+ value(): number;
+ /** Updates a gauge value. */
+ value(value: number): void;
+ /** Returns an array of gauge subvalues. */
+ subvalues(): Array<number>;
+ /** Updates gauge subvalues. */
+ subvalues(subvalues: Array<number>): void;
+ }
+ export interface LinearRangeContainer extends BaseRangeContainer {
+ /** Specifies the orientation of the range container on a vertically oriented dxLinearGauge widget. */
+ horizontalOrientation?: string;
+ /** Specifies the orientation of a range container on a horizontally oriented dxLinearGauge widget. */
+ verticalOrientation?: string;
+ /** Specifies the width of the range container's start and end boundaries in the dxLinearGauge widget. */
+ width?: any;
+ /** Specifies an end width of a range container. */
+ end?: number;
+ /** Specifies a start width of a range container. */
+ start?: number;
+ }
+ export interface LinearScaleLabel extends BaseScaleLabel {
+ /** Specifies the spacing between scale labels and ticks. */
+ indentFromTick?: number;
+ }
+ export interface LinearScale extends BaseScale {
+ /** Specifies the orientation of scale ticks on a vertically oriented dxLinearGauge widget. */
+ horizontalOrientation?: string;
+ label?: LinearScaleLabel;
+ /** Specifies the orientation of scale ticks on a horizontally oriented dxLinearGauge widget. */
+ verticalOrientation?: string;
+ }
+ export interface dxLinearGaugeOptions extends BaseGaugeOptions {
+ /** Specifies the options required to set the geometry of the dxLinearGauge widget. */
+ geometry?: {
+ /** Indicates whether to display the dxLinearGauge widget vertically or horizontally. */
+ orientation?: string;
+ };
+ /** Specifies gauge range container options. */
+ rangeContainer?: LinearRangeContainer;
+ scale?: LinearScale;
+ }
+ /** A widget that represents a gauge with a linear scale. */
+ export class dxLinearGauge extends dxBaseGauge {
+ constructor(element: JQuery, options?: dxLinearGaugeOptions);
+ constructor(element: Element, options?: dxLinearGaugeOptions);
+ }
+ export interface CircularRangeContainer extends BaseRangeContainer {
+ /** Specifies the orientation of the range container in the dxCircularGauge widget. */
+ orientation?: string;
+ /** Specifies the range container's width in pixels. */
+ width?: number;
+ }
+ export interface CircularScaleLabel extends BaseScaleLabel {
+ /** Specifies the spacing between scale labels and ticks. */
+ indentFromTick?: number;
+ }
+ export interface CircularScale extends BaseScale {
+ label?: CircularScaleLabel;
+ /** Specifies the orientation of scale ticks. */
+ orientation?: string;
+ }
+ export interface dxCircularGaugeOptions extends BaseGaugeOptions {
+ /** Specifies the options required to set the geometry of the dxCircularGauge widget. */
+ geometry?: {
+ /** Specifies the end angle of the circular gauge's arc. */
+ endAngle?: number;
+ /** Specifies the start angle of the circular gauge's arc. */
+ startAngle?: number;
+ };
+ /** Specifies gauge range container options. */
+ rangeContainer?: CircularRangeContainer;
+ scale?: CircularScale;
+ }
+ /** A widget that represents a gauge with a circular scale. */
+ export class dxCircularGauge extends dxBaseGauge {
+ constructor(element: JQuery, options?: dxCircularGaugeOptions);
+ constructor(element: Element, options?: dxCircularGaugeOptions);
+ }
+ export interface dxBarGaugeOptions extends viz.core.BaseWidgetOptions, SharedGaugeOptions {
+ /** Specifies a color for the remaining segment of the bar's track. */
+ backgroundColor?: string;
+ /** Specifies a distance between bars in pixels. */
+ barSpacing?: number;
+ /** Specifies a base value for bars. */
+ baseValue?: number;
+ /** Specifies an end value for the gauge's invisible scale. */
+ endValue?: number;
+ /** Defines the shape of the gauge's arc. */
+ geometry?: {
+ /** Specifies the end angle of the bar gauge's arc. */
+ endAngle?: number;
+ /** Specifies the start angle of the bar gauge's arc. */
+ startAngle?: number;
+ };
+ /** Specifies the options of the labels that accompany gauge bars. */
+ label?: {
+ /** Specifies a color for the label connector text. */
+ connectorColor?: string;
+ /** Specifies the width of the label connector in pixels. */
+ connectorWidth?: number;
+ /** Specifies a callback function that returns a text for labels. */
+ customizeText?: (barValue: { value: number; valueText: string }) => string;
+ /** Specifies font options for bar labels. */
+ font?: viz.core.Font;
+ /** Specifies a format for bar labels. */
+ format?: string;
+ /** Specifies the distance between the upper bar and bar labels in pixels. */
+ indent?: number;
+ /** Specifies a precision for the formatted value displayed by labels. */
+ precision?: number;
+ /** Specifies whether bar labels appear on a gauge or not. */
+ visible?: boolean;
+ };
+ /** Sets the name of the palette or an array of colors to be used for coloring the gauge range container. */
+ palette?: string;
+ /** Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */
+ relativeInnerRadius?: number;
+ /** Specifies a start value for the gauge's invisible scale. */
+ startValue?: number;
+ /** Specifies the array of values to be indicated on a bar gauge. */
+ values?: Array<number>;
+ }
+ /** A circular bar widget. */
+ export class dxBarGauge extends viz.core.BaseWidget {
+ constructor(element: JQuery, options?: dxBarGaugeOptions);
+ constructor(element: Element, options?: dxBarGaugeOptions);
+ /** Displays the loading indicator. */
+ showLoadingIndicator(): void;
+ /** Conceals the loading indicator. */
+ hideLoadingIndicator(): void;
+ /** Redraws the widget. */
+ render(): void;
+ /** Returns an array of gauge values. */
+ values(): Array<number>;
+ /** Updates the values displayed by a gauge. */
+ values(values: Array<number>): void;
+ }
+}
+interface JQuery {
+ dxLinearGauge(options?: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery;
+ dxLinearGauge(methodName: string, ...params: any[]): any;
+ dxLinearGauge(methodName: "instance"): DevExpress.viz.gauges.dxLinearGauge;
+ dxCircularGauge(options?: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery;
+ dxCircularGauge(methodName: string, ...params: any[]): any;
+ dxCircularGauge(methodName: "instance"): DevExpress.viz.gauges.dxCircularGauge;
+ dxBarGauge(options?: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery;
+ dxBarGauge(methodName: string, ...params: any[]): any;
+ dxBarGauge(methodName: "instance"): DevExpress.viz.gauges.dxBarGauge;
+}
+declare module DevExpress.viz.rangeSelector {
+ export interface dxRangeSelectorOptions extends viz.core.BaseWidgetOptions {
+ /** Specifies the options for the range selector's background. */
+ background?: {
+ /** Specifies the background color for the dxRangeSelector. */
+ color?: string;
+ /** Specifies image options. */
+ image?: {
+ /** Specifies a location for the image in the background of a range selector. */
+ location?: string;
+ /** Specifies the image's URL. */
+ url?: string;
+ };
+ /** Indicates whether or not the background (background color and/or image) is visible. */
+ visible?: boolean;
+ };
+ /** Specifies the dxRangeSelector's behavior options. */
+ behavior?: {
+ /** Indicates whether or not you can swap sliders. */
+ allowSlidersSwap?: boolean;
+ /** Indicates whether or not animation is enabled. */
+ animationEnabled?: boolean;
+ /** Specifies when to call the onSelectedRangeChanged function. */
+ callSelectedRangeChanged?: string;
+ /** Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */
+ manualRangeSelectionEnabled?: boolean;
+ /** Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */
+ moveSelectedRangeByClick?: boolean;
+ /** Indicates whether to snap a slider to ticks. */
+ snapToTicks?: boolean;
+ };
+ /** Specifies the options required to display a chart as the range selector's background. */
+ chart?: {
+ /** Specifies a coefficient for determining an indent from the bottom background boundary to the lowest chart point. */
+ bottomIndent?: number;
+ /** An object defining the common configuration options for the chart’s series. */
+ commonSeriesSettings?: viz.charts.CommonSeriesSettings;
+ /** An object providing options for managing data from a data source. */
+ dataPrepareSettings?: {
+ /** Specifies whether or not to validate values from a data source. */
+ checkTypeForAllData?: boolean;
+ /** Specifies whether or not to convert the values from a data source into the data type of an axis. */
+ convertToAxisDataType?: boolean;
+ /** Specifies how to sort series points. */
+ sortingMethod?: any;
+ };
+ /** Specifies a value indicating whether all bars in a series must have the same width, or may have different widths if any points in other series are missing. */
+ equalBarWidth?: any;
+ /** Sets the name of the palette to be used in the range selector's chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. */
+ palette?: any;
+ /** An object defining the chart’s series. */
+ series?: Array<viz.charts.SeriesConfig>;
+ /** Defines options for the series template. */
+ seriesTemplate?: viz.charts.SeriesTemplate;
+ /** Specifies a coefficient for determining an indent from the background's top boundary to the topmost chart point. */
+ topIndent?: number;
+ /** Specifies whether or not to filter the series points depending on their quantity. */
+ useAggregation?: boolean;
+ /** Specifies options for the chart's value axis. */
+ valueAxis?: {
+ /** Indicates whether or not the chart's value axis must be inverted. */
+ inverted?: boolean;
+ /** Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */
+ logarithmBase?: number;
+ /** Specifies the maximum value of the chart's value axis. */
+ max?: number;
+ /** Specifies the minimum value of the chart's value axis. */
+ min?: number;
+ /** Specifies the type of the value axis. */
+ type?: string;
+ /** Specifies the desired type of axis values. */
+ valueType?: string;
+ };
+ };
+ /** Specifies the color of the parent page element. */
+ containerBackgroundColor?: string;
+ /** Specifies a data source for the scale values and for the chart at the background. */
+ dataSource?: any;
+ /** Specifies the data source field that provides data for the scale. */
+ dataSourceField?: string;
+ /** Specifies the appearance of the loading indicator. */
+ loadingIndicator?: viz.core.LoadingIndicator;
+ /** Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size). */
+ margin?: viz.core.Margins;
+ /** Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. */
+ redrawOnResize?: boolean;
+ /** Specifies options of the range selector's scale. */
+ scale?: {
+ /** Specifies the scale's end value. */
+ endValue?: any;
+ /** Specifies common options for scale labels. */
+ label?: {
+ /** Specifies a callback function that returns the text to be displayed in scale labels. */
+ customizeText?: (scaleValue: { value: any; valueText: string; }) => string;
+ /** Specifies font options for the text displayed in the range selector's scale labels. */
+ font?: viz.core.Font;
+ /** Specifies a format for the text displayed in scale labels. */
+ format?: string;
+ /** Specifies a precision for the formatted value displayed in the scale labels. */
+ precision?: number;
+ /** Specifies a spacing between scale labels and the background bottom edge. */
+ topIndent?: number;
+ /** Specifies whether or not the scale's labels are visible. */
+ visible?: boolean;
+ };
+ /** Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */
+ logarithmBase?: number;
+ /** Specifies an interval between major ticks. */
+ majorTickInterval?: any;
+ /** Specifies options for the date-time scale's markers. */
+ marker?: {
+ /** Defines the options that can be set for the text that is displayed by the scale markers. */
+ label?: {
+ /** Specifies a callback function that returns the text to be displayed in scale markers. */
+ customizeText?: (markerValue: { value: any; valueText: string }) => string;
+ /** Specifies a format for the text displayed in scale markers. */
+ format?: string;
+ };
+ /** Specifies the height of the marker's separator. */
+ separatorHeight?: number;
+ /** Specifies the space between the marker label and the marker separator. */
+ textLeftIndent?: number;
+ /** Specifies the space between the marker's label and the top edge of the marker's separator. */
+ textTopIndent?: number;
+ /** Specified the indent between the marker and the scale lables. */
+ topIndent?: number;
+ /** Indicates whether scale markers are visible. */
+ visible?: boolean;
+ };
+ /** Specifies the maximum range that can be selected. */
+ maxRange?: any;
+ /** Specifies the number of minor ticks between neighboring major ticks. */
+ minorTickCount?: number;
+ /** Specifies an interval between minor ticks. */
+ minorTickInterval?: any;
+ /** Specifies the minimum range that can be selected. */
+ minRange?: any;
+ /** Specifies the height of the space reserved for the scale in pixels. */
+ placeholderHeight?: number;
+ /** Indicates whether or not to set ticks of a date-time scale at the beginning of each date-time interval. */
+ setTicksAtUnitBeginning?: boolean;
+ /** Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */
+ showCustomBoundaryTicks?: boolean;
+ /** Indicates whether or not to show minor ticks on the scale. */
+ showMinorTicks?: boolean;
+ /** Specifies the scale's start value. */
+ startValue?: any;
+ /** Specifies options defining the appearance of scale ticks. */
+ tick?: {
+ /** Specifies the color of scale ticks (both major and minor ticks). */
+ color?: string;
+ /** Specifies the opacity of scale ticks (both major and minor ticks). */
+ opacity?: number;
+ /** Specifies the width of the scale's ticks (both major and minor ticks). */
+ width?: number;
+ };
+ /** Specifies the type of the scale. */
+ type?: string;
+ /** Specifies whether or not to expand the current tick interval if labels overlap each other. */
+ useTicksAutoArrangement?: boolean;
+ /** Specifies the type of values on the scale. */
+ valueType?: string;
+ /** Specifies the order of arguments on a discrete scale. */
+ categories?: Array<any>;
+ };
+ /** Specifies the range to be selected when displaying the dxRangeSelector. */
+ selectedRange?: {
+ /** Specifies the start value of the range to be selected when displaying the dxRangeSelector widget on a page. */
+ startValue?: any;
+ /** Specifies the end value of the range to be selected when displaying the dxRangeSelector widget on a page. */
+ endValue?: any;
+ };
+ /** Specifies the color of the selected range. */
+ selectedRangeColor?: string;
+ /** Range selector's indent options. */
+ indent?: {
+ /** Specifies range selector's left indent. */
+ left?: number;
+ /** Specifies range selector's right indent. */
+ right?: number;
+ };
+ selectedRangeChanged?: (selectedRange: { startValue: any; endValue: any; }) => void;
+ /** A handler for the selectedRangeChanged event. */
+ onSelectedRangeChanged?: (e: {
+ startValue: any;
+ endValue: any;
+ component: dxRangeSelector;
+ element: Element;
+ }) => void;
+ /** Specifies range selector shutter options. */
+ shutter?: {
+ /** Specifies shutter color. */
+ color?: string;
+ /** Specifies the opacity of the color of shutters. */
+ opacity?: number;
+ };
+ /** Specifies in pixels the size of the dxRangeSelector widget. */
+ size?: viz.core.Size;
+ /** Specifies the appearance of the range selector's slider handles. */
+ sliderHandle?: {
+ /** Specifies the color of the slider handles. */
+ color?: string;
+ /** Specifies the opacity of the slider handles. */
+ opacity?: number;
+ /** Specifies the width of the slider handles. */
+ width?: number;
+ };
+ /** Defines the options of the range selector slider markers. */
+ sliderMarker?: {
+ /** Specifies the color of the slider markers. */
+ color?: string;
+ /** Specifies a callback function that returns the text to be displayed by slider markers. */
+ customizeText?: (scaleValue: { value: any; valueText: any; }) => string;
+ /** Specifies font options for the text displayed by the range selector slider markers. */
+ font?: viz.core.Font;
+ /** Specifies a format for the text displayed in slider markers. */
+ format?: string;
+ /** Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */
+ invalidRangeColor?: string;
+ /**
+ * Specifies the empty space between the marker's border and the marker’s text.
+ * @deprecated Use the 'paddingTopBottom' and 'paddingLeftRight' options instead
+ */
+ padding?: number;
+ /** Specifies the empty space between the marker's top and bottom borders and the marker's text. */
+ paddingTopBottom?: number;
+ /** Specifies the empty space between the marker's left and right borders and the marker's text. */
+ paddingLeftRight?: number;
+ /** Specifies the placeholder height of the slider marker. */
+ placeholderHeight?: number;
+ /**
+ * Specifies in pixels the height and width of the space reserved for the range selector slider markers.
+ * @deprecated Use the 'placeholderHeight' and 'indent' options instead
+ */
+ placeholderSize?: {
+ /** Specifies the height of the placeholder for the left and right slider markers. */
+ height?: number;
+ /** Specifies the width of the placeholder for the left and right slider markers. */
+ width?: {
+ /** Specifies the width of the left slider marker's placeholder. */
+ left?: number;
+ /** Specifies the width of the right slider marker's placeholder. */
+ right?: number;
+ };
+ };
+ /** Specifies a precision for the formatted value displayed in slider markers. */
+ precision?: number;
+ /** Indicates whether or not the slider markers are visible. */
+ visible?: boolean;
+ };
+ }
+ /** A widget that allows end users to select a range of values on a scale. */
+ export class dxRangeSelector extends viz.core.BaseWidget {
+ constructor(element: JQuery, options?: dxRangeSelectorOptions);
+ constructor(element: Element, options?: dxRangeSelectorOptions);
+ /** Displays the loading indicator. */
+ showLoadingIndicator(): void;
+ /** Conceals the loading indicator. */
+ hideLoadingIndicator(): void;
+ /** Redraws a widget. */
+ render(skipChartAnimation?: boolean): void;
+ /** Returns the currently selected range. */
+ getSelectedRange(): { startValue: any; endValue: any; };
+ /** Sets a specified range. */
+ setSelectedRange(selectedRange: { startValue: any; endValue: any; }): void;
+ }
+}
+interface JQuery {
+ dxRangeSelector(options?: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery;
+ dxRangeSelector(methodName: string, ...params: any[]): any;
+ dxRangeSelector(methodName: "instance"): DevExpress.viz.rangeSelector.dxRangeSelector;
+}
+declare module DevExpress.viz.map {
+ /** This section describes the fields and methods that can be used in code to manipulate the Area object. */
+ export interface Area {
+ /** Contains the element type. */
+ type: string;
+ /** Return the value of an attribute. */
+ attribute(name: string): any;
+ /** Provides information about the selection state of an area. */
+ selected(): boolean;
+ /** Sets a new selection state for an area. */
+ selected(state: boolean): void;
+ /** Applies the area settings specified as a parameter and updates the area appearance. */
+ applySettings(settings: any): void;
+ }
+ /** This section describes the fields and methods that can be used in code to manipulate the Markers object. */
+ export interface Marker {
+ /** Contains the descriptive text accompanying the map marker. */
+ text: string;
+ /** Contains the type of the element. */
+ type: string;
+ /** Contains the URL of an image map marker. */
+ url: string;
+ /** Contains the value of a bubble map marker. */
+ value: number;
+ /** Contains the values of a pie map marker. */
+ values: Array<number>;
+ /** Returns the value of an attribute. */
+ attribute(name: string): any;
+ /** Returns the coordinates of a specific marker. */
+ coordinates(): Array<number>;
+ /** Provides information about the selection state of a marker. */
+ selected(): boolean;
+ /** Sets a new selection state for a marker. */
+ selected(state: boolean): void;
+ /** Applies the marker settings specified as a parameter and updates the marker appearance. */
+ applySettings(settings: any): void;
+ }
+ export interface AreaSettings {
+ /** Specifies the width of the area border in pixels. */
+ borderWidth?: number;
+ /** Specifies a color for the area border. */
+ borderColor?: string;
+ click?: any;
+ /** Specifies a color for an area. */
+ color?: string;
+ /** Specifies the function that customizes each area individually. */
+ customize?: (areaInfo: Area) => AreaSettings;
+ /** Specifies a color for the area border when the area is hovered over. */
+ hoveredBorderColor?: string;
+ /** Specifies the pixel-measured width of the area border when the area is hovered over. */
+ hoveredBorderWidth?: number;
+ /** Specifies a color for an area when this area is hovered over. */
+ hoveredColor?: string;
+ /** Specifies whether or not to change the appearance of an area when it is hovered over. */
+ hoverEnabled?: boolean;
+ /** Configures area labels. */
+ label?: {
+ /** Specifies the data field that provides data for area labels. */
+ dataField?: string;
+ /** Enables area labels. */
+ enabled?: boolean;
+ /** Specifies font options for area labels. */
+ font?: viz.core.Font;
+ };
+ /** Specifies the name of the palette or a custom range of colors to be used for coloring a map. */
+ palette?: any;
+ /** Specifies the number of colors in a palette. */
+ paletteSize?: number;
+ /** Allows you to paint areas with similar attributes in the same color. */
+ colorGroups?: Array<number>;
+ /** Specifies the field that provides data to be used for coloring areas. */
+ colorGroupingField?: string;
+ /** Specifies a color for the area border when the area is selected. */
+ selectedBorderColor?: string;
+ /** Specifies a color for an area when this area is selected. */
+ selectedColor?: string;
+ /** Specifies the pixel-measured width of the area border when the area is selected. */
+ selectedBorderWidth?: number;
+ selectionChanged?: (area: Area) => void;
+ /** Specifies whether single or multiple areas can be selected on a vector map. */
+ selectionMode?: string;
+ }
+ export interface MarkerSettings {
+ /** Specifies a color for the marker border. */
+ borderColor?: string;
+ /** Specifies the width of the marker border in pixels. */
+ borderWidth?: number;
+ click?: any;
+ /** Specifies a color for a marker of the dot or bubble type. */
+ color?: string;
+ /** Specifies the function that customizes each marker individually. */
+ customize?: (markerInfo: Marker) => MarkerSettings;
+ font?: Object;
+ /** Specifies the pixel-measured width of the marker border when the marker is hovered over. */
+ hoveredBorderWidth?: number;
+ /** Specifies a color for the marker border when the marker is hovered over. */
+ hoveredBorderColor?: string;
+ /** Specifies a color for a marker of the dot or bubble type when this marker is hovered over. */
+ hoveredColor?: string;
+ /** Specifies whether or not to change the appearance of a marker when it is hovered over. */
+ hoverEnabled?: boolean;
+ /** Specifies marker label options. */
+ label?: {
+ /** Enables marker labels. */
+ enabled?: boolean;
+ /** Specifies font options for marker labels. */
+ font?: viz.core.Font;
+ };
+ /** Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if you use markers of the bubble type. */
+ maxSize?: number;
+ /** Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if you use markers of the bubble type. */
+ minSize?: number;
+ /** Specifies the opacity of markers. Setting this option makes sense only if you use markers of the bubble type. */
+ opacity?: number;
+ /** Specifies the pixel-measured width of the marker border when the marker is selected. */
+ selectedBorderWidth?: number;
+ /** Specifies a color for the marker border when the marker is selected. */
+ selectedBorderColor?: string;
+ /** Specifies a color for a marker of the dot or bubble type when this marker is selected. */
+ selectedColor?: string;
+ selectionChanged?: (marker: Marker) => void;
+ /** Specifies whether a single or multiple markers can be selected on a vector map. */
+ selectionMode?: string;
+ /** Specifies the size of markers. Setting this option makes sense for any type of marker except bubble. */
+ size?: number;
+ /** Specifies the type of markers to be used on the map. */
+ type?: string;
+ /** Specifies the name of a palette or a custom set of colors to be used for coloring markers of the pie type. */
+ palette?: any;
+ /** Allows you to paint markers with similar attributes in the same color. */
+ colorGroups?: Array<number>;
+ /** Specifies the field that provides data to be used for coloring markers. */
+ colorGroupingField?: string;
+ /** Allows you to display bubbles with similar attributes in the same size. */
+ sizeGroups?: Array<number>;
+ /** Specifies the field that provides data to be used for sizing bubble markers. */
+ sizeGroupingField?: string;
+ }
+ export interface dxVectorMapOptions extends viz.core.BaseWidgetOptions {
+ /** An object specifying options for the map areas. */
+ areaSettings?: AreaSettings;
+ /** Specifies the options for the map background. */
+ background?: {
+ /** Specifies a color for the background border. */
+ borderColor?: string;
+ /** Specifies a color for the background. */
+ color?: string;
+ };
+ /** Specifies the positioning of a map in geographical coordinates. */
+ bounds?: Array<number>;
+ /** Specifies the options of the control bar. */
+ controlBar?: {
+ /** Specifies a color for the outline of the control bar elements. */
+ borderColor?: string;
+ /** Specifies a color for the inner area of the control bar elements. */
+ color?: string;
+ /** Specifies whether or not to display the control bar. */
+ enabled?: boolean;
+ /** Specifies the margin of the control bar in pixels. */
+ margin?: number;
+ /** Specifies the position of the control bar. */
+ horizontalAlignment?: string;
+ /** Specifies the position of the control bar. */
+ verticalAlignment?: string;
+ /** Specifies the opacity of the Control_Bar. */
+ opacity?: number;
+ };
+ /** Specifies the appearance of the loading indicator. */
+ loadingIndicator?: viz.core.LoadingIndicator;
+ /** Specifies a data source for the map area. */
+ mapData?: any;
+ /** Specifies a data source for the map markers. */
+ markers?: any;
+ /** An object specifying options for the map markers. */
+ markerSettings?: MarkerSettings;
+ /** Specifies the size of the dxVectorMap widget. */
+ size?: viz.core.Size;
+ /** Specifies tooltip options. */
+ tooltip?: viz.core.Tooltip;
+ /** Configures map legends. */
+ legends?: Array<Legend>;
+ /** Specifies whether or not the map should respond when a user rolls the mouse wheel. */
+ wheelEnabled?: boolean;
+ /** Specifies whether the map should respond to touch gestures. */
+ touchEnabled?: boolean;
+ /** Disables the zooming capability. */
+ zoomingEnabled?: boolean;
+ /** Specifies the geographical coordinates of the center for a map. */
+ center?: Array<number>;
+ centerChanged?: (center: Array<number>) => void;
+ /** A handler for the centerChanged event. */
+ onCenterChanged?: (e: {
+ center: Array<number>;
+ component: dxVectorMap;
+ element: Element;
+ }) => void;
+ /** A handler for the tooltipShown event. */
+ onTooltipShown?: (e: {
+ component: dxVectorMap;
+ element: Element;
+ target: {};
+ }) => void;
+ /** A handler for the tooltipHidden event. */
+ onTooltipHidden?: (e: {
+ component: dxVectorMap;
+ element: Element;
+ target: {};
+ }) => void;
+ /** Specifies a number that is used to zoom a map initially. */
+ zoomFactor?: number;
+ /** Specifies a map's maximum zoom factor. */
+ maxZoomFactor?: number;
+ zoomFactorChanged?: (zoomFactor: number) => void;
+ /** A handler for the zoomFactorChanged event. */
+ onZoomFactorChanged?: (e: {
+ zoomFactor: number;
+ component: dxVectorMap;
+ element: Element;
+ }) => void;
+ click?: any;
+ /** A handler for the click event. */
+ onClick?: any;
+ /** A handler for the areaClick event. */
+ onAreaClick?: any;
+ /** A handler for the areaSelectionChanged event. */
+ onAreaSelectionChanged?: (e: {
+ target: Area;
+ component: dxVectorMap;
+ element: Element;
+ }) => void;
+ /** A handler for the markerClick event. */
+ onMarkerClick?: any;
+ /** A handler for the markerSelectionChanged event. */
+ onMarkerSelectionChanged?: (e: {
+ target: Marker;
+ component: dxVectorMap;
+ element: Element;
+ }) => void;
+ /** Disables the panning capability. */
+ panningEnabled?: boolean;
+ }
+ export interface Legend extends viz.core.BaseLegend {
+ /** Specifies text for legend items. */
+ customizeText?: (itemInfo: { start: number; end: number; index: number; color: string; size: number; }) => string;
+ /** Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */
+ customizeHint?: (itemInfo: { start: number; end: number; index: number; color: string; size: number }) => string;
+ /** Specifies the source of data for the legend. */
+ source?: string;
+ }
+ /** A vector map widget. */
+ export class dxVectorMap extends viz.core.BaseWidget {
+ constructor(element: JQuery, options?: dxVectorMapOptions);
+ constructor(element: Element, options?: dxVectorMapOptions);
+ /** Displays the loading indicator. */
+ showLoadingIndicator(): void;
+ /** Conceals the loading indicator. */
+ hideLoadingIndicator(): void;
+ /** Redraws a widget. */
+ render(): void;
+ /** Gets the current coordinates of the map center. */
+ center(): Array<number>;
+ /** Sets the coordinates of the map center. */
+ center(centerCoordinates: Array<number>): void;
+ /** Deselects all the selected areas on a map. The areas are displayed in their initial style after. */
+ clearAreaSelection(): void;
+ /** Deselects all the selected markers on a map. The markers are displayed in their initial style after. */
+ clearMarkerSelection(): void;
+ /** Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */
+ clearSelection(): void;
+ /** Converts client area coordinates into map coordinates. */
+ convertCoordinates(x: number, y: number): Array<number>;
+ /** Returns an array with all the map areas. */
+ getAreas(): Array<Area>;
+ /** Returns an array with all the map markers. */
+ getMarkers(): Array<Marker>;
+ /** Gets the current coordinates of the map viewport. */
+ viewport(): Array<any>;
+ /** Sets the coordinates of the map viewport. */
+ viewport(viewportCoordinates: Array<number>): void;
+ /** Gets the current value of the map zoom factor. */
+ zoomFactor(): number;
+ /** Sets the value of the map zoom factor. */
+ zoomFactor(zoomFactor: number): void;
+ }
+}
+interface JQuery {
+ dxVectorMap(options?: DevExpress.viz.map.dxVectorMapOptions): JQuery;
+ dxVectorMap(methodName: string, ...params: any[]): any;
+ dxVectorMap(methodName: "instance"): DevExpress.viz.map.dxVectorMap;
+}
+declare module DevExpress.viz.sparklines {
+ export interface SparklineTooltip extends viz.core.Tooltip {
+ /**
+ * Specifies how a tooltip is horizontally aligned relative to the graph.
+ * @deprecated Tooltip alignment is no more available.
+ */
+ horizontalAlignment?: string;
+ /**
+ * Specifies how a tooltip is vertically aligned relative to the graph.
+ * @deprecated Tooltip alignment is no more available.
+ */
+ verticalAlignment?: string;
+ }
+ export interface BaseSparklineOptions extends viz.core.BaseWidgetOptions {
+ /** Specifies the blank space between the widget's extreme elements and the boundaries of the area provided for the widget in pixels. */
+ margin?: viz.core.Margins;
+ /** Specifies the size of the widget. */
+ size?: viz.core.Size;
+ /** Specifies tooltip options. */
+ tooltip?: SparklineTooltip;
+ /** A handler for the tooltipShown event. */
+ onTooltipShown?: (e: {
+ component: BaseSparkline;
+ element: Element;
+ }) => void;
+ /** A handler for the tooltipHidden event. */
+ onTooltipHidden?: (e: {
+ component: BaseSparkline;
+ element: Element;
+ }) => void;
+ }
+ /** Overridden by descriptions for particular widgets. */
+ export class BaseSparkline extends viz.core.BaseWidget {
+ /** Redraws a widget. */
+ render(): void;
+ }
+ export interface dxBulletOptions extends BaseSparkline {
+ /** Specifies a color for the bullet bar. */
+ color?: string;
+ /** Specifies an end value for the invisible scale. */
+ endScaleValue?: number;
+ /** Specifies whether or not to show the target line. */
+ showTarget?: boolean;
+ /** Specifies whether or not to show the line indicating zero on the invisible scale. */
+ showZeroLevel?: boolean;
+ /** Specifies a start value for the invisible scale. */
+ startScaleValue?: number;
+ /** Specifies the value indicated by the target line. */
+ target?: number;
+ /** Specifies a color for both the target and zero level lines. */
+ targetColor?: string;
+ /** Specifies the width of the target line. */
+ targetWidth?: number;
+ /** Specifies the primary value indicated by the bullet bar. */
+ value?: number;
+ }
+ /** A bullet graph widget. */
+ export class dxBullet extends BaseSparkline {
+ constructor(element: JQuery, options?: dxBulletOptions);
+ constructor(element: Element, options?: dxBulletOptions);
+ }
+ export interface dxSparklineOptions extends BaseSparklineOptions {
+ /** Specifies the data source field that provides arguments for a sparkline. */
+ argumentField?: string;
+ /** Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */
+ barNegativeColor?: string;
+ /** Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */
+ barPositiveColor?: string;
+ /** Specifies a data source for the sparkline. */
+ dataSource?: Array<any>;
+ /** Sets a color for the boundary of both the first and last points on a sparkline. */
+ firstLastColor?: string;
+ /** Specifies whether a sparkline ignores null data points or not. */
+ ignoreEmptyPoints?: boolean;
+ /** Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */
+ lineColor?: string;
+ /** Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */
+ lineWidth?: number;
+ /** Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */
+ lossColor?: string;
+ /** Sets a color for the boundary of the maximum point on a sparkline. */
+ maxColor?: string;
+ /** Sets a color for the boundary of the minimum point on a sparkline. */
+ minColor?: string;
+ /** Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */
+ pointColor?: string;
+ /** Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */
+ pointSize?: number;
+ /** Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */
+ pointSymbol?: string;
+ /** Specifies whether or not to indicate both the first and last values on a sparkline. */
+ showFirstLast?: boolean;
+ /** Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */
+ showMinMax?: boolean;
+ /** Determines the type of a sparkline. */
+ type?: string;
+ /** Specifies the data source field that provides values for a sparkline. */
+ valueField?: string;
+ /** Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */
+ winColor?: string;
+ /** Specifies a value that serves as a threshold for the sparkline of the winloss type. */
+ winlossThreshold?: number;
+ /** Specifies the minimum value of the sparkline value axis. */
+ minValue?: number;
+ /** Specifies the maximum value of the sparkline's value axis. */
+ maxValue?: number;
+ }
+ /** A sparkline widget. */
+ export class dxSparkline extends BaseSparkline {
+ constructor(element: JQuery, options?: dxSparklineOptions);
+ constructor(element: Element, options?: dxSparklineOptions);
+ }
+}
+interface JQuery {
+ dxBullet(options?: DevExpress.viz.sparklines.dxBulletOptions): JQuery;
+ dxBullet(methodName: string, ...params: any[]): any;
+ dxBullet(methodName: "instance"): DevExpress.viz.sparklines.dxBullet;
+ dxSparkline(options?: DevExpress.viz.sparklines.dxSparklineOptions): JQuery;
+ dxSparkline(methodName: string, ...params: any[]): any;
+ dxSparkline(methodName: "instance"): DevExpress.viz.sparklines.dxSparkline;
+}
diff --git a/dhtmlxscheduler/dhtmlxscheduler.d.ts b/dhtmlxscheduler/dhtmlxscheduler.d.ts
index 011532573b..c79ce78c9a 100644
--- a/dhtmlxscheduler/dhtmlxscheduler.d.ts
+++ b/dhtmlxscheduler/dhtmlxscheduler.d.ts
@@ -1229,7 +1229,7 @@ interface SchedulerStatic{
* return the event object by its id
* @param event_id event_id
*/
- getEvent(event_id: any);
+ getEvent<T>(event_id: any): T;
/**
* gets the event's end date
@@ -1601,4 +1601,4 @@ interface SchedulerStatic{
-declare var scheduler: SchedulerStatic;
\ No newline at end of file
+declare var scheduler: SchedulerStatic;
diff --git a/di-lite/di-lite-test.ts b/di-lite/di-lite-tests.ts
similarity index 100%
rename from di-lite/di-lite-test.ts
rename to di-lite/di-lite-tests.ts
diff --git a/docopt/docopt-tests.ts b/docopt/docopt-tests.ts
new file mode 100644
index 0000000000..b8c1a2c25b
--- /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 0000000000..ea2330a193
--- /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/dropzone/dropzone.d.ts.tscparams b/dropzone/dropzone.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/dropzone/dropzone.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/durandal/durandal.d.ts b/durandal/durandal.d.ts
index 86f988cbe7..f5b7c32601 100644
--- a/durandal/durandal.d.ts
+++ b/durandal/durandal.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for Durandal 2.1.0
+// Type definitions for Durandal 2.1.0
// Project: http://durandaljs.com
// Definitions by: Blue Spire <https://github.com/BlueSpire>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
@@ -12,6 +12,18 @@
/// <reference path="../jquery/jquery.d.ts" />
/// <reference path="../knockout/knockout.d.ts" />
+// By default, Durandal uses JQuery's Defer/Promise implementation, but durandal supports injecting/configuring
+// usage of different JavaScript Defer/Promise libraries (f.ex. Q or ES6 Promise polyfills).
+// You might therefore want to use a different interface from a community typings file or your custom unified interface.
+// When using f.ex. Q as Defer/Promise library replace the lines below with:
+
+// <reference path="../q/Q.d.ts" />
+// interface DurandalPromise<T> extends Q.Promise<T>
+// interface DurandalDeferred<T> extends Q.Deferred<T>
+
+interface DurandalPromise<T> extends JQueryPromise<T> { }
+interface DurandalDeferred<T> extends JQueryDeferred<T> { }
+
/**
* The system module encapsulates the most basic features used by other modules.
* @requires require
@@ -45,7 +57,7 @@ interface DurandalSystemModule {
* @param {object} obj The object whose module id you wish to set.
* @param {string} id The id to set for the specified object.
*/
- setModuleId(obj, id: string): void;
+ setModuleId(obj: any, id: string): void;
/**
* Resolves the default object instance for a module. If the module is an object, the module is returned. If the module is a function, that function is called with `new` and it's result is returned.
@@ -89,9 +101,9 @@ interface DurandalSystemModule {
/**
* Creates a deferred object which can be used to create a promise. Optionally pass a function action to perform which will be passed an object used in resolving the promise.
* @param {function} [action] The action to defer. You will be passed the deferred object as a paramter.
- * @returns {JQueryDeferred} The deferred object.
+ * @returns {Deferred} The deferred object.
*/
- defer<T>(action?: (dfd: JQueryDeferred<T>) => void): JQueryDeferred<T>;
+ defer<T>(action?: (dfd: DurandalDeferred<T>) => void): DurandalDeferred<T>;
/**
* Creates a simple V4 UUID. This should not be used as a PK in your database. It can be used to generate internal, unique ids. For a more robust solution see [node-uuid](https://github.com/broofa/node-uuid).
@@ -102,23 +114,23 @@ interface DurandalSystemModule {
/**
* Uses require.js to obtain a module. This function returns a promise which resolves with the module instance.
* @param {string} moduleId The id of the module to load.
- * @returns {JQueryPromise} A promise for the loaded module.
+ * @returns {Promise} A promise for the loaded module.
*/
- acquire(moduleId: string): JQueryPromise<any>;
+ acquire(moduleId: string): DurandalPromise<any>;
/**
* Uses require.js to obtain an array of modules. This function returns a promise which resolves with the modules instances in an array.
* @param {string[]} moduleIds The ids of the modules to load.
- * @returns {JQueryPromise} A promise for the loaded module.
+ * @returns {Promise} A promise for the loaded module.
*/
- acquire(modules: string[]): JQueryPromise<any[]>;
+ acquire(modules: string[]): DurandalPromise<any[]>;
/**
* Uses require.js to obtain multiple modules. This function returns a promise which resolves with the module instances in an array.
* @param {string} moduleIds* The ids of the modules to load.
- * @returns {JQueryPromise} A promise for the loaded module.
+ * @returns {Promise} A promise for the loaded module.
*/
- acquire(...moduleIds: string[]): JQueryPromise<any[]>;
+ acquire(...moduleIds: string[]): DurandalPromise<any[]>;
/**
* Extends the first object with the properties of the following objects.
@@ -130,9 +142,9 @@ interface DurandalSystemModule {
/**
* Uses a setTimeout to wait the specified milliseconds.
* @param {number} milliseconds The number of milliseconds to wait.
- * @returns {JQueryPromise}
+ * @returns {Promise}
*/
- wait(milliseconds: number): JQueryPromise<any>;
+ wait(milliseconds: number): DurandalPromise<any>;
/**
* Gets all the owned keys of the specified object.
@@ -295,14 +307,14 @@ interface DurandalViewEngineModule {
* @param {string} id The view id whose view should be cached.
* @param {DOMElement} view The view to cache.
*/
- putViewInCache(id: string, view: HTMLElement);
+ putViewInCache(id: string, view: HTMLElement): void;
/**
* Creates the view associated with the view id.
* @param {string} viewId The view id whose view should be created.
- * @returns {JQueryPromise<HTMLElement>} A promise of the view.
+ * @returns {DurandalPromise<HTMLElement>} A promise of the view.
*/
- createView(viewId: string): JQueryPromise<HTMLElement>;
+ createView(viewId: string): DurandalPromise<HTMLElement>;
/**
* Called when a view cannot be found to provide the opportunity to locate or generate a fallback view. Mainly used to ease development.
@@ -311,7 +323,7 @@ interface DurandalViewEngineModule {
* @param {Error} requirePath The error that was returned from the attempt to locate the default view.
* @returns {Promise} A promise for the fallback view.
*/
- createFallbackView(viewId: string, requirePath: string, err: Error): JQueryPromise<HTMLElement>;
+ createFallbackView(viewId: string, requirePath: string, err: Error): DurandalPromise<HTMLElement>;
}
/**
@@ -439,7 +451,7 @@ interface DurandalViewLocatorModule {
* @param {DOMElement[]} [elementsToSearch] An existing set of elements to search first.
* @returns {Promise} A promise of the view.
*/
- locateViewForObject(obj: any, area: string, elementsToSearch?: HTMLElement[]): JQueryPromise<HTMLElement>;
+ locateViewForObject(obj: any, area: string, elementsToSearch?: HTMLElement[]): DurandalPromise<HTMLElement>;
/**
* Converts a module id into a view id. By default the ids are the same.
@@ -470,7 +482,7 @@ interface DurandalViewLocatorModule {
* @param {DOMElement[]} [elementsToSearch] An existing set of elements to search first.
* @returns {Promise} A promise of the view.
*/
- locateView(view: HTMLElement, area?: string, elementsToSearch?: HTMLElement[]): JQueryPromise<HTMLElement>;
+ locateView(view: HTMLElement, area?: string, elementsToSearch?: HTMLElement[]): DurandalPromise<HTMLElement>;
/**
* Locates the specified view.
@@ -479,7 +491,7 @@ interface DurandalViewLocatorModule {
* @param {DOMElement[]} [elementsToSearch] An existing set of elements to search first.
* @returns {Promise} A promise of the view.
*/
- locateView(viewUrlOrId: string, area?: string, elementsToSearch?: HTMLElement[]): JQueryPromise<HTMLElement>;
+ locateView(viewUrlOrId: string, area?: string, elementsToSearch?: HTMLElement[]): DurandalPromise<HTMLElement>;
}
/**
@@ -514,7 +526,7 @@ declare module 'durandal/composition' {
area?: string;
preserveContext?: boolean;
activate?: boolean;
- strategy?: (context: CompositionContext) => JQueryPromise<HTMLElement>;
+ strategy?: (context: CompositionContext) => DurandalPromise<HTMLElement>;
composingNewView: boolean;
child: HTMLElement;
binding?: (child: HTMLElement, parent: HTMLElement, context: CompositionContext) => void;
@@ -547,7 +559,7 @@ declare module 'durandal/composition' {
* @param {object} [config] The binding handler instance. If none is provided, the name will be used to look up an existing handler which will then be converted to a composition handler.
* @param {function} [initOptionsFactory] If the registered binding needs to return options from its init call back to knockout, this function will server as a factory for those options. It will receive the same parameters that the init function does.
*/
- export function addBindingHandler(name, config?: KnockoutBindingHandler, initOptionsFactory?: (element?: HTMLElement, valueAccessor?: any, allBindingsAccessor?: any, viewModel?: any, bindingContext?: KnockoutBindingContext) => any);
+ export function addBindingHandler(name: string, config?: KnockoutBindingHandler, initOptionsFactory?: (element?: HTMLElement, valueAccessor?: any, allBindingsAccessor?: any, viewModel?: any, bindingContext?: KnockoutBindingContext) => any): void;
/**
* Gets an object keyed with all the elements that are replacable parts, found within the supplied elements. The key will be the part name and the value will be the element itself.
@@ -568,7 +580,7 @@ declare module 'durandal/composition' {
* @param {object} context The composition context containing the model and possibly existing viewElements.
* @returns {promise} A promise for the view.
*/
- export var defaultStrategy: (context: CompositionContext) => JQueryPromise<HTMLElement>;
+ export var defaultStrategy: (context: CompositionContext) => DurandalPromise<HTMLElement>;
/**
* Initiates a composition.
@@ -663,13 +675,13 @@ declare module 'plugins/dialog' {
* In this function, you are expected to add a DOM element to the tree which will serve as the "host" for the modal's composed view. You must add a property called host to the modalWindow object which references the dom element. It is this host which is passed to the composition module.
* @param {Dialog} theDialog The dialog model.
*/
- addHost(theDialog: Dialog);
+ addHost(theDialog: Dialog): void;
/**
* This function is expected to remove any DOM machinery associated with the specified dialog and do any other necessary cleanup.
* @param {Dialog} theDialog The dialog model.
*/
- removeHost(theDialog: Dialog);
+ removeHost(theDialog: Dialog): void;
/**
* This function is called after the modal is fully composed into the DOM, allowing your implementation to do any final modifications, such as positioning or animation. You can obtain the original dialog object by using `getDialog` on context.model.
@@ -677,14 +689,14 @@ declare module 'plugins/dialog' {
* @param {DOMElement} parent The parent view.
* @param {object} context The composition context.
*/
- compositionComplete(child: HTMLElement, parent: HTMLElement, context: composition.CompositionContext);
+ compositionComplete(child: HTMLElement, parent: HTMLElement, context: composition.CompositionContext): void;
}
interface Dialog {
owner: any;
context: DialogContext;
activator: DurandalActivator<any>;
- close(): JQueryPromise<any>;
+ close(): DurandalPromise<any>;
settings: composition.CompositionContext;
}
@@ -745,7 +757,7 @@ declare module 'plugins/dialog' {
* @param {string} [context] The name of the dialog context to use. Uses the default context if none is specified.
* @returns {Promise} A promise that resolves when the dialog is closed and returns any data passed at the time of closing.
*/
- export function show(obj: any, activationData?: any, context?: string): JQueryPromise<any>;
+ export function show(obj: any, activationData?: any, context?: string): DurandalPromise<any>;
/**
* Shows a message box.
@@ -756,7 +768,7 @@ declare module 'plugins/dialog' {
* @param {Object} [settings] Custom settings for this instance of the messsage box, used to change classes and styles.
* @returns {Promise} A promise that resolves when the message box is closed and returns the selected option.
*/
- export function showMessage(message: string, title?: string, options?: string[], autoclose?: boolean, settings?: Object): JQueryPromise<string>;
+ export function showMessage(message: string, title?: string, options?: string[], autoclose?: boolean, settings?: Object): DurandalPromise<string>;
/**
* Shows a message box.
@@ -767,7 +779,7 @@ declare module 'plugins/dialog' {
* @param {Object} [settings] Custom settings for this instance of the messsage box, used to change classes and styles.
* @returns {Promise} A promise that resolves when the message box is closed and returns the selected option.
*/
- export function showMessage(message: string, title?: string, options?: DialogButton[], autoclose?: boolean, settings?: Object): JQueryPromise<any>;
+ export function showMessage(message: string, title?: string, options?: DialogButton[], autoclose?: boolean, settings?: Object): DurandalPromise<any>;
/**
* Installs this module into Durandal; called by the framework. Adds `app.showDialog` and `app.showMessage` convenience methods.
@@ -890,7 +902,7 @@ declare module 'plugins/http' {
* @param {object} [headers] The data to add to the request header. It will be converted to JSON. If the data contains Knockout observables, they will be converted into normal properties before serialization.
* @returns {Promise} A promise of the get response data.
*/
- export function get(url: string, query?: Object, headers?: Object): JQueryPromise<any>;
+ export function get(url: string, query?: Object, headers?: Object): DurandalPromise<any>;
/**
* Makes an JSONP request.
@@ -900,7 +912,7 @@ declare module 'plugins/http' {
* @param {object} [headers] The data to add to the request header. It will be converted to JSON. If the data contains Knockout observables, they will be converted into normal properties before serialization.
* @returns {Promise} A promise of the response data.
*/
- export function jsonp(url: string, query?: Object, callbackParam?: string, headers?: Object): JQueryPromise<any>;
+ export function jsonp(url: string, query?: Object, callbackParam?: string, headers?: Object): DurandalPromise<any>;
/**
* Makes an HTTP POST request.
@@ -909,7 +921,7 @@ declare module 'plugins/http' {
* @param {object} [headers] The data to add to the request header. It will be converted to JSON. If the data contains Knockout observables, they will be converted into normal properties before serialization.
* @returns {Promise} A promise of the response data.
*/
- export function post(url: string, data: Object, headers?: Object): JQueryPromise<any>;
+ export function post(url: string, data: Object, headers?: Object): DurandalPromise<any>;
/**
* Makes an HTTP PUT request.
@@ -919,7 +931,7 @@ declare module 'plugins/http' {
* @param {object} [headers] The data to add to the request header. It will be converted to JSON. If the data contains Knockout observables, they will be converted into normal properties before serialization.
* @return {Promise} A promise of the response data.
*/
- export function put(url: string, data: Object, headers?: Object): JQueryPromise<any>;
+ export function put(url: string, data: Object, headers?: Object): DurandalPromise<any>;
/**
* Makes an HTTP DELETE request.
@@ -929,7 +941,7 @@ declare module 'plugins/http' {
* @param {object} [headers] The data to add to the request header. It will be converted to JSON. If the data contains Knockout observables, they will be converted into normal properties before serialization.
* @return {Promise} A promise of the get response data.
*/
- export function remove(url: string, query?: Object, headers?: Object): JQueryPromise<any>;
+ export function remove(url: string, query?: Object, headers?: Object): DurandalPromise<any>;
}
/**
@@ -964,7 +976,7 @@ declare module 'plugins/observable' {
* @param {function|object} evaluatorOrOptions The Knockout computed function or computed options object.
* @returns {KnockoutComputed} The underlying computed observable.
*/
- export function defineProperty<T>(obj: any, propertyName: string, evaluatorOrOptions?: KnockoutComputedDefine<T>);
+ export function defineProperty<T>(obj: any, propertyName: string, evaluatorOrOptions?: KnockoutComputedDefine<T>): KnockoutComputed<T>;
/**
* Installs the plugin into the view model binder's `beforeBind` hook so that objects are automatically converted before being bound.
@@ -1046,7 +1058,7 @@ declare module 'plugins/serializer' {
* @param {object} [settings] Settings can specify a replacer or space to override the serializer defaults.
* @returns {string} The JSON string.
*/
- export function serialize(object: any, settings?: string);
+ export function serialize(object: any, settings?: string): string;
/**
* Serializes the object.
@@ -1054,7 +1066,7 @@ declare module 'plugins/serializer' {
* @param {object} [settings] Settings can specify a replacer or space to override the serializer defaults.
* @returns {string} The JSON string.
*/
- export function serialize(object: any, settings?: number);
+ export function serialize(object: any, settings?: number): string;
/**
* Serializes the object.
@@ -1062,7 +1074,7 @@ declare module 'plugins/serializer' {
* @param {object} [settings] Settings can specify a replacer or space to override the serializer defaults.
* @returns {string} The JSON string.
*/
- export function serialize(object: any, settings?: SerializerOptions);
+ export function serialize(object: any, settings?: SerializerOptions): string;
/**
* Gets the type id for an object instance, using the configured `typeAttribute`.
@@ -1081,7 +1093,7 @@ declare module 'plugins/serializer' {
* @param {string} typeId The type id.
* @param {function} constructor The constructor.
*/
- export function registerType(typeId: string, constructor: () => any);
+ export function registerType(typeId: string, constructor: () => any): void;
/**
* The default reviver function used during deserialization. By default is detects type properties on objects and uses them to re-construct the correct object using the provided constructor mapping.
@@ -1091,7 +1103,7 @@ declare module 'plugins/serializer' {
* @param {object} getConstructor A custom function used to get the constructor function associated with a type id.
* @returns {object} The value.
*/
- export function reviver(key: string, value: any, getTypeId: (value: any) => string, getConstructor: (string) => () => any): any;
+ export function reviver(key: string, value: any, getTypeId: (value: any) => string, getConstructor: (id: string) => () => any): any;
/**
* Deserialize the JSON.
@@ -1128,7 +1140,7 @@ declare module 'plugins/widget' {
* Creates a ko binding handler for the specified kind.
* @param {string} kind The kind to create a custom binding handler for.
*/
- export function registerKind(kind: string);
+ export function registerKind(kind: string): void;
/**
* Maps views and module to the kind identifier if a non-standard pattern is desired.
@@ -1136,7 +1148,7 @@ declare module 'plugins/widget' {
* @param {string} [viewId] The unconventional view id to map the kind to.
* @param {string} [moduleId] The unconventional module id to map the kind to.
*/
- export function mapKind(kind: string, viewId?: string, moduleId?: string);
+ export function mapKind(kind: string, viewId?: string, moduleId?: string): void;
/**
* Maps a kind name to it's module id. First it looks up a custom mapped kind, then falls back to `convertKindToModulePath`.
@@ -1172,7 +1184,7 @@ declare module 'plugins/widget' {
* @param {object} settings The widget settings.
* @param {object} [bindingContext] The current binding context.
*/
- export function create(element: HTMLElement, settings: WidgetSettings, bindingContext?: KnockoutBindingContext);
+ export function create(element: HTMLElement, settings: WidgetSettings, bindingContext?: KnockoutBindingContext): void;
}
/**
@@ -1279,14 +1291,14 @@ interface DurandalAppModule extends DurandalEventSupport<DurandalAppModule> {
* @param {string} [context] The name of the dialog context to use. Uses the default context if none is specified.
* @returns {Promise} A promise that resolves when the dialog is closed and returns any data passed at the time of closing.
*/
- showDialog(obj: any, activationData?: any, context?: string): JQueryPromise<any>;
+ showDialog(obj: any, activationData?: any, context?: string): DurandalPromise<any>;
/**
* Closes the dialog associated with the specified object. via the dialog plugin.
* @param {object} obj The object whose dialog should be closed.
* @param {object} results* The results to return back to the dialog caller after closing.
*/
- closeDialog(obj: any, ...results);
+ closeDialog(obj: any, ...results: any[]): void;
/**
* Shows a message box via the dialog plugin.
@@ -1297,7 +1309,7 @@ interface DurandalAppModule extends DurandalEventSupport<DurandalAppModule> {
* @param {Object} [settings] Custom settings for this instance of the messsage box, used to change classes and styles.
* @returns {Promise} A promise that resolves when the message box is closed and returns the selected option.
*/
- showMessage(message: string, title?: string, options?: string[], autoclose?: boolean, settings?: Object): JQueryPromise<string>;
+ showMessage(message: string, title?: string, options?: string[], autoclose?: boolean, settings?: Object): DurandalPromise<string>;
/**
* Shows a message box.
@@ -1308,7 +1320,7 @@ interface DurandalAppModule extends DurandalEventSupport<DurandalAppModule> {
* @param {Object} [settings] Custom settings for this instance of the messsage box, used to change classes and styles.
* @returns {Promise} A promise that resolves when the message box is closed and returns the selected option.
*/
- showMessage(message: string, title?: string, options?: DialogButton[], autoclose?: boolean, settings?: Object): JQueryPromise<any>;
+ showMessage(message: string, title?: string, options?: DialogButton[], autoclose?: boolean, settings?: Object): DurandalPromise<any>;
/**
* Configures one or more plugins to be loaded and installed into the application.
@@ -1322,7 +1334,7 @@ interface DurandalAppModule extends DurandalEventSupport<DurandalAppModule> {
* Starts the application.
* @returns {promise}
*/
- start(): JQueryPromise<any>;
+ start(): DurandalPromise<any>;
/**
* Sets the root module/view for the application.
@@ -1404,7 +1416,7 @@ interface DurandalActivator<T> extends KnockoutComputed<T> {
* @param {boolean} close Whether or not to check if close is possible.
* @returns {promise}
*/
- canDeactivateItem(item: T, close: boolean): JQueryPromise<boolean>;
+ canDeactivateItem(item: T, close: boolean): DurandalPromise<boolean>;
/**
* Deactivates the specified item.
@@ -1412,7 +1424,7 @@ interface DurandalActivator<T> extends KnockoutComputed<T> {
* @param {boolean} close Whether or not to close the item.
* @returns {promise}
*/
- deactivateItem(item: T, close: boolean): JQueryPromise<boolean>;
+ deactivateItem(item: T, close: boolean): DurandalPromise<boolean>;
/**
* Determines whether or not the specified item can be activated.
@@ -1420,7 +1432,7 @@ interface DurandalActivator<T> extends KnockoutComputed<T> {
* @param {object} activationData Data associated with the activation.
* @returns {promise}
*/
- canActivateItem(newItem: T, activationData?: any): JQueryPromise<boolean>;
+ canActivateItem(newItem: T, activationData?: any): DurandalPromise<boolean>;
/**
* Activates the specified item.
@@ -1428,31 +1440,31 @@ interface DurandalActivator<T> extends KnockoutComputed<T> {
* @param {object} newActivationData Data associated with the activation.
* @returns {promise}
*/
- activateItem(newItem: T, activationData?: any): JQueryPromise<boolean>;
+ activateItem(newItem: T, activationData?: any): DurandalPromise<boolean>;
/**
* Determines whether or not the activator, in its current state, can be activated.
* @returns {promise}
*/
- canActivate(): JQueryPromise<boolean>;
+ canActivate(): DurandalPromise<boolean>;
/**
* Activates the activator, in its current state.
* @returns {promise}
*/
- activate(): JQueryPromise<boolean>;
+ activate(): DurandalPromise<boolean>;
/**
* Determines whether or not the activator, in its current state, can be deactivated.
* @returns {promise}
*/
- canDeactivate(close: boolean): JQueryPromise<boolean>;
+ canDeactivate(close: boolean): DurandalPromise<boolean>;
/**
* Deactivates the activator, in its current state.
* @returns {promise}
*/
- deactivate(close: boolean): JQueryPromise<boolean>;
+ deactivate(close: boolean): DurandalPromise<boolean>;
/**
* Adds canActivate, activate, canDeactivate and deactivate functions to the provided model which pass through to the corresponding functions on the activator.
@@ -1462,7 +1474,7 @@ interface DurandalActivator<T> extends KnockoutComputed<T> {
/**
* Sets up a collection representing a pool of objects which the activator will activate. See below for details. Activators without an item bool always close their values on deactivate. Activators with an items pool only deactivate, but do not close them.
*/
- forItems(items): DurandalActivator<T>;
+ forItems(items: any[]): DurandalActivator<T>;
}
interface DurandalHistoryOptions {
@@ -1509,7 +1521,7 @@ interface DurandalRouteConfiguration {
title?: any;
moduleId?: string;
hash?: string;
- route?: string|string[];
+ route?: string | string[];
routePattern?: RegExp;
isActive?: KnockoutComputed<boolean>;
nav?: any;
@@ -1529,6 +1541,7 @@ interface DurandalRelativeRouteSettings {
moduleId?: string;
route?: string;
fromParent?: boolean;
+ dynamicHash?: string;
}
interface DurandalRouterBase<T> extends DurandalEventSupport<T> {
@@ -1765,7 +1778,7 @@ interface DurandalRouterBase<T> extends DurandalEventSupport<T> {
* @param {object} instruction The route instruction. The instruction object has config, fragment, queryString, params and queryParams properties.
* @returns {Promise|Boolean|String} If a boolean, determines whether or not the route should activate or be cancelled. If a string, causes a redirect to the specified route. Can also be a promise for either of these value types.
*/
- guardRoute?: (instance: Object, instruction: DurandalRouteInstruction) => JQueryPromise<boolean|string>|boolean|string;
+ guardRoute?: (instance: Object, instruction: DurandalRouteInstruction) => DurandalPromise<boolean | string> | boolean | string;
/**
* Parent router of the current child router.
@@ -1785,7 +1798,7 @@ interface DurandalRootRouter extends DurandalRouterBase<DurandalRootRouter> {
* Activates the router and the underlying history tracking mechanism.
* @returns {Promise} A promise that resolves when the router is ready.
*/
- activate(options?: DurandalHistoryOptions): JQueryPromise<any>;
+ activate(options?: DurandalHistoryOptions): DurandalPromise<any>;
/**
* Disable history, perhaps temporarily. Not useful in a real app, but possibly useful for unit testing Routers.
diff --git a/durandal/durandal.d.ts.tscparams b/durandal/durandal.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/durandal/durandal.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/easy-table/easy-table-0.2.0-tests.ts b/easy-table/easy-table-0.2.0-tests.ts
new file mode 100644
index 0000000000..93a4516bf5
--- /dev/null
+++ b/easy-table/easy-table-0.2.0-tests.ts
@@ -0,0 +1,14 @@
+/// <reference path="easy-table.d.ts" />
+
+import EasyTable = require('easy-table');
+
+var table = new EasyTable();
+
+table.cell('aa', 1);
+table.cell('bb',1);
+table.newRow();
+
+table.cell('aa', 1);
+table.cell('bb',1);
+
+table.print();
diff --git a/easy-table/easy-table-0.2.0.d.ts b/easy-table/easy-table-0.2.0.d.ts
new file mode 100644
index 0000000000..912b089ce9
--- /dev/null
+++ b/easy-table/easy-table-0.2.0.d.ts
@@ -0,0 +1,41 @@
+// Type definitions for easy-table 0.2.0
+// Project: https://github.com/eldargab/easy-table
+// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "easy-table" {
+ class EasyTable {
+ constructor();
+
+ cell(label: string, value: any, printer?: EasyTable.CellPrinter, width?: number):void;
+ newRow(): void;
+ toString(): string;
+ printTransposed(): string;
+ print(): string;
+ sort(fields: string): void;
+ sort(comparer: (a: any, b: any) => number): void;
+ total(label: string, accumulator: EasyTable.Accumulator, totalPrinter: EasyTable.CellPrinter): void;
+ }
+
+ module EasyTable {
+ function printArray(array: any[], cellPrinter?: CellPrinter, tablePrinter?: Printer): string;
+ function printObject(object: any, cellPrinter?: CellPrinter, tablePrinter?: Printer): string;
+
+ //printer helpers
+ function Number(length: number): CellPrinter;
+ function RightPadder(char: string): CellPrinter;
+ function LeftPadder(char: string): CellPrinter;
+
+ interface CellPrinter extends Function {
+ (obj: any, cell: (label: string, value: any, width?: number) => void):string;
+ }
+ interface Printer extends Function {
+ (table: EasyTable):string;
+ }
+ interface Accumulator extends Function {
+ (sum: number, val: number, index: number, length: number):number;
+ }
+ }
+
+ export = EasyTable;
+}
diff --git a/easy-table/easy-table-tests.ts b/easy-table/easy-table-tests.ts
index 7324260643..911031d90d 100644
--- a/easy-table/easy-table-tests.ts
+++ b/easy-table/easy-table-tests.ts
@@ -1,15 +1,103 @@
-/// <reference path="easy-table.d.ts" />
+///<reference path="easy-table.d.ts" />
-import EasyTable = require('easy-table');
+import Table = require("easy-table");
-var table = new EasyTable();
+let data = [
+ { id: 123123, desc: 'Something awesome', price: 1000.00 },
+ { id: 245452, desc: 'Very interesting book', price: 11.45 },
+ { id: 232323, desc: 'Yet another product', price: 555.55 }
+];
-table.cell('aa', 1);
-table.cell('bb',1);
-table.newRow();
+interface Data {
+ id: number;
+ desc: string;
+ price: number;
+}
-table.cell('aa', 1);
-table.cell('bb',1);
+function sample_test() {
+ let t = new Table();
+ data.forEach(function(product) {
+ t.cell('Product Id', product.id);
+ t.cell('Description', product.desc);
+ t.cell('Price, USD', product.price, Table.number(2));
+ t.newRow();
+ });
+ console.log(t.toString());
+}
-table.print();
+function static_print() {
+ console.log(Table.print(data));
+}
+function currency(val: number, width?: number) {
+ var str = val.toFixed(2);
+ return width ? str : Table.padLeft(str, width);
+}
+
+function sample_2() {
+ Table.print<Data>(data, {
+ desc: { name: 'description' },
+ price: { printer: Table.number(2) }
+ });
+}
+
+function sample_3() {
+ Table.print(data, function(item, cell) {
+ cell('Product id', item.id)
+ cell('Price, USD', item.price)
+ }, function(table) {
+ return table.print()
+ })
+}
+
+function sample_4() {
+ Table.print(data[0]);
+}
+
+function sort_strings() {
+ let t = new Table();
+ t.sort(['Price, USD|des']) // will sort in descending order
+ t.sort(['Price, USD|asc']) // will sort in ascending order
+ t.sort(['Price, USD']) // sorts in ascending order by default
+}
+
+function totalling() {
+ let t = new Table();
+ t.total('Price, USD');
+ t.total('Price, USD', {
+ printer: Table.aggr.printer('Avg: ', currency),
+ reduce: Table.aggr.avg,
+ init: 0
+ })
+
+ // or alternatively
+ t.total('Price, USD', {
+ printer: (val, width) => {
+ return Table.padLeft('Avg: ' + currency(val), width);
+ },
+ reduce: (acc: number, val: number, idx: number, len: number) => {
+ acc = acc + val;
+ return idx + 1 == len ? acc / len : acc;
+ }
+ });
+}
+
+function other_samples() {
+ var t = new Table();
+
+ data.forEach(product => {
+ t.cell('Product Id', product.id)
+ t.cell('Description', product.desc)
+ t.cell('Price, USD', product.price, Table.number(2))
+ t.newRow()
+ })
+
+ t.sort(['Price, USD'])
+ t.total('Price, USD', {
+ printer: Table.number(2)
+ })
+
+ t.log()
+ Table.log(data, { price: { printer: Table.number(2) } })
+ Table.log(data[0])
+}
diff --git a/easy-table/easy-table.d.ts b/easy-table/easy-table.d.ts
index 912b089ce9..60bcb04574 100644
--- a/easy-table/easy-table.d.ts
+++ b/easy-table/easy-table.d.ts
@@ -1,40 +1,222 @@
-// Type definitions for easy-table 0.2.0
+// Type definitions for easy-table
// Project: https://github.com/eldargab/easy-table
-// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+// Definitions by: Niklas Mollenhauer <https://github.com/nikeee>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-declare module "easy-table" {
+declare module "easy-table"
+{
class EasyTable {
- constructor();
- cell(label: string, value: any, printer?: EasyTable.CellPrinter, width?: number):void;
- newRow(): void;
- toString(): string;
- printTransposed(): string;
- print(): string;
- sort(fields: string): void;
- sort(comparer: (a: any, b: any) => number): void;
- total(label: string, accumulator: EasyTable.Accumulator, totalPrinter: EasyTable.CellPrinter): void;
+ /**
+ * String to separate columns
+ */
+ public separator: string;
+
+ /**
+ * Default printer
+ */
+ public static string(value: any): string;
+
+ /**
+ * Create a printer which right aligns the content by padding with `ch` on the left
+ *
+ * @param {String} ch
+ * @returns {Function}
+ */
+ public static leftPadder<T>(ch: string): CellPrinter<T>;
+
+ public static padLeft: CellPrinter<string>;
+
+ /**
+ * Create a printer which pads with `ch` on the right
+ *
+ * @param {String} ch
+ * @returns {Function}
+ */
+ public static rightPadder<T>(ch: string): CellPrinter<T>;
+
+ // public static padRight: CellPrinter<string>;
+
+ /**
+ * Create a printer for numbers
+ *
+ * Will do right alignment and optionally fix the number of digits after decimal point
+ *
+ * @param {Number} [digits] - Number of digits for fixpoint notation
+ * @returns {Function}
+ */
+ public static number(digits?: number): CellPrinter<number>;
+
+ public constructor();
+
+ /**
+ * Push the current row to the table and start a new one
+ *
+ * @returns {Table} `this`
+ */
+ public newRow(): EasyTable;
+
+ /**
+ * Write cell in the current row
+ *
+ * @param {String} col - Column name
+ * @param {Any} val - Cell value
+ * @param {Function} [printer] - Printer function to format the value
+ * @returns {Table} `this`
+ */
+ public cell<T>(col: string, val: T, printer?: CellPrinter<T>): EasyTable;
+
+ /**
+ * Get list of columns in printing order
+ *
+ * @returns {string[]}
+ */
+ public columns(): string[];
+
+ /**
+ * Format just rows, i.e. print the table without headers and totals
+ *
+ * @returns {String} String representaion of the table
+ */
+ public print(): string;
+
+ /**
+ * Format the table
+ *
+ * @returns {String}
+ */
+ public toString(): string;
+
+ /**
+ * Push delimeter row to the table (with each cell filled with dashs during printing)
+ *
+ * @param {String[]} [cols]
+ * @returns {Table} `this`
+ */
+ public pushDelimeter(cols?: string[]): EasyTable;
+
+ /**
+ * Compute all totals and yield the results to `cb`
+ *
+ * @param {Function} cb - Callback function with signature `(column, value, printer)`
+ */
+ public forEachTotal<T>(cb: (column: string, value: T, printer: CellPrinter<T>) => void): void;
+
+ /**
+ * Format the table so that each row represents column and each column represents row
+ *
+ * @param {IPrintColumnOptions} [opts]
+ * @returns {String}
+ */
+ public printTransposed<T>(opts?: PrintColumnOptions<T>): string;
+
+ /**
+ * Sort the table
+ *
+ * @param {Function|string[]} [cmp] - Either compare function or a list of columns to sort on
+ * @returns {Table} `this`
+ */
+ public sort(cmp?: string[]): EasyTable;
+ /**
+ * Sort the table
+ *
+ * @param {Function|string[]} [cmp] - Either compare function or a list of columns to sort on
+ * @returns {Table} `this`
+ */
+ public sort<T>(cmp?: CompareFunction<T>): EasyTable;
+
+ /**
+ * Add a total for the column
+ *
+ * @param {String} col - column name
+ * @param {Object} [opts]
+ * @returns {Table} `this`
+ */
+ public total<T>(col: string, opts?: TotalOptions<T>): EasyTable;
+ /**
+ * Predefined helpers for totals
+ */
+ public static aggr: Aggregators;
+
+ /**
+ * Print the array or object
+ *
+ * @param {Array|Object} obj - Object to print
+ * @param {Function|Object} [format] - Format options
+ * @param {Function} [cb] - Table post processing and formating
+ * @returns {String}
+ */
+ public static print<T>(obj: T | T[], format?: FormatFunction<T> | FormatObject, cb?: TablePostProcessing): string;
+
+ /**
+ * Same as `Table.print()` but yields the result to `console.log()`
+ */
+ public static log<T>(obj: T | T[], format?: FormatFunction<T> | FormatObject, cb?: TablePostProcessing): void;
+ /**
+ * Same as `.toString()` but yields the result to `console.log()`
+ */
+ public log(): void;
}
- module EasyTable {
- function printArray(array: any[], cellPrinter?: CellPrinter, tablePrinter?: Printer): string;
- function printObject(object: any, cellPrinter?: CellPrinter, tablePrinter?: Printer): string;
+ type CellPrinter<T> = (val: T, width: number) => string;
+ type CompareFunction<T> = (a: T, b: T) => number;
+ type ReduceFunction<T> = (acc: T, val: T, idx: number, length: number) => T;
+ type FormatFunction<T> = (obj: T, cell: (name: string, val: any) => void) => void;
+ type TablePostProcessing = (result: EasyTable) => string;
- //printer helpers
- function Number(length: number): CellPrinter;
- function RightPadder(char: string): CellPrinter;
- function LeftPadder(char: string): CellPrinter;
+ interface PrintColumnOptions<T> {
+ /**
+ * Column separation string
+ */
+ separator?: string;
+ /**
+ * Printer to format column names
+ */
+ namePrinter?: CellPrinter<T>;
+ }
- interface CellPrinter extends Function {
- (obj: any, cell: (label: string, value: any, width?: number) => void):string;
- }
- interface Printer extends Function {
- (table: EasyTable):string;
- }
- interface Accumulator extends Function {
- (sum: number, val: number, index: number, length: number):number;
- }
+ interface Aggregators {
+ /**
+ * Create a printer which formats the value with `printer`,
+ * adds the `prefix` to it and right aligns the whole thing
+ *
+ * @param {String} prefix
+ * @param {Function} printer
+ * @returns {printer}
+ */
+ printer<T>(prefix: string, printer: CellPrinter<T>): CellPrinter<T>;
+ /**
+ * Sum reduction
+ */
+ sum: any;
+ /**
+ * Average reduction
+ */
+ avg: any;
+ }
+
+ interface TotalOptions<T> {
+ /**
+ * reduce(acc, val, idx, length) function to compute the total value
+ */
+ reduce?: ReduceFunction<T>;
+ /**
+ * Printer to format the total cell
+ */
+ printer?: CellPrinter<T>;
+ /**
+ * Initial value for reduction
+ */
+ init?: T;
+ }
+
+ interface FormatObject {
+ [key: string]: ColumnFormat<any>;
+ }
+
+ interface ColumnFormat<T> {
+ name?: string;
+ printer?: CellPrinter<T>
}
export = EasyTable;
diff --git a/electron-builder/electron-builder-tests.ts b/electron-builder/electron-builder-tests.ts
new file mode 100644
index 0000000000..d37de84c5c
--- /dev/null
+++ b/electron-builder/electron-builder-tests.ts
@@ -0,0 +1,54 @@
+/// <reference path="./electron-builder.d.ts" />
+
+import * as factory from "electron-builder";
+const builder = factory.init();
+
+function callback(err: Error) {
+ const msg = err.message;
+}
+
+builder.build({
+ appPath: ".",
+ out: "out",
+ platform: "win",
+ config: {
+ osx: {
+ title: "myapplication",
+ icon: "icon.icns",
+ "icon-size": 80,
+ background: "installer.png",
+ contents: [
+ { x: 438, y: 344, type: "link", path: "/Applications" },
+ { x: 192, y: 344, type: "file" },
+ ]
+ },
+ win: {
+ title: "myapplication",
+ icon: "icon.ico"
+ }
+ }
+}, callback);
+
+const bldr = require("electron-builder").init();
+
+bldr.build({
+ appPath: ".",
+ out: "out",
+ platform: "osx",
+ config: {
+ osx: {
+ title: "myapplication",
+ icon: "icon.icns",
+ "icon-size": 80,
+ background: "installer.png",
+ contents: [
+ { x: 438, y: 344, type: "link", path: "/Applications" },
+ { x: 192, y: 344, type: "file" },
+ ]
+ },
+ win: {
+ title: "myapplication",
+ icon: "icon.ico"
+ }
+ }
+}, callback);
diff --git a/electron-builder/electron-builder.d.ts b/electron-builder/electron-builder.d.ts
new file mode 100644
index 0000000000..560937ab4e
--- /dev/null
+++ b/electron-builder/electron-builder.d.ts
@@ -0,0 +1,90 @@
+// Type definitions for electron-builder v2.0.2
+// Project: https://github.com/loopline-systems/electron-builder
+// Definitions by: Maxime LUCE <https://github.com/SomaticIT/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare namespace ElectronBuilder {
+
+ /** Electron-builder Options. */
+ export interface Options {
+ /** Source application path. */
+ appPath: string;
+
+ /** Platforms to build. Allowed values: win, osx, all. */
+ platform: string;
+
+ /** Path or Object. Configuration for build. */
+ config: string | Config;
+
+ /** The output directory. */
+ out?: string;
+
+ }
+
+ /** Build configuration by platforms. */
+ export interface Config {
+ /** Configurations for Mac OS X. */
+ osx: {
+ /** Installer title. */
+ title: string;
+ /** Installer background. */
+ background: string;
+ /** Installer icon. */
+ icon: string;
+ /** Installer icon size. */
+ "icon-size": number;
+ /** Installer custom contents. */
+ contents: [OsxContents, OsxContents]
+ };
+
+ /** Configurations for Windows. */
+ win: {
+ /** Installer title. */
+ title: string;
+ /** Installer icon. */
+ icon: string;
+ };
+ }
+
+ /** OSX Installer custom contents. */
+ export interface OsxContents {
+ /** Horizontal position on installer screen (in pixels). */
+ x: number;
+ /** Vertical position on installer screen (in pixels). */
+ y: number;
+ /** Content type. Allowed values are "file", "link". */
+ type: string;
+ /** Link only. Customize link destination path. */
+ path?: string;
+ }
+
+ /** Electron-builder done callback. */
+ export interface Callback {
+ /**
+ * Callback wich is called when electron-builder is done.
+ * @param err - Contains errors if any.
+ */
+ (err: Error): void
+ }
+
+ /** Prototype for electron-builder. */
+ export interface Builder {
+ /**
+ * Build the installer for given platform.
+ *
+ * @param opts - Options to configure installer.
+ * @param callback - Callback which is called when building is done or an error occured.
+ */
+ build(opts: Options, callback: Callback): void;
+ }
+}
+
+declare module "electron-builder" {
+ export function init(): ElectronBuilder.Builder;
+}
+
+interface NodeRequireFunction {
+ (id: "electron-builder"): { init(): ElectronBuilder.Builder };
+}
diff --git a/electron-packager/electron-packager-tests.ts b/electron-packager/electron-packager-tests.ts
new file mode 100644
index 0000000000..00a29143a4
--- /dev/null
+++ b/electron-packager/electron-packager-tests.ts
@@ -0,0 +1,41 @@
+/// <reference path="./electron-packager.d.ts" />
+
+import * as packager from "electron-packager";
+
+function callback(err: Error, appPath: string) {
+ const
+ msg = err.message,
+ index = appPath.indexOf("test");
+}
+
+packager({
+ dir: ".",
+ name: "myapplication",
+ platform: "win32",
+ arch: "all",
+ version: "0.34.0"
+}, callback);
+
+packager({
+ dir: ".",
+ name: "myapplication",
+ version: "0.34.0",
+ all: true
+}, callback);
+
+const pkger = require("electron-packager");
+
+pkger({
+ dir: ".",
+ name: "myapplication",
+ platform: "win32",
+ arch: "all",
+ version: "0.34.0"
+}, callback);
+
+pkger({
+ dir: ".",
+ name: "myapplication",
+ version: "0.34.0",
+ all: true
+}, callback);
diff --git a/electron-packager/electron-packager.d.ts b/electron-packager/electron-packager.d.ts
new file mode 100644
index 0000000000..a25e89fc8a
--- /dev/null
+++ b/electron-packager/electron-packager.d.ts
@@ -0,0 +1,115 @@
+// Type definitions for electron-packager v5.1.0
+// Project: https://github.com/maxogden/electron-packager
+// Definitions by: Maxime LUCE <https://github.com/SomaticIT/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare namespace ElectronPackager {
+ /** Electron-packager Options. */
+ export interface Options {
+ /** The source directory. */
+ dir: string;
+ /** The application name. */
+ name: string;
+ /**
+ * Allowed values: linux, win32, darwin, all. Not required if `all` is used.
+ * Arbitrary combinations of individual platforms are also supported via a comma-delimited string or array of strings.
+ */
+ platform?: string | string[];
+ /** Allowed values: ia32, x64, all Not required if `all` is used. */
+ arch?: string;
+ /** Electron version (without the "v"). See https://github.com/atom/electron/releases. */
+ version: string;
+
+ /** Shortcut for `--arch=all --platform=all`. */
+ all?: boolean;
+ /** The output directory. */
+ out?: string;
+ /**
+ * Currently you must look for conversion tools in order to supply an icon in the format required by the platform:
+ * - OS X: `.icns`
+ * - Windows: `.ico`
+ *
+ * For Linux builds, this option is not required, as the dock/window list icon is set via the icon option in the BrowserWindow contructor.
+ * Setting the icon in the file manager is not currently supported.
+ *
+ * If the file extension is omitted, it is auto-completed to the correct extension based on the platform,
+ * including when `--platform=all` is in effect.
+ */
+ icon?: string;
+
+ /** The bundle identifier to use in the app plist. */
+ "app-bundle-id"?: string;
+ /** The release version to set for the app. */
+ "app-version"?: string;
+ /** The build version to set for the app (OS X only). */
+ "build-version"?: string;
+ /** The bundle identifier to use in the app helper plist. */
+ "helper-bundle-id"?: string;
+ /** Object hash of application metadata to embed into the executable (Windows only). */
+ "version-string"?: VersionString;
+
+ /** The directory of cached electron downloads. Defaults to "$HOME/.electron". */
+ cache?: string;
+ /** Do not copy files into App whose filenames regex .match this string. */
+ ignore?: RegExp;
+ /** Runs `npm prune --production` on the app. */
+ prune?: boolean;
+ /** If output directory for a platform already exists, replaces it rather than skipping it. */
+ overwrite?: boolean;
+ /** Packages the source code within your app into an archive. */
+ asar?: boolean;
+ /** Unpacks the files to app.asar.unpacked directory whose filenames regex .match this string. */
+ "asar-unpack"?: string;
+ /** Should contain the identity to be used when running `codesign` (OS X only). */
+ sign?: string;
+ }
+
+ /** Object hash of application metadata to embed into the executable (Windows only). */
+ export interface VersionString {
+ CompanyName?: string;
+ LegalCopyright?: string;
+ FileDescription?: string;
+ OriginalFilename?: string;
+ FileVersion?: string;
+ ProductVersion?: string;
+ ProductName?: string;
+ InternalName?: string;
+ }
+
+ /** Electron-packager done callback. */
+ export interface Callback {
+ /**
+ * Callback wich is called when electron-packager is done.
+ *
+ * @param err - Contains errors if any.
+ * @param appPath - Path to the newly created application.
+ */
+ (err: Error, appPath: string): void
+ }
+
+ /** Electron-packager function */
+ export interface Packager {
+ /**
+ * This will:
+ * - Find or download the correct release of Electron
+ * - Use that version of electron to create a app in <out>/<appname>-<platform>-<arch>
+ *
+ * You should be able to launch the app on the platform you built for. If not, check your settings and try again.
+ *
+ * @param opts - Options to configure packaging.
+ * @param callback - Callback which is called when packaging is done or an error occured.
+ */
+ (opts: Options, callback: Callback): void;
+ }
+}
+
+declare module "electron-packager" {
+ const packager: ElectronPackager.Packager;
+ export = packager;
+}
+
+interface NodeRequireFunction {
+ (id: "electron-packager"): ElectronPackager.Packager;
+}
diff --git a/eventemitter3/eventemitter3-test.ts b/eventemitter3/eventemitter3-tests.ts
similarity index 97%
rename from eventemitter3/eventemitter3-test.ts
rename to eventemitter3/eventemitter3-tests.ts
index 05138ab34e..da13434135 100644
--- a/eventemitter3/eventemitter3-test.ts
+++ b/eventemitter3/eventemitter3-tests.ts
@@ -5,18 +5,18 @@ import EventEmitter = require('eventemitter3');
class EventEmitterTest {
v: EventEmitter;
-
+
constructor() {
this.v = new EventEmitter();
this.v = new EventEmitter.EventEmitter();
this.v = new EventEmitter.EventEmitter2();
this.v = new EventEmitter.EventEmitter3();
}
-
+
listeners() {
var v1: Function[] = this.v.listeners('click');
}
-
+
emit() {
var v1: boolean = this.v.emit('click');
var v2: boolean = this.v.emit('click', 1);
@@ -24,41 +24,41 @@ class EventEmitterTest {
var v4: boolean = this.v.emit('click', 1, '1', true);
var v5: boolean = this.v.emit('click', 1, '1', true, new Date());
}
-
+
on() {
var fn = () => console.log(1);
var v1: EventEmitter = this.v.on('click', fn);
var v2: EventEmitter = this.v.on('click', fn, this);
}
-
+
once() {
var fn = () => console.log(1);
var v1: EventEmitter = this.v.once('click', fn);
var v2: EventEmitter = this.v.once('click', fn, this);
}
-
+
removeListener() {
var fn = () => console.log(1);
var v1: EventEmitter = this.v.removeListener('click', fn);
var v2: EventEmitter = this.v.removeListener('click', fn, true);
}
-
+
removeAllListeners() {
var v1: EventEmitter = this.v.removeAllListeners('click');
}
-
+
off() {
var fn = () => console.log(1);
var v1: EventEmitter = this.v.off('click', fn);
var v2: EventEmitter = this.v.off('click', fn, true);
}
-
+
addListener() {
var fn = () => console.log(1);
var v1: EventEmitter = this.v.addListener('click', fn);
var v2: EventEmitter = this.v.addListener('click', fn, this);
}
-
+
setMaxListeners() {
var v1: EventEmitter = this.v.setMaxListeners();
}
diff --git a/express-handlebars/express-handlebars-tests.ts b/express-handlebars/express-handlebars-tests.ts
new file mode 100644
index 0000000000..3fa6ef31da
--- /dev/null
+++ b/express-handlebars/express-handlebars-tests.ts
@@ -0,0 +1,17 @@
+/// <reference path="../node/node.d.ts" />
+/// <reference path="../express/express.d.ts" />
+/// <reference path="express-handlebars.d.ts" />
+
+import express = require('express');
+import exphbs = require('express-handlebars');
+
+var app = express();
+var hbs: Exphbs = exphbs.create({defaultLayout: 'main'});
+
+app.engine('handlebars', hbs.engine);
+app.set('view engine', 'handlebars');
+
+app.listen(1337);
+console.log('Test Express Handlebars app on port 1337..');
+console.log('Done');
+process.exit(0);
diff --git a/express-handlebars/express-handlebars.d.ts b/express-handlebars/express-handlebars.d.ts
new file mode 100644
index 0000000000..6ed538c210
--- /dev/null
+++ b/express-handlebars/express-handlebars.d.ts
@@ -0,0 +1,46 @@
+// Type definitions for express-handlebars
+// Project: https://github.com/ericf/express-handlebars
+// Definitions by: Sam Saint-Pettersen <https://github.com/stpettersens>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../es6-promise/es6-promise.d.ts" />
+
+interface PartialTemplateOptions {
+ cache?: boolean;
+ precompiled?: boolean;
+}
+
+interface RenderOptions {
+ cache?: boolean;
+ data?: Object;
+ helpers?: any;
+ partials?: any;
+}
+
+interface ExphbsOptions {
+ handlebars?: any;
+ extname?: string;
+ layoutsDir?: string;
+ partialsDir?: string;
+ defaultLayout?: string;
+ helpers?: any;
+ compilerOptions?: any;
+}
+
+interface Exphbs {
+ engine: Function;
+ extname: string;
+ compiled: Object;
+ precompiled: Object;
+ create(options?: ExphbsOptions): Exphbs;
+ getPartials(options?: PartialTemplateOptions): Promise<Object>;
+ getTemplate(filePath: string, options?: PartialTemplateOptions): Promise<Function>;
+ getTemplates(dirPath: string, options?: PartialTemplateOptions): Promise<Object>;
+ render(filePath: string, context: Object, options?: RenderOptions): Promise<string>;
+ renderView(viewPath: string, optionsOrCallback: any, callback?: () => string): void;
+}
+
+declare module "express-handlebars" {
+ var exphbs: Exphbs;
+ export = exphbs;
+}
diff --git a/express/express.d.ts b/express/express.d.ts
index e2f6d5df21..523f8f7c6f 100644
--- a/express/express.d.ts
+++ b/express/express.d.ts
@@ -108,6 +108,8 @@ declare module "express" {
use(path: string, handler: ErrorRequestHandler): T;
use(path: string[], ...handler: RequestHandler[]): T;
use(path: string[], handler: ErrorRequestHandler): T;
+ use(path: RegExp, ...handler: RequestHandler[]): T;
+ use(path: RegExp, handler: ErrorRequestHandler): T;
}
export function Router(options?: any): Router;
diff --git a/fabricjs/fabricjs.d.ts.tscparams b/fabricjs/fabricjs.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/fabricjs/fabricjs.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/faker/faker.d.ts b/faker/faker.d.ts
index 6397dd9933..01ce203ea6 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/fbsdk/fbsdk.d.ts b/fbsdk/fbsdk.d.ts
index 3c1261d7cf..2be6f513a1 100644
--- a/fbsdk/fbsdk.d.ts
+++ b/fbsdk/fbsdk.d.ts
@@ -35,7 +35,7 @@ interface RequestsDialogParams {
message: string;
action_type?: string; // "send" | "askfor" | "turn"
object_id?: string;
- filters: string /* "app_users" | "app_non_users" */ | {
+ filters: string /* "app_users" | "app_non_users" */ | {
name: string;
user_ids: string[];
};
diff --git a/finalhandler/finalhandler-tests.ts b/finalhandler/finalhandler-tests.ts
new file mode 100644
index 0000000000..cb8dc053d1
--- /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 0000000000..37e9317180
--- /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/fixed-data-table/fixed-data-table-tests.tsx b/fixed-data-table/fixed-data-table-tests.tsx
new file mode 100644
index 0000000000..9265186fbd
--- /dev/null
+++ b/fixed-data-table/fixed-data-table-tests.tsx
@@ -0,0 +1,37 @@
+///<reference path="./fixed-data-table.d.ts"" />
+/// <reference path="../react/react.d.ts"/>
+
+import * as React from "react";
+import * as FixedDataTable from "fixed-data-table";
+
+var rows = [
+ ['a1', 'b1', 'c1'],
+ ['a2', 'b2', 'c2'],
+ ['a3', 'b3', 'c3'],
+ // .... and more
+];
+
+function rowGetter(rowIndex: number) {
+ return rows[rowIndex];
+}
+
+ var table = <FixedDataTable.Table
+ rowHeight={50}
+ rowGetter={rowGetter}
+ rowsCount={rows.length}
+ width={5000}
+ height={5000}
+ headerHeight={50}>
+ <FixedDataTable.Column
+ label="Col 1"
+ width={3000}
+ dataKey={0}
+ />
+ <FixedDataTable.Column
+ label="Col 2"
+ width={2000}
+ dataKey={1}
+ />
+ </FixedDataTable.Table>
+
+React.render(table, document.body);
diff --git a/fixed-data-table/fixed-data-table.d.ts b/fixed-data-table/fixed-data-table.d.ts
new file mode 100644
index 0000000000..1dc22dc3de
--- /dev/null
+++ b/fixed-data-table/fixed-data-table.d.ts
@@ -0,0 +1,402 @@
+// Type definitions for fixed-data-table 0.4.7
+// Project: https://github.com/facebook/fixed-data-table
+// Definitions by: Petar Paar <https://github.com/pepaar>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../react/react.d.ts"/>
+
+declare module FixedDataTable {
+ export var version: string;
+
+ export interface TableProps extends __React.Props<Table> {
+ /**
+ * Pixel width of table. If all columns do not fit,
+ * a horizontal scrollbar will appear.
+ */
+ width: number;
+
+ /**
+ * Pixel height of table. If all rows do not fit,
+ * a vertical scrollbar will appear.
+ *
+ * Either `height` or `maxHeight` must be specified.
+ */
+ height?: number;
+
+ /**
+ * Maximum pixel height of table. If all rows do not fit,
+ * a vertical scrollbar will appear.
+ *
+ * Either `height` or `maxHeight` must be specified.
+ */
+ maxHeight?: number;
+
+ /**
+ * Pixel height of table's owner, this is used in a managed scrolling
+ * situation when you want to slide the table up from below the fold
+ * without having to constantly update the height on every scroll tick.
+ * Instead, vary this property on scroll. By using `ownerHeight`, we
+ * over-render the table while making sure the footer and horizontal
+ * scrollbar of the table are visible when the current space for the table
+ * in view is smaller than the final, over-flowing height of table. It
+ * allows us to avoid resizing and reflowing table when it is moving in the
+ * view.
+ *
+ * This is used if `ownerHeight < height` (or `maxHeight`).
+ */
+ ownerHeight?: number;
+
+ /**
+ * hidden or auto
+ */
+ overflowX?: string;
+ overflowY?: string;
+
+ /**
+ * Number of rows in the table.
+ */
+ rowsCount: number;
+
+ /**
+ * Pixel height of rows unless `rowHeightGetter` is specified and returns
+ * different value.
+ */
+ rowHeight: number;
+
+ /**
+ * If specified, `rowHeightGetter(index)` is called for each row and the
+ * returned value overrides `rowHeight` for particular row.
+ */
+ rowHeightGetter?: Function;
+
+ /**
+ * To get rows to display in table, `rowGetter(index)`
+ * is called. `rowGetter` should be smart enough to handle async
+ * fetching of data and return temporary objects
+ * while data is being fetched.
+ */
+ rowGetter: Function;
+
+ /**
+ * To get any additional CSS classes that should be added to a row,
+ * `rowClassNameGetter(index)` is called.
+ */
+ rowClassNameGetter?: Function;
+
+ /**
+ * Pixel height of the column group header.
+ */
+ groupHeaderHeight?: number;
+
+ /**
+ * Pixel height of header.
+ */
+ headerHeight: number;
+
+ /**
+ * Function that is called to get the data for the header row.
+ * If the function returns null, the header will be set to the
+ * Column's label property.
+ */
+ headerDataGetter?: Function;
+
+ /**
+ * Pixel height of footer.
+ */
+ footerHeight?: number;
+
+ /**
+ * DEPRECATED - use footerDataGetter instead.
+ * Data that will be passed to footer cell renderers.
+ */
+ footerData?: any;
+
+ /**
+ * Function that is called to get the data for the footer row.
+ */
+ footerDataGetter?: Function;
+
+ /**
+ * Value of horizontal scroll.
+ */
+ scrollLeft?: number;
+
+ /**
+ * Index of column to scroll to.
+ */
+ scrollToColumn?: number;
+
+ /**
+ * Value of vertical scroll.
+ */
+ scrollTop?: number;
+
+ /**
+ * Index of row to scroll to.
+ */
+ scrollToRow?: number;
+
+ /**
+ * Callback that is called when scrolling starts with current horizontal
+ * and vertical scroll values.
+ */
+ onScrollStart?: Function;
+
+ /**
+ * Callback that is called when scrolling ends or stops with new horizontal
+ * and vertical scroll values.
+ */
+ onScrollEnd?: Function;
+
+ /**
+ * Callback that is called when `rowHeightGetter` returns a different height
+ * for a row than the `rowHeight` prop. This is necessary because initially
+ * table estimates heights of some parts of the content.
+ */
+ onContentHeightChange?: Function;
+
+ /**
+ * Callback that is called when a row is clicked.
+ */
+ onRowClick?: Function;
+
+ /**
+ * Callback that is called when a row is double clicked.
+ */
+ onRowDoubleClick?: Function;
+
+ /**
+ * Callback that is called when a mouse-down event happens on a row.
+ */
+ onRowMouseDown?: Function;
+
+ /**
+ * Callback that is called when a mouse-enter event happens on a row.
+ */
+ onRowMouseEnter?: Function;
+
+ /**
+ * Callback that is called when a mouse-leave event happens on a row.
+ */
+ onRowMouseLeave?: Function;
+
+ /**
+ * Callback that is called when resizer has been released
+ * and column needs to be updated.
+ *
+ * Required if the isResizable property is true on any column.
+ *
+ * ```
+ * function(
+ * newColumnWidth: number,
+ * dataKey: string,
+ * )
+ * ```
+ */
+ onColumnResizeEndCallback?: Function;
+
+ /**
+ * Whether a column is currently being resized.
+ */
+ isColumnResizing?: boolean
+ }
+
+ interface ColumnProps {
+ /**
+ * The horizontal alignment of the table cell content.
+ * 'left', 'center', 'right'
+ */
+ align?: string;
+
+ /**
+ * className for this column's header cell.
+ */
+ headerClassName?: string;
+
+ /**
+ * className for this column's footer cell.
+ */
+ footerClassName?: string;
+
+ /**
+ * className for each of this column's data cells.
+ */
+ cellClassName?: string;
+
+ /**
+ * The cell renderer that returns React-renderable content for table cell.
+ * ```
+ * function(
+ * cellData: any,
+ * cellDataKey: string,
+ * rowData: object,
+ * rowIndex: number,
+ * columnData: any,
+ * width: number
+ * ): ?$jsx
+ * ```
+ */
+ cellRenderer?: Function;
+
+ /**
+ * The getter `function(string_cellDataKey, object_rowData)` that returns
+ * the cell data for the `cellRenderer`.
+ * If not provided, the cell data will be collected from
+ * `rowData[cellDataKey]` instead. The value that `cellDataGetter` returns
+ * will be used to determine whether the cell should re-render.
+ */
+ cellDataGetter?: Function;
+
+ /**
+ * The key to retrieve the cell data from the data row. Provided key type
+ * must be either `string` or `number`. Since we use this
+ * for keys, it must be specified for each column.
+ */
+ dataKey: string|number;
+
+ /**
+ * Controls if the column is fixed when scrolling in the X axis.
+ */
+ fixed?: boolean;
+
+ /**
+ * The cell renderer that returns React-renderable content for table column
+ * header.
+ * ```
+ * function(
+ * label: ?string,
+ * cellDataKey: string,
+ * columnData: any,
+ * rowData: array<?object>,
+ * width: number
+ * ): ?$jsx
+ * ```
+ */
+ headerRenderer?: Function;
+
+ /**
+ * The cell renderer that returns React-renderable content for table column
+ * footer.
+ * ```
+ * function(
+ * label: ?string,
+ * cellDataKey: string,
+ * columnData: any,
+ * rowData: array<?object>,
+ * width: number
+ * ): ?$jsx
+ * ```
+ */
+ footerRenderer?: Function;
+
+ /**
+ * Bucket for any data to be passed into column renderer functions.
+ */
+ columnData?: any;
+
+ /**
+ * The column's header label.
+ */
+ label: string;
+
+ /**
+ * The pixel width of the column.
+ */
+ width: number;
+
+ /**
+ * If this is a resizable column this is its minimum pixel width.
+ */
+ minWidth?: number;
+
+ /**
+ * If this is a resizable column this is its maximum pixel width.
+ */
+ maxWidth?: number;
+
+ /**
+ * The grow factor relative to other columns. Same as the flex-grow API
+ * from http://www.w3.org/TR/css3-flexbox/. Basically, take any available
+ * extra width and distribute it proportionally according to all columns'
+ * flexGrow values. Defaults to zero (no-flexing).
+ */
+ flexGrow?: number;
+
+ /**
+ * Whether the column can be resized with the
+ * FixedDataTableColumnResizeHandle. Please note that if a column
+ * has a flex grow, once you resize the column this will be set to 0.
+ *
+ * This property only provides the UI for the column resizing. If this
+ * is set to true, you will need ot se the onColumnResizeEndCallback table
+ * property and render your columns appropriately.
+ */
+ isResizable?: boolean;
+
+ /**
+ * Experimental feature
+ * Whether cells in this column can be removed from document when outside
+ * of viewport as a result of horizontal scrolling.
+ * Setting this property to true allows the table to not render cells in
+ * particular column that are outside of viewport for visible rows. This
+ * allows to create table with many columns and not have vertical scrolling
+ * performance drop.
+ * Setting the property to false will keep previous behaviour and keep
+ * cell rendered if the row it belongs to is visible.
+ */
+ allowCellsRecycling?: boolean;
+ }
+
+ export interface ColumnGroupProps {
+ /**
+ * The horizontal alignment of the table cell content.
+ * 'left', 'center', 'right'
+ */
+ align?: string;
+
+ /**
+ * Controls if the column group is fixed when scrolling in the X axis.
+ */
+ fixed?: boolean;
+
+ /**
+ * Bucket for any data to be passed into column group renderer functions.
+ */
+ columnGroupData?: any;
+
+ /**
+ * The column group's header label.
+ */
+ label?: string;
+
+ /**
+ * The cell renderer that returns React-renderable content for a table
+ * column group header. If it's not specified, the label from props will
+ * be rendered as header content.
+ * ```
+ * function(
+ * label: ?string,
+ * cellDataKey: string,
+ * columnGroupData: any,
+ * rowData: array<?object>, // array of labels of all columnGroups
+ * width: number
+ * ): ?$jsx
+ * ```
+ */
+ groupHeaderRenderer?: Function;
+ }
+
+ export class Table extends __React.Component<TableProps, {}> {
+ render(): __React.DOMElement<any>
+ }
+ export class Column extends __React.Component<ColumnProps, {}> {
+ render(): __React.DOMElement<any>
+ }
+ export class ColumnGroup extends __React.Component<ColumnGroupProps, {}> {
+ render(): __React.DOMElement<any>
+ }
+}
+
+declare module "fixed-data-table" {
+ export = FixedDataTable;
+}
\ No newline at end of file
diff --git a/flat/flat-tests.ts b/flat/flat-tests.ts
new file mode 100644
index 0000000000..b6909cdb1a
--- /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 0000000000..f3698f1250
--- /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/fluxxor/fluxxor-test.ts b/fluxxor/fluxxor-tests.ts
similarity index 96%
rename from fluxxor/fluxxor-test.ts
rename to fluxxor/fluxxor-tests.ts
index 87e978248e..7d8c5c948d 100644
--- a/fluxxor/fluxxor-test.ts
+++ b/fluxxor/fluxxor-tests.ts
@@ -5,27 +5,27 @@ import Fluxxor = require('fluxxor');
class DispatcherTest {
v: Fluxxor.Dispatcher;
-
+
constructor() {
var stores: Fluxxor.Store[];
this.v = new Fluxxor.Dispatcher(stores);
}
-
+
addStore() {
var store: Fluxxor.Store;
var v1: void = this.v.addStore('mystore', store);
}
-
+
dispatch() {
var fn = () => console.log(1);
var v1: void = this.v.dispatch(fn);
}
-
+
doDispatchLoop() {
var fn = () => console.log(1);
var v1: void = this.v.doDispatchLoop(fn);
}
-
+
waitForStores() {
var store: Fluxxor.Store;
var fn = () => console.log(1);
@@ -35,44 +35,44 @@ class DispatcherTest {
class FluxTest {
v: Fluxxor.Flux;
-
+
constructor() {
var stores: any;
var actions: any;
this.v = new Fluxxor.Flux(stores, actions);
}
-
+
props() {
var stores: any = this.v.stores;
var actions: any = this.v.actions;
}
-
+
addActions() {
var actions: any;
var v1: void = this.v.addActions(actions);
}
-
+
addAction() {
var fn = () => console.log(1);
-
+
// first form
var v1: void = this.v.addAction('action1', fn);
var v2: void = this.v.addAction('action1', 'action2', fn);
-
+
// second form
var v3: void = this.v.addAction(['action1'], fn);
var v4: void = this.v.addAction(['action1','action2'], fn);
}
-
+
store() {
var store1: any = this.v.store('mystore');
}
-
+
addStore() {
var store: Fluxxor.Store;
var v1: void = this.v.addStore('mystore', store);
}
-
+
addStores() {
var stores: any;
var v1: void = this.v.addStores(stores);
@@ -81,24 +81,24 @@ class FluxTest {
class StoreTest {
v: Fluxxor.Store;
-
+
bindActions() {
var fn = () => console.log(1);
-
+
// first form
var v1: void = this.v.bindActions('action1', fn);
var v2: void = this.v.bindActions(
'action1', fn,
'action2', fn
);
-
+
// second form
var v3: void = this.v.bindActions([
'action1', fn,
'action2', fn,
]);
}
-
+
waitFor() {
var fn = () => console.log(1);
var v1: void = this.v.waitFor(['mystore1','mystore2'], fn);
@@ -107,7 +107,7 @@ class StoreTest {
class ContextTest {
v: Fluxxor.Context;
-
+
props() {
var v1: Fluxxor.Flux = this.v.flux;
}
@@ -115,11 +115,11 @@ class ContextTest {
class FluxMixinTest {
v: Fluxxor.FluxMixin;
-
+
constructor() {
this.v = Fluxxor.FluxMixin(React);
}
-
+
getFlux() {
var v1: Fluxxor.Flux = this.v.getFlux();
}
@@ -127,11 +127,11 @@ class FluxMixinTest {
class FluxChildMixinTest {
v: Fluxxor.FluxChildMixin;
-
+
constructor() {
this.v = Fluxxor.FluxChildMixin(React);
}
-
+
getFlux() {
var v1: Fluxxor.Flux = this.v.getFlux();
}
@@ -139,13 +139,13 @@ class FluxChildMixinTest {
class StoreWatchMixinTest<StoreState> {
v: Fluxxor.StoreWatchMixin<StoreState>;
-
+
constructor() {
this.v = Fluxxor.StoreWatchMixin<StoreState>('store1');
this.v = Fluxxor.StoreWatchMixin<StoreState>('store1','store2');
this.v = Fluxxor.StoreWatchMixin<StoreState>('store1','store2','store3');
}
-
+
getStateFromFlux() {
var v1: StoreState = this.v.getStateFromFlux();
}
diff --git a/forge-di/forge-di-test.ts b/forge-di/forge-di-tests.ts
similarity index 100%
rename from forge-di/forge-di-test.ts
rename to forge-di/forge-di-tests.ts
diff --git a/freedom/freedom.d.ts b/freedom/freedom.d.ts
index f012c9deab..fa80a530c3 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/github-electron/github-electron-main-tests.ts b/github-electron/github-electron-main-tests.ts
index 4e359e257b..3bce8390ef 100644
--- a/github-electron/github-electron-main-tests.ts
+++ b/github-electron/github-electron-main-tests.ts
@@ -35,6 +35,21 @@ app.on('window-all-closed', () => {
app.quit();
});
+// Check single instance app
+var shouldQuit = app.makeSingleInstance(function(commandLine, workingDirectory) {
+ // Someone tried to run a second instance, we should focus our window
+ if (mainWindow) {
+ if (mainWindow.isMinimized()) mainWindow.restore();
+ mainWindow.focus();
+ }
+ return true;
+});
+
+if (shouldQuit) {
+ app.quit();
+ process.exit(0);
+}
+
// This method will be called when Electron has done everything
// initialization and ready for creating browser windows.
app.on('ready', () => {
@@ -145,7 +160,11 @@ ipc.on('online-status-changed', (event: any, status: any) => {
// https://github.com/atom/electron/blob/master/docs/api/synopsis.md
app.on('ready', () => {
- window = new BrowserWindow({ width: 800, height: 600 });
+ window = new BrowserWindow({
+ width: 800,
+ height: 600,
+ 'title-bar-style': 'hidden-inset',
+ });
window.loadUrl('https://github.com');
});
diff --git a/github-electron/github-electron.d.ts b/github-electron/github-electron.d.ts
index 92fff65f71..fee13c29f6 100644
--- a/github-electron/github-electron.d.ts
+++ b/github-electron/github-electron.d.ts
@@ -515,6 +515,7 @@ declare module GitHubElectron {
'shared-worker'?: boolean;
'direct-write'?: boolean;
'page-visibility'?: boolean;
+ 'title-bar-style'?: string;
}
interface Rectangle {
@@ -986,6 +987,12 @@ declare module GitHubElectron {
setUserTasks(tasks: Task[]): void;
dock: BrowserWindow;
commandLine: CommandLine;
+ /**
+ * This method makes your application a Single Instance Application instead of allowing
+ * multiple instances of your app to run, this will ensure that only a single instance
+ * of your app is running, and other instances signal this instance and exit.
+ */
+ makeSingleInstance(callback: (args: string[], workingDirectory: string) => boolean): boolean;
}
interface CommandLine {
diff --git a/glob-expand/glob-expand-tests.ts b/glob-expand/glob-expand-tests.ts
new file mode 100644
index 0000000000..fc17e5fea9
--- /dev/null
+++ b/glob-expand/glob-expand-tests.ts
@@ -0,0 +1,22 @@
+/// <reference path="./glob-expand.d.ts" />
+
+import * as expand from "glob-expand";
+
+expand({ filter: 'isFile', cwd: '../' }, ['**/*.*', '!exclude/these/**/*.*']);
+// returns all files in cwd ['file1', 'file2',...] but excluding
+// those under directory 'exclude/these'
+
+// These are the same
+expand({ cwd: '../..' }, ['**/*.*', '!node_modules/**/*.*']);
+expand({ cwd: '../..' }, '**/*.*', '!node_modules/**/*.*');
+
+// These are the same too:
+expand({}, ['**/*.*', '!**/*.js']);
+expand({}, '**/*.*', '!**/*.js');
+expand(['**/*.*', '!**/*.js']);
+expand('**/*.*', '!**/*.js');
+
+// Using Regular Expressions:
+expand('**/*.js', /.*\.(coffee\.md|litcoffee|coffee)$/i, '!DRAFT*.*');
+// -> returns all `.js`, `.coffee`, `.coffee.md` & `.litcoffee` files,
+// excluding those starting with 'DRAFT'
diff --git a/glob-expand/glob-expand.d.ts b/glob-expand/glob-expand.d.ts
new file mode 100644
index 0000000000..0e12582799
--- /dev/null
+++ b/glob-expand/glob-expand.d.ts
@@ -0,0 +1,27 @@
+// Type definitions for glob-expand
+// Project: https://github.com/anodynos/node-glob-expand
+// Definitions by: vvakame <https://github.com/vvakame/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../glob/glob.d.ts" />
+
+declare module "glob-expand" {
+ import * as _glob from "glob";
+
+ interface Option {
+ filter?: string | ((filePath: string) => boolean);
+ cwd?: string;
+ }
+
+ module expand {
+ var glob: typeof _glob;
+ var VERSION: string;
+ }
+
+ function expand(opts: Option, patterns: (string | RegExp)[]): string[];
+ function expand(opts: Option, ...patterns: (string | RegExp)[]): string[];
+ function expand(patterns: (string | RegExp)[]): string[];
+ function expand(...patterns: (string | RegExp)[]): string[];
+
+ export = expand;
+}
diff --git a/googlemaps/google.maps.d.ts b/googlemaps/google.maps.d.ts
index 6849ea1d47..2093f2fd9c 100644
--- a/googlemaps/google.maps.d.ts
+++ b/googlemaps/google.maps.d.ts
@@ -822,6 +822,7 @@ declare module google.maps {
bounds?: LatLngBounds;
componentRestrictions?: GeocoderComponentRestrictions;
location?: LatLng|LatLngLiteral;
+ placeId?: string;
region?: string;
}
diff --git a/gridstack/gridstack-tests.ts b/gridstack/gridstack-tests.ts
index b3167ea5d6..9d04d037c0 100644
--- a/gridstack/gridstack-tests.ts
+++ b/gridstack/gridstack-tests.ts
@@ -1,20 +1,20 @@
-/// <reference path="../jquery/jquery.d.ts"/>
-/// <reference path="gridstack.d.ts" />
-
-
-// Type definitions for Gridstack
-// Project: http://troolee.github.io/gridstack.js/
-// Definitions by: Pascal Senn <https://github.com/PascalSenn/>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-var options = <IGridstackOptions> {
- float: true
-};
-var gridstack:GridStack = $(document).gridstack(options);
-
-gridstack.add_widget("test", 1, 2, 3, 4, true);
-gridstack.batch_update();
-gridstack.cell_height();;
-gridstack.cell_height(2);
-gridstack.cell_width();
-gridstack.get_cell_from_pixel(<MousePosition>{ left:20, top: 20 });
+/// <reference path="../jquery/jquery.d.ts"/>
+/// <reference path="gridstack.d.ts" />
+
+
+// Type definitions for Gridstack
+// Project: http://troolee.github.io/gridstack.js/
+// Definitions by: Pascal Senn <https://github.com/PascalSenn/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+var options = <IGridstackOptions> {
+ float: true
+};
+var gridstack:GridStack = $(document).gridstack(options);
+
+gridstack.add_widget("test", 1, 2, 3, 4, true);
+gridstack.batch_update();
+gridstack.cell_height();;
+gridstack.cell_height(2);
+gridstack.cell_width();
+gridstack.get_cell_from_pixel(<MousePosition>{ left:20, top: 20 });
diff --git a/gridstack/gridstack.d.ts b/gridstack/gridstack.d.ts
index 4bb3794830..6ad3d862e3 100644
--- a/gridstack/gridstack.d.ts
+++ b/gridstack/gridstack.d.ts
@@ -1,241 +1,241 @@
-// Type definitions for Gridstack
-// Project: http://troolee.github.io/gridstack.js/
-// Definitions by: Pascal Senn <https://github.com/PascalSenn/>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-interface JQuery {
- gridstack (options: IGridstackOptions):GridStack
-}
-
-interface GridStack {
- /**
- * Creates new widget and returns it.
- *
- * Widget will be always placed even if result height is more than actual grid height. You need to use will_it_fit method before calling add_widget for additional check.
- *
- * @param {string} el widget to add
- * @param {number} x widget position x
- * @param {number} y widget position y
- * @param {number} width widget dimension width
- * @param {number} height widget dimension height
- * @param {boolean} auto_position if true then x, y parameters will be ignored and widget will be places on the first available position
- */
- add_widget(el: string, x: number, y: number, width: number, height: number, auto_position: boolean): JQuery
- /**
- * Initializes batch updates. You will see no changes until commit method is called.
- */
- batch_update():void
- /**
- * Gets current cell height.
- */
- cell_height():number
- /**
- * Update current cell height. This method rebuilds an internal CSS style sheet. Note: You can expect performance issues if call this method too often.
- * @param {number} val the cell height
- */
- cell_height(val:number):void
- /**
- * Gets current cell width.
- */
- cell_width():number
- /**
- * Finishes batch updates. Updates DOM nodes. You must call it after batch_update.
- */
- commit():void
- /**
- * Destroys a grid instance.
- */
- destroy(): void
- /*
- * Disables widgets moving/resizing.
- */
- disable(): void
- /*
- * Enables widgets moving/resizing.
- */
- enable(): void
- /*
- * Get the position of the cell under a pixel on screen.
- * @param {MousePosition} position the position of the pixel to resolve in absolute coordinates, as an object with top and leftproperties
- */
- get_cell_from_pixel(position: MousePosition): CellPosition,
- /*
- * Checks if specified area is empty.
- * @param {number} x the position x.
- * @param {number} y the position y.
- * @param {number} width the width of to check
- * @param {number} height the height of to check
- */
- is_area_empty(x: number, y: number, width: number, height: number): void
- /*
- * Locks/unlocks widget.
- * @param {HTMLElement} el widget to modify.
- * @param {boolean} val if true widget will be locked.
- */
- locked(el: HTMLElement, val: boolean): void
- /*
- * Set the minWidth for a widget.
- * @param {HTMLElement} el widget to modify.
- * @param {number} val A numeric value of the number of columns
- */
- min_width(el: HTMLElement, val: number): void
- /*
- * Set the minHeight for a widget.
- * @param {HTMLElement} el widget to modify.
- * @param {number} val A numeric value of the number of rows
- */
- min_height(el: HTMLElement, val: number): void
- /*
- * Enables/Disables moving.
- * @param {HTMLElement} el widget to modify.
- * @param {number} val if true widget will be draggable.
- */
- movable(el: HTMLElement, val: boolean): void
- /**
- * Changes widget position
- * @param {HTMLElement} el widget to modify
- * @param {number} x new position x. If value is null or undefined it will be ignored.
- * @param {number} y new position y. If value is null or undefined it will be ignored.
- *
- */
- move(el: HTMLElement, x: number, y: number): void
- /**
- * Removes widget from the grid.
- * @param {HTMLElement} el widget to modify
- * @param {boolean} detach_node if false DOM node won't be removed from the tree (Optional. Default true).
- */
- remove_widget(el: HTMLElement, detach_node?: boolean): void
- /**
- * Removes all widgets from the grid.
- */
- remove_all(): void
- /**
- * Changes widget size
- * @param {HTMLElement} el widget to modify
- * @param {number} width new dimensions width. If value is null or undefined it will be ignored.
- * @param {number} height new dimensions height. If value is null or undefined it will be ignored.
- */
- resize(el: HTMLElement, width: number, height: number): void
- /**
- * Enables/Disables resizing.
- * @param {HTMLElement} el widget to modify
- * @param {boolean} val if true widget will be resizable.
- */
- resizable(el: HTMLElement, val: boolean): void
- /**
- * Toggle the grid static state. Also toggle the grid-stack-static class.
- * @param {boolean} static_value if true the grid become static.
- */
- set_static(static_value: boolean): void
- /**
- * Updates widget position/size.
- * @param {HTMLElement} el widget to modify
- * @param {number} x new position x. If value is null or undefined it will be ignored.
- * @param {number} y new position y. If value is null or undefined it will be ignored.
- * @param {number} width new dimensions width. If value is null or undefined it will be ignored.
- * @param {number} height new dimensions height. If value is null or undefined it will be ignored.
- */
- update(el: HTMLElement, x: number, y: number, width: number, height: number): void
- /**
- * Returns true if the height of the grid will be less the vertical constraint. Always returns true if grid doesn't have height constraint.
- * @param {number} x new position x. If value is null or undefined it will be ignored.
- * @param {number} y new position y. If value is null or undefined it will be ignored.
- * @param {number} width new dimensions width. If value is null or undefined it will be ignored.
- * @param {number} height new dimensions height. If value is null or undefined it will be ignored.
- * @param {boolean} auto_position if true then x, y parameters will be ignored and widget will be places on the first available position
- */
- will_it_fit(x: number, y: number, width: number, height: number, auto_position:boolean):boolean
-
-
-}
-/**
-* Defines the coordiantes of a object
-*/
-interface MousePosition {
- top: number,
- left:number,
-}
-/**
-* Defines the position of a cell inside the grid
-*/
-interface CellPosition {
- x: number,
- y:number
-}
-declare module GridStackUI {
- interface Utils {
- /**
- * Sorts array of nodes
- *@param nodes array to sort
- *@param dir 1 for asc, -1 for desc (optional)
- *@param width width of the grid. If undefined the width will be calculated automatically (optional).
- **/
- sort(nodes: HTMLElement[], dir: number, width: number): void
- }
-}
-/**
-* Gridstack Options
-* Defines the options for a Gridstack
-*/
-interface IGridstackOptions {
- /**
- * if true the resizing handles are shown even if the user is not hovering over the widget (default: false)
- */
- always_show_resize_handle: boolean;
- /**
- * turns animation on (default: true)
- */
- animate: boolean;
- /**
- * if false gridstack will not initialize existing items (default: true)
- */
- auto: boolean;
- /**
- * one cell height (default: 60)
- */
- cell_height: number;
- /**
- * allows to override jQuery UI draggable options. (default: { handle: '.grid-stack-item-content', scroll: true, appendTo: 'body' })
- */
- draggable: {};
- /**
- * draggable handle selector (default: '.grid-stack-item-content')
- */
- handle: string;
- /**
- * maximum rows amount.Default is 0 which means no maximum rows
- */
- height: number;
- /**
- * enable floating widgets (default: false) See example
- */
- float: boolean;
- /**
- * widget class (default: 'grid-stack-item')
- */
- item_class: string;
- /**
- * minimal width.If window width is less, grid will be shown in one - column mode (default: 768)
- */
- min_width: number;
- /**
- * class for placeholder (default: 'grid-stack-placeholder')
- */
- placeholder_class: string;
- /**
- * allows to override jQuery UI resizable options. (default: { autoHide: true, handles: 'se' })
- */
- resizable: {};
- /**
- * makes grid static (default false).If true widgets are not movable/ resizable.You don't even need jQueryUI draggable/resizable. A CSS class grid-stack-static is also added to the container.
- */
- static_grid: boolean;
- /**
- * vertical gap size (default: 20)
- */
- vertical_margin: number;
- /**
- * amount of columns (default: 12)
- */
- width: number;
-}
+// Type definitions for Gridstack
+// Project: http://troolee.github.io/gridstack.js/
+// Definitions by: Pascal Senn <https://github.com/PascalSenn/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+interface JQuery {
+ gridstack (options: IGridstackOptions):GridStack
+}
+
+interface GridStack {
+ /**
+ * Creates new widget and returns it.
+ *
+ * Widget will be always placed even if result height is more than actual grid height. You need to use will_it_fit method before calling add_widget for additional check.
+ *
+ * @param {string} el widget to add
+ * @param {number} x widget position x
+ * @param {number} y widget position y
+ * @param {number} width widget dimension width
+ * @param {number} height widget dimension height
+ * @param {boolean} auto_position if true then x, y parameters will be ignored and widget will be places on the first available position
+ */
+ add_widget(el: string, x: number, y: number, width: number, height: number, auto_position: boolean): JQuery
+ /**
+ * Initializes batch updates. You will see no changes until commit method is called.
+ */
+ batch_update():void
+ /**
+ * Gets current cell height.
+ */
+ cell_height():number
+ /**
+ * Update current cell height. This method rebuilds an internal CSS style sheet. Note: You can expect performance issues if call this method too often.
+ * @param {number} val the cell height
+ */
+ cell_height(val:number):void
+ /**
+ * Gets current cell width.
+ */
+ cell_width():number
+ /**
+ * Finishes batch updates. Updates DOM nodes. You must call it after batch_update.
+ */
+ commit():void
+ /**
+ * Destroys a grid instance.
+ */
+ destroy(): void
+ /*
+ * Disables widgets moving/resizing.
+ */
+ disable(): void
+ /*
+ * Enables widgets moving/resizing.
+ */
+ enable(): void
+ /*
+ * Get the position of the cell under a pixel on screen.
+ * @param {MousePosition} position the position of the pixel to resolve in absolute coordinates, as an object with top and leftproperties
+ */
+ get_cell_from_pixel(position: MousePosition): CellPosition,
+ /*
+ * Checks if specified area is empty.
+ * @param {number} x the position x.
+ * @param {number} y the position y.
+ * @param {number} width the width of to check
+ * @param {number} height the height of to check
+ */
+ is_area_empty(x: number, y: number, width: number, height: number): void
+ /*
+ * Locks/unlocks widget.
+ * @param {HTMLElement} el widget to modify.
+ * @param {boolean} val if true widget will be locked.
+ */
+ locked(el: HTMLElement, val: boolean): void
+ /*
+ * Set the minWidth for a widget.
+ * @param {HTMLElement} el widget to modify.
+ * @param {number} val A numeric value of the number of columns
+ */
+ min_width(el: HTMLElement, val: number): void
+ /*
+ * Set the minHeight for a widget.
+ * @param {HTMLElement} el widget to modify.
+ * @param {number} val A numeric value of the number of rows
+ */
+ min_height(el: HTMLElement, val: number): void
+ /*
+ * Enables/Disables moving.
+ * @param {HTMLElement} el widget to modify.
+ * @param {number} val if true widget will be draggable.
+ */
+ movable(el: HTMLElement, val: boolean): void
+ /**
+ * Changes widget position
+ * @param {HTMLElement} el widget to modify
+ * @param {number} x new position x. If value is null or undefined it will be ignored.
+ * @param {number} y new position y. If value is null or undefined it will be ignored.
+ *
+ */
+ move(el: HTMLElement, x: number, y: number): void
+ /**
+ * Removes widget from the grid.
+ * @param {HTMLElement} el widget to modify
+ * @param {boolean} detach_node if false DOM node won't be removed from the tree (Optional. Default true).
+ */
+ remove_widget(el: HTMLElement, detach_node?: boolean): void
+ /**
+ * Removes all widgets from the grid.
+ */
+ remove_all(): void
+ /**
+ * Changes widget size
+ * @param {HTMLElement} el widget to modify
+ * @param {number} width new dimensions width. If value is null or undefined it will be ignored.
+ * @param {number} height new dimensions height. If value is null or undefined it will be ignored.
+ */
+ resize(el: HTMLElement, width: number, height: number): void
+ /**
+ * Enables/Disables resizing.
+ * @param {HTMLElement} el widget to modify
+ * @param {boolean} val if true widget will be resizable.
+ */
+ resizable(el: HTMLElement, val: boolean): void
+ /**
+ * Toggle the grid static state. Also toggle the grid-stack-static class.
+ * @param {boolean} static_value if true the grid become static.
+ */
+ set_static(static_value: boolean): void
+ /**
+ * Updates widget position/size.
+ * @param {HTMLElement} el widget to modify
+ * @param {number} x new position x. If value is null or undefined it will be ignored.
+ * @param {number} y new position y. If value is null or undefined it will be ignored.
+ * @param {number} width new dimensions width. If value is null or undefined it will be ignored.
+ * @param {number} height new dimensions height. If value is null or undefined it will be ignored.
+ */
+ update(el: HTMLElement, x: number, y: number, width: number, height: number): void
+ /**
+ * Returns true if the height of the grid will be less the vertical constraint. Always returns true if grid doesn't have height constraint.
+ * @param {number} x new position x. If value is null or undefined it will be ignored.
+ * @param {number} y new position y. If value is null or undefined it will be ignored.
+ * @param {number} width new dimensions width. If value is null or undefined it will be ignored.
+ * @param {number} height new dimensions height. If value is null or undefined it will be ignored.
+ * @param {boolean} auto_position if true then x, y parameters will be ignored and widget will be places on the first available position
+ */
+ will_it_fit(x: number, y: number, width: number, height: number, auto_position:boolean):boolean
+
+
+}
+/**
+* Defines the coordiantes of a object
+*/
+interface MousePosition {
+ top: number,
+ left:number,
+}
+/**
+* Defines the position of a cell inside the grid
+*/
+interface CellPosition {
+ x: number,
+ y:number
+}
+declare module GridStackUI {
+ interface Utils {
+ /**
+ * Sorts array of nodes
+ *@param nodes array to sort
+ *@param dir 1 for asc, -1 for desc (optional)
+ *@param width width of the grid. If undefined the width will be calculated automatically (optional).
+ **/
+ sort(nodes: HTMLElement[], dir: number, width: number): void
+ }
+}
+/**
+* Gridstack Options
+* Defines the options for a Gridstack
+*/
+interface IGridstackOptions {
+ /**
+ * if true the resizing handles are shown even if the user is not hovering over the widget (default: false)
+ */
+ always_show_resize_handle: boolean;
+ /**
+ * turns animation on (default: true)
+ */
+ animate: boolean;
+ /**
+ * if false gridstack will not initialize existing items (default: true)
+ */
+ auto: boolean;
+ /**
+ * one cell height (default: 60)
+ */
+ cell_height: number;
+ /**
+ * allows to override jQuery UI draggable options. (default: { handle: '.grid-stack-item-content', scroll: true, appendTo: 'body' })
+ */
+ draggable: {};
+ /**
+ * draggable handle selector (default: '.grid-stack-item-content')
+ */
+ handle: string;
+ /**
+ * maximum rows amount.Default is 0 which means no maximum rows
+ */
+ height: number;
+ /**
+ * enable floating widgets (default: false) See example
+ */
+ float: boolean;
+ /**
+ * widget class (default: 'grid-stack-item')
+ */
+ item_class: string;
+ /**
+ * minimal width.If window width is less, grid will be shown in one - column mode (default: 768)
+ */
+ min_width: number;
+ /**
+ * class for placeholder (default: 'grid-stack-placeholder')
+ */
+ placeholder_class: string;
+ /**
+ * allows to override jQuery UI resizable options. (default: { autoHide: true, handles: 'se' })
+ */
+ resizable: {};
+ /**
+ * makes grid static (default false).If true widgets are not movable/ resizable.You don't even need jQueryUI draggable/resizable. A CSS class grid-stack-static is also added to the container.
+ */
+ static_grid: boolean;
+ /**
+ * vertical gap size (default: 20)
+ */
+ vertical_margin: number;
+ /**
+ * amount of columns (default: 12)
+ */
+ width: number;
+}
diff --git a/gruntjs/gruntjs.d.ts b/gruntjs/gruntjs.d.ts
index 850d0b2262..e503cb572b 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 42f5fb3480..fb2668a1f7 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 5ea8165b00..0df86dfc67 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/hapi/hapi-8.2.0.d.ts b/hapi/hapi-8.2.0.d.ts
index 80fcc4357d..c652ad4353 100644
--- a/hapi/hapi-8.2.0.d.ts
+++ b/hapi/hapi-8.2.0.d.ts
@@ -2101,12 +2101,14 @@ declare module "hapi" {
Returns a server object with connections set to the requested subset. Selecting again on a selection operates as a logic AND statement between the individual selections.
var Hapi = require('hapi');
var server = new Hapi.Server();
- server.connection({ port: 80, labels: ['a', 'b'] });
- server.connection({ port: 8080, labels: ['a', 'c'] });
- server.connection({ port: 8081, labels: ['b', 'c'] });
- var a = server.select('a'); // 80, 8080
- var ac = a.select('c'); // 8080*/
- select(labels: string|string[]): void;
+ server.connection({ port: 80, labels: ['a'] });
+ server.connection({ port: 8080, labels: ['b'] });
+ server.connection({ port: 8081, labels: ['c'] });
+ server.connection({ port: 8082, labels: ['c','d'] });
+ var a = server.select('a'); // The server with port 80
+ var ab = server.select(['a','b']); // A list of servers containing the server with port 80 and the server with port 8080
+ var c = server.select('c'); // A list of servers containing the server with port 8081 and the server with port 8082 */
+ select(labels: string|string[]): Server|Server[];
/** server.start([callback])
Starts the server connections by listening for incoming requests on the configured port of each listener (unless the connection was configured with autoListen set to false), where:
callback - optional callback when server startup is completed or failed with the signature function(err) where:
diff --git a/hapi/hapi.d.ts b/hapi/hapi.d.ts
index 3fc5dca036..7f2fab90e6 100644
--- a/hapi/hapi.d.ts
+++ b/hapi/hapi.d.ts
@@ -2104,12 +2104,14 @@ declare module "hapi" {
Returns a server object with connections set to the requested subset. Selecting again on a selection operates as a logic AND statement between the individual selections.
var Hapi = require('hapi');
var server = new Hapi.Server();
- server.connection({ port: 80, labels: ['a', 'b'] });
- server.connection({ port: 8080, labels: ['a', 'c'] });
- server.connection({ port: 8081, labels: ['b', 'c'] });
- var a = server.select('a'); // 80, 8080
- var ac = a.select('c'); // 8080*/
- select(labels: string|string[]): void;
+ server.connection({ port: 80, labels: ['a'] });
+ server.connection({ port: 8080, labels: ['b'] });
+ server.connection({ port: 8081, labels: ['c'] });
+ server.connection({ port: 8082, labels: ['c','d'] });
+ var a = server.select('a'); // The server with port 80
+ var ab = server.select(['a','b']); // A list of servers containing the server with port 80 and the server with port 8080
+ var c = server.select('c'); // A list of servers containing the server with port 8081 and the server with port 8082 */
+ select(labels: string|string[]): Server|Server[];
/** server.start([callback])
Starts the server connections by listening for incoming requests on the configured port of each listener (unless the connection was configured with autoListen set to false), where:
callback - optional callback when server startup is completed or failed with the signature function(err) where:
diff --git a/highcharts/highcharts-tests.ts b/highcharts/highcharts-tests.ts
index 456209a33d..bfcbc91375 100644
--- a/highcharts/highcharts-tests.ts
+++ b/highcharts/highcharts-tests.ts
@@ -1,145 +1,2288 @@
/// <reference path="highcharts.d.ts" />
/// <reference path="../jquery/jquery.d.ts" />
-Highcharts.setOptions({
- global: {
- useUTC: false
+function originalTests() {
+ Highcharts.setOptions({
+ global: {
+ useUTC: false
+ }
+ });
+
+ Highcharts.setOptions({
+ lang: {
+ months: ['Janvier', 'Février', 'Mars', 'Avril', 'Mai', 'Juin', 'Juillet', 'Août', 'Septembre', 'Octobre', 'Novembre', 'Décembre'],
+ weekdays: ['Dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi']
+ }
+ });
+
+
+ var animate: HighchartsAnimation = {
+ duration: 200,
+ easing: "linear"
+ };
+
+
+ var gradient: HighchartsGradient = {
+ linearGradient: {
+ x1: 0,
+ y1: 0,
+ x2: 500,
+ y2: 500
+ },
+ stops: [
+ [0, 'rgb(255, 255, 255)'],
+ [1, 'rgb(200, 200, 255)']
+ ]
}
-});
-Highcharts.setOptions({
- lang: {
- months: ['Janvier', 'Février', 'Mars', 'Avril', 'Mai', 'Juin', 'Juillet', 'Août', 'Septembre', 'Octobre', 'Novembre', 'Décembre'],
- weekdays: ['Dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi']
- }
-});
+ var color = "#fcfcff";
+ var chart1 = new Highcharts.Chart({
+ chart: {
+ renderTo: "container"
+ },
+ xAxis: {},
+ series: [<HighchartsLineChartSeriesOptions>{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4],
+ type: "line",
+ allowPointSelect: true
+ }]
+ });
-var animate: HighchartsAnimation = {
- duration: 200,
- easing: "linear"
-};
+ chart1.addSeries<HighchartsBarChartSeriesOptions>({
+ enableMouseTracking: true,
+ data: [1, 2, 3, 4, 5]
+ });
+ console.log((<HighchartsLineChartSeriesOptions>chart1.series[0].options).dashStyle);
-var gradient: HighchartsGradient = {
- linearGradient: {
- x1: 0,
- y1: 0,
- x2: 500,
- y2: 500
- },
- stops: [
- [0, 'rgb(255, 255, 255)'],
- [1, 'rgb(200, 200, 255)']
- ]
+ var chart2 = new Highcharts.Chart({
+ chart: {
+ renderTo: 'container',
+ width: 400,
+ height: 400,
+ spacingRight: 20
+ },
+ xAxis: [{
+ type: 'logarithmic',
+ min: 1,
+ max: 1000,
+ endOnTick: true,
+ tickInterval: 1,
+ minorTickInterval: 0.1,
+ gridLineWidth: 1
+ }],
+ yAxis: [{
+ type: 'logarithmic',
+ min: 1,
+ max: 1000,
+ tickInterval: 1,
+ minorTickInterval: 0.1,
+ title: {
+ text: null
+ }
+ }],
+ legend: {
+ enabled: false
+ },
+ series: [<HighchartsScatterChartSeriesOptions>{
+ data: [
+ [550, 870], [738, 362], [719, 711], [547, 665], [595, 197], [332, 144],
+ [581, 555], [196, 862], [6, 837], [400, 924], [888, 148], [785, 730],
+ [374, 358], [440, 69], [704, 318], [646, 506], [238, 662], [233, 56],
+ [622, 572], [563, 903], [744, 672], [904, 646], [390, 325], [536, 491],
+ [676, 186], [467, 145], [790, 114], [437, 793], [853, 243], [947, 196],
+ [395, 728], [527, 148], [516, 675], [632, 562], [52, 552], [605, 580],
+ [790, 865], [156, 87], [584, 290], [339, 921], [383, 633], [106, 373],
+ [762, 863], [424, 149], [608, 959], [574, 711], [468, 664], [268, 77],
+ [894, 850], [171, 102], [203, 565], [592, 549], [86, 486], [526, 244],
+ [323, 575], [488, 842], [401, 618], [148, 43], [828, 314], [554, 711],
+ [685, 868], [387, 435], [469, 828], [623, 506], [436, 184], [450, 156],
+ [805, 517], [465, 997], [728, 802], [231, 438], [935, 438], [519, 856],
+ [378, 579], [73, 765], [223, 219], [359, 317], [686, 742], [17, 790],
+ [20, 35], [410, 644], [984, 325], [503, 882], [900, 187], [578, 968],
+ [27, 718], [355, 704], [395, 332], [641, 548], [964, 374], [215, 472],
+ [323, 66], [882, 542], [671, 327], [650, 193], [828, 632], [760, 929],
+ [607, 335], [928, 826], [462, 598], [631, 411]
+ ],
+ type: 'scatter'
+ }]
+ });
+
+ var div: HTMLDivElement;
+ var r = new Highcharts.Renderer(div, 20, 30);
+ var box = r.text("Hello", 10, 10).getBBox();
+
+ var highChartSettings: HighchartsOptions = {
+ chart: {
+ width: 400,
+ height: 400
+ },
+ xAxis: [{
+ }],
+ series: [<HighchartsPieChartSeriesOptions>{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ };
+
+ var container = $("#container").highcharts(highChartSettings, (chart) => {
+ chart.series[0].setVisible(true, true);
+ });
+
+ var singleYAxisOptions: HighchartsOptions = {
+ yAxis: {}
+ };
+ var multipleYAxisOptions: HighchartsOptions = {
+ yAxis: [{}, {}]
+ };
}
-var color = "#fcfcff";
+function test_alldefaults() {
+ var options: HighchartsOptions = {
+ chart: {},
+ credits: {},
+ data: {},
+ drilldown: {},
+ exporting: {},
+ labels: {},
+ legend: {},
+ loading: {},
+ colors: [],
+ navigation: {},
+ noData: {},
+ pane: {},
+ plotOptions: {},
+ series: [{}],
+ subtitle: {},
+ title: {},
+ tooltip: {},
+ xAxis: {},
+ yAxis: {}
+ };
+}
-var chart1 = new Highcharts.Chart({
- chart: {
- renderTo: "container"
- },
- xAxis: [{
- }],
- series: [<HighchartsLineChartSeriesOptions>{
- data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4],
- type: "line",
- allowPointSelect: true
- }]
-});
+function test_ChartOptions() {
+ var emptyChartOptions: HighchartsChartOptions = {
+ events: {},
+ options3d: {},
+ resetZoomButton: {}
+ };
+ var allValuesSet: HighchartsChartOptions = {
+ alignTicks: false,
+ animation: {
+ duration: 500,
+ easing: "linear"
+ },
+ backgroundColor: <HighchartsGradient> {
+ linearGradient: {
+ x1: 0,
+ y1: 0,
+ x2: 1,
+ y2: 1
+ },
+ stops: [[0]]
+ },
+ borderColor: "#000000",
+ borderRadius: 20,
+ borderWidth: 5,
+ className: "class",
+ defaultSeriesType: "deprecated",
+ events: <HighchartsChartEvents> {
+ addSeries: () => {},
+ afterPrint: () => {},
+ beforePrint: () => {},
+ click: () => {},
+ drilldown: () => {},
+ drillup: () => {},
+ load: () => {},
+ redraw: () => {},
+ selection: () => {}
+ },
+ height: 200,
+ ignoreHiddenSeries: true,
+ inverted: true,
+ margin: [5, 5, 5, 5],
+ marginBottom: 10,
+ marginLeft: 10,
+ marginRight: 10,
+ marginTop: 10,
+ options3d: <HighchartsChartOptions3d> {
+ alpha: 20,
+ beta: 20,
+ depth: 50,
+ enabled: true,
+ frame: {
+ back: <HighchartsChartOptions3dFrame> {
+ color: "black",
+ size: 2
+ },
+ bottom: <HighchartsChartOptions3dFrame> {
+ color: "black",
+ size: 2
+ },
+ side: <HighchartsChartOptions3dFrame> {
+ color: "black",
+ size: 2
+ }
+ },
+ viewDistance: 100
+ },
+ panKey: "a",
+ panning: true,
+ pinchType: "xy",
+ plotBackgroundColor: "white",
+ plotBackgroundImage: "http://image.url/image.jpg",
+ plotBorderColor: "grey",
+ plotBorderWidth: 5,
+ plotShadow: <HighchartsShadow> {
+ color: "magenta",
+ offsetX: 10,
+ offsetY: 10,
+ opacity: .5,
+ width: 5
+ },
+ polar: true,
+ reflow: false,
+ renderTo: "elementId",
+ resetZoomButton: <HighchartsChartResetZoomButton> {
+ position: <HighchartsPosition> {
+ align: "left",
+ verticalAlign: "top",
+ x: 5,
+ y: 5
+ },
+ relativeTo: "chart",
+ theme: <HighchartsButtonTheme> {
+ display: "hidden",
+ fill: "black",
+ stroke: "white",
+ r: 2,
+ style: {}
+ }
+ },
+ selectionMarkerFill: "rgba(100, 100, 100, .5)",
+ shadow: false,
+ showAxes: true,
+ spacing: [5, 5, 10, 5],
+ spacingBottom: 5,
+ spacingLeft: 5,
+ spacingRight: 5,
+ spacingTop: 5,
+ style: {},
+ type: "spline",
+ width: 100,
+ zoomType: "x"
+ };
-chart1.addSeries<HighchartsBarChartSeriesOptions>({
- enableMouseTracking: true,
- data: [1, 2, 3, 4, 5]
-});
+ //alignticks example
+ $('#container').highcharts({
+ chart: {
+ alignTicks: true,
+ type: 'line'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ yAxis: [{
+ title: {
+ text: 'Primary Axis'
+ }
+ }, {
+ title: {
+ text: 'Secondary Axis'
+ },
+ gridLineWidth: 0,
+ opposite: true
+ }],
+ legend: {
+ layout: 'vertical',
+ backgroundColor: '#FFFFFF',
+ floating: true,
+ align: 'left',
+ x: 100,
+ verticalAlign: 'top',
+ y: 70
+ },
+ tooltip: {
+ formatter: function () {
+ return '<b>' + this.series.name + '</b><br/>' + this.x + ': ' + this.y;
+ }
+ },
+ plotOptions: {},
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }, {
+ data: [129.9, 271.5, 306.4, 29.2, 544.0, 376.0, 435.6, 348.5, 216.4, 294.1, 35.6, 354.4],
+ yAxis: 1
+ }]
+ });
+ // animation example
+ $('#container').highcharts(<HighchartsOptions> {
+ chart: {
+ animation: {
+ duration: 1500,
+ easing: 'easeOutBounce'
+ }
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+ var i = 1;
+ $('#update').click(function () {
+ var chart = $('#container').highcharts();
+ chart.series[0].data[0].update(i % 2 ? 200 : 0);
+ i += 1;
+ });
-console.log((<HighchartsLineChartSeriesOptions>chart1.series[0].options).dashStyle);
+ // background gradient example
+ $('#container').highcharts({
+ chart: {
+ backgroundColor: {
+ linearGradient: [0, 0, 500, 500],
+ stops: [
+ [0, 'rgb(255, 255, 255)'],
+ [1, 'rgb(200, 200, 255)']
+ ]
+ },
+ type: 'line'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ legend: {
+ layout: 'vertical',
+ backgroundColor: '#FFFFFF',
+ floating: true,
+ align: 'left',
+ x: 100,
+ verticalAlign: 'top',
+ y: 70
+ },
+ tooltip: {
+ formatter: function () {
+ return `<b>${this.series.name}</b><br/>${this.x}: ${this.y}`;
+ }
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
-var chart2 = new Highcharts.Chart({
- chart: {
- renderTo: 'container',
- width: 400,
- height: 400,
- spacingRight: 20
- },
- xAxis: [{
- type: 'logarithmic',
- min: 1,
- max: 1000,
- endOnTick: true,
- tickInterval: 1,
- minorTickInterval: 0.1,
- gridLineWidth: 1
- }],
- yAxis: [{
- type: 'logarithmic',
- min: 1,
- max: 1000,
- tickInterval: 1,
- minorTickInterval: 0.1,
+ // border example
+ $('#container').highcharts({
+ chart: {
+ borderColor: '#EBBA95',
+ borderRadius: 20,
+ borderWidth: 2,
+ type: 'line'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ legend: {
+ layout: 'vertical',
+ backgroundColor: '#FFFFFF',
+ floating: true,
+ align: 'left',
+ x: 100,
+ verticalAlign: 'top',
+ y: 70
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+
+ // events examples
+ $('#container').highcharts({
+ chart: {
+ events: {
+ addSeries: function () {
+ var label = (<HighchartsChartObject>this).renderer.label('A series was added, about to redraw chart', 100, 120)
+ .attr({
+ fill: Highcharts.getOptions().colors[0],
+ padding: 10,
+ r: 5,
+ zIndex: 8
+ })
+ .css({
+ color: '#FFFFFF'
+ })
+ .add();
+
+ setTimeout(function () {
+ label.fadeOut();
+ }, 1000);
+ }
+ }
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+
+ // activate the button
+ $('#button').click(function () {
+ var chart = $('#container').highcharts();
+
+ chart.addSeries({
+ data: [216.4, 194.1, 95.6, 54.4, 29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5]
+ });
+
+ $(this).attr('disabled', 'true');
+ });
+
+ // options3d examples
+ $('#container').highcharts({
+ chart: {
+ type: 'column',
+ margin: 75,
+ options3d: {
+ enabled: true,
+ alpha: 15,
+ beta: 15,
+ depth: 50,
+ frame: {
+ bottom: {
+ size: 1,
+ color: '#C0C0C0'
+ },
+ side: {
+ size: 1,
+ color: '#C0C0C0'
+ },
+ back: {
+ size: 1,
+ color: '#D0D0D0'
+ }
+ }
+ },
+ },
+ plotOptions: {
+ column: {
+ depth: 25
+ }
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+
+ // zoom&pan example
+ $('#container').highcharts({
+ chart: {
+ type: 'line',
+ zoomType: 'x',
+ panning: true,
+ panKey: 'shift'
+ },
title: {
- text: null
+ text: 'Zooming and panning'
+ },
+ subtitle: {
+ text: 'Click and drag to zoom in. Hold down shift key to pan.'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+
+ // reset zoom example
+ $('#container').highcharts({
+ chart: {
+ zoomType: 'x',
+ resetZoomButton: {
+ position: {
+ x: 0,
+ y: -30
+ },
+ theme: {
+ fill: 'white',
+ stroke: 'silver',
+ r: 0,
+ states: {
+ hover: {
+ fill: '#41739D',
+ style: {
+ color: 'white'
+ }
+ }
+ }
+ }
+ }
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+}
+
+function test_CreditsOptions() {
+ var allDefaults: HighchartsCreditsOptions = {};
+
+ // custom url and text example
+ $('#container').highcharts({
+ credits: {
+ text: 'Example.com',
+ href: 'http://www.example.com'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+}
+
+function test_Data() {
+ // all defaults
+ var data: HighchartsDataOptions = {};
+
+ // data from table example
+ $('#container').highcharts({
+ data: {
+ table: 'datatable'
+ },
+ chart: {
+ type: 'column'
+ },
+ title: {
+ text: 'Data extracted from a HTML table in the page'
+ },
+ yAxis: {
+ allowDecimals: false,
+ title: {
+ text: 'Units'
+ }
}
- }],
- legend: {
- enabled: false
- },
- series: [<HighchartsScatterChartSeriesOptions>{
- data: [
- [550, 870], [738, 362], [719, 711], [547, 665], [595, 197], [332, 144],
- [581, 555], [196, 862], [6, 837], [400, 924], [888, 148], [785, 730],
- [374, 358], [440, 69], [704, 318], [646, 506], [238, 662], [233, 56],
- [622, 572], [563, 903], [744, 672], [904, 646], [390, 325], [536, 491],
- [676, 186], [467, 145], [790, 114], [437, 793], [853, 243], [947, 196],
- [395, 728], [527, 148], [516, 675], [632, 562], [52, 552], [605, 580],
- [790, 865], [156, 87], [584, 290], [339, 921], [383, 633], [106, 373],
- [762, 863], [424, 149], [608, 959], [574, 711], [468, 664], [268, 77],
- [894, 850], [171, 102], [203, 565], [592, 549], [86, 486], [526, 244],
- [323, 575], [488, 842], [401, 618], [148, 43], [828, 314], [554, 711],
- [685, 868], [387, 435], [469, 828], [623, 506], [436, 184], [450, 156],
- [805, 517], [465, 997], [728, 802], [231, 438], [935, 438], [519, 856],
- [378, 579], [73, 765], [223, 219], [359, 317], [686, 742], [17, 790],
- [20, 35], [410, 644], [984, 325], [503, 882], [900, 187], [578, 968],
- [27, 718], [355, 704], [395, 332], [641, 548], [964, 374], [215, 472],
- [323, 66], [882, 542], [671, 327], [650, 193], [828, 632], [760, 929],
- [607, 335], [928, 826], [462, 598], [631, 411]
- ],
- type: 'scatter'
- }]
-});
+ });
-chart1.exportChart(null, {
- backgroundColor: '#FFFFFF'
-});
+ // data from csv example
+ $('#container').highcharts({
+ data: {
+ csv: document.getElementById('csv').innerHTML
+ },
+ plotOptions: {
+ series: {
+ marker: {
+ enabled: false
+ }
+ }
+ },
+ series: [
+ <HighchartsLineChartSeriesOptions> {
+ lineWidth: 1
+ },
+ <HighchartsAreaSplineChartSeriesOptions> {
+ type: 'areaspline',
+ color: '#c4392d',
+ negativeColor: '#5679c4',
+ fillOpacity: 0.5
+ }
+ ]
+ });
+ // limited data example
+ $('#container').highcharts({
+ data: <HighchartsDataOptions> {
+ csv: document.getElementById('csv').innerHTML,
+ startRow: 114,
+ endRow: 134,
+ endColumn: 1,
+ firstRowAsNames: false
+ },
+ xAxis: {
+ allowDecimals: false
+ },
+ series: [<HighchartsLineChartSeriesOptions> {
+ name: 'Annual mean'
+ }]
+ });
-var div: HTMLDivElement;
-var r = new Highcharts.Renderer(div, 20, 30);
-var box = r.text("Hello", 10, 10).getBBox();
+ // delimiter example
+ $('#container').highcharts({
+ xAxis: {
+ type: 'category'
+ },
+ data: {
+ csv: document.getElementById('csv').innerHTML,
+ itemDelimiter: ';',
+ lineDelimiter: '\n',
+ decimalPoint: ','
+ }
+ });
+}
-var highChartSettings: HighchartsOptions = {
- chart: {
- width: 400,
- height: 400
- },
- xAxis: [{
- }],
- series: [<HighchartsPieChartSeriesOptions>{
- data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
- }]
-};
+function test_Drilldown() {
+ var allDefaults: HighchartsDrilldownOptions = {};
-var container = $("#container").highcharts(highChartSettings, (chart) => {
- chart.series[0].setVisible(true, true);
-});
+ // multiseries drilldown example
+ $('#container').highcharts({
+ chart: {
+ type: 'column'
+ },
+ xAxis: {
+ type: 'category'
+ },
+ plotOptions: {
+ series: <HighchartsColumnChart> {
+ borderWidth: 0,
+ dataLabels: {
+ enabled: true
+ }
+ }
+ },
+ series: [<HighchartsColumnChartSeriesOptions>{
+ name: '2010',
+ data: [{
+ name: 'Republican',
+ y: 5,
+ drilldown: 'republican-2010'
+ }, {
+ name: 'Democrats',
+ y: 2,
+ drilldown: 'democrats-2010'
+ }, {
+ name: 'Other',
+ y: 4,
+ drilldown: 'other-2010'
+ }]
+ }, <HighchartsColumnChartSeriesOptions>{
+ name: '2014',
+ data: [{
+ name: 'Republican',
+ y: 4,
+ drilldown: 'republican-2014'
+ }, {
+ name: 'Democrats',
+ y: 4,
+ drilldown: 'democrats-2014'
+ }, {
+ name: 'Other',
+ y: 4,
+ drilldown: 'other-2014'
+ }]
+ }],
+ drilldown: {
+ series: [<HighchartsColumnChartSeriesOptions>{
+ id: 'republican-2010',
+ data: [
+ ['East', 4],
+ ['West', 2],
+ ['North', 1],
+ ['South', 4]
+ ]
+ }, <HighchartsColumnChartSeriesOptions>{
+ id: 'democrats-2010',
+ data: [
+ ['East', 6],
+ ['West', 2],
+ ['North', 2],
+ ['South', 4]
+ ]
+ }, <HighchartsColumnChartSeriesOptions>{
+ id: 'other-2010',
+ data: [
+ ['East', 2],
+ ['West', 7],
+ ['North', 3],
+ ['South', 2]
+ ]
+ }, <HighchartsColumnChartSeriesOptions>{
+ id: 'republican-2014',
+ data: [
+ ['East', 2],
+ ['West', 4],
+ ['North', 1],
+ ['South', 7]
+ ]
+ }, <HighchartsColumnChartSeriesOptions>{
+ id: 'democrats-2014',
+ data: [
+ ['East', 4],
+ ['West', 2],
+ ['North', 5],
+ ['South', 3]
+ ]
+ }, <HighchartsColumnChartSeriesOptions>{
+ id: 'other-2014',
+ data: [
+ ['East', 7],
+ ['West', 8],
+ ['North', 2],
+ ['South', 2]
+ ]
+ }]
+ }
+ });
+ // label and drillup example
+ $('#container').highcharts({
+ chart: {
+ type: 'column'
+ },
+ plotOptions: {
+ series: <HighchartsColumnChart> {
+ borderWidth: 0,
+ dataLabels: {
+ enabled: true
+ }
+ }
+ },
+ series: [<HighchartsColumnChartSeriesOptions>{
+ name: 'Things',
+ colorByPoint: true,
+ data: [{
+ name: 'Animals',
+ y: 5,
+ drilldown: 'animals'
+ }, {
+ name: 'Fruits',
+ y: 2,
+ drilldown: 'fruits'
+ }, {
+ name: 'Cars',
+ y: 4
+ }]
+ }],
+ drilldown: {
+ activeAxisLabelStyle: {
+ textDecoration: 'none',
+ fontStyle: 'italic'
+ },
+ activeDataLabelStyle: {
+ textDecoration: 'none',
+ fontStyle: 'italic'
+ },
+ drillUpButton: {
+ relativeTo: 'spacingBox',
+ position: {
+ y: 0,
+ x: 0
+ },
+ theme: {
+ fill: 'white',
+ 'stroke-width': 1,
+ stroke: 'silver',
+ r: 0,
+ states: {
+ hover: {
+ fill: '#bada55'
+ },
+ select: {
+ stroke: '#039',
+ fill: '#bada55'
+ }
+ }
+ }
+ },
+ series: [{
+ id: 'animals',
+ data: [
+ ['Cats', 4],
+ ['Dogs', 2],
+ ['Cows', 1],
+ ['Sheep', 2],
+ ['Pigs', 1]
+ ]
+ }, {
+ id: 'fruits',
+ data: [
+ ['Apples', 4],
+ ['Oranges', 2]
+ ]
+ }]
+ }
+ });
+}
-var singleYAxisOptions: HighchartsOptions = {
- yAxis: {}
-};
-var multipleYAxisOptions: HighchartsOptions = {
- yAxis: [{},{}]
-};
\ No newline at end of file
+function test_Exporting() {
+ var allDefaults: HighchartsExportingOptions = {};
+
+ // source size example
+ $('#container').highcharts({
+ title: {
+ text: 'Highcharts sourceWidth and sourceHeight demo'
+ },
+ subtitle: {
+ text: 'The on-screen chart is 600x400.<br/>The exported chart is 800x400<br/>(sourceWidth and sourceHeight multiplied by scale)',
+ floating: true,
+ align: 'left',
+ x: 60,
+ y: 50
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }],
+ exporting: {
+ sourceWidth: 400,
+ sourceHeight: 200,
+ scale: 2,
+ chartOptions: {
+ subtitle: null
+ }
+ }
+ });
+}
+
+function test_Loading() {
+ var allDefaults: HighchartsLoadingOptions = {};
+
+ // examples
+ // the button handler
+ var isLoading = false,
+ $button = $('#button'),
+ chart: HighchartsChartObject;
+
+ $button.click(function () {
+ if (!isLoading) {
+ chart.showLoading();
+ $button.html('Hide loading');
+ } else {
+ chart.hideLoading();
+ $button.html('Show loading');
+ }
+ isLoading = !isLoading;
+ });
+
+ // create the chart
+ $('#container').highcharts({
+ loading: {
+ hideDuration: 1000,
+ showDuration: 1000,
+ labelStyle: {
+ color: 'white'
+ },
+ style: {
+ backgroundColor: 'gray'
+ }
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+ chart = $('#container').highcharts();
+}
+
+function test_Navigation() {
+ var allDefaults: HighchartsNavigationOptions = {};
+
+ // examples
+ $('#container').highcharts({
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }],
+ navigation: {
+ buttonOptions: {
+ align: 'center',
+ height: 40,
+ width: 48,
+ symbolFill: 'blue',
+ symbolStroke: 'blue',
+ symbolSize: 24,
+ symbolX: 23,
+ symbolY: 21,
+ symbolStrokeWidth: 2,
+ verticalAlign: 'bottom',
+ y: -20
+ },
+ menuItemStyle: {
+ borderLeft: '20px solid #E0E0E0',
+ fontWeight: 'normal',
+ background: 'none'
+ },
+ menuItemHoverStyle: {
+ fontWeight: 'bold',
+ background: 'none',
+ color: 'black'
+ },
+ menuStyle: {
+ background: '#E0E0E0'
+ }
+ }
+ });
+}
+
+function test_NoData() {
+ var allDefaults: HighchartsNoDataOptions = {};
+
+ // example
+ $('#container').highcharts({
+ title: {
+ text: 'No data in line chart - with custom options'
+ },
+ series: [{
+ type: 'line',
+ name: 'Random data',
+ data: []
+ }],
+ lang: {
+ noData: "Nichts zu anzeigen"
+ },
+ noData: {
+ style: {
+ fontWeight: 'bold',
+ fontSize: '15px',
+ color: '#303030'
+ }
+ }
+ });
+}
+
+function test_AreaOptions() {
+ var allDefaults: HighchartsAreaChartSeriesOptions = {};
+
+ // examples
+ $('#container').highcharts({
+ chart: {
+ type: 'area'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ plotOptions: {
+ series: <HighchartsAreaChartSeriesOptions> {
+ fillColor: {
+ linearGradient: [0, 0, 0, 300],
+ stops: [
+ [0, Highcharts.getOptions().colors[0]],
+ [1, (<HighchartsGradient>Highcharts.Color(Highcharts.getOptions().colors[0])).setOpacity(0).get('rgba')]
+ ]
+ },
+ fillOpacity: 0.1,
+ lineColor: '#303030',
+ negativeFillColor: 'red',
+ stacking: 'normal',
+ step: 'right',
+ threshold: 100,
+ trackByArea: true,
+ stickyTracking: false // to show the difference in tracking
+ }
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+}
+
+function test_AreaRange() {
+ var allDefaults: HighchartsAreaRangeChartSeriesOptions = {};
+
+ // example
+ $('#container').highcharts({
+ chart: {
+ type: "arearange",
+ zoomType: 'x'
+ },
+ series: [<HighchartsAreaRangeChartSeriesOptions>{
+ data: (function (arr: number[], len: number) {
+ var i: number;
+ for (i = 0; i < len; i = i + 1) {
+ arr.push(i);
+ }
+ return arr;
+ }([], 50))
+ }]
+ });
+
+ $('#setextremes').click(function () {
+ $('#container').highcharts().xAxis[0].setExtremes(10, 15);
+ });
+
+ $('#unsetextremes').click(function () {
+ $('#container').highcharts().xAxis[0].setExtremes();
+ });
+
+ // datalabels example
+ $.getJSON('http://www.highcharts.com/samples/data/jsonp.php?filename=range.json&callback=?', function (data) {
+ // Shorten the data
+ data = data.splice(181, 14);
+ $('#container').highcharts({
+ chart: {
+ type: 'arearange'
+ },
+ title: {
+ text: 'Temperature variation by day'
+ },
+ xAxis: {
+ type: 'datetime'
+ },
+ yAxis: {
+ title: {
+ text: null
+ }
+ },
+ tooltip: {
+ crosshairs: true,
+ shared: true,
+ valueSuffix: '°C'
+ },
+ legend: {
+ enabled: false
+ },
+ series: [<HighchartsAreaRangeChartSeriesOptions> {
+ name: 'Temperatures',
+ data: data,
+ dataLabels: {
+ enabled: true,
+ yHigh: 20,
+ yLow: -20
+ }
+ }]
+
+ });
+ });
+}
+
+function test_Bar() {
+ var allDefaults: HighchartsBarChartSeriesOptions = {};
+
+ $('#container').highcharts({
+ chart: {
+ type: 'bar'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ plotOptions: {
+ series: <HighchartsBarChartSeriesOptions> {
+ borderColor: '#303030',
+ borderRadius: 5,
+ borderWidth: 2,
+ colorByPoint: true,
+ colors: ["black", "red", "blue"],
+ groupPadding: 1,
+ maxPointWidth: 50,
+ minPointLength: 3,
+ pointRange: 24 * 3600 * 1000,
+ pointWidth: 20,
+ states: {
+ hover: {
+ brightness: -0.3, // darken
+ enabled: true,
+ halo: {
+ size: 9,
+ attributes: {
+ fill: Highcharts.getOptions().colors[2],
+ 'stroke-width': 2,
+ stroke: Highcharts.getOptions().colors[1]
+ }
+ }
+ }
+ }
+ }
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+
+ // 3d example
+ $('#container').highcharts({
+ chart: {
+ type: 'column',
+ margin: 75,
+ options3d: {
+ enabled: true,
+ alpha: 15,
+ beta: 15,
+ depth: 50
+ }
+ },
+ plotOptions: {
+ column: {
+ depth: 25,
+ edgeColor: "black",
+ edgeWidth: 2,
+ groupZPadding: 2,
+ }
+ },
+ series: [{
+ data: [29.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
+ }]
+ });
+
+ // grouping example
+ Highcharts.getOptions().colors = Highcharts.map(Highcharts.getOptions().colors, function (color: string) {
+ return (<HighchartsGradient>Highcharts.Color(color))
+ .setOpacity(0.5)
+ .get('rgba');
+ });
+
+ $('#container').highcharts({
+ chart: {
+ type: 'bar'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ yAxis: {
+ min: 0,
+ },
+ legend: {
+ layout: 'vertical',
+ backgroundColor: '#FFFFFF',
+ align: 'left',
+ verticalAlign: 'top',
+ x: 100,
+ y: 70,
+ floating: true,
+ shadow: true
+ },
+ tooltip: {
+ shared: true,
+ valueSuffix: ' mm'
+ },
+ plotOptions: {
+ column: {
+ grouping: false,
+ shadow: false
+ }
+ },
+ series: [<HighchartsBarChartSeriesOptions> {
+ name: 'Tokyo',
+ data: [49.9, 71.5, 106.4, 129.2, 144.0, 176.0, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4],
+ pointPadding: 0
+ }, <HighchartsBarChartSeriesOptions> {
+ name: 'New York',
+ data: [83.6, 78.8, 98.5, 93.4, 106.0, 84.5, 105.0, 104.3, 91.2, 83.5, 106.6, 92.3],
+ pointPadding: 0.1
+ }, <HighchartsBarChartSeriesOptions> {
+ name: 'London',
+ data: [48.9, 38.8, 39.3, 41.4, 47.0, 48.3, 59.0, 59.6, 52.4, 65.2, 59.3, 51.2],
+ pointPadding: 0.2
+ }, <HighchartsBarChartSeriesOptions> {
+ name: 'Berlin',
+ data: [42.4, 33.2, 34.5, 39.7, 52.6, 75.5, 57.4, 60.4, 47.6, 39.1, 46.8, 51.1],
+ pointPadding: 0.3
+ }]
+ });
+}
+
+function test_BoxPlot() {
+ var allDefaults: HighchartsBoxPlotChartSeriesOptions = {};
+
+ // boxplot example
+ $('#container').highcharts({
+ chart: {
+ type: 'boxplot'
+ },
+ title: {
+ text: 'Highcharts box plot styling'
+ },
+ legend: {
+ enabled: false
+ },
+ xAxis: {
+ categories: ['1', '2', '3', '4', '5'],
+ title: {
+ text: 'Experiment No.'
+ }
+ },
+ yAxis: {
+ title: {
+ text: 'Observations'
+ }
+ },
+ plotOptions: {
+ boxplot: {
+ fillColor: '#F0F0E0',
+ lineWidth: 2,
+ medianColor: '#0C5DA5',
+ medianWidth: 3,
+ stemColor: '#A63400',
+ stemDashStyle: 'dot',
+ stemWidth: 1,
+ whiskerColor: '#3D9200',
+ whiskerLength: '20%',
+ whiskerWidth: 3
+ }
+ },
+ series: [{
+ name: 'Observations',
+ data: [
+ [760, 801, 848, 895, 965],
+ [733, 853, 939, 980, 1080],
+ [714, 762, 817, 870, 918],
+ [724, 802, 806, 871, 950],
+ [834, 836, 864, 882, 910]
+ ]
+ }]
+ });
+}
+
+function test_Bubble() {
+ var allDefaults: HighchartsBubbleChartSeriesOptions = {};
+
+ // bubble example
+ $('#container').highcharts({
+ chart: {
+ type: 'bubble',
+ plotBorderWidth: 1,
+ zoomType: 'xy'
+ },
+ title: {
+ text: 'Highcharts with negative bubbles'
+ },
+ xAxis: {
+ gridLineWidth: 1
+ },
+ yAxis: {
+ startOnTick: false,
+ endOnTick: false
+ },
+ plotOptions: {
+ bubble: {
+ minSize: 3,
+ maxSize: 50
+ }
+ },
+ series: [<HighchartsBubbleChartSeriesOptions> {
+ data: [
+ [9, 81, 13],
+ [98, 5, 39],
+ [51, 50, 23],
+ [41, 22, -36],
+ [58, 24, -30],
+ [78, 37, -16],
+ [55, 56, 3],
+ [18, 45, 20],
+ [42, 44, -22],
+ [3, 52, 9],
+ [31, 18, 47],
+ [79, 91, 13],
+ [93, 23, -27],
+ [44, 83, -28]
+ ],
+ displayNegative: true,
+ negativeColor: Highcharts.getOptions().colors[1],
+ sizeBy: "width",
+ zMin: 0,
+ zMax: 100,
+ zThreshold: 0
+ }]
+ });
+
+ // size by absolute value example
+ $('#container').highcharts({
+ chart: {
+ type: 'bubble'
+ },
+ title: {
+ text: 'Size by absolute value'
+ },
+ subtitle: {
+ text: 'Size is computed by absolute value on negative bubbles'
+ },
+ series: [<HighchartsBubbleChartSeriesOptions>{
+ data: [
+ [-5, 0, -5],
+ [-4, 0, -4],
+ [-3, 0, -3],
+ [-2, 0, -2],
+ [-1, 0, -1],
+ [0, 0, 0],
+ [1, 0, 1],
+ [2, 0, 2],
+ [3, 0, 3],
+ [4, 0, 4],
+ [5, 0, 5]
+ ],
+ sizeByAbsoluteValues: true,
+ negativeColor: '#FF0000'
+ }]
+ });
+}
+
+function test_Column() {
+ var allDefaults: HighchartsColumnChartSeriesOptions = {};
+
+ // same options as bar chart
+}
+
+function test_ColumnRange() {
+ var allDefaults: HighchartsColumnRangeChartSeriesOptions = {};
+
+ // same options as bar chart and datalabels from arearange
+}
+
+function test_ErrorBar() {
+ var allDefaults: HighchartsErrorBarChartSeriesOptions = {};
+
+ // error bar styling example
+ $('#container').highcharts({
+ chart: {
+ zoomType: 'x'
+ },
+ title: {
+ text: 'Temperature'
+ },
+ xAxis: [{
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ }],
+ yAxis: {
+ labels: {
+ format: '{value}°C'
+ },
+ title: {
+ text: 'Temperature'
+ }
+ },
+ tooltip: {
+ shared: true
+ },
+ series: [<HighchartsSplineChartSeriesOptions>{
+ name: 'Temperature',
+ type: 'spline',
+ data: [7.0, 6.9, 9.5, 14.5, 18.2, 21.5, 25.2, 26.5, 23.3, 18.3, 13.9, 9.6],
+ marker: {
+ enabled: false
+ },
+ tooltip: {
+ pointFormat: '<span style="font-weight: bold; color: {series.color}">{series.name}</span>: <b>{point.y:.1f}°C</b><br/>'
+ }
+ }, <HighchartsErrorBarChartSeriesOptions> {
+ color: '#FF0000',
+ name: 'Temperature error',
+ type: 'errorbar',
+ data: [[6, 8], [5.9, 7.6], [9.4, 10.4], [14.1, 15.9], [18.0, 20.1], [21.0, 24.0], [23.2, 25.3], [26.1, 27.8], [23.2, 23.9], [18.0, 21.1], [12.9, 14.0], [7.6, 10.0]],
+ tooltip: {
+ pointFormat: 'Error range: {point.low}-{point.high}°C'
+ },
+ stemColor: "grey",
+ stemDashStyle: "Solid",
+ stemWidth: 3,
+ whiskerLength: 0
+ }]
+ });
+}
+
+function test_Funnel() {
+ var allDefaults: HighchartsFunnelChartSeriesOptions = {};
+
+ // funnel demo
+ $('#container').highcharts({
+ chart: {
+ type: 'funnel',
+ marginRight: 100
+ },
+ title: {
+ text: 'Sales funnel',
+ x: -50
+ },
+ plotOptions: {
+ series: <HighchartsFunnelChartSeriesOptions> {
+ dataLabels: {
+ enabled: true,
+ format: '<b>{point.name}</b> ({point.y:,.0f})',
+ color: 'black',
+ softConnector: true
+ },
+ neckWidth: '30%',
+ neckHeight: '25%',
+ reversed: false,
+ height: "10%",
+ width: 100
+ }
+ },
+ legend: {
+ enabled: false
+ },
+ series: [{
+ name: 'Unique users',
+ data: [
+ ['Website visits', 15654],
+ ['Downloads', 4064],
+ ['Requested price list', 1987],
+ ['Invoice sent', 976],
+ ['Finalized', 846]
+ ]
+ }]
+ });
+}
+
+function test_Gauge() {
+ var allDefaults: HighchartsGaugeChartSeriesOptions = {};
+
+ // example
+ $('#container').highcharts({
+ chart: {
+ type: 'gauge'
+ },
+ pane: {
+ startAngle: -150,
+ endAngle: 150
+ },
+ yAxis: {
+ min: 0,
+ max: 100
+ },
+ plotOptions: {
+ gauge: {
+ dial: {
+ radius: '100%',
+ backgroundColor: 'silver',
+ borderColor: 'black',
+ borderWidth: 1,
+ baseWidth: 10,
+ topWidth: 1,
+ baseLength: '90%', // of radius
+ rearLength: '50%'
+ },
+ pivot: {
+ radius: 4,
+ borderWidth: 0,
+ borderColor: '#1f9fd9',
+ backgroundColor: '#1f9fd9'
+ },
+ dataLabels: {
+ borderWidth: 2,
+ borderColor: '#d3e9f7',
+ padding: 5,
+ borderRadius: 2,
+ verticalAlign: 'center',
+ y: 30,
+ style: {
+ fontWeight: 'normal'
+ }
+ }
+ }
+ },
+ series: [<HighchartsGaugeChartSeriesOptions> {
+ data: [80],
+ overshoot: 5
+ }]
+ });
+}
+
+function test_HeatMap() {
+ var allDefaults: HighchartsHeatMapSeriesOptions = {};
+
+ // heatmap demo
+ $('#container').highcharts({
+ data: {
+ csv: document.getElementById('csv').innerHTML
+ },
+ chart: {
+ type: 'heatmap',
+ inverted: true
+ },
+ title: {
+ text: 'Highcharts heat map',
+ align: 'left'
+ },
+ subtitle: {
+ text: 'Temperature variation by day and hour through May 2015',
+ align: 'left'
+ },
+ xAxis: {
+ tickPixelInterval: 50,
+ min: Date.UTC(2015, 4, 1),
+ max: Date.UTC(2015, 4, 30)
+ },
+ yAxis: {
+ title: {
+ text: null
+ },
+ labels: {
+ format: '{value}:00'
+ },
+ minPadding: 0,
+ maxPadding: 0,
+ startOnTick: false,
+ endOnTick: false,
+ tickPositions: [0, 6, 12, 18, 24],
+ tickWidth: 1,
+ min: 0,
+ max: 23
+ },
+ colorAxis: {
+ stops: [
+ [0, '#3060cf'],
+ [0.5, '#fffbbc'],
+ [0.9, '#c4463a']
+ ],
+ min: -5
+ },
+ series: [<HighchartsHeatMapSeriesOptions> {
+ borderWidth: 0,
+ colsize: 24 * 36e5, // one day
+ tooltip: {
+ headerFormat: 'Temperature<br/>',
+ pointFormat: '{point.x:%e %b, %Y} {point.y}:00: <b>{point.value} ℃</b>'
+ }
+ }]
+ });
+}
+
+function test_Line() {
+ var allDefaults: HighchartsLineChartSeriesOptions = {};
+
+ // step example
+ $('#container').highcharts({
+ title: {
+ text: 'Step line types, with null values in the series'
+ },
+ xAxis: {
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ },
+ series: [<HighchartsLineChartSeriesOptions>{
+ data: [1, 2, 3, 4, null, 6, 7, null, 9],
+ step: 'right',
+ name: 'Right'
+ }, <HighchartsLineChartSeriesOptions>{
+ data: [5, 6, 7, 8, null, 10, 11, null, 13],
+ step: 'center',
+ name: 'Center'
+ }, <HighchartsLineChartSeriesOptions>{
+ data: [9, 10, 11, 12, null, 14, 15, null, 17],
+ step: 'left',
+ name: 'Left'
+ }]
+ });
+}
+
+function test_Pie() {
+ var allDefaults: HighchartsPieChartSeriesOptions = {};
+
+ // pie demo
+ $('#container').highcharts({
+ chart: {
+ plotBackgroundColor: null,
+ plotBorderWidth: null,
+ plotShadow: false,
+ type: 'pie'
+ },
+ title: {
+ text: 'Browser market shares January, 2015 to May, 2015'
+ },
+ tooltip: {
+ pointFormat: '{series.name}: <b>{point.percentage:.1f}%</b>'
+ },
+ plotOptions: {
+ pie: {
+ allowPointSelect: true,
+ center: [100, 100],
+ cursor: 'pointer',
+ dataLabels: {
+ enabled: true,
+ format: '<b>{point.name}</b>: {point.percentage:.1f} %',
+ style: {
+ color: 'black'
+ }
+ }
+ }
+ },
+ series: [<HighchartsPieChartSeriesOptions>{
+ name: "Brands",
+ colorByPoint: true,
+ data: [{
+ name: "Microsoft Internet Explorer",
+ y: 56.33
+ }, {
+ name: "Chrome",
+ y: 24.03,
+ sliced: true,
+ selected: true
+ }, {
+ name: "Firefox",
+ y: 10.38
+ }, {
+ name: "Safari",
+ y: 4.77
+ }, {
+ name: "Opera",
+ y: 0.91
+ }, {
+ name: "Proprietary or Undetectable",
+ y: 0.2
+ }]
+ }]
+ });
+
+ // semi circle
+ $('#container').highcharts({
+ chart: {
+ plotBackgroundColor: null,
+ plotBorderWidth: 0,
+ plotShadow: false
+ },
+ title: {
+ text: 'Browser<br>shares<br>2015',
+ align: 'center',
+ verticalAlign: 'middle',
+ y: 40
+ },
+ tooltip: {
+ pointFormat: '{series.name}: <b>{point.percentage:.1f}%</b>'
+ },
+ plotOptions: {
+ pie: {
+ dataLabels: {
+ enabled: true,
+ distance: -50,
+ style: {
+ fontWeight: 'bold',
+ color: 'white',
+ textShadow: '0px 1px 2px black'
+ }
+ },
+ startAngle: -90,
+ endAngle: 90,
+ center: ['50%', '75%']
+ }
+ },
+ series: [<HighchartsPieChartSeriesOptions>{
+ type: 'pie',
+ name: 'Browser share',
+ innerSize: '50%',
+ data: [
+ ['Firefox', 10.38],
+ ['IE', 56.33],
+ ['Chrome', 24.03],
+ ['Safari', 4.77],
+ ['Opera', 0.91],
+ {
+ name: 'Proprietary or Undetectable',
+ y: 0.2,
+ dataLabels: {
+ enabled: false
+ }
+ }
+ ]
+ }]
+ });
+
+ // slice and size
+ $('#container').highcharts({
+ chart: {
+ type: 'pie'
+ },
+ plotOptions: {
+ pie: {
+ allowPointSelect: true,
+ innerSize: 10,
+ size: 80,
+ slicedOffset: 20
+ }
+ },
+ series: [{
+ data: [
+ {
+ name: 'Firefox',
+ y: 44.2,
+ selected: true,
+ sliced: true
+ },
+ ['IE7', 26.6],
+ ['IE6', 20],
+ ['Chrome', 3.1],
+ ['Other', 5.4]
+ ]
+ }]
+ });
+}
+
+function test_Polygon() {
+ var allDefaults: HighchartsPolygonChartSeriesOptions = {};
+
+ $('#container').highcharts({
+ chart: {
+ type: 'polygon'
+ },
+ xAxis: {
+ minPadding: 0.05,
+ maxPadding: 0.05
+ },
+ plotOptions: {
+ polygon: {
+ lineWidth: 5
+ }
+ },
+ series: [{
+ data: [
+ [34, 29.9],
+ [35, 144.0],
+ [43, 176.0],
+ [46, 71.5],
+ [12, 106.4],
+ [78, 129.2]
+ ]
+ }]
+ });
+}
+
+function test_Pyramid() {
+ var allDefaults: HighchartsPyramidChartSeriesOptions = {};
+
+ // pyramid demo
+ $('#container').highcharts({
+ chart: {
+ type: 'pyramid',
+ marginRight: 100
+ },
+ title: {
+ text: 'Sales pyramid',
+ x: -50
+ },
+ plotOptions: {
+ pyramid: {
+ dataLabels: {
+ enabled: true,
+ format: '<b>{point.name}</b> ({point.y:,.0f})',
+ color: 'black',
+ softConnector: true
+ }
+ }
+ },
+ legend: {
+ enabled: false
+ },
+ series: [{
+ name: 'Unique users',
+ data: [
+ ['Website visits', 15654],
+ ['Downloads', 4064],
+ ['Requested price list', 1987],
+ ['Invoice sent', 976],
+ ['Finalized', 846]
+ ]
+ }]
+ });
+}
+
+function test_SolidGauge() {
+ var allDefaults: HighchartsSolidGaugeChartSeriesOptions = {};
+
+ // partial solid gauge demo
+ var gaugeOptions: HighchartsOptions = {
+ chart: {
+ type: 'solidgauge'
+ },
+ title: null,
+ pane: {
+ center: ['50%', '85%'],
+ size: '140%',
+ startAngle: -90,
+ endAngle: 90,
+ background: {
+ backgroundColor: '#EEE',
+ innerRadius: '60%',
+ outerRadius: '100%',
+ shape: 'arc'
+ }
+ },
+ tooltip: {
+ enabled: false
+ },
+ yAxis: {
+ stops: [
+ [0.1, '#55BF3B'], // green
+ [0.5, '#DDDF0D'], // yellow
+ [0.9, '#DF5353'] // red
+ ],
+ lineWidth: 0,
+ minorTickInterval: null,
+ tickPixelInterval: 400,
+ tickWidth: 0,
+ title: {
+ y: -70
+ },
+ labels: {
+ y: 16
+ }
+ },
+ plotOptions: {
+ solidgauge: {
+ dataLabels: {
+ y: 5,
+ borderWidth: 0,
+ useHTML: true
+ }
+ }
+ }
+ };
+}
+
+function test_TreeMap() {
+ var allDefaults: HighchartsTreeMapChartSeriesOptions = {};
+
+ // allowDrillToNode
+ var treeMap: HighchartsTreeMapChartSeriesOptions = {
+ type: "treemap",
+ layoutAlgorithm: 'squarified',
+ allowDrillToNode: true,
+ alternateStartingDirection: true,
+ interactByLeaf: true,
+ layoutStartingDirection: "horizontal",
+ levelIsConstant: true,
+ data: [{
+ id: "id_1",
+ name: 'A'
+ }, {
+ id: "id_2",
+ name: 'A1',
+ value: 2,
+ parent: 'id_1'
+ }, {
+ id: "id_3",
+ name: 'A2',
+ value: 2,
+ parent: 'id_1'
+ }, {
+ id: "id_4",
+ name: 'A3',
+ value: 2,
+ parent: 'id_1'
+ }, {
+ name: 'B',
+ value: 6
+ }, {
+ name: 'C',
+ value: 4
+ }, {
+ name: 'D',
+ value: 3
+ }, {
+ name: 'E',
+ value: 2
+ }, {
+ name: 'F',
+ value: 2
+ }, {
+ name: 'G',
+ value: 1
+ }]
+ };
+}
+
+function test_Waterfall() {
+ var allDefaults: HighchartsWaterFallChartSeriesOptions = {};
+
+ // partial waterfall demo
+ var series: HighchartsWaterFallChartSeriesOptions = {
+ upColor: Highcharts.getOptions().colors[2],
+ color: Highcharts.getOptions().colors[3],
+ data: [{
+ name: 'Start',
+ y: 120000
+ }, {
+ name: 'Product Revenue',
+ y: 569000
+ }, {
+ name: 'Service Revenue',
+ y: 231000
+ }, {
+ name: 'Positive Balance',
+ isIntermediateSum: true,
+ color: Highcharts.getOptions().colors[1]
+ }, {
+ name: 'Fixed Costs',
+ y: -342000
+ }, {
+ name: 'Variable Costs',
+ y: -233000
+ }, {
+ name: 'Balance',
+ isSum: true,
+ color: Highcharts.getOptions().colors[1]
+ }],
+ dataLabels: {
+ enabled: true,
+ formatter: function () {
+ return Highcharts.numberFormat(this.y / 1000, 0, ',') + 'k';
+ },
+ style: {
+ color: '#FFFFFF',
+ fontWeight: 'bold',
+ textShadow: '0px 0px 3px black'
+ }
+ },
+ pointPadding: 0
+ };
+}
+
+function test_AxisOptions() {
+ var allDefaults: HighchartsAxisOptions = {};
+
+ var axis: HighchartsAxisOptions = {
+ allowDecimals: false,
+ alternateGridColor: '#000000',
+ breaks: [{
+ breakSize: 1,
+ from: 5,
+ to: 10,
+ repeat: 2
+ }],
+ categories: ['A', 'B'],
+ ceiling: 100,
+ dateTimeLabelFormats: {
+ millisecond: "ms format"
+ },
+ endOnTick: false,
+ events: {
+ afterBreaks: () => {},
+ afterSetExtremes: () => {},
+ pointBreak: () => {},
+ setExtremes: () => {}
+ },
+ floor: 0,
+ gridLineColor: '#111111',
+ gridLineDashStyle: 'Solid',
+ gridLineWidth: 1,
+ gridZIndex: 1,
+ id: "axis1",
+ labels: {
+ align: "left",
+ autoRotation: [-45],
+ autoRotationLimit: 70,
+ distance: 10,
+ enabled: true,
+ format: "format",
+ formatter: function() { return this.value; },
+ maxStaggerLines: 5,
+ overflow: false,
+ padding: 10,
+ rotation: 10,
+ staggerLines: 10,
+ step: 3,
+ style: {},
+ useHTML: false,
+ x: 0,
+ y: 0
+ },
+ lineColor: "#C0D0E0",
+ lineWidth: 2,
+ linkedTo: 1,
+ max: 1200,
+ maxPadding: 5,
+ min: 0,
+ minPadding: 5,
+ minRange: 10,
+ minTickInterval: 5,
+ minorGridLineColor: "#E0E0E0",
+ minorGridLineDashStyle: 'Solid',
+ minorGridLineWidth: 2,
+ minorTickColor: '#A0A0A0',
+ minorTickInterval: 5,
+ minorTickLength: 3,
+ minorTickPosition: 'inside',
+ minorTickWidth: 0,
+ offset: 0,
+ opposite: false,
+ plotBands: [{
+ borderColor: 'black',
+ borderWidth: 2,
+ color: 'gray',
+ events: {
+ click: () => {},
+ mouseover: () => {},
+ mouseout: () => {},
+ mousemove: () => {}
+ },
+ from: 0,
+ id: 'plotband1',
+ innerRadius: 10,
+ label: {
+ align: 'left',
+ rotation: 10,
+ style: {},
+ text: 'text',
+ textAlign: 'left',
+ useHTML: false,
+ verticalAlign: 'bottom',
+ x: 0,
+ y: 0
+ },
+ outerRadius: 20,
+ thickness: 1,
+ to: 2,
+ zIndex: 2
+ }],
+ plotLines: [{
+ color: '#000000',
+ dashStyle: 'Solid',
+ events: {
+ click: () => {},
+ mouseover: () => {},
+ mouseout: () => {},
+ mousemove: () => {}
+ },
+ id: 'plotline1',
+ label: {
+ align: 'left',
+ rotation: 10,
+ style: {},
+ text: 'text',
+ textAlign: 'left',
+ useHTML: false,
+ verticalAlign: 'bottom',
+ x: 0,
+ y: 0
+ },
+ value: 10,
+ width: 100,
+ zIndex: 2
+ }],
+ reversed: false,
+ showEmpty: false,
+ showFirstLabel: true,
+ showLastLabel: true,
+ startOfWeek: 1,
+ startOnTick: false,
+ tickAmount: 10,
+ tickColor: 'black',
+ tickInterval: 1,
+ tickLength: 10,
+ tickPixelInterval: 100,
+ tickPosition: 'outside',
+ tickPositioner: () => {},
+ tickPositions: [0, 1, 2],
+ tickWidth: 1,
+ tickmarkPlacement: 'between',
+ title: {
+ align: 'left',
+ rotation: 10,
+ style: {},
+ text: 'text',
+ x: 0,
+ y: 0
+ },
+ type: 'linear',
+ units: [
+ ['millisecond', [1, 2, 5, 10, 20, 25, 50, 100, 200, 500]],
+ ['second', [1, 2, 5, 10, 15, 30]],
+ ['minute', [1, 2, 5, 10, 15, 30]]],
+ visible: true
+ };
+}
+
+function test_AxisObject() {
+ var axis = $("#container").highcharts().xAxis[0];
+ axis.addPlotBand({
+ from: 5.5,
+ to: 7.5,
+ color: '#FCFFC5',
+ id: 'plot-band-1'
+ });
+ axis.removePlotBand('plot-band-1');
+ axis.addPlotLine({
+ value: 5.5,
+ color: 'red',
+ width: 2,
+ id: 'plot-line-1'
+ });
+ axis.removePlotLine('plot-line-1');
+ var extremes = axis.getExtremes();
+ console.log('dataMax: ' + extremes.dataMax + '<br/>' +
+ 'dataMin: ' + extremes.dataMin + '<br/>' +
+ 'max: ' + extremes.max + '<br/>' +
+ 'min: ' + extremes.min + '<br/>');
+ axis.remove();
+ axis.remove(false);
+ axis.setCategories(['A', 'B', 'C']);
+ axis.setCategories(['A', 'B', 'C', 'D'], false);
+ axis.setExtremes();
+ axis.setExtremes(10, 20);
+ axis.setExtremes(10, 20, false);
+ axis.setExtremes(10, 20, false, false);
+ axis.setExtremes(10, 20, false, {duration: 50});
+ axis.setTitle({text: 'text'});
+ axis.setTitle({text: 'text'}, false);
+ axis.toPixels(10);
+ axis.toPixels(10, true);
+ axis.toValue(10);
+ axis.toValue(10, true);
+ axis.update(<HighchartsAxisOptions>{});
+ axis.update(<HighchartsAxisOptions>{}, true);
+}
+
+function test_ChartObject() {
+ var chart = $("#container").highcharts();
+ chart.addAxis(<HighchartsAxisOptions>{});
+ chart.addAxis(<HighchartsAxisOptions>{}, true);
+ chart.addAxis(<HighchartsAxisOptions>{}, true, false);
+ chart.addAxis(<HighchartsAxisOptions>{}, true, true, false);
+ chart.addAxis(<HighchartsAxisOptions>{}, true, true, {duration: 50});
+ chart.addSeries(<HighchartsIndividualSeriesOptions>{});
+ chart.addSeries(<HighchartsIndividualSeriesOptions>{}, false);
+ chart.addSeries(<HighchartsIndividualSeriesOptions>{}, false, false);
+ chart.addSeries(<HighchartsIndividualSeriesOptions>{}, false, {duration: 50});
+ chart.addSeriesAsDrilldown(<HighchartsPointObject>{}, <HighchartsIndividualSeriesOptions>{});
+ var container = chart.container;
+ console.log(container.id);
+ chart.destroy();
+ chart.drillUp();
+ chart.exportChart(<HighchartsExportingOptions>{}, <HighchartsOptions>{});
+ var object = chart.get('axisIdOrSeriesIdOrPointId');
+ var svg1 = chart.getSVG();
+ var svg2 = chart.getSVG(<HighchartsOptions>{});
+ var selectedPoints = chart.getSelectedPoints();
+ var selectedSeries = chart.getSelectedSeries();
+ chart.hideLoading();
+ var options = chart.options;
+ chart.print();
+ chart.redraw();
+ chart.redraw(false);
+ chart.redraw({duration: 50, easing: 'fadeIn'});
+ chart.reflow();
+ var series = chart.series;
+ chart.setSize(200, 200);
+ chart.setSize(200, 200, false);
+ chart.setSize(200, 200, {duration: 50});
+ chart.setTitle({}, {});
+ chart.setTitle({}, {}, false);
+ chart.showLoading();
+ chart.showLoading("Loading label");
+ var firstXAxis = chart.xAxis[0];
+ var firstYAxis = chart.yAxis[0];
+}
+
+function test_ElementObject() {
+ var renderer = new Highcharts.Renderer($("#container")[0], 400, 400);
+ var group = renderer.g().add();
+ renderer
+ .circle(200, 150, 100)
+ .attr({
+ fill: '#FCFFC5',
+ stroke: 'black',
+ 'stroke-width': 1
+ })
+ .add(group);
+ var rect = renderer
+ .rect(90, 150, 100, 100, 5)
+ .attr({
+ fill: '#C5FFC5',
+ stroke: 'black',
+ 'stroke-width': 1
+ })
+ .add(group);
+ rect.animate({
+ x: 50,
+ y: 50,
+ width: 200,
+ height: 20,
+ 'stroke-width': 10
+ });
+ rect.destroy();
+ var styledText = renderer
+ .text('Series 1', 140, 140)
+ .attr({
+ rotation: -25
+ })
+ .css({
+ color: '#4572A7',
+ fontSize: '16px'
+ })
+ .add();
+ var bbox = styledText.getBBox();
+ styledText.on('click', () => {});
+ group.toFront();
+}
+
+function test_PointObject() {
+ var point = <HighchartsPointObject>$('#container').highcharts().get('point1');
+ var category = point.category;
+ var percentage = point.percentage;
+ point.remove();
+ point.remove(false);
+ point.remove(false, {duration: 50});
+ point.select();
+ point.select(false);
+ point.select(false, true);
+ var isSelected = point.selected;
+ var series = point.series;
+ point.slice();
+ point.slice(false);
+ point.slice(false, false);
+ point.slice(false, false, false);
+ point.slice(false, false, {duration: 50});
+ var total = point.total;
+ point.update(0);
+ point.update([0, 0]);
+ point.update({});
+ point.update({}, false);
+ point.update({}, false, false);
+ point.update({}, false, {duration: 50});
+ var x = point.x;
+ var y = point.y;
+}
+
+function test_RendererObject() {
+ var renderer = $('#container').highcharts().renderer;
+ renderer.arc(0, 0, 20, 10, 0, Math.PI);
+ renderer.circle(0, 0, 100);
+ renderer.g('groupName');
+ renderer.image('http://source', 20, 20, 100, 100);
+ renderer.label('Label', 200, 100, 'rect', 0, 0, false, false, 'class');
+ renderer.path(['M', 100, 100, 'L', 100, 200]);
+ renderer.rect(20, 20, 100, 100, 2);
+ renderer.text('text', 10, 10);
+}
+
+function test_SeriesObject() {
+ var series = <HighchartsSeriesObject>$('#container').highcharts().get('series1');
+ series.addPoint(0);
+ series.addPoint([0, 0]);
+ series.addPoint({});
+ series.addPoint({}, false);
+ series.addPoint({}, false, true);
+ series.addPoint({}, false, true, false);
+ series.addPoint({}, false, true, {duration: 50});
+ var chart = series.chart;
+ var data = series.data;
+ series.hide();
+ var name = series.name;
+ var options = series.options;
+ series.remove();
+ series.remove(false);
+ series.removePoint(0);
+ series.removePoint(0, false);
+ series.removePoint(0, false, false);
+ series.removePoint(0, false, {duration: 50});
+ series.select();
+ series.select(true);
+ var isSelected = series.selected;
+ series.setData([0, 1, 2]);
+ series.setData([[0, 0], [1, 1], [2, 2]]);
+ series.setData([{}, {}, {}]);
+ series.setData([0, 1, 2], false);
+ series.setData([0, 1, 2], false, false);
+ series.setData([0, 1, 2], false, {duration: 50});
+ series.setData([0, 1, 2], false, false, false);
+ series.setVisible();
+ series.setVisible(true);
+ series.setVisible(true, false);
+ series.show();
+ var type = series.type;
+ series.update({});
+ series.update({}, false);
+ var visible = series.visible;
+ var xAxis = series.xAxis;
+ var yAxis = series.yAxis;
+}
diff --git a/highcharts/highcharts.d.ts b/highcharts/highcharts.d.ts
index 16867937bb..bc0a8e9a0c 100644
--- a/highcharts/highcharts.d.ts
+++ b/highcharts/highcharts.d.ts
@@ -1,9 +1,9 @@
-// Type definitions for Highcharts 4.0.4
+// Type definitions for Highcharts 4.1.9
// Project: http://www.highcharts.com/
-// Definitions by: Damiano Gambarotto <http://github.com/damianog>
+// Definitions by: Damiano Gambarotto <http://github.com/damianog>, Dan Lewi Harkestad <http://github.com/baltie>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-/// <reference path="../jquery/jquery.d.ts" />
+/// <reference path='../jquery/jquery.d.ts' />
interface HighchartsPosition {
align?: string;
@@ -13,14 +13,38 @@ interface HighchartsPosition {
}
interface HighchartsDateTimeFormats {
- millisecond?: string; // '%H:%M:%S.%L'
- second?: string; // '%H:%M:%S'
- minute?: string; // '%H:%M'
- hour?: string; // '%H:%M'
- day?: string; // '%e. %b'
- week?: string; // '%e. %b'
- month?: string; // '%b \'%y'
- year?: string; // '%Y'
+ /**
+ * @default '%H:%M:%S.%L'
+ */
+ millisecond?: string;
+ /**
+ * @default '%H:%M:%S'
+ */
+ second?: string;
+ /**
+ * @default '%H:%M'
+ */
+ minute?: string;
+ /**
+ * @default '%H:%M'
+ */
+ hour?: string;
+ /**
+ * @default '%e. %b'
+ */
+ day?: string;
+ /**
+ * @default '%e. %b'
+ */
+ week?: string;
+ /**
+ * @default '%b \ '%y'
+ */
+ month?: string;
+ /**
+ * @default '%Y'
+ */
+ year?: string;
}
interface HighchartsAxisEvent extends Event {
@@ -29,217 +53,1659 @@ interface HighchartsAxisEvent extends Event {
}
interface HighchartsAxisLabels {
+ /**
+ * What part of the string the given position is anchored to. Can be one of 'left', 'center' or 'right'. Defaults to
+ * an intelligent guess based on which side of the chart the axis is on and the rotation of the label.
+ * @default 'center' on xAxis, 'right' on yAxis
+ */
align?: string;
+ /**
+ * For horizontal axes, the allowed degrees of label rotation to prevent overlapping labels. If there is enough
+ * space, labels are not rotated. As the chart gets narrower, it will start rotating the labels -45 degrees, then
+ * remove every second label and try again with rotations 0 and -45 etc. Set it to false to disable rotation, which
+ * will cause the labels to word-wrap if possible.
+ * @default [-45]
+ * @since 4.1.0
+ */
+ autoRotation?: number[];
+ /**
+ * When each category width is more than this many pixels, we don't apply auto rotation. Instead, we lay out the
+ * axis label with word wrap. A lower limit makes sense when the label contains multiple short words that don't
+ * extend the available horizontal space for each label.
+ * @default 80
+ * @since 4.1.5
+ */
+ autoRotationLimit?: number;
+ /**
+ * Polar charts only. The label's pixel distance from the perimeter of the plot area.
+ * @default 15
+ */
+ distance?: number;
+ /**
+ * Enable or disable the axis labels.
+ * @default true
+ */
enabled?: boolean;
+ /**
+ * A {@link http://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting|format string} for the axis label.
+ * @default '{value}'
+ * @since 3.0
+ */
+ format?: string;
+ /**
+ * Callback JavaScript function to format the label. The value is given by this.value. Additional properties for
+ * this are axis, chart, isFirst and isLast.
+ * @default function() {return this.value;}
+ */
formatter?: () => string;
- overflow?: string;
+ /**
+ * Horizontal axis only. When staggerLines is not set, maxStaggerLines defines how many lines the axis is allowed to
+ * add to automatically avoid overlapping X labels. Set to 1 to disable overlap detection.
+ * @default 5
+ * @since 3.0.3
+ * @deprecated
+ */
+ maxStaggerLines?: number;
+ /**
+ * How to handle overflowing labels on horizontal axis. Can be undefined, false or 'justify'. By default it aligns
+ * inside the chart area. If 'justify', labels will not render outside the plot area. If false, it will not be
+ * aligned at all. If there is room to move it, it will be aligned to the edge, else it will be removed.
+ * @since 2.2.5
+ * @deprecated
+ */
+ overflow?: string|boolean;
+ /**
+ * The pixel padding for axis labels, to ensure white space between them.
+ * @default 5
+ */
+ padding?: number;
+ /**
+ * Rotation of the labels in degrees.
+ * @default 0
+ */
rotation?: number;
+ /**
+ * Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels.
+ * @since 2.1
+ */
staggerLines?: number;
+ /**
+ * To show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label. By
+ * default, the step is calculated automatically to avoid overlap. To prevent this, set it to 1. This usually only
+ * happens on a category axis, and is often a sign that you have chosen the wrong axis type.
+ * Read more at {@link http://www.highcharts.com/docs/chart-concepts/axes|Axis docs} => What axis should I use?
+ * @since 2.1
+ */
step?: number;
+ /**
+ * CSS styles for the label. Use whiteSpace: 'nowrap' to prevent wrapping of category labels. Use textOverflow:
+ * 'none' to prevent ellipsis (dots).
+ * @default {'color':'#6D869F','fontWeight':'bold'}.
+ */
style?: HighchartsCSSObject;
+ /**
+ * Whether to use HTML to render the labels.
+ * @default false
+ */
useHTML?: boolean;
+ /**
+ * The x position offset of the label relative to the tick position on the axis.
+ * @default 0
+ */
x?: number;
+ /**
+ * The y position offset of the label relative to the tick position on the axis. The default makes it adapt to the
+ * font size on bottom axis.
+ * @default null
+ */
y?: number;
+ /**
+ * The Z index for the axis labels.
+ * @default 7
+ */
+ zIndex?: number;
}
interface HighchartsMousePlotEvents {
- click?: (event?: Event) => void;
- mouseover?: (event?: Event) => void;
- mouseout?: (event?: Event) => void;
- mousemove?: (event?: Event) => void;
+ click?: (event: Event) => void;
+ mouseover?: (event: Event) => void;
+ mouseout?: (event: Event) => void;
+ mousemove?: (event: Event) => void;
}
+/**
+ * Text labels for the plot bands
+ */
interface HighchartsPlotLabel {
+ /**
+ * Horizontal alignment of the label. Can be one of 'left', 'center' or 'right'.
+ * @default 'center'
+ * @since 2.1
+ */
align?: string;
+ /**
+ * Rotation of the text label in degrees.
+ * @default 0
+ * @since 2.1
+ */
rotation?: number;
+ /**
+ * CSS styles for the text label.
+ * @since 2.1
+ */
style?: HighchartsCSSObject;
+ /**
+ * The string text itself. A subset of HTML is supported.
+ * @since 2.1
+ */
text?: string;
- textAlign?: string; // "top", "middle" or "bottom
+ /**
+ * The text alignment for the label. While align determines where the texts anchor point is placed within the plot
+ * band, textAlign determines how the text is aligned against its anchor point. Possible values are 'left', 'center'
+ * and 'right'. Defaults to the same as the align option.
+ * @since 2.1
+ */
+ textAlign?: string;
+ /**
+ * Whether to {@link http://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html|use HTML} to render the labels.
+ * @default false
+ * @since 3.0.3
+ */
+ useHTML?: boolean;
+ /**
+ * Vertical alignment of the label relative to the plot band. Can be one of 'top', 'middle' or 'bottom'.
+ * @default 'top'
+ * @since 2.1
+ */
+ verticalAlign?: string;
+ /**
+ * Horizontal position relative the alignment. Default varies by orientation.
+ * @since 2.1
+ */
x?: number;
+ /**
+ * Vertical position of the text baseline relative to the alignment. Default varies by orientation.
+ * @since 2.1
+ */
y?: number;
}
interface HighchartsPlotBands {
- color?: string;
+ /**
+ * Border color for the plot band. Also requires borderWidth to be set.
+ * @default null
+ */
+ borderColor?: string;
+ /**
+ * Border width for the plot band. Also requires borderColor to be set.
+ * @default 0
+ */
+ borderWidth?: number;
+ /**
+ * The color of the plot band.
+ */
+ color?: string | HighchartsGradient;
+ /**
+ * An object defining mouse events for the plot band. Supported properties are click, mouseover, mouseout,
+ * mousemove.
+ * The this keyword refers to the PlotLineOrBand object.
+ * @since 1.2
+ */
events?: HighchartsMousePlotEvents;
+ /**
+ * The start position of the plot band in axis units.
+ */
from?: number;
+ /**
+ * An id used for identifying the plot band in Axis.removePlotBand.
+ */
id?: string;
+ /**
+ * In a gauge chart, this option determines the inner radius of the plot band that stretches along the perimeter. It
+ * can be given as a percentage string, like '100%', or as a pixel number, like 100. By default, the inner radius is
+ * controlled by the thickness option.
+ * Only defined for yAxis.plotBands
+ * @default null
+ * @since 2.3
+ */
+ innerRadius?: number|string;
+ /**
+ * Text labels for the plot bands
+ */
label?: HighchartsPlotLabel;
+ /**
+ * In a gauge chart, this option determines the outer radius of the plot band that stretches along the perimeter. It
+ * can be given as a percentage string, like '100%', or as a pixel number, like 100.
+ * Only defined for yAxis.plotBands
+ * @default '100%'
+ * @since 2.3
+ */
+ outerRadius?: number|string;
+ /**
+ * In a gauge chart, this option sets the width of the plot band stretching along the perimeter. It can be given as
+ * a percentage string, like '10%', or as a pixel number, like 10. The default value 10 is the same as the default
+ * tickLength, thus making the plot band act as a background for the tick markers.
+ * Only defined for yAxis.plotBands
+ * @default 10
+ * @since 2.3
+ */
+ thickness?: number|string;
+ /**
+ * The end position of the plot band in axis units.
+ */
to?: number;
+ /**
+ * The z index of the plot band within the chart, relative to other elements. Using the same z index as another
+ * element may give unpredictable results, as the last rendered element will be on top. Values from 0 to 20 make
+ * sense.
+ * @since 1.2
+ */
zIndex?: number;
}
+/**
+ * An array of lines stretching across the plot area, marking a specific value
+ * on one of the axes.
+ */
interface HighchartsPlotLines {
- color?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
+ /**
+ * The color of the line.
+ */
+ color?: string | HighchartsGradient;
+ /**
+ * The dashing or dot style for the plot line. For possible values see
+ * {@link http://jsfiddle.net/gh/get/jquery/1.7.1/highslide-software/highcharts.com/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/|this overview}.
+ * (Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot)
+ * @default 'Solid'
+ * @since 1.2
+ */
+ dashStyle?: string;
+ /**
+ * An object defining mouse events for the plot line. Supported properties are click, mouseover, mouseout,
+ * mousemove.
+ * The this keyword refers to the PlotLineOrBand object.
+ * @since 1.2
+ */
events?: HighchartsMousePlotEvents;
+ /**
+ * An id used for identifying the plot line in Axis.removePlotLine.
+ */
id?: string;
+ /**
+ * Text labels for the plot lines
+ */
label?: HighchartsPlotLabel;
+ /**
+ * The position of the line in axis units.
+ */
value?: number;
+ /**
+ * The width or thickness of the plot line.
+ */
width?: number;
+ /**
+ * The z index of the plot line within the chart.
+ * @since 1.2
+ */
zIndex?: number;
}
interface HighchartsAxisTitle {
+ /**
+ * Alignment of the title relative to the axis values. Possible values are 'low', 'middle' or 'high'.
+ * @default 'middle'
+ */
align?: string;
+ /**
+ * Set the text to null to disable the title.
+ * @default 'middle'
+ * @deprecated
+ */
+ enabled?: string;
+ /**
+ * The pixel distance between the axis labels or line and the title.
+ * @default xAxis: 0 for horizontal axes, 10 for vertical axes, yAxis: 40
+ */
margin?: number;
+ /**
+ * The distance of the axis title from the axis line. By default, this distance is computed from the offset width of
+ * the labels, the labels' distance from the axis and the title's margin. However when the offset option is set, it
+ * overrides all this.
+ * @since 2.2.0
+ */
offset?: number;
+ /**
+ * The rotation of the text in degrees. 0 is horizontal, 270 is vertical reading from bottom to top.
+ * @default xAxis: 0, yAxis: 270
+ */
rotation?: number;
+ /**
+ * CSS styles for the title. When titles are rotated they are rendered using vector graphic techniques and not all
+ * styles are applicable.
+ * @default { 'color': '#707070', 'fontWeight': 'bold' }.
+ */
style?: HighchartsCSSObject;
+ /**
+ * The actual text of the axis title. It can contain basic HTML text markup like <b>, <i> and spans with style.
+ * @default xAxis: null, yAxis: 'Values'
+ */
text?: string;
+ /**
+ * Horizontal pixel offset of the title position.
+ * @default 0
+ * @since 4.1.6
+ */
+ x?: number;
+ /**
+ * Vertical pixel offset of the title position.
+ */
+ y?: number;
+}
+
+interface HighchartsAxisBreak {
+ /**
+ * A number indicating how much space should be left between the start and the end of the break. The break size is
+ * given in axis units, so for instance on a datetime axis, a break size of 3600000 would indicate the equivalent of
+ * an hour.
+ * @default 0
+ * @since 4.1.0
+ */
+ breakSize?: number;
+ /**
+ * The point where the break starts.
+ * @since 4.1.0
+ */
+ from?: number;
+ /**
+ * Defines an interval after which the break appears again. By default the breaks do not repeat.
+ * @default 0
+ * @since 4.1.0
+ */
+ repeat?: number;
+ /**
+ * The point where the break ends.
+ * @since 4.1.0
+ */
+ to?: number;
}
interface HighchartsAxisOptions {
+ /**
+ * Whether to allow decimals in this axis' ticks. When counting integers,
+ * like persons or hits on a web page, decimals must be avoided in the axis
+ * tick labels.
+ * @default true
+ * @since 2.0
+ */
allowDecimals?: boolean;
+ /**
+ * When using an alternate grid color, a band is painted across the plot
+ * area between every other grid line.
+ */
alternateGridColor?: string;
+ /**
+ * An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to
+ * each other. Requires that the broken-axis.js module is loaded.
+ * @since 4.1.0
+ */
+ breaks?: HighchartsAxisBreak[];
+ /**
+ * If categories are present for the xAxis, names are used instead of numbers for that axis. Since Highcharts 3.0,
+ * categories can also be extracted by giving each point a name and setting axis type to category. However, if you
+ * have multiple series, best practice remains defining the categories array.
+ * Example:
+ * categories: ['Apples', 'Bananas', 'Oranges']
+ * @default null
+ */
categories?: string[];
+ /**
+ * The highest allowed value for automatically computed axis extremes.
+ * @since 4.0
+ */
+ ceiling?: number;
+ /**
+ * For a datetime axis, the scale will automatically adjust to the appropriate unit. This member gives the default
+ * string representations used for each unit. For an overview of the replacement codes, see dateFormat.
+ */
dateTimeLabelFormats?: HighchartsDateTimeFormats;
+ /**
+ * Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
+ * @default false
+ */
endOnTick?: boolean;
+ /**
+ * Event handlers for the axis
+ */
events?: {
+ /**
+ * An event fired after the breaks have rendered.
+ * @since 4.1.0
+ */
+ afterBreaks?: (event: Event) => void;
+ /**
+ * As opposed to the setExtremes event, this event fires after the final min and max values are computed and
+ * corrected for minRange.
+ * The this keyword refers to the {@link HighchartsAxisObject|Axis} object.
+ * @since 2.3
+ */
afterSetExtremes?: (event: HighchartsAxisEvent) => void;
+ /**
+ * An event fired when a break from this axis occurs on a point.
+ * The this keyword refers to the {@link HighchartsAxisObject|Axis} object.
+ */
+ pointBreak?: (event: Event) => void;
+ /**
+ * Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by
+ * selecting an area in the chart. One parameter, event, is passed to the function. This contains common event
+ * information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ *
+ * The new user set minimum and maximum values can be found by event.min and event.max. When an axis is zoomed
+ * all the way out from the 'Reset zoom' button, event.min and event.max are null, and the new extremes are set
+ * based on this.dataMin and this.dataMax.
+ *
+ * The this keyword refers to the {@link HighchartsAxisObject|Axis} object.
+ * @since 1.2.0
+ */
setExtremes?: (event: HighchartsAxisEvent) => void;
};
+ /**
+ * The lowest allowed value for automatically computed axis extremes.
+ * @default null
+ * @since 4.0
+ */
+ floor?: number;
+ /**
+ * Color of the grid lines extending the ticks across the plot area.
+ * @defaults to '#D8D8D8'.
+ */
gridLineColor?: string;
+ /**
+ * The dash or dot style of the grid lines. For possible values, see {@http://jsfiddle.net/gh/get/jquery/1.7.2/highslide-software/highcharts.com/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/|this demonstration}. Defaults to Solid.
+ * @since 1.2
+ */
gridLineDashStyle?: string;
+ /**
+ * The width of the grid lines extending the ticks across the plot area.
+ * @default 0
+ */
gridLineWidth?: number;
+ /**
+ * The Z index of the grid lines.
+ * @default 1
+ */
+ gridZIndex?: number;
+ /**
+ * An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
+ * @since 1.2.0
+ */
id?: string;
+ /**
+ * The axis labels show the number or category for each tick.
+ */
labels?: HighchartsAxisLabels;
+ /**
+ * The color of the line marking the axis itself.
+ * @default '#C0D0E0'.
+ */
lineColor?: string;
+ /**
+ * The width of the line marking the axis itself.
+ * @default 1
+ */
lineWidth?: number;
+ /**
+ * Index of another axis that this axis is linked to. When an axis is linked to a master axis, it will take the same
+ * extremes as the master, but as assigned by min or max or by setExtremes. It can be used to show additional info,
+ * or to ease reading the chart by duplicating the scales.
+ * @since 2.0.2
+ */
linkedTo?: number;
+ /**
+ * The maximum value of the axis. If null, the max value is automatically calculated. If the endOnTick option is
+ * true, the max value might be rounded up. The actual maximum value is also influenced by chart.alignTicks.
+ */
max?: number;
+ /**
+ * Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
+ * This is useful when you don't want the highest data value to appear on the edge of the plot area. When the axis'
+ * max option is set or a max extreme is set using axis.setExtremes(), the maxPadding will be ignored.
+ * @default 0.01
+ * @since 1.2.0
+ */
maxPadding?: number;
+ /**
+ * Renamed to minRange as of Highcharts 2.2.
+ * @deprecated
+ */
maxZoom?: number;
+ /**
+ * The minimum value of the axis. If null the min value is automatically calculated. If the startOnTick option is
+ * true, the min value might be rounded down.
+ */
min?: number;
+ /**
+ * Padding of the min value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
+ * This is useful when you don't want the lowest data value to appear on the edge of the plot area. When the axis'
+ * min option is set or a min extreme is set using axis.setExtremes(), the minPadding will be ignored.
+ * @default 0.01
+ * @since 1.2.0
+ */
minPadding?: number;
+ /**
+ * The minimum range to display on this axis. The entire axis will not be allowed to span over a smaller interval
+ * than this. For example, for a datetime axis the main unit is milliseconds. If minRange is set to 3600000, you
+ * can't zoom in more than to one hour.
+ *
+ * The default minRange for the x axis is five times the smallest interval between any of the data points.
+ *
+ * On a logarithmic axis, the unit for the minimum range is the power. So a minRange of 1 means that the axis can be
+ * zoomed to 10-100, 100-1000, 1000-10000 etc.
+ *
+ * Note that the minPadding, maxPadding, startOnTick and endOnTick settings also affect how the extremes of the axis
+ * are computed.
+ */
minRange?: number;
+ /**
+ * The minimum tick interval allowed in axis values. For example on zooming in on an axis with daily data, this can
+ * be used to prevent the axis from showing hours. Defaults to the closest distance between two points on the axis.
+ * @since 2.3.0
+ */
minTickInterval?: number;
+ /**
+ * Color of the minor, secondary grid lines.
+ * @default '#E0E0E0'
+ */
+ minorGridLineColor?: string;
+ /**
+ * The dash or dot style of the minor grid lines. For possible values, see {@link http://jsfiddle.net/gh/get/jquery/1.7.1/highslide-software/highcharts.com/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/|this demonstration}.
+ * @default 'Solid'
+ */
+ minorGridLineDashStyle?: string;
+ /**
+ * Width of the minor, secondary grid lines.
+ * @default 1
+ */
+ minorGridLineWidth?: number;
+ /**
+ * Color for the minor tick marks.
+ * @default to '#A0A0A0'
+ */
minorTickColor?: string;
+ /**
+ * Tick interval in scale units for the minor ticks. On a linear axis, if 'auto', the minor tick interval is
+ * calculated as a fifth of the tickInterval. If null, minor ticks are not shown.
+ *
+ * On logarithmic axes, the unit is the power of the value. For example, setting the minorTickInterval to 1 puts one
+ * tick on each of 0.1, 1, 10, 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1 and 10, 10
+ * and 100 etc. A minorTickInterval of 'auto' on a log axis results in a best guess, attempting to enter
+ * approximately 5 minor ticks between each major tick.
+ *
+ * If user settings dictate minor ticks to become too dense, they don't make sense, and will be ignored to prevent
+ * performance problems.
+ *
+ * On axes using categories, minor ticks are not supported.
+ */
minorTickInterval?: number|string;
+ /**
+ * The pixel length of the minor tick marks.
+ * @default 2
+ */
minorTickLength?: number;
- minorTickPosition?: string; // 'inside' 'outside'
+ /**
+ * The position of the minor tick marks relative to the axis line. Can be one of 'inside' and 'outside'.
+ * @default 'outside'
+ */
+ minorTickPosition?: string;
+ /**
+ * The pixel width of the minor tick mark.
+ * @default 0
+ */
minorTickWidth?: number;
+ /**
+ * The distance in pixels from the plot area to the axis line. A positive offset moves the axis with it's line,
+ * labels and ticks away from the plot area. This is typically used when two or more axes are displayed on the same
+ * side of the plot.
+ * @default 0
+ */
offset?: number;
+ /**
+ * Whether to display the axis on the opposite side of the normal. The normal is on the left side for vertical axes
+ * and bottom for horizontal, so the opposite sides will be right and top respectively. This is typically used with
+ * dual or multiple axes.
+ * @default false
+ */
opposite?: boolean;
- plotBands?: HighchartsPlotBands;
- plotLines?: HighchartsPlotLines;
+ /**
+ * An array of colored bands stretching across the plot area marking an interval on the axis.
+ *
+ * In a gauge, a plot band on the Y axis (value axis) will stretch along the perimeter of the gauge.
+ */
+ plotBands?: HighchartsPlotBands[];
+ /**
+ * An array of lines stretching across the plot area, marking a specific value on one of the axes.
+ */
+ plotLines?: HighchartsPlotLines[];
+ /**
+ * Whether to reverse the axis so that the highest number is closest to the origin. If the chart is inverted, the x
+ * axis is reversed by default.
+ * @default false
+ */
reversed?: boolean;
+ /**
+ * Whether to show the axis line and title when the axis has no data.
+ * @default true
+ * @since 1.1
+ */
showEmpty?: boolean;
+ /**
+ * Whether to show the first tick label.
+ * @default true
+ */
showFirstLabel?: boolean;
+ /**
+ * Whether to show the last tick label.
+ * @default true
+ */
showLastLabel?: boolean;
+ /**
+ * For datetime axes, this decides where to put the tick between weeks. 0 = Sunday, 1 = Monday.
+ * @default 1
+ */
startOfWeek?: number;
+ /**
+ * Whether to force the axis to start on a tick. Use this option with the minPadding option to control the axis
+ * start.
+ * @default false
+ * @since 1.2.0
+ */
startOnTick?: boolean;
+ /**
+ * The amount of ticks to draw on the axis. This opens up for aligning the ticks of multiple charts or panes within
+ * a chart. This option overrides the tickPixelInterval option.
+ *
+ * This option only has an effect on linear axes. Datetime, logarithmic or category axes are not affected.
+ */
+ tickAmount?: number;
+ /**
+ * Color for the main tick marks.
+ * @default '#C0D0E0'
+ */
tickColor?: string;
+ /**
+ * The interval of the tick marks in axis units. When null, the tick interval is computed to approximately follow
+ * the tickPixelInterval on linear and datetime axes. On categorized axes, a null tickInterval will default to 1,
+ * one category. Note that datetime axes are based on milliseconds, so for example an interval of one day is
+ * expressed as 24 * 3600 * 1000.
+ *
+ * On logarithmic axes, the tickInterval is based on powers, so a tickInterval of 1 means one tick on each of 0.1,
+ * 1, 10, 100 etc. A tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of 0.2 puts a tick on 0.1,
+ * 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40 etc.
+ *
+ * If the tickInterval is too dense for labels to be drawn, Highcharts may remove ticks.
+ */
tickInterval?: number;
+ /**
+ * The pixel length of the main tick marks.
+ * @default 10
+ */
tickLength?: number;
+ /**
+ * If tickInterval is null this option sets the approximate pixel interval of the tick marks. Not applicable to
+ * categorized axis.
+ *
+ * @default 72 for the Y axis, 100 for the X axis.
+ */
tickPixelInterval?: number;
- tickPosition?: string; // "inside" or "outside"
+ /**
+ * The position of the major tick marks relative to the axis line. Can be one of 'inside' and 'outside'.
+ * @default 'outside'
+ */
+ tickPosition?: string;
+ /**
+ * A callback function returning array defining where the ticks are laid out on the axis. This overrides the default
+ * behaviour of tickPixelInterval and tickInterval. The automatic tick positions are accessible through
+ * this.tickPositions and can be modified by the callback.
+ */
+ tickPositioner?: (min: number, max: number) => void;
+ /**
+ * An array defining where the ticks are laid out on the axis. This overrides the default behaviour of
+ * tickPixelInterval and tickInterval.
+ */
+ tickPositions?: number[];
+ /**
+ * The pixel width of the major tick marks.
+ * @default 1
+ */
tickWidth?: number;
- tickmarkPlacement?: string; // "between" or "on"
+ /**
+ * For categorized axes only. If 'on' the tick mark is placed in the center of the category, if 'between' the tick
+ * mark is placed between categories. The default is 'between' if the tickInterval is 1, else 'on'.
+ * @default null
+ */
+ tickmarkPlacement?: string;
+ /**
+ * The axis title, showing next to the axis line.
+ */
title?: HighchartsAxisTitle;
- type?: string; // "linear", "logarithmic" or "datetime"
+ /**
+ * The type of axis. Can be one of 'linear', 'logarithmic', 'datetime' or 'category'. In a datetime axis, the
+ * numbers are given in milliseconds, and tick marks are placed on appropriate values like full hours or days. In a
+ * category axis, the point names of the chart's series are used for categories, if not a categories array is
+ * defined.
+ * @default 'linear'
+ */
+ type?: string;
+ /**
+ * Datetime axis only. An array determining what time intervals the ticks are allowed to fall on. Each array item is
+ * an array where the first value is the time unit and the second value another array of allowed multiples.
+ */
+ units?: [[string, [number]]];
+ /**
+ * Whether axis, including axis title, line, ticks and labels, should be visible.
+ * @default true
+ * @since 4.1.9
+ */
+ visible?: boolean;
+}
+
+interface HighchartsColorAxisDataClass {
+ from?: number;
+ to?: number;
+ color?: string;
+ name?: string;
+}
+
+/**
+ * A color axis for choropleth mapping. Visually, the color axis will appear as a gradient or as separate items inside
+ * the legend, depending on whether the axis is scalar or based on data classes.
+ *
+ * For supported color formats, see the docs article about colors.
+ *
+ * A scalar color axis is represented by a gradient. The colors either range between the minColor and the maxColor, or
+ * for more fine grained control the colors can be defined in stops. Often times, the color axis needs to be adjusted to
+ * get the right color spread for the data. In addition to stops, consider using a logarithmic axis type, or setting min
+ * and max to avoid the colors being determined by outliers.
+ *
+ * When dataClasses are used, the ranges are subdivided into separate classes like categories based on their values.
+ * This can be used for ranges between two values, but also for a true category. However, when your data is categorized,
+ * it may be as convenient to add each category to a separate series.
+ *
+ * See the Axis object for programmatic access to the axis.
+ */
+interface HighchartsColorAxisOptions {
+ /**
+ * Determines how to set each data class' color if no individual color is set. The default value, tween, computes
+ * intermediate colors between minColor and maxColor. The other possible value, category, pulls colors from the
+ * global or chart specific colors array.
+ * @default 'tween'
+ */
+ dataClassColor?: string;
+ /**
+ * An array of data classes or ranges for the choropleth map. If none given, the color axis is scalar and values are
+ * distributed as a gradient between the minimum and maximum colors.
+ */
+ dataClasses?: HighchartsColorAxisDataClass[];
+ /**
+ * Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
+ * @default true
+ */
+ endOnTick?: boolean;
+ events?: {
+ /**
+ * As opposed to the setExtremes event, this event fires after the final min and max values are computed and
+ * corrected for minRange.
+ * The this keyword refers to the {@link HighchartsAxisObject|Axis} object.
+ */
+ afterSetExtremes?: (event: HighchartsAxisEvent) => void;
+ /**
+ * Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by
+ * selecting an area in the chart. One parameter, event, is passed to the function. This contains common event
+ * information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ *
+ * The new user set minimum and maximum values can be found by event.min and event.max. When an axis is zoomed
+ * all the way out from the 'Reset zoom' button, event.min and event.max are null, and the new extremes are set
+ * based on this.dataMin and this.dataMax.
+ *
+ * The this keyword refers to the {@link HighchartsAxisObject|Axis} object.
+ */
+ setExtremes?: (event: HighchartsAxisEvent) => void;
+ };
+ /**
+ * Color of the grid lines extending from the axis across the gradient.
+ * @default '#C0C0C0'
+ */
+ gridLineColor?: string;
+ /**
+ * The dash or dot style of the grid lines.
+ * @default 'Solid'
+ */
+ gridLineDashStyle?: string;
+ /**
+ * The width of the grid lines extending from the axis across the gradient of a scalar color axis.
+ * @default 1
+ */
+ gridLineWidth?: number;
+ /**
+ * An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
+ */
+ id?: string;
+ /**
+ * The axis labels show the number for each tick.
+ */
+ labels?: HighchartsAxisLabels;
+ /**
+ * The color of the line marking the axis itself.
+ * @default '#C0D0E0'
+ */
+ lineColor?: string;
+ /**
+ * The width of the line marking the axis itself.
+ * @default 0
+ */
+ lineWidth?: number;
+ /**
+ * The triangular marker on a scalar color axis that points to the value of the hovered area. To disable the marker,
+ * set marker: null.
+ */
+ marker?: {
+ /**
+ * Animation for the marker as it moves between values. Set to false to disable animation.
+ * @default {duration: 50}
+ */
+ animation?: boolean | HighchartsAnimation;
+ /**
+ * The color of the marker.
+ * @default 'gray'
+ */
+ color?: string;
+ };
+ /**
+ * The maximum value of the axis in terms of map point values. If null, the max value is automatically calculated.
+ * If the endOnTick option is true, the max value might be rounded up.
+ */
+ max?: number;
+ /**
+ * The color to represent the maximum of the color axis. Unless dataClasses or stops are set, the gradient ends at
+ * this value.
+ *
+ * If dataClasses are set, the color is based on minColor and maxColor unless a color is set for each data class, or
+ * the dataClassColor is set.
+ * @default '#102D4C'
+ */
+ maxColor?: string;
+ /**
+ * Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
+ * @default 0.05
+ */
+ maxPadding?: number;
+ /**
+ * The minimum value of the axis in terms of map point values. If null, the min value is automatically calculated.
+ * If the startOnTick option is true, the min value might be rounded down.
+ */
+ min?: number;
+ /**
+ * The color to represent the minimum of the color axis. Unless dataClasses or stops are set, the gradient starts at
+ * this value.
+ *
+ * If dataClasses are set, the color is based on minColor and maxColor unless a color is set for each data class, or
+ * the dataClassColor is set.
+ * @default '#EFEFFF'
+ */
+ minColor?: string;
+ /**
+ * Padding of the min value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
+ * @default 0.05
+ */
+ minPadding?: number;
+ /**
+ * Color of the minor, secondary grid lines.
+ * @default '#E0E0E0'
+ */
+ minorGridLineColor?: string;
+ /**
+ * The dash or dot style of the minor grid lines.
+ * @default 'Solid'
+ */
+ minorGridLineDashStyle?: string;
+ /**
+ * Width of the minor, secondary grid lines.
+ * @default 1
+ */
+ minorGridLineWidth?: number;
+ /**
+ * Color for the minor tick marks.
+ * @default '#A0A0A0'
+ */
+ minorTickColor?: string;
+ /**
+ * Tick interval in scale units for the minor ticks. On a linear axis, if 'auto', the minor tick interval is
+ * calculated as a fifth of the tickInterval. If null, minor ticks are not shown.
+ *
+ * On logarithmic axes, the unit is the power of the value. For example, setting the minorTickInterval to 1 puts one
+ * tick on each of 0.1, 1, 10, 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1 and 10, 10
+ * and 100 etc. A minorTickInterval of 'auto' on a log axis results in a best guess, attempting to enter
+ * approximately 5 minor ticks between each major tick.
+ *
+ * If user settings dictate minor ticks to become too dense, they don't make sense, and will be ignored to prevent
+ * performance problems.
+ */
+ minorTickInterval?: string | number;
+ /**
+ * The pixel length of the minor tick marks.
+ * @default 2
+ */
+ minorTickLength?: number;
+ /**
+ * The position of the minor tick marks relative to the axis line. Can be one of inside and outside.
+ * @default 'outside'
+ */
+ minorTickPosition?: string;
+ /**
+ * The pixel width of the minor tick mark
+ * @default 0
+ */
+ minorTickWidth?: number;
+ /**
+ * Whether to reverse the axis so that the highest number is closest to the origin. Defaults to false in a
+ * horizontal legend and true in a vertical legend, where the smallest value starts on top.
+ */
+ reversed?: boolean;
+ /**
+ * If labels are enabled, whether to show the first tick label.
+ * @default true
+ */
+ showFirstLabel?: boolean;
+ /**
+ * If labels are enabled, whether to show the last tick label.
+ * @default true
+ */
+ showLastLabel?: boolean;
+ /**
+ * Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis
+ * start.
+ * @default true
+ */
+ startOnTick?: boolean;
+ /**
+ * Color stops for the gradient of a scalar color axis. Use this in cases where a linear gradient between a minColor
+ * and maxColor is not sufficient. The stops is an array of tuples, where the first item is a float between 0 and 1
+ * assigning the relative position in the gradient, and the second item is the color.
+ */
+ stops?: [number, string][];
+ /**
+ * Color for the main tick marks.
+ * @default '#C0D0E0'
+ */
+ tickColor?: string;
+ /**
+ * The interval of the tick marks in axis units. When null, the tick interval is computed to approximately follow
+ * the tickPixelInterval.
+ */
+ tickInterval?: number;
+ /**
+ * The pixel length of the main tick marks.
+ * @default 10
+ */
+ tickLength?: number;
+ /**
+ * If tickInterval is null this option sets the approximate pixel interval of the tick marks.
+ * @default 72
+ */
+ tickPixelInterval?: number;
+ /**
+ * The position of the major tick marks relative to the axis line. Can be one of 'inside' and 'outside'.
+ * @default 'outside'
+ */
+ tickPosition?: string;
+ /**
+ * A callback function returning array defining where the ticks are laid out on the axis. This overrides the default
+ * behaviour of tickPixelInterval and tickInterval.
+ */
+ tickPositioner?: (min: number, max: number) => void;
+ /**
+ * An array defining where the ticks are laid out on the axis. This overrides the default behaviour of
+ * tickPixelInterval and tickInterval.
+ */
+ tickPositions?: number[];
+ /**
+ * The pixel width of the major tick marks.
+ * @default 0
+ */
+ tickWidth?: number;
+ /**
+ * The type of interpolation to use for the color axis. Can be 'linear' or 'logarithmic'.
+ * @default 'linear'
+ */
+ type?: string;
}
interface HighchartsExtremes {
+ /**
+ * The maximum value of the axis' associated series.
+ */
dataMax: number;
+ /**
+ * The minimum value of the axis' associated series.
+ */
dataMin: number;
+ /**
+ * The maximum axis value, either automatic or set manually. If the max option is not set and maxPadding is 0, this
+ * value will be the same as dataMax.
+ */
max: number;
+ /**
+ * The minimum axis value, either automatic or set manually. If the min option is not set and minPadding is 0, this
+ * value will be the same as dataMin.
+ */
min: number;
}
interface HighchartsAnimation {
+ /**
+ * The duration of the animation in milliseconds.
+ */
duration?: number;
- easing?: string; // "linear" | "swing"
+ /**
+ * When using jQuery as the general framework, the easing can be set to linear or swing. More easing functions are
+ * available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the
+ * {@link http://api.jquery.com/animate/|jQuery docs}. When using MooTools as the general framework, use the
+ * property name transition instead of easing.
+ */
+ easing?: string;
}
-interface HighchartsSelectionEvent extends Event {
+interface HighchartsAddSeriesEvent extends Event {
+ /**
+ * The series options that was passed to the addSeries method.
+ */
+ options: HighchartsChartOptions;
+}
+
+interface HighchartsAxisValueOptions extends HighchartsAxisOptions {
+ /**
+ * The axis value at the clicked spot
+ */
+ value: number;
+}
+
+interface HighchartsChartClickEvent extends Event {
+ /**
+ * Array containing the axes of each dimension and each axis' value at the clicked spot
+ */
+ xAxis: HighchartsAxisValueOptions[];
+ /**
+ * Array containing the axes of each dimension and each axis' value at the clicked spot
+ */
+ yAxis: HighchartsAxisValueOptions[];
+}
+
+interface HighchartsChartDrilldownEvent extends Event {
+ /**
+ * If a category label was clicked, which index.
+ */
+ category?: number;
+ /**
+ * The originating point.
+ */
+ point?: HighchartsPointObject;
+ /**
+ * If a category label was clicked, this array holds all points corresponing to the category.
+ */
+ points?: HighchartsPointObject[];
+ /**
+ * Options for the new series.
+ */
+ seriesOptions?: HighchartsIndividualSeriesOptions;
+}
+
+interface HighchartsChartSelectionEvent extends Event {
+ /**
+ * Array containing the axes of each dimension and each axis' min and max values
+ */
xAxis: HighchartsAxisOptions[];
+ /**
+ * Array containing the axes of each dimension and each axis' min and max values
+ */
yAxis: HighchartsAxisOptions[];
}
interface HighchartsChartEvents {
- addSeries?: (event?: Event) => boolean;
- click?: (event?: Event) => void;
- load?: (event?: Event) => void;
+ /**
+ * Fires when a series is added to the chart after load time, using the addSeries method. One parameter, event, is
+ * passed to the function. This contains common event information based on jQuery or MooTools depending on which
+ * library is used as the base for Highcharts. Through event.options you can access the series options that was
+ * passed to the addSeries method. Returning false prevents the series from being added.
+ *
+ * The this keyword refers to the Chart object.
+ * @since 1.2.0
+ */
+ addSeries?: (event: HighchartsAddSeriesEvent) => boolean|void;
+ /**
+ * Fires after a chart is printed through the context menu item or the Chart.print method. Requires the exporting
+ * module.
+ * @since 4.1.0
+ */
+ afterPrint?: (event: Event) => void;
+ /**
+ * Fires before a chart is printed through the context menu item or the Chart.print method. Requires the exporting
+ * module.
+ * @since 4.1.0
+ */
+ beforePrint?: (event: Event) => void;
+ /**
+ * Fires when clicking on the plot background. One parameter, event, is passed to the function. This contains common
+ * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ *
+ * Information on the clicked spot can be found through event.xAxis and event.yAxis, which are arrays containing the
+ * axes of each dimension and each axis' value at the clicked spot. The primary axes are event.xAxis[0] and
+ * event.yAxis[0]. Remember the unit of a datetime axis is milliseconds since 1970-01-01 00:00:00.
+ *
+ * click: function(e) {
+ * console.log(Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', e.xAxis[0].value), e.yAxis[0].value);
+ * }
+ *
+ * The this keyword refers to the Chart object.
+ * @since 1.2.0
+ */
+ click?: (event: HighchartsChartClickEvent) => void;
+ /**
+ * Fires when a drilldown point is clicked, before the new series is added.
+ * @since 3.0.8
+ */
+ drilldown?: (event: HighchartsChartDrilldownEvent) => void;
+ /**
+ * Fires when drilling up from a drilldown series.
+ * @since 3.0.8
+ */
+ drillup?: (event: Event) => void;
+ /**
+ * Fires when the chart is finished loading. One parameter, event, is passed to the function. This contains common
+ * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ *
+ * From version 2.0.4, there is also a second parameter to Highcharts.Chart where a callback function can be passed
+ * to be executed on chart.load.
+ *
+ * The this keyword refers to the Chart object.
+ */
+ load?: (event: Event) => void;
+ /**
+ * Fires when the chart is redrawn, either after a call to chart.redraw() or after an axis, series or point is
+ * modified with the redraw option set to true. One parameter, event, is passed to the function. This contains
+ * common event information based on jQuery or MooTools depending on which library is used as the base for
+ * Highcharts.
+ *
+ * The this keyword refers to the Chart object.
+ * @since 1.2.0
+ */
redraw?: (event: Event) => void;
- selection?: (event: HighchartsSelectionEvent) => void;
+ /**
+ * Fires when an area of the chart has been selected. Selection is enabled by setting the chart's zoomType. One
+ * parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools
+ * depending on which library is used as the base for Highcharts. The default action for the selection event is to
+ * zoom the chart to the selected area. It can be prevented by calling event.preventDefault().
+ *
+ * Information on the selected area can be found through event.xAxis and event.yAxis, which are arrays containing
+ * the axes of each dimension and each axis' min and max values. The primary axes are event.xAxis[0] and
+ * event.yAxis[0]. Remember the unit of a datetime axis is milliseconds since 1970-01-01 00:00:00.
+ *
+ * selection: function(event) {
+ * // log the min and max of the primary, datetime x-axis
+ * console.log(
+ * Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', event.xAxis[0].min),
+ * Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', event.xAxis[0].max)
+ * );
+ * // log the min and max of the y axis
+ * console.log(event.yAxis[0].min, event.yAxis[0].max);
+ * }
+ */
+ selection?: (event: HighchartsChartSelectionEvent) => void;
+}
+
+interface HighchartsLinearGradient {
+ x1: number;
+ y1: number;
+ x2: number;
+ y2: number;
}
interface HighchartsGradient {
- linearGradient?: {
- x1: number; y1: number; x2: number; y2: number;
- };
+ linearGradient?: HighchartsLinearGradient | number[];
radialGradient?: {
cx: number; cy: number; r: number;
};
stops?: any[][];
- brighten? (amount: number): string | HighchartsGradient;
- get? (type: string): string;
+ /**
+ * Brighten the color
+ * @param {number} alpha
+ */
+ brighten?(alpha: number): HighchartsGradient;
+ /**
+ * Return the color a specified format
+ * @param {string} format
+ */
+ get?(format: string): string;
+ /**
+ * The raw input
+ */
+ raw?: string;
+ /**
+ * rgba array
+ */
+ rgba?: number[];
+ /**
+ * Set the color's opacity to a given alpha value
+ * @param {number} alpha
+ * @return {HighchartsGradient}
+ */
+ setOpacity?(alpha: number): HighchartsGradient;
+}
+
+interface HighchartsChartOptions3dFrame {
+ /**
+ * The color of the panel.
+ * @default 'transparent'
+ * @since 4.0
+ */
+ color?: string | HighchartsGradient,
+ /**
+ * Thickness of the panel.
+ * @default 1
+ * @since 4.0
+ */
+ size?: number;
+}
+
+interface HighchartsChartOptions3d {
+ /**
+ * One of the two rotation angles for the chart.
+ * @default 0
+ * @since 4.0
+ */
+ alpha?: number;
+ /**
+ * One of the two rotation angles for the chart.
+ * @default 0
+ * @since 4.0
+ */
+ beta?: number;
+ /**
+ * The total depth of the chart.
+ * @default 100
+ * @since 4.0
+ */
+ depth?: number;
+ /**
+ * Wether to render the chart using the 3D functionality.
+ * @default false
+ * @since 4.0
+ */
+ enabled?: boolean;
+ /**
+ * Provides the option to draw a frame around the charts by defining a bottom, front and back panel.
+ */
+ frame?: {
+ /**
+ * Defines the back panel of the frame around 3D charts.
+ * @since 4.0
+ */
+ back?: HighchartsChartOptions3dFrame;
+ /**
+ * The bottom of the frame around a 3D chart.
+ * @since 4.0
+ */
+ bottom?: HighchartsChartOptions3dFrame;
+ /**
+ * The side for the frame around a 3D chart.
+ * @since 4.0
+ */
+ side?: HighchartsChartOptions3dFrame;
+ };
+ /**
+ * Defines the distance the viewer is standing in front of the chart, this setting is important to calculate the
+ * perspective effect in column and scatter charts. It is not used for 3D pie charts.
+ * @default 100
+ * @since 4.0
+ */
+ viewDistance?: number;
}
interface HighchartsShadow {
+ /**
+ * @default 'black'
+ */
color?: string;
+ /**
+ * @default 1
+ */
offsetX?: number;
+ /**
+ * @default 1
+ */
offsetY?: number;
+ /**
+ * @default 0.15 / width
+ */
opacity?: number;
+ /**
+ * @default 3
+ */
width?: number;
}
interface HighchartsChartResetZoomButton {
- position: HighchartsPosition;
+ /**
+ * The position of the button. This is an object that can hold the properties align, verticalAlign, x and y.
+ * @since 2.2
+ */
+ position?: HighchartsPosition;
+ /**
+ * What frame the button should be placed related to. Can be either 'plot' or 'chart'.
+ * @default 'plot'
+ * @since 2.2
+ */
relativeTo?: string;
- theme?: HighchartsChartResetZoomButtonTheme;
+ /**
+ * A collection of attributes for the button. The object takes SVG attributes like fill, stroke, stroke-width or r,
+ * the border radius. The theme also supports style, a collection of CSS properties for the text. Equivalent
+ * attributes for the hover state are given in theme.states.hover.
+ * @since 2.2
+ */
+ theme?: HighchartsButtonStatesTheme;
}
-interface HighchartsChartResetZoomButtonTheme {
- fill?: string; //css HEX colours.
- stroke?: string;//css HEX colours.
- r?: number; // Radius %
- states?: any; // HTML element states eg: hover, with css attributes in object.
+interface HighchartsButtonTheme {
display?: string; // css attr eg: 'none'
+ /**
+ * The button fill color, SVG color definition
+ */
+ fill?: string | HighchartsGradient;
+ /**
+ * The button stroke color, SVG color definition
+ */
+ stroke?: string;
+ /**
+ * The button stroke width
+ * @type {[type]}
+ */
+ 'stroke-width'?: number;
+ /**
+ * The border radius
+ */
+ r?: number;
+ /**
+ * CSS style
+ */
+ style?: Object;
+}
+
+interface HighchartsButtonStatesTheme extends HighchartsButtonTheme {
+ /**
+ * Themed button states. Only hover is supported for reset zoom button.
+ */
+ states?: {
+ /**
+ * Attributes and styles applied when hovering.
+ */
+ hover?: HighchartsButtonTheme;
+ /**
+ * Attributes and styles applied when button is selected (tri-state).
+ */
+ select?: HighchartsButtonTheme;
+ };
}
interface HighchartsChartOptions {
+ /**
+ * When using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to
+ * the axis or axes with the least ticks. This can be prevented by setting alignTicks to false. If the grid lines
+ * look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0.
+ * @default true
+ */
alignTicks?: boolean;
+ /**
+ * Set the overall animation for all chart updating. Animation can be disabled throughout the chart by setting it to
+ * false here. It can be overridden for each individual API method as a function parameter. The only animation not
+ * affected by this option is the initial series animation, see plotOptions.series.animation.
+ *
+ * The animation can either be set as a boolean or a configuration object. If true, it will use the 'swing' jQuery
+ * easing and a duration of 500 ms.
+ *
+ * @default true
+ */
animation?: boolean | HighchartsAnimation;
+ /**
+ * The background color or gradient for the outer chart area.
+ * @default '#FFFFFF'
+ */
backgroundColor?: string | HighchartsGradient;
+ /**
+ * The color of the outer chart border.
+ * @default '#4572A7'
+ */
borderColor?: string;
+ /**
+ * The corner radius of the outer chart border.
+ * @default 0
+ */
borderRadius?: number;
+ /**
+ * The pixel width of the outer chart border.
+ * @default 0
+ */
borderWidth?: number;
+ /**
+ * A CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
+ */
className?: string;
+ /**
+ * Alias of type. Defaults to line.
+ * @default 'line'
+ * @deprecated
+ */
defaultSeriesType?: string;
+ /**
+ * Event listeners for the chart.
+ */
events?: HighchartsChartEvents;
+ /**
+ * An explicit height for the chart. By default the height is calculated from the offset height of the containing
+ * element, or 400 pixels if the containing element's height is 0.
+ */
height?: number;
+ /**
+ * If true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and
+ * showing a series will not affect the axes or the other series. For stacks, once one series within the stack is
+ * hidden, the rest of the stack will close in around it even if the axis is not affected.
+ * @default true
+ * @since 1.2.0
+ */
ignoreHiddenSeries?: boolean;
+ /**
+ * Whether to invert the axes so that the x axis is vertical and y axis is horizontal. When true, the x axis is
+ * reversed by default. If a bar series is present in the chart, it will be inverted automatically.
+ * @default false
+ */
inverted?: boolean;
- margin?: number[];
+ /**
+ * The margin between the outer edge of the chart and the plot area. The numbers in the array designate top, right,
+ * bottom and left respectively. Use the options marginTop, marginRight, marginBottom and marginLeft for shorthand
+ * setting of one option.
+ *
+ * Since version 2.1, the margin is 0 by default. The actual space is dynamically calculated from the offset of axis
+ * labels, axis title, title, subtitle and legend in addition to the spacingTop, spacingRight, spacingBottom and
+ * spacingLeft options.
+ */
+ margin?: number | number[];
+ /**
+ * The margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed pixel value for
+ * the margin as opposed to the default dynamic margin. See also spacingBottom.
+ * @since 2.0
+ */
marginBottom?: number;
+ /**
+ * The margin between the left outer edge of the chart and the plot area. Use this to set a fixed pixel value for
+ * the margin as opposed to the default dynamic margin. See also spacingLeft.
+ * @since 2.0
+ */
marginLeft?: number;
+ /**
+ * The margin between the right outer edge of the chart and the plot area. Use this to set a fixed pixel value for
+ * the margin as opposed to the default dynamic margin. See also spacingRight.
+ * @since 2.0
+ */
marginRight?: number;
+ /**
+ * The margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the
+ * margin as opposed to the default dynamic margin. See also spacingTop.
+ * @since 2.0
+ */
marginTop?: number;
+ /**
+ * Options to render charts in 3 dimensions. This feature requires highcharts-3d.js, found in the download package
+ * or online at {@link code.highcharts.com/highcharts-3d.js}.
+ */
+ options3d?: HighchartsChartOptions3d;
+ /**
+ * Allows setting a key to switch between zooming and panning.
+ * @since 4.0.3
+ */
panKey?: string;
- panning?: number;
+ /**
+ * Allow panning in a chart. Best used with panKey to combine zooming and panning.
+ * @default false
+ * @since 4.0.3
+ */
+ panning?: boolean;
+ /**
+ * Equivalent to zoomType, but for multitouch gestures only. By default, the pinchType is the same as the zoomType
+ * setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse
+ * drag pans the chart, while pinching is enabled.
+ * @default null
+ * @since 3.0
+ */
pinchType?: string;
+ /**
+ * The background color or gradient for the plot area.
+ */
plotBackgroundColor?: string | HighchartsGradient;
+ /**
+ * The URL for an image to use as the plot background. To set an image as the background for the entire chart, set a
+ * CSS background image to the container element. Note that for the image to be applied to exported charts, its URL
+ * needs to be accessible by the export server.
+ */
plotBackgroundImage?: string;
+ /**
+ * The color of the inner chart or plot area border.
+ * @default 0
+ */
plotBorderColor?: string;
+ /**
+ * The pixel width of the plot area border.
+ * @default 0
+ */
plotBorderWidth?: number;
+ /**
+ * Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. Since 2.3 the shadow
+ * can be an object configuration containing color, offsetX, offsetY, opacity and width.
+ * @default false
+ */
plotShadow?: boolean | HighchartsShadow;
+ /**
+ * When true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
+ * Requires highcharts-more.js.
+ * @default false
+ * @since 2.3.0
+ */
polar?: boolean;
+ /**
+ * Whether to reflow the chart to fit the width of the container div on resizing the window.
+ * @default true
+ * @since 2.1
+ */
reflow?: boolean;
- renderTo?: any;
+ /**
+ * The HTML element where the chart will be rendered. If it is a string, the element by that id is used. The HTML
+ * element can also be passed by direct reference.
+ */
+ renderTo?: string | HTMLElement;
+ /**
+ * The button that appears after a selection zoom, allowing the user to reset zoom.
+ */
resetZoomButton?: HighchartsChartResetZoomButton;
+ /**
+ * The background color of the marker square when selecting (zooming in on) an area of the chart.
+ * @default 'rgba(69,114,167,0.25)'
+ * @since 2.1.7
+ */
selectionMarkerFill?: string;
+ /**
+ * Whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set. Since 2.3 the
+ * shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
+ * @default false
+ */
shadow?: boolean | HighchartsShadow;
+ /**
+ * Whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes
+ * are automatically added to cartesian series.
+ * @default false
+ * @since 1.2.5
+ */
showAxes?: boolean;
+ /**
+ * The distance between the outer edge of the chart and the content, like title, legend, axis title or labels. The
+ * numbers in the array designate top, right, bottom and left respectively. Use the options spacingTop,
+ * spacingRight, spacingBottom and spacingLeft options for shorthand setting of one option.
+ * @default [10, 10, 15, 10]
+ * @since 3.0.6
+ */
spacing?: number[];
+ /**
+ * The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle
+ * or legend in top position).
+ * @default 15
+ * @since 2.1
+ */
spacingBottom?: number;
+ /**
+ * The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle
+ * or legend in top position).
+ * @default 10
+ * @since 2.1
+ */
spacingLeft?: number;
+ /**
+ * The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle
+ * or legend in top position).
+ * @default 10
+ * @since 2.1
+ */
spacingRight?: number;
+ /**
+ * The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or
+ * legend in top position).
+ * @default 10
+ * @since 2.1
+ */
spacingTop?: number;
+ /**
+ * Additional CSS styles to apply inline to the container div. Note that since the default font styles are applied
+ * in the renderer, it is ignorant of the individual chart options and must be set globally.
+ */
style?: HighchartsCSSObject;
+ /**
+ * The default series type for the chart. Can be any of the chart types listed under plotOptions.
+ * @default 'line'
+ * @since 2.1.0
+ */
type?: string;
+ /**
+ * An explicit width for the chart. By default the width is calculated from the offset width of the containing
+ * element.
+ */
width?: number;
+ /**
+ * Decides in what dimensions the user can zoom by dragging the mouse. Can be one of x, y or xy.
+ */
zoomType?: string;
}
@@ -256,65 +1722,513 @@ interface HighchartsCSSObject {
padding?: string | number;
position?: string;
top?: string;
+ textShadow?: string;
}
interface HighchartsCreditsOptions {
+ /**
+ * Whether to show the credits text.
+ * @default true
+ */
enabled?: boolean;
+ /**
+ * The URL for the credits label.
+ * @default 'http://www.highcharts.com'
+ */
href?: string;
+ /**
+ * Position configuration for the credits label. Supported properties are align, verticalAlign, x and y.
+ */
position?: HighchartsPosition;
- style?: HighchartsCSSObject;
+ /**
+ * CSS styles for the credits label.
+ */
+ style?: Object;
+ /**
+ * The text for the credits label.
+ * @default 'Highcharts.com'
+ */
text?: string;
}
+interface HighchartsDataSeriesMapping {
+ [pointPropertyName: string]: number;
+}
+
+/**
+ * The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid
+ * views. See also the tutorial article on the Data module.
+ *
+ * It requires the modules/data.js file to be loaded.
+ *
+ * Please note that the default way of adding data in Highcharts, without the need of a module, is through the
+ * series.data option.
+ */
+interface HighchartsDataOptions {
+ /**
+ * A two-dimensional array representing the input data on tabular form. This input can be used when the data is
+ * already parsed, for example from a grid view component. Each cell can be a string or number. If not
+ * switchRowsAndColumns is set, the columns are interpreted as series.
+ * @since 4.0
+ */
+ columns?: [string|number][];
+ /**
+ * The callback that is evaluated when the data is finished loading, optionally from an external source, and parsed.
+ * The first argument passed is a finished chart options object, containing the series. These options can be
+ * extended with additional options and passed directly to the chart constructor.
+ * @since 4.0
+ */
+ complete?: (options: HighchartsOptions) => void;
+ /**
+ * A comma delimited string to be parsed. Related options are startRow, endRow, startColumn and endColumn to delimit
+ * what part of the table is used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats.
+ * @since 4.0
+ */
+ csv?: string;
+ /**
+ * Which of the predefined date formats in Date.prototype.dateFormats to use to parse date values. Defaults to a
+ * best guess based on what format gives valid and ordered dates.
+ *
+ * Valid options include:
+ * 'YYYY-mm-dd'
+ * 'dd/mm/YYYY'
+ * 'mm/dd/YYYY'
+ * 'dd/mm/YY'
+ * 'mm/dd/YY'
+ * @since 4.0
+ */
+ dateFormat?: string;
+ /**
+ * The decimal point used for parsing numbers in the CSV.
+ * @default '.'
+ */
+ decimalPoint?: string;
+ /**
+ * In tabular input data, the last column (indexed by 0) to use. Defaults to the last column containing data.
+ * @since 4.0
+ */
+ endColumn?: number;
+ /**
+ * In tabular input data, the last row (indexed by 0) to use. Defaults to the last row containing data.
+ * @since 4.0.4
+ */
+ endRow?: number;
+ /**
+ * Whether to use the first row in the data set as series names.
+ * @default true
+ * @since 4.1.0
+ */
+ firstRowAsNames?: boolean;
+ /**
+ * The key for a Google Spreadsheet to load. See {@link https://developers.google.com/gdata/samples/spreadsheet_sample|general information on GS}.
+ * @since 4.0
+ */
+ googleSpreadsheetKey?: string;
+ /**
+ * The Google Spreadsheet worksheet to use in combination with googleSpreadsheetKey. The available id's from your
+ * sheet can be read from https://spreadsheets.google.com/feeds/worksheets/{key}/public/basic
+ * @since 4.0
+ */
+ googleSpreadsheetWorksheet?: string;
+ /**
+ * Item or cell delimiter for parsing CSV. Defaults to the tab character \t if a tab character is found in the CSV
+ * string, if not it defaults to ,.
+ * @since 4.0
+ */
+ itemDelimiter?: string;
+ /**
+ * Line delimiter for parsing CSV.
+ * @default '\n'
+ * @since 4.0
+ */
+ lineDelimiter?: string;
+ /**
+ * A callback function to parse string representations of dates into JavaScript timestamps. Should return an integer
+ * timestamp on success.
+ * @since 4.0
+ */
+ parseDate?: (val: any) => number;
+ /**
+ * A callback function to access the parsed columns, the two-dimentional input data array directly, before they are
+ * interpreted into series data and categories. Return false to stop completion, or call this.complete() to continue
+ * async.
+ * @since 4.0
+ */
+ parsed?: (columns: [string|number][]) => boolean | void;
+ /**
+ * The same as the columns input option, but defining rows intead of columns.
+ * @since 4.0
+ */
+ rows?: [string|number][];
+ /**
+ * An array containing object with Point property names along with what column id the property should be taken from.
+ * @since 4.0.4
+ */
+ seriesMapping?: HighchartsDataSeriesMapping[];
+ /**
+ * In tabular input data, the first column (indexed by 0) to use.
+ * @default 0
+ * @since 4.0
+ */
+ startColumn?: number;
+ /**
+ * In tabular input data, the first row (indexed by 0) to use.
+ * @default 0
+ * @since 4.0
+ */
+ startRow?: number;
+ /**
+ * Switch rows and columns of the input data, so that this.columns effectively becomes the rows of the data set, and
+ * the rows are interpreted as series.
+ * @default false
+ * @since 4.0
+ */
+ switchRowsAndColumns?: boolean;
+ /**
+ * A HTML table or the id of such to be parsed as input data. Related options are startRow, endRow, startColumn and
+ * endColumn to delimit what part of the table is used.
+ */
+ table?: string | HTMLElement;
+}
+
+/**
+ * Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart items
+ * like columns or pie slices.
+ *
+ * The drilldown feature requires the drilldown.js file to be loaded, found in the modules directory of the download
+ * package, or online at code.highcharts.com/modules/drilldown.js.
+ */
+interface HighchartsDrilldownOptions {
+ /**
+ * Additional styles to apply to the X axis label for a point that has drilldown data. By default it is underlined
+ * and blue to invite to interaction.
+ * @default { cursor: 'pointer', color: '#0d233a', fontWeight: 'bold', textDecoration: 'underline' }
+ * @since 3.0.8
+ */
+ activeAxisLabelStyle?: Object;
+ /**
+ * Additional styles to apply to the data label of a point that has drilldown data. By default it is underlined and
+ * blue to invite to interaction.
+ * @default { cursor: 'pointer', color: '#0d233a', fontWeight: 'bold', textDecoration: 'underline' }
+ * @since 3.0.8
+ */
+ activeDataLabelStyle?: Object;
+ /**
+ * When this option is false, clicking a single point will drill down all points in the same category, equivalent to
+ * clicking the X axis label.
+ * @default true
+ * @since 4.1.7
+ */
+ allowPointDrilldown?: boolean;
+ /**
+ * Set the animation for all drilldown animations. Animation of a drilldown occurs when drilling between a column
+ * point and a column series, or a pie slice and a full pie series. Drilldown can still be used between series and
+ * points of different types, but animation will not occur.
+ *
+ * The animation can either be set as a boolean or a configuration object. If true, it will use the 'swing' jQuery
+ * easing and a duration of 500 ms.
+ * @since 3.0.8
+ */
+ animation?: boolean | HighchartsAnimation;
+ /**
+ * Options for the drill up button that appears when drilling down on a series. The text for the button is defined
+ * in lang.drillUpText.
+ */
+ drillUpButton?: {
+ /**
+ * Positioning options for the button within the relativeTo box. Available properties are x, y, align and
+ * verticalAlign.
+ * @since 3.0.8
+ */
+ position?: HighchartsPosition;
+ /**
+ * What box to align the button to. Can be either 'plotBox' or 'spacingBox'.
+ * @default 'plotBox'
+ * @since 3.0.8
+ */
+ relativeTo?: string;
+ /**
+ * A collection of attributes for the button. The object takes SVG attributes like fill, stroke, stroke-width or
+ * r, the border radius. The theme also supports style, a collection of CSS properties for the text. Equivalent
+ * attributes for the hover state are given in theme.states.hover.
+ * @since 3.0.8
+ */
+ theme?: HighchartsButtonStatesTheme;
+ }
+ /**
+ * An array of series configurations for the drill down. Each series configuration uses the same syntax as the
+ * series option set. These drilldown series are hidden by default. The drilldown series is linked to the parent
+ * series' point by its id.
+ * @since 3.0.8
+ */
+ series?: HighchartsIndividualSeriesOptions[];
+}
+
interface HighchartsMenuItem {
+ /**
+ * String to show in the menu item.
+ */
text: string;
+ /**
+ * Callback function to run on click.
+ */
onclick: () => void;
}
interface HighchartsButton {
+ /**
+ * Alignment for the buttons.
+ * @default 'right'
+ * @since 2.0
+ */
align?: string;
- backgroundColor?: string | HighchartsGradient;
- borderColor?: string;
- borderRadius?: number;
- borderWidth?: number;
- verticalAlign?: string;
+ /**
+ * Whether to enable buttons.
+ * @default true
+ * @since 2.0
+ */
enabled?: boolean;
+ /**
+ * Pixel height of the buttons.
+ * @default 20
+ * @since 2.0
+ */
height?: number;
- hoverBorderColor?: string;
- hoverSymbolFill?: string;
- hoverSimbolStroke?: string;
- menuItems?: HighchartsMenuItem[];
- onclick?: () => void;
- symbol?: string;
- simbolFill?: string;
- simbolSize?: number;
+ /**
+ * Fill color for the symbol within the button.
+ * @default '#E0E0E0'
+ * @since 2.0
+ */
+ symbolFill?: string;
+ /**
+ * The pixel size of the symbol on the button.
+ * @default 14
+ * @since 2.0
+ */
+ symbolSize?: number;
+ /**
+ * The color of the symbol's stroke or line.
+ * @default '#666'
+ * @since 2.0
+ */
symbolStroke?: string;
+ /**
+ * The pixel stroke width of the symbol on the button.
+ * @default 1
+ * @since 2.0
+ */
symbolStrokeWidth?: number;
+ /**
+ * The x position of the center of the symbol inside the button.
+ * @default 12.5
+ * @since 2.0
+ */
symbolX?: number;
+ /**
+ * The y position of the center of the symbol inside the button.
+ * @default 10.5
+ * @since 2.0
+ */
symbolY?: number;
+ /**
+ * A text string to add to the individual button.
+ * @default null
+ * @since 3.0
+ */
+ text?: string;
+ /**
+ * A configuration object for the button theme. The object accepts SVG properties like stroke-width, stroke and
+ * fill. Tri-state button styles are supported by the states.hover and states.select objects.
+ * @since 3.0
+ */
+ theme?: HighchartsButtonStatesTheme;
+ /**
+ * The vertical alignment of the buttons. Can be one of 'top', 'middle' or 'bottom'.
+ * @default 'top'
+ * @since 2.0
+ */
+ verticalAlign?: string;
+ /**
+ * The pixel width of the button.
+ * @default 24
+ * @since 2.0
+ */
width?: number;
- x?: number;
+ /**
+ * The vertical offset of the button's position relative to its verticalAlign.
+ * @default 0
+ * @since 2.0
+ */
y?: number;
}
+interface HighchartsExportingContextButton extends HighchartsButton {
+ /**
+ * A collection of config options for the menu items. Each options object consists of a text option which is a
+ * string to show in the menu item, as well as an onclick parameter which is a callback function to run on click.
+ *
+ * By default, there is the 'Print' menu item plus one menu item for each of the available export types. Menu items
+ * can be customized by defining a new array of items and assigning null to unwanted positions.
+ * @since 2.0
+ */
+ menuItems?: HighchartsMenuItem[];
+ /**
+ * A click handler callback to use on the button directly instead of the popup menu.
+ * @since 2.0
+ */
+ onclick?: () => void;
+ /**
+ * The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The
+ * default exportIcon function is part of the exporting module.
+ * @default 'menu'
+ */
+ symbol?: string;
+ /**
+ * The horizontal position of the button relative to the align option.
+ * @default -10
+ */
+ x?: number;
+}
+
interface HighchartsExportingOptions {
+ /**
+ * Experimental setting to allow HTML inside the chart (added through the useHTML options), directly in the exported
+ * image. This allows you to preserve complicated HTML structures like tables or bi-directional text in exported
+ * charts.
+ *
+ * Disclaimer: The HTML is rendered in a foreignObject tag in the generated SVG. The official export server is based
+ * on PhantomJS, which supports this, but other SVG clients, like Batik, does not support it. This also applies to
+ * downloaded SVG that you want to open in a desktop client.
+ * @default false
+ * @since 4.1.8
+ */
+ allowHTML?: boolean;
+ /**
+ * Options for the export related buttons, print and export. In addition to the default buttons listed here, custom
+ * buttons can be added. See navigation.buttonOptions for general options.
+ */
buttons?: {
- exportButton?: HighchartsButton;
- printButton?: HighchartsButton;
+ contextButton?: HighchartsExportingContextButton;
};
- enableImages?: boolean;
+ /**
+ * Additional chart options to be merged into an exported chart. For example, the exported chart can be given a
+ * specific width and height, or a printer-friendly color scheme.
+ * @default null
+ */
+ chartOptions?: HighchartsOptions;
+ /**
+ * Whether to enable the exporting module. Disabling the module will hide the context button, but API methods will
+ * still be available.
+ * @default true
+ * @since 2.0
+ */
enabled?: boolean;
+ /**
+ * Whether or not to fall back to the export server if the offline-exporting module is unable to export the chart on
+ * the client side.
+ * @default true
+ * @since 4.1.8
+ */
+ fallbackToExportServer?: boolean;
+ /**
+ * The filename, without extension, to use for the exported chart.
+ * @default 'chart'
+ * @since 2.0
+ */
filename?: string;
+ /**
+ * An object containing additional attributes for the POST form that sends the SVG to the export server. For
+ * example, a target can be set to make sure the generated image is received in another frame, or a custom enctype
+ * or encoding can be set.
+ * @since 3.0.8
+ */
+ formAttributes?: any;
+ /**
+ * Defines the scale or zoom factor for the exported image compared to the on-screen display. While for instance a
+ * 600px wide chart may look good on a website, it will look bad in print. The default scale of 2 makes this chart
+ * export to a 1200px PNG or JPG.
+ * @default 2
+ * @since 3.0
+ */
+ scale?: number;
+ /**
+ * The height of the original chart when exported, unless an explicit chart.height is set. The height exported
+ * raster image is then multiplied by scale.
+ * @since 3.0
+ */
+ sourceHeight?: number;
+ /**
+ * The width of the original chart when exported, unless an explicit chart.width is set. The width exported
+ * raster image is then multiplied by scale.
+ * @since 3.0
+ */
+ sourceWidth?: number;
+ /**
+ * Default MIME type for exporting if chart.exportChart() is called without specifying a type option. Possible
+ * values are image/png, image/jpeg, application/pdf and image/svg+xml.
+ * @default 'image/png'
+ * @since 2.0
+ */
type?: string;
+ /**
+ * The URL for the server module converting the SVG string to an image format. By default this points to Highslide
+ * Software's free web service.
+ * @default 'http://export.highcharts.com'
+ * @since 2.0
+ */
url?: string;
+ /**
+ * The pixel width of charts exported to PNG or JPG. As of Highcharts 3.0, the default pixel width is a function of
+ * the chart.width or exporting.sourceWidth and the exporting.scale.
+ * @since 2.0
+ */
width?: number;
}
+/**
+ * Global options that don't apply to each chart. These options, like the lang options, must be set using the
+ * Highcharts.setOptions method.
+ */
interface HighchartsGlobalObject {
+ /**
+ * A custom Date class for advanced date handling. For example, JDate can be hooked in to handle Jalali dates.
+ * @since 4.0.4
+ */
Date?: any;
+ /**
+ * Path to the pattern image required by VML browsers in order to draw radial gradients.
+ * @default 'http://code.highcharts.com/{version}/gfx/vml-radial-gradient.png'
+ * @since 2.3.0
+ */
VMLRadialGradientURL?: string;
+ /**
+ * The URL to the additional file to lazy load for Android 2.x devices. These devices don't support SVG, so we
+ * download a helper file that contains canvg, its dependency rbcolor, and our own CanVG Renderer class. To avoid
+ * hotlinking to our site, you can install canvas-tools.js on your own server and change this option accordingly.
+ * @default 'http://code.highcharts.com/{version}/modules/canvas-tools.js'
+ */
canvasToolsURL?: string;
+ /**
+ * A callback to return the time zone offset for a given datetime. It takes the timestamp in terms of milliseconds
+ * since January 1 1970, and returns the timezone offset in minutes. This provides a hook for drawing time based
+ * charts in specific time zones using their local DST crossover dates, with the help of external libraries.
+ * @since 4.1.0
+ */
+ getTimezoneOffset?: (timestamp: number) => number;
+ /**
+ * The timezone offset in minutes. Positive values are west, negative values are east of UTC, as in the ECMAScript
+ * getTimezoneOffset method. Use this to display UTC based data in a predefined time zone.
+ * @default 0
+ * @since 3.0.8
+ */
timezoneOffset?: number;
+ /**
+ * Whether to use UTC time for axis scaling, tickmark placement and time display in Highcharts.dateFormat.
+ * Advantages of using UTC is that the time displays equally regardless of the user agent's time zone settings.
+ * Local time can be used when the data is loaded in real time or when correct Daylight Saving Time transitions are
+ * required.
+ * @default true
+ */
useUTC?: boolean;
}
@@ -329,703 +2243,2531 @@ interface HighchartsLabelsOptions {
}
interface HighchartsLangObject {
+ /**
+ * Exporting module menu. The tooltip title for the context menu holding print and export menu items.
+ * @default 'Chart context menu'
+ * @since 3.0
+ */
contextButtonTitle?: string;
+ /**
+ * The default decimal point used in the Highcharts.numberFormat method unless otherwise specified in the function
+ * arguments.
+ * @default '.'
+ * @since 1.2.2
+ */
decimalPoint?: string;
+ /**
+ * Exporting module only. The text for the JPEG download menu item.
+ * @default 'Download JPEG image'
+ * @since 2.0
+ */
downloadJPEG?: string;
+ /**
+ * Exporting module only. The text for the PDF download menu item.
+ * @default 'Download PDF document'
+ * @since 2.0
+ */
downloadPDF?: string;
+ /**
+ * Exporting module only. The text for the PNG download menu item.
+ * @default 'Download PNG image'
+ * @since 2.0
+ */
downloadPNG?: string;
+ /**
+ * Exporting module only. The text for the SVG download menu item.
+ * @default 'Download SVG vector image'
+ * @since 2.0
+ */
downloadSVG?: string;
+ /**
+ * The text for the button that appears when drilling down, linking back to the parent series. The parent series'
+ * name is inserted for {series.name}
+ * @default 'Back to {series.name}'
+ * @since 3.0.8
+ */
drillUpText?: string;
+ /**
+ * What to show in a date field for invalid dates.
+ * @default ''
+ * @since 4.1.8
+ */
+ invalidDate?: string;
+ /**
+ * The loading text that appears when the chart is set into the loading state following a call to chart.showLoading.
+ * @default 'Loading...'
+ */
loading?: string;
+ /**
+ * An array containing the months names. Corresponds to the %B format in Highcharts.dateFormat().
+ * @default ['January' , 'February' , 'March' , 'April' , 'May' , 'June' , 'July' , 'August' , 'September' , 'October' , 'November' , 'December']
+ */
months?: string[];
+ /**
+ * The text to display when the chart contains no data. Requires the no-data module, see noData.
+ * @default 'No data to display'
+ * @since 3.0.8
+ */
noData?: string;
+ /**
+ * Metric prefixes used to shorten high numbers in axis labels. Replacing any of the positions with null causes the
+ * full number to be written. Setting numericSymbols to null disables shortening altogether.
+ * @default ['k', 'M', 'G', 'T', 'P', 'E']
+ * @since 2.3.0
+ */
numericSymbols?: string[];
+ /**
+ * Exporting module only. The text for the menu item to print the chart.
+ * @default 'Print chart'
+ * @since 3.0.1
+ */
printChart?: string;
+ /**
+ * The text for the label appearing when a chart is zoomed.
+ * @default 'Reset zoom'
+ * @since 1.2.4
+ */
resetZoom?: string;
+ /**
+ * The tooltip title for the label appearing when a chart is zoomed.
+ * @default 'Reset zoom level 1:1'
+ * @since 1.2.4
+ */
resetZoomTitle?: string;
+ /**
+ * An array containing the months names in abbreviated form. Corresponds to the %b format in
+ * Highcharts.dateFormat().
+ * @default ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ */
shortMonths?: string[];
+ /**
+ * The default thousands separator used in the Highcharts.numberFormat method unless otherwise specified in the
+ * function arguments. Since Highcharts 4.1 it defaults to a single space character, which is compatible with ISO
+ * and works across Anglo-American and continental European languages.
+ * @default ' '
+ * @since 1.2.2
+ */
thousandsSep?: string;
+ /**
+ * An array containing the weekday names.
+ * @default ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
+ */
weekdays?: string[];
}
interface HighchartsLegendNavigationOptions {
+ /**
+ * The color for the active up or down arrow in the legend page navigation.
+ * @default '#3E576F'
+ * @since 2.2.4
+ */
activeColor?: string;
+ /**
+ * How to animate the pages when navigating up or down. A value of true applies the default navigation given in the
+ * chart.animation option. Additional options can be given as an object containing values for easing and duration.
+ * @default true
+ * @since 2.2.4
+ */
animation?: boolean | HighchartsAnimation;
+ /**
+ * The pixel size of the up and down arrows in the legend paging navigation.
+ * @default 12
+ * @since 2.2.4
+ */
arrowSize?: number;
+ /**
+ * The color of the inactive up or down arrow in the legend page navigation.
+ * @default '#CCC'
+ */
inactiveColor?: string;
+ /**
+ * Text styles for the legend page navigation.
+ * @since 2.2.4
+ */
style?: HighchartsCSSObject;
}
interface HighchartsLegendTitleOptions {
+ /**
+ * Generic CSS styles for the legend title.
+ * @default {'fontWeight':'bold'}
+ * @since 3.0
+ */
style?: HighchartsCSSObject;
+ /**
+ * A text or HTML string for the title.
+ * @default null
+ * @since 3.0
+ */
text?: string;
}
interface HighchartsLegendOptions {
+ /**
+ * The horizontal alignment of the legend box within the chart area. Valid values are 'left', 'center' and 'right'.
+ * In the case that the legend is aligned in a corner position, the layout option will determine whether to place it
+ * above/below or on the side of the plot area.
+ * @default 'center'
+ * @since 2.0
+ */
align?: string;
+ /**
+ * The background color of the legend.
+ */
backgroundColor?: string | HighchartsGradient;
+ /**
+ * The color of the drawn border around the legend.
+ * @default '#909090'
+ */
borderColor?: string;
+ /**
+ * The border corner radius of the legend.
+ * @default 0
+ */
borderRadius?: number;
+ /**
+ * The width of the drawn border around the legend.
+ * @default 0
+ */
borderWidth?: number;
+ /**
+ * Enable or disable the legend.
+ * @default true
+ */
enabled?: boolean;
+ /**
+ * When the legend is floating, the plot area ignores it and is allowed to be placed below it.
+ * @default false
+ * @since 2.1
+ */
floating?: boolean;
+ /**
+ * In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.
+ * @default 20
+ * @since 3.0.3
+ */
itemDistance?: number;
+ /**
+ * CSS styles for each legend item when the corresponding series or point is hidden. Only a subset of CSS is
+ * supported, notably those options related to text. Properties are inherited from style unless overridden here.
+ * @default {color: '#CCC'}
+ */
itemHiddenStyle?: HighchartsCSSObject;
+ /**
+ * CSS styles for each legend item in hover mode. Only a subset of CSS is supported, notably those options related
+ * to text. Properties are inherited from style unless overridden here.
+ * @default {color: '#000'}
+ */
itemHoverStyle?: HighchartsCSSObject;
+ /**
+ * The pixel bottom margin for each legend item.
+ * @default 0
+ * @since 2.2.0
+ */
itemMarginBottom?: number;
+ /**
+ * The pixel top margin for each legend item.
+ * @default 0
+ * @since 2.2.0
+ */
itemMarginTop?: number;
+ /**
+ * CSS styles for each legend item. Only a subset of CSS is supported, notably those options related to text.
+ * @default { 'color': '#333333', 'cursor': 'pointer', 'fontSize': '12px', 'fontWeight': 'bold' }
+ */
itemStyle?: HighchartsCSSObject;
+ /**
+ * The width for each legend item. This is useful in a horizontal layout with many items when you want the items to
+ * align vertically.
+ * @since 2.0
+ */
itemWidth?: number;
+ /**
+ * A format string for each legend label. Available variables relates to properties on the series, or the point in
+ * case of pies.
+ * @default '{name}'
+ * @since 1.3
+ */
+ labelFormat?: string;
+ /**
+ * Callback function to format each of the series' labels. The this keyword refers to the series object, or the
+ * point object in case of pie charts. By default the series or point name is printed.
+ */
labelFormatter?: () => string;
+ /**
+ * The layout of the legend items. Can be one of 'horizontal' or 'vertical'.
+ * @default 'horizontal'
+ */
layout?: string;
+ /**
+ * Line height for the legend items. Deprecated as of 2.1. Instead, the line height for each item can be set using
+ * itemStyle.lineHeight, and the padding between items using itemMarginTop and itemMarginBottom.
+ * @default 16
+ * @since 2.0
+ * @deprecated
+ */
lineHeight?: number;
+ /**
+ * If the plot area sized is calculated automatically and the legend is not floating, the legend margin is the space
+ * between the legend and the axis labels or plot area.
+ * @default 12
+ * @since 2.1
+ */
margin?: number;
+ /**
+ * Maximum pixel height for the legend. When the maximum height is extended, navigation will show.
+ * @since 2.3.0
+ */
maxHeight?: number;
+ /**
+ * Options for the paging or navigation appearing when the legend is overflown.
+ */
navigation?: HighchartsLegendNavigationOptions;
+ /**
+ * The inner padding of the legend box.
+ * @default 8
+ * @since 2.2.0
+ */
padding?: number;
+ /**
+ * Whether to reverse the order of the legend items compared to the order of the series or points as defined in the
+ * configuration object.
+ * @default false
+ * @since 1.2.5
+ */
reversed?: boolean;
+ /**
+ * Whether to show the symbol on the right side of the text rather than the left side. This is common in Arabic and
+ * Hebraic.
+ * @default false
+ * @since 2.2
+ */
rtl?: boolean;
+ /**
+ * Whether to apply a drop shadow to the legend. A backgroundColor also needs to be applied for this to take effect.
+ * Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
+ * @default false
+ */
shadow?: boolean | HighchartsShadow;
+ /**
+ * CSS styles for the legend area. In the 1.x versions the position of the legend area was determined by CSS. In
+ * 2.x, the position is determined by properties like align, verticalAlign, x and y, but the styles are still parsed
+ * for backwards compatibility.
+ * @deprecated
+ */
style?: HighchartsCSSObject;
+ /**
+ * The pixel height of the symbol for series types that use a rectangle in the legend. Defaults to the font size of
+ * legend items.
+ * @since 3.0.8
+ */
symbolHeight?: number;
+ /**
+ * The pixel padding between the legend item symbol and the legend item text.
+ * @default 5
+ */
symbolPadding?: number;
+ /**
+ * The border radius of the symbol for series types that use a rectangle in the legend.
+ * @default 0
+ * @since 3.0.8
+ */
+ symbolRadius?: number;
+ /**
+ * The pixel width of the legend item symbol.
+ * @default 16
+ */
symbolWidth?: number;
+ /**
+ * A title to be added on top of the legend.
+ * @since 3.0
+ */
title?: HighchartsLegendTitleOptions;
+ /**
+ * Whether to use HTML to render the legend item texts. Prior to 4.1.7, when using HTML, legend.navigation was
+ * disabled.
+ * @default false
+ */
useHTML?: boolean;
+ /**
+ * The vertical alignment of the legend box. Can be one of 'top', 'middle' or 'bottom'. Vertical position can be
+ * further determined by the y option.
+ *
+ * In the case that the legend is aligned in a corner position, the layout option will determine whether to place it
+ * above/below or on the side of the plot area.
+ *
+ * @default 'bottom'
+ * @since 2.0
+ */
verticalAlign?: string;
+ /**
+ * The width of the legend box.
+ * @since 2.0
+ */
width?: number;
+ /**
+ * The x offset of the legend relative to its horizontal alignment align within chart.spacingLeft and
+ * chart.spacingRight. Negative x moves it to the left, positive x moves it to the right.
+ * @default 0
+ * @since 2.0
+ */
x?: number;
+ /**
+ * The vertical offset of the legend relative to it's vertical alignment verticalAlign within chart.spacingTop and
+ * chart.spacingBottom. Negative y moves it up, positive y moves it down.
+ * @default 0
+ * @since 2.0
+ */
y?: number;
}
+/**
+ * The loading options control the appearance of the loading screen that covers the plot area on chart operations. This
+ * screen only appears after an explicit call to chart.showLoading(). It is a utility for developers to communicate to
+ * the end user that something is going on, for example while retrieving new data via an XHR connection. The
+ * 'Loading...' text itself is not part of this configuration object, but part of the lang object.
+ */
interface HighchartsLoadingOptions {
+ /**
+ * The duration in milliseconds of the fade out effect.
+ * @default 100
+ * @since 1.2.0
+ */
hideDuration?: number;
+ /**
+ * CSS styles for the loading label span.
+ * @default { 'fontWeight': 'bold', 'position': 'relative', 'top': '45%' }
+ */
labelStyle?: HighchartsCSSObject;
+ /**
+ * The duration in milliseconds of the fade in effect.
+ * @default 100
+ * @since 1.2.0
+ */
showDuration?: number;
+ /**
+ * CSS styles for the loading screen that covers the plot area.
+ * @default { position: 'absolute', backgroundColor: 'white', opacity: 0.5, textAlign: 'center' }
+ */
+ style?: Object;
+}
+
+/**
+ * A collection of options for buttons and menus appearing in the exporting module.
+ */
+interface HighchartsNavigationOptions {
+ /**
+ * A collection of options for buttons appearing in the exporting module.
+ */
+ buttonOptions?: HighchartsButton;
+ /**
+ * CSS styles for the hover state of the individual items within the popup menu appearing by default when the export
+ * icon is clicked. The menu items are rendered in HTML.
+ * @default {background: '#4572A5', color: '#FFFFFF'}
+ * @since 2.0
+ */
+ menuItemHoverStyle?: Object;
+ /**
+ * CSS styles for the individual items within the popup menu appearing by default when the export icon is clicked.
+ * The menu items are rendered in HTML.
+ * @default { padding: '0 5px', background: NONE, color: '#303030'}
+ * @since 2.0
+ */
+ menuItemStyle?: Object;
+ /**
+ * CSS styles for the popup menu appearing by default when the export icon is clicked. This menu is rendered in
+ * HTML.
+ * @default { border: '1px solid #A0A0A0', background: '#FFFFFF' }
+ * @since 2.0
+ */
+ menuStyle?: Object;
+}
+
+/**
+ * Options for displaying a message like 'No data to display'. This feature requires the file no-data-to-display.js to
+ * be loaded in the page. The actual text to display is set in the lang.noData option.
+ */
+interface HighchartsNoDataOptions {
+ /**
+ * An object of additional SVG attributes for the no-data label.
+ * @since 3.0.8
+ */
+ attr?: {};
+ /**
+ * The position of the no-data label, relative to the plot area.
+ * @default { 'x': 0, 'y': 0, 'align': 'center', 'verticalAlign': 'middle' }
+ * @since 3.0.8
+ */
+ position?: HighchartsPosition;
+ /**
+ * CSS styles for the no-data label.
+ * @default { 'fontSize': '12px', 'fontWeight': 'bold', 'color': '#60606a' }
+ */
style?: HighchartsCSSObject;
}
-interface HighchartsNavigationOptions {
- buttonOptions?: HighchartsButton;
- menuItemHoverStyle?: HighchartsCSSObject;
- menuItemStyle?: HighchartsCSSObject;
- menuStyle?: HighchartsCSSObject;
-}
-
-// Not sure of this interface
interface HighchartsPaneBackground {
+ /**
+ * @default {linearGradient: { x1: 0, y1: 0, x2: 0, y2: 1 }, stops: [[0, '#FFF'],[1, '#DDD']]}
+ */
backgroundColor: string | HighchartsGradient;
+ /**
+ * @default 'silver'
+ */
borderColor?: string;
+ /**
+ * @default 1
+ */
borderWidth?: number;
- innerRadius?: string;
- outerRadius?: string;
+ /**
+ * @default 0
+ */
+ innerRadius?: number | string;
+ /**
+ * @default '105%'
+ */
+ outerRadius?: number | string;
+ /**
+ * @default 'circle'
+ */
+ shape?: string;
}
+/**
+ * Applies only to polar charts and angular gauges. This configuration object holds general options for the combined X
+ * and Y axes set. Each xAxis or yAxis can reference the pane by index.
+ */
interface HighchartsPaneOptions {
- background?: HighchartsPaneBackground[];
- center?: [number|string, number|string]; // [x,y] | ["50%","50%" ]
+ /**
+ * An object, or array of objects, for backgrounds. Sub options include backgroundColor (can be solid or gradient),
+ * shape ('solid', 'arc' or 'circle'), innerWidth, outerWidth, borderWidth, borderColor.
+ * @since 2.3.0
+ */
+ background?: HighchartsPaneBackground | HighchartsPaneBackground[];
+ /**
+ * The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as
+ * integers that transform to pixels, or as percentages of the plot area size.
+ * @default ['50%', '50%']
+ * @since 2.3.0
+ */
+ center?: [number|string, number|string];
+ /**
+ * The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.
+ * @default startAngle + 360
+ * @since 2.3.0
+ */
endAngle?: number;
+ /**
+ * The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
+ * @default '85%'
+ */
size?: number | string;
+ /**
+ * The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are
+ * @since 2.3.0
+ */
startAngle?: number;
}
interface HighchartsDataLabels {
+ /**
+ * The alignment of the data label compared to the point. If right, the right side of the label should be touching
+ * the point. For points with an extent, like columns, the alignments also dictates how to align it inside the box,
+ * as given with the inside option. Can be one of 'left', 'center' or 'right'.
+ * @default 'center'
+ */
align?: string;
+ /**
+ * Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the
+ * dataLabels.padding can be set to 0.
+ * @default false
+ * @since 4.1.0
+ */
+ allowOverlap?: boolean;
+ /**
+ * The background color or gradient for the data label.
+ * @since 2.2.1
+ */
backgroundColor?: string | HighchartsGradient;
+ /**
+ * The border color for the data label.
+ * @since 2.2.1
+ */
borderColor?: string;
+ /**
+ * The border radius in pixels for the data label.
+ * @default 0
+ * @since 2.2.1
+ */
borderRadius?: number;
+ /**
+ * The border width in pixels for the data label.
+ * @default 0
+ * @since 2.2.1
+ */
borderWidth?: number;
+ /**
+ * The text color for the data labels.
+ * @default null
+ */
color?: string;
+ /**
+ * Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot
+ * area according to the overflow option.
+ * @default 2.3.3
+ */
crop?: boolean;
+ /**
+ * Whether to defer displaying the data labels until the initial series animation has finished.
+ * @default true
+ * @since 4.0
+ */
+ defer?: boolean;
+ /**
+ * Enable or disable the data labels.
+ * @default false
+ */
enabled?: boolean;
- formatter?: () => any;
+ /**
+ * A format string for the data label. Available variables are the same as for formatter.
+ * @default {y}
+ * @since 3.0
+ */
+ format?: string;
+ /**
+ * Callback JavaScript function to format the data label. Note that if a format is defined, the format takes
+ * precedence and the formatter is ignored.
+ * Available data are:
+ * - this.percentage Stacked series and pies only. The point's percentage of the total.
+ * - this.point The point object. The point name, if defined, is available through this.point.name.
+ * - this.series The series object. The series name is available through this.series.name.
+ * - this.total Stacked series only. The total value at this point's x value.
+ * - this.x: The x value.
+ * - this.y: The y value.
+ */
+ formatter?: () => string;
+ /**
+ * For points with an extent, like columns, whether to align the data label inside the box or to the actual value
+ * point. Defaults to false in most cases, true in stacked columns.
+ * @since 3.0
+ */
+ inside?: boolean;
+ /**
+ * How to handle data labels that flow outside the plot area. The default is 'justify', which aligns them inside the
+ * plot area. For columns and bars, this means it will be moved inside the bar. To display data labels outside the
+ * plot area, set crop to false and overflow to 'none'.
+ * @default 'justify'
+ * @since 3.0.6
+ */
overflow?: string;
+ /**
+ * When either the borderWidth or the backgroundColor is set, this is the padding within the box.
+ * @default 5
+ * @since 2.2.1
+ */
padding?: number;
+ /**
+ * Text rotation in degrees. Note that due to a more complex structure, backgrounds, borders and padding will be
+ * lost on a rotated data label.
+ * @default 0
+ */
rotation?: number;
+ /**
+ * The shadow of the box. Works best with borderWidth or backgroundColor. Since 2.3 the shadow can be an object
+ * configuration containing color, offsetX, offsetY, opacity and width.
+ * @default false
+ */
shadow?: boolean | HighchartsShadow;
- staggerLines?: any; // ?? need to check API
- step?: any; // ?? need to check API
+ /**
+ * The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer
+ * object.
+ * @default 'square'
+ * @since 4.1.2
+ */
+ shape?: string;
+ /**
+ * Styles for the label.
+ * @default {'color': 'contrast', 'fontSize': '11px', 'fontWeight': 'bold', 'textShadow': '0 0 6px contrast, 0 0 3px contrast' }
+ * @since 4.1.0
+ */
style?: HighchartsCSSObject;
+ /**
+ * Whether to {@link http://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html|use HTML} to render the labels.
+ * @default false
+ */
useHTML?: boolean;
+ /**
+ * The vertical alignment of a data label. Can be one of top, middle or bottom. The default value depends on the
+ * data, for instance in a column chart, the label is above positive values and below negative values.
+ * @since 2.3.3
+ */
verticalAlign?: string;
+ /**
+ * The x position offset of the label relative to the point.
+ * @default 0
+ */
x?: number;
+ /**
+ * The y position offset of the label relative to the point.
+ * @default -6
+ */
y?: number;
+ /**
+ * The Z index of the data labels. The default Z index puts it above the series. Use a Z index of 2 to display it
+ * behind the series.
+ * @default 6
+ * @since 2.3.5
+ */
+ zIndex?: number;
+}
+
+interface HighchartsPieDataLabels extends HighchartsDataLabels {
+ /**
+ * The color of the line connecting the data label to the pie slice. The default color is the same as the point's
+ * color. Defaults to {point.color}.
+ * @since 2.1
+ */
+ connectorColor?: string;
+ /**
+ * The distance from the data label to the connector.
+ * @default 5
+ * @since 2.1
+ */
+ connectorPadding?: number;
+ /**
+ * The width of the line connecting the data label to the pie slice.
+ * @default 1
+ * @since 2.1
+ */
+ connectorWidth?: number;
+ /**
+ * The distance of the data label from the pie's edge. Negative numbers put the data label on top of the pie slices.
+ * Connectors are only shown for data labels outside the pie.
+ * @default 30
+ * @since 2.1
+ */
+ distance?: number;
+ /**
+ * Whether to render the connector as a soft arc or a line with sharp break.
+ * @default true
+ * @since 2.1.7
+ */
+ softConnector?: boolean;
}
interface HighchartsAreaCheckboxEvent extends Event {
+ /**
+ * The state of the checkbox
+ */
checked: boolean;
+ /**
+ * The checked item
+ */
+ item: HighchartsSeriesObject | HighchartsPointObject;
}
interface HighchartsAreaClickEvent extends Event {
+ /**
+ * A pointer to the nearest point on the graph
+ */
point: HighchartsPointObject;
}
interface HighchartsPlotEvents {
- checkboxClick?: (event: HighchartsAreaCheckboxEvent) => boolean;
+ /**
+ * Fires after the series has finished its initial animation, or in case animation is disabled, immediately as the
+ * series is displayed.
+ *
+ * The this keyword refers to the Series object.
+ * @since 4.0
+ */
+ afterAnimate?: (event: Event) => void;
+ /**
+ * Fires when the checkbox next to the series' name in the legend is clicked. One parameter, event, is passed to the
+ * function. The state of the checkbox is found by event.checked. The checked item is found by event.item. Return
+ * false to prevent the default action which is to toggle the select state of the series.
+ *
+ * The this keyword refers to the Series object.
+ * @since 1.2.0
+ */
+ checkboxClick?: (event: HighchartsAreaCheckboxEvent) => boolean|void;
+ /**
+ * Fires when the series is clicked. One parameter, event, is passed to the function. This contains common event
+ * information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ * Additionally, event.point holds a pointer to the nearest point on the graph.
+ *
+ * The this keyword refers to the Series object.
+ */
click?: (event: HighchartsAreaClickEvent) => void;
+ /**
+ * Fires when the series is hidden after chart generation time, either by clicking the legend item or by calling
+ * .hide().
+ *
+ * The this keyword refers to the Series object.
+ */
hide?: () => void;
- legendItemClick?: (event: Event) => boolean;
+ /**
+ * Fires when the legend item belonging to the series is clicked. One parameter, event, is passed to the function.
+ * This contains common event information based on jQuery or MooTools depending on which library is used as the base
+ * for Highcharts. The default action is to toggle the visibility of the series. This can be prevented by returning
+ * false or calling event.preventDefault().
+ *
+ * The this keyword refers to the Series object.
+ */
+ legendItemClick?: (event: Event) => boolean|void;
+ /**
+ * Fires when the mouse leaves the graph. One parameter, event, is passed to the function. This contains common
+ * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. If
+ * the stickyTracking option is true, mouseOut doesn't happen before the mouse enters another graph or leaves the
+ * plot area.
+ *
+ * The this keyword refers to the Series object.
+ */
mouseOut?: (event: Event) => void;
+ /**
+ * Fires when the mouse enters the graph. One parameter, event, is passed to the function. This contains common
+ * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ *
+ * The this keyword refers to the Series object.
+ */
mouseOver?: (event: Event) => void;
+ /**
+ * Fires when the series is shown after chart generation time, either by clicking the legend item or by calling
+ * .show().
+ *
+ * The this keyword refers to the Series object.
+ * @since 1.2.0
+ */
show?: () => void;
}
interface HighchartsMarkerState {
+ /**
+ * Enable or disable the point marker. If null, the markers are hidden when the data is dense, and shown for more
+ * widespread data points.
+ * @default null, true for hover and select
+ */
enabled?: boolean;
+ /**
+ * The fill color of the point marker. When null, the series' or point's color is used.
+ */
fillColor?: string;
+ /**
+ * The color of the point marker's outline. When null, the series' or point's color is used.
+ * @default '#FFFFFF', '#000000' for select state
+ */
lineColor?: string;
+ /**
+ * The width of the point marker's outline.
+ * @default 0
+ */
lineWidth?: number;
+ /**
+ * The radius of the point marker.
+ * @default 4, undefined for hover and select
+ */
radius?: number;
}
+interface HighchartsMarkerHoverState extends HighchartsMarkerState {
+ /**
+ * The additional line width for a hovered point.
+ * @default 1
+ * @since 4.0.3
+ */
+ lineWidthPlus?: number;
+ /**
+ * The number of pixels to increase the radius of the hovered point.
+ * @default 2
+ * @since 4.0.3
+ */
+ radiusPlus?: number;
+}
+
interface HighchartsMarker extends HighchartsMarkerState {
+ /**
+ * Image markers only. Set the image width explicitly. When using this option, a width must also be set.
+ * @default null
+ * @since 4.0.4
+ */
+ height?: number;
states?: {
- hover?: HighchartsMarkerState;
+ hover?: HighchartsMarkerHoverState;
+ /**
+ * The appearance of the point marker when selected. In order to allow a point to be selected, set the
+ * series.allowPointSelect option to true.
+ */
select?: HighchartsMarkerState;
};
- symbol?: string; // null, "circle", "square", "diamond", "triangle" "triangle-down" or "url(graphic.png)"
+ /**
+ * A predefined shape or symbol for the marker. When null, the symbol is pulled from options.symbols. Other possible
+ * values are 'circle', 'square', 'diamond', 'triangle' and 'triangle-down'.
+ *
+ * Additionally, the URL to a graphic can be given on this form: 'url(graphic.png)'. Note that for the image to be
+ * applied to exported charts, its URL needs to be accessible by the export server.
+ *
+ * Custom callbacks for symbol path generation can also be added to Highcharts.SVGRenderer.prototype.symbols. The
+ * callback is then used by its method name.
+ */
+ symbol?: string; // null, 'circle', 'square', 'diamond', 'triangle' 'triangle-down' or 'url(graphic.png)'
+ /**
+ * Image markers only. Set the image width explicitly. When using this option, a height must also be set.
+ * @default null.
+ * @since 4.0.4
+ */
+ width?: number;
}
interface HighchartsPointEvents {
+ /**
+ * Fires when a point is clicked. One parameter, event, is passed to the function. This contains common event
+ * information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
+ *
+ * If the series.allowPointSelect option is true, the default action for the point's click event is to toggle the
+ * point's select state. Returning false cancels this action.
+ *
+ * The this keyword refers to the Point object.
+ */
click?: (event: Event) => boolean;
+ /**
+ * Fires when the mouse leaves the area close to the point. One parameter, event, is passed to the function. This
+ * contains common event information based on jQuery or MooTools depending on which library is used as the base for
+ * Highcharts.
+ *
+ * The this keyword refers to the Point object.
+ */
mouseOut?: (event: Event) => void;
+ /**
+ * Fires when the mouse enters the area close to the point. One parameter, event, is passed to the function. This
+ * contains common event information based on jQuery or MooTools depending on which library is used as the base for
+ * Highcharts.
+ *
+ * The this keyword refers to the Point object.
+ */
mouseOver?: (event: Event) => void;
- remove?: (event: Event) => boolean;
- select?: (event: Event) => boolean;
- unselect?: (event: Event) => boolean;
- update?: (event: Event) => boolean;
+ /**
+ * Fires when the point is removed using the .remove() method. One parameter, event, is passed to the function.
+ * Returning false cancels the operation.
+ *
+ * The this keyword refers to the Point object.
+ * @since 1.2.0
+ */
+ remove?: (event: Event) => boolean|void;
+ /**
+ * Fires when the point is selected either programmatically or following a click on the point. One parameter, event,
+ * is passed to the function. Returning false cancels the operation.
+ *
+ * The this keyword refers to the Point object.
+ * @since 1.2.0
+ */
+ select?: (event: Event) => boolean|void;
+ /**
+ * Fires when the point is unselected either programmatically or following a click on the point. One parameter,
+ * event, is passed to the function. Returning false cancels the operation.
+ *
+ * The this keyword refers to the Point object.
+ * @since 1.2.0
+ */
+ unselect?: (event: Event) => boolean|void;
+ /**
+ * Fires when the point is updated programmatically through the .update() method. One parameter, event, is passed to
+ * the function. The new point options can be accessed through event.options. Returning false cancels the operation.
+ *
+ * The this keyword refers to the Point object.
+ * @since 1.2.0
+ */
+ update?: (event: Event) => boolean|void;
}
-interface HighchartsAreaStates {
+interface HighchartsHalo {
+ /**
+ * A collection of SVG attributes to override the appearance of the halo, for example fill, stroke and stroke-width.
+ * @since 4.0
+ */
+ attributes?: {};
+ /**
+ * Opacity for the halo unless a specific fill is overridden using the attributes setting. Note that Highcharts is
+ * only able to apply opacity to colors of hex or rgb(a) formats.
+ * @default 0.25
+ * @since 4.0
+ */
+ opacity?: number;
+ /**
+ * The pixel size of the halo. For point markers this is the radius of the halo. For pie slices it is the width of
+ * the halo outside the slice. For bubbles it defaults to 5 and is the width of the halo outside the bubble.
+ * Defaults to 10.
+ */
+ size?: number;
+}
+
+interface HighchartsLineStates {
+ /**
+ * Enable separate styles for the hovered series to visualize that the user hovers either the series itself or the
+ * legend.
+ * @default true
+ * @since 1.2
+ */
enabled?: boolean;
+ /**
+ * Options for the halo appearing around the hovered point in line-type series as well as outside the hovered slice
+ * in pie charts. By default the halo is filled by the current point or series color with an opacity of 0.25. The
+ * halo can be disabled by setting the halo option to false.
+ * @since 4.0
+ */
+ halo?: boolean | HighchartsHalo;
+ /**
+ * Pixel with of the graph line.
+ * @default 2
+ */
lineWidth?: number;
+ /**
+ * The additional line width for the graph of a hovered series.
+ * @default 1
+ * @since 4.0.3
+ */
+ lineWidthPlus?: number;
marker?: HighchartsMarker;
}
-interface HighchartsBarStates extends HighchartsAreaStates {
+interface HighchartsBarStates {
+ /**
+ * How much to brighten the point on interaction. Requires the main color to be defined in hex or rgb(a) format.
+ * @default 0.1
+ */
brightness?: number;
+ /**
+ * Enable separate styles for the hovered series to visualize that the user hovers either the series itself or the
+ * legend.
+ * @default true
+ * @since 1.2
+ */
+ enabled?: boolean;
+ /**
+ * Options for the halo appearing around the hovered point in line-type series as well as outside the hovered slice
+ * in pie charts. By default the halo is filled by the current point or series color with an opacity of 0.25. The
+ * halo can be disabled by setting the halo option to false.
+ * @since 4.0
+ */
+ halo?: boolean | HighchartsHalo;
+}
+
+interface HighchartsPieStates extends HighchartsBarStates, HighchartsLineStates { }
+
+interface HighchartsAreaZone {
+ /**
+ * Defines the color of the series.
+ * @since 4.1.0
+ */
+ color?: string;
+ /**
+ * A name for the dash style to use for the graph.
+ * @since 4.1.0
+ */
+ dashStyle?: string;
+ /**
+ * Defines the fill color for the series (in area type series)
+ * @since 4.1.0
+ */
+ fillColor?: string;
+ /**
+ * The value up to where the zone extends, if undefined the zones stretches to the last value in the series.
+ * @default undefined
+ * @since 4.1.0
+ */
+ value?: number;
}
interface HighchartsRangeDataLabels {
+ /**
+ * The alignment of the data label compared to the point. If right, the right side of the label should be touching
+ * the point. For points with an extent, like columns, the alignments also dictates how to align it inside the box,
+ * as given with the inside option. Can be one of 'left', 'center' or 'right'.
+ * @default 'center'
+ */
align?: string;
+ /**
+ * Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the
+ * dataLabels.padding can be set to 0.
+ * @default false
+ * @since 4.1.0
+ */
+ allowOverlap?: boolean;
+ /**
+ * The background color or gradient for the data label.
+ * @default undefined
+ * @since 2.2.1
+ */
backgroundColor?: string | HighchartsGradient;
+ /**
+ * The border color for the data label.
+ * @default undefined
+ * @since 2.2.1
+ */
borderColor?: string;
+ /**
+ * The border radius in pixels for the data label.
+ * @default 0
+ * @since 2.2.1
+ */
borderRadius?: number;
+ /**
+ * The border width in pixels for the data label.
+ * @default 0
+ * @since 2.2.1
+ */
borderWidth?: number;
+ /**
+ * The text color for the data labels.
+ * @default null
+ */
color?: string;
+ /**
+ * Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot
+ * area according to the overflow option.
+ * @default true
+ * @since 2.3.3
+ */
crop?: boolean;
+ /**
+ * Whether to defer displaying the data labels until the initial series animation has finished.
+ * @default true
+ * @since 4.0
+ */
defer?: boolean;
+ /**
+ * Enable or disable the data labels.
+ * @default false
+ */
enabled?: boolean;
+ /**
+ * A format string for the data label. Available variables are the same as for formatter.
+ * @default '{y}'
+ * @since 3.0
+ */
format?: string;
- formatter?: () => any;
+ /**
+ * Callback JavaScript function to format the data label. Note that if a format is defined, the format takes
+ * precedence and the formatter is ignored.
+ * Available data are:
+ * - this.percentage Stacked series and pies only. The point's percentage of the total.
+ * - this.point The point object. The point name, if defined, is available through this.point.name.
+ * - this.series The series object. The series name is available through this.series.name.
+ * - this.total Stacked series only. The total value at this point's x value.
+ * - this.x: The x value.
+ * - this.y: The y value.
+ */
+ formatter?: () => string;
+ /**
+ * For points with an extent, like columns, whether to align the data label inside the box or to the actual value
+ * point. Defaults to false in most cases, true in stacked columns.
+ * @since 3.0
+ */
inside?: boolean;
+ /**
+ * How to handle data labels that flow outside the plot area. The default is justify, which aligns them inside the
+ * plot area. For columns and bars, this means it will be moved inside the bar. To display data labels outside the
+ * plot area, set crop to false and overflow to 'none'.
+ * @default 'justify'
+ * @since 3.0.6
+ */
overflow?: string;
+ /**
+ * When either the borderWidth or the backgroundColor is set, this is the padding within the box.
+ * @default 5
+ * @since 2.2.1
+ */
padding?: number;
+ /**
+ * Text rotation in degrees. Note that due to a more complex structure, backgrounds, borders and padding will be
+ * lost on a rotated data label.
+ * @default 0
+ */
rotation?: number;
+ /**
+ * The shadow of the box. Works best with borderWidth or backgroundColor. Since 2.3 the shadow can be an object
+ * configuration containing color, offsetX, offsetY, opacity and width.
+ * @default false
+ * @since 2.2.1
+ */
shadow?: boolean | HighchartsShadow;
+ /**
+ * The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer
+ * object.
+ * @default 'square'
+ * @since 4.1.2
+ */
+ shape?: string;
+ /**
+ * Styles for the label.
+ * @default {'color': 'contrast', 'fontSize': '11px', 'fontWeight': 'bold', 'textShadow': '0 0 6px contrast, 0 0 3px contrast' }
+ * @since 4.1.0
+ */
style?: HighchartsCSSObject;
+ /**
+ * Whether to {@link http://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html|use HTML} to render the labels.
+ * @default false
+ */
useHTML?: boolean;
+ /**
+ * The vertical alignment of a data label. Can be one of 'top', 'middle' or 'bottom'. The default value depends on the
+ * data, for instance in a column chart, the label is above positive values and below negative values.
+ * @since 2.3.3
+ */
verticalAlign?: string;
+ /**
+ * X offset of the higher data labels relative to the point value.
+ * @default 0
+ * @since 2.3.0
+ */
xHigh?: number;
+ /**
+ * X offset of the lower data labels relative to the point value.
+ * @default 0
+ * @since 2.3.0
+ */
xLow?: number;
+ /**
+ * Y offset of the higher data labels relative to the point value.
+ * @default -6
+ * @since 2.3.0
+ */
yHigh?: number;
+ /**
+ * Y offset of the lower data labels relative to the point value.
+ * @default 16
+ * @since 2.3.0
+ */
yLow?: number;
+ /**
+ * The Z index of the data labels. The default Z index puts it above the series. Use a Z index of 2 to display it
+ * behind the series.
+ * @default 6
+ * @since 2.3.5
+ */
zIndex?: number;
}
interface HighchartsDial {
+ /**
+ * The background or fill color of the gauge's dial.
+ * @default 'black'
+ * @since 2.3.0
+ */
backgroundColor?: string;
+ /**
+ * The length of the dial's base part, relative to the total radius or length of the dial.
+ * @default '70%'.
+ * @since 2.3.0
+ */
baseLength?: string;
+ /**
+ * The pixel width of the base of the gauge dial. The base is the part closest to the pivot, defined by baseLength.
+ * @default 3
+ * @since 2.3.0
+ */
baseWidth?: number;
+ /**
+ * The border color or stroke of the gauge's dial. By default, the borderWidth is 0, so this must be set in addition
+ * to a custom border color.
+ * @default 'silver'
+ * @since 2.3.0
+ */
borderColor?: string;
+ /**
+ * The width of the gauge dial border in pixels.
+ * @default 0
+ * @since 2.3.0
+ */
borderWidth?: number;
+ /**
+ * The radius or length of the dial, in percentages relative to the radius of the gauge itself.
+ * @default '80%'
+ * @since 2.3.0
+ */
radius?: string;
+ /**
+ * The length of the dial's rear end, the part that extends out on the other side of the pivot. Relative to the
+ * dial's length.
+ * @default '10%'
+ * @since 2.3.0
+ */
rearLength?: string;
+ /**
+ * The width of the top of the dial, closest to the perimeter. The pivot narrows in from the base to the top.
+ * @default 1
+ * @since 2.3.0
+ */
topWidth?: number;
}
interface HighchartsPivot {
+ /**
+ * The background color or fill of the pivot.
+ * @default 'black'
+ * @since 2.3.0
+ */
backgroundColor?: string;
+ /**
+ * The border or stroke color of the pivot. In able to change this, the borderWidth must also be set to something
+ * other than the default 0.
+ * @default 'silver'
+ * @since 2.3.0
+ */
borderColor?: string;
+ /**
+ * The border or stroke width of the pivot.
+ * @default 0
+ * @since 2.3.0
+ */
borderWidth?: number;
+ /**
+ * The pixel radius of the pivot.
+ * @default 5
+ * @since 2.3.0
+ */
radius?: number;
}
-interface HighchartsAreaChart {
- allowPointSelect?: boolean;
- animation?: boolean;
+/**
+ * Set options on specific levels. Takes precedence over series options, but not point options.
+ */
+interface HighchartsTreeMapLevel {
+ /**
+ * Can set borderColor on all points which lies on the same level.
+ * @since 4.1.0
+ */
+ borderColor?: string;
+ /**
+ * et the dash style of the border of all the point which lies on the level.
+ * @since 4.1.0
+ */
+ borderDashStyle?: string;
+ /**
+ * Can set the borderWidth on all points which lies on the same level.
+ * @since 4.1.0
+ */
+ borderWidth?: number;
+ /**
+ * Can set a color on all points which lies on the same level.
+ * @since 4.1.0
+ */
color?: string;
- connectEnds?: boolean;
- connectNulls?: boolean;
- cropThreshold?: number;
- cursor?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
+ /**
+ * Can set the options of dataLabels on each point which lies on the level.
+ * @default undefined
+ * @since 4.1.0
+ */
dataLabels?: HighchartsDataLabels;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- fillColor?: string | HighchartsGradient;
- fillOpacity?: number;
- linkedTo?: string;
- lineColor?: string;
- lineWidth?: number;
- marker?: HighchartsMarker;
- negativeColor?: string;
- negativeFillColor?: string;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPlacement?: string | number; // null, "on", "between"
- pointStart?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- stacking?: string;
- states?: {
- hover: HighchartsAreaStates;
- };
- step?: string;
- stickyTracking?: boolean;
- threshold?: number;
- tooltip?: HighchartsTooltipOptions;
- trackByArea?: boolean;
- turboThreshold?: number;
- visible?: boolean;
- zIndex?: number;
+ /**
+ * Can set the layoutAlgorithm option on a specific level.
+ * @since 4.1.0
+ */
+ layoutAlgorithm?: string;
+ /**
+ * Can set the layoutStartingDirection option on a specific level.
+ * @since 4.1.0
+ */
+ layoutStartingDirection?: string;
+ /**
+ * Decides which level takes effect from the options set in the levels object.
+ * @since 4.1.0
+ */
+ level?: number;
}
-interface HighchartsAreaRangeChart {
+/**
+ * General options for all series types
+ */
+interface HighchartsSeriesChart {
+ /**
+ * Allow this series' points to be selected by clicking on the markers, bars or pie slices.
+ * @default false
+ * @since 1.2.0
+ */
allowPointSelect?: boolean;
- animation?: boolean;
+ /**
+ * Enable or disable the initial animation when a series is displayed. The animation can also be set as a
+ * configuration object. Please note that this option only applies to the initial animation of the series itself.
+ * For other animations, see chart.animation and the animation parameter under the API methods.
+ * @default true
+ */
+ animation?: boolean | HighchartsAnimation;
+ /**
+ * The main color or the series. In line type series it applies to the line and the point markers unless otherwise
+ * specified. In bar type series it applies to the bars unless a color is specified per point. The default value is
+ * pulled from the options.colors array.
+ */
color?: string;
+ /**
+ * Polar charts only. Whether to connect the ends of a line series plot across the extremes.
+ * @default true
+ * @since 2.3.0
+ */
+ connectEnds?: boolean;
+ /**
+ * Whether to connect a graph line across null points.
+ * @default false
+ */
connectNulls?: boolean;
+ /**
+ * When the series contains less points than the crop threshold, all points are drawn, event if the points fall
+ * outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and
+ * columns), is that animation is performed on updates. On the other hand, when the series contains more points than
+ * the crop threshold, the series data is cropped to only contain points that fall within the plot area. The
+ * advantage of cropping away invisible points is to increase performance on large series.
+ * @default 300
+ * @since 2.2
+ */
cropThreshold?: number;
+ /**
+ * You can set the cursor to 'pointer' if you have click events attached to the series, to signal to the user that
+ * the points and lines can be clicked.
+ */
cursor?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
- dataLabels?: HighchartsRangeDataLabels;
+ /**
+ * A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline,
+ * area and scatter in case it has a lineWidth. The value for the dashStyle include:
+ * - Solid
+ * - ShortDash
+ * - ShortDot
+ * - ShortDashDot
+ * - ShortDashDotDot
+ * - Dot
+ * - Dash
+ * - LongDash
+ * - DashDot
+ * - LongDashDot
+ * - LongDashDotDot
+ * @default 'Solid'
+ */
+ dashStyle?: string;
+ dataLabels?: HighchartsDataLabels;
+ /**
+ * Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on
+ * graphs and points. For large datasets it improves performance.
+ * @default true
+ */
enableMouseTracking?: boolean;
events?: HighchartsPlotEvents;
- fillColor?: string | HighchartsGradient;
- fillOpacity?: number;
- lineColor?: string;
+ /**
+ * Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X
+ * axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
+ * @default false
+ * @since 4.1.6
+ */
+ getExtremesFromAll?: boolean;
+ /**
+ * An array specifying which option maps to which key in the data point array. This makes it convenient to work with
+ * unstructured data arrays from different sources.
+ * @since 4.1.6
+ */
+ keys?: string[];
+ /**
+ * Pixel with of the graph line.
+ * @default 2
+ */
lineWidth?: number;
+ /**
+ * The id of another series to link to. Additionally, the value can be ':previous' to link to the previous series.
+ * When two series are linked, only the first one appears in the legend. Toggling the visibility of this also
+ * toggles the linked series.
+ * @since 3.0
+ */
linkedTo?: string;
+ marker?: HighchartsMarker;
+ /**
+ * The color for the parts of the graph or points that are below the threshold.
+ * @default null.
+ * @since 3.0
+ */
negativeColor?: string;
- negativeFillColor?: string;
point?: {
events: HighchartsPointEvents;
};
+ /**
+ * If no x values are given for the points in a series, pointInterval defines the interval of the x values. For
+ * example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
+ *
+ * Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
+ * @default 1
+ */
pointInterval?: number;
- pointPlacement?: string | number; // null, "on", "between"
+ /**
+ * On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year.
+ * Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
+ * @since 4.1.0
+ */
+ pointIntervalUnit?: string;
+ /**
+ * Possible values: null, 'on', 'between'.
+ *
+ * In a column chart, when pointPlacement is 'on', the point will not create any padding of the X axis. In a polar
+ * column chart this means that the first column points directly north. If the pointPlacement is 'between', the
+ * columns will be laid out between ticks. This is useful for example for visualising an amount between two points
+ * in time or in a certain sector of a polar chart.
+ *
+ * Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between
+ * this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric
+ * point placement options won't affect axis padding.
+ *
+ * Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series
+ * it needs to be set.
+ *
+ * Defaults to null in cartesian charts, 'between' in polar charts.
+ * @since 2.3.0
+ */
+ pointPlacement?: string | number;
+ /**
+ * If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a
+ * series contains one yearly value starting from 1945, set pointStart to 1945.
+ * @default 0
+ */
pointStart?: number;
+ /**
+ * Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be
+ * checked for a selected series.
+ * @default false
+ * @since 1.2.0
+ */
selected?: boolean;
+ /**
+ * Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing
+ * color, offsetX, offsetY, opacity and width.
+ * @default false
+ */
shadow?: boolean | HighchartsShadow;
+ /**
+ * If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox
+ * is determined by the selected option.
+ * @default false
+ * @since 1.2.0
+ */
showCheckbox?: boolean;
+ /**
+ * Whether to display this particular series or series type in the legend. The default value is true for standalone
+ * series, false for linked series. Defaults to true.
+ */
showInLegend?: boolean;
+ /**
+ * When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the
+ * data actually crosses the plane.
+ *
+ * For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values
+ * according to the minPadding option. If softThreshold is true, the Y axis starts at 0.
+ * @default true
+ * @since 4.1.9
+ */
+ softTreshold?: boolean;
+ /**
+ * Whether to stack the values of each series on top of each other. Possible values are null to disable, 'normal' to
+ * stack by value or 'percent'.
+ */
stacking?: string;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
states?: {
- hover: HighchartsAreaStates;
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsLineStates;
};
- step?: string;
+ /**
+ * Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves
+ * over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the
+ * mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is
+ * false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series. Defaults to
+ * true for line and area type series, but to false for columns, pies etc.
+ * @default true
+ * @since 2.0
+ */
stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
+ /**
+ * The Y axis value to serve as the base for the area, for distinguishing between values above and below a
+ * threshold. If null, the area behaves like a line series with fill between the graph and the Y axis minimum.
+ * @default 0
+ * @since 2.0
+ */
threshold?: number;
- trackByArea?: boolean;
+ /**
+ * A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip,
+ * but only the following properties can be defined on a series level.
+ * @since 2.3
+ */
+ tooltip?: HighchartsSeriesTooltipOptions;
+ /**
+ * When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two
+ * dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are
+ * assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0
+ * disable.
+ * @default 1000
+ * @since 2.2
+ */
turboThreshold?: number;
+ /**
+ * Set the initial visibility of the series.
+ * @default true
+ */
visible?: boolean;
+ /**
+ * Defines the Axis on which the zones are applied.
+ * @default 'y'
+ * @since 4.1.0
+ */
+ zoneAxis?: string;
+ /**
+ * An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles,
+ * according to the zoneAxis option.
+ */
+ zones?: HighchartsAreaZone[];
+}
+
+interface HighchartsAreaChart extends HighchartsSeriesChart {
+ /**
+ * Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.
+ */
+ fillColor?: string | HighchartsGradient;
+ /**
+ * Fill opacity for the area. Note that when you set an explicit fillColor, the fillOpacity is not applied. Instead,
+ * you should define the opacity in the fillColor with an rgba color definition.
+ * @default 0.75
+ */
+ fillOpacity?: number;
+ /**
+ * A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting
+ * allows setting a separate color for the line without altering the fillColor.
+ */
+ lineColor?: string;
+ /**
+ * A separate color for the negative part of the area.
+ * @since 3.0
+ */
+ negativeFillColor?: string;
+ /**
+ * Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was
+ * supported.
+ *
+ * @default 'false'
+ * @since 1.2.5
+ */
+ step?: string;
+ /**
+ * Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.
+ * @default false
+ * @since 1.1.6
+ */
+ trackByArea?: boolean;
+}
+
+interface HighchartsAreaRangeChart extends HighchartsAreaChart {
+ /**
+ * Extended data labels for range series types. Range series data labels have no x and y options. Instead, they have
+ * xLow, xHigh, yLow and yHigh options to allow the higher and lower data label sets individually.
+ * @since 2.3.0
+ */
+ dataLabels?: HighchartsRangeDataLabels;
}
interface HighchartsAreaSplineChart extends HighchartsAreaChart {
- connectEnds?: boolean;
}
interface HighchartsAreaSplineRangeChart extends HighchartsAreaRangeChart {
}
-interface HighchartsBarChart {
- allowPointSelect?: boolean;
- animation?: boolean;
+interface HighchartsBarChart extends HighchartsSeriesChart {
+ /**
+ * The color of the border surrounding each column or bar.
+ * @default '#FFFFFF'
+ */
borderColor?: string;
+ /**
+ * The corner radius of the border surrounding each column or bar.
+ * @default 0
+ */
borderRadius?: number;
+ /**
+ * The width of the border surrounding each column or bar.
+ * @default 1
+ */
borderWidth?: number;
- color?: string;
+ /**
+ * When using automatic point colors pulled from the options.colors collection, this option determines whether the
+ * chart should receive one color per series or one color per point. Defaults to false.
+ * @default false
+ * @since 2.0
+ */
colorByPoint?: boolean;
- cropThreshold?: number;
+ /**
+ * A series specific or series type specific color set to apply instead of the global colors when colorByPoint is
+ * true.
+ * @since 3.0
+ */
colors?: string[];
- cursor?: string;
- dataLabels?: HighchartsDataLabels;
+ /**
+ * Depth of the columns in a 3D column chart. Requires highcharts-3d.js.
+ * @default 25
+ * @since 4.0
+ */
depth?: number;
+ /**
+ * 3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the
+ * column.
+ */
edgeColor?: string;
+ /**
+ * 3D columns only. The width of the colored edges.
+ * @default 1
+ */
edgeWidth?: number;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
+ /**
+ * Padding between each value groups, in x axis units.
+ * @default 0.2
+ */
groupPadding?: number;
+ /**
+ * The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.
+ * @default 1
+ * @since 4.0
+ */
groupZPadding?: number;
+ /**
+ * Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be
+ * laid out individually and overlap each other.
+ * @default true
+ * @since 2.3.0
+ */
grouping?: boolean;
- linkedTo?: string;
+ /**
+ * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the
+ * columns from becoming too wide when there is a small number of points in the chart.
+ * @default null
+ * @since 4.1.8
+ */
+ maxPointWidth?: number;
+ /**
+ * The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or
+ * close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts,
+ * minPointLength might not be respected for tightly packed values.
+ * @default 0
+ */
minPointLength?: number;
- negativeColor?: string;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPadding?: number;
- pointPlacement?: string | number; // null, "on", "between"
+ /**
+ * Padding between each column or bar, in x axis units.
+ * @default 0.1
+ */
+ pointPadding?: string | number;
+ /**
+ * The X axis range that each point is valid for. This determines the width of the column. On a categorized axis,
+ * the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as
+ * the distance between the two closest data points.
+ * @since 2.3
+ */
pointRange?: number;
- pointStart?: number;
+ /**
+ * A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the
+ * pointPadding and groupPadding.
+ * @since 1.2.5
+ */
pointWidth?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- stacking?: string;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
states?: {
- hover: HighchartsBarStates;
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsBarStates;
};
- stickyTracking?: boolean;
- threshold?: number;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
}
-interface HighchartsBoxPlotChart {
- allowPointSelect?: boolean;
- color?: string;
- colorByPoint?: boolean;
- colors?: string[];
- cursor?: string;
- depth?: number;
- edgecolor?: string;
- edgewidth?: number;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
+/**
+ * A box plot is a convenient way of depicting groups of data through their five-number summaries: the smallest
+ * observation (sample minimum), lower quartile (Q1), median (Q2), upper quartile (Q3), and largest observation (sample
+ * maximum).
+ */
+interface HighchartsBoxPlotChart extends HighchartsErrorBarChart {
+ /**
+ * The fill color of the box.
+ * @default '#FFFFFF'
+ * @since 3.0
+ */
fillColor?: string;
+ /**
+ * Padding between each value groups, in x axis units.
+ * @default 0.2
+ */
groupPadding?: number;
- groupZPadding?: number;
+ /**
+ * Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be
+ * laid out individually and overlap each other.
+ * @default true
+ * @since 2.3.0
+ */
grouping?: boolean;
- lineWidth?: number;
+ /**
+ * The id of another series to link to. Additionally, the value can be ':previous' to link to the previous series.
+ * When two series are linked, only the first one appears in the legend. Toggling the visibility of this also
+ * toggles the linked series.
+ * @since 3.0
+ */
linkedTo?: string;
+ /**
+ * The color of the median line. If null, the general series color applies.
+ * @default null
+ * @since 3.0
+ */
medianColor?: string;
- negativeColor?: string;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPadding?: number;
- pointPlacement?: string | number;
- pointRange?: number;
- pointStart?: number;
- pointWidth?: number;
- selected?: boolean;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- states?: {
- hover: HighchartsBarStates;
- };
- stemColor?: string;
- stemDashStyle?: string;
- stemWidth?: number;
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
- whiskerColor?: string;
- whiskerLength?: number | string; // 100 | "50%"
- whiskerWidth?: number;
+ /**
+ * The pixel width of the median line. If null, the lineWidth is used.
+ * @default 2
+ * @since 3.0
+ */
+ medianWidth?: number;
}
-interface HighchartsBubbleChart {
- allowPointSelect?: boolean;
- animation?: boolean;
- color?: string;
- cropThreshold?: number;
- cursor?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
- dataLabels?: HighchartsRangeDataLabels;
+/**
+ * A bubble series is a three dimensional series type where each point renders an X, Y and Z value. Each points is drawn
+ * as a bubble where the position along the X and Y axes mark the X and Y values, and the size of the bubble relates to
+ * the Z value.
+ */
+interface HighchartsBubbleChart extends HighchartsSeriesChart {
+ /**
+ * Whether to display negative sized bubbles. The threshold is given by the zThreshold option, and negative bubbles
+ * can be visualized by setting negativeColor.
+ * @default true
+ * @since 3.0
+ */
displayNegative?: boolean;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- lineWidth?: number;
- linkedTo?: string;
- marker?: HighchartsMarker;
- maxSize?: string;
- minSize?: string;
+ /**
+ * Maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of
+ * each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width
+ * and height.
+ * @default '20%'
+ * @since 3.0
+ */
+ maxSize?: string | number;
+ /**
+ * Minimum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of
+ * each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width
+ * and height.
+ * @default 8
+ * @since 3.0
+ */
+ minSize?: string | number;
+ /**
+ * When a point's Z value is below the zThreshold setting, this color is used.
+ * @default null
+ * @since 3.0
+ */
negativeColor?: string;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointStart?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
+ /**
+ * Whether the bubble's value should be represented by the area or the width of the bubble. The default, area,
+ * corresponds best to the human perception of the size of each bubble.
+ * @default 'area'
+ * @since 3.0.7
+ */
sizeBy?: string;
- states?: {
- hover: HighchartsBarStates;
- };
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
+ /**
+ * When this is true, the absolute value of z determines the size of the bubble. This means that with the default
+ * zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0
+ * will have a smaller size according to minSize.
+ * @default false
+ * @since 4.1.9
+ */
+ sizeByAbsoluteValues?: boolean;
+ /**
+ * The maximum for the Z value range. Defaults to the highest Z value in the data.
+ * @default null
+ * @since 4.0.3
+ */
zMax?: number;
+ /**
+ * The minimum for the Z value range. Defaults to the lowest Z value in the data.
+ * @default null
+ * @since 4.0.3
+ */
zMin?: number;
+ /**
+ * When displayNegative is false, bubbles with lower Z values are skipped. When displayNegative is true and a
+ * negativeColor is given, points with lower Z is colored.
+ * @default 0
+ * @since 3.0
+ */
zThreshold?: number;
}
interface HighchartsColumnChart extends HighchartsBarChart {
}
-interface HighchartsColumnRangeChart {
- allowPointSelect?: boolean;
- animation?: boolean;
- borderColor?: string;
- borderRadius?: number;
- borderWidth?: number;
- color?: string;
- colorByPoint?: boolean;
- colors?: string[];
- cropThreshold?: number;
- cursor?: string;
+/**
+ * The column range is a cartesian series type with higher and lower Y values along an X axis. Requires
+ * highcharts-more.js. To display horizontal bars, set chart.inverted to true.
+ */
+interface HighchartsColumnRangeChart extends HighchartsColumnChart {
dataLabels?: HighchartsRangeDataLabels;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- groupPadding?: number;
- grouping?: boolean;
- linkedTo?: string;
- minPointLength?: number;
- negativeColor?: string;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPadding?: number;
- pointPlacement?: string | number; // null, "on", "between"
- pointRange?: number;
- pointStart?: number;
- pointWidth?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- stacking?: string;
- states?: {
- hover: HighchartsBarStates;
- };
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
}
-interface HighchartsErrorBarChart {
- // TODO
-}
-
-interface HighchartsFunnelChart {
- // TODO
-}
-
-interface HighchartsGaugeChart {
- animation?: boolean;
- color?: string;
- cursor?: string;
- datalabels?: HighchartsDataLabels;
- dial?: HighchartsDial;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- id?: string;
- pivot?: HighchartsPivot;
- point?: {
- events: HighchartsPointEvents;
- };
- selected?: boolean;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- states?: {
- hover: HighchartsAreaStates;
- };
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- visible?: boolean;
- zIndex?: number;
-}
-
-interface HighchartsHeatMapChart {
- // TODO
-}
-
-interface HighchartsLineChart {
- allowPointSelect?: boolean;
- animation?: boolean;
- color?: string;
- connectEnds?: boolean;
- connectNulls?: boolean;
- cropThreshold?: number;
- cursor?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
- dataLabels?: HighchartsDataLabels;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- id?: string;
- lineWidth?: number;
- marker?: HighchartsMarker;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPlacement?: string | number; // null, "on", "between"
- pointStart?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- stacking?: string;
- states?: {
- hover: HighchartsAreaStates;
- };
- step?: boolean|string;
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
- zIndex?: number;
-}
-
-interface HighchartsPieChart {
- allowPointSelect?: boolean;
- animation?: boolean;
- borderColor?: string;
- borderWidth?: number;
- center?: string[];
+/**
+ * Error bars are a graphical representation of the variability of data and are used on graphs to indicate the error, or
+ * uncertainty in a reported measurement.
+ */
+interface HighchartsErrorBarChart extends HighchartsSeriesChart {
+ /**
+ * When using automatic point colors pulled from the options.colors collection, this option determines whether the
+ * chart should receive one color per series or one color per point.
+ * @default false
+ * @since 2.0
+ */
+ colorByPoint?: boolean;
+ /**
+ * A series specific or series type specific color set to apply instead of the global colors when colorByPoint is
+ * true.
+ * @since 3.0
+ */
colors?: string[];
- cursor?: string;
- dataLabels?: HighchartsDataLabels;
+ /**
+ * Depth of the columns in a 3D column chart. Requires highcharts-3d.js.
+ * @default 25
+ * @since 4.0
+ */
depth?: number;
- enableMouseTracking?: boolean;
- endAngle?: number;
- events?: HighchartsPlotEvents;
- getExtremesFromAll?: boolean;
- id?: string;
- ignoreHiddenPoint?: boolean;
- innerSize?: number | string;
- lineWidth?: number;
- marker?: HighchartsMarker;
+ /**
+ * 3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the
+ * column.
+ */
+ edgeColor?: string;
+ /**
+ * 3D columns only. The width of the colored edges.
+ * @default 1
+ */
+ edgeWidth?: number;
+ /**
+ * The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.
+ * @default 1
+ * @since 4.0
+ */
+ groupZPadding?: number;
+ /**
+ * The parent series of the error bar. The default value links it to the previous series. Otherwise, use the id of
+ * the parent series.
+ * @default ':previous'
+ * @since 3.0
+ */
+ linkedTo?: string;
+ /**
+ * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the
+ * columns from becoming too wide when there is a small number of points in the chart.
+ * @default null
+ * @since 4.1.8
+ */
+ maxPointWidth?: number;
+ /**
+ * Padding between each column or bar, in x axis units.
+ * @default 0.1
+ */
+ pointPadding?: number;
+ /**
+ * The X axis range that each point is valid for. This determines the width of the column. On a categorized axis,
+ * the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as
+ * the distance between the two closest data points.
+ * @since 2.3
+ */
+ pointRange?: number;
+ /**
+ * A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the
+ * pointPadding and groupPadding.
+ * @since 1.2.5
+ */
+ pointWidth?: number;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
+ states?: {
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsBarStates;
+ };
+ /**
+ * The color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is
+ * used.
+ * @default null
+ * @since 3.0
+ */
+ stemColor?: string;
+ /**
+ * The dash style of the stem, the vertical line extending from the box to the whiskers.
+ * @default 'Solid'
+ * @since 3.0
+ */
+ stemDashStyle?: string;
+ /**
+ * The width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited
+ * from the lineWidth option.
+ * @default null
+ * @since 3.0
+ */
+ stemWidth?: number;
+ /**
+ * The color of the whiskers, the horizontal lines marking low and high values. When null, the general series color
+ * is used.
+ * @default null
+ * @since 3.0
+ */
+ whiskerColor?: string;
+ /**
+ * The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value,
+ * or a percentage value of the box width. Set 0 to disable whiskers.
+ * @default '50%'
+ * @since 3.0
+ */
+ whiskerLength?: number | string;
+ /**
+ * The line width of the whiskers, the horizontal lines marking low and high values. When null, the general
+ * lineWidth applies.
+ * @default 2
+ * @since 3.0
+ */
+ whiskerWidth?: number;
+}
+
+/**
+ * Funnel charts are a type of chart often used to visualize stages in a sales project, where the top are the initial
+ * stages with the most clients. It requires that the modules/funnel.js file is loaded
+ */
+interface HighchartsFunnelChart extends HighchartsSeriesChart {
+ /**
+ * The color of the border surrounding each column or bar.
+ * @default '#FFFFFF'
+ */
+ borderColor?: string;
+ /**
+ * The width of the border surrounding each column or bar.
+ * @default 1
+ */
+ borderWidth?: number;
+ /**
+ * The center of the series. By default, it is centered in the middle of the plot area, so it fills the plot area
+ * height.
+ * @default ['50%', '50%']
+ * @since 3.0
+ */
+ center?: [string|number, string|number];
+ /**
+ * A series specific or series type specific color set to use instead of the global colors.
+ * @since 3.0
+ */
+ colors?: string[];
+ dataLabels?: HighchartsPieDataLabels;
+ /**
+ * The thickness of a 3D pie. Requires highcharts-3d.js
+ * @default 0
+ * @since 4.0
+ */
+ depth?: number;
+ /**
+ * The height of the funnel or pyramid. If it is a number it defines the pixel height, if it is a percentage string
+ * it is the percentage of the plot area height.
+ * @since 3.0
+ */
+ height?: number | string;
+ /**
+ * The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels
+ * in side the plot area, but only to this size.
+ * @default 80
+ * @since 3.0
+ */
minSize?: number;
- point?: {
- events: HighchartsPointEvents;
- };
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showInLegend?: boolean;
- size?: number | string;
+ /**
+ * The height of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a
+ * percentage of the plot area height.
+ * @default '25%'
+ */
+ neckHeight?: number | string;
+ /**
+ * The width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a
+ * percentage of the plot area width.
+ * @default '30%'
+ * @since 3.0
+ */
+ neckWidth?: number | string;
+ /**
+ * A reversed funnel has the widest area down. A reversed funnel with no neck width and neck height is a pyramid.
+ * @default false
+ * @since 3.0.10
+ */
+ reversed?: boolean;
+ /**
+ * If a point is sliced, moved out from the center, how many pixels should it be moved?
+ * @default 10
+ */
slicedOffset?: number;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
+ states?: {
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsPieStates;
+ };
+ /**
+ * The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.
+ * @default '90%'
+ * @since 3.0
+ */
+ width?: number | string;
+}
+
+/**
+ * General plotting options for the gauge series type. Requires highcharts-more.js
+ */
+interface HighchartsGaugeChart extends HighchartsSeriesChart {
+ /**
+ * Data labels for the gauge. For gauges, the data labels are enabled by default and shown in a bordered box below
+ * the point.
+ */
+ datalabels?: HighchartsDataLabels;
+ /**
+ * Options for the dial or arrow pointer of the gauge.
+ */
+ dial?: HighchartsDial;
+ /**
+ * Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0
+ * to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis. Defaults to 0.
+ * @default 0
+ * @since 3.0.10
+ */
+ overshoot?: number;
+ /**
+ * Options for the pivot or the center point of the gauge.
+ * @since 2.3.0
+ */
+ pivot?: HighchartsPivot;
+ /**
+ * When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to
+ * 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.
+ * @default true
+ * @since 3.0
+ */
+ wrap?: boolean;
+}
+
+/**
+ * The heatmap series type. This series type is available both in Highcharts and Highmaps.
+ * The colors of each heat map point is usually determined by its value and controlled by settings on the colorAxis.
+ */
+interface HighchartsHeatMapChart extends HighchartsSeriesChart {
+ /**
+ * The color of the border surrounding each column or bar.
+ * @default '#FFFFFF'
+ */
+ borderColor?: string;
+ /**
+ * The corner radius of the border surrounding each column or bar.
+ * @default 0
+ */
+ borderRadius?: number;
+ /**
+ * The width of the border surrounding each column or bar.
+ * @default 1
+ */
+ borderWidth?: number;
+ /**
+ * When using automatic point colors pulled from the options.colors collection, this option determines whether the
+ * chart should receive one color per series or one color per point. Defaults to false.
+ * @default false
+ * @since 2.0
+ */
+ colorByPoint?: boolean;
+ /**
+ * A series specific or series type specific color set to apply instead of the global colors when colorByPoint is
+ * true.
+ * @since 3.0
+ */
+ colors?: string[];
+ /**
+ * The columns size - how many X axis units each column in the heatmap should span.
+ * @default 1
+ * @since 4.0
+ */
+ colsize?: number;
+ /**
+ * When the series contains less points than the crop threshold, all points are drawn, event if the points fall
+ * outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and
+ * columns), is that animation is performed on updates. On the other hand, when the series contains more points than
+ * the crop threshold, the series data is cropped to only contain points that fall within the plot area. The
+ * advantage of cropping away invisible points is to increase performance on large series.
+ * @default 50
+ */
+ cropTreshold?: number;
+ /**
+ * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the
+ * columns from becoming too wide when there is a small number of points in the chart.
+ * @default null
+ * @since 4.1.8
+ */
+ maxPointWidth?: number;
+ /**
+ * The row size - how many Y axis units each heatmap row should span.
+ * @default 1
+ * @since 4.0
+ */
+ rowsize?: number;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
+ states?: {
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsBarStates;
+ }
+}
+
+interface HighchartsLineChart extends HighchartsSeriesChart {
+ /**
+ * Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was
+ * supported.
+ * @default false
+ * @since 1.2.5
+ */
+ step?: boolean|string;
+}
+
+/**
+ * A pie chart is a circular chart divided into sectors, illustrating numerical proportion.
+ */
+interface HighchartsPieChart extends HighchartsSeriesChart {
+ /**
+ * The color of the border surrounding each column or bar.
+ * @default '#FFFFFF'
+ */
+ borderColor?: string;
+ /**
+ * The width of the border surrounding each column or bar.
+ * @default 1
+ */
+ borderWidth?: number;
+ /**
+ * The center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour
+ * (as of 3.0) is to center the pie so that all slices and data labels are within the plot area. As a consequence,
+ * the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the
+ * center should be explicitly set, for example to ['50%', '50%'].
+ * @default [null, null]
+ */
+ center?: [string|number, string|number];
+ /**
+ * A series specific or series type specific color set to use instead of the global colors.
+ * @since 3.0
+ */
+ colors?: string[];
+ dataLabels?: HighchartsPieDataLabels;
+ /**
+ * The thickness of a 3D pie. Requires highcharts-3d.js
+ * @default 0
+ * @since 4.0
+ */
+ depth?: number;
+ /**
+ * The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to startAngle plus 360.
+ * @default null
+ * @since 1.3.6
+ */
+ endAngle?: number;
+ /**
+ * Equivalent to chart.ignoreHiddenSeries, this option tells whether the series shall be redrawn as if the hidden
+ * point were null.
+ *
+ * The default value changed from false to true with Highcharts 3.0.
+ *
+ * @default true
+ * @since 2.3.0
+ */
+ ignoreHiddenPoint?: boolean;
+ /**
+ * The size of the inner diameter for the pie. A size greater than 0 renders a donut chart. Can be a percentage or
+ * pixel value. Percentages are relative to the pie size. Pixel values are given as integers.
+ *
+ * Note: in Highcharts < 4.1.2, the percentage was relative to the plot area, not the pie size.
+ * @default 0
+ * @since 2.0
+ */
+ innerSize?: number | string;
+ /**
+ * The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels
+ * in side the plot area, but only to this size.
+ * @default 80
+ * @since 3.0
+ */
+ minSize?: number;
+ /**
+ * The diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as
+ * integers. The default behaviour (as of 3.0) is to scale to the plot area and give room for data labels within the
+ * plot area. As a consequence, the size of the pie may vary when points are updated and data labels more around. In
+ * that case it is best to set a fixed value, for example '75%'.
+ */
+ size?: number | string;
+ /**
+ * If a point is sliced, moved out from the center, how many pixels should it be moved?
+ * @default 10
+ */
+ slicedOffset?: number;
+ /**
+ * The start angle of the pie slices in degrees where 0 is top and 90 right.
+ * @default 0
+ * @since 2.3.4
+ */
startAngle?: number;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
states?: {
- hover: HighchartsAreaStates;
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsPieStates;
};
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- visible?: boolean;
- zIndex?: number;
}
-interface HighchartsPolygonChart {
- // TODO
-}
-
-interface HighchartsPyramidChart {
- // TODO
-}
-
-interface HighchartsScatterChart {
- allowPointSelect?: boolean;
- animation?: boolean;
- color?: string;
- connectNulls?: boolean;
- cropThreshold?: number;
- cursor?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
- dataLabels?: HighchartsDataLabels;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- id?: string;
+/**
+ * A polygon series can be used to draw any freeform shape in the cartesian coordinate system. A fill is applied with
+ * the color option, and stroke is applied through lineWidth and lineColor options. Requires the highcharts-more.js
+ * file.
+ */
+interface HighchartsPolygonChart extends HighchartsSeriesChart {
+ /**
+ * The width of the line connecting the data points.
+ * @default 0
+ */
lineWidth?: number;
- marker?: HighchartsMarker;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPlacement?: string | number; // null, "on", "between"
- pointStart?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
+}
+
+interface HighchartsPyramidChart extends HighchartsSeriesChart {
+ /**
+ * The color of the border surrounding each slice
+ * @default '#FFFFFF'
+ */
+ borderColor?: string;
+ /**
+ * The width of the border surrounding each slice
+ * @default 1
+ */
+ borderWidth?: number;
+ /**
+ * The center of the series. By default, it is centered in the middle of the plot area, so it fills the plot area
+ * height.
+ * @default ['50%', '50%']
+ * @since 3.0
+ */
+ center?: [string|number, string|number];
+ /**
+ * A series specific or series type specific color set to use instead of the global colors.
+ * @since 3.0
+ */
+ colors?: string[];
+ dataLabels?: HighchartsPieDataLabels;
+ /**
+ * The thickness of a 3D pie. Requires highcharts-3d.js
+ * @default 0
+ * @since 4.0
+ */
+ depth?: number;
+ /**
+ * The height of the funnel or pyramid. If it is a number it defines the pixel height, if it is a percentage string
+ * it is the percentage of the plot area height.
+ * @since 3.0
+ */
+ height?: number | string;
+ /**
+ * The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels
+ * in side the plot area, but only to this size.
+ * @default 80
+ * @since 3.0
+ */
+ minSize?: number;
+ /**
+ * The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not
+ * reversed.
+ * @default true
+ * @since 3.0.10
+ */
+ reversed?: boolean;
+ /**
+ * If a point is sliced, moved out from the center, how many pixels should it be moved?
+ * @default 10
+ */
+ slicedOffset?: number;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
states?: {
- hover: HighchartsAreaStates;
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsPieStates;
};
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
- zIndex?: number;
+ /**
+ * The width of the pyramid compared to the width of the plot area, or the pixel width if it is a number.
+ * @default '90%'
+ * @since 3.0
+ */
+ width?: number | string;
}
-interface HighchartsSolidGaugeChart {
- // TODO
+interface HighchartsScatterChart extends HighchartsSeriesChart { }
+
+/**
+ * A gauge showing values using a filled arc with colors indicating the value. The solid gauge plots values against the
+ * yAxis, which is extended with some color options, minColor, maxColor and stops, to control the color of the gauge
+ * itself.
+ */
+interface HighchartsSolidGaugeChart extends HighchartsSeriesChart {
+ /**
+ * Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0
+ * to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis.
+ * @default 0
+ * @since 3.0.10
+ */
+ overshoot?: number;
+ /**
+ * When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to
+ * 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.
+ * @default true
+ * @since 3.0
+ */
+ wrap?: boolean;
}
-interface HighchartsSplineChart extends HighchartsSeriesChart {
-}
+interface HighchartsSplineChart extends HighchartsSeriesChart { }
-interface HighchartsTreeMapChart {
- // TODO
-}
-
-interface HighchartsWaterFallChart {
- // TODO
-}
-
-
-// General options for all series types
-interface HighchartsSeriesChart {
- allowPointSelect?: boolean;
- animation?: boolean;
- color?: string;
- connectEnds?: boolean;
- connectNulls?: boolean;
- cropThreshold?: number;
- cursor?: string;
- dashStyle?: string; //Solid ShortDash ShortDot ShortDashDot ShortDashDotDot Dot Dash LongDash DashDot LongDashDot LongDashDotDot
- dataLabels?: HighchartsDataLabels;
- enableMouseTracking?: boolean;
- events?: HighchartsPlotEvents;
- lineWidth?: number;
- marker?: HighchartsMarker;
- point?: {
- events: HighchartsPointEvents;
- };
- pointInterval?: number;
- pointPlacement?: string | number; // null, "on", "between"
- pointStart?: number;
- selected?: boolean;
- shadow?: boolean | HighchartsShadow;
- showCheckbox?: boolean;
- showInLegend?: boolean;
- stacking?: string;
+/**
+ * The size of the point shape is determined by its value relative to its siblings values. Requires the module
+ * heatmap.js as well, if functionality such as the colorAxis is to be used.
+ */
+interface HighchartsTreeMapChart extends HighchartsSeriesChart {
+ /**
+ * When enabled the user can click on a point which is a parent and zoom in on its children.
+ * @default false
+ * @since 4.1.0
+ */
+ allowDrillToNode?: boolean;
+ /**
+ * Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal. The
+ * next levels starting direction will always be the opposite of the previous.
+ * @default false
+ * @since 4.1.0
+ */
+ alternateStartingDirection?: boolean;
+ /**
+ * The color of the border surrounding each tree map item.
+ * @default '#E0E0E0'
+ */
+ borderColor?: string;
+ /**
+ * The width of the border surrounding each column or bar.
+ * @default 1
+ */
+ borderWidth?: number;
+ /**
+ * When using automatic point colors pulled from the options.colors collection, this option determines whether the
+ * chart should receive one color per series or one color per point.
+ * @default false
+ * @since 2.0
+ */
+ colorByPoint?: boolean;
+ /**
+ * A series specific or series type specific color set to apply instead of the global colors when colorByPoint is
+ * true.
+ * @since 3.0
+ */
+ colors?: string[];
+ /**
+ * This option decides if the user can interact with the parent nodes or just the leaf nodes. When this option is
+ * undefined, it will be true by default. However when allowDrillToNode is true, then it will be false by default.
+ * @since 4.1.2
+ */
+ interactByLeaf?: boolean;
+ /**
+ * This option decides which algorithm is used for setting position and dimensions of the points. Can be one of
+ * 'sliceAndDice', 'stripes', 'squarified' or 'strip'.
+ * @default 'sliceAndDice'
+ * @since 4.1.0
+ */
+ layoutAlgorithm?: string;
+ /**
+ * Defines which direction the layout algorithm will start drawing. Possible values are 'vertical' and 'horizontal'.
+ * @default 'vertical'
+ * @since 4.1.0
+ */
+ layoutStartingDirection?: string;
+ /**
+ * Used together with the levels and allowDrillToNode options. When set to false the first level visible when
+ * drilling is considered to be level one. Otherwise the level will be the same as the tree structure.
+ * @default true
+ * @since 4.1.0
+ */
+ levelIsConstant?: boolean;
+ /**
+ * Set options on specific levels. Takes precedence over series options, but not point options.
+ */
+ levels?: HighchartsTreeMapLevel[];
+ /**
+ * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the
+ * columns from becoming too wide when there is a small number of points in the chart.
+ * @default null
+ * @since 4.1.8
+ */
+ maxPointWidth?: number;
+ /**
+ * A wrapper object for all the series options in specific states.
+ */
states?: {
- hover: HighchartsAreaStates;
- };
- stickyTracking?: boolean;
- tooltip?: HighchartsTooltipOptions;
- turboThreshold?: number;
- visible?: boolean;
- zIndex?: number;
+ /**
+ * Options for the hovered series
+ */
+ hover?: HighchartsBarStates;
+ }
}
+interface HighchartsWaterFallChart extends HighchartsBarChart {
+ /**
+ * A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline,
+ * area and scatter in case it has a lineWidth. The value for the dashStyle include:
+ * - Solid
+ * - ShortDash
+ * - ShortDot
+ * - ShortDashDot
+ * - ShortDashDotDot
+ * - Dot
+ * - Dash
+ * - LongDash
+ * - DashDot
+ * - LongDashDot
+ * - LongDashDotDot
+ * @default 'Dot'
+ */
+ dashStyle?: string;
+ /**
+ * The color of the line that connects columns in a waterfall series.
+ * @default '#333333'
+ * @since 3.0
+ */
+ lineColor?: string;
+ /**
+ * The color used specifically for positive point columns. When not specified, the general series color is used.
+ */
+ upColor?: string;
+}
+
+/**
+ * The plotOptions is a wrapper object for config objects for each series type. The config objects for each series can
+ * also be overridden for each series item as given in the series array.
+ *
+ * Configuration options for the series are given in three levels. Options for all series in a chart are given in the
+ * plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of that type,
+ * for example plotOptions.line. Next, options for one single series are given in the series array.
+ */
interface HighchartsPlotOptions {
area?: HighchartsAreaChart;
arearange?: HighchartsAreaRangeChart;
@@ -1056,15 +4798,79 @@ interface HighchartsPlotOptions {
* interfaces (HighchartsAreaChartSeriesOptions, HighchartsLineChartSeriesOptions, etc.)
*/
interface HighchartsIndividualSeriesOptions {
- data?: number[]|[number, number][]| HighchartsDataPoint[]; // [value1,value2, ... ] | [[x1,y1],[x2,y2],... ] | HighchartsDataPoint[]
- id?: string;
- index?: number;
- legendIndex?: number;
- name?: string;
- stack?: any; // type doesn't matter, as long as grouped series' stack options match each other.
type?: string;
+ /**
+ * An array of data points for the series. For the area series type, points can be given in the following ways:
+ *
+ * 1. An array of numerical values. In this case, the numerical values will be interpreted as y options. The x
+ * values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart and
+ * pointInterval given in the series options. If the axis has categories, these will be used. Example:
+ * data: [0, 5, 3, 5]
+ *
+ * 2. An array of arrays with 2 values. In this case, the values correspond to x,y. If the first value is a string,
+ * it is applied as the name of the point, and the x value is inferred.
+ * data: [
+ * [0, 9],
+ * [1, 7],
+ * [2, 6]
+ * ]
+ *
+ * 3. An array of objects with named values. The objects are point configuration objects as seen below. If the total
+ * number of data points exceeds the series' turboThreshold, this option is not available.
+ * data: [{
+ * x: 1,
+ * y: 9,
+ * name: 'Point2',
+ * color: '#00FF00'
+ * }, {
+ * x: 1,
+ * y: 6,
+ * name: 'Point1',
+ * color: '#FF00FF'
+ * }]
+ */
+ data?: number[] | [number, number][] | [string, number][] | HighchartsDataPoint[];
+ /**
+ * An id for the series. This can be used after render time to get a pointer to the series object through
+ * chart.get().
+ */
+ id?: string;
+ /**
+ * The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index
+ * as well as the order in the legend.
+ * @since 2.3.0
+ */
+ index?: number;
+ /**
+ * The sequential index of the series in the legend.
+ */
+ legendIndex?: number;
+ /**
+ * The name of the series as shown in the legend, tooltip etc.
+ */
+ name?: string;
+ /**
+ * This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything
+ * else, as long as the grouped series' stack options match each other.
+ * @since 2.1
+ */
+ stack?: any;
+ /**
+ * When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It
+ * refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
+ * @default 0
+ */
xAxis?: string | number;
+ /**
+ * When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It
+ * refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
+ * @default 0
+ */
yAxis?: string | number;
+ /**
+ * Define the visual z index of the series.
+ */
+ zIndex?: number;
}
interface HighchartsSeriesOptions extends HighchartsIndividualSeriesOptions, HighchartsSeriesChart { }
@@ -1093,42 +4899,231 @@ interface HighchartsTreeMapChartSeriesOptions extends HighchartsIndividualSeries
interface HighchartsWaterFallChartSeriesOptions extends HighchartsIndividualSeriesOptions, HighchartsWaterFallChart { }
interface HighchartsDataPoint {
+ /**
+ * Individual color for the point. By default the color is pulled from the global colors array.
+ * @default undefined
+ */
color?: string;
+ /**
+ * Serves a purpose only if a colorAxis object is defined in the chart options. This value will decide which color
+ * the point gets from the scale of the colorAxis.
+ * @default undefined
+ */
+ colorValue?: number;
+ /**
+ * Individual data label for each point. The options are the same as the ones for plotOptions.series.dataLabels
+ */
dataLabels?: HighchartsDataLabels;
+ /**
+ * The id of a series in the drilldown.series array to use for a drilldown for this point.
+ * @since 3.0.8
+ */
+ drilldown?: string;
+ /**
+ * Individual point events
+ */
events?: HighchartsPointEvents;
+ /**
+ * The high or maximum value for each data point.
+ */
+ high?: number;
+ /**
+ * An id for the point. This can be used after render time to get a pointer to the point object through chart.get().
+ * @since 1.2.0
+ */
id?: string;
+ /**
+ * The inner radius of an individual point in a solid gauge. Can be given as a number (pixels) or percentage string.
+ * @since 4.1.6
+ */
+ innerRadius?: number;
+ /**
+ * When this property is true, the points acts as a summary column for the values added or substracted since the
+ * last intermediate sum, or since the start of the series. The y value is ignored.
+ * @default false
+ */
+ isIntermediateSum?: boolean;
+ /**
+ * When this property is true, the point display the total sum across the entire series. The y value is ignored.
+ * @default false
+ */
+ isSum?: boolean;
+ /**
+ * The sequential index of the data point in the legend.
+ */
legendIndex?: number;
+ /**
+ * The low or minimum value for each data point.
+ */
+ low?: number;
marker?: HighchartsMarker;
+ /**
+ * The median for each data point. This is drawn as a line through the middle area of the box.
+ */
+ median?: number;
+ /**
+ * The name of the point as shown in the legend, tooltip, dataLabel etc.
+ *
+ * If the xAxis.type is set to category, and no categories option exists, the category will be pulled from the
+ * point.name of the last series defined. For multiple series, best practice however is to define xAxis.categories.
+ */
name?: string;
+ /**
+ * Only for treemap. Use this option to build a tree structure. The value should be the id of the point which is the
+ * parent. If no points has a matching id, or this option is undefined, then the parent will be set to the root.
+ * @default undefined
+ * @since 4.1.0
+ */
+ parent?: string;
+ /**
+ * The lower quartile for each data point. This is the bottom of the box.
+ */
+ q1?: number;
+ /**
+ * The higher quartile for each data point. This is the top of the box.
+ */
+ q3?: number;
+ /**
+ * The outer radius of an individual point in a solid gauge. Can be given as a number (pixels) or percentage string.
+ * @since 4.1.6
+ */
+ radius?: number;
+ /**
+ * Whether the data point is selected initially.
+ * @default false
+ */
+ selected?: boolean;
+ /**
+ * Whether to display a slice offset from the center.
+ * @default false
+ */
sliced?: boolean;
+ /**
+ * The value of the point, resulting in a relative area of the point in the treemap.
+ */
+ value?: number;
+ /**
+ * The x value of the point. For datetime axes, the X value is the timestamp in milliseconds since 1970.
+ */
x?: number;
+ /**
+ * The y value of the point.
+ */
y?: number;
+ /**
+ * The size value for each bubble. The bubbles' diameters are computed based on the z, and controlled by series
+ * options like minSize, maxSize, sizeBy, zMin and zMax.
+ */
+ z?: number;
}
-interface HighchartsSeriesOptions extends HighchartsSeriesChart {
- type?: string;
- data?: number[]| number[][]| HighchartsDataPoint[];
- index?: number;
- legendIndex?: number;
- name?: string;
- stack?: string | number;
- xAxis?: string | number;
- yAxis?: string | number;
-}
-
+/**
+ * The chart's subtitle
+ */
interface HighchartsSubtitleOptions {
+ /**
+ * The horizontal alignment of the subtitle. Can be one of 'left', 'center' and 'right'.
+ * @default 'center'
+ * @since 2.0
+ */
align?: string;
- verticalAlign?: string;
+ /**
+ * When the subtitle is floating, the plot area will not move to make space for it.
+ * @default false
+ * @since 2.1
+ */
floating?: boolean;
- style?: HighchartsCSSObject;
+ /**
+ * CSS styles for the title. Exact positioning of the title can be achieved by changing the margin property, or by
+ * adding position: 'absolute' and left and top properties.
+ * @default { 'color': '#555555' }
+ */
+ style?: Object;
+ /**
+ * The subtitle of the chart.
+ */
text?: string;
+ /**
+ * Whether to {@link http://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html|use HTML} to render the text.
+ * @default false
+ */
useHTML?: boolean;
+ /**
+ * The vertical alignment of the title. Can be one of 'top', 'middle' and 'bottom'. When a value is given, the title
+ * behaves as floating.
+ * @since 2.1
+ */
+ verticalAlign?: string;
+ /**
+ * The x position of the subtitle relative to the alignment within chart.spacingLeft and chart.spacingRight.
+ * @default 0
+ * @since 2.0
+ */
x?: number;
+ /**
+ * The y position of the subtitle relative to the alignment within chart.spacingTop and chart.spacingBottom. By
+ * default the subtitle is laid out below the title unless the title is floating.
+ * @default null
+ * @since 2.0
+ */
y?: number;
}
-interface HighchartsTitleOptions extends HighchartsSubtitleOptions {
+interface HighchartsTitleOptions {
+ /**
+ * The horizontal alignment of the title. Can be one of 'left', 'center' and 'right'.
+ * @default 'center'
+ * @since 2.0
+ */
+ align?: string;
+ /**
+ * When the title is floating, the plot area will not move to make space for it.
+ * @default false
+ * @since 2.1
+ */
+ floating?: boolean;
+ /**
+ * The margin between the title and the plot area, or if a subtitle is present, the margin between the subtitle and
+ * the plot area.
+ * @default 15
+ * @since 2.1
+ */
margin?: number;
+ /**
+ * CSS styles for the title. Exact positioning of the title can be achieved by changing the margin property, or by
+ * adding position: 'absolute' and left and top properties.
+ * @default { 'color': '#333333', 'fontSize': '18px' }
+ */
+ style?: Object;
+ /**
+ * The title of the chart. To disable the title, set the text to null.
+ * @default 'Chart title'
+ */
+ text?: string;
+ /**
+ * Whether to {@link http://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html|use HTML} to render the text.
+ * @default false
+ */
+ useHTML?: boolean;
+ /**
+ * The vertical alignment of the title. Can be one of 'top', 'middle' and 'bottom'. When a value is given, the title
+ * behaves as floating.
+ * @since 2.1
+ */
+ verticalAlign?: string;
+ /**
+ * The x position of the title relative to the alignment within chart.spacingLeft and chart.spacingRight.
+ * @default 0
+ * @since 2.0
+ */
+ x?: number;
+ /**
+ * The y position of the title relative to the alignment within chart.spacingTop and chart.spacingBottom. By default
+ * it depends on the font size.
+ * @default null
+ * @since 2.0
+ */
+ y?: number;
}
interface HighchartsCrosshairObject {
@@ -1143,133 +5138,821 @@ interface HighchartsPlotPoint {
plotY: number;
}
-interface HighchartsTooltipOptions {
+interface HighchartsTooltipOptions extends HighchartsSeriesTooltipOptions {
+ /**
+ * Enable or disable animation of the tooltip. In slow legacy IE browsers the animation is disabled by default.
+ * @default true
+ * @since 2.3.0
+ */
animation?: boolean;
+ /**
+ * The background color or gradient for the tooltip.
+ * @default 'rgba(255, 255, 255, 0.85)'
+ */
backgroundColor?: string | HighchartsGradient;
+ /**
+ * The color of the tooltip border. When null, the border takes the color of the corresponding series or point.
+ * @default null
+ */
borderColor?: string;
+ /**
+ * The radius of the rounded border corners.
+ * @default 3
+ */
borderRadius?: number;
+ /**
+ * The pixel width of the tooltip border.
+ * @default 1
+ */
borderWidth?: number;
- crosshairs?: boolean |[boolean, boolean]| HighchartsCrosshairObject |[HighchartsCrosshairObject, HighchartsCrosshairObject];
+ /**
+ * Display crosshairs to connect the points with their corresponding axis values. The crosshairs can be defined as a
+ * boolean, an array of booleans or an object.
+ *
+ * Boolean
+ * If the crosshairs option is true, a single crosshair relating to the x axis will be shown.
+ *
+ * Array of booleans
+ * In an array of booleans, the first value turns on the x axis crosshair and the second value to the y axis
+ * crosshair. Use [true, true] to show complete crosshairs.
+ *
+ * Array of objects
+ * In an array of objects, the first value applies to the x axis crosshair and the second value to the y axis
+ * crosshair. For each dimension, a width, color, dashStyle and zIndex can be given.
+ *
+ * @default null
+ */
+ crosshairs?: boolean | [boolean, boolean] | HighchartsCrosshairObject | [HighchartsCrosshairObject, HighchartsCrosshairObject];
+ /**
+ * Enable or disable the tooltip.
+ * @default true
+ */
enabled?: boolean;
- footerFormat?: string;
- formatter?: () => any;
- pointFormat?: string;
+ /**
+ * Callback function to format the text of the tooltip. Return false to disable tooltip for a specific point on
+ * series.
+ *
+ * A subset of HTML is supported. The HTML of the tooltip is parsed and converted to SVG, therefore this isn't a
+ * complete HTML renderer. The following tabs are supported: <b>, <strong>, <i>, <em>, <br/>, <span>. Spans can be
+ * styled with a style attribute, but only text-related CSS that is shared with SVG is handled.
+ *
+ * Since version 2.1 the tooltip can be shared between multiple series through the shared option. The available data
+ * in the formatter differ a bit depending on whether the tooltip is shared or not. In a shared tooltip, all
+ * properties except x, which is common for all points, are kept in an array, this.points.
+ *
+ * Available data are:
+ * this.percentage (not shared) / this.points[i].percentage (shared)
+ * Stacked series and pies only. The point's percentage of the total.
+ * this.point (not shared) / this.points[i].point (shared)
+ * The point object. The point name, if defined, is available through this.point.name.
+ * this.points
+ * In a shared tooltip, this is an array containing all other properties for each point.
+ * this.series (not shared) / this.points[i].series (shared)
+ * The series object. The series name is available through this.series.name.
+ * this.total (not shared) / this.points[i].total (shared)
+ * Stacked series only. The total value at this point's x value.
+ * this.x
+ * The x value. This property is the same regardless of the tooltip being shared or not.
+ * this.y (not shared) / this.points[i].y (shared)
+ * The y value.
+ */
+ formatter?: () => boolean | string;
+ /**
+ * A callback function to place the tooltip in a default position. The callback receives three parameters:
+ * labelWidth, labelHeight and point, where point contains values for plotX and plotY telling where the reference
+ * point is in the plot area. Add chart.plotLeft and chart.plotTop to get the full coordinates.
+ *
+ * The return should be an object containing x and y values, for example { x: 100, y: 100 }.
+ * @since 2.2.4
+ */
positioner?: (labelWidth: number, labelHeight: number, point: HighchartsPlotPoint) => { x: number; y: number; };
+ /**
+ * Whether to apply a drop shadow to the tooltip.
+ * @default true
+ */
shadow?: boolean;
+ /**
+ * The name of a symbol to use for the border around the tooltip. In Highcharts 3.x and less, the shape was square.
+ * @default 'callout'
+ * @since 4.0
+ */
+ shape?: string;
+ /**
+ * When the tooltip is shared, the entire plot area will capture mouse movement or touch events. Tooltip texts for
+ * series types with ordered data (not pie, scatter, flags etc) will be shown in a single bubble. This is
+ * recommended for single series charts and for tablet/mobile optimized charts.
+ * @default false
+ * @since 2.1
+ */
shared?: boolean;
+ /**
+ * Proximity snap for graphs or single points. Does not apply to bars, columns and pie slices. It defaults to 10 for
+ * mouse-powered devices and 25 for touch devices. Note that since Highcharts 4.1 the whole plot area by default
+ * captures pointer events in order to show the tooltip, so for tooltip.snap to make sense, stickyTracking must be
+ * false.
+ * @since 1.2.0
+ */
snap?: number;
- style?: HighchartsCSSObject;
+ /**
+ * CSS styles for the tooltip. The tooltip can also be styled through the CSS class .highcharts-tooltip
+ * @default { color: '#333333', fontSize: '12px', padding: '8px' }
+ */
+ style?: Object;
+ /**
+ * Use HTML to render the contents of the tooltip instead of SVG. Using HTML allows advanced formatting like tables
+ * and images in the tooltip. It is also recommended for rtl languages as it works around rtl bugs in early Firefox.
+ * @default false
+ * @since 2.2
+ */
useHTML?: boolean;
+}
+
+interface HighchartsSeriesTooltipOptions {
+ /**
+ * For series on a datetime axes, the date format in the tooltip's header will by default be guessed based on the
+ * closest data points. This member gives the default string representations used for each unit.
+ */
+ dateTimeLabelFormats?: HighchartsDateTimeFormats;
+ /**
+ * Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an
+ * extent. By default it behaves this way for scatter, bubble and pie series by override in the plotOptions for
+ * those series types.
+ *
+ * For touch moves to behave the same way, followTouchMove must be true also.
+ * @default false
+ * @since 3.0
+ */
+ followPointer?: boolean;
+ /**
+ * Whether the tooltip should follow the finger as it moves on a touch device. If chart.zoomType is set, it will
+ * override followTouchMove.
+ * @default true
+ * @since 3.0.1
+ */
+ followTouchMove?: boolean;
+ /**
+ * A string to append to the tooltip format.
+ * @default 'false'
+ * @since 2.2
+ */
+ footerFormat?: string;
+ /**
+ * The HTML of the tooltip header line. Variables are enclosed by curly brackets. Available variables are point.key,
+ * series.name, series.color and other members from the point and series objects. The point.key variable contains
+ * the category name, x value or datetime string depending on the type of axis. For datetime axes, the point.key
+ * date format can be set using tooltip.xDateFormat.
+ *
+ * @default '<span style='font-size: 10px'>{point.key}</span><br/>'
+ */
+ headerFormat?: string;
+ /**
+ * The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
+ * @default 500
+ * @since 3.0
+ */
+ hideDelay?: number;
+ /**
+ * The HTML of the point's line in the tooltip. Variables are enclosed by curly brackets. Available variables are
+ * point.x, point.y, series.name and series.color and other properties on the same form. Furthermore, point.y can be
+ * extended by the tooltip.valuePrefix and tooltip.valueSuffix variables. This can also be overridden for each
+ * series, which makes it a good hook for displaying units.
+ *
+ * @default '<span style='color:{point.color}'>\u25CF</span> {series.name}: <b>{point.y}</b><br/>'
+ * @since 2.2
+ */
+ pointFormat?: string;
+ /**
+ * A callback function for formatting the HTML output for a single point in the tooltip. Like the pointFormat
+ * string, but with more flexibility.
+ *
+ * The this keyword refers to the Point object.
+ * @since 4.1.0
+ */
+ pointFormatter?: () => string;
+ /**
+ * How many decimals to show in each series' y value. This is overridable in each series' tooltip options object.
+ * The default is to preserve all decimals.
+ * @since 2.2
+ */
valueDecimals?: number;
+ /**
+ * A string to prepend to each series' y value. Overridable in each series' tooltip options object.
+ * @since 2.2
+ */
valuePrefix?: string;
+ /**
+ * A string to append to each series' y value. Overridable in each series' tooltip options object.
+ * @since 2.2
+ */
valueSuffix?: string;
+ /**
+ * The format for the date in the tooltip header if the X axis is a datetime axis. The default is a best guess based
+ * on the smallest distance between points in the chart.
+ */
xDateFormat?: string;
}
interface HighchartsOptions {
+ /**
+ * Options regarding the chart area and plot area as well as general chart options.
+ */
chart?: HighchartsChartOptions;
+ colorAxis?: HighchartsColorAxisOptions | HighchartsColorAxisOptions[];
+ /**
+ * An array containing the default colors for the chart's series. When all colors are used, new colors are pulled
+ * from the start again.
+ *
+ * Default colors can also be set on a series or series.type basis, see column.colors, pie.colors.
+ *
+ * @default ['#7cb5ec', '#434348', '#90ed7d', '#f7a35c', '#8085e9', '#f15c80', '#e4d354', '#2b908f', '#f45b5b', '#91e8e1']
+ */
colors?: string[];
+ /**
+ * Highchart by default puts a credits label in the lower right corner of the chart. This can be changed using these options.
+ */
credits?: HighchartsCreditsOptions;
- data?: any; // TODO
- drilldown?: any; // TODO
+ /**
+ * The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or
+ * grid views. See also the tutorial article on the Data module.
+ *
+ * It requires the modules/data.js file to be loaded.
+ *
+ * Please note that the default way of adding data in Highcharts, without the need of a module, is through the
+ * series.data option.
+ */
+ data?: HighchartsDataOptions;
+ /**
+ * Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart
+ * items like columns or pie slices.
+ *
+ * The drilldown feature requires the drilldown.js file to be loaded, found in the modules directory of the download
+ * package, or online at code.highcharts.com/modules/drilldown.js.
+ */
+ drilldown?: HighchartsDrilldownOptions;
+ /**
+ * Options for the exporting module.
+ */
exporting?: HighchartsExportingOptions;
+ /**
+ * HTML labels that can be positioned anywhere in the chart area.
+ */
labels?: HighchartsLabelsOptions;
+ lang?: HighchartsLangObject;
+ /**
+ * The legend is a box containing a symbol and name for each series item or point item in the chart.
+ */
legend?: HighchartsLegendOptions;
+ /**
+ * The loading options control the appearance of the loading screen that covers the plot area on chart operations.
+ * This screen only appears after an explicit call to chart.showLoading(). It is a utility for developers to
+ * communicate to the end user that something is going on, for example while retrieving new data via an XHR
+ * connection. The 'Loading...' text itself is not part of this configuration object, but part of the lang object.
+ */
loading?: HighchartsLoadingOptions;
+ /**
+ * A collection of options for buttons and menus appearing in the exporting module.
+ */
navigation?: HighchartsNavigationOptions;
- noData?: any; // TODO
+ /**
+ * Options for displaying a message like 'No data to display'. This feature requires the file no-data-to-display.js
+ * to be loaded in the page. The actual text to display is set in the lang.noData option.
+ */
+ noData?: HighchartsNoDataOptions;
+ /**
+ * Applies only to polar charts and angular gauges. This configuration object holds general options for the combined
+ * X and Y axes set. Each xAxis or yAxis can reference the pane by index.
+ */
pane?: HighchartsPaneOptions;
+ /**
+ * The plotOptions is a wrapper object for config objects for each series type. The config objects for each series
+ * can also be overridden for each series item as given in the series array.
+ *
+ * Configuration options for the series are given in three levels. Options for all series in a chart are given in
+ * the plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of
+ * that type, for example plotOptions.line. Next, options for one single series are given in the series array.
+ */
plotOptions?: HighchartsPlotOptions;
+ /**
+ * The actual series to append to the chart. In addition to the members listed below, any member of the plotOptions
+ * for that specific type of plot can be added to a series individually. For example, even though a general
+ * lineWidth is specified in plotOptions.series, an individual lineWidth can be specified for each series.
+ */
series?: HighchartsIndividualSeriesOptions[];
+ /**
+ * The chart's subtitle
+ */
subtitle?: HighchartsSubtitleOptions;
+ /**
+ * The chart's main title.
+ */
title?: HighchartsTitleOptions;
+ /**
+ * Options for the tooltip that appears when the user hovers over a series or point.
+ */
tooltip?: HighchartsTooltipOptions;
- xAxis?: HighchartsAxisOptions;
- yAxis?: HighchartsAxisOptions|HighchartsAxisOptions[];
+ /**
+ * The X axis or category axis. Normally this is the horizontal axis, though if the chart is inverted this is the
+ * vertical axis. In case of multiple axes, the xAxis node is an array of configuration objects.
+ */
+ xAxis?: HighchartsAxisOptions | HighchartsAxisOptions[];
+ /**
+ * The Y axis or value axis. Normally this is the vertical axis, though if the chart is inverted this is the
+ * horizontal axis. In case of multiple axes, the yAxis node is an array of configuration objects.
+ */
+ yAxis?: HighchartsAxisOptions | HighchartsAxisOptions[];
}
interface HighchartsGlobalOptions extends HighchartsOptions {
+ /**
+ * Global options that don't apply to each chart. These options, like the lang options, must be set using the
+ * Highcharts.setOptions method.
+ */
global?: HighchartsGlobalObject;
+ /**
+ * Language object. The language object is global and it can't be set on each chart initiation. Instead, use
+ * Highcharts.setOptions to set it before any chart is initiated.
+ */
lang?: HighchartsLangObject;
}
+interface HighchartsDateFormatSpecifiers
+{
+ [index: string]: (timestamp: number) => string;
+}
+
+/**
+ * A chart can have from 0 axes (pie chart) to multiples. In a normal, single series cartesian chart, there is one X
+ * axis and one Y axis.
+ *
+ * The X axis or axes are referenced by chart.xAxis, which is an array of Axis objects. If there is only one axis, it
+ * can be referenced through chart.xAxis[0], and multiple axes have increasing indices. The same pattern goes for Y
+ * axes.
+ *
+ * If you need to get the axes from a series object, use the series.xAxis andseries.yAxis properties. These are not
+ * arrays, as one series can only be associated to one X and one Y axis.
+ *
+ * A third way to reference the axis programmatically is by id. Add an id in the axis configuration options, and get the
+ * axis by chart.get(id).
+ *
+ * Configuration options for the axes are given in options.xAxis and options.yAxis.
+ */
interface HighchartsAxisObject {
+ /**
+ * Add a plot band after render time.
+ * @param {HighchartsPlotBands} options A configuration object consisting of the same members as options.xAxis.plotBands
+ * @since 1.2.0
+ */
addPlotBand(options: HighchartsPlotBands): void;
+ /**
+ * Add a plot line after render time.
+ * @param {HighchartsPlotLines} options A configuration object consisting of the same members as options.xAxis.plotLines
+ * @since 1.2.0
+ */
addPlotLine(options: HighchartsPlotLines): void;
+ /**
+ * Get the current extremes for the axis.
+ * @since 1.2.0
+ */
getExtremes(): HighchartsExtremes;
+ /**
+ * Remove an axis from the chart.
+ * @param [boolean] redraw Defaults to true. Whether to redraw the chart following the remove.
+ * @since 3.0
+ */
remove(redraw?: boolean): void;
+ /**
+ * Remove a plot band by its id.
+ * @param {string} id The plot band's id as given in the original configuration object or in the addPlotBand method.
+ * @since 1.2.0
+ */
removePlotBand(id: string): void;
+ /**
+ * Remove a plot line by its id.
+ * @param {string} id The plot line's id as given in the original configuration object or in the addPlotLine method.
+ * @since 1.2.0
+ */
removePlotLine(id: string): void;
+ /**
+ * Set new categories for the axis. Redraws.
+ * @param {string[]} categories The new category names.
+ * @since 1.2.0
+ */
setCategories(categories: string[]): void;
+ /**
+ * Set new categories for the axis.
+ * @param {string[]} categories The new category names.
+ * @param {boolean} redraw Whether to redraw the axis or wait for an explicit call to chart.redraw().
+ * @since 1.2.0
+ */
setCategories(categories: string[], redraw: boolean): void;
- setExtremes(min: number, max: number): void;
- setExtremes(min: number, max: number, redraw: boolean): void;
- setExtremes(min: number, max: number, redraw: boolean, animation: boolean | HighchartsAnimation): void;
+ /**
+ * Set the minimum and maximum of the axes after render time. If the startOnTick and endOnTick options are true, the
+ * minimum and maximum values are rounded off to the nearest tick. To prevent this, these options can be set to
+ * false before calling setExtremes. Also, setExtremes will not allow a range lower than the minRange option, which
+ * by default is the range of five points.
+ * @param {number} min The new minimum value
+ * @param {number} max The new maximum value
+ * @param {boolean} redraw Whether to redraw the chart or wait for an explicit call to chart.redraw().
+ * @param {boolean | HighchartsAnimation} animation When true, the resize will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @since 1.2.0
+ */
+ setExtremes(min?: number, max?: number, redraw?: boolean, animation?: boolean | HighchartsAnimation): void;
+ /**
+ * Update the title of the axis after render time.
+ * @param {HighchartsAxisTitle} title The new title options on the same format as given in xAxis.title.
+ * @param {boolean} redraw Whether to redraw the chart now or hold until the next chart.redraw()
+ * @since 2.2
+ */
setTitle(title: HighchartsAxisTitle, redraw?: boolean): void;
+ /**
+ * Translates a value in terms of axis units in to pixels within the chart.
+ * @param {number} value A value in terms of axis units.
+ * @param {boolean} paneCoordinates Whether to return the pixel coordinate relative to the chart or just the axis/pane itself.
+ * @return {number}
+ * @since 3.0
+ */
toPixels(value: number, paneCoordinates?: boolean): number;
+ /**
+ * Translate a pixel position along the axis to a value in terms of axis units.
+ * @param {number} pixel A pixel position along the axis.
+ * @param {boolean} paneCoordinates Whether the input pixel position is relative to the chart or just the axis/pane itself.
+ * @return {number}
+ * @since 3.0
+ */
toValue(pixel: number, paneCoordinates?: boolean): number;
+ /**
+ * Update an axis object with a new set of options. The options are merged with the existing options, so only new or
+ * altered options need to be specified.
+ * @param {HighchartsAxisOptions} options The new options that will be merged in with existing options on the axis.
+ * @param {boolean} redraw Defaults to true. Whether to redraw the chart after the new options are set.
+ * @since 3.0
+ */
update(options: HighchartsAxisOptions, redraw?: boolean): void;
}
+/**
+ * The chart object is the JavaScript object representing a single chart in the web page.The pointer to your chart
+ * object is returned when a chart is created using the Highcharts.Chart() constructor:
+ * var chart1 = new Highcharts.Chart(options);
+ */
interface HighchartsChartObject {
+ /**
+ * Add an axis to the chart after render time. Note that this method should never be used when adding data
+ * synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the
+ * same time as the chart is initiated, add the axis as a configuration option instead.
+ * @param {HighchartsAxisOptions} options The Axis options, as documented under xAxis and yAxis.
+ * @param [boolean] isX Whether it is an X axis or Y axis
+ * @param [boolean] redraw Defaults to true. Whether to redraw the chart after the series is added. See the redraw() method.
+ * @param [boolean | HighchartsAnimation] animation Defaults to true. When true, the series' updating will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @return {HighchartsAxisObject}
+ * @since 3.0
+ */
addAxis(options: HighchartsAxisOptions, isX?: boolean, redraw?: boolean, animation?: boolean | HighchartsAnimation): HighchartsAxisObject;
+ /**
+ * Add a series to the chart after render time. Note that this method should never be used when adding data
+ * synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the
+ * same time as the chart is initiated, add the series as a configuration option instead.
+ * @param {T} options The series options, as documented under plotOptions.series and under the plotOptions for each series type.
+ * @param [boolean] redraw
+ * @since 1.2.0
+ */
addSeries<T extends HighchartsIndividualSeriesOptions>(options: T, redraw?: boolean, animation?: boolean | HighchartsAnimation): T;
- addSeriesAsDrilldown(point: HighchartsPointObject, seriesOptions: HighchartsSeriesOptions): void;
+ /**
+ * Add a series to the chart as drilldown from a specific point in the parent series. This method is used for async
+ * drilldown, when clicking a point in a series should result in loading and displaying a more high-resolution
+ * series. When not async, the setup is simpler using the drilldown.series options structure.
+ * @param {HighchartsPointObject} point The existing Point object from which the drilldown will start.
+ * @param {HighchartsIndividualSeriesOptions} seriesOptions The series options, as documented under plotOptions.series and under the plotOptions for each series type.
+ * @since 3.0.8
+ */
+ addSeriesAsDrilldown(point: HighchartsPointObject, seriesOptions: HighchartsIndividualSeriesOptions): void;
+ /**
+ * A reference to the containing HTML element, dynamically inserted into the element given in chart.renderTo.
+ * @since 1.2.5
+ */
container: HTMLElement;
+ /**
+ * Removes the chart and purges memory. This method should be called before writing a new chart into the same
+ * container. It is called internally on window unload to prevent leaks.
+ * @since 1.2.2
+ */
destroy(): void;
+ /**
+ * When the chart is drilled down to a child series, calling chart.drillUp() will drill up to the parent series.
+ * @since 3.0.8
+ */
drillUp(): void;
+ /**
+ * Exporting module required. Submit an SVG version of the chart to a server along with some parameters for
+ * conversion.
+ * @since 2.0
+ */
exportChart(): void;
+ /**
+ * Exporting module required. Submit an SVG version of the chart to a server along with some parameters for
+ * conversion.
+ * @param {HighchartsExportingOptions} options Exporting options. Out of the exporting options, the following options can be given as parameters to the exportChart method. All options default to the values given in the exporting config options. filename: the filename for the export without extension, url: the URL for the server module to do the conversion, width: the width of the PNG or JPEG image generated on the server, type: the MIME type of the converted image, sourceWidth: the width of the source (in-page) chart, sourceHeight: the height of the source chart.
+ * @since 2.0
+ */
exportChart(options: HighchartsExportingOptions): void;
- exportChart(options: HighchartsExportingOptions, chartOptions: HighchartsChartOptions): void;
+ /**
+ * Exporting module required. Submit an SVG version of the chart to a server along with some parameters for
+ * conversion.
+ * @param {HighchartsExportingOptions} options Exporting options. Out of the exporting options, the following options can be given as parameters to the exportChart method. All options default to the values given in the exporting config options. filename: the filename for the export without extension, url: the URL for the server module to do the conversion, width: the width of the PNG or JPEG image generated on the server, type: the MIME type of the converted image, sourceWidth: the width of the source (in-page) chart, sourceHeight: the height of the source chart.
+ * @param {HighchartsOptions} chartOptions Additional chart options for the exported chart. For example a different background color can be added here.
+ * @since 2.0
+ */
+ exportChart(options: HighchartsExportingOptions, chartOptions: HighchartsOptions): void;
+ /**
+ * Get an axis, series or point by its id as given in the configuration options.
+ * @param {string} id The id of the axis, series or point to get.
+ * @return {HighchartsAxisObject|HighchartsSeriesObject|HighchartsPointObject}
+ * @since 1.2.0
+ */
get(id: string): HighchartsAxisObject | HighchartsSeriesObject | HighchartsPointObject;
- getSVG(): string;
- getSVG(additionalOptions: HighchartsChartOptions): string;
+ /**
+ * Exporting module required. Get an SVG string representing the chart.
+ * @param {HighchartsOptions} additionalOptions Chart options to add to the exported chart in addition to the options given for the original chart. For example if series.lineWidth should be greater in the exported chart than in the original, or the chart should have a different background color, this is added here.
+ * @return {string}
+ * @since 2.0
+ */
+ getSVG(additionalOptions?: HighchartsOptions): string;
+ /**
+ * Returns an array of all currently selected points in the chart. Points can be selected either programmatically by
+ * the point.select() method or by clicking.
+ * @return {HighchartsPointObject[]} An array of the selected points.
+ * @since 1.2.0
+ */
getSelectedPoints(): HighchartsPointObject[];
+ /**
+ * Returns an array of all currently selected series in the chart. Series can be selected either programmatically by
+ * the series.select() method or by checking the checkbox next to the legend item if series.showCheckBox is true.
+ * @return {HighchartsSeriesObject[]} An array of the selected Series items.
+ * @since 1.2.0
+ */
getSelectedSeries(): HighchartsSeriesObject[];
+ /**
+ * Hide the loading screen. Options for the loading screen are defined at options.loading.
+ * @since 1.2.0
+ */
hideLoading(): void;
- options: HighchartsChartOptions;
+ /**
+ * The options structure for the chart.
+ * @since 1.2.0
+ */
+ options: HighchartsOptions;
+ /**
+ * Exporting module required. Clears away other elements in the page and prints the chart as it is displayed. By
+ * default, when the exporting module is enabled, a button at the upper left calls this method.
+ * @since 2.0
+ */
print(): void;
- redraw(): void;
+ /**
+ * Redraw the chart after changes have been done to the data or axis extremes. All methods for updating axes, series
+ * or points have a parameter for redrawing the chart. This is true by default. But in many cases you want to do
+ * more than one operation on the chart before redrawing, for example add a number of points. In those cases it is a
+ * waste of resources to redraw the chart for each new point added. So you add the points and call chart.redraw()
+ * after.
+ * @param [boolean | HighchartsAnimation] animation Defaults to true. When true, the update will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @since 1.2.0
+ */
+ redraw(animation?: boolean | HighchartsAnimation): void;
+ /**
+ * Reflows the chart to its container. By default, the chart reflows automatically to its container following a
+ * window.resize event, as per the chart.reflow option. However, there are no reliable events for div resize, so if
+ * the container is resized without a window resize event, this must be called explicitly.
+ */
reflow(): void;
+ /**
+ * An array of all the chart's series.
+ * @type {HighchartsSeriesObject[]}
+ * @since 1.2.0
+ */
series: HighchartsSeriesObject[];
- setSize(width: number, height: number): void;
- setSize(width: number, height: number, animation: boolean): void;
- setSize(width: number, height: number, animation: HighchartsAnimation): void;
- setTitle(title: HighchartsTitleOptions): void;
- setTitle(title: HighchartsTitleOptions, subtitle: HighchartsSubtitleOptions): void;
- setTitle(title: HighchartsTitleOptions, subtitle: HighchartsSubtitleOptions, redraw: boolean): void;
- showLoading(): void;
- showLoading(str: string): void;
+ /**
+ * Resize the chart to a given width and height.
+ * @param {number} width The new pixel width of the chart.
+ * @param {number} height The new pixel height of the chart.
+ * @param {boolean | HighchartsAnimation} animation Defaults to true. When true, the resize will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ */
+ setSize(width: number, height: number, animation?: boolean | HighchartsAnimation): void;
+ /**
+ * Set a new title or subtitle for the chart
+ * @param {HighchartsTitleOptions} title A configuration object for the new title as defined at #title.
+ * @param [HighchartsSubtitleOptions] subtitle A configuration object for the new subtitle as defined at #subtitle.
+ * @param [boolean] redraw Whether to redraw the chart. Defaults to true.
+ * @since 2.1.0
+ */
+ setTitle(title: HighchartsTitleOptions, subtitle?: HighchartsSubtitleOptions, redraw?: boolean): void;
+ /**
+ * Dim the chart's plot area and show a loading label text. Options for the loading screen are defined at
+ * options.loading. A custom text can be given as a parameter for loading.
+ * @since 2.0.5
+ */
+ showLoading(str?: string): void;
+ /**
+ * This method is deprecated as of 2.0.1. Updating the chart position after a move operation is no longer necessary.
+ * @since 1.2.5
+ * @deprecated
+ */
+ updatePosition(): void;
+ /**
+ * An array of the chart's x axes. If only one x axis, it is referenced by chart.xAxis[0].
+ * @since 1.2.0
+ */
xAxis: HighchartsAxisObject[];
+ /**
+ * An array of the chart's y axes. If only one y axis, it is referenced by chart.yAxis[0].
+ * @since 1.2.0
+ */
yAxis: HighchartsAxisObject[];
renderer: HighchartsRendererObject;
}
interface HighchartsChart {
+ /**
+ * This is the constructor for creating a new chart object.
+ * @param {HighchartsOptions} options The chart options
+ * @return {HighchartsChartObject}
+ */
new (options: HighchartsOptions): HighchartsChartObject;
+ /**
+ * This is the constructor for creating a new chart object.
+ * @param {HighchartsOptions} options The chart options
+ * @param callback A function to execute when the chart object is finished loading and rendering. In most cases the chart is built in one thread, but in Internet Explorer version 8 or less the chart is sometimes initiated before the document is ready, and in these cases the chart object will not be finished directly after callingnew Highcharts.Chart(). As a consequence, code that relies on the newly built Chart object should always run in the callback. Defining a chart.event.load handler is equivalent.
+ * @return {HighchartsChartObject}
+ */
new (options: HighchartsOptions, callback: (chart: HighchartsChartObject) => void): HighchartsChartObject;
}
+/**
+ * The Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highchart. Combined with
+ * the Renderer object, these elements allows freeform annotation in the charts or even in your HTML pages without
+ * creating a chart at all.
+ */
interface HighchartsElementObject {
- add(): HighchartsElementObject;
- add(parent: HighchartsElementObject): HighchartsElementObject;
+ /**
+ * Add the element to the renderer canvas.
+ * @param {HighchartsElementObject} parent The element can be added to a g (group) element.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
+ add(parent?: HighchartsElementObject): HighchartsElementObject;
+ /**
+ * Apply numeric attributes to the SVG/VML element by animation. See Element.attr() for more information on setting
+ * attributes.
+ * @param {any} attributes A set of attributes to apply.
+ * @param {any} animation Optional animation parameters that are passed over to jQuery or other framework. Valid properties depend on the library, but options like duration, easing and complete are supported by jQuery.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
animate(attributes: any, animation?: any): HighchartsElementObject;
+ /**
+ * Apply attributes to the SVG/VML elements. These attributes for the most parts correspond to SVG, but some are
+ * specific to Highcharts, like zIndex and rotation.
+ *
+ * In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes
+ * to position the element instead.
+ *
+ * Attributes frequently used in Highcharts are fill, stroke, stroke-width.
+ * @param {any} hash A set of attributes to apply.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
attr(hash: any): HighchartsElementObject;
- css(hash: HighchartsCSSObject): HighchartsElementObject;
+ /**
+ * Apply some CSS properties to the element
+ * @param {Object} hash The object literal of CSS properties to apply. Properties should be hyphenated, not camelCased.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
+ css(hash: Object): HighchartsElementObject;
+ /**
+ * Destroy the element and free up memory
+ * @since 2.0
+ */
destroy(): void;
+ fadeOut(duration?: number): void;
+ /**
+ * Get the bounding box of the element
+ * @return An object containing x, y, width and height values for the element.
+ * @since 2.0
+ */
getBBox(): { x: number; y: number; height: number; width: number; };
+ /**
+ * Apply an event handler to the element
+ * @param {string} eventType The event type to attach, for example 'click', 'mouseover', 'touch'.
+ * @param handler The event handler function.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
on(eventType: string, handler: () => void): HighchartsElementObject;
+ /**
+ * Bring the element to the front. Alternatively, a zIndex attribute can be given.
+ * @return {HighchartsElementObject} The element object
+ * @since 2.0
+ */
toFront(): HighchartsElementObject;
}
+/**
+ * Allows direct access to the Highcharts rendering layer in order to draw primitive shapes like circles,
+ * rectangles,paths or text directly on a chart, or independent from any chart. The Renderer represents a wrapper object
+ * for SVGin modern browsers and VML in IE < 8.
+ *
+ * An existing chart's renderer can be accessed through chart.renderer. To create a renderer independent from a chart,
+ * use var renderer = new Highcharts.Renderer(parentNode, width, height); where parentNode is the HTML element where you
+ * want to add it.
+ *
+ * The Renderer's methods are chained wherever possible, so you can initiate an element then call for example attr and
+ * css and add on that element in one statement.
+ */
interface HighchartsRendererObject {
+ /**
+ * Draw an arc on the renderer canvas.
+ * @param {number} centerX The x position of the arc's center in the SVG element.
+ * @param {number} centerY The y position of the arc's center in the SVG element.
+ * @param {number} outerRadius The outer radius of the arc.
+ * @param {number} innerRadius The inner radius of the arc.
+ * @param {number} start The starting angle of the arc in radians, where 0 is to the right and -Math.PI/2 is up.
+ * @param {number} end The ending angle of the arc in radians, where 0 is to the right and -Math.PI/2 is up.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
arc(centerX: number, centerY: number, outerRadius: number, innerRadius: number, start: number, end: number): HighchartsElementObject;
+ /**
+ * Draw circle on the renderer canvas.
+ * @param {number} centerX The x position of the circle's center in the SVG element.
+ * @param {number} centerY The y position of the circle's center in the SVG element.
+ * @param {number} radius [description]
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
circle(centerX: number, centerY: number, radius: number): HighchartsElementObject;
- g(name: string): HighchartsElementObject;
+ /**
+ * Add an SVG/VML group.
+ * @param [string] name The name of the group. This will be used in the class name, which will be 'highcharts-'+ name. Other Element objects are added to the group by using the group as the first parameter in .add() for the wrappers
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
+ g(name?: string): HighchartsElementObject;
+ /**
+ * Add an image from an external resource.
+ * @param {string} source The URL of the image.
+ * @param {number} x The x position of the image's upper left corner.
+ * @param {number} y The y position of the image's upper left corner.
+ * @param {number} width The width of the image.
+ * @param {number} height The height of the image.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
image(source: string, x: number, y: number, width: number, height: number): HighchartsElementObject;
- path(path: any[]): HighchartsElementObject;
+ /**
+ * Draw a label, which is an extended text element with support for border and background. Highcharts creates a g
+ * element with a text and a path or rect inside, to make it behave somewhat like a HTML div. Border and background
+ * are set through stroke, stroke-width and fill attributes using the attr method. This must be done before calling
+ * add.
+ * @param {string} str The text or HTML to draw
+ * @param {number} x The x position of the label's left side.
+ * @param {number} y The y position of the label's top side or baseline, depending on the baseline parameter.
+ * @param [string] shape The shape of the label's border/background, if any. Defaults to rect.
+ * @param [number] anchorX If the shape has a pointer, like the chevron on a callout shape, anchorX is the x position to point to.
+ * @param [number] anchorY If the shape has a pointer, like the chevron on a callout shape, anchorY is the y position to point to.
+ * @param [boolean] useHTML Use HTML to render the text of the label.
+ * @param [boolean] baseline Whether the label should be vertically aligned by the text baseline, which makes it behave like the text element, or by the top left side, which makes it behave like a HTML div.
+ * @param [string] className A class name for the g element surrounding the label.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
+ label(str: string, x: number, y: number, shape?: string, anchorX?: number, anchorY?: number, useHTML?: boolean, baseline?: boolean, className?: string): HighchartsElementObject;
+ /**
+ * Add a path based on SVG's path commands. In SVG capable browsers all path commands are supported, but in VML only
+ * a subset is supported: absolute moveTo (M), absolute lineTo (L), absolute curveTo (C) and close (Z).
+ * @param {(string|number)[]} path An SVG path split up in array form.
+ * @return {HighchartsElementObject}
+ */
+ path(path: [string|number]): HighchartsElementObject;
+ /**
+ * Add a rectangle.
+ * @param {number} x The x position of the rectangle's upper left corner.
+ * @param {number} y The y position of the rectangle's upper left corner.
+ * @param {number} width The width of the rectangle.
+ * @param {number} height The height of the rectangle.
+ * @param {number} cornerRadius The corner radius of all the rectangle's corners.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
rect(x: number, y: number, width: number, height: number, cornerRadius: number): HighchartsElementObject;
+ /**
+ * Draw text. The text can contain a subset of HTML, like spans and anchors and some basic text styling of these.
+ * For more advanced features like border and background, use label instead.
+ * @param {string} str The text or HTML to draw
+ * @param {number} x The x position of the text's lower left corner.
+ * @param {number} y The y position of the text's lower left corner.
+ * @return {HighchartsElementObject}
+ * @since 2.0
+ */
text(str: string, x: number, y: number): HighchartsElementObject;
}
@@ -1282,9 +5965,49 @@ interface HighchartsStatic {
Renderer: HighchartsRenderer;
Color(color: string | HighchartsGradient): string | HighchartsGradient;
+ /**
+ * An array containing the current chart objects in the page. A chart's position in the array is preserved
+ * throughout the page's lifetime. When a chart is destroyed, the array item becomes undefined.
+ * @since 2.3.4
+ */
+ charts: HighchartsChart[];
+ /**
+ * Formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a human readable date string. The
+ * format is a subset of the formats for PHP's strftime function. Additional formats can be given in the
+ * Highcharts.dateFormats hook, see below.
+ * @param {string} format A string containing some of the formats.
+ * @param [number] time The JavaScript time to format.
+ * @param [boolean] capitalize Whether to capitalize words in the return string.
+ * @return {string}
+ */
dateFormat(format: string, time?: number, capitalize?: boolean): string;
+ /**
+ * A hook for defining additional date format specifiers. New specifiers are defined as key-value pairs by using the
+ * specifier as key, and a function which takes the timestamp as value. This function returns the formatted portion
+ * of the date.
+ */
+ dateFormats: HighchartsDateFormatSpecifiers;
+ /**
+ * Formats a JavaScript number with grouped thousands, a fixed amount of decimals and an optional decimal point. It
+ * is a port of PHP's function with the same name. See PHP number_format for a full explanation of the parameters.
+ * @param {number} value The raw number to format.
+ * @param {number} decimals The desired number of decimals.
+ * @param {string} decimalPoint The decimal point. Defaults to '.' or to the string specified globally in options.lang.decimalPoint.
+ * @param {string} thousandsSep The thousands separator. Defaults to ' ' or to the string specified globally in options.lang.thousandsSep.
+ * @return {string}
+ */
numberFormat(value: number, decimals?: number, decimalPoint?: string, thousandsSep?: string): string;
+ /**
+ * Sets the options globally for all charts created after this has been called. Takes an options JavaScript object
+ * structure as the argument. These options are merged with the default options and the result is returned.
+ * @param options The chart configuration object.
+ * @return {HighchartsOptions}
+ */
setOptions(options: HighchartsGlobalOptions): HighchartsOptions;
+ /**
+ * Get the updated default options. Until 3.0.7, merely exposing defaultOptions for outside modules
+ * wasn't enough because the setOptions method created a new object.
+ */
getOptions(): HighchartsOptions;
map(array: any[], fn: Function): any[];
@@ -1292,39 +6015,212 @@ interface HighchartsStatic {
declare var Highcharts: HighchartsStatic;
+/**
+ * The Point object is the JavaScript representation of each data point
+ *
+ * The object can be accessed in a number of ways. In all point event handlers the point object is this. In the series
+ * object all the points are accessed by the series.data array.
+ *
+ * Another way to reference the point programmatically is by id. Add an id in the point configuration options, and get
+ * the point object by chart.get(id).
+ */
interface HighchartsPointObject {
+ /**
+ * For categorized axes this property holds the category name for the point. For other axis it holds the x value.
+ * @since 1.2.0
+ */
category: string | number;
+ name: string;
+ /**
+ * The percentage for points in a stacked series or pies.
+ * @since 1.2.0
+ */
percentage: number;
+ /**
+ * Remove the point from the series.
+ * @param [boolean] redraw Defaults to true. Whether to redraw the chart after the point is removed.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
+ * @param [boolean|HighchartsAnimation] animation Defaults to true. When true, the graph's updating will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @since 1.2.0
+ */
remove(redraw?: boolean, animation?: boolean|HighchartsAnimation): void;
- select(): void;
- select(select: boolean): void;
- select(select: boolean, accumulate: boolean): void;
+ /**
+ * Select or unselect the point.
+ * @param [boolean] select When true, the point is selected. When false, the point is unselected. When null or undefined, the selection state is toggled.
+ * @param [boolean] accumulate When true, the selection is added to other selected points. When false, other selected points are deselected. Internally in Highcharts,selected points are accumulated on Control, Shift or Cmd clicking the point.
+ * @since 1.2.0
+ */
+ select(select?: boolean, accumulate?: boolean): void;
+ /**
+ * Whether the point is selected or not.
+ * @since 1.2.0
+ */
selected: boolean;
+ /**
+ * The series object associated with the point.
+ * @since 1.2.0
+ */
series: HighchartsSeriesObject;
+ /**
+ * Slice out or set back in a pie chart slice. This is the default way of Highcharts to visualize that a pie point
+ * is selected.
+ * @param [boolean] sliced When true, the point is sliced out. When false, the point is set in. When null or undefined, the sliced state is toggled.
+ * @param [boolean] redraw Defaults to true. Whether to redraw the chart after the point is altered.
+ * @param [boolean|HighchartsAnimation] animation Defaults to true. When true, the move will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @since 1.2.0
+ */
slice(sliced?: boolean, redraw?: boolean, animation?: boolean|HighchartsAnimation): void;
+ /**
+ * The total of a stack for stacked series, or pie in pie charts.
+ */
total: number;
+ /**
+ * Update the point with new values.
+ * @param {number|[number,number]|HighchartsDataPoint} options The point options. Point options are handled as described under the series<type>.data item for each series type. For example for a line series, if options is a single number, the point will be given that number as the main y value. If it is an array, it will be interpreted as x and y values respectively. If it is an object, advanced options are applied.
+ * @param [boolean] redraw Defaults to true. Whether to redraw the chart after the point is updated.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
+ * @param {boolean|HighchartsAnimation} animation Defaults to true. When true, the update will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @since 1.2.0
+ */
update(options: number | [number, number] | HighchartsDataPoint, redraw?: boolean, animation?: boolean | HighchartsAnimation): void;
+ /**
+ * The x value for the point.
+ * @since 1.2.0
+ */
x: number;
+ /**
+ * The y value for the point.
+ * @since 1.2.0
+ */
y: number;
}
+/**
+ * The Series object is the JavaScript representation of each line, area series, pie etc.
+ *
+ * The object can be accessed in a number of ways. All series and point event handlers give a reference to the series
+ * object. The chart object has a series property that is a collection of all the chart's series. The point objects also
+ * have the same reference.
+ *
+ * Another way to reference the series programmatically is by id. Add an id in the series configuration options, and get
+ * the series object by chart.get(id).
+ *
+ * Configuration options for the series are given in three levels. Options for all series in a chart are given in the
+ * plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of that type,
+ * for example plotOptions.line. Next, options for one single series are given in the series array.
+ */
interface HighchartsSeriesObject {
+ /**
+ * Add a point to the series after render time. The point can be added at the end, or by giving it an X value, to
+ * the start or in the middle of the series.
+ * @param {number|[number,number]|HighchartsDataPoint} The point options. If options is a single number, a point with that y value is appended to the series.If it is an array, it will be interpreted as x and y values respectively. If it is an object, advanced options as outlined under series.data are applied.
+ * @param [boolean=true] redraw - Whether to redraw the chart after the point is added. When adding more than one point, it is highly recommended that the redraw option be set to false, and instead chart.redraw() is explicitly called after the adding of points is finished.
+ * @param [boolean=false] shift - When shift is true, one point is shifted off the start of the series as one is appended to the end. Use this option for live charts monitoring a value over time.
+ * @param [(boolean|HighchartsAnimation)=false] animation - When shift is true, one point is shifted off the start of the series as one is appended to the end. Use this option for live charts monitoring a value over time.
+ * @since 1.2.0
+ */
addPoint(options: number |[number, number]| HighchartsDataPoint, redraw?: boolean, shift?: boolean, animation?: boolean | HighchartsAnimation): void;
+ /**
+ * Read only. The chart that the series belongs to.
+ * @since 1.2.0
+ */
chart: HighchartsChartObject;
+ /**
+ * Read only. An array with the series' data point objects.
+ * @since 1.2.0
+ */
data: HighchartsPointObject[];
+ /**
+ * Hides the series if visible. If the chart.ignoreHiddenSeries option is true,the chart is redrawn without this
+ * series.
+ * @since 1.2.0
+ */
hide(): void;
+ /**
+ * The series' name as given in the options.
+ * @since 1.2.0
+ */
name: string;
- options: HighchartsSeriesOptions;
+ /**
+ * Read only. The series' options.
+ * @since 1.2.0
+ */
+ options: HighchartsIndividualSeriesOptions;
+ /**
+ * Remove the series from the chart.
+ * @param [boolean=true] redraw - Whether to redraw the chart after the series is removed.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
+ * @since 1.2.0
+ */
remove(redraw?: boolean): void;
+ /**
+ * Remove a point from the series. Unlike the Point.remove method, this can also be done on a point that is not
+ * instanciated because it is outside the view or subject to data grouping.
+ * @param {number} index - The index of the point in the data array.
+ * @param [boolean=true] redraw - Whether to redraw the chart after the point is added. When adding more than one point, it is highly recommended that the redraw option be set to false, and instead chart.redraw() is explicitly called after the adding of points is finished.
+ * @param [boolean|HighchartsAnimation=true] animation - When true, the graph will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.
+ * @since 4.1.0
+ */
+ removePoint(index: number, redraw?: boolean, animation?: boolean|HighchartsAnimation): void;
+ /**
+ * Select or unselect the series. This means its selected property is set,the checkbox in the legend is toggled and
+ * when selected, the series is returned in the chart.getSelectedSeries() method.
+ * @param [boolean] selected - When true, the series is selected. When false it is unselected. When null or undefined, the series' selection state is toggled.
+ * @since 1.2.0
+ */
select(selected?: boolean): void;
+ /**
+ * Read only. The series' selected state as set by series.select().
+ * @since 1.2.0
+ */
selected: boolean;
+ /**
+ * Apply a new set of data to the series and optionally redraw it. Note that this method throws away all points and
+ * creates new ones. For updating the values of existing points, use Point.update() instead.
+ * @param {number[]|number[][]|HighchartsDataPoint[]} data - Takes an array of data in the same format as described under series<type>data for the given series type.
+ * @param [boolean=true] redraw - Whether to redraw the chart after the series is altered.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
+ * @param [boolean|HighchartsAnimation] animation - When the updated data is the same length as the existing data, points will be updated by default, and animation visualizes how the points are changed. Set false to disable animation, or a configuration object to set duration or easing.
+ * @param [boolean] updatePoints - When the updated data is the same length as the existing data, points will be updated instead of replace. This option prevents this, and makes setData behave like it did prior to Highcharts 3.0.10.
+ * @since 1.2.0
+ */
setData(data: number[] | number[][] | HighchartsDataPoint[], redraw?: boolean, animation?: boolean | HighchartsAnimation, updatePoints?: boolean): void;
- setVisible(visible: boolean, redraw?: boolean): void;
+ /**
+ * A utility function to show or hide the series with an optional redraw.
+ * @param [boolean] visible - Whether to show or hide the series. If undefined, the visibility is toggled.
+ * @param [boolean=true] redraw - Whether to redraw the chart after the series is altered.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
+ * @since 1.2.0
+ */
+ setVisible(visible?: boolean, redraw?: boolean): void;
+ /**
+ * Shows the series if hidden.
+ * @since 1.2.0
+ */
show(): void;
+ /**
+ * Read only. The series' type, like 'line', 'area' etc.
+ * @since 1.2.0
+ */
type: string;
- update(options: HighchartsSeriesOptions, redraw?: boolean): void;
+ /**
+ * Update the series with a new set of options. For a clean and precise handling of new options, all methods and
+ * elements from the series is removed, and it is initiated from scratch. Therefore, this method is more performance
+ * expensive than some other utility methods like setData or setVisible.
+ * @param {HighchartsIndividualSeriesOptions} options New options that will be merged into the series' existing options.
+ * @param [boolean] redraw - Whether to redraw the chart after the series is altered. If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.
+ * @since 1.2.0
+ */
+ update(options: HighchartsIndividualSeriesOptions, redraw?: boolean): void;
+ /**
+ * Read only. The series' visibility state as set by series.show(), series.hide(), or the initial configuration.
+ * @since 1.2.0
+ */
visible: boolean;
+ /**
+ * Read only. The unique xAxis object associated with the series.
+ * @since 1.2.0
+ */
xAxis: HighchartsAxisObject;
+ /**
+ * Read only. The unique yAxis object associated with the series.
+ * @since 1.2.0
+ */
yAxis: HighchartsAxisObject;
}
diff --git a/history/history-tests.ts.tscparams b/history/history-tests.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/history/history-tests.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/history/history.d.ts.tscparams b/history/history.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/history/history.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/iniparser/iniparser-tests.ts b/iniparser/iniparser-tests.ts
new file mode 100644
index 0000000000..8558766df6
--- /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 0000000000..81fd073776
--- /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/inline-css/inline-css-tests.ts b/inline-css/inline-css-tests.ts
new file mode 100644
index 0000000000..e633e9e0ae
--- /dev/null
+++ b/inline-css/inline-css-tests.ts
@@ -0,0 +1,35 @@
+/// <reference path="inline-css.d.ts" />
+
+import inlineCss = require('inline-css');
+
+var str: string;
+var bool: boolean;
+
+var options:inlineCss.Options;
+
+str = options.url;
+str = options.extraCss;
+
+bool = options.applyStyleTags;
+bool = options.applyLinkTags;
+bool = options.removeStyleTags;
+bool = options.removeLinkTags;
+bool = options.preserveMediaQueries;
+bool = options.applyWidthAttributes;
+bool = options.applyTableAttributes;
+
+options = {
+ url: str,
+ extraCss: str,
+ applyStyleTags: bool,
+ applyLinkTags: bool,
+ removeStyleTags: bool,
+ removeLinkTags: bool,
+ preserveMediaQueries: bool,
+ applyWidthAttributes: bool,
+ applyTableAttributes: bool
+};
+
+inlineCss(str, options).then((value:string) => {
+
+});
diff --git a/inline-css/inline-css.d.ts b/inline-css/inline-css.d.ts
new file mode 100644
index 0000000000..c0cd640aca
--- /dev/null
+++ b/inline-css/inline-css.d.ts
@@ -0,0 +1,28 @@
+// Type definitions for inline-css
+// Project: https://github.com/jonkemp/inline-css
+// Definitions by: Philip Spain <https://github.com/philipisapain>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../bluebird/bluebird.d.ts" />
+
+declare module 'inline-css' {
+ import Promise = require('bluebird');
+
+ module InlineCss {
+ export interface Options {
+ url:string;
+ extraCss?:string;
+ applyStyleTags?:boolean;
+ applyLinkTags?:boolean;
+ removeStyleTags?:boolean;
+ removeLinkTags?:boolean;
+ preserveMediaQueries?:boolean;
+ applyWidthAttributes?:boolean;
+ applyTableAttributes?:boolean;
+ }
+ }
+
+ function InlineCss(html:string, options:InlineCss.Options):Promise<string>;
+
+ export = InlineCss;
+}
diff --git a/ionic/ionic.d.ts b/ionic/ionic.d.ts
index 1b2e3265ee..239f775c5d 100644
--- a/ionic/ionic.d.ts
+++ b/ionic/ionic.d.ts
@@ -5,6 +5,16 @@
/// <reference path="../angularjs/angular.d.ts" />
+interface IonicStatic {
+ version: string;
+}
+
+declare var ionic: IonicStatic;
+
+declare module 'ionic' {
+ export = ionic;
+}
+
declare module ionic {
module actionSheet {
interface IonicActionSheetService {
@@ -56,7 +66,7 @@ declare module ionic {
}
module loading {
interface IonicLoadingService {
- show(opts: IonicLoadingOptions): void;
+ show(opts?: IonicLoadingOptions): void;
hide(): void;
}
interface IonicLoadingOptions {
diff --git a/jest/jest-tests.ts b/jest/jest-tests.ts
index 764daf142a..da141ef9e5 100644
--- a/jest/jest-tests.ts
+++ b/jest/jest-tests.ts
@@ -47,7 +47,7 @@ describe('displayUser', function() {
' <button id="button" />' +
'</div>';
- var displayUser = require('../displayUser');
+ var displayUser = require.requireActual('../displayUser');
var $ = require('jquery');
var fetchCurrentUser = require('../fetchCurrentUser');
diff --git a/jest/jest.d.ts b/jest/jest.d.ts
index d500525b63..fde9d894f8 100644
--- a/jest/jest.d.ts
+++ b/jest/jest.d.ts
@@ -3,21 +3,29 @@
// Definitions by: Asana <https://asana.com>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
+/// <reference path="../node/node.d.ts" />
+
declare function afterEach(fn: jest.EmptyFunction): void;
declare function beforeEach(fn: jest.EmptyFunction): void;
declare function describe(name: string, fn: jest.EmptyFunction): void;
declare var it: jest.It;
declare function pit(name: string, fn: jest.EmptyFunction): void;
-declare var require: jest.Require;
+
declare function xdescribe(name: string, fn: jest.EmptyFunction): void;
declare function xit(name: string, fn: jest.EmptyFunction): void;
declare function expect(actual: any): jest.Matchers;
+interface NodeRequire {
+ requireActual(moduleName: string): any;
+}
+
declare module jest {
+ function addMatchers(matchers: CustomMatcherFactories): void;
function autoMockOff(): void;
function autoMockOn(): void;
function clearAllTimers(): void;
+ function currentTestPath(): string;
function dontMock(moduleName: string): void;
function genMockFromModule<T>(moduleName: string): Mock<T>;
function genMockFunction<T>(): Mock<T>;
@@ -40,6 +48,7 @@ declare module jest {
toBeFalsy(): boolean;
toBeTruthy(): boolean;
toBeNull(): boolean;
+ toBeDefined(): boolean;
toBeUndefined(): boolean;
toMatch(expected: RegExp): boolean;
toContain(expected: string): boolean;
@@ -56,14 +65,9 @@ declare module jest {
only(name: string, fn: EmptyFunction): void;
}
- interface Require {
- (moduleName: string): any;
- requireActual(moduleName: string): any;
- }
-
interface Mock<T> {
- new(): T;
- (...args:any[]): any; // TODO please fix this line! added for TypeScript 1.1.0-1 https://github.com/borisyankov/DefinitelyTyped/pull/2932
+ new (): T;
+ (...args: any[]): any; // TODO please fix this line! added for TypeScript 1.1.0-1 https://github.com/borisyankov/DefinitelyTyped/pull/2932
mock: MockContext<T>;
mockClear(): void;
mockImplementation(fn: Function): Mock<T>;
@@ -77,4 +81,44 @@ declare module jest {
calls: any[][];
instances: T[];
}
+
+ // taken from Jasmine since addMatchers calls into the jasmine api
+ interface CustomMatcherFactories {
+ [index: string]: CustomMatcherFactory;
+ }
+
+ // taken from Jasmine since addMatchers calls into the jasmine api
+ interface CustomMatcherFactory {
+ (util: MatchersUtil, customEqualityTesters: Array<CustomEqualityTester>): CustomMatcher;
+ }
+
+ // taken from Jasmine since addMatchers calls into the jasmine api
+ interface MatchersUtil {
+ equals(a: any, b: any, customTesters?: Array<CustomEqualityTester>): boolean;
+ contains<T>(haystack: ArrayLike<T> | string, needle: any, customTesters?: Array<CustomEqualityTester>): boolean;
+ buildFailureMessage(matcherName: string, isNot: boolean, actual: any, ...expected: Array<any>): string;
+ }
+
+ // taken from Jasmine since addMatchers calls into the jasmine api
+ interface CustomEqualityTester {
+ (first: any, second: any): boolean;
+ }
+
+ // taken from Jasmine since addMatchers calls into the jasmine api
+ interface CustomMatcher {
+ compare<T>(actual: T, expected: T): CustomMatcherResult;
+ compare(actual: any, expected: any): CustomMatcherResult;
+ }
+
+ // taken from Jasmine since addMatchers calls into the jasmine api
+ interface CustomMatcherResult {
+ pass: boolean;
+ message: string;
+ }
+
+ // taken from Jasmine which takes from TypeScript lib.core.es6.d.ts, applicable to CustomMatchers.contains()
+ interface ArrayLike<T> {
+ length: number;
+ [n: number]: T;
+ }
}
diff --git a/jointjs/jointjs.d.ts b/jointjs/jointjs.d.ts
index eb03edbc78..1c7e915715 100644
--- a/jointjs/jointjs.d.ts
+++ b/jointjs/jointjs.d.ts
@@ -110,7 +110,7 @@ declare module joint {
module shapes {
module basic {
- class Generic extends joint.dia.Element {
+ class Generic extends dia.Element {
}
class Rect extends Generic {
}
diff --git a/jquery.dataTables/jquery.dataTables.d.ts b/jquery.dataTables/jquery.dataTables.d.ts
index 9a5ea2124d..479c85e632 100755
--- a/jquery.dataTables/jquery.dataTables.d.ts
+++ b/jquery.dataTables/jquery.dataTables.d.ts
@@ -182,7 +182,7 @@ declare module DataTables {
destroy(remove?: boolean): DataTable;
/**
- * Destroy the DataTables in the current context.
+ * Redraw the table.
*
* @param reset Reset (default) or hold the current paging position. A full re-sort and re-filter is performed when this method is called, which is why the pagination reset is the default action.
*/
@@ -1832,4 +1832,4 @@ declare module DataTables {
}
//#endregion "SettingsLegacy"
-}
\ No newline at end of file
+}
diff --git a/jquery.dynatree/jquery.dynatree.d.ts.tscparams b/jquery.dynatree/jquery.dynatree.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/jquery.dynatree/jquery.dynatree.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/jquery.fullscreen/jquery.fullscreen-tests.ts b/jquery.fullscreen/jquery.fullscreen-tests.ts
new file mode 100644
index 0000000000..39d686a873
--- /dev/null
+++ b/jquery.fullscreen/jquery.fullscreen-tests.ts
@@ -0,0 +1,34 @@
+/// <reference path="jquery.fullscreen.d.ts"/>
+
+//
+// Examples from https://github.com/kayahr/jquery-fullscreen-plugin
+//
+
+$(document).on('ready', () => {
+ function checkBrowserSupport() {
+ console.log("Native Browser support: ", $.fullscreen.isNativelySupported());
+ }
+
+ function activateFullscreen() {
+ $(document).fullscreen();
+ }
+
+ function exitFullscreen() {
+ $.fullscreen.exit();
+ }
+
+ function fullscreenStatus() {
+ var state = ($.fullscreen.isFullScreen()) ? 'is active' : 'is inactive' ;
+ console.log("Fullscreen is %s", state);
+ }
+
+ function runTests() {
+ checkBrowserSupport();
+ activateFullscreen();
+ fullscreenStatus();
+ exitFullscreen();
+ fullscreenStatus();
+ }
+
+ runTests();
+});
diff --git a/jquery.fullscreen/jquery.fullscreen.d.ts b/jquery.fullscreen/jquery.fullscreen.d.ts
new file mode 100644
index 0000000000..6b3846f056
--- /dev/null
+++ b/jquery.fullscreen/jquery.fullscreen.d.ts
@@ -0,0 +1,57 @@
+// Type definitions for jquery.fullscreen
+// Project: https://github.com/private-face/jquery.fullscreen
+// Definitions by: Piraveen Kamalathas <https://github.com/piraveen>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts"/>
+
+/**
+ * Extends jQuery interface
+ * i.e: To use $elem.fullscreen()
+ */
+interface JQuery {
+ fullscreen(options?: Object): void;
+}
+
+/**
+ * Interface for the jquery plugin
+ */
+interface JQueryFullscreen {
+ /**
+ * [open Activate fullscreen mode in a specific element through static method]
+ * @param {Element} element [description]
+ * @param {Object} options [description]
+ */
+ open(element: Element, options?: Object): void;
+
+ /**
+ * [close Deactivate fullscreen mode]
+ * TODO: have to check for params
+ */
+ close(): void;
+
+ /**
+ * [isFullScreen Get fullscreen status]
+ * @return {boolean} [description]
+ */
+ isFullScreen(): boolean;
+
+ /**
+ * [isNativelySupported Check if fullscreen is supported by the browser]
+ * @return {boolean} [description]
+ */
+ isNativelySupported(): boolean;
+
+ /**
+ * [exit Deactivate and destroy all fullscreen instances]
+ */
+ exit(): void;
+}
+
+/**
+ * Extends JqueryStatic ($)
+ * i.e: To use $.fullscreen.functionName()
+ */
+interface JQueryStatic {
+ fullscreen: JQueryFullscreen;
+}
diff --git a/jquery.highlight-bartaz/jquery.highlight-bartaz-tests.ts b/jquery.highlight-bartaz/jquery.highlight-bartaz-tests.ts
new file mode 100644
index 0000000000..90d60e83fd
--- /dev/null
+++ b/jquery.highlight-bartaz/jquery.highlight-bartaz-tests.ts
@@ -0,0 +1,26 @@
+/// <reference path="jquery.highlight-bartaz.d.ts" />
+
+
+
+$('#content').highlight('lorem');
+
+// search for and highlight more terms at once
+// so you can save some time on traversing DOM
+$('#content').highlight(['lorem', 'ipsum']);
+$('#content').highlight('lorem ipsum');
+
+// search only for entire word 'lorem'
+$('#content').highlight('lorem', { wordsOnly: true });
+
+// don't ignore case during search of term 'lorem'
+$('#content').highlight('lorem', { caseSensitive: true });
+
+// wrap every occurrance of term 'ipsum' in content
+// with <em class='important'>
+$('#content').highlight('ipsum', { element: 'em', className: 'important' });
+
+// remove default highlight
+$('#content').unhighlight();
+
+// remove custom highlight
+$('#content').unhighlight({ element: 'em', className: 'important' });
diff --git a/jquery.highlight-bartaz/jquery.highlight-bartaz.d.ts b/jquery.highlight-bartaz/jquery.highlight-bartaz.d.ts
new file mode 100644
index 0000000000..2f5b8043b6
--- /dev/null
+++ b/jquery.highlight-bartaz/jquery.highlight-bartaz.d.ts
@@ -0,0 +1,20 @@
+// Type definitions for jquery.highlight.js
+// Project: https://github.com/bartaz/sandbox.js/blob/master/jquery.highlight.js
+// Definitions by: Stefan Profanter <https://github.com/Pro/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+
+///<reference path="../jquery/jquery.d.ts" />
+
+interface JQuery {
+ unhighlight(options?: {
+ element?: string,
+ className?: string
+ }): JQuery;
+ highlight(words: string | string[], options?: {
+ element?: string,
+ className?: string
+ caseSensitive?: boolean,
+ wordsOnly?: boolean
+ }): JQuery;
+}
diff --git a/jquery.payment/jquery.payment.d.ts.tscparams b/jquery.payment/jquery.payment.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/jquery.payment/jquery.payment.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/jquery.pnotify/jquery.pnotify.d.ts b/jquery.pnotify/jquery.pnotify.d.ts
index 6e3e67cd34..a21416f845 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/jquery.qrcode/jquery.qrcode-tests.ts b/jquery.qrcode/jquery.qrcode-tests.ts
new file mode 100644
index 0000000000..716010c516
--- /dev/null
+++ b/jquery.qrcode/jquery.qrcode-tests.ts
@@ -0,0 +1,73 @@
+/// <reference path="../jquery/jquery.d.ts"/>
+/// <reference path="jquery.qrcode.d.ts"/>
+
+// Examples from website (note: the examples use color instead of fill, which is not supported)
+$('.container').qrcode();
+
+$('.container').qrcode({
+ "size": 100,
+ "fill": "#3a3",
+ "text": "http://larsjung.de/qrcode"
+});
+
+$('.container').qrcode({
+ "render": "div",
+ "size": 100,
+ "fill": "#3a3",
+ "text": "http://larsjung.de/qrcode"
+});
+
+// defaults
+$('.container').qrcode({
+
+ // render method: `'canvas'`, `'image'` or `'div'`
+ render: 'canvas',
+
+ // version range somewhere in 1 .. 40
+ minVersion: 1,
+ maxVersion: 40,
+
+ // error correction level: `'L'`, `'M'`, `'Q'` or `'H'`
+ ecLevel: 'L',
+
+ // offset in pixel if drawn onto existing canvas
+ left: 0,
+ top: 0,
+
+ // size in pixel
+ size: 200,
+
+ // code color or image element
+ fill: '#000',
+
+ // background color or image element, `null` for transparent background
+ background: null,
+
+ // content
+ text: 'no text',
+
+ // corner radius relative to module width: 0.0 .. 0.5
+ radius: 0,
+
+ // quiet zone in modules
+ quiet: 0,
+
+ // modes
+ // 0: normal
+ // 1: label strip
+ // 2: label box
+ // 3: image strip
+ // 4: image box
+ mode: JQueryQRCode.Mode.NORMAL,
+
+ mSize: 0.1,
+ mPosX: 0.5,
+ mPosY: 0.5,
+
+ label: 'no label',
+ fontname: 'sans',
+ fontcolor: '#000',
+
+ image: null
+});
+
diff --git a/jquery.qrcode/jquery.qrcode.d.ts b/jquery.qrcode/jquery.qrcode.d.ts
new file mode 100644
index 0000000000..c10582af2c
--- /dev/null
+++ b/jquery.qrcode/jquery.qrcode.d.ts
@@ -0,0 +1,127 @@
+// Type definitions for jQuery.qrcode v0.12.0
+// Project: https://github.com/lrsjng/jquery-qrcode
+// Definitions by: Dan Manastireanu <https://github.com/danmana>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../jquery/jquery.d.ts" />
+
+declare module JQueryQRCode {
+ /**
+ * One of the possible mode types.
+ */
+ export const enum Mode {
+ NORMAL,
+ LABEL_STRIP,
+ LABEL_BOX,
+ IMAGE_STRIP,
+ IMAGE_BOX
+ }
+
+ interface Options {
+ /**
+ * Render method: 'canvas', 'image' or 'div'
+ * @default 'canvas'
+ */
+ render?: string,
+
+ /**
+ * Start of version range, somewhere in 1 .. 40
+ * @default 1
+ */
+ minVersion?: number,
+ /**
+ * End of version range, somewhere in 1 .. 40
+ * @default 40
+ */
+ maxVersion?: number,
+
+ /**
+ * Error correction level: 'L', 'M', 'Q' or 'H'
+ * @default 'L'
+ */
+ ecLevel?: string,
+
+ /**
+ * Left offset in pixels, if drawn onto existing canvas
+ * @default 0
+ */
+ left?: number,
+ /**
+ * Top offset in pixels, if drawn onto existing canvas
+ * @default 0
+ */
+ top?: number,
+
+ /**
+ * Size in pixel
+ * @default 200
+ */
+ size?: number,
+
+ /**
+ * Code color or image element
+ * @default '#000'
+ */
+ fill?: string,
+
+ /**
+ * Background color or image element, null for transparent background
+ * @default null
+ */
+ background?: string,
+
+ /**
+ * The text content of the QR code.
+ * @default 'no text'
+ */
+ text?: string,
+
+ /**
+ * Corner radius relative to module width: 0.0 .. 0.5
+ * @default 0
+ */
+ radius?: number,
+
+ /**
+ * Quiet zone in modules
+ * @default 0
+ */
+ quiet?: number,
+
+ /**
+ * Mode
+ * @default Mode.NORMAL
+ */
+ mode?: Mode,
+
+
+ /** @default 0.1 */
+ mSize?: number,
+ /** @default 0.5 */
+ mPosX?: number,
+ /** @default 0.5 */
+ mPosY?: number,
+
+ /** @default 'no label' */
+ label?: string,
+ /** @default 'sans' */
+ fontname?: string,
+ /** @default '#000' */
+ fontcolor?: string,
+
+ /** @default null */
+ image?: string
+ }
+
+
+}
+
+
+
+interface JQuery {
+ /**
+ * Create a QR Code inside the selected container.
+ * @param options
+ */
+ qrcode(options?: JQueryQRCode.Options): JQuery;
+}
diff --git a/jquery/jquery-tests.ts b/jquery/jquery-tests.ts
index 0ba33c193d..62cd273f4d 100644
--- a/jquery/jquery-tests.ts
+++ b/jquery/jquery-tests.ts
@@ -3217,6 +3217,10 @@ function test_not() {
$("p").not("#selected");
$("p").not($("div p.selected"));
+
+ var el1 = $("<div/>")[0];
+ var el2 = $("<div/>")[0];
+ $("p").not([el1, el2]);
}
function test_EventIsNewable() {
diff --git a/jquery/jquery.d.ts b/jquery/jquery.d.ts
index 5beb4e4af6..8401753e35 100644
--- a/jquery/jquery.d.ts
+++ b/jquery/jquery.d.ts
@@ -3050,7 +3050,7 @@ interface JQuery {
*
* @param elements One or more DOM elements to remove from the matched set.
*/
- not(...elements: Element[]): JQuery;
+ not(elements: Element|Element[]): JQuery;
/**
* Remove elements from the set of matched elements.
*
diff --git a/jsdeferred/jsdeferred.d.ts.tscparams b/jsdeferred/jsdeferred.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/jsdeferred/jsdeferred.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/jsts/jsts-tests.ts b/jsts/jsts-tests.ts
new file mode 100644
index 0000000000..3b37d0f185
--- /dev/null
+++ b/jsts/jsts-tests.ts
@@ -0,0 +1,145 @@
+/// <reference path="jsts.d.ts" />
+var str: string;
+var n: number;
+var bool: boolean;
+var obj: any;
+
+var c: jsts.geom.Coordinate = new jsts.geom.Coordinate(n, n);
+var e: jsts.geom.Envelope = new jsts.geom.Envelope(n, n, n, n);
+var g: jsts.geom.Geometry = new jsts.geom.Geometry();
+var lr: jsts.geom.LinearRing = new jsts.geom.LinearRing([c]);
+var ls: jsts.geom.LineString = new jsts.geom.LineString([c]);
+var p: jsts.geom.Point = new jsts.geom.Point(c);
+var poly: jsts.geom.Polygon = new jsts.geom.Polygon(lr);
+
+str = jsts.version;
+
+c = new jsts.geom.Coordinate(c);
+c = c.clone();
+n = c.compareTo(c);
+n = c.distance(c);
+bool = c.equals(c);
+bool = c.equals2D(c);
+c.setCoordinate(c);
+n = c.x;
+n = c.y;
+n = c.z;
+
+e = new jsts.geom.Envelope(c);
+e = new jsts.geom.Envelope(e);
+e = new jsts.geom.Envelope(c, c);
+c = e.centre();
+e = e.clone();
+bool = e.contains(e);
+bool = e.contains(c);
+bool = e.contains(n, n);
+bool = e.covers(c);
+bool = e.covers(e);
+bool = e.covers(n, n);
+n = e.distance(e);
+bool = e.equals(e);
+e.expandBy(n);
+e.expandToInclude(c);
+e.expandToInclude(e);
+e.expandToInclude(n, n);
+n = e.getArea();
+n = e.getHeight();
+n = e.getMaxX();
+n = e.getMaxY();
+n = e.getMinX();
+n = e.getMinY();
+n = e.getWidth();
+e = e.intersection(e);
+bool = e.intersects(e);
+bool = e.intersects(c);
+bool = e.intersects(n, n);
+bool = e.isNull();
+n = e.maxx;
+n = e.maxy;
+n = e.minx;
+n = e.miny;
+e.setToNull();
+str = e.toString();
+e.translate(n, n);
+
+g.apply({});
+g = g.buffer(n, n, n);
+g.checkNotGeometryCollection(g);
+g = g.clone();
+n = g.compare([{}], [{}]);
+n = g.compareTo(g);
+n = g.compareToSameClass(g);
+e = g.computeEnvelopeInternal();
+bool = g.contains(g);
+g = g.convexHull();
+bool = g.coveredBy(g);
+bool = g.covers(g);
+bool = g.crosses(g);
+g = g.difference(g);
+bool = g.disjoint(g);
+n = g.distance(g);
+e = g.envelope;
+bool = g.equal(c, c, n);
+bool = g.equals(g);
+bool = g.equalsExact(g, n);
+bool = g.equalsNorm(g);
+bool = g.equalsTopo(g);
+n = g.getArea();
+g = g.getBoundary();
+n = g.getBoundaryDimension();
+p = g.getCentroid();
+c = g.getCoordinate();
+var coords: jsts.geom.Coordinate[] = g.getCoordinates();
+n = g.getDimension();
+g = g.getEnvelope();
+e = g.getEnvelopeInternal();
+obj = g.getFactory();
+g = g.getGeometryN(n);
+str = g.getGeometryType();
+p = g.getInteriorPoint();
+n = g.getLength();
+n = g.getNumGeometries();
+n = g.getNumPoints();
+obj = g.getPrecisionModel();
+g = g.intersection(g);
+bool = g.intersects(g);
+bool = g.isEmpty();
+bool = g.isEquivalentClass(g);
+bool = g.isGeometryCollection();
+bool = g.isGeometryCollectionBase();
+bool = g.isRectangle();
+bool = g.isSimple();
+bool = g.isValid();
+bool = g.isWithinDistance(g, n);
+g = g.norm();
+g.normalize();
+bool = g.overlaps(g);
+bool = g.relate(g, str);
+obj = g.relate2(g);
+g = g.symDifference(g);
+str = g.toString();
+bool = g.touches(g);
+g = g.union(g);
+bool = g.within(g);
+
+c = ls.getCoordinateN(n);
+p = ls.getEndPoint();
+p = ls.getPointN(n);
+p = ls.getStartPoint();
+bool = ls.isClosed();
+bool = ls.isRing();
+
+n = p.getX();
+n = p.getY();
+p = p.reverse();
+
+lr = poly.getExteriorRing();
+lr = poly.getInteriorRingN(n);
+n = poly.getNumInteriorRing();
+
+var gjw: jsts.io.GeoJSONWriter = new jsts.io.GeoJSONWriter();
+obj = gjw.write(g);
+
+var wr: jsts.io.WKTReader = new jsts.io.WKTReader();
+g = wr.read(str);
+wr.reducePrecision(g);
\ No newline at end of file
diff --git a/jsts/jsts.d.ts b/jsts/jsts.d.ts
new file mode 100644
index 0000000000..2eac4d5a48
--- /dev/null
+++ b/jsts/jsts.d.ts
@@ -0,0 +1,1666 @@
+// Type definitions for jsts 0.16.0
+// Project: https://github.com/bjornharrtell/jsts
+// Definitions by: Stephane Alie <https://github.com/StephaneAlie>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module jsts {
+ export var version: string;
+
+ module geom {
+ /**
+ * A lightweight class used to store coordinates on the 2-dimensional
+ * Cartesian plane. It is distinct from {@link Point}, which is a subclass of
+ * {@link Geometry}. Unlike objects of type {@link Point} (which contain
+ * additional information such as an envelope, a precision model, and spatial
+ * reference system information), a <code>Coordinate</code> only contains
+ * coordinate values and accessor methods.
+ */
+ export class Coordinate {
+ /**
+ * @constructor
+ */
+ constructor(x: number, y: number);
+
+ /**
+ * @constructor
+ */
+ constructor(c: Coordinate);
+
+ /**
+ * Gets or sets the x value.
+ */
+ x: number;
+
+ /**
+ * Gets or sets the y value.
+ */
+ y: number;
+
+ /**
+ * Gets or sets the z value.
+ */
+ z: number;
+
+ /**
+ * Sets this <code>Coordinate</code>s (x,y,z) values to that of
+ * <code>other</code>.
+ *
+ * @param {Coordinate}
+ * other the <code>Coordinate</code> to copy.
+ */
+ setCoordinate(other: Coordinate): void;
+
+ /**
+ * Clones this instance.
+ *
+ * @return {Coordinate} A point instance cloned from this.
+ */
+ clone(): Coordinate;
+
+ /**
+ * Computes the 2-dimensional Euclidean distance to another location. The
+ * Z-ordinate is ignored.
+ *
+ * @param {Coordinate}
+ * p a point.
+ * @return {number} the 2-dimensional Euclidean distance between the
+ * locations.
+ */
+ distance(p: Coordinate): number;
+
+ /**
+ * Returns whether the planar projections of the two <code>Coordinate</code>s
+ * are equal.
+ *
+ * @param {Coordinate}
+ * other a <code>Coordinate</code> with which to do the 2D
+ * comparison.
+ * @return {boolean} <code>true</code> if the x- and y-coordinates are
+ * equal; the z-coordinates do not have to be equal.
+ */
+ equals2D(other: Coordinate): boolean;
+
+ /**
+ * Returns <code>true</code> if <code>other</code> has the same values for
+ * the x and y ordinates. Since Coordinates are 2.5D, this routine ignores the
+ * z value when making the comparison.
+ *
+ * @param {Coordinate}
+ * other a <code>Coordinate</code> with which to do the comparison.
+ * @return {boolean} <code>true</code> if <code>other</code> is a
+ * <code>Coordinate</code> with the same values for the x and y
+ * ordinates.
+ */
+ equals(other: Coordinate): boolean;
+
+ /**
+ * Compares this {@link Coordinate} with the specified {@link Coordinate} for
+ * order. This method ignores the z value when making the comparison. Returns:
+ * <UL>
+ * <LI> -1 : this.x < other.x || ((this.x == other.x) && (this.y < other.y))
+ * <LI> 0 : this.x == other.x && this.y = other.y
+ * <LI> 1 : this.x > other.x || ((this.x == other.x) && (this.y > other.y))
+ *
+ * </UL>
+ * Note: This method assumes that ordinate values are valid numbers. NaN
+ * values are not handled correctly.
+ *
+ * @param {Coordinate}
+ * other the <code>Coordinate</code> with which this
+ * <code>Coordinate</code> is being compared.
+ * @return {number} -1, zero, or 1 as explained above.
+ */
+ compareTo(other: Coordinate): number;
+ }
+
+ /**
+ * Defines a rectangular region of the 2D coordinate plane. It is often used to
+ * represent the bounding box of a {@link Geometry}, e.g. the minimum and
+ * maximum x and y values of the {@link Coordinate}s.
+ * <p>
+ * Note that Envelopes support infinite or half-infinite regions, by using the
+ * values of <code>Double.POSITIVE_INFINITY</code> and
+ * <code>Double.NEGATIVE_INFINITY</code>.
+ * <p>
+ * When Envelope objects are created or initialized, the supplies extent values
+ * are automatically sorted into the correct order.
+ */
+ export class Envelope {
+ /**
+ * Test the point q to see whether it intersects the Envelope defined by p1-p2
+ *
+ * NOTE: calls intersectsEnvelope if four arguments are given to simulate
+ * overloaded function
+ *
+ * @param {jsts.geom.Coordinate}
+ * p1 one extremal point of the envelope.
+ * @param {jsts.geom.Coordinate}
+ * p2 another extremal point of the envelope.
+ * @param {jsts.geom.Coordinate}
+ * q the point to test for intersection.
+ * @return {boolean} <code>true</code> if q intersects the envelope p1-p2.
+ */
+ static intersects(p1: Coordinate, p2: Coordinate, q: Coordinate): boolean;
+
+ /**
+ * Test the envelope defined by p1-p2 for intersection with the envelope defined
+ * by q1-q2
+ *
+ * @param {jsts.geom.Coordinate}
+ * p1 one extremal point of the envelope P.
+ * @param {jsts.geom.Coordinate}
+ * p2 another extremal point of the envelope P.
+ * @param {jsts.geom.Coordinate}
+ * q1 one extremal point of the envelope Q.
+ * @param {jsts.geom.Coordinate}
+ * q2 another extremal point of the envelope Q.
+ * @return {boolean} <code>true</code> if Q intersects P.
+ */
+ static intersectsEnvelope(p1: Coordinate, p2: Coordinate, q1: Coordinate, q2: Coordinate): boolean;
+
+ /**
+ * Creates an <code>Envelope</code> for a region defined by maximum and
+ * minimum values.
+ *
+ * @param {number} x1 the first x-value.
+ * @param {number} x2 the second x-value.
+ * @param {number} y1 the first y-value.
+ * @param {number} y2 the second y-value.
+ */
+ constructor(x1: number, x2: number, y1: number, y2: number);
+
+ /**
+ * Initialize an <code>Envelope</code> to a region defined by two Coordinates.
+ *
+ * @param {jsts.geom.Coordinate} p1 the first Coordinate.
+ * @param {jsts.geom.Coordinate} p2 the second Coordinate.
+ */
+ constructor(p1: Coordinate, p2: Coordinate);
+
+ /**
+ * Initialize an <code>Envelope</code> to a region defined by a single
+ * Coordinate.
+ *
+ * @param {jsts.geom.Coordinate} p the Coordinate.
+ */
+ constructor(p: Coordinate);
+
+ /**
+ * Initialize an <code>Envelope</code> from an existing Envelope.
+ *
+ * @param {jsts.geom.Envelope} env the Envelope to initialize from.
+ */
+ constructor(env: Envelope);
+
+ /**
+ * the minimum x-coordinate.
+ */
+ minx: number;
+
+ /**
+ * the maximum x-coordinate.
+ */
+ maxx: number;
+
+ /**
+ * the minimum y-coordinate.
+ */
+ miny: number;
+
+ /**
+ * the maximum y-coordinate.
+ */
+ maxy: number;
+
+ /**
+ * Makes this <code>Envelope</code> a "null" envelope, that is, the envelope
+ * of the empty geometry.
+ */
+ setToNull(): void;
+
+ /**
+ * Returns <code>true</code> if this <code>Envelope</code> is a "null"
+ * envelope.
+ *
+ * @return {boolean} <code>true</code> if this <code>Envelope</code> is
+ * uninitialized or is the envelope of the empty geometry.
+ */
+ isNull(): boolean;
+
+ /**
+ * Returns the difference between the maximum and minimum y values.
+ *
+ * @return {number} max y - min y, or 0 if this is a null <code>Envelope.</code>
+ */
+ getHeight(): number;
+
+ /**
+ * Returns the difference between the maximum and minimum x values.
+ *
+ * @return {number} max x - min x, or 0 if this is a null <code>Envelope.</code>
+ */
+ getWidth(): number;
+
+ /**
+ * Returns the <code>Envelope</code>s minimum x-value. min x > max x
+ * indicates that this is a null <code>Envelope</code>.
+ *
+ * @return {number} the minimum x-coordinate.
+ */
+ getMinX(): number;
+
+ /**
+ * Returns the <code>Envelope</code>s maximum x-value. min x > max x
+ * indicates that this is a null <code>Envelope</code>.
+ *
+ * @return {number} the maximum x-coordinate.
+ */
+ getMaxX(): number;
+
+ /**
+ * Returns the <code>Envelope</code>s minimum y-value. min y > max y
+ * indicates that this is a null <code>Envelope</code>.
+ *
+ * @return {number} the minimum y-coordinate.
+ */
+ getMinY(): number;
+
+ /**
+ * Returns the <code>Envelope</code>s maximum y-value. min y > max y
+ * indicates that this is a null <code>Envelope</code>.
+ *
+ * @return {number} the maximum y-coordinate.
+ */
+ getMaxY(): number;
+
+ /**
+ * Gets the area of this envelope.
+ *
+ * @return {number} the area of the envelope, 0.0 if the envelope is null.
+ */
+ getArea(): number;
+
+ /**
+ * Enlarges this <code>Envelope</code> so that it contains the given
+ * {@link Coordinate}. Has no effect if the point is already on or within the
+ * envelope.
+ *
+ * @param {jsts.geom.Coordinate} p the Coordinate to expand to include.
+ */
+ expandToInclude(p: Coordinate): void;
+
+ /**
+ * Enlarges this <code>Envelope</code> so that it contains the given point.
+ * Has no effect if the point is already on or within the envelope.
+ *
+ * @param {number} x the value to lower the minimum x to or to raise the maximum x to.
+ * @param {number} y the value to lower the minimum y to or to raise the maximum y to.
+ */
+ expandToInclude(x: number, y: number): void;
+
+ /**
+ * Enlarges this <code>Envelope</code> so that it contains the
+ * <code>other</code> Envelope. Has no effect if <code>other</code> is
+ * wholly on or within the envelope.
+ *
+ * @param {jsts.geom.Envelope} other the <code>Envelope</code> to expand to include.
+ */
+ expandToInclude(other: Envelope): void;
+
+ /**
+ * Expands this envelope by a given distance in all directions. Both positive
+ * and negative distances are supported.
+ *
+ * @param {number} distance the distance to expand the envelope.
+ */
+ expandBy(distance: number): void;
+
+ /**
+ * Expands this envelope by a given distance in all directions. Both positive
+ * and negative distances are supported.
+ *
+ * @param {number}
+ * deltaX the distance to expand the envelope along the the X axis.
+ * @param {number}
+ * deltaY the distance to expand the envelope along the the Y axis.
+ */
+ expandBy(deltaX: number, deltaY: number): void;
+
+ /**
+ * Translates this envelope by given amounts in the X and Y direction.
+ *
+ * @param {number}
+ * transX the amount to translate along the X axis.
+ * @param {number}
+ * transY the amount to translate along the Y axis.
+ */
+ translate(transX: number, transY: number): void;
+
+ /**
+ * Computes the coordinate of the centre of this envelope (as long as it is
+ * non-null
+ *
+ * @return {jsts.geom.Coordinate} the centre coordinate of this envelope <code>null</code>
+ * if the envelope is null.
+ */
+ centre(): Coordinate;
+
+ /**
+ * Computes the intersection of two {@link Envelopes}
+ *
+ * @param {jsts.geom.Envelope}
+ * env the envelope to intersect with.
+ * @return {jsts.geom.Envelope} a new Envelope representing the intersection of
+ * the envelopes (this will be the null envelope if either argument is
+ * null, or they do not intersect.
+ */
+ intersection(env: Envelope): Envelope;
+
+ /**
+ * Check if the region defined by <code>other</code> overlaps (intersects) the
+ * region of this <code>Envelope</code>.
+ *
+ * @param {jsts.geom.Envelope}
+ * other the <code>Envelope</code> which this <code>Envelope</code>
+ * is being checked for overlapping.
+ * @return {boolean} <code>true</code> if the <code>Envelope</code>s
+ * overlap.
+ */
+ intersects(other: Envelope): boolean;
+
+ /**
+ * Check if the point <code>p</code> overlaps (lies inside) the region of this
+ * <code>Envelope</code>.
+ *
+ * @param {jsts.geom.Coordinate}
+ * p the <code>Coordinate</code> to be tested.
+ * @return {boolean} <code>true</code> if the point overlaps this
+ * <code>Envelope.</code>
+ */
+ intersects(p: Coordinate): boolean;
+
+ /**
+ * Check if the point <code>(x, y)</code> overlaps (lies inside) the region of
+ * this <code>Envelope</code>.
+ *
+ * @param {number}
+ * x the x-ordinate of the point.
+ * @param {number}
+ * y the y-ordinate of the point.
+ * @return {boolean} <code>true</code> if the point overlaps this
+ * <code>Envelope.</code>
+ */
+ intersects(x: number, y: number): boolean;
+
+ /**
+ * Tests if the <code>Envelope other</code> lies wholely inside this
+ * <code>Envelope</code> (inclusive of the boundary).
+ * <p>
+ * Note that this is <b>not</b> the same definition as the SFS
+ * <tt>contains</tt>, which would exclude the envelope boundary.
+ *
+ * @param {jsts.geom.Envelope}
+ * other the <code>Envelope</code> to check.
+ * @return {boolean} true if <code>other</code> is contained in this
+ * <code>Envelope.</code>
+ *
+ * @see covers(Envelope)
+ */
+ contains(other: Envelope): boolean;
+
+ /**
+ * Tests if the given point lies in or on the envelope.
+ * <p>
+ * Note that this is <b>not</b> the same definition as the SFS
+ * <tt>contains</tt>, which would exclude the envelope boundary.
+ *
+ * @param {jsts.geom.Coordinate}
+ * p the point which this <code>Envelope</code> is being checked for
+ * containing.
+ * @return {boolean} <code>true</code> if the point lies in the interior or on
+ * the boundary of this <code>Envelope</code>.
+ *
+ * @see covers(Coordinate)
+ */
+ contains(p: Coordinate): boolean;
+
+ /**
+ * Tests if the given point lies in or on the envelope.
+ * <p>
+ * Note that this is <b>not</b> the same definition as the SFS
+ * <tt>contains</tt>, which would exclude the envelope boundary.
+ *
+ * @param {number}
+ * x the x-coordinate of the point which this <code>Envelope</code>
+ * is being checked for containing.
+ * @param {number}
+ * y the y-coordinate of the point which this <code>Envelope</code>
+ * is being checked for containing.
+ * @return {boolean} <code>true</code> if <code>(x, y)</code> lies in the
+ * interior or on the boundary of this <code>Envelope</code>.
+ *
+ * @see covers(double, double)
+ */
+ contains(x: number, y: number): boolean;
+
+ /**
+ * Tests if the given point lies in or on the envelope.
+ *
+ * @param {number}
+ * x the x-coordinate of the point which this <code>Envelope</code>
+ * is being checked for containing.
+ * @param {number}
+ * y the y-coordinate of the point which this <code>Envelope</code>
+ * is being checked for containing.
+ * @return {boolean} <code>true</code> if <code>(x, y)</code> lies in the
+ * interior or on the boundary of this <code>Envelope</code>.
+ */
+ covers(x: number, y: number): boolean;
+
+ /**
+ * Tests if the given point lies in or on the envelope.
+ *
+ * @param {jsts.geom.Coordinate}
+ * p the point which this <code>Envelope</code> is being checked for
+ * containing.
+ * @return {boolean} <code>true</code> if the point lies in the interior or on
+ * the boundary of this <code>Envelope</code>.
+ */
+ covers(p: Coordinate): boolean;
+
+ /**
+ * Tests if the <code>Envelope other</code> lies wholely inside this
+ * <code>Envelope</code> (inclusive of the boundary).
+ *
+ * @param {jsts.geom.Envelope}
+ * other the <code>Envelope</code> to check.
+ * @return {boolean} true if this <code>Envelope</code> covers the
+ * <code>other.</code>
+ */
+ covers(other: Envelope): boolean;
+
+ /**
+ * Computes the distance between this and another <code>Envelope</code>.
+ *
+ * @param {jsts.geom.Envelope}
+ * env The <code>Envelope</code> to test this <code>Envelope</code>
+ * against.
+ * @return {number} The distance between overlapping Envelopes is 0. Otherwise,
+ * the distance is the Euclidean distance between the closest points.
+ */
+ distance(env: Envelope): number;
+
+ /**
+ * @param {jsts.geom.Envelope}
+ * other the <code>Envelope</code> to check against.
+ * @return {boolean} true if envelopes are equal.
+ */
+ equals(other: Envelope): boolean;
+
+ /**
+ * @return {string} String representation of this <code>Envelope.</code>
+ */
+ toString(): string;
+
+ /**
+ * @return {jsts.geom.Envelope} A new instance copied from this.
+ */
+ clone(): Envelope;
+ }
+
+ /**
+ * The base class for all geometric objects.
+ */
+ export class Geometry {
+ /**
+ * Creates a new <tt>Geometry</tt> via the specified GeometryFactory.
+ */
+ constructor(factory?: any);
+
+ /**
+ * The bounding box of this <code>Geometry</code>.
+ */
+ envelope: Envelope;
+
+ /**
+ * Gets the factory which contains the context in which this geometry was created.
+ *
+ * @return {jsts.geom.GeometryFactory} the factory for this geometry.
+ */
+ getFactory(): any;
+
+ /**
+ * Returns the name of this object's <code>com.vivid.jts.geom</code> interface.
+ *
+ * @return {string} The name of this <code>Geometry</code>s most specific <code>jsts.geom</code> interface.
+ */
+ getGeometryType(): string;
+
+ /**
+ *Returns the number of {@link Geometry}s in a {@link GeometryCollection}
+ * (or 1, if the geometry is not a collection).
+ *
+ * @return {number} the number of geometries contained in this geometry.
+ */
+ getNumGeometries(): number;
+
+ /**
+ * Returns an element {@link Geometry} from a {@link GeometryCollection} (or
+ * <code>this</code>, if the geometry is not a collection).
+ *
+ * @param {number} n The index of the geometry element.
+ *
+ * @return {Geometry} the n'th geometry contained in this geometry.
+ */
+ getGeometryN(n: number): Geometry;
+
+ /**
+ * Returns the <code>PrecisionModel</code> used by the <code>Geometry</code>.
+ *
+ * @return {PrecisionModel} the specification of the grid of allowable points, for this
+ * <code>Geometry</code> and all other <code>Geometry</code>s.
+ */
+ getPrecisionModel(): any;
+
+ /**
+ * Returns a vertex of this <code>Geometry</code> (usually, but not
+ * necessarily, the first one). The returned coordinate should not be assumed to
+ * be an actual Coordinate object used in the internal representation.
+ *
+ * @return {Coordinate} a {@link Coordinate} which is a vertex of this
+ * <code>Geometry</code>. null if this Geometry is empty.
+ */
+ getCoordinate(): Coordinate;
+
+ /**
+ * Returns an array containing the values of all the vertices for this geometry.
+ * If the geometry is a composite, the array will contain all the vertices for
+ * the components, in the order in which the components occur in the geometry.
+ * <p>
+ * In general, the array cannot be assumed to be the actual internal storage for
+ * the vertices. Thus modifying the array may not modify the geometry itself.
+ * Use the {@link CoordinateSequence#setOrdinate} method (possibly on the
+ * components) to modify the underlying data. If the coordinates are modified,
+ * {@link #geometryChanged} must be called afterwards.
+ *
+ * @return {Coordinate[]} the vertices of this <code>Geometry.</code>
+ * @see geometryChanged
+ * @see CoordinateSequence#setOrdinate
+ */
+ getCoordinates(): Coordinate[];
+
+ /**
+ * Returns the count of this <code>Geometry</code>s vertices. The
+ * <code>Geometry</code> s contained by composite <code>Geometry</code>s
+ * must be Geometry's; that is, they must implement <code>getNumPoints</code>
+ *
+ * @return {number} the number of vertices in this <code>Geometry.</code>
+ */
+ getNumPoints(): number;
+
+ /**
+ * Tests whether this {@link Geometry} is simple. In general, the SFS
+ * specification of simplicity follows the rule:
+ * <UL>
+ * <LI> A Geometry is simple iff the only self-intersections are at boundary
+ * points.
+ * </UL>
+ * Simplicity is defined for each {@link Geometry} subclass as follows:
+ * <ul>
+ * <li>Valid polygonal geometries are simple by definition, so
+ * <code>isSimple</code> trivially returns true.
+ * <li>Linear geometries are simple iff they do not self-intersect at points
+ * other than boundary points.
+ * <li>Zero-dimensional geometries (points) are simple iff they have no
+ * repeated points.
+ * <li>Empty <code>Geometry</code>s are always simple
+ * <ul>
+ *
+ * @return {boolean} <code>true</code> if this <code>Geometry</code> has any
+ * points of self-tangency, self-intersection or other anomalous points.
+ * @see #isValid
+ */
+ isSimple(): boolean;
+
+ /**
+ * Tests the validity of this <code>Geometry</code>. Subclasses provide their
+ * own definition of "valid".
+ *
+ * @return {boolean} <code>true</code> if this <code>Geometry</code> is
+ * valid.
+ *
+ * @see IsValidOp
+ */
+ isValid(): boolean;
+
+ /**
+ * Returns whether or not the set of points in this <code>Geometry</code> is
+ * empty.
+ *
+ * @return {boolean} <code>true</code> if this <code>Geometry</code> equals
+ * the empty geometry.
+ */
+ isEmpty(): boolean;
+
+ /**
+ * Returns the minimum distance between this <code>Geometry</code> and the
+ * <code>Geometry</code> g
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> from which to compute the distance.
+ * @return {number} the distance between the geometries. 0 if either input
+ * geometry is empty.
+ * @throws IllegalArgumentException
+ * if g is null
+ */
+ distance(g: Geometry): number;
+
+ /**
+ * Tests whether the distance from this <code>Geometry</code> to another is
+ * less than or equal to a specified value.
+ *
+ * @param {Geometry}
+ * geom the Geometry to check the distance to.
+ * @param {number}
+ * distance the distance value to compare.
+ * @return {boolean} <code>true</code> if the geometries are less than
+ * <code>distance</code> apart.
+ */
+ isWithinDistance(geom: Geometry, distance: number): boolean;
+
+ isRectangle(): boolean;
+
+ /**
+ * Returns the area of this <code>Geometry</code>. Areal Geometries have a
+ * non-zero area. They override this function to compute the area. Others return
+ * 0.0
+ *
+ * @return the area of the Geometry.
+ */
+ getArea(): number;
+
+ /**
+ * Returns the length of this <code>Geometry</code>. Linear geometries return
+ * their length. Areal geometries return their perimeter. They override this
+ * function to compute the area. Others return 0.0
+ *
+ * @return the length of the Geometry.
+ */
+ getLength(): number;
+
+ /**
+ * Computes the centroid of this <code>Geometry</code>. The centroid is equal
+ * to the centroid of the set of component Geometries of highest dimension
+ * (since the lower-dimension geometries contribute zero "weight" to the
+ * centroid)
+ *
+ * @return a {@link Point} which is the centroid of this Geometry.
+ */
+ getCentroid(): Point;
+
+ /**
+ * Computes an interior point of this <code>Geometry</code>. An interior
+ * point is guaranteed to lie in the interior of the Geometry, if it possible to
+ * calculate such a point exactly. Otherwise, the point may lie on the boundary
+ * of the geometry.
+ *
+ * @return {Point} a {@link Point} which is in the interior of this Geometry.
+ */
+ getInteriorPoint(): Point;
+
+ /**
+ * Returns the dimension of this geometry. The dimension of a geometry is is the
+ * topological dimension of its embedding in the 2-D Euclidean plane. In the JTS
+ * spatial model, dimension values are in the set {0,1,2}.
+ * <p>
+ * Note that this is a different concept to the dimension of the vertex
+ * {@link Coordinate}s. The geometry dimension can never be greater than the
+ * coordinate dimension. For example, a 0-dimensional geometry (e.g. a Point)
+ * may have a coordinate dimension of 3 (X,Y,Z).
+ *
+ * @return {number} the topological dimension of this geometry.
+ */
+ getDimension(): number;
+
+ /**
+ * Returns the boundary, or an empty geometry of appropriate dimension if this
+ * <code>Geometry</code> is empty. (In the case of zero-dimensional
+ * geometries, ' an empty GeometryCollection is returned.) For a discussion of
+ * this function, see the OpenGIS Simple Features Specification. As stated in
+ * SFS Section 2.1.13.1, "the boundary of a Geometry is a set of Geometries of
+ * the next lower dimension."
+ *
+ * @return {Geometry} the closure of the combinatorial boundary of this
+ * <code>Geometry.</code>
+ */
+ getBoundary(): Geometry;
+
+ /**
+ * Returns the dimension of this <code>Geometry</code>s inherent boundary.
+ *
+ * @return {number} the dimension of the boundary of the class implementing this
+ * interface, whether or not this object is the empty geometry. Returns
+ * <code>Dimension.FALSE</code> if the boundary is the empty geometry.
+ */
+ getBoundaryDimension(): number;
+
+ /**
+ * Returns this <code>Geometry</code>s bounding box. If this
+ * <code>Geometry</code> is the empty geometry, returns an empty
+ * <code>Point</code>. If the <code>Geometry</code> is a point, returns a
+ * non-empty <code>Point</code>. Otherwise, returns a <code>Polygon</code>
+ * whose points are (minx, miny), (maxx, miny), (maxx, maxy), (minx, maxy),
+ * (minx, miny).
+ *
+ * @return {Geometry} an empty <code>Point</code> (for empty
+ * <code>Geometry</code>s), a <code>Point</code> (for
+ * <code>Point</code>s) or a <code>Polygon</code> (in all other
+ * cases).
+ */
+ getEnvelope(): Geometry;
+
+ /**
+ * Returns the minimum and maximum x and y values in this <code>Geometry</code>,
+ * or a null <code>Envelope</code> if this <code>Geometry</code> is empty.
+ *
+ * @return {Envelope} this <code>Geometry</code>s bounding box; if the
+ * <code>Geometry</code> is empty, <code>Envelope#isNull</code> will
+ * return <code>true.</code>
+ */
+ getEnvelopeInternal(): Envelope;
+
+ /**
+ * Tests whether this geometry is disjoint from the specified geometry.
+ * <p>
+ * The <code>disjoint</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>The two geometries have no point in common
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[FF*FF****]</code>
+ * <li><code>! g.intersects(this)</code> (<code>disjoint</code> is the
+ * inverse of <code>intersects</code>)
+ * </ul>
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if the two <code>Geometry</code>s
+ * are disjoint.
+ *
+ * @see Geometry#intersects
+ */
+ disjoint(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry touches the specified geometry.
+ * <p>
+ * The <code>touches</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>The geometries have at least one point in common, but their interiors do
+ * not intersect.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[FT*******]</code> or <code>[F**T*****]</code> or
+ * <code>[F***T****]</code>
+ * </ul>
+ * If both geometries have dimension 0, this predicate returns
+ * <code>false</code>
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if the two <code>Geometry</code>s
+ * touch; Returns <code>false</code> if both <code>Geometry</code>s
+ * are points.
+ */
+ touches(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry intersects the specified geometry.
+ * <p>
+ * The <code>intersects</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>The two geometries have at least one point in common
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[T********]</code> or <code>[*T*******]</code> or
+ * <code>[***T*****]</code> or <code>[****T****]</code>
+ * <li><code>! g.disjoint(this)</code> (<code>intersects</code> is the
+ * inverse of <code>disjoint</code>)
+ * </ul>
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if the two <code>Geometry</code>s
+ * intersect.
+ *
+ * @see Geometry#disjoint
+ */
+ intersects(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry crosses the specified geometry.
+ * <p>
+ * The <code>crosses</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>The geometries have some but not all interior points in common.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <ul>
+ * <li><code>[T*T******]</code> (for P/L, P/A, and L/A situations)
+ * <li><code>[T*****T**]</code> (for L/P, A/P, and A/L situations)
+ * <li><code>[0********]</code> (for L/L situations)
+ * </ul>
+ * </ul>
+ * For any other combination of dimensions this predicate returns
+ * <code>false</code>.
+ * <p>
+ * The SFS defined this predicate only for P/L, P/A, L/L, and L/A situations.
+ * JTS extends the definition to apply to L/P, A/P and A/L situations as well,
+ * in order to make the relation symmetric.
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if the two <code>Geometry</code>s
+ * cross.
+ */
+ crosses(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry is within the specified geometry.
+ * <p>
+ * The <code>within</code> predicate has the following equivalent definitions:
+ * <ul>
+ * <li>Every point of this geometry is a point of the other geometry, and the
+ * interiors of the two geometries have at least one point in common.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[T*F**F***]</code>
+ * <li><code>g.contains(this)</code> (<code>within</code> is the converse
+ * of <code>contains</code>)
+ * </ul>
+ * An implication of the definition is that "The boundary of a Geometry is not
+ * within the Geometry". In other words, if a geometry A is a subset of the
+ * points in the boundary of a geomtry B, <code>A.within(B) = false</code>
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if this <code>Geometry</code> is
+ * within <code>other.</code>
+ *
+ * @see Geometry#contains
+ */
+ within(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry contains the specified geometry.
+ * <p>
+ * The <code>contains</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>Every point of the other geometry is a point of this geometry, and the
+ * interiors of the two geometries have at least one point in common.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[T*****FF*]</code>
+ * <li><code>g.within(this)</code> (<code>contains</code> is the converse
+ * of <code>within</code>)
+ * </ul>
+ * An implication of the definition is that "Geometries do not contain their
+ * boundary". In other words, if a geometry A is a subset of the points in the
+ * boundary of a geometry B, <code>B.contains(A) = false</code>
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if this <code>Geometry</code>
+ * contains <code>g.</code>
+ *
+ * @see Geometry#within
+ */
+ contains(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry overlaps the specified geometry.
+ * <p>
+ * The <code>overlaps</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>The geometries have at least one point each not shared by the other (or
+ * equivalently neither covers the other), they have the same dimension, and the
+ * intersection of the interiors of the two geometries has the same dimension as
+ * the geometries themselves.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[T*T***T**]</code> (for two points or two surfaces) or
+ * <code>[1*T***T**]</code> (for two curves)
+ * </ul>
+ * If the geometries are of different dimension this predicate returns
+ * <code>false</code>.
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if the two <code>Geometry</code>s
+ * overlap.
+ */
+ overlaps(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry covers the specified geometry.
+ * <p>
+ * The <code>covers</code> predicate has the following equivalent definitions:
+ * <ul>
+ * <li>Every point of the other geometry is a point of this geometry.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[T*****FF*]</code> or <code>[*T****FF*]</code> or
+ * <code>[***T**FF*]</code> or <code>[****T*FF*]</code>
+ * <li><code>g.coveredBy(this)</code> (<code>covers</code> is the converse
+ * of <code>coveredBy</code>)
+ * </ul>
+ * If either geometry is empty, the value of this predicate is <tt>false</tt>.
+ * <p>
+ * This predicate is similar to {@link #contains}, but is more inclusive (i.e.
+ * returns <tt>true</tt> for more cases). In particular, unlike
+ * <code>contains</code> it does not distinguish between points in the
+ * boundary and in the interior of geometries. For most situations,
+ * <code>covers</code> should be used in preference to <code>contains</code>.
+ * As an added benefit, <code>covers</code> is more amenable to optimization,
+ * and hence should be more performant.
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if this <code>Geometry</code> covers
+ * <code>g.</code>
+ *
+ * @see Geometry#contains
+ * @see Geometry#coveredBy
+ */
+ covers(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry is covered by the specified geometry.
+ * <p>
+ * The <code>coveredBy</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>Every point of this geometry is a point of the other geometry.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches
+ * <code>[T*F**F***]</code> or <code>[*TF**F***]</code> or
+ * <code>[**FT*F***]</code> or <code>[**F*TF***]</code>
+ * <li><code>g.covers(this)</code> (<code>coveredBy</code> is the converse
+ * of <code>covers</code>)
+ * </ul>
+ * If either geometry is empty, the value of this predicate is <tt>false</tt>.
+ * <p>
+ * This predicate is similar to {@link #within}, but is more inclusive (i.e.
+ * returns <tt>true</tt> for more cases).
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if this <code>Geometry</code> is
+ * covered by <code>g.</code>
+ *
+ * @see Geometry#within
+ * @see Geometry#covers
+ */
+ coveredBy(g: Geometry): boolean;
+
+ /**
+ * Tests whether the elements in the DE-9IM {@link IntersectionMatrix} for the
+ * two <code>Geometry</code>s match the elements in
+ * <code>intersectionPattern</code>. The pattern is a 9-character string,
+ * with symbols drawn from the following set:
+ * <UL>
+ * <LI> 0 (dimension 0)
+ * <LI> 1 (dimension 1)
+ * <LI> 2 (dimension 2)
+ * <LI> T ( matches 0, 1 or 2)
+ * <LI> F ( matches FALSE)
+ * <LI> * ( matches any value)
+ * </UL>
+ * For more information on the DE-9IM, see the <i>OpenGIS Simple Features
+ * Specification</i>.
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @param {string}
+ * intersectionPattern the pattern against which to check the
+ * intersection matrix for the two <code>Geometry</code>s.
+ * @return {boolean} <code>true</code> if the DE-9IM intersection matrix for
+ * the two <code>Geometry</code>s match
+ * <code>intersectionPattern.</code>
+ * @see IntersectionMatrix
+ */
+ relate(g: Geometry, intersectionPattern: string): boolean;
+
+ /**
+ * Returns the DE-9IM {@link IntersectionMatrix} for the two
+ * <code>Geometry</code>s.
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {IntersectionMatrix} an {@link IntersectionMatrix} describing the
+ * intersections of the interiors, boundaries and exteriors of the two
+ * <code>Geometry</code>s.
+ */
+ relate2(g: Geometry): any;
+
+ /**
+ * Tests whether this geometry is topologically equal to the argument geometry
+ * as defined by the SFS <tt>equals</tt> predicate.
+ * <p>
+ * The SFS <code>equals</code> predicate has the following equivalent
+ * definitions:
+ * <ul>
+ * <li>The two geometries have at least one point in common, and no point of
+ * either geometry lies in the exterior of the other geometry.
+ * <li>The DE-9IM Intersection Matrix for the two geometries matches the
+ * pattern <tt>T*F**FFF*</tt>
+ * <pre>
+ * T*F
+ * **F
+ * FF*
+ * </pre>
+ *
+ * </ul>
+ * <b>Note</b> that this method computes <b>topologically equality</b>. For
+ * structural equality, see {@link #equalsExact(Geometry)}.
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {boolean} <code>true</code> if the two <code>Geometry</code>s
+ * are topologically equal.
+ *
+ * @see #equalsExact(Geometry)
+ */
+ equalsTopo(g: Geometry): boolean;
+
+ /**
+ * Tests whether this geometry is structurally and numerically equal to a given
+ * <tt>Object</tt>. If the argument <tt>Object</tt> is not a
+ * <tt>Geometry</tt>, the result is <tt>false</tt>. Otherwise, the result
+ * is computed using {@link #equalsExact(Geometry)}.
+ * <p>
+ * This method is provided to fulfill the Java contract for value-based object
+ * equality. In conjunction with {@link #hashCode()} it provides semantics which
+ * are most useful for using <tt>Geometry</tt>s as keys and values in Java
+ * collections.
+ * <p>
+ * Note that to produce the expected result the input geometries should be in
+ * normal form. It is the caller's responsibility to perform this where required
+ * (using {@link Geometry#norm() or {@link #normalize()} as appropriate).
+ *
+ * @param {Object}
+ * o the Object to compare.
+ * @return {boolean} true if this geometry is exactly equal to the argument.
+ *
+ * @see #equalsExact(Geometry)
+ * @see #hashCode()
+ * @see #norm()
+ * @see #normalize()
+ */
+ equals(o: Object): boolean;
+
+ /**
+ * Computes a buffer area around this geometry having the given width and with a
+ * specified accuracy of approximation for circular arcs, and using a specified
+ * end cap style.
+ * <p>
+ * Mathematically-exact buffer area boundaries can contain circular arcs. To
+ * represent these arcs using linear geometry they must be approximated with
+ * line segments. The <code>quadrantSegments</code> argument allows
+ * controlling the accuracy of the approximation by specifying the number of
+ * line segments used to represent a quadrant of a circle
+ * <p>
+ * The end cap style specifies the buffer geometry that will be created at the
+ * ends of linestrings. The styles provided are:
+ * <ul>
+ * <li><tt>BufferOp.CAP_ROUND</tt> - (default) a semi-circle
+ * <li><tt>BufferOp.CAP_BUTT</tt> - a straight line perpendicular to the end
+ * segment
+ * <li><tt>BufferOp.CAP_SQUARE</tt> - a half-square
+ * </ul>
+ * <p>
+ * The buffer operation always returns a polygonal result. The negative or
+ * zero-distance buffer of lines and points is always an empty {@link Polygon}.
+ * This is also the result for the buffers of degenerate (zero-area) polygons.
+ *
+ * @param {number}
+ * distance the width of the buffer (may be positive, negative or 0).
+ * @param {number}
+ * quadrantSegments the number of line segments used to represent a
+ * quadrant of a circle.
+ * @param {number}
+ * endCapStyle the end cap style to use.
+ * @return {Geometry} a polygonal geometry representing the buffer region (which
+ * may be empty).
+ *
+ * @throws TopologyException
+ * if a robustness error occurs
+ *
+ * @see #buffer(double)
+ * @see #buffer(double, int)
+ * @see BufferOp
+ */
+ buffer(distance: number, quadrantSegments: number, endCapStyle: number): Geometry;
+
+ /**
+ * Computes the smallest convex <code>Polygon</code> that contains all the
+ * points in the <code>Geometry</code>. This obviously applies only to
+ * <code>Geometry</code> s which contain 3 or more points; the results for
+ * degenerate cases are specified as follows: <TABLE>
+ * <TR>
+ * <TH> Number of <code>Point</code>s in argument <code>Geometry</code>
+ * </TH>
+ * <TH> <code>Geometry</code> class of result </TH>
+ * </TR>
+ * <TR>
+ * <TD> 0 </TD>
+ * <TD> empty <code>GeometryCollection</code> </TD>
+ * </TR>
+ * <TR>
+ * <TD> 1 </TD>
+ * <TD> <code>Point</code> </TD>
+ * </TR>
+ * <TR>
+ * <TD> 2 </TD>
+ * <TD> <code>LineString</code> </TD>
+ * </TR>
+ * <TR>
+ * <TD> 3 or more </TD>
+ * <TD> <code>Polygon</code> </TD>
+ * </TR>
+ * </TABLE>
+ *
+ * @return {Geometry} the minimum-area convex polygon containing this
+ * <code>Geometry</code>' s points.
+ */
+ convexHull(): Geometry;
+
+ /**
+ * Computes a <code>Geometry</code> representing the points shared by this
+ * <code>Geometry</code> and <code>other</code>. {@link GeometryCollection}s
+ * support intersection with homogeneous collection types, with the semantics
+ * that the result is a {@link GeometryCollection} of the intersection of each
+ * element of the target with the argument.
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compute the
+ * intersection.
+ * @return {Geometry} the points common to the two <code>Geometry</code>s.
+ * @throws TopologyException
+ * if a robustness error occurs
+ * @throws IllegalArgumentException
+ * if the argument is a non-empty GeometryCollection
+ */
+ intersection(other: Geometry): Geometry;
+
+ /**
+ * Computes a <code>Geometry</code> representing all the points in this
+ * <code>Geometry</code> and <code>other</code>.
+ *
+ * Or without arguments:
+ *
+ * Computes the union of all the elements of this geometry. Heterogeneous
+ * {@link GeometryCollection}s are fully supported.
+ *
+ * The result obeys the following contract:
+ * <ul>
+ * <li>Unioning a set of {@link LineString}s has the effect of fully noding
+ * and dissolving the linework.
+ * <li>Unioning a set of {@link Polygon}s will always return a
+ * {@link Polygonal} geometry (unlike {link #union(Geometry)}, which may return
+ * geometrys of lower dimension if a topology collapse occurred.
+ * </ul>
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compute the union.
+ * @return {Geometry} a set combining the points of this <code>Geometry</code>
+ * and the points of <code>other.</code>
+ * @throws TopologyException
+ * if a robustness error occurs
+ * @throws IllegalArgumentException
+ * if either input is a non-empty GeometryCollection
+ */
+ union(other: Geometry): Geometry;
+
+ /**
+ * Computes a <code>Geometry</code> representing the points making up this
+ * <code>Geometry</code> that do not make up <code>other</code>. This
+ * method returns the closure of the resultant <code>Geometry</code>.
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compute the
+ * difference.
+ * @return {Geometry} the point set difference of this <code>Geometry</code>
+ * with <code>other.</code>
+ * @throws TopologyException
+ * if a robustness error occurs
+ * @throws IllegalArgumentException
+ * if either input is a non-empty GeometryCollection
+ */
+ difference(other: Geometry): Geometry;
+
+ /**
+ * Returns a set combining the points in this <code>Geometry</code> not in
+ * <code>other</code>, and the points in <code>other</code> not in this
+ * <code>Geometry</code>. This method returns the closure of the resultant
+ * <code>Geometry</code>.
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compute the
+ * symmetric difference.
+ * @return {Geometry} the point set symmetric difference of this
+ * <code>Geometry</code> with <code>other.</code>
+ * @throws TopologyException
+ * if a robustness error occurs
+ * @throws IllegalArgumentException
+ * if either input is a non-empty GeometryCollection
+ */
+ symDifference(other: Geometry): Geometry;
+
+ /**
+ * Returns true if the two <code>Geometry</code>s are exactly equal, up to a
+ * specified distance tolerance. Two Geometries are exactly equal within a
+ * distance tolerance if and only if:
+ * <ul>
+ * <li>they have the same class
+ * <li>they have the same values for their vertices, within the given tolerance
+ * distance, in exactly the same order.
+ * </ul>
+ * If this and the other <code>Geometry</code>s are composites and any
+ * children are not <code>Geometry</code>s, returns <code>false</code>.
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @param {number}
+ * tolerance distance at or below which two <code>Coordinate</code>s
+ * are considered equal.
+ * @return {boolean}
+ */
+ equalsExact(other: Geometry, tolerance: number): boolean;
+
+ /**
+ * Tests whether two geometries are exactly equal in their normalized forms.
+ * This is a convenience method which creates normalized versions of both
+ * geometries before computing {@link #equalsExact(Geometry)}. This method is
+ * relatively expensive to compute. For maximum performance, the client should
+ * instead perform normalization itself at an appropriate point during
+ * execution.
+ *
+ * @param {Geometry}
+ * g a Geometry.
+ * @return {boolean} true if the input geometries are exactly equal in their
+ * normalized form.
+ */
+ equalsNorm(g: Geometry): boolean;
+
+ /**
+ * Performs an operation with or on this <code>Geometry</code> and its
+ * subelement <code>Geometry</code>s (if any). Only GeometryCollections and
+ * subclasses have subelement Geometry's.
+ *
+ * @param filter
+ * the filter to apply to this <code>Geometry</code> (and its
+ * children, if it is a <code>GeometryCollection</code>).
+ */
+ apply(filter: any): void;
+
+ /**
+ * Creates and returns a full copy of this {@link Geometry} object (including
+ * all coordinates contained by it). Subclasses are responsible for overriding
+ * this method and copying their internal data. Overrides should call this
+ * method first.
+ *
+ * @return a clone of this instance.
+ */
+ clone(): Geometry;
+
+ /**
+ * Converts this <code>Geometry</code> to <b>normal form</b> (or <b>
+ * canonical form</b> ). Normal form is a unique representation for
+ * <code>Geometry</code> s. It can be used to test whether two
+ * <code>Geometry</code>s are equal in a way that is independent of the
+ * ordering of the coordinates within them. Normal form equality is a stronger
+ * condition than topological equality, but weaker than pointwise equality. The
+ * definitions for normal form use the standard lexicographical ordering for
+ * coordinates. "Sorted in order of coordinates" means the obvious extension of
+ * this ordering to sequences of coordinates.
+ */
+ normalize(): void;
+
+ /**
+ * Creates a new Geometry which is a normalized copy of this Geometry.
+ *
+ * @return a normalized copy of this geometry.
+ * @see #normalize()
+ */
+ norm(): Geometry;
+
+ /**
+ * Returns whether this <code>Geometry</code> is greater than, equal to, or
+ * less than another <code>Geometry</code>.
+ * <P>
+ *
+ * If their classes are different, they are compared using the following
+ * ordering:
+ * <UL>
+ * <LI> Point (lowest)
+ * <LI> MultiPoint
+ * <LI> LineString
+ * <LI> LinearRing
+ * <LI> MultiLineString
+ * <LI> Polygon
+ * <LI> MultiPolygon
+ * <LI> GeometryCollection (highest)
+ * </UL>
+ * If the two <code>Geometry</code>s have the same class, their first
+ * elements are compared. If those are the same, the second elements are
+ * compared, etc.
+ *
+ * @param {Geometry}
+ * other a <code>Geometry</code> with which to compare this
+ * <code>Geometry.</code>
+ * @return {number} a positive number, 0, or a negative number, depending on
+ * whether this object is greater than, equal to, or less than
+ * <code>o</code>, as defined in "Normal Form For Geometry" in the
+ * JTS Technical Specifications.
+ */
+ compareTo(o: Geometry): number;
+
+ /**
+ * Returns whether the two <code>Geometry</code>s are equal, from the point
+ * of view of the <code>equalsExact</code> method. Called by
+ * <code>equalsExact</code> . In general, two <code>Geometry</code> classes
+ * are considered to be "equivalent" only if they are the same class. An
+ * exception is <code>LineString</code> , which is considered to be equivalent
+ * to its subclasses.
+ *
+ * @param {Geometry}
+ * other the <code>Geometry</code> with which to compare this
+ * <code>Geometry</code> for equality.
+ * @return {boolean} <code>true</code> if the classes of the two
+ * <code>Geometry</code> s are considered to be equal by the
+ * <code>equalsExact</code> method.
+ */
+ isEquivalentClass(other: Geometry): boolean;
+
+ /**
+ * Throws an exception if <code>g</code>'s class is
+ * <code>GeometryCollection</code> . (Its subclasses do not trigger an
+ * exception).
+ *
+ * @param {Geometry}
+ * g the <code>Geometry</code> to check.
+ * @throws Error
+ * if <code>g</code> is a <code>GeometryCollection</code> but not
+ * one of its subclasses
+ */
+ checkNotGeometryCollection(g: Geometry): void;
+
+ /**
+ *
+ * @return {boolean} true if this is a GeometryCollection.
+ */
+ isGeometryCollection(): boolean;
+
+ /**
+ *
+ * @return {boolean} true if this is a GeometryCollection but not subclass.
+ */
+ isGeometryCollectionBase(): boolean;
+
+ /**
+ * Returns the minimum and maximum x and y values in this <code>Geometry</code>,
+ * or a null <code>Envelope</code> if this <code>Geometry</code> is empty.
+ * Unlike <code>getEnvelopeInternal</code>, this method calculates the
+ * <code>Envelope</code> each time it is called;
+ * <code>getEnvelopeInternal</code> caches the result of this method.
+ *
+ * @return {Envelope} this <code>Geometry</code>s bounding box; if the
+ * <code>Geometry</code> is empty, <code>Envelope#isNull</code> will
+ * return <code>true.</code>
+ */
+ computeEnvelopeInternal(): Envelope;
+
+ /**
+ * Returns whether this <code>Geometry</code> is greater than, equal to, or
+ * less than another <code>Geometry</code> having the same class.
+ *
+ * @param o
+ * a <code>Geometry</code> having the same class as this
+ * <code>Geometry.</code>
+ * @return a positive number, 0, or a negative number, depending on whether this
+ * object is greater than, equal to, or less than <code>o</code>, as
+ * defined in "Normal Form For Geometry" in the JTS Technical
+ * Specifications.
+ */
+ compareToSameClass(o: Geometry): number;
+
+ /**
+ * Returns the first non-zero result of <code>compareTo</code> encountered as
+ * the two <code>Collection</code>s are iterated over. If, by the time one of
+ * the iterations is complete, no non-zero result has been encountered, returns
+ * 0 if the other iteration is also complete. If <code>b</code> completes
+ * before <code>a</code>, a positive number is returned; if a before b, a
+ * negative number.
+ *
+ * @param {Array}
+ * a a <code>Collection</code> of <code>Comparable</code>s.
+ * @param {Array}
+ * b a <code>Collection</code> of <code>Comparable</code>s.
+ * @return {number} the first non-zero <code>compareTo</code> result, if any;
+ * otherwise, zero.
+ */
+ compare(a: Array<any>, b: Array<any>): number;
+
+ /**
+ * @param {jsts.geom.Coordinate}
+ * a first Coordinate to compare.
+ * @param {jsts.geom.Coordinate}
+ * b second Coordinate to compare.
+ * @param {number}
+ * tolerance tolerance when comparing.
+ * @return {boolean} true if equal.
+ */
+ equal(a: Coordinate, b: Coordinate, tolerance: number): boolean;
+
+ /**
+ * Returns a WKT representation of this geometry.
+ */
+ toString(): string;
+ }
+
+ /**
+ * Models an OGC SFS <code>LinearRing</code>. A LinearRing is a LineString
+ * which is both closed and simple. In other words, the first and last
+ * coordinate in the ring must be equal, and the interior of the ring must not
+ * self-intersect. Either orientation of the ring is allowed.
+ * <p>
+ * A ring must have either 0 or 4 or more points. The first and last points
+ * must be equal (in 2D). If these conditions are not met, the constructors
+ * throw an {@link IllegalArgumentException}
+ */
+ export class LinearRing extends LineString {
+ }
+
+ export class LineString extends Geometry {
+ /**
+ * @constructor
+ */
+ constructor(points: Array<Coordinate>, factory?: any);
+
+ /**
+ * @return {jsts.geom.Coordinate} The n'th coordinate of this
+ * jsts.geom.LineString.
+ * @param {int}
+ * n index.
+ */
+ getCoordinateN(n: number): Coordinate;
+
+ /**
+ * @return {jsts.geom.Point} The n'th point of this
+ * jsts.geom.LineString.
+ * @param {int}
+ * n index.
+ */
+ getPointN(n: number): Point;
+
+ /**
+ * @return {jsts.geom.Point} The first point of this
+ * jsts.geom.LineString.
+ */
+ getStartPoint(): Point;
+
+ /**
+ * @return {jsts.geom.Point} The last point of this
+ * jsts.geom.LineString.
+ */
+ getEndPoint(): Point;
+
+ /**
+ * @return {Boolean} true if LineString is Closed.
+ */
+ isClosed(): boolean;
+
+ /**
+ * @return {Boolean} true if LineString is a Ring.
+ */
+ isRing(): boolean;
+ }
+
+ export class Point extends Geometry {
+ /**
+ * @constructor
+ */
+ constructor(coordinate: Coordinate, factory?: any);
+
+ /**
+ * @return {number} x-axis value of this Point.
+ */
+ getX(): number;
+
+ /**
+ * @return {number} y-axis value of this Point.
+ */
+ getY(): number;
+
+ /**
+ * @return {Point} Reversed point is a cloned point.
+ */
+ reverse(): Point;
+ }
+
+ /**
+ * Represents a linear polygon, which may include holes. The shell and holes
+ * of the polygon are represented by {@link LinearRing}s. In a valid polygon,
+ * holes may touch the shell or other holes at a single point. However, no
+ * sequence of touching holes may split the polygon into two pieces. The
+ * orientation of the rings in the polygon does not matter.
+ *
+ * The shell and holes must conform to the assertions specified in the <A
+ * HREF="http://www.opengis.org/techno/specs.htm">OpenGIS Simple Features
+ * Specification for SQL</A>.
+ */
+ export class Polygon extends Geometry {
+ /**
+ * @constructor
+ */
+ constructor(shell: LinearRing, holes?: Array<LinearRing>, factory?: any);
+
+ /**
+ * Gets the exterior ring.
+ *
+ * @return {LinearRing} The exterior ring.
+ */
+ getExteriorRing(): LinearRing;
+
+ /**
+ * Gets the interior ring at the specified index.
+ *
+ * @param {number} n The interior ring index.
+ *
+ * @returns {LinearRing} The interior ring at the specified index.
+ */
+ getInteriorRingN(n: number): LinearRing;
+
+ /**
+ * Gets the number of interior rings.
+ *
+ * @return {number} The number of interior rings.
+ */
+ getNumInteriorRing(): number;
+ }
+ }
+
+ module io {
+ export class GeoJSONWriter {
+ /**
+ * Writes the GeoJSON representation of a {@link Geometry}. The
+ * The GeoJSON format is defined <A
+ * HREF="http://geojson.org/geojson-spec.html">here</A>.
+ * <p>
+ * The <code>GeoJSONWriter</code> outputs coordinates rounded to the precision
+ * model. Only the maximum number of decimal places necessary to represent the
+ * ordinates to the required precision will be output.
+ * <p>
+ *
+ * @see WKTReader
+ * @constructor
+ */
+ constructor();
+
+ /**
+ * Converts a <code>Geometry</code> to its GeoJSON representation.
+ *
+ * @param {jsts.geom.Geometry}
+ * geometry a <code>Geometry</code> to process.
+ * @return {Object} The GeoJSON representation of the Geometry.
+ */
+ write(geometry: geom.Geometry): Object;
+ }
+
+ /**
+ * Converts a geometry in Well-Known Text format to a {@link Geometry}.
+ * <p>
+ * <code>WKTReader</code> supports extracting <code>Geometry</code> objects
+ * from either {@link Reader}s or {@link String}s. This allows it to function
+ * as a parser to read <code>Geometry</code> objects from text blocks embedded
+ * in other data formats (e.g. XML).
+ * <P>
+ * <p>
+ * A <code>WKTReader</code> is parameterized by a <code>GeometryFactory</code>,
+ * to allow it to create <code>Geometry</code> objects of the appropriate
+ * implementation. In particular, the <code>GeometryFactory</code> determines
+ * the <code>PrecisionModel</code> and <code>SRID</code> that is used.
+ * <P>
+ */
+ export class WKTReader {
+ /**
+ * @constructor
+ */
+ constructor(geometryFactory?: any);
+
+ /**
+ * Reads a Well-Known Text representation of a {@link Geometry}
+ *
+ * @param {string}
+ * wkt a <Geometry Tagged Text> string (see the OpenGIS Simple Features
+ * Specification).
+ * @return {jsts.geom.Geometry} a <code>Geometry</code> read from
+ * <code>string.</code>
+ */
+ read(wkt: string): geom.Geometry;
+
+ reducePrecision(geometry: geom.Geometry): void;
+ }
+ }
+}
\ No newline at end of file
diff --git a/kafka-node/kafka-node-test.ts b/kafka-node/kafka-node-tests.ts
similarity index 100%
rename from kafka-node/kafka-node-test.ts
rename to kafka-node/kafka-node-tests.ts
diff --git a/karma/karma-tests-0.12.ts b/karma/karma-0.12-tests.ts
similarity index 100%
rename from karma/karma-tests-0.12.ts
rename to karma/karma-0.12-tests.ts
diff --git a/karma/karma-tests.ts b/karma/karma-tests.ts
index dd571f8ae5..7dbd533b59 100644
--- a/karma/karma-tests.ts
+++ b/karma/karma-tests.ts
@@ -29,8 +29,8 @@ karma.runner.run({port: 9876}, (exitCode: number) => {
});
-var Server = require('karma').Server;
-var server = new Server({port: 9876}, function(exitCode: number) {
+//var Server = require('karma').Server; => cannot use this syntax otherwise Server is of type any
+var server = new karma.Server({logLevel: 'debug', port: 9876}, function(exitCode: number) {
console.log('Karma has exited with ' + exitCode);
process.exit(exitCode);
});
@@ -43,8 +43,8 @@ server.on('browser_register', function (browser: any) {
console.log('A new browser was registered');
});
-var runner = require('karma').runner;
-runner.run({port: 9876}, function(exitCode: number) {
+//var runner = require('karma').runner; => cannot use this syntax otherwise runner is of type any
+karma.runner.run({port: 9876}, function(exitCode: number) {
console.log('Karma has exited with ' + exitCode);
process.exit(exitCode);
});
@@ -52,3 +52,44 @@ runner.run({port: 9876}, function(exitCode: number) {
//
var captured: boolean = karma.launcher.areAllCaptured();
+
+
+// Example of configuration file karma.conf.ts, see http://karma-runner.github.io/0.13/config/configuration-file.html
+module.exports = function(config: karma.Config) {
+ config.set({
+ logLevel: config.LOG_DEBUG,
+ basePath: '..',
+ urlRoot: '/base/',
+ frameworks: ['jasmine'],
+
+ files: [
+ 'file1.js',
+ 'file2.js',
+ 'file3.js',
+ {
+ pattern: '**/*.html',
+ included: false
+ }
+ ],
+
+ reporters: [
+ 'progress',
+ 'coverage'
+ ],
+
+ preprocessors: {
+ 'app.js': ['coverage']
+ },
+
+ port: 9876,
+
+ autoWatch: true,
+
+ browsers: [
+ 'Chrome',
+ 'Firefox'
+ ],
+
+ singleRun: true
+ });
+};
diff --git a/karma/karma.d.ts b/karma/karma.d.ts
index cad9eb6ba6..c489535eb3 100644
--- a/karma/karma.d.ts
+++ b/karma/karma.d.ts
@@ -8,7 +8,7 @@
/// <reference path="../log4js/log4js.d.ts" />
declare module 'karma' {
- // See Karma public API https://karma-runner.github.io/0.12/dev/public-api.html
+ // See Karma public API https://karma-runner.github.io/0.13/dev/public-api.html
import Promise = require('bluebird');
import https = require('https');
import log4js = require('log4js');
@@ -53,11 +53,11 @@ declare module 'karma' {
}
interface Runner {
- run(options?: Config, callback?: ServerCallback): void;
+ run(options?: ConfigOptions|ConfigFile, callback?: ServerCallback): void;
}
interface Server extends NodeJS.EventEmitter {
- new(options?: Config, callback?: ServerCallback): Server;
+ new(options?: ConfigOptions|ConfigFile, callback?: ServerCallback): Server;
/**
* Start the server
*/
@@ -82,8 +82,21 @@ declare module 'karma' {
interface ServerCallback {
(exitCode: number): void;
}
+
+ interface Config {
+ set: (config: ConfigOptions) => void;
+ LOG_DISABLE: string;
+ LOG_ERROR: string;
+ LOG_WARN: string;
+ LOG_INFO: string;
+ LOG_DEBUG: string;
+ }
+
+ interface ConfigFile {
+ configFile: string;
+ }
- interface Config {
+ interface ConfigOptions {
/**
* @description Enable or disable watching files and executing the tests whenever one of these files changes.
* @default true
@@ -163,7 +176,7 @@ declare module 'karma' {
* </p>
*/
captureTimeout?: number;
- client?: ClientConfig;
+ client?: ClientOptions;
/**
* @default true
* @description Enable or disable colors in the output (reporters and logs).
@@ -308,7 +321,7 @@ declare module 'karma' {
urlRoot?: string;
}
- interface ClientConfig {
+ interface ClientOptions {
/**
* @default undefined
* @description When karma run is passed additional arguments on the command-line, they
diff --git a/knex/knex-test.ts b/knex/knex-tests.ts
similarity index 98%
rename from knex/knex-test.ts
rename to knex/knex-tests.ts
index 081f98867d..1d468b2605 100644
--- a/knex/knex-test.ts
+++ b/knex/knex-tests.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 82c26cfec6..d2afc4aa82 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/knockout-secure-binding/knockout-secure-binding-test.ts b/knockout-secure-binding/knockout-secure-binding-tests.ts
similarity index 100%
rename from knockout-secure-binding/knockout-secure-binding-test.ts
rename to knockout-secure-binding/knockout-secure-binding-tests.ts
diff --git a/knockout/knockout.d.ts b/knockout/knockout.d.ts
index edb510b6db..bee7041dee 100644
--- a/knockout/knockout.d.ts
+++ b/knockout/knockout.d.ts
@@ -6,7 +6,7 @@
interface KnockoutSubscribableFunctions<T> {
[key: string]: KnockoutBindingHandler;
-
+
notifySubscribers(valueToWrite?: T, event?: string): void;
}
@@ -16,7 +16,7 @@ interface KnockoutComputedFunctions<T> {
interface KnockoutObservableFunctions<T> {
[key: string]: KnockoutBindingHandler;
-
+
equalityComparer(a: any, b: any): boolean;
}
@@ -36,7 +36,7 @@ interface KnockoutObservableArrayFunctions<T> {
// Ko specific
[key: string]: KnockoutBindingHandler;
-
+
replace(oldItem: T, newItem: T): void;
remove(item: T): T[];
@@ -77,7 +77,7 @@ interface KnockoutComputedStatic {
interface KnockoutComputed<T> extends KnockoutObservable<T>, KnockoutComputedFunctions<T> {
fn: KnockoutComputedFunctions<any>;
-
+
dispose(): void;
isActive(): boolean;
getDependenciesCount(): number;
@@ -216,22 +216,12 @@ interface KnockoutExtenders {
trackArrayChanges(target: any): any;
}
+//
+// NOTE TO MAINTAINERS AND CONTRIBUTORS : pay attention to only include symbols that are
+// publicly exported in the minified version of ko, without that you can give the false
+// impression that some functions will be available in production builds.
+//
interface KnockoutUtils {
-
- //////////////////////////////////
- // utils.domManipulation.js
- //////////////////////////////////
-
- simpleHtmlParse(html: string): any[];
-
- jQueryHtmlParse(html: string): any[];
-
- parseHtmlFragment(html: string): any[];
-
- setHtml(node: Element, html: string): void;
-
- setHtml(node: Element, html: () => string): void;
-
//////////////////////////////////
// utils.domData.js
//////////////////////////////////
@@ -260,91 +250,77 @@ interface KnockoutUtils {
removeNode(node: Node): void;
};
- //////////////////////////////////
- // utils.js
- //////////////////////////////////
-
- fieldsIncludedWithJsonPost: any[];
-
- compareArrays<T>(a: T[], b: T[]): Array<KnockoutArrayChange<T>>;
-
- arrayForEach<T>(array: T[], action: (item: T, index: number) => void): void;
-
- arrayIndexOf<T>(array: T[], item: T): number;
-
- arrayFirst<T>(array: T[], predicate: (item: T) => boolean, predicateOwner?: any): T;
-
- arrayRemoveItem(array: any[], itemToRemove: any): void;
-
- arrayGetDistinctValues<T>(array: T[]): T[];
-
- arrayMap<T, U>(array: T[], mapping: (item: T) => U): U[];
+ addOrRemoveItem<T>(array: T[] | KnockoutObservable<T>, value: T, included: T): void;
arrayFilter<T>(array: T[], predicate: (item: T) => boolean): T[];
- arrayPushAll<T>(array: T[], valuesToPush: T[]): T[];
+ arrayFirst<T>(array: T[], predicate: (item: T) => boolean, predicateOwner?: any): T;
- arrayPushAll<T>(array: KnockoutObservableArray<T>, valuesToPush: T[]): T[];
+ arrayForEach<T>(array: T[], action: (item: T, index: number) => void): void;
+
+ arrayGetDistinctValues<T>(array: T[]): T[];
+
+ arrayIndexOf<T>(array: T[], item: T): number;
+
+ arrayMap<T, U>(array: T[], mapping: (item: T) => U): U[];
+
+ arrayPushAll<T>(array: T[] | KnockoutObservableArray<T>, valuesToPush: T[]): T[];
+
+ arrayRemoveItem(array: any[], itemToRemove: any): void;
+
+ compareArrays<T>(a: T[], b: T[]): Array<KnockoutArrayChange<T>>;
extend(target: Object, source: Object): Object;
- moveCleanedNodesToContainerElement(nodes: any[]): HTMLElement;
+ fieldsIncludedWithJsonPost: any[];
- cloneNodes(nodesArray: any[], shouldCleanNodes: boolean): any[];
+ getFormFields(form: any, fieldName: string): any[];
- setDomNodeChildren(domNode: any, childNodes: any[]): void;
+ objectForEach(obj: any, action: (key: any, value: any) => void): void;
- replaceDomNodes(nodeToReplaceOrNodeArray: any, newNodesArray: any[]): void;
+ parseHtmlFragment(html: string): any[];
- setOptionNodeSelectionState(optionNode: any, isSelected: boolean): void;
+ parseJson(jsonString: string): any;
- stringTrim(str: string): string;
+ postJson(urlOrForm: any, data: any, options: any): void;
- stringTokenize(str: string, delimiter: string): string[];
+ peekObservable<T>(value: KnockoutObservable<T>): T;
- stringStartsWith(str: string, startsWith: string): boolean;
-
- domNodeIsContainedBy(node: any, containedByNode: any): boolean;
-
- domNodeIsAttachedToDocument(node: any): boolean;
-
- tagNameLower(element: any): string;
+ range(min: any, max: any): any;
registerEventHandler(element: any, eventType: any, handler: Function): void;
+ setHtml(node: Element, html: () => string): void;
+
+ setHtml(node: Element, html: string): void;
+
+ setTextContent(element: any, textContent: string | KnockoutObservable<string>): void;
+
+ stringifyJson(data: any, replacer?: Function, space?: string): string;
+
+ toggleDomNodeCssClass(node: any, className: string, shouldHaveClass: boolean): void;
+
triggerEvent(element: any, eventType: any): void;
unwrapObservable<T>(value: KnockoutObservable<T> | T): T;
- peekObservable<T>(value: KnockoutObservable<T>): T;
-
- toggleDomNodeCssClass(node: any, className: string, shouldHaveClass: boolean): void;
-
- //setTextContent(element: any, textContent: string): void; // NOT PART OF THE MINIFIED API SURFACE (ONLY IN knockout-{version}.debug.js) https://github.com/SteveSanderson/knockout/issues/670
-
- setElementName(element: any, name: string): void;
-
- forceRefresh(node: any): void;
-
- ensureSelectElementIsRenderedCorrectly(selectElement: any): void;
-
- range(min: any, max: any): any;
-
- makeArray(arrayLikeObject: any): any[];
-
- getFormFields(form: any, fieldName: string): any[];
-
- parseJson(jsonString: string): any;
-
- stringifyJson(data: any, replacer?: Function, space?: string): string;
-
- postJson(urlOrForm: any, data: any, options: any): void;
-
- ieVersion: number;
-
- isIe6: boolean;
-
- isIe7: boolean;
+ // NOT PART OF THE MINIFIED API SURFACE (ONLY IN knockout-{version}.debug.js) https://github.com/SteveSanderson/knockout/issues/670
+ // forceRefresh(node: any): void;
+ // ieVersion: number;
+ // isIe6: boolean;
+ // isIe7: boolean;
+ // jQueryHtmlParse(html: string): any[];
+ // makeArray(arrayLikeObject: any): any[];
+ // moveCleanedNodesToContainerElement(nodes: any[]): HTMLElement;
+ // replaceDomNodes(nodeToReplaceOrNodeArray: any, newNodesArray: any[]): void;
+ // setDomNodeChildren(domNode: any, childNodes: any[]): void;
+ // setElementName(element: any, name: string): void;
+ // setOptionNodeSelectionState(optionNode: any, isSelected: boolean): void;
+ // simpleHtmlParse(html: string): any[];
+ // stringStartsWith(str: string, startsWith: string): boolean;
+ // stringTokenize(str: string, delimiter: string): string[];
+ // stringTrim(str: string): string;
+ // tagNameLower(element: any): string;
}
interface KnockoutArrayChange<T> {
@@ -573,7 +549,7 @@ interface KnockoutComputedContext {
}
//
-// refactored types into a namespace to reduce global pollution
+// refactored types into a namespace to reduce global pollution
// and used Union Types to simplify overloads (requires TypeScript 1.4)
//
declare module KnockoutComponentTypes {
diff --git a/ko.plus/ko.plus-tests.ts b/ko.plus/ko.plus-tests.ts
index 7dd1053b22..bff291d839 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 dacf6121f3..4c9299aeea 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/later/later-test.ts b/later/later-tests.ts
similarity index 95%
rename from later/later-test.ts
rename to later/later-tests.ts
index 2d336d1b3f..4f0d429708 100644
--- a/later/later-test.ts
+++ b/later/later-tests.ts
@@ -8,7 +8,7 @@ module LaterTest_DefineSchedule {
var cronSched = later.parse.cron('0 0/5 14,18 * * ?');
var recurSched = later.parse.recur().last().dayOfMonth();
var manualSched = <Later.IScheduleData>{ schedules: [ <Later.IRecurrence>{ M: [ 3 ], D: [ 21 ] } ] };
-
+
// this schedule will fire on the closest weekday to the 15th
// every month at 2:00 am except in March
var complexSched = later.parse.recur()
@@ -414,7 +414,7 @@ module LaterTest_TimePeriods {
export function custom() {
var customLater = <IPartOfDayLater>later;
-
+
customLater.partOfDay = {
name: 'part of day',
@@ -422,10 +422,10 @@ module LaterTest_TimePeriods {
range: later.hour.range * 6,
val: function(d: Date): number {
- return later.hour.val(d) < 12
- ? 0
- : later.hour.val(d) < 18
- ? 1
+ return later.hour.val(d) < 12
+ ? 0
+ : later.hour.val(d) < 18
+ ? 1
: 2;
},
@@ -433,15 +433,15 @@ module LaterTest_TimePeriods {
return customLater.partOfDay.val(d) === val;
},
- extent: function(date?: Date) {
- return [0, 2];
+ extent: function(date?: Date) {
+ return [0, 2];
},
start: function(date: Date) {
- var hour = customLater.partOfDay.val(date) === 0
- ? 0
- : customLater.partOfDay.val(date) === 1
- ? 12
+ var hour = customLater.partOfDay.val(date) === 0
+ ? 0
+ : customLater.partOfDay.val(date) === 1
+ ? 12
: 18;
return later.date.next(
@@ -453,10 +453,10 @@ module LaterTest_TimePeriods {
},
end: function(date: Date) {
- var hour = customLater.partOfDay.val(date) === 0
- ? 11
- : customLater.partOfDay.val(date) === 1
- ? 5
+ var hour = customLater.partOfDay.val(date) === 0
+ ? 11
+ : customLater.partOfDay.val(date) === 1
+ ? 5
: 23;
return later.date.prev(
@@ -468,10 +468,10 @@ module LaterTest_TimePeriods {
},
next: function(date: Date, val: any) {
- var hour = val === 0
- ? 0
- : val === 1
- ? 12
+ var hour = val === 0
+ ? 0
+ : val === 1
+ ? 12
: 18;
return later.date.next(
@@ -484,17 +484,17 @@ module LaterTest_TimePeriods {
},
prev: function(date: Date, val: any) {
- var hour = val === 0
- ? 11
- : val === 1
- ? 5
+ var hour = val === 0
+ ? 11
+ : val === 1
+ ? 5
: 23;
return later.date.prev(
later.year.val(date),
later.month.val(date),
// decrement the day if we already passed the desired time period
- later.day.val(date) + (hour > later.hour.val(date) ? -1 : 0),
+ later.day.val(date) + (hour > later.hour.val(date) ? -1 : 0),
hour
);
}
@@ -503,7 +503,7 @@ module LaterTest_TimePeriods {
}
module LaterTest_GenerateRecurences {
-
+
export function on_method() {
// fires on the 2nd minute every hour
later.parse.recur().on(2).minute();
diff --git a/leaflet-editable/leaflet-editable-tests.ts b/leaflet-editable/leaflet-editable-tests.ts
new file mode 100644
index 0000000000..fa904f6713
--- /dev/null
+++ b/leaflet-editable/leaflet-editable-tests.ts
@@ -0,0 +1,57 @@
+/// <reference path="leaflet-editable.d.ts" />
+
+var map: L.Map = L.map('div', {
+ editable: true,
+ editOptions: {
+ drawingCSSClass: 'css-class',
+ editLayer: L.layerGroup(),
+ featuresLayer: L.layerGroup<L.Marker|L.Polyline|L.Polygon>(),
+ lineGuideOptions: {},
+ markerClass: MarkerClass,
+ markerEditorClass: MarkerEditorClass,
+ middleMarkerClass: MiddleMarkerClass,
+ polygonClass: PolygonClass,
+ polygonEditorClass: PolygonEditorClass,
+ polylineClass: PolylineClass,
+ polylineEditorClass: PolylineEditorClass,
+ skipMiddleMarkers: true,
+ vertexMarkerClass: VertexMarkerClass
+ }
+});
+
+var currentPoly: L.Polygon|L.Polyline| L.Marker = map.editTools.currentPolygon;
+map.editTools.stopDrawing();
+
+var marker: L.Marker = map.editTools.startMarker(L.latLng(0, 0), { draggable: true });
+marker.disable();
+marker.enable();
+marker.toggleEdit();
+var enabled: boolean = marker.editEnabled();
+
+var polyline: L.Polyline = map.editTools.startPolyline(L.latLng(0, 0), { noClip: true });
+polyline.continueBackward();
+polyline.continueForward();
+polyline.disable();
+polyline.enable();
+enabled = polyline.editEnabled();
+polyline.reset();
+polyline.toggleEdit();
+
+var polygon: L.Polygon = map.editTools.startPolygon(L.latLng(0, 0), { noClip: true });
+polygon.continueBackward();
+polygon.continueForward();
+polygon.disable();
+polygon.enable();
+enabled = polygon.editEnabled();
+polygon.newHole(L.latLng(0, 0));
+polygon.reset();
+polygon.toggleEdit();
+
+class MarkerClass { }
+class MarkerEditorClass { }
+class MiddleMarkerClass { }
+class PolygonClass { }
+class PolygonEditorClass { }
+class PolylineClass { }
+class PolylineEditorClass { }
+class VertexMarkerClass { }
\ No newline at end of file
diff --git a/leaflet-editable/leaflet-editable.d.ts b/leaflet-editable/leaflet-editable.d.ts
new file mode 100644
index 0000000000..4297a34cb6
--- /dev/null
+++ b/leaflet-editable/leaflet-editable.d.ts
@@ -0,0 +1,258 @@
+// Type definitions for Leaflet.Editable 0.7
+// Project: https://github.com/yohanboniface/Leaflet.Editable
+// Definitions by: Dominic Alie <https://github.com/dalie>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../leaflet/leaflet.d.ts" />
+
+declare module L {
+ /**
+ * Make geometries editable in Leaflet.
+ *
+ * This is not a plug and play UI, and will not. This is a minimal, lightweight, and fully extendable API to
+ * control editing of geometries. So you can easily build your own UI with your own needs and choices.
+ */
+ export interface EditableStatic {
+ new (map: Map, options: EditOptions): Editable;
+ }
+
+ /**
+ * Options to pass to L.Editable when instanciating.
+ */
+ export interface EditOptions {
+ /**
+ * Class to be used when creating a new Polyline.
+ */
+ polylineClass?: Object;
+
+ /**
+ * Class to be used when creating a new Polygon.
+ */
+ polygonClass?: Object;
+
+ /**
+ * Class to be used when creating a new Marker.
+ */
+ markerClass?: Object;
+
+ /**
+ * CSS class to be added to the map container while drawing.
+ */
+ drawingCSSClass?: string;
+
+ /**
+ * Layer used to store edit tools (vertex, line guide…).
+ */
+ editLayer?: L.LayerGroup<L.ILayer>;
+
+ /**
+ * Default layer used to store drawn features (marker, polyline…).
+ */
+ featuresLayer?: L.LayerGroup<L.Polyline|L.Polygon|L.Marker>;
+
+ /**
+ * Class to be used as vertex, for path editing.
+ */
+ vertexMarkerClass?: Object;
+
+ /**
+ * Class to be used as middle vertex, pulled by the user to create a new point in the middle of a path.
+ */
+ middleMarkerClass?: Object;
+
+ /**
+ * Class to be used as Polyline editor.
+ */
+ polylineEditorClass?: Object;
+
+ /**
+ * Class to be used as Polygon editor.
+ */
+ polygonEditorClass?: Object;
+
+ /**
+ * Class to be used as Marker editor.
+ */
+ markerEditorClass?: Object;
+
+ /**
+ * Options to be passed to the line guides.
+ */
+ lineGuideOptions?: Object;
+
+ /**
+ * Set this to true if you don't want middle markers.
+ */
+ skipMiddleMarkers?: boolean;
+ }
+
+ /**
+ * Make geometries editable in Leaflet.
+ *
+ * This is not a plug and play UI, and will not. This is a minimal, lightweight, and fully extendable API to
+ * control editing of geometries. So you can easily build your own UI with your own needs and choices.
+ */
+ export interface Editable extends Mixin.LeafletMixinEvents {
+ /**
+ * Options to pass to L.Editable when instanciating.
+ */
+ options: EditOptions;
+
+ currentPolygon: Polyline|Polygon|Marker;
+
+ /**
+ * Start drawing a polyline. If latlng is given, a first point will be added. In any case, continuing on user
+ * click. If options is given, it will be passed to the polyline class constructor.
+ */
+ startPolyline(latLng?: LatLng, options?: L.PolylineOptions): L.Polyline;
+
+ /**
+ * Start drawing a polygon. If latlng is given, a first point will be added. In any case, continuing on user
+ * click. If options is given, it will be passed to the polygon class constructor.
+ */
+ startPolygon(latLng?: LatLng, options?: L.PolylineOptions): L.Polygon;
+
+ /**
+ * Start adding a marker. If latlng is given, the marker will be shown first at this point. In any case, it
+ * will follow the user mouse, and will have a final latlng on next click (or touch). If options is given,
+ * it will be passed to the marker class constructor.
+ */
+ startMarker(latLng?: LatLng, options?: L.MarkerOptions): L.Marker;
+
+ /**
+ * When you need to stop any ongoing drawing, without needing to know which editor is active.
+ */
+ stopDrawing(): void;
+ }
+
+ export var Editable: EditableStatic;
+
+ /**
+ * EditableMixin is included to L.Polyline, L.Polygon and L.Marker. It adds the following methods to them.
+ *
+ * When editing is enabled, the editor is accessible on the instance with the editor property.
+ */
+ export interface EditableMixin {
+ /**
+ * Enable editing, by creating an editor if not existing, and then calling enable on it.
+ */
+ enableEdit(): any;
+
+ /**
+ * Disable editing, also remove the editor property reference.
+ */
+ disableEdit(): void;
+
+ /**
+ * Enable or disable editing, according to current status.
+ */
+ toggleEdit(): void;
+
+ /**
+ * Return true if current instance has an editor attached, and this editor is enabled.
+ */
+ editEnabled(): boolean;
+ }
+
+ export interface Map {
+ /**
+ * Whether to create a L.Editable instance at map init or not.
+ */
+ editable: boolean;
+
+ /**
+ * Options to pass to L.Editable when instanciating.
+ */
+ editOptions: EditOptions;
+
+ /**
+ * L.Editable plugin instance.
+ */
+ editTools: Editable;
+ }
+
+ export interface Polyline extends EditableMixin {
+ }
+
+ module Map {
+ export interface MapOptions {
+ /**
+ * Whether to create a L.Editable instance at map init or not.
+ */
+ editable?: boolean;
+
+ /**
+ * Options to pass to L.Editable when instanciating.
+ */
+ editOptions?: EditOptions;
+ }
+ }
+
+ /**
+ * When editing a feature (marker, polyline…), an editor is attached to it. This editor basically knows
+ * how to handle the edition.
+ */
+ export interface BaseEditor {
+ /**
+ * Set up the drawing tools for the feature to be editable.
+ */
+ enable(): MarkerEditor|PolylineEditor|PolygonEditor;
+
+ /**
+ * Remove editing tools.
+ */
+ disable(): MarkerEditor|PolylineEditor|PolygonEditor;
+ }
+
+ /**
+ * Inherit from L.Editable.BaseEditor.
+ * Inherited by L.Editable.PolylineEditor and L.Editable.PolygonEditor.
+ */
+ export interface PathEditor extends BaseEditor {
+ /**
+ * Rebuild edit elements (vertex, middlemarker, etc.).
+ */
+ reset(): void;
+ }
+
+ /**
+ * Inherit from L.Editable.PathEditor.
+ */
+ export interface PolylineEditor extends PathEditor {
+ /**
+ * Set up drawing tools to continue the line forward.
+ */
+ continueForward(): void;
+
+ /**
+ * Set up drawing tools to continue the line backward.
+ */
+ continueBackward(): void;
+ }
+
+ /**
+ * Inherit from L.Editable.PathEditor.
+ */
+ export interface PolygonEditor extends PathEditor {
+ /**
+ * Set up drawing tools for creating a new hole on the polygon. If the latlng param is given, a first
+ * point is created.
+ */
+ newHole(latlng: LatLng): void;
+ }
+
+ /**
+ * Inherit from L.Editable.BaseEditor.
+ */
+ export interface MarkerEditor extends BaseEditor {
+ }
+
+ export interface Marker extends EditableMixin, MarkerEditor {
+ }
+
+ export interface Polyline extends EditableMixin, PolylineEditor {
+ }
+
+ export interface Polygon extends EditableMixin, PolygonEditor {
+ }
+}
\ No newline at end of file
diff --git a/levelup/levelup.d.ts.tscparams b/levelup/levelup.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/levelup/levelup.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/libxmljs/libxmljs-tests.ts.tscparams b/libxmljs/libxmljs-tests.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/libxmljs/libxmljs-tests.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/libxmljs/libxmljs.d.ts.tscparams b/libxmljs/libxmljs.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/libxmljs/libxmljs.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/localForage/localForage-tests.ts b/localForage/localForage-tests.ts
index 59e429a76a..6f162e8c4b 100644
--- a/localForage/localForage-tests.ts
+++ b/localForage/localForage-tests.ts
@@ -52,4 +52,14 @@ declare var localForage: LocalForage;
localForage.removeItem("key").then(() => {
});
-}
+
+ var config = localForage.config({
+ name: "testyo",
+ driver: localForage.LOCALSTORAGE
+ });
+
+ var store = localForage.createInstance({
+ name: "da instance",
+ driver: localForage.LOCALSTORAGE
+ });
+}
\ No newline at end of file
diff --git a/localForage/localForage.d.ts b/localForage/localForage.d.ts
index d169d01e3f..cd12bb4f32 100644
--- a/localForage/localForage.d.ts
+++ b/localForage/localForage.d.ts
@@ -6,7 +6,7 @@
/// <reference path="../es6-promise/es6-promise.d.ts" />
interface LocalForageOptions {
- driver?: LocalForageDriver | LocalForageDriver[];
+ driver?: string | LocalForageDriver | LocalForageDriver[];
name?: string;
@@ -46,9 +46,19 @@ interface LocalForage {
WEBSQL: string;
INDEXEDDB: string;
- config(options: LocalForageOptions): void;
+ /**
+ * Set and persist localForage options. This must be called before any other calls to localForage are made, but can be called after localForage is loaded.
+ * If you set any config values with this method they will persist after driver changes, so you can call config() then setDriver()
+ * @param {ILocalForageConfig} options?
+ */
+ config(options: LocalForageOptions): boolean;
+ createInstance(options: LocalForageOptions): LocalForage;
driver(): LocalForageDriver;
+ /**
+ * Force usage of a particular driver or drivers, if available.
+ * @param {string} driver
+ */
setDriver(driver: string | string[]): Promise<void>;
setDriver(driver: string | string[], callback: () => void, errorCallback: (error: any) => void): void;
defineDriver(driver: LocalForageDriver): Promise<void>;
@@ -79,3 +89,8 @@ interface LocalForage {
iterate(iteratee: (value: any, key: string, iterationNumber: number) => any,
callback: (err: any, result: any) => void): void;
}
+
+declare module "localforage" {
+ var localforage: LocalForage;
+ export default localforage;
+}
\ No newline at end of file
diff --git a/lodash/lodash-tests.ts b/lodash/lodash-tests.ts
index db15ebc4ab..abe109c6e0 100644
--- a/lodash/lodash-tests.ts
+++ b/lodash/lodash-tests.ts
@@ -104,56 +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 = <string>_('test').toString();
-result = <string>_([1, 2, 3]).toString();
-result = <string>_({ 'key1': 'test1', 'key2': 'test2' }).toString();
-
-// _.value (aliases: _.run, _.toJSON, _.valueOf)
-result = <string>_('test').value();
-result = <number[]>_([1, 2, 3]).run();
-result = <_.Dictionary<string>>_(<{ [index: string]: string; }>{ 'key1': 'test1', 'key2': 'test2' }).toJSON();
-result = <_.Dictionary<number>>_({ a: 1, b: 2}).mapValues(function(num: number) { return num * 2; }).valueOf();
+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);
/*********
* Array *
@@ -163,51 +150,112 @@ result = <_.Dictionary<number>>_({ a: 1, b: 2}).mapValues(function(num: number)
module TestChunk {
let array: TResult[];
let list: _.List<TResult>;
- let result: TResult[][];
- result = _.chunk<TResult>(array);
- result = _.chunk<TResult>(array, 42);
- result = _.chunk<TResult>(list);
- result = _.chunk<TResult>(list, 42);
- result = _(array).chunk().value();
- result = _(array).chunk(42).value();
- result = _(list).chunk<TResult>().value();
- result = _(list).chunk<TResult>(42).value();
+
+ {
+ let result: TResult[][];
+
+ result = _.chunk<TResult>(array);
+ result = _.chunk<TResult>(array, 42);
+
+ result = _.chunk<TResult>(list);
+ result = _.chunk<TResult>(list, 42);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult[]>;
+
+ result = _(array).chunk();
+ result = _(array).chunk(42);
+
+ result = _(list).chunk<TResult>();
+ result = _(list).chunk<TResult>(42);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult[]>;
+
+ result = _(array).chain().chunk();
+ result = _(array).chain().chunk(42);
+
+ result = _(list).chain().chunk<TResult>();
+ result = _(list).chain().chunk<TResult>(42);
+ }
}
// _.compact
module TestCompact {
let array: TResult[];
let list: _.List<TResult>;
- let result: TResult[];
- result = _.compact<TResult>();
- result = _.compact<TResult>(array);
- result = _.compact<TResult>(list);
- result = _<TResult>(array).compact().value();
- result = _(list).compact<TResult>().value();
+ {
+ let result: TResult[];
+
+ result = _.compact<TResult>();
+ result = _.compact<TResult>(array);
+ result = _.compact<TResult>(list);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _<TResult>(array).compact();
+ result = _(list).compact<TResult>();
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _<TResult>(array).chain().compact();
+ result = _(list).chain().compact<TResult>();
+ }
}
// _.difference
-{
- let testDifferenceArray: TResult[];
- let testDifferenceList: _.List<TResult>;
- let result: TResult[];
- result = _.difference<TResult>(testDifferenceArray);
- result = _.difference<TResult>(testDifferenceArray, testDifferenceArray);
- result = _.difference<TResult>(testDifferenceArray, testDifferenceList, testDifferenceArray);
- result = _.difference<TResult>(testDifferenceArray, testDifferenceArray, testDifferenceList, testDifferenceArray);
- result = _.difference<TResult>(testDifferenceList);
- result = _.difference<TResult>(testDifferenceList, testDifferenceList);
- result = _.difference<TResult>(testDifferenceList, testDifferenceArray, testDifferenceList);
- result = _.difference<TResult>(testDifferenceList, testDifferenceList, testDifferenceArray, testDifferenceList);
- result = _(testDifferenceArray).difference().value();
- result = _(testDifferenceArray).difference(testDifferenceArray).value();
- result = _(testDifferenceArray).difference(testDifferenceList, testDifferenceArray).value();
- result = _(testDifferenceArray).difference(testDifferenceArray, testDifferenceList, testDifferenceArray).value();
- result = _(testDifferenceList).difference<TResult>().value();
- result = _(testDifferenceList).difference<TResult>(testDifferenceList).value();
- result = _(testDifferenceList).difference<TResult>(testDifferenceArray, testDifferenceList).value();
- result = _(testDifferenceList).difference<TResult>(testDifferenceList, testDifferenceArray, testDifferenceList).value();
+module TestDifference {
+ let array: TResult[];
+ let list: _.List<TResult>;
+
+ {
+ let result: TResult[];
+
+ result = _.difference<TResult>(array);
+ result = _.difference<TResult>(array, array);
+ result = _.difference<TResult>(array, list, array);
+ result = _.difference<TResult>(array, array, list, array);
+
+ result = _.difference<TResult>(list);
+ result = _.difference<TResult>(list, list);
+ result = _.difference<TResult>(list, array, list);
+ result = _.difference<TResult>(list, list, array, list);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).difference();
+ result = _(array).difference(array);
+ result = _(array).difference(list, array);
+ result = _(array).difference(array, list, array);
+
+ result = _(list).difference<TResult>();
+ result = _(list).difference<TResult>(list);
+ result = _(list).difference<TResult>(array, list);
+ result = _(list).difference<TResult>(list, array, list);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().difference();
+ result = _(array).chain().difference(array);
+ result = _(array).chain().difference(list, array);
+ result = _(array).chain().difference(array, list, array);
+
+ result = _(list).chain().difference<TResult>();
+ result = _(list).chain().difference<TResult>(list);
+ result = _(list).chain().difference<TResult>(array, list);
+ result = _(list).chain().difference<TResult>(list, array, list);
+ }
}
// _.drop
@@ -229,15 +277,73 @@ module TestCompact {
module TestDropRight {
let array: TResult[];
let list: _.List<TResult>;
+
+ {
+ let result: TResult[];
+
+ result = _.dropRight<TResult>(array);
+ result = _.dropRight<TResult>(array, 42);
+
+ result = _.dropRight<TResult>(list);
+ result = _.dropRight<TResult>(list, 42);
+
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).dropRight();
+ result = _(array).dropRight(42);
+
+ result = _(list).dropRight<TResult>();
+ result = _(list).dropRight<TResult>(42);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().dropRight();
+ result = _(array).chain().dropRight(42);
+
+ result = _(list).chain().dropRight<TResult>();
+ result = _(list).chain().dropRight<TResult>(42);
+ }
+}
+
+// _.dropRightWhile
+module TestDropRightWhile {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let predicateFn: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
let result: TResult[];
- result = _.dropRight<TResult>(array);
- result = _.dropRight<TResult>(array, 42);
- result = _.dropRight<TResult>(list);
- result = _.dropRight<TResult>(list, 42);
- result = _(array).dropRight().value();
- result = _(array).dropRight(42).value();
- result = _(list).dropRight<TResult>().value();
- result = _(list).dropRight<TResult>(42).value();
+
+ result = _.dropRightWhile<TResult>(array);
+ result = _.dropRightWhile<TResult>(array, predicateFn);
+ result = _.dropRightWhile<TResult>(array, predicateFn, any);
+ result = _.dropRightWhile<TResult>(array, '');
+ result = _.dropRightWhile<TResult>(array, '', any);
+ result = _.dropRightWhile<{a: number;}, TResult>(array, {a: 42});
+
+ result = _.dropRightWhile<TResult>(list);
+ result = _.dropRightWhile<TResult>(list, predicateFn);
+ result = _.dropRightWhile<TResult>(list, predicateFn, any);
+ result = _.dropRightWhile<TResult>(list, '');
+ result = _.dropRightWhile<TResult>(list, '', any);
+ result = _.dropRightWhile<{a: number;}, TResult>(list, {a: 42});
+
+ result = _(array).dropRightWhile().value();
+ result = _(array).dropRightWhile(predicateFn).value();
+ result = _(array).dropRightWhile(predicateFn, any).value();
+ result = _(array).dropRightWhile('').value();
+ result = _(array).dropRightWhile('', any).value();
+ result = _(array).dropRightWhile<{a: number;}>({a: 42}).value();
+
+ result = _(list).dropRightWhile<TResult>().value();
+ result = _(list).dropRightWhile<TResult>(predicateFn).value();
+ result = _(list).dropRightWhile<TResult>(predicateFn, any).value();
+ result = _(list).dropRightWhile<TResult>('').value();
+ result = _(list).dropRightWhile<TResult>('', any).value();
+ result = _(list).dropRightWhile<{a: number;}, TResult>({a: 42}).value();
}
// _.dropWhile
@@ -245,49 +351,62 @@ module TestDropWhile {
let array: TResult[];
let list: _.List<TResult>;
let predicateFn: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
- let result: TResult[];
- result = _.dropWhile<TResult>(array);
- result = _.dropWhile<TResult>(array, predicateFn);
- result = _.dropWhile<TResult>(array, predicateFn, any);
- result = _.dropWhile<TResult>(array, '')
- result = _.dropWhile<TResult>(array, '', any);
- result = _.dropWhile<{a: number;}, TResult>(array, {a: 42});
+ {
+ let result: TResult[];
- result = _.dropWhile<TResult>(list);
- result = _.dropWhile<TResult>(list, predicateFn);
- result = _.dropWhile<TResult>(list, predicateFn, any);
- result = _.dropWhile<TResult>(list, '')
- result = _.dropWhile<TResult>(list, '', any);
- result = _.dropWhile<{a: number;}, TResult>(list, {a: 42});
+ result = _.dropWhile<TResult>(array);
+ result = _.dropWhile<TResult>(array, predicateFn);
+ result = _.dropWhile<TResult>(array, predicateFn, any);
+ result = _.dropWhile<TResult>(array, '');
+ result = _.dropWhile<TResult>(array, '', any);
+ result = _.dropWhile<{a: number;}, TResult>(array, {a: 42});
- result = _(array).dropWhile().value();
- result = _(array).dropWhile(predicateFn).value();
- result = _(array).dropWhile(predicateFn, any).value();
- result = _(array).dropWhile('').value();
- result = _(array).dropWhile('', any).value();
- result = _(array).dropWhile<{a: number;}>({a: 42}).value();
+ result = _.dropWhile<TResult>(list);
+ result = _.dropWhile<TResult>(list, predicateFn);
+ result = _.dropWhile<TResult>(list, predicateFn, any);
+ result = _.dropWhile<TResult>(list, '');
+ result = _.dropWhile<TResult>(list, '', any);
+ result = _.dropWhile<{a: number;}, TResult>(list, {a: 42});
+ }
- result = _(list).dropWhile<TResult>().value();
- result = _(list).dropWhile<TResult>(predicateFn).value();
- result = _(list).dropWhile<TResult>(predicateFn, any).value();
- result = _(list).dropWhile<TResult>('').value();
- result = _(list).dropWhile<TResult>('', any).value();
- result = _(list).dropWhile<{a: number;}, TResult>({a: 42}).value();
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).dropWhile();
+ result = _(array).dropWhile(predicateFn);
+ result = _(array).dropWhile(predicateFn, any);
+ result = _(array).dropWhile('');
+ result = _(array).dropWhile('', any);
+ result = _(array).dropWhile<{a: number;}>({a: 42});
+
+ result = _(list).dropWhile<TResult>();
+ result = _(list).dropWhile<TResult>(predicateFn);
+ result = _(list).dropWhile<TResult>(predicateFn, any);
+ result = _(list).dropWhile<TResult>('');
+ result = _(list).dropWhile<TResult>('', any);
+ result = _(list).dropWhile<{a: number;}, TResult>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().dropWhile();
+ result = _(array).chain().dropWhile(predicateFn);
+ result = _(array).chain().dropWhile(predicateFn, any);
+ result = _(array).chain().dropWhile('');
+ result = _(array).chain().dropWhile('', any);
+ result = _(array).chain().dropWhile<{a: number;}>({a: 42});
+
+ result = _(list).chain().dropWhile<TResult>();
+ result = _(list).chain().dropWhile<TResult>(predicateFn);
+ result = _(list).chain().dropWhile<TResult>(predicateFn, any);
+ result = _(list).chain().dropWhile<TResult>('');
+ result = _(list).chain().dropWhile<TResult>('', any);
+ result = _(list).chain().dropWhile<{a: number;}, TResult>({a: 42});
+ }
}
-result = <number[]>_.rest([1, 2, 3]);
-result = <number[]>_.rest([1, 2, 3], 2);
-result = <number[]>_.rest([1, 2, 3], (num) => num < 3)
-result = <IFoodOrganic[]>_.rest(foodsOrganic, 'test');
-result = <IFoodType[]>_.rest(foodsType, { 'type': 'value' });
-
-result = <number[]>_.tail([1, 2, 3])
-result = <number[]>_.tail([1, 2, 3], 2)
-result = <number[]>_.tail([1, 2, 3], (num) => num < 3)
-result = <IFoodOrganic[]>_.tail(foodsOrganic, 'test')
-result = <IFoodType[]> _.tail(foodsType, { 'type': 'value' })
-
// _.fill
var testFillArray = [1, 2, 3];
var testFillList: _.List<number> = {0: 1, 1: 2, 2: 3, length: 3};
@@ -302,35 +421,56 @@ module TestFindIndex {
let array: TResult[];
let list: _.List<TResult>;
let predicateFn: (value: TResult, index?: number, collection?: _.List<TResult>) => boolean;
- let result: number;
- result = _.findIndex<TResult>(array);
- result = _.findIndex<TResult>(array, predicateFn);
- result = _.findIndex<TResult>(array, predicateFn, any);
- result = _.findIndex<TResult>(array, '');
- result = _.findIndex<TResult>(array, '', any);
- result = _.findIndex<{a: number}, TResult>(array, {a: 42});
+ {
+ let result: number;
- result = _.findIndex<TResult>(list);
- result = _.findIndex<TResult>(list, predicateFn);
- result = _.findIndex<TResult>(list, predicateFn, any);
- result = _.findIndex<TResult>(list, '');
- result = _.findIndex<TResult>(list, '', any);
- result = _.findIndex<{a: number}, TResult>(list, {a: 42});
+ result = _.findIndex<TResult>(array);
+ result = _.findIndex<TResult>(array, predicateFn);
+ result = _.findIndex<TResult>(array, predicateFn, any);
+ result = _.findIndex<TResult>(array, '');
+ result = _.findIndex<TResult>(array, '', any);
+ result = _.findIndex<{a: number}, TResult>(array, {a: 42});
- result = _<TResult>(array).findIndex();
- result = _<TResult>(array).findIndex(predicateFn);
- result = _<TResult>(array).findIndex(predicateFn, any);
- result = _<TResult>(array).findIndex('');
- result = _<TResult>(array).findIndex('', any);
- result = _<TResult>(array).findIndex<{a: number}>({a: 42});
+ result = _.findIndex<TResult>(list);
+ result = _.findIndex<TResult>(list, predicateFn);
+ result = _.findIndex<TResult>(list, predicateFn, any);
+ result = _.findIndex<TResult>(list, '');
+ result = _.findIndex<TResult>(list, '', any);
+ result = _.findIndex<{a: number}, TResult>(list, {a: 42});
- result = _(list).findIndex();
- result = _(list).findIndex<TResult>(predicateFn);
- result = _(list).findIndex<TResult>(predicateFn, any);
- result = _(list).findIndex('');
- result = _(list).findIndex('', any);
- result = _(list).findIndex<{a: number}>({a: 42});
+ result = _<TResult>(array).findIndex();
+ result = _<TResult>(array).findIndex(predicateFn);
+ result = _<TResult>(array).findIndex(predicateFn, any);
+ result = _<TResult>(array).findIndex('');
+ result = _<TResult>(array).findIndex('', any);
+ result = _<TResult>(array).findIndex<{a: number}>({a: 42});
+
+ result = _(list).findIndex();
+ result = _(list).findIndex<TResult>(predicateFn);
+ result = _(list).findIndex<TResult>(predicateFn, any);
+ result = _(list).findIndex('');
+ result = _(list).findIndex('', any);
+ result = _(list).findIndex<{a: number}>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _<TResult>(array).chain().findIndex();
+ result = _<TResult>(array).chain().findIndex(predicateFn);
+ result = _<TResult>(array).chain().findIndex(predicateFn, any);
+ result = _<TResult>(array).chain().findIndex('');
+ result = _<TResult>(array).chain().findIndex('', any);
+ result = _<TResult>(array).chain().findIndex<{a: number}>({a: 42});
+
+ result = _(list).chain().findIndex();
+ result = _(list).chain().findIndex<TResult>(predicateFn);
+ result = _(list).chain().findIndex<TResult>(predicateFn, any);
+ result = _(list).chain().findIndex('');
+ result = _(list).chain().findIndex('', any);
+ result = _(list).chain().findIndex<{a: number}>({a: 42});
+ }
}
// _.findLastIndex
@@ -388,14 +528,40 @@ 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 = <Array<number>>_.flattenDeep<number>([[[[1]]]]);
+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], 5, 6]).flatten();
-result = <_.LoDashArrayWrapper<number|Array<Array<number>>>>_([1, [2], [3, [[4]]]]).flatten();
+result = <_.LoDashImplicitArrayWrapper<number>>_([1, [2], [3, [[4]]]]).flatten(true);
-result = <_.LoDashArrayWrapper<number>>_([1, [2], [3, [[4]]]]).flatten(true);
+// _.flattenDeep
+module TestFlattenDeep {
+ interface RecursiveArray<T> extends Array<T|RecursiveArray<T>> {}
+ interface ListOfRecursiveArraysOrValues<T> extends _.List<T|RecursiveArray<T>> {}
+ interface RecursiveList<T> extends _.List<T|RecursiveList<T>> { }
-result = <_.LoDashArrayWrapper<number>>_([1, [2], [3, [[4]]]]).flattenDeep();
+ let recursiveArray: RecursiveArray<TResult>;
+ let listOfMaybeRecursiveArraysOrValues: ListOfRecursiveArraysOrValues<TResult>;
+ let recursiveList: RecursiveList<TResult>;
+
+ {
+ let result: TResult[];
+
+ result = _.flattenDeep<TResult>(recursiveArray);
+ result = _.flattenDeep<TResult>(listOfMaybeRecursiveArraysOrValues);
+
+ result = _(recursiveArray).flattenDeep<TResult>().value();
+
+ result = _(listOfMaybeRecursiveArraysOrValues).flattenDeep<TResult>().value();
+ }
+
+ {
+ let result: any;
+
+ result = _.flattenDeep<TResult>(recursiveList);
+
+ result = _(recursiveList).flattenDeep().value();
+ }
+}
// _.head
module TestHead {
@@ -413,19 +579,38 @@ module TestIndexOf {
let array: TResult[];
let list: _.List<TResult>;
let value: TResult;
- let result: number;
- result = _.indexOf<TResult>(array, value);
- result = _.indexOf<TResult>(array, value, true);
- result = _.indexOf<TResult>(array, value, 42);
- result = _.indexOf<TResult>(list, value);
- result = _.indexOf<TResult>(list, value, true);
- result = _.indexOf<TResult>(list, value, 42);
- result = _(array).indexOf(value);
- result = _(array).indexOf(value, true);
- result = _(array).indexOf(value, 42);
- result = _(list).indexOf<TResult>(value);
- result = _(list).indexOf<TResult>(value, true);
- result = _(list).indexOf<TResult>(value, 42);
+
+ {
+ let result: number;
+
+ result = _.indexOf<TResult>(array, value);
+ result = _.indexOf<TResult>(array, value, true);
+ result = _.indexOf<TResult>(array, value, 42);
+
+ result = _.indexOf<TResult>(list, value);
+ result = _.indexOf<TResult>(list, value, true);
+ result = _.indexOf<TResult>(list, value, 42);
+
+ result = _(array).indexOf(value);
+ result = _(array).indexOf(value, true);
+ result = _(array).indexOf(value, 42);
+
+ result = _(list).indexOf<TResult>(value);
+ result = _(list).indexOf<TResult>(value, true);
+ result = _(list).indexOf<TResult>(value, 42);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(array).chain().indexOf(value);
+ result = _(array).chain().indexOf(value, true);
+ result = _(array).chain().indexOf(value, 42);
+
+ result = _(list).chain().indexOf<TResult>(value);
+ result = _(list).chain().indexOf<TResult>(value, true);
+ result = _(list).chain().indexOf<TResult>(value, 42);
+ }
}
//_.initial
@@ -440,16 +625,36 @@ module TestIndexOf {
}
// _.intersection
-{
- let testIntersectionArray: TResult[];
- let testIntersectionList: _.List<TResult>;
- let result: TResult[];
- result = _.intersection<TResult>(testIntersectionArray, testIntersectionList);
- result = _.intersection<TResult>(testIntersectionList, testIntersectionArray, testIntersectionList);
- result = _(testIntersectionArray).intersection<TResult>(testIntersectionArray).value();
- result = _(testIntersectionArray).intersection<TResult>(testIntersectionList, testIntersectionArray).value();
- result = _(testIntersectionList).intersection<TResult>(testIntersectionArray).value();
- result = _(testIntersectionList).intersection<TResult>(testIntersectionList, testIntersectionArray).value();
+module TestIntersection {
+ let array: TResult[];
+ let list: _.List<TResult>;
+
+ {
+ let result: TResult[];
+
+ result = _.intersection<TResult>(array, list);
+ result = _.intersection<TResult>(list, array, list);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).intersection<TResult>(array);
+ result = _(array).intersection<TResult>(list, array);
+
+ result = _(list).intersection<TResult>(array);
+ result = _(list).intersection<TResult>(list, array);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().intersection<TResult>(array);
+ result = _(array).chain().intersection<TResult>(list, array);
+
+ result = _(list).chain().intersection<TResult>(array);
+ result = _(list).chain().intersection<TResult>(list, array);
+ }
}
// _.last
@@ -469,51 +674,162 @@ module TestLastIndexOf {
let array: TResult[];
let list: _.List<TResult>;
let value: TResult;
- let result: number;
- result = _.lastIndexOf<TResult>(array, value);
- result = _.lastIndexOf<TResult>(array, value, true);
- result = _.lastIndexOf<TResult>(array, value, 42);
+ {
+ let result: number;
- result = _.lastIndexOf<TResult>(list, value);
- result = _.lastIndexOf<TResult>(list, value, true);
- result = _.lastIndexOf<TResult>(list, value, 42);
+ result = _.lastIndexOf<TResult>(array, value);
+ result = _.lastIndexOf<TResult>(array, value, true);
+ result = _.lastIndexOf<TResult>(array, value, 42);
- result = _(array).lastIndexOf(value);
- result = _(array).lastIndexOf(value, true);
- result = _(array).lastIndexOf(value, 42);
+ result = _.lastIndexOf<TResult>(list, value);
+ result = _.lastIndexOf<TResult>(list, value, true);
+ result = _.lastIndexOf<TResult>(list, value, 42);
- result = _(list).lastIndexOf<TResult>(value);
- result = _(list).lastIndexOf<TResult>(value, true);
- result = _(list).lastIndexOf<TResult>(value, 42);
+ result = _(array).lastIndexOf(value);
+ result = _(array).lastIndexOf(value, true);
+ result = _(array).lastIndexOf(value, 42);
+
+ result = _(list).lastIndexOf<TResult>(value);
+ result = _(list).lastIndexOf<TResult>(value, true);
+ result = _(list).lastIndexOf<TResult>(value, 42);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(array).chain().lastIndexOf(value);
+ result = _(array).chain().lastIndexOf(value, true);
+ result = _(array).chain().lastIndexOf(value, 42);
+
+ result = _(list).chain().lastIndexOf<TResult>(value);
+ result = _(list).chain().lastIndexOf<TResult>(value, true);
+ result = _(list).chain().lastIndexOf<TResult>(value, 42);
+ }
+}
+
+// _.object
+module TestObject {
+ let arrayOfKeys: string[];
+ let arrayOfValues: number[];
+
+ let listOfKeys: _.List<string>;
+ let listOfValues: _.List<number>;
+
+ {
+ let result: _.Dictionary<void>;
+
+ result = _.object<_.Dictionary<void>>(arrayOfKeys);
+ result = _.object<_.Dictionary<void>>(listOfKeys);
+
+ result = _(arrayOfKeys).object<_.Dictionary<void>>().value();
+ result = _(listOfKeys).object<_.Dictionary<void>>().value();
+ }
+
+ {
+ let result: _.Dictionary<number>;
+
+ result = _.object<_.Dictionary<number>>(arrayOfKeys, arrayOfValues);
+ result = _.object<_.Dictionary<number>>(arrayOfKeys, listOfValues);
+ result = _.object<_.Dictionary<number>>(listOfKeys, listOfValues);
+ result = _.object<_.Dictionary<number>>(listOfKeys, arrayOfValues);
+
+ result = _.object<number, _.Dictionary<number>>(arrayOfKeys, arrayOfValues);
+ result = _.object<number, _.Dictionary<number>>(arrayOfKeys, listOfValues);
+ result = _.object<number, _.Dictionary<number>>(listOfKeys, listOfValues);
+ result = _.object<number, _.Dictionary<number>>(listOfKeys, arrayOfValues);
+
+ result = _(arrayOfKeys).object<_.Dictionary<number>>(arrayOfValues).value();
+ result = _(arrayOfKeys).object<_.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).object<_.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).object<_.Dictionary<number>>(arrayOfValues).value();
+
+ result = _(arrayOfKeys).object<number, _.Dictionary<number>>(arrayOfValues).value();
+ result = _(arrayOfKeys).object<number, _.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).object<number, _.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).object<number, _.Dictionary<number>>(arrayOfValues).value();
+ }
+
+ {
+ let result: _.Dictionary<any>;
+
+ result = _.object(arrayOfKeys);
+ result = _.object(arrayOfKeys, arrayOfValues);
+ result = _.object(arrayOfKeys, listOfValues);
+
+ result = _.object(listOfKeys);
+ result = _.object(listOfKeys, listOfValues);
+ result = _.object(listOfKeys, arrayOfValues);
+
+ result = _(arrayOfKeys).object().value();
+ result = _(arrayOfKeys).object(arrayOfValues).value();
+ result = _(arrayOfKeys).object(listOfValues).value();
+
+ result = _(listOfKeys).object().value();
+ result = _(listOfKeys).object(listOfValues).value();
+ result = _(listOfKeys).object(arrayOfValues).value();
+ }
}
// _.pull
-{
- let testPullArray: TResult[];
- let testPullValue: TResult;
- let result: TResult[];
- result = _.pull<TResult>(testPullArray);
- result = _.pull<TResult>(testPullArray, testPullValue);
- result = _.pull<TResult>(testPullArray, testPullValue, testPullValue);
- result = _.pull<TResult>(testPullArray, testPullValue, testPullValue, testPullValue);
- result = _(testPullArray).pull().value();
- result = _(testPullArray).pull(testPullValue).value();
- result = _(testPullArray).pull(testPullValue, testPullValue).value();
- result = _(testPullArray).pull(testPullValue, testPullValue, testPullValue).value();
-}
-{
- let testPullList: _.List<TResult>;
- let testPullValue: TResult;
- let result: _.List<TResult>;
- result = _.pull<TResult>(testPullList);
- result = _.pull<TResult>(testPullList, testPullValue);
- result = _.pull<TResult>(testPullList, testPullValue, testPullValue);
- result = _.pull<TResult>(testPullList, testPullValue, testPullValue, testPullValue);
- result = _(testPullList).pull<TResult>().value();
- result = _(testPullList).pull<TResult>(testPullValue).value();
- result = _(testPullList).pull<TResult>(testPullValue, testPullValue).value();
- result = _(testPullList).pull<TResult>(testPullValue, testPullValue, testPullValue).value();
+module TestPull {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let value: TResult;
+
+ {
+ let result: TResult[];
+
+ result = _.pull<TResult>(array);
+ result = _.pull<TResult>(array, value);
+ result = _.pull<TResult>(array, value, value);
+ result = _.pull<TResult>(array, value, value, value);
+ }
+
+ {
+ let result: _.List<TResult>;
+
+ result = _.pull<TResult>(list);
+ result = _.pull<TResult>(list, value);
+ result = _.pull<TResult>(list, value, value);
+ result = _.pull<TResult>(list, value, value, value);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).pull();
+ result = _(array).pull(value);
+ result = _(array).pull(value, value);
+ result = _(array).pull(value, value, value);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<_.List<TResult>>;
+
+ result = _(list).pull<TResult>();
+ result = _(list).pull<TResult>(value);
+ result = _(list).pull<TResult>(value, value);
+ result = _(list).pull<TResult>(value, value, value);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().pull();
+ result = _(array).chain().pull(value);
+ result = _(array).chain().pull(value, value);
+ result = _(array).chain().pull(value, value, value);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<_.List<TResult>>;
+
+ result = _(list).chain().pull<TResult>();
+ result = _(list).chain().pull<TResult>(value);
+ result = _(list).chain().pull<TResult>(value, value);
+ result = _(list).chain().pull<TResult>(value, value, value);
+ }
}
// _.pullAt
@@ -539,88 +855,184 @@ module TestLastIndexOf {
result = _(testPullAtList).pullAt<TResult>(4, [2, 3], 1).value();
}
-result = <_.Dictionary<any>>_.zipObject(['moe', 'larry'], [30, 40]);
-result = <_.LoDashObjectWrapper<_.Dictionary<any>>>_(['moe', 'larry']).zipObject([30, 40]);
-result = <_.Dictionary<any>>_.object(['moe', 'larry'], [30, 40]);
-result = <_.LoDashObjectWrapper<_.Dictionary<any>>>_(['moe', 'larry']).object([30, 40]);
-result = <_.Dictionary<any>>_.zipObject([['moe', 30], ['larry', 40]]);
-result = <_.LoDashObjectWrapper<_.Dictionary<any>>>_([['moe', 30], ['larry', 40]]).zipObject();
-result = <_.Dictionary<any>>_.object([['moe', 30], ['larry', 40]]);
-result = <_.LoDashObjectWrapper<_.Dictionary<any>>>_([['moe', 30], ['larry', 40]]).object();
-
// _.remove
module TestRemove {
let array: TResult[];
let list: _.List<TResult>;
let predicateFn: (value: TResult, index?: number, collection?: _.List<TResult>) => boolean;
+
+ {
+ let result: TResult[];
+
+ result = _.remove<TResult>(array);
+ result = _.remove<TResult>(array, predicateFn);
+ result = _.remove<TResult>(array, predicateFn, any);
+ result = _.remove<TResult>(array, '');
+ result = _.remove<TResult>(array, '', any);
+ result = _.remove<{a: number}, TResult>(array, {a: 42});
+
+ result = _.remove<TResult>(list);
+ result = _.remove<TResult>(list, predicateFn);
+ result = _.remove<TResult>(list, predicateFn, any);
+ result = _.remove<TResult>(list, '');
+ result = _.remove<TResult>(list, '', any);
+ result = _.remove<{a: number}, TResult>(list, {a: 42});
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _<TResult>(array).remove();
+ result = _<TResult>(array).remove(predicateFn);
+ result = _<TResult>(array).remove(predicateFn, any);
+ result = _<TResult>(array).remove('');
+ result = _<TResult>(array).remove('', any);
+ result = _<TResult>(array).remove<{a: number}>({a: 42});
+
+ result = _(list).remove<TResult>();
+ result = _(list).remove<TResult>(predicateFn);
+ result = _(list).remove<TResult>(predicateFn, any);
+ result = _(list).remove<TResult>('');
+ result = _(list).remove<TResult>('', any);
+ result = _(list).remove<{a: number}, TResult>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _<TResult>(array).chain().remove();
+ result = _<TResult>(array).chain().remove(predicateFn);
+ result = _<TResult>(array).chain().remove(predicateFn, any);
+ result = _<TResult>(array).chain().remove('');
+ result = _<TResult>(array).chain().remove('', any);
+ result = _<TResult>(array).chain().remove<{a: number}>({a: 42});
+
+ result = _(list).chain().remove<TResult>();
+ result = _(list).chain().remove<TResult>(predicateFn);
+ result = _(list).chain().remove<TResult>(predicateFn, any);
+ result = _(list).chain().remove<TResult>('');
+ result = _(list).chain().remove<TResult>('', any);
+ result = _(list).chain().remove<{a: number}, TResult>({a: 42});
+ }
+}
+
+// _.rest
+module TestRest {
+ let array: TResult[];
+ let list: _.List<TResult>;
let result: TResult[];
- result = _.remove<TResult>(array);
- result = _.remove<TResult>(array, predicateFn);
- result = _.remove<TResult>(array, predicateFn, any);
- result = _.remove<TResult>(array, '');
- result = _.remove<TResult>(array, '', any);
- result = _.remove<{a: number}, TResult>(array, {a: 42});
-
- result = _.remove<TResult>(list);
- result = _.remove<TResult>(list, predicateFn);
- result = _.remove<TResult>(list, predicateFn, any);
- result = _.remove<TResult>(list, '');
- result = _.remove<TResult>(list, '', any);
- result = _.remove<{a: number}, TResult>(list, {a: 42});
-
- result = _<TResult>(array).remove().value();
- result = _<TResult>(array).remove(predicateFn).value();
- result = _<TResult>(array).remove(predicateFn, any).value();
- result = _<TResult>(array).remove('').value();
- result = _<TResult>(array).remove('', any).value();
- result = _<TResult>(array).remove<{a: number}>({a: 42}).value();
-
- result = _(list).remove<TResult>().value();
- result = _(list).remove<TResult>(predicateFn).value();
- result = _(list).remove<TResult>(predicateFn, any).value();
- result = _(list).remove<TResult>('').value();
- result = _(list).remove<TResult>('', any).value();
- result = _(list).remove<{a: number}, TResult>({a: 42}).value();
+ result = _.rest<TResult>(array);
+ result = _.rest<TResult>(list);
+ result = _(array).rest().value();
+ result = _(list).rest<TResult>().value();
}
// _.slice
-{
- let testSliceArray: TResult[];
- let result: TResult[];
- result = _.slice(testSliceArray);
- result = _.slice(testSliceArray, 42);
- result = _.slice(testSliceArray, 42, 42);
- result = _(testSliceArray).slice().value();
- result = _(testSliceArray).slice(42).value();
- result = _(testSliceArray).slice(42, 42).value();
+module TestSlice {
+ let array: TResult[];
+
+ {
+ let result: TResult[];
+
+ result = _.slice(array);
+ result = _.slice(array, 42);
+ result = _.slice(array, 42, 42);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).slice();
+ result = _(array).slice(42);
+ result = _(array).slice(42, 42);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().slice();
+ result = _(array).chain().slice(42);
+ result = _(array).chain().slice(42, 42);
+ }
}
-result = <number>_.sortedIndex([20, 30, 50], 40);
-result = <number>_.sortedIndex([{ 'x': 20 }, { 'x': 30 }, { 'x': 50 }], { 'x': 40 }, 'x');
-var sortedIndexDict: { wordToNumber: { [idx: string]: number } } = {
- 'wordToNumber': { 'twenty': 20, 'thirty': 30, 'fourty': 40, 'fifty': 50 }
-};
-result = <number>_.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function (word: string) {
- return sortedIndexDict.wordToNumber[word];
-});
-result = <number>_.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function (word: string) {
- return this.wordToNumber[word];
-}, sortedIndexDict);
+// _.sortedIndex
+module TestSortedIndex {
+ result = <number>_.sortedIndex([20, 30, 50], 40);
+ result = <number>_.sortedIndex([{ 'x': 20 }, { 'x': 30 }, { 'x': 50 }], { 'x': 40 }, 'x');
+ var sortedIndexDict: { wordToNumber: { [idx: string]: number } } = {
+ 'wordToNumber': { 'twenty': 20, 'thirty': 30, 'fourty': 40, 'fifty': 50 }
+ };
+ result = <number>_.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function (word: string) {
+ return sortedIndexDict.wordToNumber[word];
+ });
+ result = <number>_.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function (word: string) {
+ return this.wordToNumber[word];
+ }, sortedIndexDict);
+}
+
+// _.sortedLastIndex
+module TestSortedLastIndex {
+ result = <number>_.sortedLastIndex([20, 30, 50], 40);
+ result = <number>_.sortedLastIndex([{ 'x': 20 }, { 'x': 30 }, { 'x': 50 }], { 'x': 40 }, 'x');
+ var sortedLastIndexDict: { wordToNumber: { [idx: string]: number } } = {
+ 'wordToNumber': { 'twenty': 20, 'thirty': 30, 'fourty': 40, 'fifty': 50 }
+ };
+ result = <number>_.sortedLastIndex(['twenty', 'thirty', 'fifty'], 'fourty', function (word: string) {
+ return sortedLastIndexDict.wordToNumber[word];
+ });
+ result = <number>_.sortedLastIndex(['twenty', 'thirty', 'fifty'], 'fourty', function (word: string) {
+ return this.wordToNumber[word];
+ }, sortedLastIndexDict);
+}
+
+// _.tail
+module TestTail {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let result: TResult[];
+
+ result = _.tail<TResult>(array);
+ result = _.tail<TResult>(list);
+ result = _(array).tail().value();
+ result = _(list).tail<TResult>().value();
+}
// _.take
module TestTake {
let array: TResult[];
let list: _.List<TResult>;
- let result: TResult[];
- result = _.take<TResult>(array);
- result = _.take<TResult>(array, 42);
- result = _.take<TResult>(list);
- result = _.take<TResult>(list, 42);
- result = _(array).take().value();
- result = _(array).take(42).value();
- result = _(list).take<TResult>().value();
- result = _(list).take<TResult>(42).value();
+
+ {
+ let result: TResult[];
+
+ result = _.take<TResult>(array);
+ result = _.take<TResult>(array, 42);
+
+ result = _.take<TResult>(list);
+ result = _.take<TResult>(list, 42);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).take();
+ result = _(array).take(42);
+
+ result = _(list).take<TResult>();
+ result = _(list).take<TResult>(42);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().take();
+ result = _(array).chain().take(42);
+
+ result = _(list).chain().take<TResult>();
+ result = _(list).chain().take<TResult>(42);
+ }
}
// _.takeRight
@@ -643,35 +1055,60 @@ module TestTakeRightWhile {
let array: TResult[];
let list: _.List<TResult>;
let predicateFn: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
- let result: TResult[];
- result = _.takeRightWhile<TResult>(array);
- result = _.takeRightWhile<TResult>(array, predicateFn);
- result = _.takeRightWhile<TResult>(array, predicateFn, any);
- result = _.takeRightWhile<TResult>(array, '')
- result = _.takeRightWhile<TResult>(array, '', any);
- result = _.takeRightWhile<{a: number;}, TResult>(array, {a: 42});
+ {
+ let result: TResult[];
- result = _.takeRightWhile<TResult>(list);
- result = _.takeRightWhile<TResult>(list, predicateFn);
- result = _.takeRightWhile<TResult>(list, predicateFn, any);
- result = _.takeRightWhile<TResult>(list, '')
- result = _.takeRightWhile<TResult>(list, '', any);
- result = _.takeRightWhile<{a: number;}, TResult>(list, {a: 42});
+ result = _.takeRightWhile<TResult>(array);
+ result = _.takeRightWhile<TResult>(array, predicateFn);
+ result = _.takeRightWhile<TResult>(array, predicateFn, any);
+ result = _.takeRightWhile<TResult>(array, '');
+ result = _.takeRightWhile<TResult>(array, '', any);
+ result = _.takeRightWhile<{a: number;}, TResult>(array, {a: 42});
- result = _(array).takeRightWhile().value();
- result = _(array).takeRightWhile(predicateFn).value();
- result = _(array).takeRightWhile(predicateFn, any).value();
- result = _(array).takeRightWhile('').value();
- result = _(array).takeRightWhile('', any).value();
- result = _(array).takeRightWhile<{a: number;}>({a: 42}).value();
+ result = _.takeRightWhile<TResult>(list);
+ result = _.takeRightWhile<TResult>(list, predicateFn);
+ result = _.takeRightWhile<TResult>(list, predicateFn, any);
+ result = _.takeRightWhile<TResult>(list, '');
+ result = _.takeRightWhile<TResult>(list, '', any);
+ result = _.takeRightWhile<{a: number;}, TResult>(list, {a: 42});
+ }
- result = _(list).takeRightWhile<TResult>().value();
- result = _(list).takeRightWhile<TResult>(predicateFn).value();
- result = _(list).takeRightWhile<TResult>(predicateFn, any).value();
- result = _(list).takeRightWhile<TResult>('').value();
- result = _(list).takeRightWhile<TResult>('', any).value();
- result = _(list).takeRightWhile<{a: number;}, TResult>({a: 42}).value();
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).takeRightWhile();
+ result = _(array).takeRightWhile(predicateFn);
+ result = _(array).takeRightWhile(predicateFn, any);
+ result = _(array).takeRightWhile('');
+ result = _(array).takeRightWhile('', any);
+ result = _(array).takeRightWhile<{a: number;}>({a: 42});
+
+ result = _(list).takeRightWhile<TResult>();
+ result = _(list).takeRightWhile<TResult>(predicateFn);
+ result = _(list).takeRightWhile<TResult>(predicateFn, any);
+ result = _(list).takeRightWhile<TResult>('');
+ result = _(list).takeRightWhile<TResult>('', any);
+ result = _(list).takeRightWhile<{a: number;}, TResult>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().takeRightWhile();
+ result = _(array).chain().takeRightWhile(predicateFn);
+ result = _(array).chain().takeRightWhile(predicateFn, any);
+ result = _(array).chain().takeRightWhile('');
+ result = _(array).chain().takeRightWhile('', any);
+ result = _(array).chain().takeRightWhile<{a: number;}>({a: 42});
+
+ result = _(list).chain().takeRightWhile<TResult>();
+ result = _(list).chain().takeRightWhile<TResult>(predicateFn);
+ result = _(list).chain().takeRightWhile<TResult>(predicateFn, any);
+ result = _(list).chain().takeRightWhile<TResult>('');
+ result = _(list).chain().takeRightWhile<TResult>('', any);
+ result = _(list).chain().takeRightWhile<{a: number;}, TResult>({a: 42});
+ }
}
// _.takeWhile
@@ -684,14 +1121,14 @@ module TestTakeWhile {
result = _.takeWhile<TResult>(array);
result = _.takeWhile<TResult>(array, predicateFn);
result = _.takeWhile<TResult>(array, predicateFn, any);
- result = _.takeWhile<TResult>(array, '')
+ result = _.takeWhile<TResult>(array, '');
result = _.takeWhile<TResult>(array, '', any);
result = _.takeWhile<{a: number;}, TResult>(array, {a: 42});
result = _.takeWhile<TResult>(list);
result = _.takeWhile<TResult>(list, predicateFn);
result = _.takeWhile<TResult>(list, predicateFn, any);
- result = _.takeWhile<TResult>(list, '')
+ result = _.takeWhile<TResult>(list, '');
result = _.takeWhile<TResult>(list, '', any);
result = _.takeWhile<{a: number;}, TResult>(list, {a: 42});
@@ -710,9 +1147,57 @@ module TestTakeWhile {
result = _(list).takeWhile<{a: number;}, TResult>({a: 42}).value();
}
-result = <number[]>_.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
+// _.union
+module TestUnion {
+ let array: TResult[];
+ let list: _.List<TResult>;
-result = <number[]>_([1, 2, 3]).union([101, 2, 1, 10], [2, 1]).value();
+ {
+ let result: TResult[];
+
+ result = _.union<TResult>();
+
+ result = _.union<TResult>(array);
+ result = _.union<TResult>(array, list);
+ result = _.union<TResult>(array, list, array);
+
+ result = _.union<TResult>(list);
+ result = _.union<TResult>(list, array);
+ result = _.union<TResult>(list, array, list);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(array).union();
+ result = _(array).union(list);
+ result = _(array).union(list, array);
+
+ result = _(array).union<TResult>();
+ result = _(array).union<TResult>(list);
+ result = _(array).union<TResult>(list, array);
+
+ result = _(list).union<TResult>();
+ result = _(list).union<TResult>(array);
+ result = _(list).union<TResult>(array, list);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(array).chain().union();
+ result = _(array).chain().union(list);
+ result = _(array).chain().union(list, array);
+
+ result = _(array).chain().union<TResult>();
+ result = _(array).chain().union<TResult>(list);
+ result = _(array).chain().union<TResult>(list, array);
+
+ result = _(list).chain().union<TResult>();
+ result = _(list).chain().union<TResult>(array);
+ result = _(list).chain().union<TResult>(array, list);
+ }
+}
result = <number[]>_.uniq([1, 2, 1, 3, 1]);
result = <number[]>_.uniq([1, 1, 2, 2, 3], true);
@@ -817,6 +1302,69 @@ result = <any[][]>_.unzip(['moe', 'larry'], [30, 40], [true, false]);
result = <any[][]>_(['moe', 'larry']).zip([30, 40], [true, false]).value();
result = <any[][]>_(['moe', 'larry']).unzip([30, 40], [true, false]).value();
+// _.zipObject
+module TestZipObject {
+ let arrayOfKeys: string[];
+ let arrayOfValues: number[];
+
+ let listOfKeys: _.List<string>;
+ let listOfValues: _.List<number>;
+
+ {
+ let result: _.Dictionary<void>;
+
+ result = _.zipObject<_.Dictionary<void>>(arrayOfKeys);
+ result = _.zipObject<_.Dictionary<void>>(listOfKeys);
+
+ result = _(arrayOfKeys).zipObject<_.Dictionary<void>>().value();
+ result = _(listOfKeys).zipObject<_.Dictionary<void>>().value();
+ }
+
+ {
+ let result: _.Dictionary<number>;
+
+ result = _.zipObject<_.Dictionary<number>>(arrayOfKeys, arrayOfValues);
+ result = _.zipObject<_.Dictionary<number>>(arrayOfKeys, listOfValues);
+ result = _.zipObject<_.Dictionary<number>>(listOfKeys, listOfValues);
+ result = _.zipObject<_.Dictionary<number>>(listOfKeys, arrayOfValues);
+
+ result = _.zipObject<number, _.Dictionary<number>>(arrayOfKeys, arrayOfValues);
+ result = _.zipObject<number, _.Dictionary<number>>(arrayOfKeys, listOfValues);
+ result = _.zipObject<number, _.Dictionary<number>>(listOfKeys, listOfValues);
+ result = _.zipObject<number, _.Dictionary<number>>(listOfKeys, arrayOfValues);
+
+ result = _(arrayOfKeys).zipObject<_.Dictionary<number>>(arrayOfValues).value();
+ result = _(arrayOfKeys).zipObject<_.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).zipObject<_.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).zipObject<_.Dictionary<number>>(arrayOfValues).value();
+
+ result = _(arrayOfKeys).zipObject<number, _.Dictionary<number>>(arrayOfValues).value();
+ result = _(arrayOfKeys).zipObject<number, _.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).zipObject<number, _.Dictionary<number>>(listOfValues).value();
+ result = _(listOfKeys).zipObject<number, _.Dictionary<number>>(arrayOfValues).value();
+ }
+
+ {
+ let result: _.Dictionary<any>;
+
+ result = _.zipObject(arrayOfKeys);
+ result = _.zipObject(arrayOfKeys, arrayOfValues);
+ result = _.zipObject(arrayOfKeys, listOfValues);
+
+ result = _.zipObject(listOfKeys);
+ result = _.zipObject(listOfKeys, listOfValues);
+ result = _.zipObject(listOfKeys, arrayOfValues);
+
+ result = _(arrayOfKeys).zipObject().value();
+ result = _(arrayOfKeys).zipObject(arrayOfValues).value();
+ result = _(arrayOfKeys).zipObject(listOfValues).value();
+
+ result = _(listOfKeys).zipObject().value();
+ result = _(listOfKeys).zipObject(listOfValues).value();
+ result = _(listOfKeys).zipObject(arrayOfValues).value();
+ }
+}
+
// _.zipWith
interface TestZipWithFn {
(a1: number, a2: number): number;
@@ -837,76 +1385,586 @@ 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('');
+
+// _.prototype.reverse
+module TestReverse {
+ {
+ let result: _.LoDashImplicitArrayWrapper<number>;
+ result: _([42]).reverse();
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<number>;
+ result: _([42]).chain().reverse();
+ }
}
-{
- let result: _.LoDashWrapper<boolean>;
- result = _(any).plant(true);
+
+// _.prototype.run
+module TestRun {
+ {
+ let result: string;
+
+ result = _('').run();
+ result = _('').chain().run();
+ }
+
+ {
+ let result: number;
+
+ result = _(42).run();
+ result = _(42).chain().run();
+ }
+
+ {
+ let result: boolean;
+
+ result = _(true).run();
+ result = _(true).chain().run();
+ }
+
+ {
+ let result: string[];
+
+ result = _<string>([]).run();
+ result = _<string>([]).chain().run();
+ }
+
+ {
+ let result: {a: string};
+
+ result = _({a: ''}).run();
+ result = _({a: ''}).chain().run();
+ }
}
-{
- let result: _.LoDashNumberArrayWrapper;
- result = _(any).plant([42]);
+
+// _.prototype.toJSON
+module TestToJSON {
+ {
+ let result: string;
+
+ result = _('').toJSON();
+ result = _('').chain().toJSON();
+ }
+
+ {
+ let result: number;
+
+ result = _(42).toJSON();
+ result = _(42).chain().toJSON();
+ }
+
+ {
+ let result: boolean;
+
+ result = _(true).toJSON();
+ result = _(true).chain().toJSON();
+ }
+
+ {
+ let result: string[];
+
+ result = _<string>([]).toJSON();
+ result = _<string>([]).chain().toJSON();
+ }
+
+ {
+ let result: {a: string};
+
+ result = _({a: ''}).toJSON();
+ result = _({a: ''}).chain().toJSON();
+ }
}
-{
- let result: _.LoDashArrayWrapper<any>;
- result = _(any).plant<any>([]);
+
+// _.prototype.toString
+module TestToString {
+ let result: string;
+
+ result = _('').toString();
+ result = _(42).toString();
+ result = _(true).toString();
+ result = _<string>(['']).toString();
+ result = _({}).toString();
+
+ result = _('').chain().toString();
+ result = _(42).chain().toString();
+ result = _(true).chain().toString();
+ result = _<string>(['']).chain().toString();
+ result = _({}).chain().toString();
}
-{
- let result: _.LoDashObjectWrapper<{}>;
- result = _(any).plant<{}>({});
+
+// _.prototype.value
+module TestValue {
+ {
+ let result: string;
+
+ result = _('').value();
+ result = _('').chain().value();
+ }
+
+ {
+ let result: number;
+
+ result = _(42).value();
+ result = _(42).chain().value();
+ }
+
+ {
+ let result: boolean;
+
+ result = _(true).value();
+ result = _(true).chain().value();
+ }
+
+ {
+ let result: string[];
+
+ result = _<string>([]).value();
+ result = _<string>([]).chain().value();
+ }
+
+ {
+ let result: {a: string};
+
+ result = _({a: ''}).value();
+ result = _({a: ''}).chain().value();
+ }
+}
+
+// _.prototype.valueOf
+module TestValueOf {
+ {
+ let result: string;
+
+ result = _('').valueOf();
+ result = _('').chain().valueOf();
+ }
+
+ {
+ let result: number;
+
+ result = _(42).valueOf();
+ result = _(42).chain().valueOf();
+ }
+
+ {
+ let result: boolean;
+
+ result = _(true).valueOf();
+ result = _(true).chain().valueOf();
+ }
+
+ {
+ let result: string[];
+
+ result = _<string>([]).valueOf();
+ result = _<string>([]).chain().valueOf();
+ }
+
+ {
+ let result: {a: string};
+
+ result = _({a: ''}).valueOf();
+ result = _({a: ''}).chain().valueOf();
+ }
}
/**************
@@ -922,43 +1980,139 @@ module TestAll {
let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean;
- let result: boolean;
+ {
+ let result: boolean;
- result = _.all<TResult>(array);
- result = _.all<TResult>(array, listIterator);
- result = _.all<TResult>(array, listIterator, any);
- result = _.all<TResult>(array, '');
- result = _.all<{a: number}, TResult>(array, {a: 42});
+ result = _.all<TResult>(array);
+ result = _.all<TResult>(array, listIterator);
+ result = _.all<TResult>(array, listIterator, any);
+ result = _.all<TResult>(array, '');
+ result = _.all<{a: number}, TResult>(array, {a: 42});
- result = _.all<TResult>(list);
- result = _.all<TResult>(list, listIterator);
- result = _.all<TResult>(list, listIterator, any);
- result = _.all<TResult>(list, '');
- result = _.all<{a: number}, TResult>(list, {a: 42});
+ result = _.all<TResult>(list);
+ result = _.all<TResult>(list, listIterator);
+ result = _.all<TResult>(list, listIterator, any);
+ result = _.all<TResult>(list, '');
+ result = _.all<{a: number}, TResult>(list, {a: 42});
- result = _.all<TResult>(dictionary);
- result = _.all<TResult>(dictionary, dictionaryIterator);
- result = _.all<TResult>(dictionary, dictionaryIterator, any);
- result = _.all<TResult>(dictionary, '');
- result = _.all<{a: number}, TResult>(dictionary, {a: 42});
+ result = _.all<TResult>(dictionary);
+ result = _.all<TResult>(dictionary, dictionaryIterator);
+ result = _.all<TResult>(dictionary, dictionaryIterator, any);
+ result = _.all<TResult>(dictionary, '');
+ result = _.all<{a: number}, TResult>(dictionary, {a: 42});
- result = _(array).all();
- result = _(array).all(listIterator);
- result = _(array).all(listIterator, any);
- result = _(array).all('');
- result = _(array).all<{a: number}>({a: 42});
+ result = _(array).all();
+ result = _(array).all(listIterator);
+ result = _(array).all(listIterator, any);
+ result = _(array).all('');
+ result = _(array).all<{a: number}>({a: 42});
- result = _(list).all<TResult>();
- result = _(list).all<TResult>(listIterator);
- result = _(list).all<TResult>(listIterator, any);
- result = _(list).all('');
- result = _(list).all<{a: number}>({a: 42});
+ result = _(list).all<TResult>();
+ result = _(list).all<TResult>(listIterator);
+ result = _(list).all<TResult>(listIterator, any);
+ result = _(list).all('');
+ result = _(list).all<{a: number}>({a: 42});
- result = _(dictionary).all<TResult>();
- result = _(dictionary).all<TResult>(dictionaryIterator);
- result = _(dictionary).all<TResult>(dictionaryIterator, any);
- result = _(dictionary).all('');
- result = _(dictionary).all<{a: number}>({a: 42});
+ result = _(dictionary).all<TResult>();
+ result = _(dictionary).all<TResult>(dictionaryIterator);
+ result = _(dictionary).all<TResult>(dictionaryIterator, any);
+ result = _(dictionary).all('');
+ result = _(dictionary).all<{a: number}>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _(array).chain().all();
+ result = _(array).chain().all(listIterator);
+ result = _(array).chain().all(listIterator, any);
+ result = _(array).chain().all('');
+ result = _(array).chain().all<{a: number}>({a: 42});
+
+ result = _(list).chain().all<TResult>();
+ result = _(list).chain().all<TResult>(listIterator);
+ result = _(list).chain().all<TResult>(listIterator, any);
+ result = _(list).chain().all('');
+ result = _(list).chain().all<{a: number}>({a: 42});
+
+ result = _(dictionary).chain().all<TResult>();
+ result = _(dictionary).chain().all<TResult>(dictionaryIterator);
+ result = _(dictionary).chain().all<TResult>(dictionaryIterator, any);
+ result = _(dictionary).chain().all('');
+ result = _(dictionary).chain().all<{a: number}>({a: 42});
+ }
+}
+
+// _.any
+module TestAny {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
+
+ let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
+ let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean;
+
+ {
+ let result: boolean;
+
+ result = _.any<TResult>(array);
+ result = _.any<TResult>(array, listIterator);
+ result = _.any<TResult>(array, listIterator, any);
+ result = _.any<TResult>(array, '');
+ result = _.any<{a: number}, TResult>(array, {a: 42});
+
+ result = _.any<TResult>(list);
+ result = _.any<TResult>(list, listIterator);
+ result = _.any<TResult>(list, listIterator, any);
+ result = _.any<TResult>(list, '');
+ result = _.any<{a: number}, TResult>(list, {a: 42});
+
+ result = _.any<TResult>(dictionary);
+ result = _.any<TResult>(dictionary, dictionaryIterator);
+ result = _.any<TResult>(dictionary, dictionaryIterator, any);
+ result = _.any<TResult>(dictionary, '');
+ result = _.any<{a: number}, TResult>(dictionary, {a: 42});
+
+ result = _(array).any();
+ result = _(array).any(listIterator);
+ result = _(array).any(listIterator, any);
+ result = _(array).any('');
+ result = _(array).any<{a: number}>({a: 42});
+
+ result = _(list).any<TResult>();
+ result = _(list).any<TResult>(listIterator);
+ result = _(list).any<TResult>(listIterator, any);
+ result = _(list).any('');
+ result = _(list).any<{a: number}>({a: 42});
+
+ result = _(dictionary).any<TResult>();
+ result = _(dictionary).any<TResult>(dictionaryIterator);
+ result = _(dictionary).any<TResult>(dictionaryIterator, any);
+ result = _(dictionary).any('');
+ result = _(dictionary).any<{a: number}>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _(array).chain().any();
+ result = _(array).chain().any(listIterator);
+ result = _(array).chain().any(listIterator, any);
+ result = _(array).chain().any('');
+ result = _(array).chain().any<{a: number}>({a: 42});
+
+ result = _(list).chain().any<TResult>();
+ result = _(list).chain().any<TResult>(listIterator);
+ result = _(list).chain().any<TResult>(listIterator, any);
+ result = _(list).chain().any('');
+ result = _(list).chain().any<{a: number}>({a: 42});
+
+ result = _(dictionary).chain().any<TResult>();
+ result = _(dictionary).chain().any<TResult>(dictionaryIterator);
+ result = _(dictionary).chain().any<TResult>(dictionaryIterator, any);
+ result = _(dictionary).chain().any('');
+ result = _(dictionary).chain().any<{a: number}>({a: 42});
+ }
}
// _.at
@@ -980,43 +2134,89 @@ module TestCollect {
let array: number[];
let list: _.List<number>;
let dictionary: _.Dictionary<number>;
- let listIterator: {(value: number, index: number, collection: _.List<number>): TResult};
- let dictionaryIterator: {(value: number, key: string, collection: _.Dictionary<number>): TResult};
+
+ let listIterator: (value: number, index: number, collection: _.List<number>) => TResult;
+ let dictionaryIterator: (value: number, key: string, collection: _.Dictionary<number>) => TResult;
+
{
let result: TResult[];
+
result = _.collect<number, TResult>(array);
result = _.collect<number, TResult>(array, listIterator);
result = _.collect<number, TResult>(array, listIterator, any);
result = _.collect<number, TResult>(array, '');
+
result = _.collect<number, TResult>(list);
result = _.collect<number, TResult>(list, listIterator);
result = _.collect<number, TResult>(list, listIterator, any);
result = _.collect<number, TResult>(list, '');
+
result = _.collect<number, TResult>(dictionary);
result = _.collect<number, TResult>(dictionary, dictionaryIterator);
result = _.collect<number, TResult>(dictionary, dictionaryIterator, any);
result = _.collect<number, TResult>(dictionary, '');
- result = _<number>(array).collect<TResult>().value();
- result = _<number>(array).collect<TResult>(listIterator).value();
- result = _<number>(array).collect<TResult>(listIterator, any).value();
- result = _<number>(array).collect<TResult>('').value();
- result = _(list).collect<number, TResult>().value();
- result = _(list).collect<number, TResult>(listIterator).value();
- result = _(list).collect<number, TResult>(listIterator, any).value();
- result = _(list).collect<number, TResult>('').value();
- result = _(dictionary).collect<number, TResult>().value();
- result = _(dictionary).collect<number, TResult>(dictionaryIterator).value();
- result = _(dictionary).collect<number, TResult>(dictionaryIterator, any).value();
- result = _(dictionary).collect<number, TResult>('').value();
}
+
{
let result: boolean[];
+
result = _.collect<number, {}>(array, {});
result = _.collect<number, {}>(list, {});
result = _.collect<number, {}>(dictionary, {});
- result = _<number>(array).collect<{}>({}).value();
- result = _(list).collect<{}>({}).value();
- result = _(dictionary).collect<{}>({}).value();
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _<number>(array).collect<TResult>();
+ result = _<number>(array).collect<TResult>(listIterator);
+ result = _<number>(array).collect<TResult>(listIterator, any);
+ result = _<number>(array).collect<TResult>('');
+
+ result = _(list).collect<number, TResult>();
+ result = _(list).collect<number, TResult>(listIterator);
+ result = _(list).collect<number, TResult>(listIterator, any);
+ result = _(list).collect<number, TResult>('');
+
+ result = _(dictionary).collect<number, TResult>();
+ result = _(dictionary).collect<number, TResult>(dictionaryIterator);
+ result = _(dictionary).collect<number, TResult>(dictionaryIterator, any);
+ result = _(dictionary).collect<number, TResult>('');
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<boolean>;
+
+ result = _<number>(array).collect<{}>({});
+ result = _(list).collect<{}>({});
+ result = _(dictionary).collect<{}>({});
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _<number>(array).chain().collect<TResult>();
+ result = _<number>(array).chain().collect<TResult>(listIterator);
+ result = _<number>(array).chain().collect<TResult>(listIterator, any);
+ result = _<number>(array).chain().collect<TResult>('');
+
+ result = _(list).chain().collect<number, TResult>();
+ result = _(list).chain().collect<number, TResult>(listIterator);
+ result = _(list).chain().collect<number, TResult>(listIterator, any);
+ result = _(list).chain().collect<number, TResult>('');
+
+ result = _(dictionary).chain().collect<number, TResult>();
+ result = _(dictionary).chain().collect<number, TResult>(dictionaryIterator);
+ result = _(dictionary).chain().collect<number, TResult>(dictionaryIterator, any);
+ result = _(dictionary).chain().collect<number, TResult>('');
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<boolean>;
+
+ result = _<number>(array).chain().collect<{}>({});
+ result = _(list).chain().collect<{}>({});
+ result = _(dictionary).chain().collect<{}>({});
}
}
@@ -1054,9 +2254,152 @@ 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 {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
+
+ let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
+ let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean;
+
+ let result: TResult;
+
+ result = _.detect<TResult>(array);
+ result = _.detect<TResult>(array, listIterator);
+ result = _.detect<TResult>(array, listIterator, any);
+ result = _.detect<TResult>(array, '');
+ result = _.detect<{a: number}, TResult>(array, {a: 42});
+
+ result = _.detect<TResult>(list);
+ result = _.detect<TResult>(list, listIterator);
+ result = _.detect<TResult>(list, listIterator, any);
+ result = _.detect<TResult>(list, '');
+ result = _.detect<{a: number}, TResult>(list, {a: 42});
+
+ result = _.detect<TResult>(dictionary);
+ result = _.detect<TResult>(dictionary, dictionaryIterator);
+ result = _.detect<TResult>(dictionary, dictionaryIterator, any);
+ result = _.detect<TResult>(dictionary, '');
+ result = _.detect<{a: number}, TResult>(dictionary, {a: 42});
+
+ result = _(array).detect();
+ result = _(array).detect(listIterator);
+ result = _(array).detect(listIterator, any);
+ result = _(array).detect('');
+ result = _(array).detect<{a: number}>({a: 42});
+
+ result = _(list).detect<TResult>();
+ result = _(list).detect<TResult>(listIterator);
+ result = _(list).detect<TResult>(listIterator, any);
+ result = _(list).detect<TResult>('');
+ result = _(list).detect<{a: number}, TResult>({a: 42});
+
+ result = _(dictionary).detect<TResult>();
+ result = _(dictionary).detect<TResult>(dictionaryIterator);
+ result = _(dictionary).detect<TResult>(dictionaryIterator, any);
+ result = _(dictionary).detect<TResult>('');
+ result = _(dictionary).detect<{a: number}, TResult>({a: 42});
+}
+
+// _.each
+module TestEach {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
+
+ let stringIterator: (char: string, index: number, string: string) => boolean|void;
+ let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean|void;
+ let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean|void;
+
+ {
+ let result: string;
+
+ _.each('', stringIterator);
+ _.each('', stringIterator, any);
+ }
+
+ {
+ let result: TResult[];
+
+ _.each<TResult>(array, listIterator);
+ _.each<TResult>(array, listIterator, any);
+ }
+
+ {
+ let result: _.List<TResult>;
+
+ _.each<TResult>(list, listIterator);
+ _.each<TResult>(list, listIterator, any);
+ }
+
+ {
+ let result: _.Dictionary<TResult>;
+
+ _.each<TResult>(dictionary, dictionaryIterator);
+ _.each<TResult>(dictionary, dictionaryIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitWrapper<string>;
+
+ _('').each(stringIterator);
+ _('').each(stringIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ _(array).each(listIterator);
+ _(array).each(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<_.List<TResult>>;
+
+ _(list).each<TResult>(listIterator);
+ _(list).each<TResult>(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<_.Dictionary<TResult>>;
+
+ _(dictionary).each<TResult>(dictionaryIterator);
+ _(dictionary).each<TResult>(dictionaryIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ _('').chain().each(stringIterator);
+ _('').chain().each(stringIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ _(array).chain().each(listIterator);
+ _(array).chain().each(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<_.List<TResult>>;
+
+ _(list).chain().each<TResult>(listIterator);
+ _(list).chain().each<TResult>(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<_.Dictionary<TResult>>;
+
+ _(dictionary).chain().each<TResult>(dictionaryIterator);
+ _(dictionary).chain().each<TResult>(dictionaryIterator, any);
+ }
+}
// _.every
module TestEvery {
@@ -1067,43 +2410,67 @@ module TestEvery {
let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean;
- let result: boolean;
+ {
+ let result: boolean;
- result = _.every<TResult>(array);
- result = _.every<TResult>(array, listIterator);
- result = _.every<TResult>(array, listIterator, any);
- result = _.every<TResult>(array, '');
- result = _.every<{a: number}, TResult>(array, {a: 42});
+ result = _.every<TResult>(array);
+ result = _.every<TResult>(array, listIterator);
+ result = _.every<TResult>(array, listIterator, any);
+ result = _.every<TResult>(array, '');
+ result = _.every<{a: number}, TResult>(array, {a: 42});
- result = _.every<TResult>(list);
- result = _.every<TResult>(list, listIterator);
- result = _.every<TResult>(list, listIterator, any);
- result = _.every<TResult>(list, '');
- result = _.every<{a: number}, TResult>(list, {a: 42});
+ result = _.every<TResult>(list);
+ result = _.every<TResult>(list, listIterator);
+ result = _.every<TResult>(list, listIterator, any);
+ result = _.every<TResult>(list, '');
+ result = _.every<{a: number}, TResult>(list, {a: 42});
- result = _.every<TResult>(dictionary);
- result = _.every<TResult>(dictionary, dictionaryIterator);
- result = _.every<TResult>(dictionary, dictionaryIterator, any);
- result = _.every<TResult>(dictionary, '');
- result = _.every<{a: number}, TResult>(dictionary, {a: 42});
+ result = _.every<TResult>(dictionary);
+ result = _.every<TResult>(dictionary, dictionaryIterator);
+ result = _.every<TResult>(dictionary, dictionaryIterator, any);
+ result = _.every<TResult>(dictionary, '');
+ result = _.every<{a: number}, TResult>(dictionary, {a: 42});
- result = _(array).every();
- result = _(array).every(listIterator);
- result = _(array).every(listIterator, any);
- result = _(array).every('');
- result = _(array).every<{a: number}>({a: 42});
+ result = _(array).every();
+ result = _(array).every(listIterator);
+ result = _(array).every(listIterator, any);
+ result = _(array).every('');
+ result = _(array).every<{a: number}>({a: 42});
- result = _(list).every<TResult>();
- result = _(list).every<TResult>(listIterator);
- result = _(list).every<TResult>(listIterator, any);
- result = _(list).every('');
- result = _(list).every<{a: number}>({a: 42});
+ result = _(list).every<TResult>();
+ result = _(list).every<TResult>(listIterator);
+ result = _(list).every<TResult>(listIterator, any);
+ result = _(list).every('');
+ result = _(list).every<{a: number}>({a: 42});
- result = _(dictionary).every<TResult>();
- result = _(dictionary).every<TResult>(dictionaryIterator);
- result = _(dictionary).every<TResult>(dictionaryIterator, any);
- result = _(dictionary).every('');
- result = _(dictionary).every<{a: number}>({a: 42});
+ result = _(dictionary).every<TResult>();
+ result = _(dictionary).every<TResult>(dictionaryIterator);
+ result = _(dictionary).every<TResult>(dictionaryIterator, any);
+ result = _(dictionary).every('');
+ result = _(dictionary).every<{a: number}>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _(array).chain().every();
+ result = _(array).chain().every(listIterator);
+ result = _(array).chain().every(listIterator, any);
+ result = _(array).chain().every('');
+ result = _(array).chain().every<{a: number}>({a: 42});
+
+ result = _(list).chain().every<TResult>();
+ result = _(list).chain().every<TResult>(listIterator);
+ result = _(list).chain().every<TResult>(listIterator, any);
+ result = _(list).chain().every('');
+ result = _(list).chain().every<{a: number}>({a: 42});
+
+ result = _(dictionary).chain().every<TResult>();
+ result = _(dictionary).chain().every<TResult>(dictionaryIterator);
+ result = _(dictionary).chain().every<TResult>(dictionaryIterator, any);
+ result = _(dictionary).chain().every('');
+ result = _(dictionary).chain().every<{a: number}>({a: 42});
+ }
}
result = <number[]>_.filter([1, 2, 3, 4, 5, 6]);
@@ -1123,20 +2490,53 @@ result = <number[]>_([1, 2, 3, 4, 5, 6]).select(function (num) { return num % 2
result = <IFoodCombined[]>_(foodsCombined).select('organic').value();
result = <IFoodCombined[]>_(foodsCombined).select({ 'type': 'fruit' }).value();
-result = <number>_.find([1, 2, 3, 4], num => num % 2 == 0);
-result = <IFoodCombined>_.find(foodsCombined, { 'type': 'vegetable' });
-result = <IFoodCombined>_.find(foodsCombined, 'type', 'vegetable');
-result = <IFoodCombined>_.find(foodsCombined, 'organic');
-result = <number>_([1, 2, 3, 4]).find(num => num % 2 == 0);
-result = <IFoodCombined>_(foodsCombined).find({ 'type': 'vegetable' });
-result = <IFoodCombined>_(foodsCombined).find('type', 'vegetable');
-result = <IFoodCombined>_(foodsCombined).find('organic');
+// _.find
+module TestFind {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
-result = <number>_.detect([1, 2, 3, 4], function (num) {
- return num % 2 == 0;
-});
-result = <IFoodCombined>_.detect(foodsCombined, { 'type': 'vegetable' });
-result = <IFoodCombined>_.detect(foodsCombined, 'organic');
+ let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
+ let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean;
+
+ let result: TResult;
+
+ result = _.find<TResult>(array);
+ result = _.find<TResult>(array, listIterator);
+ result = _.find<TResult>(array, listIterator, any);
+ result = _.find<TResult>(array, '');
+ result = _.find<{a: number}, TResult>(array, {a: 42});
+
+ result = _.find<TResult>(list);
+ result = _.find<TResult>(list, listIterator);
+ result = _.find<TResult>(list, listIterator, any);
+ result = _.find<TResult>(list, '');
+ result = _.find<{a: number}, TResult>(list, {a: 42});
+
+ result = _.find<TResult>(dictionary);
+ result = _.find<TResult>(dictionary, dictionaryIterator);
+ result = _.find<TResult>(dictionary, dictionaryIterator, any);
+ result = _.find<TResult>(dictionary, '');
+ result = _.find<{a: number}, TResult>(dictionary, {a: 42});
+
+ result = _(array).find();
+ result = _(array).find(listIterator);
+ result = _(array).find(listIterator, any);
+ result = _(array).find('');
+ result = _(array).find<{a: number}>({a: 42});
+
+ result = _(list).find<TResult>();
+ result = _(list).find<TResult>(listIterator);
+ result = _(list).find<TResult>(listIterator, any);
+ result = _(list).find<TResult>('');
+ result = _(list).find<{a: number}, TResult>({a: 42});
+
+ result = _(dictionary).find<TResult>();
+ result = _(dictionary).find<TResult>(dictionaryIterator);
+ result = _(dictionary).find<TResult>(dictionaryIterator, any);
+ result = _(dictionary).find<TResult>('');
+ result = _(dictionary).find<{a: number}, TResult>({a: 42});
+}
result = <number>_.findWhere([1, 2, 3, 4], function (num) {
return num % 2 == 0;
@@ -1156,19 +2556,100 @@ result = <number>_([1, 2, 3, 4]).findLast(function (num) {
result = <IFoodCombined>_(foodsCombined).findLast({ 'type': 'vegetable' });
result = <IFoodCombined>_(foodsCombined).findLast('organic');
-result = <number[]>_.forEach([1, 2, 3], function (num) { console.log(num); });
-result = <_.Dictionary<number>>_.forEach({ 'one': 1, 'two': 2, 'three': 3 }, function (num) { console.log(num); });
-result = <IFoodType>_.forEach<IFoodType, string>({ name: 'apple', type: 'fruit' }, function (value, key) { console.log(value, key) });
+// _.forEach
+module TestForEach {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
-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) });
+ let stringIterator: (char: string, index: number, string: string) => boolean|void;
+ let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean|void;
+ let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean|void;
-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); });
+ {
+ let result: string;
-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); });
+ _.forEach('', stringIterator);
+ _.forEach('', stringIterator, any);
+ }
+
+ {
+ let result: TResult[];
+
+ _.forEach<TResult>(array, listIterator);
+ _.forEach<TResult>(array, listIterator, any);
+ }
+
+ {
+ let result: _.List<TResult>;
+
+ _.forEach<TResult>(list, listIterator);
+ _.forEach<TResult>(list, listIterator, any);
+ }
+
+ {
+ let result: _.Dictionary<TResult>;
+
+ _.forEach<TResult>(dictionary, dictionaryIterator);
+ _.forEach<TResult>(dictionary, dictionaryIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitWrapper<string>;
+
+ _('').forEach(stringIterator);
+ _('').forEach(stringIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ _(array).forEach(listIterator);
+ _(array).forEach(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<_.List<TResult>>;
+
+ _(list).forEach<TResult>(listIterator);
+ _(list).forEach<TResult>(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<_.Dictionary<TResult>>;
+
+ _(dictionary).forEach<TResult>(dictionaryIterator);
+ _(dictionary).forEach<TResult>(dictionaryIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ _('').chain().forEach(stringIterator);
+ _('').chain().forEach(stringIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ _(array).chain().forEach(listIterator);
+ _(array).chain().forEach(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<_.List<TResult>>;
+
+ _(list).chain().forEach<TResult>(listIterator);
+ _(list).chain().forEach<TResult>(listIterator, any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<_.Dictionary<TResult>>;
+
+ _(dictionary).chain().forEach<TResult>(dictionaryIterator);
+ _(dictionary).chain().forEach<TResult>(dictionaryIterator, any);
+ }
+}
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); });
@@ -1176,11 +2657,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);
@@ -1231,108 +2712,71 @@ module TestMap {
result = _.map<number, TResult>(dictionary, dictionaryIterator);
result = _.map<number, TResult>(dictionary, dictionaryIterator, any);
result = _.map<number, TResult>(dictionary, '');
-
- result = _<number>(array).map<TResult>().value();
- result = _<number>(array).map<TResult>(listIterator).value();
- result = _<number>(array).map<TResult>(listIterator, any).value();
- result = _<number>(array).map<TResult>('').value();
-
- result = _(list).map<number, TResult>().value();
- result = _(list).map<number, TResult>(listIterator).value();
- result = _(list).map<number, TResult>(listIterator, any).value();
- result = _(list).map<number, TResult>('').value();
-
- result = _(dictionary).map<number, TResult>().value();
- result = _(dictionary).map<number, TResult>(dictionaryIterator).value();
- result = _(dictionary).map<number, TResult>(dictionaryIterator, any).value();
- result = _(dictionary).map<number, TResult>('').value();
}
+
{
let result: boolean[];
result = _.map<number, {}>(array, {});
result = _.map<number, {}>(list, {});
result = _.map<number, {}>(dictionary, {});
+ }
- result = _<number>(array).map<{}>({}).value();
- result = _(list).map<{}>({}).value();
- result = _(dictionary).map<{}>({}).value();
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _<number>(array).map<TResult>();
+ result = _<number>(array).map<TResult>(listIterator);
+ result = _<number>(array).map<TResult>(listIterator, any);
+ result = _<number>(array).map<TResult>('');
+
+ result = _(list).map<number, TResult>();
+ result = _(list).map<number, TResult>(listIterator);
+ result = _(list).map<number, TResult>(listIterator, any);
+ result = _(list).map<number, TResult>('');
+
+ result = _(dictionary).map<number, TResult>();
+ result = _(dictionary).map<number, TResult>(dictionaryIterator);
+ result = _(dictionary).map<number, TResult>(dictionaryIterator, any);
+ result = _(dictionary).map<number, TResult>('');
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<boolean>;
+
+ result = _<number>(array).map<{}>({});
+ result = _(list).map<{}>({});
+ result = _(dictionary).map<{}>({});
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _<number>(array).chain().map<TResult>();
+ result = _<number>(array).chain().map<TResult>(listIterator);
+ result = _<number>(array).chain().map<TResult>(listIterator, any);
+ result = _<number>(array).chain().map<TResult>('');
+
+ result = _(list).chain().map<number, TResult>();
+ result = _(list).chain().map<number, TResult>(listIterator);
+ result = _(list).chain().map<number, TResult>(listIterator, any);
+ result = _(list).chain().map<number, TResult>('');
+
+ result = _(dictionary).chain().map<number, TResult>();
+ result = _(dictionary).chain().map<number, TResult>(dictionaryIterator);
+ result = _(dictionary).chain().map<number, TResult>(dictionaryIterator, any);
+ result = _(dictionary).chain().map<number, TResult>('');
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<boolean>;
+
+ result = _<number>(array).chain().map<{}>({});
+ result = _(list).chain().map<{}>({});
+ result = _(dictionary).chain().map<{}>({});
}
}
-// _.ceil
-result = <number>_.ceil(4.006);
-// → 5
-result = <number>_.ceil(6.004, 2);
-// → 6.01
-result = <number>_.ceil(6040, -2);
-// → 6100
-result = <number>_(4.006).ceil();
-// → 5
-result = <number>_(6.004).ceil(2);
-// → 6.01
-result = <number>_(6040).ceil(-2);
-// → 6100
-
-// _.floor
-result = <number>_.floor(4.006);
-// → 4
-result = <number>_.floor(0.046, 2);
-// → 0.04
-result = <number>_.floor(4060, -2);
-// → 4000
-result = <number>_(4.006).floor();
-// → 4
-result = <number>_(0.046).floor(2);
-// → 0.04
-result = <number>_(4060).floor(-2);
-// → 4000
-
-result = <number>_.max([4, 2, 8, 6]);
-result = <IStoogesAge>_.max(stoogesAges, function (stooge) { return stooge.age; });
-result = <IStoogesAge>_.max(stoogesAges, 'age');
-result = <_.LoDashWrapper<number>>_([4, 2, 8, 6]).max();
-result = <_.LoDashWrapper<IStoogesAge>>_(stoogesAges).max(function (stooge) { return stooge.age; });
-result = <_.LoDashWrapper<IStoogesAge>>_(stoogesAges).max('age');
-
-result = <number>_.min([4, 2, 8, 6]);
-result = <IStoogesAge>_.min(stoogesAges, function (stooge) { return stooge.age; });
-result = <IStoogesAge>_.min(stoogesAges, 'age');
-result = <_.LoDashWrapper<number>>_([4, 2, 8, 6]).min();
-result = <_.LoDashWrapper<IStoogesAge>>_(stoogesAges).min(function (stooge) { return stooge.age; });
-result = <_.LoDashWrapper<IStoogesAge>>_(stoogesAges).min('age');
-
-// _.round
-result = <number>_.round(4.006);
-// → 4
-result = <number>_.round(4.006, 2);
-// → 4.01
-result = <number>_.round(4060, -2);
-// → 4100
-result = <number>_(4.006).round();
-// → 4
-result = <number>_(4.006).round(2);
-// → 4.01
-result = <number>_(4060).round(-2);
-// → 4100
-
-result = <number>_.sum([4, 2, 8, 6]);
-result = <number>_.sum([4, 2, 8, 6], function(v) { return v; });
-result = <number>_.sum({a: 2, b: 4});
-result = <number>_.sum({a: 2, b: 4}, function(v) { return v; });
-result = <number>_.sum(stoogesAges, function (stooge) { return stooge.age; });
-result = <number>_.sum(stoogesAges, 'age');
-result = <number>_.sum(stoogesAgesDict, function(stooge) { return stooge.age; });
-result = <number>_.sum(stoogesAgesDict, 'age');
-result = <number>_([4, 2, 8, 6]).sum();
-result = <number>_([4, 2, 8, 6]).sum(function(v) { return v; });
-result = <number>_({a: 2, b: 4}).sum();
-result = <number>_({a: 2, b: 4}).sum(function(v) { return v; });
-result = <number>_(stoogesAges).sum(function (stooge) { return stooge.age; });
-result = <number>_(stoogesAges).sum('age');
-result = <number>_(stoogesAgesDict).sum(function (stooge) { return stooge.age; });
-result = <number>_(stoogesAgesDict).sum('age');
-
result = <string[]>_.pluck(stoogesAges, 'name');
result = <string[]>_(stoogesAges).pluck('name').value();
result = <string[]>_.pluck(stoogesAges, ['name']);
@@ -1433,14 +2877,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();
@@ -1448,15 +2892,77 @@ result = <number>_.size({ 'one': 1, 'two': 2, 'three': 3 });
result = <number>_({ 'one': 1, 'two': 2, 'three': 3 }).size();
result = <number>_.size('curly');
-result = <boolean>_.some([null, 0, 'yes', false], Boolean);
-result = <boolean>_.some(foodsCombined, 'organic');
-result = <boolean>_.some(foodsCombined, { 'type': 'meat' });
-result = <boolean>_.some(foodsOrganic[0]);
+// _.some
+module TestSome {
+ let array: TResult[];
+ let list: _.List<TResult>;
+ let dictionary: _.Dictionary<TResult>;
-result = <boolean>_.any([null, 0, 'yes', false], Boolean);
-result = <boolean>_.any(foodsCombined, 'organic');
-result = <boolean>_.any(foodsCombined, { 'type': 'meat' });
-result = <boolean>_.any(foodsOrganic[0]);
+ let listIterator: (value: TResult, index: number, collection: _.List<TResult>) => boolean;
+ let dictionaryIterator: (value: TResult, key: string, collection: _.Dictionary<TResult>) => boolean;
+
+ {
+ let result: boolean;
+
+ result = _.some<TResult>(array);
+ result = _.some<TResult>(array, listIterator);
+ result = _.some<TResult>(array, listIterator, any);
+ result = _.some<TResult>(array, '');
+ result = _.some<{a: number}, TResult>(array, {a: 42});
+
+ result = _.some<TResult>(list);
+ result = _.some<TResult>(list, listIterator);
+ result = _.some<TResult>(list, listIterator, any);
+ result = _.some<TResult>(list, '');
+ result = _.some<{a: number}, TResult>(list, {a: 42});
+
+ result = _.some<TResult>(dictionary);
+ result = _.some<TResult>(dictionary, dictionaryIterator);
+ result = _.some<TResult>(dictionary, dictionaryIterator, any);
+ result = _.some<TResult>(dictionary, '');
+ result = _.some<{a: number}, TResult>(dictionary, {a: 42});
+
+ result = _(array).some();
+ result = _(array).some(listIterator);
+ result = _(array).some(listIterator, any);
+ result = _(array).some('');
+ result = _(array).some<{a: number}>({a: 42});
+
+ result = _(list).some<TResult>();
+ result = _(list).some<TResult>(listIterator);
+ result = _(list).some<TResult>(listIterator, any);
+ result = _(list).some('');
+ result = _(list).some<{a: number}>({a: 42});
+
+ result = _(dictionary).some<TResult>();
+ result = _(dictionary).some<TResult>(dictionaryIterator);
+ result = _(dictionary).some<TResult>(dictionaryIterator, any);
+ result = _(dictionary).some('');
+ result = _(dictionary).some<{a: number}>({a: 42});
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _(array).chain().some();
+ result = _(array).chain().some(listIterator);
+ result = _(array).chain().some(listIterator, any);
+ result = _(array).chain().some('');
+ result = _(array).chain().some<{a: number}>({a: 42});
+
+ result = _(list).chain().some<TResult>();
+ result = _(list).chain().some<TResult>(listIterator);
+ result = _(list).chain().some<TResult>(listIterator, any);
+ result = _(list).chain().some('');
+ result = _(list).chain().some<{a: number}>({a: 42});
+
+ result = _(dictionary).chain().some<TResult>();
+ result = _(dictionary).chain().some<TResult>(dictionaryIterator);
+ result = _(dictionary).chain().some<TResult>(dictionaryIterator, any);
+ result = _(dictionary).chain().some('');
+ result = _(dictionary).chain().some<{a: number}>({a: 42});
+ }
+}
result = <number[]>_.sortBy([1, 2, 3], function (num) { return Math.sin(num); });
result = <number[]>_.sortBy([1, 2, 3], function (num) { return this.sin(num); }, Math);
@@ -1481,12 +2987,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!'] });
@@ -1497,7 +2997,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 *
@@ -1510,18 +3027,10 @@ done = _.after(saves.length, function () {
console.log('Done saving!');
});
-_.forEach(saves, function (type) {
- asyncSave({ 'type': type, 'complete': done });
-});
-
done = _(saves.length).after(function () {
console.log('Done saving!');
}).value();
-_.forEach(saves, function (type) {
- asyncSave({ 'type': type, 'complete': done });
-});
-
// _.ary
result = <number[]>['6', '8', '10'].map(_.ary<(s: string) => number>(parseInt, 1));
result = <number[]>['6', '8', '10'].map(_(parseInt).ary<(s: string) => number>(1).value());
@@ -1600,28 +3109,58 @@ 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];
-interface TestCurryResultFn {
- (...args: number[]): number[] | TestCurryResultFn;
-}
-result = <number[]>_.curry<TestCurryResultFn>(testCurryFn)(1, 2, 3);
-result = <TestCurryResultFn>_.curry<TestCurryResultFn>(testCurryFn)(1);
-result = <number[]>_(testCurryFn).curry<TestCurryResultFn>().value()(1, 2, 3);
-result = <TestCurryResultFn>_(testCurryFn).curry<TestCurryResultFn>().value()(1);
+let curryResult0: number[]
+let curryResult1: _.CurriedFunction1<number, number[]>
+let curryResult2: _.CurriedFunction2<number, number, number[]>
+
+curryResult0 = _.curry(testCurryFn)(1, 2, 3);
+curryResult1 = _.curry(testCurryFn)(1, 2);
+curryResult0 = _.curry(testCurryFn)(1, 2)(3);
+curryResult0 = _.curry(testCurryFn)(1)(2)(3);
+curryResult2 = _.curry(testCurryFn)(1);
+curryResult1 = _.curry(testCurryFn)(1)(2);
+curryResult0 = _.curry(testCurryFn)(1)(2)(3);
+curryResult0 = _.curry(testCurryFn)(1)(2, 3);
+curryResult0 = _(testCurryFn).curry().value()(1, 2, 3);
+curryResult2 = _(testCurryFn).curry().value()(1);
+
+declare function testCurry2(a: string, b: number, c: boolean): [string, number, boolean];
+let curryResult3: [string, number, boolean];
+let curryResult4: _.CurriedFunction1<boolean, [string, number, boolean]>;
+let curryResult5: _.CurriedFunction2<number, boolean, [string, number, boolean]>;
+let curryResult6: _.CurriedFunction3<string, number, boolean, [string, number, boolean]>;
+curryResult3 = _.curry(testCurry2)("1", 2, true);
+curryResult3 = _.curry(testCurry2)("1", 2)(true);
+curryResult3 = _.curry(testCurry2)("1")(2, true);
+curryResult3 = _.curry(testCurry2)("1")(2)(true);
+curryResult4 = _.curry(testCurry2)("1", 2);
+curryResult4 = _.curry(testCurry2)("1")(2);
+curryResult5 = _.curry(testCurry2)("1");
+curryResult6 = _.curry(testCurry2);
// _.curryRight
var testCurryRightFn = (a: number, b: number, c: number) => [a, b, c];
-interface TestCurryRightResultFn {
- (...args: number[]): number[] | TestCurryRightResultFn;
-}
-result = <number[]>_.curryRight<TestCurryRightResultFn>(testCurryRightFn)(1, 2, 3);
-result = <TestCurryRightResultFn>_.curryRight<TestCurryRightResultFn>(testCurryRightFn)(1);
-result = <number[]>_(testCurryRightFn).curryRight<TestCurryRightResultFn>().value()(1, 2, 3);
-result = <TestCurryRightResultFn>_(testCurryRightFn).curryRight<TestCurryRightResultFn>().value()(1);
+curryResult0 = _.curryRight(testCurryRightFn)(1, 2, 3);
+curryResult2 = _.curryRight(testCurryRightFn)(1);
+curryResult0 = _(testCurryRightFn).curryRight().value()(1, 2, 3);
+curryResult2 = _(testCurryRightFn).curryRight().value()(1);
+
+let curryResult7: _.CurriedFunction1<string, [string, number, boolean]>;
+let curryResult8: _.CurriedFunction2<number, string, [string, number, boolean]>;
+let curryResult9: _.CurriedFunction3<boolean, number, string, [string, number, boolean]>;
+curryResult3 = _.curryRight(testCurry2)(true, 2, "1");
+curryResult3 = _.curryRight(testCurry2)(true, 2)("1");
+curryResult3 = _.curryRight(testCurry2)(true)(2, "1");
+curryResult3 = _.curryRight(testCurry2)(true)(2)("1");
+curryResult7 = _.curryRight(testCurry2)(true, 2);
+curryResult7 = _.curryRight(testCurry2)(true)(2);
+curryResult8 = _.curryRight(testCurry2)(true);
+curryResult9 = _.curryRight(testCurry2);
declare var source: any;
result = <Function>_.debounce(function () { }, 150);
@@ -1635,14 +3174,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);
@@ -1650,11 +3189,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;
@@ -1726,9 +3265,10 @@ var returnedOnce = _.throttle(function (a: any) { return a * 5; }, 5);
returnedOnce(4);
var greetPartial = function (greeting: string, name: string) { return greeting + ' ' + name; };
-var hi = <Function>_.partial(greetPartial, 'hi');
+var hi = _.partial(greetPartial, 'hi');
hi('moe');
+
var defaultsDeep = <Function>_.partialRight(_.merge, _.defaults);
var optionsPartialRight = {
@@ -1872,6 +3412,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);
@@ -1889,24 +3443,68 @@ result = <boolean>_.isArguments(any);
result = <boolean>_(1).isArguments();
result = <boolean>_<any>([]).isArguments();
result = <boolean>_({}).isArguments();
+{
+ let value: IArguments|number = 42;
+ if (_.isArguments(value)) {
+ let length: number = value.length;
+ // compile error
+ // let i: number = value + 1;
+ } else {
+ let i: number = value + 1;
+ // compile error
+ // let length: number = value.length;
+ }
+}
// _.isArray
result = <boolean>_.isArray(any);
result = <boolean>_(1).isArray();
result = <boolean>_<any>([]).isArray();
result = <boolean>_({}).isArray();
+{
+ let value: number[]|string = [1, 3, 5];
+ if (_.isArray(value)) {
+ let length: number[] = value.concat(4);
+ // compile error
+ // let char: string = value.charAt(0);
+ } else {
+ let char: string = value.charAt(0);
+ // compile error
+ // let length: number[] = value.concat(4);
+ }
+}
// _.isBoolean
result = <boolean>_.isBoolean(any);
result = <boolean>_(1).isBoolean();
result = <boolean>_<any>([]).isBoolean();
result = <boolean>_({}).isBoolean();
+{
+ let value: number[]|boolean = [1, 3, 5];
+ if (_.isBoolean(value)) {
+ let b: boolean = value;
+ // compile error
+ // let length: number = value.length;
+ } else {
+ let length: number = value.length;
+ // compile error
+ // let b: boolean = value;
+ }
+}
// _.isDate
result = <boolean>_.isDate(any);
result = <boolean>_(42).isDate();
result = <boolean>_<any>([]).isDate();
result = <boolean>_({}).isDate();
+{
+ let value: Date|string = "foo";
+ if (_.isDate(value)) {
+ value.toTimeString();
+ } else {
+ value.charAt(0);
+ }
+}
// _.isElement
result = <boolean>_.isElement(any);
@@ -1922,11 +3520,33 @@ 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();
result = <boolean>_<any>([]).isError();
result = <boolean>_({}).isError();
+{
+ let value: Error|string = "error";
+ if (_.isError(value)) {
+ let message: string = value.message;
+ } else {
+ let message: string = value;
+ }
+}
// _.isFinite
result = <boolean>_.isFinite(any);
@@ -1939,6 +3559,14 @@ result = <boolean>_.isFunction(any);
result = <boolean>_(1).isFunction();
result = <boolean>_<any>([]).isFunction();
result = <boolean>_({}).isFunction();
+{
+ let value: Function|string = "foo";
+ if (_.isFunction(value)) {
+ value();
+ } else {
+ let result: string = value;
+ }
+}
// _.isMatch
var testIsMatchCustiomizerFn: (value: any, other: any, indexOrKey: number|string) => boolean;
@@ -1960,6 +3588,14 @@ result = <boolean>_(undefined).isNaN();
// _.isNative
result = <boolean>_.isNative(Array.prototype.push);
result = <boolean>_(Array.prototype.push).isNative();
+{
+ let value: Function|string = "foo";
+ if (_.isNative(value)) {
+ value();
+ } else {
+ let result: string = value;
+ }
+}
// _.isNull
result = <boolean>_.isNull(any);
@@ -1972,6 +3608,14 @@ result = <boolean>_.isNumber(any);
result = <boolean>_(1).isNumber();
result = <boolean>_<any>([]).isNumber();
result = <boolean>_({}).isNumber();
+{
+ let value: number|string = "foo";
+ if (_.isNumber(value)) {
+ let result: number = value * 42;
+ } else {
+ let result: string = value;
+ }
+}
// _.isObject
result = <boolean>_.isObject(any);
@@ -1990,12 +3634,29 @@ result = <boolean>_.isRegExp(any);
result = <boolean>_(1).isRegExp();
result = <boolean>_<any>([]).isRegExp();
result = <boolean>_({}).isRegExp();
+{
+ let value: RegExp|string = /^foo$/g;
+ if (_.isRegExp(value)) {
+ let regex: RegExp = value;
+ let index: number = value.exec("foo").index;
+ } else {
+ let result: string = value;
+ }
+}
// _.isString
result = <boolean>_.isString(any);
result = <boolean>_(1).isString();
result = <boolean>_<any>([]).isString();
result = <boolean>_({}).isString();
+{
+ let value: string|number = "foo";
+ if (_.isString(value)) {
+ let result: string = value;
+ } else {
+ let result: number = value * 42;
+ }
+}
// _.isTypedArray
result = <boolean>_.isTypedArray([]);
@@ -2019,37 +3680,367 @@ 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
-result = <Object>_.toPlainObject();
-result = <Object>_.toPlainObject(true);
-result = <Object>_.toPlainObject(1);
-result = <Object>_.toPlainObject('a');
-result = <Object>_.toPlainObject([]);
-result = <Object>_.toPlainObject({});
-result = <Object>_(true).toPlainObject();
-result = <Object>_(1).toPlainObject();
-result = <Object>_('a').toPlainObject();
-result = <Object>_([1]).toPlainObject();
-result = <Object>_<string>([]).toPlainObject();
-result = <Object>_({}).toPlainObject();
+module TestToPlainObject {
+ let result: TResult;
+
+ result = _.toPlainObject<TResult>();
+ result = _.toPlainObject<TResult>(true);
+ result = _.toPlainObject<TResult>(1);
+ result = _.toPlainObject<TResult>('a');
+ result = _.toPlainObject<TResult>([]);
+ result = _.toPlainObject<TResult>({});
+
+ result = _(true).toPlainObject<TResult>().value();
+ result = _(1).toPlainObject<TResult>().value();
+ result = _('a').toPlainObject<TResult>().value();
+ result = _([1]).toPlainObject<TResult>().value();
+ result = _<string>([]).toPlainObject<TResult>().value();
+ result = _({}).toPlainObject<TResult>().value();
+}
/********
* Math *
********/
// _.add
-result = <number>_.add(1, 1);
-result = <number>_(1).add(1);
+module TestAdd {
+ {
+ let result: number;
+
+ result = _.add(1, 1);
+ result = _(1).add(1);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(1).chain().add(1);
+ }
+}
+
+// _.ceil
+module TestCeil {
+ {
+ let result: number;
+
+ result = _.ceil(6.004);
+ result = _.ceil(6.004, 2);
+
+ result = _(6.004).ceil();
+ result = _(6.004).ceil(2);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(6.004).chain().ceil();
+ result = _(6.004).chain().ceil(2);
+ }
+}
+
+// _.floor
+module TestFloor {
+ {
+ let result: number;
+
+ result = _.floor(4.006);
+ result = _.floor(0.046, 2);
+ result = _.floor(4060, -2);
+
+ result = _(4.006).floor();
+ result = _(0.046).floor(2);
+ result = _(4060).floor(-2);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(4.006).chain().floor();
+ result = _(0.046).chain().floor(2);
+ result = _(4060).chain().floor(-2);
+ }
+}
+
+// _.max
+module TestMax {
+ let array: number[];
+ let list: _.List<number>;
+ let dictionary: _.Dictionary<number>;
+
+ let listIterator: (value: number, index: number, collection: _.List<number>) => number;
+ let dictionaryIterator: (value: number, key: string, collection: _.Dictionary<number>) => number;
+
+ let result: number;
+
+ result = _.max<number>(array);
+ result = _.max<number>(array, listIterator);
+ result = _.max<number>(array, listIterator, any);
+ result = _.max<number>(array, '');
+ result = _.max<{a: number}, number>(array, {a: 42});
+
+ result = _.max<number>(list);
+ result = _.max<number>(list, listIterator);
+ result = _.max<number>(list, listIterator, any);
+ result = _.max<number>(list, '');
+ result = _.max<{a: number}, number>(list, {a: 42});
+
+ result = _.max<number>(dictionary);
+ result = _.max<number>(dictionary, dictionaryIterator);
+ result = _.max<number>(dictionary, dictionaryIterator, any);
+ result = _.max<number>(dictionary, '');
+ result = _.max<{a: number}, number>(dictionary, {a: 42});
+
+ result = _(array).max();
+ result = _(array).max(listIterator);
+ result = _(array).max(listIterator, any);
+ result = _(array).max('');
+ result = _(array).max<{a: number}>({a: 42});
+
+ result = _(list).max<number>();
+ result = _(list).max<number>(listIterator);
+ result = _(list).max<number>(listIterator, any);
+ result = _(list).max<number>('');
+ result = _(list).max<{a: number}, number>({a: 42});
+
+ result = _(dictionary).max<number>();
+ result = _(dictionary).max<number>(dictionaryIterator);
+ result = _(dictionary).max<number>(dictionaryIterator, any);
+ result = _(dictionary).max<number>('');
+ result = _(dictionary).max<{a: number}, number>({a: 42});
+}
+
+// _.min
+module TestMin {
+ let array: number[];
+ let list: _.List<number>;
+ let dictionary: _.Dictionary<number>;
+
+ let listIterator: (value: number, index: number, collection: _.List<number>) => number;
+ let dictionaryIterator: (value: number, key: string, collection: _.Dictionary<number>) => number;
+
+ let result: number;
+
+ result = _.min<number>(array);
+ result = _.min<number>(array, listIterator);
+ result = _.min<number>(array, listIterator, any);
+ result = _.min<number>(array, '');
+ result = _.min<{a: number}, number>(array, {a: 42});
+
+ result = _.min<number>(list);
+ result = _.min<number>(list, listIterator);
+ result = _.min<number>(list, listIterator, any);
+ result = _.min<number>(list, '');
+ result = _.min<{a: number}, number>(list, {a: 42});
+
+ result = _.min<number>(dictionary);
+ result = _.min<number>(dictionary, dictionaryIterator);
+ result = _.min<number>(dictionary, dictionaryIterator, any);
+ result = _.min<number>(dictionary, '');
+ result = _.min<{a: number}, number>(dictionary, {a: 42});
+
+ result = _(array).min();
+ result = _(array).min(listIterator);
+ result = _(array).min(listIterator, any);
+ result = _(array).min('');
+ result = _(array).min<{a: number}>({a: 42});
+
+ result = _(list).min<number>();
+ result = _(list).min<number>(listIterator);
+ result = _(list).min<number>(listIterator, any);
+ result = _(list).min<number>('');
+ result = _(list).min<{a: number}, number>({a: 42});
+
+ result = _(dictionary).min<number>();
+ result = _(dictionary).min<number>(dictionaryIterator);
+ result = _(dictionary).min<number>(dictionaryIterator, any);
+ result = _(dictionary).min<number>('');
+ result = _(dictionary).min<{a: number}, number>({a: 42});
+}
+
+// _.round
+module TestRound {
+ {
+ let result: number;
+
+ result = _.round(4.006);
+ result = _.round(4.006, 2);
+
+ result = _(4.006).round();
+ result = _(4.006).round(2);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(4.006).chain().round();
+ result = _(4.006).chain().round(2);
+ }
+}
+
+// _.sum
+module TestSum {
+ let array: number[];
+ let list: _.List<number>;
+ let dictionary: _.Dictionary<number>;
+
+ let listIterator: (value: number, index: number, collection: _.List<number>) => number;
+ let dictionaryIterator: (value: number, key: string, collection: _.Dictionary<number>) => number;
+
+ {
+ let result: number;
+
+ result = _.sum(array);
+ result = _.sum<number>(array);
+ result = _.sum<number>(array, listIterator);
+ result = _.sum<number>(array, listIterator, any);
+ result = _.sum<number>(array, '');
+
+
+ result = _.sum(list);
+ result = _.sum<number>(list);
+ result = _.sum<number>(list, listIterator);
+ result = _.sum<number>(list, listIterator, any);
+ result = _.sum<number>(list, '');
+
+ result = _.sum(dictionary);
+ result = _.sum<number>(dictionary);
+ result = _.sum<number>(dictionary, dictionaryIterator);
+ result = _.sum<number>(dictionary, dictionaryIterator, any);
+ result = _.sum<number>(dictionary, '');
+
+ result = _(array).sum();
+ result = _(array).sum(listIterator);
+ result = _(array).sum(listIterator, any);
+ result = _(array).sum('');
+
+
+ result = _(list).sum();
+ result = _(list).sum<number>(listIterator);
+ result = _(list).sum<number>(listIterator, any);
+ result = _(list).sum('');
+
+ result = _(dictionary).sum();
+ result = _(dictionary).sum<number>(dictionaryIterator);
+ result = _(dictionary).sum<number>(dictionaryIterator, any);
+ result = _(dictionary).sum('');
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(array).chain().sum();
+ result = _(array).chain().sum(listIterator);
+ result = _(array).chain().sum(listIterator, any);
+ result = _(array).chain().sum('');
+
+
+ result = _(list).chain().sum();
+ result = _(list).chain().sum<number>(listIterator);
+ result = _(list).chain().sum<number>(listIterator, any);
+ result = _(list).chain().sum('');
+
+ result = _(dictionary).chain().sum();
+ result = _(dictionary).chain().sum<number>(dictionaryIterator);
+ result = _(dictionary).chain().sum<number>(dictionaryIterator, any);
+ result = _(dictionary).chain().sum('');
+ }
+}
/**********
* Number *
**********/
// _.inRange
-result = <boolean>_.inRange(3, 2, 4);
-result = <boolean>_.inRange(4, 8);
-result = <boolean>_(3).inRange(2, 4);
-result = <boolean>_(4).inRange(8);
+module TestInRange {
+ {
+ let result: boolean;
+
+ result = _.inRange(3, 2, 4);
+ result = _.inRange(4, 8);
+
+ result = _(3).inRange(2, 4);
+ result = _(4).inRange(8);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _(3).chain().inRange(2, 4);
+ result = _(4).chain().inRange(8);
+ }
+}
+
+// _.random
+module TestRandom {
+ {
+ let result: number;
+
+ result = _.random();
+ result = _.random(1);
+ result = _.random(1, 2);
+ result = _.random(1, 2, true);
+ result = _.random(1, true);
+ result = _.random(true);
+
+ result = _(1).random();
+ result = _(1).random(2);
+ result = _(1).random(2, true);
+ result = _(1).random(true);
+ result = _(true).random();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _(1).chain().random();
+ result = _(1).chain().random(2);
+ result = _(1).chain().random(2, true);
+ result = _(1).chain().random(true);
+ result = _(true).chain().random();
+ }
+}
/*********
* Object *
@@ -2063,8 +4054,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;
});
@@ -2073,8 +4064,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;
});
@@ -2103,7 +4094,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 {
@@ -2158,15 +4149,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);
});
@@ -2174,7 +4202,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);
});
@@ -2188,7 +4216,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);
});
@@ -2196,15 +4224,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');
@@ -2240,31 +4268,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,
@@ -2326,41 +4329,51 @@ module TestMapKeys {
result = _(dictionary).mapKeys<TResult, {}>({}).value();
}
-var mergeNames = {
- 'stooges': [
- { 'name': 'moe' },
- { 'name': 'larry' }
- ]
-};
+// _.merge
+module TestMerge {
+ let customizer: (value: any, srcValue: any, key?: string, object?: {}, source?: {}) => any;
+ let result: TResult;
-var mergeAges = {
- 'stooges': [
- { 'age': 40 },
- { 'age': 50 }
- ]
-};
+ result = _.merge<{}, {}, TResult>({}, {});
+ result = _.merge<{}, {}, TResult>({}, {}, customizer);
+ result = _.merge<{}, {}, TResult>({}, {}, customizer, any);
-result = <NameAge>_.merge(mergeNames, mergeAges);
+ result = _.merge<{}, {}, {}, TResult>({}, {}, {});
+ result = _.merge<{}, {}, {}, TResult>({}, {}, {}, customizer);
+ result = _.merge<{}, {}, {}, TResult>({}, {}, {}, customizer, any);
-var mergeFood = {
- 'fruits': ['apple'],
- 'vegetables': ['beet']
-};
+ result = _.merge<{}, {}, {}, {}, TResult>({}, {}, {}, {});
+ result = _.merge<{}, {}, {}, {}, TResult>({}, {}, {}, {}, customizer);
+ result = _.merge<{}, {}, {}, {}, TResult>({}, {}, {}, {}, customizer, any);
-var mergeOtherFood: { [index: string]: string[] } = {
- 'fruits': ['banana'],
- 'vegetables': ['carrot']
-};
+ result = _.merge<{}, {}, {}, {}, {}, TResult>({}, {}, {}, {}, {});
+ result = _.merge<{}, {}, {}, {}, {}, TResult>({}, {}, {}, {}, {}, customizer);
+ result = _.merge<{}, {}, {}, {}, {}, TResult>({}, {}, {}, {}, {}, customizer, any);
-interface FruitVeg {
- [index: string]: string[];
- fruits: string[];
- vegetables: string[]
-};
+ result = _.merge<{}, TResult>({}, {}, {}, {}, {}, {});
+ result = _.merge<{}, TResult>({}, {}, {}, {}, {}, {}, customizer);
+ result = _.merge<{}, TResult>({}, {}, {}, {}, {}, {}, customizer, any);
-result = <FruitVeg[]>_.merge(<FruitVeg>mergeFood, <FruitVeg>mergeOtherFood, function (a: any, b: any) {
- return _.isArray(a) ? a.concat(b) : undefined;
-});
+ result = _({}).merge<{}, TResult>({}).value();
+ result = _({}).merge<{}, TResult>({}, customizer).value();
+ result = _({}).merge<{}, TResult>({}, customizer, any).value();
+
+ result = _({}).merge<{}, {}, TResult>({}, {}).value();
+ result = _({}).merge<{}, {}, TResult>({}, {}, customizer).value();
+ result = _({}).merge<{}, {}, TResult>({}, {}, customizer, any).value();
+
+ result = _({}).merge<{}, {}, {}, TResult>({}, {}, {}).value();
+ result = _({}).merge<{}, {}, {}, TResult>({}, {}, {}, customizer).value();
+ result = _({}).merge<{}, {}, {}, TResult>({}, {}, {}, customizer, any).value();
+
+ result = _({}).merge<{}, {}, {}, {}, TResult>({}, {}, {}, {}).value();
+ result = _({}).merge<{}, {}, {}, {}, TResult>({}, {}, {}, {}, customizer).value();
+ result = _({}).merge<{}, {}, {}, {}, TResult>({}, {}, {}, {}, customizer, any).value();
+
+ result = _({}).merge<TResult>({}, {}, {}, {}, {}).value();
+ result = _({}).merge<TResult>({}, {}, {}, {}, {}, customizer).value();
+ result = _({}).merge<TResult>({}, {}, {}, {}, {}, customizer, any).value();
+}
interface HasName {
name: string;
@@ -2510,31 +4523,6 @@ result = <number[]>_(new TestValueIn()).valuesIn<number>().value();
* Utility *
***********/
-// _.attempt
-interface TestAttemptFn {
- (): TResult;
-}
-var testAttempFn: TestAttemptFn;
-result = <TResult|Error>_.attempt<TResult>(testAttempFn);
-result = <TResult|Error>_(testAttempFn).attempt<TResult>();
-
-result = <number>_.random(0, 5);
-result = <number>_.random(5);
-result = <number>_.random(5, true);
-result = <number>_.random(1.2, 5.2);
-result = <number>_.random(0, 5, true);
-
-// _.noop
-result = <void>_.noop();
-result = <void>_.noop(1);
-result = <void>_.noop('a', 1);
-result = <void>_.noop(true, 'a', 1);
-result = <void>_('a').noop(true, 'a', 1);
-result = <void>_([1]).noop(true, 'a', 1);
-result = <void>_<string>([]).noop(true, 'a', 1);
-result = <void>_({}).noop(true, 'a', 1);
-result = <void>_(any).noop(true, 'a', 1);
-
// _.property
interface TestPropertyObject {
a: {
@@ -2548,15 +4536,34 @@ result = <number>(_('a.b').property<TestPropertyObject, number>().value())(testP
result = <number>(_(['a', 'b']).property<TestPropertyObject, number>().value())(testPropertyObject);
// _.propertyOf
-interface TestPropertyOfObject {
- a: {
- b: number[];
+module TestPropertyOf {
+ interface SampleObject {
+ a: {
+ b: number[];
+ }
+ }
+
+ let object: SampleObject;
+
+ {
+ let result: (path: string|string[]) => any;
+
+ result = _.propertyOf({});
+ result = _.propertyOf<SampleObject>(object);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(path: string|string[]) => any>;
+
+ result = _({}).propertyOf();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(path: string|string[]) => any>;
+
+ result = _({}).chain().propertyOf();
}
}
-var testPropertyOfObject: TestPropertyOfObject;
-result = <(path: string|string[]) => any>_.propertyOf({});
-result = <(path: string|string[]) => any>_.propertyOf<TestPropertyOfObject>(testPropertyOfObject);
-result = <(path: string|string[]) => any>_({}).propertyOf().value();
// _.range
result = <number[]>_.range(10);
@@ -2581,102 +4588,314 @@ class Mage {
*********/
// _.camelCase
-result = <string>_.camelCase('Foo Bar');
-result = <string>_('Foo Bar').camelCase();
+module TestCamelCase {
+ {
+ let result: string;
+
+ result = _.camelCase('Foo Bar');
+ result = _('Foo Bar').camelCase();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('Foo Bar').chain().camelCase();
+ }
+}
// _.capitalize
-result = <string>_.capitalize('fred');
-result = <string>_('fred').capitalize();
+module TestCapitalize {
+ {
+ let result: string;
+
+ result = _.capitalize('fred');
+ result = _('fred').capitalize();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('fred').chain().capitalize();
+ }
+}
// _.deburr
-result = <string>_.deburr('déjà vu');
-result = <string>_('déjà vu').deburr();
+module TestDeburr {
+ {
+ let result: string;
+
+ result = _.deburr('déjà vu');
+ result = _('déjà vu').deburr();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('déjà vu').chain().deburr();
+ }
+}
// _.endsWith
-result = <boolean>_.endsWith('abc', 'c');
-result = <boolean>_.endsWith('abc', 'c', 1);
-result = <boolean>_('abc').endsWith('c');
-result = <boolean>_('abc').endsWith('c', 1);
+module TestEndsWith {
+ {
+ let result: boolean;
+
+ result = _.endsWith('abc', 'c');
+ result = _.endsWith('abc', 'c', 1);
+
+ result = _('abc').endsWith('c');
+ result = _('abc').endsWith('c', 1);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _('abc').chain().endsWith('c');
+ result = _('abc').chain().endsWith('c', 1);
+ }
+}
// _.escape
-result = <string>_.escape('fred, barney, & pebbles');
-result = <string>_('fred, barney, & pebbles').escape();
+module TestEscape {
+ {
+ let result: string;
+
+ result = _.escape('fred, barney, & pebbles');
+ result = _('fred, barney, & pebbles').escape();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('fred, barney, & pebbles').chain().escape();
+ }
+}
// _.escapeRegExp
-result = <string>_.escapeRegExp('[lodash](https://lodash.com/)');
-result = <string>_('[lodash](https://lodash.com/)').escapeRegExp();
+module TestEscapeRegExp {
+ {
+ let result: string;
+
+ result = _.escapeRegExp('[lodash](https://lodash.com/)');
+ result = _('[lodash](https://lodash.com/)').escapeRegExp();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('[lodash](https://lodash.com/)').chain().escapeRegExp();
+ }
+}
// _.kebabCase
-result = <string>_.kebabCase('Foo Bar');
-result = <string>_('Foo Bar').kebabCase();
+module TestKebabCase {
+ {
+ let result: string;
+
+ result = _.kebabCase('Foo Bar');
+ result = _('Foo Bar').kebabCase();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('Foo Bar').chain().kebabCase();
+ }
+}
// _.pad
-result = <string>_.pad('abd');
-result = <string>_.pad('abc', 8);
-result = <string>_.pad('abc', 8, '_-');
-result = <string>_('abc').pad();
-result = <string>_('abc').pad(8);
-result = <string>_('abc').pad(8, '_-');
+module TestPad {
+ {
+ let result: string;
+
+ result = _.pad('abd');
+ result = _.pad('abc', 8);
+ result = _.pad('abc', 8, '_-');
+
+ result = _('abc').pad();
+ result = _('abc').pad(8);
+ result = _('abc').pad(8, '_-');
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('abc').chain().pad();
+ result = _('abc').chain().pad(8);
+ result = _('abc').chain().pad(8, '_-');
+ }
+}
// _.padLeft
-result = <string>_.padLeft('abc');
-result = <string>_.padLeft('abc', 6);
-result = <string>_.padLeft('abc', 6, '_-');
-result = <string>_('abc').padLeft();
-result = <string>_('abc').padLeft(6);
-result = <string>_('abc').padLeft(6, '_-');
+module TestPadLeft {
+ {
+ let result: string;
+
+ result = _.padLeft('abc');
+ result = _.padLeft('abc', 6);
+ result = _.padLeft('abc', 6, '_-');
+
+ result = _('abc').padLeft();
+ result = _('abc').padLeft(6);
+ result = _('abc').padLeft(6, '_-');
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('abc').chain().padLeft();
+ result = _('abc').chain().padLeft(6);
+ result = _('abc').chain().padLeft(6, '_-');
+ }
+}
// _.padRight
-result = <string>_.padRight('abc');
-result = <string>_.padRight('abc', 6);
-result = <string>_.padRight('abc', 6, '_-');
-result = <string>_('abc').padRight();
-result = <string>_('abc').padRight(6);
-result = <string>_('abc').padRight(6, '_-');
+module TestPadRight {
+ {
+ let result: string;
+
+ result = _.padRight('abc');
+ result = _.padRight('abc', 6);
+ result = _.padRight('abc', 6, '_-');
+
+ result = _('abc').padRight();
+ result = _('abc').padRight(6);
+ result = _('abc').padRight(6, '_-');
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('abc').chain().padRight();
+ result = _('abc').chain().padRight(6);
+ result = _('abc').chain().padRight(6, '_-');
+ }
+}
+
// _.parseInt
-result = <number>_.parseInt('08');
-result = <number>_.parseInt('08', 10);
-result = <number>_('08').parseInt();
-result = <number>_('08').parseInt(10);
+module TestParseInt {
+ {
+ let result: number;
+
+ result = _.parseInt('08');
+ result = _.parseInt('08', 10);
+
+ result = _('08').parseInt();
+ result = _('08').parseInt(10);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<number>;
+
+ result = _('08').chain().parseInt();
+ result = _('08').chain().parseInt(10);
+ }
+}
// _.repeat
-result = <string>_.repeat('*', 3);
-result = <string>_('*').repeat(3);
+module TestRepeat {
+ {
+ let result: string;
+ result = _.repeat('*');
+ result = _.repeat('*', 3);
+
+ result = _('*').repeat();
+ result = _('*').repeat(3);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('*').chain().repeat();
+ result = _('*').chain().repeat(3);
+ }
+}
// _.snakeCase
-result = <string>_.snakeCase('Foo Bar');
-result = <string>_('Foo Bar').snakeCase();
+module TestSnakeCase {
+ {
+ let result: string;
+
+ result = _.snakeCase('Foo Bar');
+ result = _('Foo Bar').snakeCase();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('Foo Bar').chain().snakeCase();
+ }
+}
// _.startCase
-result = <string>_.startCase('--foo-bar');
-result = <string>_('--foo-bar').startCase();
+module TestStartCase {
+ {
+ let result: string;
+
+ result = _.startCase('--foo-bar');
+ result = _('--foo-bar').startCase();
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('--foo-bar').chain().startCase();
+ }
+}
// _.startsWith
-result = <boolean>_.startsWith('abc', 'a');
-result = <boolean>_.startsWith('abc', 'a', 1);
-result = <boolean>_('abc').startsWith('a');
-result = <boolean>_('abc').startsWith('a', 1);
+module TestStartsWith {
+ {
+ let result: boolean;
+
+ result = _.startsWith('abc', 'a');
+ result = _.startsWith('abc', 'a', 1);
+
+ result = _('abc').startsWith('a');
+ result = _('abc').startsWith('a', 1);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<boolean>;
+
+ result = _('abc').chain().startsWith('a');
+ result = _('abc').chain().startsWith('a', 1);
+ }
+}
// _.template
-interface TestTemplateOptions {
- escape?: RegExp;
- evaluate?: RegExp;
- imports?: _.Dictionary<any>;
- interpolate?: RegExp;
- variable?: string;
-}
-interface TestTemplateExecutor {
- (obj?: Object): string;
- source: string;
-}
-{
- let testTemplateOptions: TestTemplateOptions
- let result: TestTemplateExecutor;
- result = _.template('');
- result = _.template('', testTemplateOptions);
- result = _('').template();
- result = _('').template(testTemplateOptions);
+module TestTemplate {
+ interface TemplateExecutor {
+ (obj?: Object): string;
+ source: string;
+ }
+
+ let options: {
+ escape?: RegExp;
+ evaluate?: RegExp;
+ imports?: _.Dictionary<any>;
+ interpolate?: RegExp;
+ sourceURL?: string;
+ variable?: string;
+ };
+
+ {
+ let result: TemplateExecutor;
+
+ result = _.template('');
+ result = _.template('', options);
+
+ result = _('').template();
+ result = _('').template(options);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<TemplateExecutor>;
+
+ result = _('').chain().template();
+ result = _('').chain().template(options);
+ }
}
// _.trim
@@ -2687,11 +4906,25 @@ result = <string>_('-_-abc-_-').trim();
result = <string>_('-_-abc-_-').trim('_-');
// _.trimLeft
-result = <string>_.trimLeft();
-result = <string>_.trimLeft(' abc ');
-result = <string>_.trimLeft('-_-abc-_-', '_-');
-result = <string>_('-_-abc-_-').trimLeft();
-result = <string>_('-_-abc-_-').trimLeft('_-');
+module TestTrimLeft {
+ {
+ let result: string;
+
+ result = _.trimLeft();
+ result = _.trimLeft(' abc ');
+ result = _.trimLeft('-_-abc-_-', '_-');
+
+ result = _('-_-abc-_-').trimLeft();
+ result = _('-_-abc-_-').trimLeft('_-');
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('-_-abc-_-').chain().trimLeft();
+ result = _('-_-abc-_-').chain().trimLeft('_-');
+ }
+}
// _.trimRight
result = <string>_.trimRight();
@@ -2701,65 +4934,223 @@ result = <string>_('-_-abc-_-').trimRight();
result = <string>_('-_-abc-_-').trimRight('_-');
// _.trunc
-result = <string>_.trunc('hi-diddly-ho there, neighborino');
-result = <string>_.trunc('hi-diddly-ho there, neighborino', 24);
-result = <string>_.trunc('hi-diddly-ho there, neighborino', { 'length': 24, 'separator': ' ' });
-result = <string>_.trunc('hi-diddly-ho there, neighborino', { 'length': 24, 'separator': /,? +/ });
-result = <string>_.trunc('hi-diddly-ho there, neighborino', { 'omission': ' […]' });
-result = <string>_('hi-diddly-ho there, neighborino').trunc();
-result = <string>_('hi-diddly-ho there, neighborino').trunc(24);
-result = <string>_('hi-diddly-ho there, neighborino').trunc({ 'length': 24, 'separator': ' ' });
-result = <string>_('hi-diddly-ho there, neighborino').trunc({ 'length': 24, 'separator': /,? +/ });
-result = <string>_('hi-diddly-ho there, neighborino').trunc({ 'omission': ' […]' });
+module TestTrunc {
+ {
+ let result: string;
+
+ result = _.trunc('hi-diddly-ho there, neighborino');
+ result = _.trunc('hi-diddly-ho there, neighborino', 24);
+ result = _.trunc('hi-diddly-ho there, neighborino', { 'length': 24, 'separator': ' ' });
+ result = _.trunc('hi-diddly-ho there, neighborino', { 'length': 24, 'separator': /,? +/ });
+ result = _.trunc('hi-diddly-ho there, neighborino', { 'omission': ' […]' });
+
+ result = _('hi-diddly-ho there, neighborino').trunc();
+ result = _('hi-diddly-ho there, neighborino').trunc(24);
+ result = _('hi-diddly-ho there, neighborino').trunc({ 'length': 24, 'separator': ' ' });
+ result = _('hi-diddly-ho there, neighborino').trunc({ 'length': 24, 'separator': /,? +/ });
+ result = _('hi-diddly-ho there, neighborino').trunc({ 'omission': ' […]' });
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<string>;
+
+ result = _('hi-diddly-ho there, neighborino').chain().trunc();
+ result = _('hi-diddly-ho there, neighborino').chain().trunc(24);
+ result = _('hi-diddly-ho there, neighborino').chain().trunc({ 'length': 24, 'separator': ' ' });
+ result = _('hi-diddly-ho there, neighborino').chain().trunc({ 'length': 24, 'separator': /,? +/ });
+ result = _('hi-diddly-ho there, neighborino').chain().trunc({ 'omission': ' […]' });
+ }
+}
// _.unescape
result = <string>_.unescape('fred, barney, & pebbles');
result = <string>_('fred, barney, & pebbles').unescape();
// _.words
-result = <string[]>_.words('fred, barney, & pebbles');
-result = <string[]>_.words('fred, barney, & pebbles', /[^, ]+/g);
-result = <string[]>_('fred, barney, & pebbles').words();
-result = <string[]>_('fred, barney, & pebbles').words(/[^, ]+/g);
+module TestWords {
+ {
+ let result: string[];
+
+ result = _.words('fred, barney, & pebbles');
+ result = _.words('fred, barney, & pebbles', /[^, ]+/g);
+
+ result = _('fred, barney, & pebbles').words();
+ result = _('fred, barney, & pebbles').words(/[^, ]+/g);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<string>;
+
+ result = _('fred, barney, & pebbles').chain().words();
+ result = _('fred, barney, & pebbles').chain().words(/[^, ]+/g);
+ }
+}
/***********
* Utility *
***********/
+// _.attempt
+module TestAttempt {
+ let func: (...args: any[]) => {a: string};
+
+ {
+ let result: {a: string}|Error;
+
+ result = _.attempt<{a: string}>(func);
+ result = _(func).attempt<{a: string}>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<{a: string}|Error>;
+
+ result = _(func).chain().attempt<{a: string}>();
+ }
+}
+
// _.callback
-{
- let result: (...args: any[]) => TResult;
- result = _.callback<TResult>(Function);
- result = _.callback<TResult>(Function, any);
- result = _(Function).callback<TResult>().value();
- result = _(Function).callback<TResult>(any).value();
-}
-{
- let result: (object: any) => TResult;
- result = _.callback<TResult>('');
- result = _.callback<TResult>('', any);
- result = _('').callback<TResult>().value();
- result = _('').callback<TResult>(any).value();
-}
-{
- let result: (object: any) => boolean;
- result = _.callback({});
- result = _.callback({}, any);
- result = _({}).callback().value();
- result = _({}).callback(any).value();
+module TestCallback {
+ {
+ let result: (...args: any[]) => TResult;
+
+ result = _.callback<TResult>(Function);
+ result = _.callback<TResult>(Function, any);
+ }
+
+ {
+ let result: (object: any) => TResult;
+
+ result = _.callback<TResult>('');
+ result = _.callback<TResult>('', any);
+ }
+
+ {
+ let result: (object: any) => boolean;
+
+ result = _.callback({});
+ result = _.callback({}, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(...args: any[]) => TResult>;
+
+ result = _(Function).callback<TResult>();
+ result = _(Function).callback<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(object: any) => TResult>;
+
+ result = _('').callback<TResult>();
+ result = _('').callback<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(object: any) => boolean>;
+
+ result = _({}).callback();
+ result = _({}).callback(any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(...args: any[]) => TResult>;
+
+ result = _(Function).chain().callback<TResult>();
+ result = _(Function).chain().callback<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(object: any) => TResult>;
+
+ result = _('').chain().callback<TResult>();
+ result = _('').chain().callback<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(object: any) => boolean>;
+
+ result = _({}).chain().callback();
+ result = _({}).chain().callback(any);
+ }
}
// _.constant
-result = <() => number>_.constant<number>(1);
-result = <() => string>_.constant<string>('a');
-result = <() => boolean>_.constant<boolean>(true);
-result = <() => any[]>_.constant<any[]>([]);
-result = <() => {}>_.constant<{}>({});
-result = <() => number>_(1).constant<number>();
-result = <() => string>_('a').constant<string>();
-result = <() => boolean>_(true).constant<boolean>();
-result = <() => any[]>_(['a']).constant<any[]>();
-result = <() => {}>_({}).constant<{}>();
+module TestConstant {
+ {
+ let result: () => number;
+ result: _.constant<number>(42);
+ }
+
+ {
+ let result: () => string;
+ result: _.constant<string>('a');
+ }
+
+ {
+ let result: () => boolean;
+ result: _.constant<boolean>(true);
+ }
+
+ {
+ let result: () => string[];
+ result: _.constant<string[]>(['a']);
+ }
+
+ {
+ let result: () => {a: string};
+ result: _.constant<{a: string}>({a: 'a'});
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<() => number>;
+ result: _(42).constant<number>();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<() => string>;
+ result: _('a').constant<string>();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<() => boolean>;
+ result: _(true).constant<boolean>();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<() => string[]>;
+ result: _(['a']).constant<string[]>();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<() => {a: string}>;
+ result: _({a: 'a'}).constant<{a: string}>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<() => number>;
+ result: _(42).chain().constant<number>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<() => string>;
+ result: _('a').chain().constant<string>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<() => boolean>;
+ result: _(true).chain().constant<boolean>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<() => string[]>;
+ result: _(['a']).chain().constant<string[]>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<() => {a: string}>;
+ result: _({a: 'a'}).chain().constant<{a: string}>();
+ }
+}
// _.identity
{
@@ -2778,26 +5169,69 @@ result = <() => {}>_({}).constant<{}>();
}
// _.iteratee
-{
- let result: (...args: any[]) => TResult;
- result = _.iteratee<TResult>(Function);
- result = _.iteratee<TResult>(Function, any);
- result = _(Function).iteratee<TResult>().value();
- result = _(Function).iteratee<TResult>(any).value();
-}
-{
- let result: (object: any) => TResult;
- result = _.iteratee<TResult>('');
- result = _.iteratee<TResult>('', any);
- result = _('').iteratee<TResult>().value();
- result = _('').iteratee<TResult>(any).value();
-}
-{
- let result: (object: any) => boolean;
- result = _.iteratee({});
- result = _.iteratee({}, any);
- result = _({}).iteratee().value();
- result = _({}).iteratee(any).value();
+module TestIteratee {
+ {
+ let result: (...args: any[]) => TResult;
+
+ result = _.iteratee<TResult>(Function);
+ result = _.iteratee<TResult>(Function, any);
+ }
+
+ {
+ let result: (object: any) => TResult;
+
+ result = _.iteratee<TResult>('');
+ result = _.iteratee<TResult>('', any);
+ }
+
+ {
+ let result: (object: any) => boolean;
+
+ result = _.iteratee({});
+ result = _.iteratee({}, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(...args: any[]) => TResult>;
+
+ result = _(Function).iteratee<TResult>();
+ result = _(Function).iteratee<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(object: any) => TResult>;
+
+ result = _('').iteratee<TResult>();
+ result = _('').iteratee<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(object: any) => boolean>;
+
+ result = _({}).iteratee();
+ result = _({}).iteratee(any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(...args: any[]) => TResult>;
+
+ result = _(Function).chain().iteratee<TResult>();
+ result = _(Function).chain().iteratee<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(object: any) => TResult>;
+
+ result = _('').chain().iteratee<TResult>();
+ result = _('').chain().iteratee<TResult>(any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(object: any) => boolean>;
+
+ result = _({}).chain().iteratee();
+ result = _({}).chain().iteratee(any);
+ }
}
// _.matches
@@ -2807,13 +5241,21 @@ module TestMatches {
{
let result: (value: any) => boolean;
result = _.matches<TResult>(source);
- result = _(source).matches().value();
}
{
let result: (value: TResult) => boolean;
result = _.matches<TResult, TResult>(source);
- result = _(source).matches<TResult>().value();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(value: TResult) => boolean>;
+ result = _(source).matches<TResult>();
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(value: TResult) => boolean>;
+ result = _(source).chain().matches<TResult>();
}
}
@@ -2824,28 +5266,127 @@ module TestMatches {
{
let result: (value: any) => boolean;
+
result = _.matchesProperty<TResult>(path, source);
- result = _(path).matchesProperty<TResult>(source).value();
}
{
let result: (value: TResult) => boolean;
+
result = _.matchesProperty<TResult, TResult>(path, source);
- result = _(path).matchesProperty<TResult, TResult>(source).value();
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(value: any) => boolean>;
+
+ result = _(path).matchesProperty<TResult>(source);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(value: TResult) => boolean>;
+
+ result = _(path).matchesProperty<TResult, TResult>(source);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(value: any) => boolean>;
+
+ result = _(path).chain().matchesProperty<TResult>(source);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(value: TResult) => boolean>;
+
+ result = _(path).chain().matchesProperty<TResult, TResult>(source);
}
}
// _.method
-class TestMethod {
- a = {
- b: (a1: number, a2: number) => a1 + a2
+module TestMethod {
+ {
+ let result: (object: any) => {a: string};
+
+ result = _.method<{a: string}>('a.0');
+ result = _.method<{a: string}>('a.0', any);
+ result = _.method<{a: string}>('a.0', any, any);
+ result = _.method<{a: string}>('a.0', any, any, any);
+
+ result = _.method<{a: string}>(['a', 0]);
+ result = _.method<{a: string}>(['a', 0], any);
+ result = _.method<{a: string}>(['a', 0], any, any);
+ result = _.method<{a: string}>(['a', 0], any, any, any);
+ }
+
+ {
+ let result: (object: {a: string}) => {b: string};
+
+ result = _.method<{a: string}, {b: string}>('a.0');
+ result = _.method<{a: string}, {b: string}>('a.0', any);
+ result = _.method<{a: string}, {b: string}>('a.0', any, any);
+ result = _.method<{a: string}, {b: string}>('a.0', any, any, any);
+
+ result = _.method<{a: string}, {b: string}>(['a', 0]);
+ result = _.method<{a: string}, {b: string}>(['a', 0], any);
+ result = _.method<{a: string}, {b: string}>(['a', 0], any, any);
+ result = _.method<{a: string}, {b: string}>(['a', 0], any, any, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(object: any) => {a: string}>;
+
+ result = _('a.0').method<{a: string}>();
+ result = _('a.0').method<{a: string}>(any);
+ result = _('a.0').method<{a: string}>(any, any);
+ result = _('a.0').method<{a: string}>(any, any, any);
+
+ result = _(['a', 0]).method<{a: string}>();
+ result = _(['a', 0]).method<{a: string}>(any);
+ result = _(['a', 0]).method<{a: string}>(any, any);
+ result = _(['a', 0]).method<{a: string}>(any, any, any);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<(object: {a: string}) => {b: string}>;
+
+ result = _('a.0').method<{a: string}, {b: string}>();
+ result = _('a.0').method<{a: string}, {b: string}>(any);
+ result = _('a.0').method<{a: string}, {b: string}>(any, any);
+ result = _('a.0').method<{a: string}, {b: string}>(any, any, any);
+
+ result = _(['a', 0]).method<{a: string}, {b: string}>();
+ result = _(['a', 0]).method<{a: string}, {b: string}>(any);
+ result = _(['a', 0]).method<{a: string}, {b: string}>(any, any);
+ result = _(['a', 0]).method<{a: string}, {b: string}>(any, any, any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(object: any) => {a: string}>;
+
+ result = _('a.0').chain().method<{a: string}>();
+ result = _('a.0').chain().method<{a: string}>(any);
+ result = _('a.0').chain().method<{a: string}>(any, any);
+ result = _('a.0').chain().method<{a: string}>(any, any, any);
+
+ result = _(['a', 0]).chain().method<{a: string}>();
+ result = _(['a', 0]).chain().method<{a: string}>(any);
+ result = _(['a', 0]).chain().method<{a: string}>(any, any);
+ result = _(['a', 0]).chain().method<{a: string}>(any, any, any);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<(object: {a: string}) => {b: string}>;
+
+ result = _('a.0').chain().method<{a: string}, {b: string}>();
+ result = _('a.0').chain().method<{a: string}, {b: string}>(any);
+ result = _('a.0').chain().method<{a: string}, {b: string}>(any, any);
+ result = _('a.0').chain().method<{a: string}, {b: string}>(any, any, any);
+
+ result = _(['a', 0]).chain().method<{a: string}, {b: string}>();
+ result = _(['a', 0]).chain().method<{a: string}, {b: string}>(any);
+ result = _(['a', 0]).chain().method<{a: string}, {b: string}>(any, any);
+ result = _(['a', 0]).chain().method<{a: string}, {b: string}>(any, any, any);
}
}
-var TestMethodObject = new TestMethod();
-result = <number>(_.method<number>('a.b', 1, 2))(TestMethodObject);
-result = <number>(_.method<number>(['a', 'b'], 1, 2))(TestMethodObject);
-result = <number>(_('a.b').method<number>(1, 2).value())(TestMethodObject);
-result = <number>(_(['a', 'b']).method<number>(1, 2).value())(TestMethodObject);
// _.methodOf
class TestMethodOf {
@@ -2860,18 +5401,36 @@ result = <number>(_(TestMethodOfObject).methodOf<number>(1, 2).value())('a[0]');
result = <number>(_(TestMethodOfObject).methodOf<number>(1, 2).value())(['a', '0']);
// _.mixin
-{
- let testMixinSource: _.Dictionary<Function>;
- let testMixinOptions: {chain?: boolean;}
- let result: TResult;
- result = _.mixin<TResult, Object>({}, testMixinSource);
- result = _.mixin<TResult, Object>({}, testMixinSource, testMixinOptions);
- result = _.mixin<TResult>(testMixinSource);
- result = _.mixin<TResult>(testMixinSource, testMixinOptions);
- result = _({}).mixin<TResult>(testMixinSource).value();
- result = _({}).mixin<TResult>(testMixinSource, testMixinOptions).value();
- result = _(testMixinSource).mixin<TResult>().value();
- result = _(testMixinSource).mixin<TResult>(testMixinOptions).value();
+module TestMixin {
+ let source: _.Dictionary<Function>;
+ let options: {chain?: boolean};
+
+ {
+ let result: TResult;
+
+ result = _.mixin<TResult, Object>({}, source);
+ result = _.mixin<TResult, Object>({}, source, options);
+ result = _.mixin<TResult>(source);
+ result = _.mixin<TResult>(source, options);
+ }
+
+ {
+ let result: _.LoDashImplicitObjectWrapper<TResult>;
+
+ result = _({}).mixin<TResult>(source);
+ result = _({}).mixin<TResult>(source, options);
+ result = _(source).mixin<TResult>();
+ result = _(source).mixin<TResult>(options);
+ }
+
+ {
+ let result: _.LoDashExplicitObjectWrapper<TResult>;
+
+ result = _({}).chain().mixin<TResult>(source);
+ result = _({}).chain().mixin<TResult>(source, options);
+ result = _(source).chain().mixin<TResult>();
+ result = _(source).chain().mixin<TResult>(options);
+ }
}
// _.noConflict
@@ -2883,6 +5442,34 @@ result = <number>(_(TestMethodOfObject).methodOf<number>(1, 2).value())(['a', '0
result = _({}).noConflict();
}
+// _.noop
+module TestNoop {
+ {
+ let result: void;
+
+ result = _.noop();
+ result = _.noop(1);
+ result = _.noop('a', 1);
+ result = _.noop(true, 'a', 1);
+
+ result = _('a').noop(true, 'a', 1);
+ result = _([1]).noop(true, 'a', 1);
+ result = _<string>([]).noop(true, 'a', 1);
+ result = _({}).noop(true, 'a', 1);
+ result = _(any).noop(true, 'a', 1);
+ }
+
+ {
+ let result: _.LoDashExplicitWrapper<void>;
+
+ result = _('a').chain().noop(true, 'a', 1);
+ result = _([1]).chain().noop(true, 'a', 1);
+ result = _<string>([]).chain().noop(true, 'a', 1);
+ result = _({}).chain().noop(true, 'a', 1);
+ result = _(any).chain().noop(true, 'a', 1);
+ }
+}
+
// _.runInContext
{
let result: typeof _;
@@ -2891,6 +5478,50 @@ result = <number>(_(TestMethodOfObject).methodOf<number>(1, 2).value())(['a', '0
result = _({}).runInContext();
}
+// _.times
+module TestTimes {
+ let iteratee: (num: number) => TResult;
+
+ {
+ let result: number[];
+
+ result = _.times(42);
+ }
+
+ {
+ let result: TResult[];
+
+ result = _.times(42, iteratee);
+ result = _.times(42, iteratee, any);
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<number>;
+
+ result = _(42).times();
+ }
+
+ {
+ let result: _.LoDashImplicitArrayWrapper<TResult>;
+
+ result = _(42).times(iteratee);
+ result = _(42).times(iteratee, any);
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<number>;
+
+ result = _(42).chain().times();
+ }
+
+ {
+ let result: _.LoDashExplicitArrayWrapper<TResult>;
+
+ result = _(42).chain().times(iteratee);
+ result = _(42).chain().times(iteratee, any);
+ }
+}
+
// _.uniqueId
result = <string>_.uniqueId();
result = <string>_.uniqueId('');
@@ -2900,17 +5531,117 @@ result = <string>_.VERSION;
result = <_.Support>_.support;
result = <_.TemplateSettings>_.templateSettings;
-// _.times
+// _.partial & _.partialRight
{
- let result: number[];
- result = _.times(42);
- result = _(42).times().value();
-}
-{
- let testTimesFn: (num: number) => TResult;
- let result: TResult[];
- result = _.times(42, testTimesFn);
- result = _.times(42, testTimesFn, any);
- result = _(42).times(testTimesFn).value();
- result = _(42).times(testTimesFn, any).value();
+ function func0(): number {
+ return 42;
+ }
+ function func1(arg1: number): number {
+ return arg1 * 2;
+ }
+ function func2(arg1: number, arg2: string): number {
+ return arg1 * arg2.length;
+ }
+ function func3(arg1: number, arg2: string, arg3: boolean): number {
+ return arg1 * arg2.length + (arg3 ? 1 : 0);
+ }
+ function func4(arg1: number, arg2: string, arg3: boolean, arg4: number): number {
+ return arg1 * arg2.length + (arg3 ? 1 : 0) - arg4;
+ }
+ let res____: () => number;
+ let res1___: (arg1: number ) => number;
+ let res_2__: ( arg2: string ) => number;
+ let res__3_: ( arg3: boolean ) => number;
+ let res___4: ( arg4: number) => number;
+ let res12__: (arg1: number, arg2: string ) => number;
+ let res1_3_: (arg1: number, arg3: boolean ) => number;
+ let res1__4: (arg1: number, arg4: number) => number;
+ let res_23_: ( arg2: string, arg3: boolean ) => number;
+ let res_2_4: ( arg2: string, arg4: number) => number;
+ let res__34: ( arg3: boolean, arg4: number) => number;
+ let res123_: (arg1: number, arg2: string, arg3: boolean ) => number;
+ let res12_4: (arg1: number, arg2: string, arg4: number) => number;
+ let res1_34: (arg1: number, arg3: boolean, arg4: number) => number;
+ let res_234: ( arg2: string, arg3: boolean, arg4: number) => number;
+ let res1234: (arg1: number, arg2: string, arg3: boolean, arg4: number) => number;
+
+ //
+ // _.partial
+ //
+ // with arity 0 function
+ res____ = _.partial(func0);
+ // with arity 1 function
+ res____ = _.partial(func1, 42 );
+ res1___ = _.partial(func1 );
+ // with arity 2 function
+ res12__ = _.partial(func2 );
+ res_2__ = _.partial(func2, 42 );
+ res1___ = _.partial(func2, _, "foo");
+ res____ = _.partial(func2, 42, "foo");
+ // with arity 3 function
+ res123_ = _.partial(func3 );
+ res_23_ = _.partial(func3, 42 );
+ res1_3_ = _.partial(func3, _, "foo" );
+ res__3_ = _.partial(func3, 42, "foo" );
+ res12__ = _.partial(func3, _, _, true);
+ res_2__ = _.partial(func3, 42, _, true);
+ res1___ = _.partial(func3, _, "foo", true);
+ res____ = _.partial(func3, 42, "foo", true);
+ // with arity 4 function
+ res1234 = _.partial(func4 );
+ res_234 = _.partial(func4, 42 );
+ res1_34 = _.partial(func4, _, "foo" );
+ res__34 = _.partial(func4, 42, "foo" );
+ res12_4 = _.partial(func4, _, _, true );
+ res_2_4 = _.partial(func4, 42, _, true );
+ res1__4 = _.partial(func4, _, "foo", true );
+ res___4 = _.partial(func4, 42, "foo", true );
+ res123_ = _.partial(func4, _, _, _, 100);
+ res_23_ = _.partial(func4, 42, _, _, 100);
+ res1_3_ = _.partial(func4, _, "foo", _, 100);
+ res__3_ = _.partial(func4, 42, "foo", _, 100);
+ res12__ = _.partial(func4, _, _, true, 100);
+ res_2__ = _.partial(func4, 42, _, true, 100);
+ res1___ = _.partial(func4, _, "foo", true, 100);
+ res____ = _.partial(func4, 42, "foo", true, 100);
+
+ //
+ // _.partialRight
+ //
+ // with arity 0 function
+ res____ = _.partialRight(func0);
+ // with arity 1 function
+ res____ = _.partialRight(func1, 42 );
+ res1___ = _.partialRight(func1 );
+ // with arity 2 function
+ res12__ = _.partialRight(func2 );
+ res_2__ = _.partialRight(func2, 42, _);
+ res1___ = _.partialRight(func2, "foo");
+ res____ = _.partialRight(func2, 42, "foo");
+ // with arity 3 function
+ res123_ = _.partialRight(func3 );
+ res_23_ = _.partialRight(func3, 42, _, _);
+ res1_3_ = _.partialRight(func3, "foo", _);
+ res__3_ = _.partialRight(func3, 42, "foo", _);
+ res12__ = _.partialRight(func3, true);
+ res_2__ = _.partialRight(func3, 42, _, true);
+ res1___ = _.partialRight(func3, "foo", true);
+ res____ = _.partialRight(func3, 42, "foo", true);
+ // with arity 4 function
+ res1234 = _.partialRight(func4 );
+ res_234 = _.partialRight(func4, 42, _, _, _);
+ res1_34 = _.partialRight(func4, "foo", _, _);
+ res__34 = _.partialRight(func4, 42, "foo", _, _);
+ res12_4 = _.partialRight(func4, true, _);
+ res_2_4 = _.partialRight(func4, 42, _, true, _);
+ res1__4 = _.partialRight(func4, "foo", true, _);
+ res___4 = _.partialRight(func4, 42, "foo", true, _);
+ res123_ = _.partialRight(func4, 100);
+ res_23_ = _.partialRight(func4, 42, _, _, 100);
+ res1_3_ = _.partialRight(func4, "foo", _, 100);
+ res__3_ = _.partialRight(func4, 42, "foo", _, 100);
+ res12__ = _.partialRight(func4, true, 100);
+ res_2__ = _.partialRight(func4, 42, _, true, 100);
+ res1___ = _.partialRight(func4, "foo", true, 100);
+ res____ = _.partialRight(func4, 42, "foo", true, 100);
}
diff --git a/lodash/lodash.d.ts b/lodash/lodash.d.ts
index 5a3e0df9e9..7f20d7aa8c 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,106 +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>> { }
- /**
- * @see _.toPlainObject
- */
- toPlainObject(): Object;
- }
+ interface LoDashImplicitStringWrapper extends LoDashImplicitWrapper<string> { }
- interface LoDashWrapper<T> extends LoDashWrapperBase<T, LoDashWrapper<T>> { }
+ interface LoDashExplicitStringWrapper extends LoDashExplicitWrapper<string> { }
- interface LoDashStringWrapper extends LoDashWrapper<string> { }
+ interface LoDashImplicitObjectWrapper<T> extends LoDashImplicitWrapperBase<T, LoDashImplicitObjectWrapper<T>> { }
- interface LoDashObjectWrapper<T> extends LoDashWrapperBase<T, LoDashObjectWrapper<T>> { }
+ interface LoDashExplicitObjectWrapper<T> extends LoDashExplicitWrapperBase<T, LoDashExplicitObjectWrapper<T>> { }
- interface LoDashArrayWrapper<T> extends LoDashWrapperBase<T[], LoDashArrayWrapper<T>> {
- concat(...items: Array<T|Array<T>>): LoDashArrayWrapper<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 *
@@ -332,18 +266,32 @@ 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[]>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.chunk
+ */
+ chunk(size?: number): LoDashExplicitArrayWrapper<T[]>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.chunk
+ */
+ chunk<TResult>(size?: number): LoDashExplicitArrayWrapper<TResult[]>;
}
//_.compact
@@ -358,18 +306,32 @@ 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>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.compact
+ */
+ compact(): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.compact
+ */
+ compact<TResult>(): LoDashExplicitArrayWrapper<TResult>;
}
//_.difference
@@ -388,18 +350,32 @@ 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>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.difference
+ */
+ difference(...values: (T[]|List<T>)[]): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.difference
+ */
+ difference<TValue>(...values: (TValue[]|List<TValue>)[]): LoDashExplicitArrayWrapper<TValue>;
}
//_.drop
@@ -414,18 +390,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
@@ -443,18 +419,126 @@ 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>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.dropRight
+ */
+ dropRight(n?: number): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.dropRight
+ */
+ dropRight<TResult>(n?: number): LoDashExplicitArrayWrapper<TResult>;
+ }
+
+ //_.dropRightWhile
+ interface LoDashStatic {
+ /**
+ * Creates a slice of array excluding elements dropped from the end. Elements are dropped until predicate
+ * returns falsey. The predicate is bound to thisArg and invoked with three arguments: (value, index, array).
+ *
+ * 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
+ * match the properties of the given object, else false.
+ *
+ * @param array The array to query.
+ * @param predicate The function invoked per iteration.
+ * @param thisArg The this binding of predicate.
+ * @return Returns the slice of array.
+ */
+ dropRightWhile<TValue>(
+ array: List<TValue>,
+ predicate?: ListIterator<TValue, boolean>,
+ thisArg?: any
+ ): TValue[];
+
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile<TValue>(
+ array: List<TValue>,
+ predicate?: string,
+ thisArg?: any
+ ): TValue[];
+
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile<TWhere, TValue>(
+ array: List<TValue>,
+ predicate?: TWhere
+ ): TValue[];
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashImplicitArrayWrapper<T>;
+
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashImplicitArrayWrapper<T>;
+
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile<TWhere>(
+ predicate?: TWhere
+ ): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile<TValue>(
+ predicate?: ListIterator<TValue, boolean>,
+ thisArg?: any
+ ): LoDashImplicitArrayWrapper<TValue>;
+
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile<TValue>(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashImplicitArrayWrapper<TValue>;
+
+ /**
+ * @see _.dropRightWhile
+ */
+ dropRightWhile<TWhere, TValue>(
+ predicate?: TWhere
+ ): LoDashImplicitArrayWrapper<TValue>;
}
//_.dropWhile
@@ -501,14 +585,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
@@ -516,24 +600,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
@@ -541,14 +625,64 @@ declare module _ {
dropWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.dropWhile
*/
dropWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.dropWhile
+ */
+ dropWhile(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.dropWhile
+ */
+ dropWhile(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.dropWhile
+ */
+ dropWhile<TWhere>(
+ predicate?: TWhere
+ ): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.dropWhile
+ */
+ dropWhile<TValue>(
+ predicate?: ListIterator<TValue, boolean>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TValue>;
+
+ /**
+ * @see _.dropWhile
+ */
+ dropWhile<TValue>(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TValue>;
+
+ /**
+ * @see _.dropWhile
+ */
+ dropWhile<TWhere, TValue>(
+ predicate?: TWhere
+ ): LoDashExplicitArrayWrapper<TValue>;
}
//_.findIndex
@@ -595,7 +729,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.findIndex
*/
@@ -620,7 +754,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.findIndex
*/
@@ -645,6 +779,56 @@ declare module _ {
): number;
}
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.findIndex
+ */
+ findIndex(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.findIndex
+ */
+ findIndex(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.findIndex
+ */
+ findIndex<W>(
+ predicate?: W
+ ): LoDashExplicitWrapper<number>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.findIndex
+ */
+ findIndex<TResult>(
+ predicate?: ListIterator<TResult, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.findIndex
+ */
+ findIndex(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.findIndex
+ */
+ findIndex<W>(
+ predicate?: W
+ ): LoDashExplicitWrapper<number>;
+ }
+
//_.findLastIndex
interface LoDashStatic {
/**
@@ -688,7 +872,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.findLastIndex
*/
@@ -713,7 +897,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.findLastIndex
*/
@@ -751,14 +935,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
*/
@@ -766,6 +950,8 @@ declare module _ {
}
interface MaybeNestedList<T> extends List<T|List<T>> { }
+ interface RecursiveArray<T> extends Array<T|RecursiveArray<T>> { }
+ interface ListOfRecursiveArraysOrValues<T> extends List<T|RecursiveArray<T>> { }
interface RecursiveList<T> extends List<T|RecursiveList<T>> { }
//_.flatten
@@ -792,33 +978,53 @@ declare module _ {
* @return `array` flattened.
**/
flatten<T>(array: RecursiveList<T>, isDeep: boolean): List<T> | RecursiveList<T>;
+ }
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.flatten
+ **/
+ flatten<T>(): LoDashImplicitArrayWrapper<any>;
+
+ /**
+ * @see _.flatten
+ **/
+ flatten<T>(isShallow: boolean): LoDashImplicitArrayWrapper<any>;
+ }
+
+ //_.flattenDeep
+ interface LoDashStatic {
/**
* Recursively flattens a nested array.
*
- * _.flattenDeep(x) is equivalent to _.flatten(x, true);
- *
- * @param array The array to flatten
- * @return `array` recursively flattened
+ * @param array The array to recursively flatten.
+ * @return Returns the new flattened array.
*/
- flattenDeep<T>(array: RecursiveList<T>): List<T>
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.flatten
- **/
- flatten<T>(): LoDashArrayWrapper<any>;
-
- /**
- * @see _.flatten
- **/
- flatten<T>(isShallow: boolean): LoDashArrayWrapper<any>;
+ flattenDeep<T>(array: RecursiveArray<T>): T[];
/**
* @see _.flattenDeep
*/
- flattenDeep<T>(): LoDashArrayWrapper<any>;
+ flattenDeep<T>(array: ListOfRecursiveArraysOrValues<T>): T[];
+
+ /**
+ * @see _.flattenDeep
+ */
+ flattenDeep<T>(array: RecursiveList<T>): any[];
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.flattenDeep
+ */
+ flattenDeep<TResult>(): LoDashImplicitArrayWrapper<TResult>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.flattenDeep
+ */
+ flattenDeep<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.head
@@ -829,14 +1035,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
*/
@@ -862,7 +1068,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.indexOf
*/
@@ -872,7 +1078,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.indexOf
*/
@@ -882,6 +1088,26 @@ declare module _ {
): number;
}
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.indexOf
+ */
+ indexOf(
+ value: T,
+ fromIndex?: boolean|number
+ ): LoDashExplicitWrapper<number>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.indexOf
+ */
+ indexOf<TValue>(
+ value: TValue,
+ fromIndex?: boolean|number
+ ): LoDashExplicitWrapper<number>;
+ }
+
//_.initial
interface LoDashStatic {
/**
@@ -893,18 +1119,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
@@ -919,18 +1145,32 @@ 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>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.intersection
+ */
+ intersection<TResult>(...arrays: (TResult[]|List<TResult>)[]): LoDashExplicitArrayWrapper<TResult>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.intersection
+ */
+ intersection<TResult>(...arrays: (TResult[]|List<TResult>)[]): LoDashExplicitArrayWrapper<TResult>;
}
//_.last
@@ -944,14 +1184,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
*/
@@ -975,7 +1215,7 @@ declare module _ {
): number;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.lastIndexOf
*/
@@ -985,7 +1225,7 @@ declare module _ {
): number;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.lastIndexOf
*/
@@ -995,6 +1235,99 @@ declare module _ {
): number;
}
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.lastIndexOf
+ */
+ lastIndexOf(
+ value: T,
+ fromIndex?: boolean|number
+ ): LoDashExplicitWrapper<number>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.lastIndexOf
+ */
+ lastIndexOf<TResult>(
+ value: TResult,
+ fromIndex?: boolean|number
+ ): LoDashExplicitWrapper<number>;
+ }
+
+ //_.object
+ interface LoDashStatic {
+ /**
+ * @see _.zipObject
+ */
+ object<TValues, TResult extends {}>(
+ props: List<StringRepresentable>,
+ values?: List<TValues>
+ ): TResult;
+
+ /**
+ * @see _.zipObject
+ */
+ object<TResult extends {}>(
+ props: List<StringRepresentable>,
+ values?: List<any>
+ ): TResult;
+
+ /**
+ * @see _.zipObject
+ */
+ object(
+ props: List<StringRepresentable>,
+ values?: List<any>
+ ): _.Dictionary<any>;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.zipObject
+ */
+ object<TValues, TResult extends {}>(
+ values?: List<TValues>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ object<TResult extends {}>(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ object(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.zipObject
+ */
+ object<TValues, TResult extends {}>(
+ values?: List<TValues>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ object<TResult extends {}>(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ object(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
+ }
+
//_.pull
interface LoDashStatic {
/**
@@ -1020,18 +1353,32 @@ 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>>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.pull
+ */
+ pull(...values: T[]): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.pull
+ */
+ pull<TValue>(...values: TValue[]): LoDashExplicitObjectWrapper<List<TValue>>;
}
//_.pullAt
@@ -1052,18 +1399,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
@@ -1112,14 +1459,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
@@ -1127,24 +1474,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
@@ -1152,168 +1499,91 @@ declare module _ {
remove<TResult>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.remove
*/
remove<W, TResult>(
predicate?: W
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.remove
+ */
+ remove(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.remove
+ */
+ remove(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.remove
+ */
+ remove<W>(
+ predicate?: W
+ ): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.remove
+ */
+ remove<TResult>(
+ predicate?: ListIterator<TResult, boolean>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.remove
+ */
+ remove<TResult>(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.remove
+ */
+ remove<W, TResult>(
+ predicate?: W
+ ): LoDashExplicitArrayWrapper<TResult>;
}
//_.rest
interface LoDashStatic {
/**
- * The opposite of _.initial this method gets all but the first element or first n elements of
- * an array. If a callback function is provided elements at the beginning of the array are excluded
- * from the result as long as the callback returns truey. The callback is bound to thisArg and
- * invoked with three arguments; (value, index, array).
- *
- * If a property name is provided for callback the created "_.pluck" style callback will return
- * the property value of the given element.
- *
- * If an object is provided for callback the created "_.where" style callback will return true
- * for elements that have the properties of the given object, else false.
- * @param array The array to query.
- * @param {(Function|Object|number|string)} [callback=1] The function called per element or the number
- * of elements to exclude. If a property name or object is provided it will be used to create a
- * ".pluck" or ".where" style callback, respectively.
- * @param {*} [thisArg] The this binding of callback.
- * @return Returns a slice of array.
- **/
- rest<T>(array: Array<T>): T[];
-
- /**
- * @see _.rest
- **/
+ * Gets all but the first element of array.
+ *
+ * @alias _.tail
+ *
+ * @param array The array to query.
+ * @return Returns the slice of array.
+ */
rest<T>(array: List<T>): T[];
+ }
+ interface LoDashImplicitArrayWrapper<T> {
/**
- * @see _.rest
- **/
- rest<T>(
- array: Array<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T[];
+ * @see _.rest
+ */
+ rest(): LoDashImplicitArrayWrapper<T>;
+ }
+ interface LoDashImplicitObjectWrapper<T> {
/**
- * @see _.rest
- **/
- rest<T>(
- array: List<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T[];
-
- /**
- * @see _.rest
- **/
- rest<T>(
- array: Array<T>,
- n: number): T[];
-
- /**
- * @see _.rest
- **/
- rest<T>(
- array: List<T>,
- n: number): T[];
-
- /**
- * @see _.rest
- **/
- rest<T>(
- array: Array<T>,
- pluckValue: string): T[];
-
- /**
- * @see _.rest
- **/
- rest<T>(
- array: List<T>,
- pluckValue: string): T[];
-
- /**
- * @see _.rest
- **/
- rest<W, T>(
- array: Array<T>,
- whereValue: W): T[];
-
- /**
- * @see _.rest
- **/
- rest<W, T>(
- array: List<T>,
- whereValue: W): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(array: Array<T>): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(array: List<T>): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(
- array: Array<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(
- array: List<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(
- array: Array<T>,
- n: number): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(
- array: List<T>,
- n: number): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(
- array: Array<T>,
- pluckValue: string): T[];
-
- /**
- * @see _.rest
- **/
- tail<T>(
- array: List<T>,
- pluckValue: string): T[];
-
- /**
- * @see _.rest
- **/
- tail<W, T>(
- array: Array<T>,
- whereValue: W): T[];
-
- /**
- * @see _.rest
- **/
- tail<W, T>(
- array: List<T>,
- whereValue: W): T[];
+ * @see _.rest
+ */
+ rest<TResult>(): LoDashImplicitArrayWrapper<TResult>;
}
//_.slice
@@ -1333,14 +1603,24 @@ declare module _ {
): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.slice
*/
slice(
start?: number,
end?: number
- ): LoDashArrayWrapper<T>;
+ ): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.slice
+ */
+ slice(
+ start?: number,
+ end?: number
+ ): LoDashExplicitArrayWrapper<T>;
}
//_.sortedIndex
@@ -1413,6 +1693,98 @@ declare module _ {
whereValue: W): number;
}
+ //_.sortedLastIndex
+ interface LoDashStatic {
+ /**
+ * Uses a binary search to determine the highest index at which a value should be inserted
+ * into a given sorted array in order to maintain the sort order of the array. If a callback
+ * is provided it will be executed for value and each element of array to compute their sort
+ * ranking. The callback is bound to thisArg and invoked with one argument; (value).
+ *
+ * If a property name is provided for callback the created "_.pluck" style callback will
+ * return the property value of the given element.
+ *
+ * If an object is provided for callback the created "_.where" style callback will return
+ * true for elements that have the properties of the given object, else false.
+ * @param array The sorted list.
+ * @param value The value to determine its index within `list`.
+ * @param callback Iterator to compute the sort ranking of each value, optional.
+ * @return The index at which value should be inserted into array.
+ **/
+ sortedLastIndex<T, TSort>(
+ array: Array<T>,
+ value: T,
+ callback?: (x: T) => TSort,
+ thisArg?: any): number;
+
+ /**
+ * @see _.sortedLastIndex
+ **/
+ sortedLastIndex<T, TSort>(
+ array: List<T>,
+ value: T,
+ callback?: (x: T) => TSort,
+ thisArg?: any): number;
+
+ /**
+ * @see _.sortedLastIndex
+ * @param pluckValue the _.pluck style callback
+ **/
+ sortedLastIndex<T>(
+ array: Array<T>,
+ value: T,
+ pluckValue: string): number;
+
+ /**
+ * @see _.sortedLastIndex
+ * @param pluckValue the _.pluck style callback
+ **/
+ sortedLastIndex<T>(
+ array: List<T>,
+ value: T,
+ pluckValue: string): number;
+
+ /**
+ * @see _.sortedLastIndex
+ * @param pluckValue the _.where style callback
+ **/
+ sortedLastIndex<W, T>(
+ array: Array<T>,
+ value: T,
+ whereValue: W): number;
+
+ /**
+ * @see _.sortedLastIndex
+ * @param pluckValue the _.where style callback
+ **/
+ sortedLastIndex<W, T>(
+ array: List<T>,
+ value: T,
+ whereValue: W): number;
+ }
+
+ //_.tail
+ interface LoDashStatic {
+ /**
+ * @see _.rest
+ */
+ tail<T>(array: List<T>): T[];
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.rest
+ */
+ tail(): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.rest
+ */
+ tail<TResult>(): LoDashImplicitArrayWrapper<TResult>;
+ }
+
//_.take
interface LoDashStatic {
/**
@@ -1428,18 +1800,32 @@ 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>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.take
+ */
+ take(n?: number): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.take
+ */
+ take<TResult>(n?: number): LoDashExplicitArrayWrapper<TResult>;
}
//_.takeRight
@@ -1457,18 +1843,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
@@ -1515,14 +1901,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
@@ -1530,24 +1916,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
@@ -1555,14 +1941,64 @@ declare module _ {
takeRightWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.takeRightWhile
*/
takeRightWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.takeRightWhile
+ */
+ takeRightWhile(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.takeRightWhile
+ */
+ takeRightWhile(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.takeRightWhile
+ */
+ takeRightWhile<TWhere>(
+ predicate?: TWhere
+ ): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.takeRightWhile
+ */
+ takeRightWhile<TValue>(
+ predicate?: ListIterator<TValue, boolean>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TValue>;
+
+ /**
+ * @see _.takeRightWhile
+ */
+ takeRightWhile<TValue>(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TValue>;
+
+ /**
+ * @see _.takeRightWhile
+ */
+ takeRightWhile<TWhere, TValue>(
+ predicate?: TWhere
+ ): LoDashExplicitArrayWrapper<TValue>;
}
//_.takeWhile
@@ -1609,14 +2045,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
@@ -1624,24 +2060,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
@@ -1649,37 +2085,64 @@ declare module _ {
takeWhile<TValue>(
predicate?: string,
thisArg?: any
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
/**
* @see _.takeWhile
*/
takeWhile<TWhere, TValue>(
predicate?: TWhere
- ): LoDashArrayWrapper<TValue>;
+ ): LoDashImplicitArrayWrapper<TValue>;
}
//_.union
interface LoDashStatic {
/**
- * Creates an array of unique values, in order, of the provided arrays using strict
- * equality for comparisons, i.e. ===.
- * @param arrays The arrays to inspect.
- * @return Returns an array of composite values.
- **/
- union<T>(...arrays: Array<T>[]): T[];
-
- /**
- * @see _.union
- **/
+ * Creates an array of unique values, in order, from all of the provided arrays using SameValueZero for
+ * equality comparisons.
+ *
+ * @param arrays The arrays to inspect.
+ * @return Returns the new array of combined values.
+ */
union<T>(...arrays: List<T>[]): T[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
- * @see _.union
- **/
- union<T>(...arrays: (Array<T>|List<T>)[]): LoDashArrayWrapper<T>;
+ * @see _.union
+ */
+ union(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
+
+ /**
+ * @see _.union
+ */
+ union<T>(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.union
+ */
+ union<T>(...arrays: List<T>[]): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.union
+ */
+ union(...arrays: List<T>[]): LoDashExplicitArrayWrapper<T>;
+
+ /**
+ * @see _.union
+ */
+ union<T>(...arrays: List<T>[]): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.union
+ */
+ union<T>(...arrays: List<T>[]): LoDashExplicitArrayWrapper<T>;
}
//_.uniq
@@ -1924,11 +2387,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
@@ -1936,14 +2399,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
@@ -1951,13 +2414,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
@@ -1965,19 +2428,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
@@ -1985,14 +2448,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
@@ -2000,13 +2463,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
@@ -2014,14 +2477,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
@@ -2043,24 +2506,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
@@ -2078,18 +2541,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
@@ -2103,18 +2566,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
@@ -2144,60 +2607,97 @@ 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
interface LoDashStatic {
/**
- * The inverse of _.pairs; this method returns an object composed from arrays of property
- * names and values. Provide either a single two dimensional array, e.g. [[key1, value1],
- * [key2, value2]] or two arrays, one of property names and one of corresponding values.
- * @param props The property names.
- * @param values The property values.
- * @return Returns the new object.
- **/
+ * The inverse of _.pairs; this method returns an object composed from arrays of property names and values.
+ * Provide either a single two dimensional array, e.g. [[key1, value1], [key2, value2]] or two arrays, one of
+ * property names and one of corresponding values.
+ *
+ * @alias _.object
+ *
+ * @param props The property names.
+ * @param values The property values.
+ * @return Returns the new object.
+ */
+ zipObject<TValues, TResult extends {}>(
+ props: List<StringRepresentable>,
+ values?: List<TValues>
+ ): TResult;
+
+ /**
+ * @see _.zipObject
+ */
zipObject<TResult extends {}>(
- props: List<string>,
- values?: List<any>): TResult;
+ props: List<StringRepresentable>,
+ values?: List<any>
+ ): TResult;
/**
- * @see _.zipObject
- **/
- zipObject<TResult extends {}>(props: List<List<any>>): Dictionary<any>;
-
- /**
- * @see _.zipObject
- **/
- object<TResult extends {}>(
- props: List<string>,
- values?: List<any>): TResult;
-
- /**
- * @see _.zipObject
- **/
- object<TResult extends {}>(props: List<List<any>>): Dictionary<any>;
+ * @see _.zipObject
+ */
+ zipObject(
+ props: List<StringRepresentable>,
+ values?: List<any>
+ ): _.Dictionary<any>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
- * @see _.zipObject
- **/
- zipObject(values?: List<any>): _.LoDashObjectWrapper<Dictionary<any>>;
+ * @see _.zipObject
+ */
+ zipObject<TValues, TResult extends {}>(
+ values?: List<TValues>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
/**
- * @see _.zipObject
- **/
- object(values?: List<any>): _.LoDashObjectWrapper<Dictionary<any>>;
+ * @see _.zipObject
+ */
+ zipObject<TResult extends {}>(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ zipObject(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.zipObject
+ */
+ zipObject<TValues, TResult extends {}>(
+ values?: List<TValues>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ zipObject<TResult extends {}>(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.zipObject
+ */
+ zipObject(
+ values?: List<any>
+ ): _.LoDashImplicitObjectWrapper<_.Dictionary<any>>;
}
//_.zipWith
@@ -2214,21 +2714,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.
@@ -2237,48 +2821,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.
*
@@ -2287,44 +2914,182 @@ 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>;
+ }
+
+ //_.prototype.run
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * @see _.value
+ */
+ run(): T;
+ }
+
+ //_.prototype.toJSON
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * @see _.value
+ */
+ toJSON(): T;
+ }
+
+ //_.prototype.toString
+ interface LoDashWrapperBase<T, TWrapper> {
+ /**
+ * Produces the result of coercing the unwrapped value to a string.
+ *
+ * @return Returns the coerced string value.
+ */
+ toString(): string;
+ }
+
+ //_.prototype.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;
}
/**************
@@ -2369,7 +3134,7 @@ declare module _ {
): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.every
*/
@@ -2394,7 +3159,7 @@ declare module _ {
): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.every
*/
@@ -2419,6 +3184,194 @@ declare module _ {
): boolean;
}
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.every
+ */
+ all(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ all(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ all<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.every
+ */
+ all<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ all(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ all<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
+ //_.any
+ interface LoDashStatic {
+ /**
+ * @see _.some
+ */
+ any<T>(
+ collection: List<T>,
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any<T>(
+ collection: Dictionary<T>,
+ predicate?: DictionaryIterator<T, boolean>,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any<T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: string,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any<TObject extends {}, T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: TObject
+ ): boolean;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.some
+ */
+ any(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any(
+ predicate?: string,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any<TObject extends {}>(
+ predicate?: TObject
+ ): boolean;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.some
+ */
+ any<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any(
+ predicate?: string,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ any<TObject extends {}>(
+ predicate?: TObject
+ ): boolean;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.some
+ */
+ any(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.some
+ */
+ any(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.some
+ */
+ any<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.some
+ */
+ any<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.some
+ */
+ any(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.some
+ */
+ any<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
//_.at
interface LoDashStatic {
/**
@@ -2435,18 +3388,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
@@ -2473,15 +3426,7 @@ declare module _ {
* @see _.map
*/
collect<T, TResult>(
- collection: List<T>,
- iteratee?: string
- ): TResult[];
-
- /**
- * @see _.map
- */
- collect<T, TResult>(
- collection: Dictionary<T>,
+ collection: List<T>|Dictionary<T>,
iteratee?: string
): TResult[];
@@ -2489,65 +3434,105 @@ declare module _ {
* @see _.map
*/
collect<T, TObject extends {}>(
- collection: List<T>,
- iteratee?: TObject
- ): boolean[];
-
- /**
- * @see _.map
- */
- collect<T, TObject extends {}>(
- collection: Dictionary<T>,
+ collection: List<T>|Dictionary<T>,
iteratee?: TObject
): 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>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.map
+ */
+ collect<TResult>(
+ iteratee?: ListIterator<T, TResult>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.map
+ */
+ collect<TResult>(
+ iteratee?: string
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.map
+ */
+ collect<TObject extends {}>(
+ iteratee?: TObject
+ ): LoDashExplicitArrayWrapper<boolean>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.map
+ */
+ collect<TValue, TResult>(
+ iteratee?: ListIterator<TValue, TResult>|DictionaryIterator<TValue, TResult>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.map
+ */
+ collect<TValue, TResult>(
+ iteratee?: string
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.map
+ */
+ collect<TObject extends {}>(
+ iteratee?: TObject
+ ): LoDashExplicitArrayWrapper<boolean>;
}
//_.contains
@@ -2658,7 +3643,7 @@ declare module _ {
fromIndex?: number): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.contains
**/
@@ -2675,7 +3660,7 @@ declare module _ {
includes(target: T, fromIndex?: number): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.contains
**/
@@ -2692,7 +3677,7 @@ declare module _ {
includes<TValue>(target: TValue, fromIndex?: number): boolean;
}
- interface LoDashStringWrapper {
+ interface LoDashImplicitStringWrapper {
/**
* @see _.contains
**/
@@ -2778,13 +3763,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
@@ -2792,7 +3777,194 @@ declare module _ {
**/
countBy(
callback: string,
- thisArg?: any): LoDashObjectWrapper<Dictionary<number>>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<number>>;
+ }
+
+ //_.detect
+ interface LoDashStatic {
+ /**
+ * @see _.find
+ */
+ detect<T>(
+ collection: List<T>,
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ detect<T>(
+ collection: Dictionary<T>,
+ predicate?: DictionaryIterator<T, boolean>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ detect<T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ detect<TObject extends {}, T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.find
+ */
+ detect(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ detect(
+ predicate?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ detect<TObject extends {}>(
+ predicate?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.find
+ */
+ detect<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): TResult;
+
+ /**
+ * @see _.find
+ */
+ detect<TResult>(
+ predicate?: string,
+ thisArg?: any
+ ): TResult;
+
+ /**
+ * @see _.find
+ */
+ detect<TObject extends {}, TResult>(
+ predicate?: TObject
+ ): TResult;
+ }
+
+ //_.each
+ interface LoDashStatic {
+ /**
+ * @see _.forEach
+ */
+ each(
+ collection: string,
+ iteratee?: StringIterator<boolean|void>,
+ thisArg?: any
+ ): string;
+
+ /**
+ * @see _.forEach
+ */
+ each<T>(
+ collection: T[],
+ iteratee?: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): T[];
+
+ /**
+ * @see _.forEach
+ */
+ each<T>(
+ collection: List<T>,
+ iteratee?: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): List<T>;
+
+ /**
+ * @see _.forEach
+ */
+ each<T>(
+ collection: Dictionary<T>,
+ iteratee?: DictionaryIterator<T, boolean|void>,
+ thisArg?: any
+ ): Dictionary<T>;
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ each(
+ iteratee: StringIterator<boolean|void>,
+ thisArg?: any
+ ): LoDashImplicitWrapper<string>;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ each(
+ iteratee: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ each<TValue>(
+ iteratee?: ListIterator<TValue, boolean|void>|DictionaryIterator<TValue, boolean|void>,
+ thisArg?: any
+ ): LoDashImplicitObjectWrapper<T>;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ each(
+ iteratee: StringIterator<boolean|void>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<string>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ each(
+ iteratee: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ each<TValue>(
+ iteratee?: ListIterator<TValue, boolean|void>|DictionaryIterator<TValue, boolean|void>,
+ thisArg?: any
+ ): LoDashExplicitObjectWrapper<T>;
}
//_.every
@@ -2850,7 +4022,7 @@ declare module _ {
): boolean;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.every
*/
@@ -2875,7 +4047,7 @@ declare module _ {
): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.every
*/
@@ -2900,6 +4072,56 @@ declare module _ {
): boolean;
}
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.every
+ */
+ every(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ every(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ every<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.every
+ */
+ every<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ every(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.every
+ */
+ every<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
//_.fill
interface LoDashStatic {
/**
@@ -2929,24 +4151,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
@@ -3118,284 +4340,241 @@ 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
interface LoDashStatic {
/**
- * Iterates over elements of collection, returning the first element predicate returns
- * truthy for. The predicate is bound to thisArg and invoked with three arguments:
- * (value, index|key, collection).
- *
- * 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 collection Searches for a value in this list.
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- * @return The found element, else undefined.
- **/
- find<T>(
- collection: Array<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * Alias of _.find
- * @see _.find
- **/
- detect<T>(
- collection: Array<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * @see _.find
- **/
+ * Iterates over elements of collection, returning the first element predicate returns truthy for.
+ * The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).
+ *
+ * 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.
+ *
+ * @alias _.detect
+ *
+ * @param collection The collection to search.
+ * @param predicate The function invoked per iteration.
+ * @param thisArg The this binding of predicate.
+ * @return Returns the matched element, else undefined.
+ */
find<T>(
collection: List<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T;
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): T;
/**
- * Alias of _.find
- * @see _.find
- **/
- detect<T>(
- collection: List<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * @see _.find
- **/
+ * @see _.find
+ */
find<T>(
collection: Dictionary<T>,
- callback: DictionaryIterator<T, boolean>,
- thisArg?: any): T;
+ predicate?: DictionaryIterator<T, boolean>,
+ thisArg?: any
+ ): T;
/**
- * Alias of _.find
- * @see _.find
- **/
- detect<T>(
- collection: Dictionary<T>,
- callback: DictionaryIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * @see _.find
- * @param _.matches style callback
- **/
- find<W, T>(
- collection: Array<T>|List<T>|Dictionary<T>,
- whereValue: W): T;
-
- /**
- * Alias of _.find
- * @see _.find
- * @param _.matches style callback
- **/
- detect<W, T>(
- collection: Array<T>|List<T>|Dictionary<T>,
- whereValue: W): T;
-
- /**
- * @see _.find
- * @param _.matchesProperty style callback
- **/
+ * @see _.find
+ */
find<T>(
- collection: Array<T>|List<T>|Dictionary<T>,
- path: string,
- srcValue: any): T;
+ collection: List<T>|Dictionary<T>,
+ predicate?: string,
+ thisArg?: any
+ ): T;
/**
- * Alias of _.find
- * @see _.find
- * @param _.matchesProperty style callback
- **/
- detect<T>(
- collection: Array<T>|List<T>|Dictionary<T>,
- path: string,
- srcValue: any): T;
-
- /**
- * @see _.find
- * @param _.property style callback
- **/
- find<T>(
- collection: Array<T>|List<T>|Dictionary<T>,
- pluckValue: string): T;
-
- /**
- * Alias of _.find
- * @see _.find
- * @param _.property style callback
- **/
- detect<T>(
- collection: Array<T>|List<T>|Dictionary<T>,
- pluckValue: string): T;
-
- /**
- * @see _.find
- **/
- findWhere<T>(
- collection: Array<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * @see _.find
- **/
- findWhere<T>(
- collection: List<T>,
- callback: ListIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * @see _.find
- **/
- findWhere<T>(
- collection: Dictionary<T>,
- callback: DictionaryIterator<T, boolean>,
- thisArg?: any): T;
-
- /**
- * @see _.find
- * @param _.matches style callback
- **/
- findWhere<W, T>(
- collection: Array<T>,
- whereValue: W): T;
-
- /**
- * @see _.find
- * @param _.matches style callback
- **/
- findWhere<W, T>(
- collection: List<T>,
- whereValue: W): T;
-
- /**
- * @see _.find
- * @param _.matches style callback
- **/
- findWhere<W, T>(
- collection: Dictionary<T>,
- whereValue: W): T;
-
- /**
- * @see _.find
- * @param _.property style callback
- **/
- findWhere<T>(
- collection: Array<T>,
- pluckValue: string): T;
-
- /**
- * @see _.find
- * @param _.property style callback
- **/
- findWhere<T>(
- collection: List<T>,
- pluckValue: string): T;
-
- /**
- * @see _.find
- * @param _.property style callback
- **/
- findWhere<T>(
- collection: Dictionary<T>,
- pluckValue: string): T;
+ * @see _.find
+ */
+ find<TObject extends {}, T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: TObject
+ ): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.find
+ */
+ find(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ find(
+ predicate?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.find
+ */
+ find<TObject extends {}>(
+ predicate?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.find
+ */
+ find<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): TResult;
+
+ /**
+ * @see _.find
+ */
+ find<TResult>(
+ predicate?: string,
+ thisArg?: any
+ ): TResult;
+
+ /**
+ * @see _.find
+ */
+ find<TObject extends {}, TResult>(
+ predicate?: TObject
+ ): TResult;
+ }
+
+ //_.findWhere
+ interface LoDashStatic {
/**
* @see _.find
- */
- find(
+ **/
+ findWhere<T>(
+ collection: Array<T>,
callback: ListIterator<T, boolean>,
thisArg?: any): T;
+
+ /**
+ * @see _.find
+ **/
+ findWhere<T>(
+ collection: List<T>,
+ callback: ListIterator<T, boolean>,
+ thisArg?: any): T;
+
+ /**
+ * @see _.find
+ **/
+ findWhere<T>(
+ collection: Dictionary<T>,
+ callback: DictionaryIterator<T, boolean>,
+ thisArg?: any): T;
+
/**
* @see _.find
* @param _.matches style callback
- */
- find<W>(
+ **/
+ findWhere<W, T>(
+ collection: Array<T>,
whereValue: W): T;
+
/**
* @see _.find
- * @param _.matchesProperty style callback
- */
- find(
- path: string,
- srcValue: any): T;
+ * @param _.matches style callback
+ **/
+ findWhere<W, T>(
+ collection: List<T>,
+ whereValue: W): T;
+
+ /**
+ * @see _.find
+ * @param _.matches style callback
+ **/
+ findWhere<W, T>(
+ collection: Dictionary<T>,
+ whereValue: W): T;
+
/**
* @see _.find
* @param _.property style callback
- */
- find(
+ **/
+ findWhere<T>(
+ collection: Array<T>,
+ pluckValue: string): T;
+
+ /**
+ * @see _.find
+ * @param _.property style callback
+ **/
+ findWhere<T>(
+ collection: List<T>,
+ pluckValue: string): T;
+
+ /**
+ * @see _.find
+ * @param _.property style callback
+ **/
+ findWhere<T>(
+ collection: Dictionary<T>,
pluckValue: string): T;
}
@@ -3479,7 +4658,7 @@ declare module _ {
pluckValue: string): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.findLast
*/
@@ -3504,108 +4683,111 @@ declare module _ {
//_.forEach
interface LoDashStatic {
/**
- * Iterates over elements of a collection, executing the callback for each element.
- * The callback is bound to thisArg and invoked with three arguments; (value, index|key,
- * collection). Callbacks may exit iteration early by explicitly returning false.
- * @param collection The collection to iterate over.
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- **/
- forEach<T>(
- collection: Array<T>,
- callback: ListIterator<T, void>,
- thisArg?: any): Array<T>;
-
- /**
- * @see _.forEach
- **/
- forEach<T>(
- collection: List<T>,
- callback: ListIterator<T, void>,
- thisArg?: any): List<T>;
-
- /**
- * @see _.forEach
- **/
- forEach<T extends {}>(
- object: Dictionary<T>,
- callback: DictionaryIterator<T, void>,
- thisArg?: any): Dictionary<T>;
-
- /**
- * @see _.each
- **/
- forEach<T extends {}, TValue>(
- object: T,
- callback: ObjectIterator<TValue, void>,
- thisArg?: any): T
-
- /**
- * @see _.forEach
- **/
- each<T>(
- collection: Array<T>,
- callback: ListIterator<T, void>,
- thisArg?: any): Array<T>;
-
- /**
- * @see _.forEach
- **/
- each<T>(
- collection: List<T>,
- callback: ListIterator<T, void>,
- thisArg?: any): List<T>;
-
- /**
- * @see _.forEach
- * @param object The object to iterate over
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- **/
- each<T extends {}>(
- object: Dictionary<T>,
- callback: DictionaryIterator<T, void>,
- thisArg?: any): Dictionary<T>;
-
- /**
- * @see _.each
- **/
- each<T extends {}, TValue>(
- object: T,
- callback: ObjectIterator<TValue, void>,
- thisArg?: any): T
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.forEach
- **/
+ * Iterates over elements of collection invoking iteratee for each element. The iteratee is bound to thisArg
+ * and invoked with three arguments:
+ * (value, index|key, collection). Iteratee functions may exit iteration early by explicitly returning false.
+ *
+ * Note: As with other "Collections" methods, objects with a "length" property are iterated like arrays. To
+ * avoid this behavior _.forIn or _.forOwn may be used for object iteration.
+ *
+ * @alias _.each
+ *
+ * @param collection The collection to iterate over.
+ * @param iteratee The function invoked per iteration.
+ * @param thisArg The this binding of iteratee.
+ */
forEach(
- callback: ListIterator<T, void>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ collection: string,
+ iteratee?: StringIterator<boolean|void>,
+ thisArg?: any
+ ): string;
/**
- * @see _.forEach
- **/
- each(
- callback: ListIterator<T, void>,
- thisArg?: any): LoDashArrayWrapper<T>;
+ * @see _.forEach
+ */
+ forEach<T>(
+ collection: T[],
+ iteratee?: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): T[];
+
+ /**
+ * @see _.forEach
+ */
+ forEach<T>(
+ collection: List<T>,
+ iteratee?: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): List<T>;
+
+ /**
+ * @see _.forEach
+ */
+ forEach<T>(
+ collection: Dictionary<T>,
+ iteratee?: DictionaryIterator<T, boolean|void>,
+ thisArg?: any
+ ): Dictionary<T>;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
- * @see _.forEach
- **/
- forEach<T extends {}>(
- callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<T>;
+ * @see _.forEach
+ */
+ forEach(
+ iteratee: StringIterator<boolean|void>,
+ thisArg?: any
+ ): LoDashImplicitWrapper<string>;
+ }
+ interface LoDashImplicitArrayWrapper<T> {
/**
- * @see _.forEach
- **/
- each<T extends {}>(
- callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<T>;
+ * @see _.forEach
+ */
+ forEach(
+ iteratee: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): LoDashImplicitArrayWrapper<T>;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ forEach<TValue>(
+ iteratee?: ListIterator<TValue, boolean|void>|DictionaryIterator<TValue, boolean|void>,
+ thisArg?: any
+ ): LoDashImplicitObjectWrapper<T>;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ forEach(
+ iteratee: StringIterator<boolean|void>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<string>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ forEach(
+ iteratee: ListIterator<T, boolean|void>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<T>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.forEach
+ */
+ forEach<TValue>(
+ iteratee?: ListIterator<TValue, boolean|void>|DictionaryIterator<TValue, boolean|void>,
+ thisArg?: any
+ ): LoDashExplicitObjectWrapper<T>;
}
//_.forEachRight
@@ -3666,29 +4848,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
@@ -3698,7 +4880,7 @@ declare module _ {
**/
eachRight<T extends {}>(
callback: ObjectIterator<T, void>,
- thisArg?: any): LoDashObjectWrapper<Dictionary<T>>;
+ thisArg?: any): LoDashImplicitObjectWrapper<Dictionary<T>>;
}
//_.groupBy
@@ -3788,46 +4970,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
@@ -4000,15 +5182,7 @@ declare module _ {
* @see _.map
*/
map<T, TResult>(
- collection: List<T>,
- iteratee?: string
- ): TResult[];
-
- /**
- * @see _.map
- */
- map<T, TResult>(
- collection: Dictionary<T>,
+ collection: List<T>|Dictionary<T>,
iteratee?: string
): TResult[];
@@ -4016,471 +5190,105 @@ declare module _ {
* @see _.map
*/
map<T, TObject extends {}>(
- collection: List<T>,
- iteratee?: TObject
- ): boolean[];
-
- /**
- * @see _.map
- */
- map<T, TObject extends {}>(
- collection: Dictionary<T>,
+ collection: List<T>|Dictionary<T>,
iteratee?: TObject
): 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
- interface LoDashStatic {
+ interface LoDashExplicitArrayWrapper<T> {
/**
- * Calculates n rounded up to precision.
- * @param n The number to round up.
- * @param precision The precision to round up to.
- * @return Returns the rounded up number.
+ * @see _.map
*/
- ceil(n: number, precision?: number): number;
- }
+ map<TResult>(
+ iteratee?: ListIterator<T, TResult>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
- interface LoDashWrapper<T> {
/**
- * @see _.ceil
+ * @see _.map
*/
- ceil(precision?: number): number;
- }
+ map<TResult>(
+ iteratee?: string
+ ): LoDashExplicitArrayWrapper<TResult>;
- //_.floor
- interface LoDashStatic {
/**
- * Calculates n rounded down to precision.
- * @param n The number to round down.
- * @param precision The precision to round down to.
- * @return Returns the rounded down number.
+ * @see _.map
*/
- floor(n: number, precision?: number): number;
+ map<TObject extends {}>(
+ iteratee?: TObject
+ ): LoDashExplicitArrayWrapper<boolean>;
}
- interface LoDashWrapper<T> {
+ interface LoDashExplicitObjectWrapper<T> {
/**
- * @see _.floor
+ * @see _.map
*/
- floor(precision?: number): number;
- }
-
- //_.max
- interface LoDashStatic {
- /**
- * Retrieves the maximum value of a collection. If the collection is empty or falsey -Infinity is
- * returned. If a callback is provided it will be executed for each value in the collection to
- * generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked
- * with three arguments; (value, index, collection).
- *
- * If a property name is provided for callback the created "_.pluck" style callback will return the
- * property value of the given element.
- *
- * If an object is provided for callback the created "_.where" style callback will return true for
- * elements that have the properties of the given object, else false.
- * @param collection The collection to iterate over.
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- * @return Returns the maximum value.
- **/
- max<T>(
- collection: Array<T>,
- callback?: ListIterator<T, any>,
- thisArg?: any): T;
+ map<TValue, TResult>(
+ iteratee?: ListIterator<TValue, TResult>|DictionaryIterator<TValue, TResult>,
+ thisArg?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
/**
- * @see _.max
- **/
- max<T>(
- collection: List<T>,
- callback?: ListIterator<T, any>,
- thisArg?: any): T;
-
- /**
- * @see _.max
- **/
- max<T>(
- collection: Dictionary<T>,
- callback?: DictionaryIterator<T, any>,
- thisArg?: any): T;
-
- /**
- * @see _.max
- * @param pluckValue _.pluck style callback
- **/
- max<T>(
- collection: Array<T>,
- pluckValue: string): T;
-
- /**
- * @see _.max
- * @param pluckValue _.pluck style callback
- **/
- max<T>(
- collection: List<T>,
- pluckValue: string): T;
-
- /**
- * @see _.max
- * @param pluckValue _.pluck style callback
- **/
- max<T>(
- collection: Dictionary<T>,
- pluckValue: string): T;
-
- /**
- * @see _.max
- * @param whereValue _.where style callback
- **/
- max<W, T>(
- collection: Array<T>,
- whereValue: W): T;
-
- /**
- * @see _.max
- * @param whereValue _.where style callback
- **/
- max<W, T>(
- collection: List<T>,
- whereValue: W): T;
-
- /**
- * @see _.max
- * @param whereValue _.where style callback
- **/
- max<W, T>(
- collection: Dictionary<T>,
- whereValue: W): T;
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.max
- **/
- max(
- callback?: ListIterator<T, any>,
- thisArg?: any): LoDashWrapper<T>;
-
- /**
- * @see _.max
- * @param pluckValue _.pluck style callback
- **/
- max(
- pluckValue: string): LoDashWrapper<T>;
-
- /**
- * @see _.max
- * @param whereValue _.where style callback
- **/
- max<W>(
- whereValue: W): LoDashWrapper<T>;
- }
-
- //_.min
- interface LoDashStatic {
- /**
- * Retrieves the minimum value of a collection. If the collection is empty or falsey
- * Infinity is returned. If a callback is provided it will be executed for each value
- * in the collection to generate the criterion by which the value is ranked. The callback
- * is bound to thisArg and invoked with three arguments; (value, index, collection).
- *
- * If a property name is provided for callback the created "_.pluck" style callback
- * will return the property value of the given element.
- *
- * If an object is provided for callback the created "_.where" style callback will
- * return true for elements that have the properties of the given object, else false.
- * @param collection The collection to iterate over.
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- * @return Returns the maximum value.
- **/
- min<T>(
- collection: Array<T>,
- callback?: ListIterator<T, any>,
- thisArg?: any): T;
-
- /**
- * @see _.min
- **/
- min<T>(
- collection: List<T>,
- callback?: ListIterator<T, any>,
- thisArg?: any): T;
-
- /**
- * @see _.min
- **/
- min<T>(
- collection: Dictionary<T>,
- callback?: ListIterator<T, any>,
- thisArg?: any): T;
-
- /**
- * @see _.min
- * @param pluckValue _.pluck style callback
- **/
- min<T>(
- collection: Array<T>,
- pluckValue: string): T;
-
- /**
- * @see _.min
- * @param pluckValue _.pluck style callback
- **/
- min<T>(
- collection: List<T>,
- pluckValue: string): T;
-
- /**
- * @see _.min
- * @param pluckValue _.pluck style callback
- **/
- min<T>(
- collection: Dictionary<T>,
- pluckValue: string): T;
-
- /**
- * @see _.min
- * @param whereValue _.where style callback
- **/
- min<W, T>(
- collection: Array<T>,
- whereValue: W): T;
-
- /**
- * @see _.min
- * @param whereValue _.where style callback
- **/
- min<W, T>(
- collection: List<T>,
- whereValue: W): T;
-
- /**
- * @see _.min
- * @param whereValue _.where style callback
- **/
- min<W, T>(
- collection: Dictionary<T>,
- whereValue: W): T;
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.min
- **/
- min(
- callback?: ListIterator<T, any>,
- thisArg?: any): LoDashWrapper<T>;
-
- /**
- * @see _.min
- * @param pluckValue _.pluck style callback
- **/
- min(
- pluckValue: string): LoDashWrapper<T>;
-
- /**
- * @see _.min
- * @param whereValue _.where style callback
- **/
- min<W>(
- whereValue: W): LoDashWrapper<T>;
- }
-
- //_.round
- interface LoDashStatic {
- /**
- * Calculates n rounded to precision.
- * @param n The number to round.
- * @param precision The precision to round to.
- * @return Returns the rounded number.
+ * @see _.map
*/
- round(n: number, precision?: number): number;
- }
+ map<TValue, TResult>(
+ iteratee?: string
+ ): LoDashExplicitArrayWrapper<TResult>;
- interface LoDashWrapper<T> {
/**
- * @see _.round
+ * @see _.map
*/
- round(precision?: number): number;
- }
-
- //_.sum
- interface LoDashStatic {
- /**
- * Gets the sum of the values in collection.
- *
- * @param collection The collection to iterate over.
- * @param iteratee The function invoked per iteration.
- * @param thisArg The this binding of iteratee.
- * @return Returns the sum.
- **/
- sum(
- collection: Array<number>): number;
-
- /**
- * @see _.sum
- **/
- sum(
- collection: List<number>): number;
-
- /**
- * @see _.sum
- **/
- sum(
- collection: Dictionary<number>): number;
-
- /**
- * @see _.sum
- **/
- sum<T>(
- collection: Array<T>,
- iteratee: ListIterator<T, number>,
- thisArg?: any): number;
-
- /**
- * @see _.sum
- **/
- sum<T>(
- collection: List<T>,
- iteratee: ListIterator<T, number>,
- thisArg?: any): number;
-
- /**
- * @see _.sum
- **/
- sum<T>(
- collection: Dictionary<T>,
- iteratee: ObjectIterator<T, number>,
- thisArg?: any): number;
-
- /**
- * @see _.sum
- * @param property _.property callback shorthand.
- **/
- sum<T>(
- collection: Array<T>,
- property: string): number;
-
- /**
- * @see _.sum
- * @param property _.property callback shorthand.
- **/
- sum<T>(
- collection: List<T>,
- property: string): number;
-
- /**
- * @see _.sum
- * @param property _.property callback shorthand.
- **/
- sum<T>(
- collection: Dictionary<T>,
- property: string): number;
- }
-
- interface LoDashNumberArrayWrapper {
- /**
- * @see _.sum
- **/
- sum(): number;
-
- /**
- * @see _.sum
- **/
- sum(
- iteratee: ListIterator<number, number>,
- thisArg?: any): number;
- }
-
- interface LoDashArrayWrapper<T> {
- /**
- * @see _.sum
- **/
- sum(): number;
-
- /**
- * @see _.sum
- **/
- sum(
- iteratee: ListIterator<T, number>,
- thisArg?: any): number;
-
- /**
- * @see _.sum
- * @param property _.property callback shorthand.
- **/
- sum(
- property: string): number;
- }
-
- interface LoDashObjectWrapper<T> {
- /**
- * @see _.sum
- **/
- sum(): number;
-
- /**
- * @see _.sum
- **/
- sum(
- iteratee: ObjectIterator<any, number>,
- thisArg?: any): number;
-
- /**
- * @see _.sum
- * @param property _.property callback shorthand.
- **/
- sum(
- property: string): number;
+ map<TObject extends {}>(
+ iteratee?: TObject
+ ): LoDashExplicitArrayWrapper<boolean>;
}
//_.pluck
@@ -4510,20 +5318,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
@@ -4605,73 +5413,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
@@ -4839,7 +5647,7 @@ declare module _ {
thisArg?: any): TResult;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.reduce
**/
@@ -4886,7 +5694,7 @@ declare module _ {
thisArg?: any): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.reduce
**/
@@ -5130,25 +5938,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
@@ -5189,16 +5997,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
@@ -5222,18 +6030,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
@@ -5266,14 +6074,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
**/
@@ -5283,176 +6091,157 @@ declare module _ {
//_.some
interface LoDashStatic {
/**
- * Checks if the callback returns a truey value for any element of a collection. The function
- * returns as soon as it finds a passing value and does not iterate over the entire collection.
- * The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
- *
- * If a property name is provided for callback the created "_.pluck" style callback will return
- * the property value of the given element.
- *
- * If an object is provided for callback the created "_.where" style callback will return true for
- * elements that have the properties of the given object, else false.
- * @param collection The collection to iterate over.
- * @param callback The function called per iteration.
- * @param thisArg The this binding of callback.
- * @return True if any element passed the callback check, else false.
- **/
- some<T>(
- collection: Array<T>,
- callback?: ListIterator<T, boolean>,
- thisArg?: any): boolean;
-
- /**
- * @see _.some
- **/
+ * Checks if predicate returns truthy for any element of collection. The function returns as soon as it finds
+ * a passing value and does not iterate over the entire collection. The predicate is bound to thisArg and
+ * invoked with three arguments: (value, index|key, collection).
+ *
+ * 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.
+ *
+ * @alias _.any
+ *
+ * @param collection The collection to iterate over.
+ * @param predicate The function invoked per iteration.
+ * @param thisArg The this binding of predicate.
+ * @return Returns true if any element passes the predicate check, else false.
+ */
some<T>(
collection: List<T>,
- callback?: ListIterator<T, boolean>,
- thisArg?: any): boolean;
-
- /**
- * @see _.some
- **/
- some<T>(
- collection: Dictionary<T>,
- callback?: DictionaryIterator<T, boolean>,
- thisArg?: any): boolean;
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): boolean;
/**
* @see _.some
- **/
+ */
+ some<T>(
+ collection: Dictionary<T>,
+ predicate?: DictionaryIterator<T, boolean>,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ some<T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: string,
+ thisArg?: any
+ ): boolean;
+
+ /**
+ * @see _.some
+ */
+ some<TObject extends {}, T>(
+ collection: List<T>|Dictionary<T>,
+ predicate?: TObject
+ ): boolean;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.some
+ */
some(
- collection: {},
- callback?: ListIterator<{}, boolean>,
- thisArg?: any): boolean;
-
- /**
- * @see _.some
- * @param pluckValue _.pluck style callback
- **/
- some<T>(
- collection: Array<T>,
- pluckValue: string): boolean;
-
- /**
- * @see _.some
- * @param pluckValue _.pluck style callback
- **/
- some<T>(
- collection: List<T>,
- pluckValue: string): boolean;
-
- /**
- * @see _.some
- * @param pluckValue _.pluck style callback
- **/
- some<T>(
- collection: Dictionary<T>,
- pluckValue: string): boolean;
-
- /**
- * @see _.some
- * @param whereValue _.where style callback
- **/
- some<W, T>(
- collection: Array<T>,
- whereValue: W): boolean;
-
- /**
- * @see _.some
- * @param whereValue _.where style callback
- **/
- some<W, T>(
- collection: List<T>,
- whereValue: W): boolean;
-
- /**
- * @see _.some
- * @param whereValue _.where style callback
- **/
- some<W, T>(
- collection: Dictionary<T>,
- whereValue: W): boolean;
-
- /**
- * @see _.some
- **/
- any<T>(
- collection: Array<T>,
- callback?: ListIterator<T, boolean>,
- thisArg?: any): boolean;
-
- /**
- * @see _.some
- **/
- any<T>(
- collection: List<T>,
- callback?: ListIterator<T, boolean>,
- thisArg?: any): boolean;
-
- /**
- * @see _.some
- **/
- any<T>(
- collection: Dictionary<T>,
- callback?: DictionaryIterator<T, boolean>,
- thisArg?: any): boolean;
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): boolean;
/**
* @see _.some
- **/
- any(
- collection: {},
- callback?: ListIterator<{}, boolean>,
- thisArg?: any): boolean;
+ */
+ some(
+ predicate?: string,
+ thisArg?: any
+ ): boolean;
/**
- * @see _.some
- * @param pluckValue _.pluck style callback
- **/
- any<T>(
- collection: Array<T>,
- pluckValue: string): boolean;
+ * @see _.some
+ */
+ some<TObject extends {}>(
+ predicate?: TObject
+ ): boolean;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.some
+ */
+ some<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): boolean;
/**
- * @see _.some
- * @param pluckValue _.pluck style callback
- **/
- any<T>(
- collection: List<T>,
- pluckValue: string): boolean;
+ * @see _.some
+ */
+ some(
+ predicate?: string,
+ thisArg?: any
+ ): boolean;
/**
- * @see _.some
- * @param pluckValue _.pluck style callback
- **/
- any<T>(
- collection: Dictionary<T>,
- pluckValue: string): boolean;
+ * @see _.some
+ */
+ some<TObject extends {}>(
+ predicate?: TObject
+ ): boolean;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.some
+ */
+ some(
+ predicate?: ListIterator<T, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
/**
- * @see _.some
- * @param whereValue _.where style callback
- **/
- any<W, T>(
- collection: Array<T>,
- whereValue: W): boolean;
+ * @see _.some
+ */
+ some(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
/**
- * @see _.some
- * @param whereValue _.where style callback
- **/
- any<W, T>(
- collection: List<T>,
- whereValue: W): boolean;
+ * @see _.some
+ */
+ some<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.some
+ */
+ some<TResult>(
+ predicate?: ListIterator<TResult, boolean>|DictionaryIterator<TResult, boolean>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
/**
- * @see _.some
- * @param whereValue _.where style callback
- **/
- any<W, T>(
- collection: Dictionary<T>,
- whereValue: W): boolean;
+ * @see _.some
+ */
+ some(
+ predicate?: string,
+ thisArg?: any
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.some
+ */
+ some<TObject extends {}>(
+ predicate?: TObject
+ ): LoDashExplicitWrapper<boolean>;
}
//_.sortBy
@@ -5531,31 +6320,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
@@ -5604,18 +6393,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
@@ -5667,54 +6456,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
@@ -5745,11 +6500,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>;
}
/********
@@ -5759,13 +6514,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 *
*************/
@@ -5784,11 +6553,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
@@ -5803,11 +6572,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
@@ -5818,11 +6587,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
@@ -5838,7 +6607,7 @@ declare module _ {
before<TFunc extends Function>(n: number, func: TFunc): TFunc;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @sed _.before
*/
@@ -5861,13 +6630,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
@@ -5886,11 +6655,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
@@ -5911,13 +6680,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
@@ -5928,11 +6697,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
@@ -5961,26 +6730,71 @@ 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
interface LoDashStatic {
+ /**
+ * Creates a function that accepts one or more arguments of func that when called either invokes func returning
+ * its result, if all func arguments have been provided, or returns a function that accepts one or more of the
+ * remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curry<T1, R>(func: (t1: T1) => R):
+ CurriedFunction1<T1, R>;
+ /**
+ * Creates a function that accepts one or more arguments of func that when called either invokes func returning
+ * its result, if all func arguments have been provided, or returns a function that accepts one or more of the
+ * remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curry<T1, T2, R>(func: (t1: T1, t2: T2) => R):
+ CurriedFunction2<T1, T2, R>;
+ /**
+ * Creates a function that accepts one or more arguments of func that when called either invokes func returning
+ * its result, if all func arguments have been provided, or returns a function that accepts one or more of the
+ * remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curry<T1, T2, T3, R>(func: (t1: T1, t2: T2, t3: T3) => R):
+ CurriedFunction3<T1, T2, T3, R>;
+ /**
+ * Creates a function that accepts one or more arguments of func that when called either invokes func returning
+ * its result, if all func arguments have been provided, or returns a function that accepts one or more of the
+ * remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curry<T1, T2, T3, T4, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4) => R):
+ CurriedFunction4<T1, T2, T3, T4, R>;
+ /**
+ * Creates a function that accepts one or more arguments of func that when called either invokes func returning
+ * its result, if all func arguments have been provided, or returns a function that accepts one or more of the
+ * remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curry<T1, T2, T3, T4, T5, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5) => R):
+ CurriedFunction5<T1, T2, T3, T4, T5, R>;
/**
* Creates a function that accepts one or more arguments of func that when called either invokes func returning
* its result, if all func arguments have been provided, or returns a function that accepts one or more of the
@@ -5990,19 +6804,94 @@ declare module _ {
* @return Returns the new curried function.
*/
curry<TResult extends Function>(
- func: Function,
- arity?: number): TResult;
+ func: Function,
+ arity?: number): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface CurriedFunction1<T1, R> {
+ (): CurriedFunction1<T1, R>;
+ (t1: T1): R;
+ }
+
+ interface CurriedFunction2<T1, T2, R> {
+ (): CurriedFunction2<T1, T2, R>;
+ (t1: T1): CurriedFunction1<T2, R>;
+ (t1: T1, t2: T2): R;
+ }
+
+ interface CurriedFunction3<T1, T2, T3, R> {
+ (): CurriedFunction3<T1, T2, T3, R>;
+ (t1: T1): CurriedFunction2<T2, T3, R>;
+ (t1: T1, t2: T2): CurriedFunction1<T3, R>;
+ (t1: T1, t2: T2, t3: T3): R;
+ }
+
+ interface CurriedFunction4<T1, T2, T3, T4, R> {
+ (): CurriedFunction4<T1, T2, T3, T4, R>;
+ (t1: T1): CurriedFunction3<T2, T3, T4, R>;
+ (t1: T1, t2: T2): CurriedFunction2<T3, T4, R>;
+ (t1: T1, t2: T2, t3: T3): CurriedFunction1<T4, R>;
+ (t1: T1, t2: T2, t3: T3, t4: T4): R;
+ }
+
+ interface CurriedFunction5<T1, T2, T3, T4, T5, R> {
+ (): CurriedFunction5<T1, T2, T3, T4, T5, R>;
+ (t1: T1): CurriedFunction4<T2, T3, T4, T5, R>;
+ (t1: T1, t2: T2): CurriedFunction3<T3, T4, T5, R>;
+ (t1: T1, t2: T2, t3: T3): CurriedFunction2<T4, T5, R>;
+ (t1: T1, t2: T2, t3: T3, t4: T4): CurriedFunction1<T5, R>;
+ (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.curry
**/
- curry<TResult extends Function>(arity?: number): LoDashObjectWrapper<TResult>;
+ curry<TResult extends Function>(arity?: number): LoDashImplicitObjectWrapper<TResult>;
}
//_.curryRight
interface LoDashStatic {
+ /**
+ * This method is like _.curry except that arguments are applied to func in the manner of _.partialRight
+ * instead of _.partial.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curryRight<T1, R>(func: (t1: T1) => R):
+ CurriedFunction1<T1, R>;
+ /**
+ * This method is like _.curry except that arguments are applied to func in the manner of _.partialRight
+ * instead of _.partial.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curryRight<T1, T2, R>(func: (t1: T1, t2: T2) => R):
+ CurriedFunction2<T2, T1, R>;
+ /**
+ * This method is like _.curry except that arguments are applied to func in the manner of _.partialRight
+ * instead of _.partial.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curryRight<T1, T2, T3, R>(func: (t1: T1, t2: T2, t3: T3) => R):
+ CurriedFunction3<T3, T2, T1, R>;
+ /**
+ * This method is like _.curry except that arguments are applied to func in the manner of _.partialRight
+ * instead of _.partial.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curryRight<T1, T2, T3, T4, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4) => R):
+ CurriedFunction4<T4, T3, T2, T1, R>;
+ /**
+ * This method is like _.curry except that arguments are applied to func in the manner of _.partialRight
+ * instead of _.partial.
+ * @param func The function to curry.
+ * @return Returns the new curried function.
+ */
+ curryRight<T1, T2, T3, T4, T5, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5) => R):
+ CurriedFunction5<T5, T4, T3, T2, T1, R>;
/**
* This method is like _.curry except that arguments are applied to func in the manner of _.partialRight
* instead of _.partial.
@@ -6011,15 +6900,15 @@ declare module _ {
* @return Returns the new curried function.
*/
curryRight<TResult extends Function>(
- func: Function,
- arity?: number): TResult;
+ func: Function,
+ 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
@@ -6047,13 +6936,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 {
@@ -6087,11 +6976,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
@@ -6110,13 +6999,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
@@ -6130,11 +7019,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
@@ -6148,11 +7037,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
@@ -6175,11 +7064,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
@@ -6205,16 +7094,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
@@ -6233,16 +7122,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
@@ -6257,11 +7146,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
@@ -6274,9 +7163,66 @@ declare module _ {
* @param args Arguments to be partially applied.
* @return The new partially applied function.
**/
- partial(
- func: Function,
- ...args: any[]): Function;
+ partial: Partial;
+ }
+
+ type PH = LoDashStatic;
+
+ interface Function0<R> {
+ (): R;
+ }
+ interface Function1<T1, R> {
+ (t1: T1): R;
+ }
+ interface Function2<T1, T2, R> {
+ (t1: T1, t2: T2): R;
+ }
+ interface Function3<T1, T2, T3, R> {
+ (t1: T1, t2: T2, t3: T3): R;
+ }
+ interface Function4<T1, T2, T3, T4, R> {
+ (t1: T1, t2: T2, t3: T3, t4: T4): R;
+ }
+
+ interface Partial {
+ // arity 0
+ <R>(func: Function0<R>): Function0<R>;
+ // arity 1
+ <T1, R>(func: Function1<T1, R>): Function1<T1, R>;
+ <T1, R>(func: Function1<T1, R>, arg1: T1): Function0<R>;
+ // arity 2
+ <T1, T2, R>(func: Function2<T1, T2, R>): Function2<T1, T2, R>;
+ <T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1): Function1< T2, R>;
+ <T1, T2, R>(func: Function2<T1, T2, R>, plc1: PH, arg2: T2): Function1<T1, R>;
+ <T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, arg2: T2): Function0< R>;
+ // arity 3
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>): Function3<T1, T2, T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1): Function2< T2, T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: PH, arg2: T2): Function2<T1, T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2): Function1< T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: PH, plc2: PH, arg3: T3): Function2<T1, T2, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: PH, arg3: T3): Function1< T2, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: PH, arg2: T2, arg3: T3): Function1<T1, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): Function0< R>;
+ // arity 4
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>): Function4<T1, T2, T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1): Function3< T2, T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2): Function3<T1, T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2): Function2< T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, plc2: PH, arg3: T3): Function3<T1, T2, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3): Function2< T2, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2, arg3: T3): Function2<T1, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3): Function1< T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, plc2: PH, plc3: PH, arg4: T4): Function3<T1, T2, T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, plc3: PH, arg4: T4): Function2< T2, T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2, plc3: PH, arg4: T4): Function2<T1, T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: PH, arg4: T4): Function1< T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, plc2: PH, arg3: T3, arg4: T4): Function2<T1, T2, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3, arg4: T4): Function1< T2, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function0< R>;
+ // catch-all
+ (func: Function, ...args: any[]): Function;
}
//_.partialRight
@@ -6288,9 +7234,48 @@ declare module _ {
* @param args Arguments to be partially applied.
* @return The new partially applied function.
**/
- partialRight(
- func: Function,
- ...args: any[]): Function;
+ partialRight: PartialRight
+ }
+
+ interface PartialRight {
+ // arity 0
+ <R>(func: Function0<R>): Function0<R>;
+ // arity 1
+ <T1, R>(func: Function1<T1, R>): Function1<T1, R>;
+ <T1, R>(func: Function1<T1, R>, arg1: T1): Function0<R>;
+ // arity 2
+ <T1, T2, R>(func: Function2<T1, T2, R>): Function2<T1, T2, R>;
+ <T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, plc2: PH): Function1< T2, R>;
+ <T1, T2, R>(func: Function2<T1, T2, R>, arg2: T2): Function1<T1, R>;
+ <T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, arg2: T2): Function0< R>;
+ // arity 3
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>): Function3<T1, T2, T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: PH, plc3: PH): Function2< T2, T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, plc3: PH): Function2<T1, T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, plc3: PH): Function1< T3, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg3: T3): Function2<T1, T2, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: PH, arg3: T3): Function1< T2, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, arg3: T3): Function1<T1, R>;
+ <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): Function0< R>;
+ // arity 4
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>): Function4<T1, T2, T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, plc3: PH, plc4: PH): Function3< T2, T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: PH, plc4: PH): Function3<T1, T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: PH, plc4: PH): Function2< T3, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg3: T3, plc4: PH): Function3<T1, T2, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3, plc4: PH): Function2< T2, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, plc4: PH): Function2<T1, T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, plc4: PH): Function1< T4, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg4: T4): Function3<T1, T2, T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, plc3: PH, arg4: T4): Function2< T2, T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: PH, arg4: T4): Function2<T1, T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: PH, arg4: T4): Function1< T3, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg3: T3, arg4: T4): Function2<T1, T2, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3, arg4: T4): Function1< T2, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>;
+ <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function0< R>;
+ // catch-all
+ (func: Function, ...args: any[]): Function;
}
//_.rearg
@@ -6311,16 +7296,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
@@ -6340,11 +7325,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
@@ -6358,11 +7343,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>;
}
@@ -6452,7 +7437,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.clone
*/
@@ -6469,7 +7454,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.clone
*/
@@ -6486,7 +7471,7 @@ declare module _ {
thisArg?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.clone
*/
@@ -6523,7 +7508,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.cloneDeep
*/
@@ -6532,7 +7517,7 @@ declare module _ {
thisArg?: any): T;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.cloneDeep
*/
@@ -6541,7 +7526,7 @@ declare module _ {
thisArg?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.cloneDeep
*/
@@ -6550,6 +7535,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 {
/**
@@ -6561,7 +7570,7 @@ declare module _ {
gt(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.gt
*/
@@ -6579,7 +7588,7 @@ declare module _ {
gte(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.gte
*/
@@ -6593,10 +7602,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
*/
- isArguments(value?: any): boolean;
+ isArguments(value?: any): value is IArguments;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isArguments
*/
@@ -6610,10 +7619,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
**/
- isArray(value?: any): boolean;
+ isArray(value?: any): value is any[];
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.isArray
*/
@@ -6627,10 +7636,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
**/
- isBoolean(value?: any): boolean;
+ isBoolean(value?: any): value is boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isBoolean
*/
@@ -6644,10 +7653,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
**/
- isDate(value?: any): boolean;
+ isDate(value?: any): value is Date;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isDate
*/
@@ -6664,7 +7673,7 @@ declare module _ {
isElement(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isElement
*/
@@ -6682,13 +7691,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 {
/**
@@ -6697,10 +7749,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is an error object, else false.
*/
- isError(value: any): boolean;
+ isError(value: any): value is Error;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isError
*/
@@ -6715,10 +7767,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is a finite number, else false.
**/
- isFinite(value?: any): boolean;
+ isFinite(value?: any): value is number;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isFinite
*/
@@ -6732,10 +7784,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
**/
- isFunction(value?: any): boolean;
+ isFunction(value?: any): value is Function;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isFunction
*/
@@ -6762,7 +7814,7 @@ declare module _ {
isMatch(object: Object, source: Object, customizer?: isMatchCustomizer, thisArg?: any): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.isMatch
*/
@@ -6780,7 +7832,7 @@ declare module _ {
isNaN(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.isNaN
*/
@@ -6794,10 +7846,10 @@ declare module _ {
* @param value The value to check.
* @retrun Returns true if value is a native function, else false.
*/
- isNative(value: any): boolean;
+ isNative(value: any): value is Function;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isNative
*/
@@ -6814,7 +7866,7 @@ declare module _ {
isNull(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isNull
*/
@@ -6829,10 +7881,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
*/
- isNumber(value?: any): boolean;
+ isNumber(value?: any): value is number;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isNumber
*/
@@ -6850,7 +7902,7 @@ declare module _ {
isObject(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isObject
*/
@@ -6871,7 +7923,7 @@ declare module _ {
isPlainObject(value?: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isPlainObject
*/
@@ -6885,10 +7937,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
*/
- isRegExp(value?: any): boolean;
+ isRegExp(value?: any): value is RegExp;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isRegExp
*/
@@ -6902,10 +7954,10 @@ declare module _ {
* @param value The value to check.
* @return Returns true if value is correctly classified, else false.
**/
- isString(value?: any): boolean;
+ isString(value?: any): value is string;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isString
*/
@@ -6922,7 +7974,7 @@ declare module _ {
isTypedArray(value: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isTypedArray
*/
@@ -6939,7 +7991,7 @@ declare module _ {
isUndefined(value: any): boolean;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* see _.isUndefined
*/
@@ -6957,7 +8009,7 @@ declare module _ {
lt(value: any, other: any): boolean;
}
- interface LoDashWrapperBase<T,TWrapper> {
+ interface LoDashImplicitWrapperBase<T,TWrapper> {
/**
* @see _.lt
*/
@@ -6975,22 +8027,82 @@ 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 {
/**
* Converts value to a plain object flattening inherited enumerable properties of value to own properties
* of the plain object.
+ *
* @param value The value to convert.
* @return Returns the converted plain object.
*/
- toPlainObject(value?: any): Object;
+ toPlainObject<TResult extends {}>(value?: any): TResult;
+ }
+
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.toPlainObject
+ */
+ toPlainObject<TResult extends {}>(): LoDashImplicitObjectWrapper<TResult>;
}
/********
@@ -7001,20 +8113,450 @@ declare module _ {
interface LoDashStatic {
/**
* Adds two numbers.
+ *
* @param augend The first number to add.
* @param addend The second number to add.
* @return Returns the sum.
*/
- add(augend: number, addend: number): number;
+ add(
+ augend: number,
+ addend: number
+ ): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.add
*/
add(addend: number): number;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.add
+ */
+ add(addend: number): LoDashExplicitWrapper<number>;
+ }
+
+ //_.ceil
+ interface LoDashStatic {
+ /**
+ * Calculates n rounded up to precision.
+ *
+ * @param n The number to round up.
+ * @param precision The precision to round up to.
+ * @return Returns the rounded up number.
+ */
+ ceil(
+ n: number,
+ precision?: number
+ ): number;
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.ceil
+ */
+ ceil(precision?: number): number;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.ceil
+ */
+ ceil(precision?: number): LoDashExplicitWrapper<number>;
+ }
+
+ //_.floor
+ interface LoDashStatic {
+ /**
+ * Calculates n rounded down to precision.
+ *
+ * @param n The number to round down.
+ * @param precision The precision to round down to.
+ * @return Returns the rounded down number.
+ */
+ floor(
+ n: number,
+ precision?: number
+ ): number;
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.floor
+ */
+ floor(precision?: number): number;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.floor
+ */
+ floor(precision?: number): LoDashExplicitWrapper<number>;
+ }
+
+ //_.max
+ interface LoDashStatic {
+ /**
+ * Gets the maximum value of collection. If collection is empty or falsey -Infinity is returned. If an iteratee
+ * function is provided it’s invoked for each value in collection to generate the criterion by which the value
+ * is ranked. The iteratee is bound to thisArg and invoked with three arguments: (value, index, collection).
+ *
+ * If a property name is provided for iteratee 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 iteratee the created _.matches style callback returns true for elements that
+ * have the properties of the given object, else false.
+ *
+ * @param collection The collection to iterate over.
+ * @param iteratee The function invoked per iteration.
+ * @param thisArg The this binding of iteratee.
+ * @return Returns the maximum value.
+ */
+ max<T>(
+ collection: List<T>,
+ iteratee?: ListIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max<T>(
+ collection: Dictionary<T>,
+ iteratee?: DictionaryIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max<T>(
+ collection: List<T>|Dictionary<T>,
+ iteratee?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max<TObject extends {}, T>(
+ collection: List<T>|Dictionary<T>,
+ whereValue?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.max
+ */
+ max(
+ iteratee?: ListIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max(
+ iteratee?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max<TObject extends {}>(
+ whereValue?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.max
+ */
+ max<T>(
+ iteratee?: ListIterator<T, any>|DictionaryIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max<T>(
+ iteratee?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.max
+ */
+ max<TObject extends {}, T>(
+ whereValue?: TObject
+ ): T;
+ }
+
+ //_.min
+ interface LoDashStatic {
+ /**
+ * Gets the minimum value of collection. If collection is empty or falsey Infinity is returned. If an iteratee
+ * function is provided it’s invoked for each value in collection to generate the criterion by which the value
+ * is ranked. The iteratee is bound to thisArg and invoked with three arguments: (value, index, collection).
+ *
+ * If a property name is provided for iteratee 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 iteratee the created _.matches style callback returns true for elements that
+ * have the properties of the given object, else false.
+ *
+ * @param collection The collection to iterate over.
+ * @param iteratee The function invoked per iteration.
+ * @param thisArg The this binding of iteratee.
+ * @return Returns the minimum value.
+ */
+ min<T>(
+ collection: List<T>,
+ iteratee?: ListIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min<T>(
+ collection: Dictionary<T>,
+ iteratee?: DictionaryIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min<T>(
+ collection: List<T>|Dictionary<T>,
+ iteratee?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min<TObject extends {}, T>(
+ collection: List<T>|Dictionary<T>,
+ whereValue?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.min
+ */
+ min(
+ iteratee?: ListIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min(
+ iteratee?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min<TObject extends {}>(
+ whereValue?: TObject
+ ): T;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.min
+ */
+ min<T>(
+ iteratee?: ListIterator<T, any>|DictionaryIterator<T, any>,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min<T>(
+ iteratee?: string,
+ thisArg?: any
+ ): T;
+
+ /**
+ * @see _.min
+ */
+ min<TObject extends {}, T>(
+ whereValue?: TObject
+ ): T;
+ }
+
+ //_.round
+ interface LoDashStatic {
+ /**
+ * Calculates n rounded to precision.
+ *
+ * @param n The number to round.
+ * @param precision The precision to round to.
+ * @return Returns the rounded number.
+ */
+ round(
+ n: number,
+ precision?: number
+ ): number;
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.round
+ */
+ round(precision?: number): number;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.round
+ */
+ round(precision?: number): LoDashExplicitWrapper<number>;
+ }
+
+ //_.sum
+ interface LoDashStatic {
+ /**
+ * Gets the sum of the values in collection.
+ *
+ * @param collection The collection to iterate over.
+ * @param iteratee The function invoked per iteration.
+ * @param thisArg The this binding of iteratee.
+ * @return Returns the sum.
+ */
+ sum<T>(
+ collection: List<T>,
+ iteratee: ListIterator<T, number>,
+ thisArg?: any
+ ): number;
+
+ /**
+ * @see _.sum
+ **/
+ sum<T>(
+ collection: Dictionary<T>,
+ iteratee: DictionaryIterator<T, number>,
+ thisArg?: any
+ ): number;
+
+ /**
+ * @see _.sum
+ */
+ sum<T>(
+ collection: List<number>|Dictionary<number>,
+ iteratee: string
+ ): number;
+
+ /**
+ * @see _.sum
+ */
+ sum<T>(collection: List<T>|Dictionary<T>): number;
+
+ /**
+ * @see _.sum
+ */
+ sum(collection: List<number>|Dictionary<number>): number;
+ }
+
+ interface LoDashImplicitArrayWrapper<T> {
+ /**
+ * @see _.sum
+ */
+ sum(
+ iteratee: ListIterator<T, number>,
+ thisArg?: any
+ ): number;
+
+ /**
+ * @see _.sum
+ */
+ sum(iteratee: string): number;
+
+ /**
+ * @see _.sum
+ */
+ sum(): number;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.sum
+ **/
+ sum<TValue>(
+ iteratee: ListIterator<TValue, number>|DictionaryIterator<TValue, number>,
+ thisArg?: any
+ ): number;
+
+ /**
+ * @see _.sum
+ */
+ sum(iteratee: string): number;
+
+ /**
+ * @see _.sum
+ */
+ sum(): number;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.sum
+ */
+ sum(
+ iteratee: ListIterator<T, number>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.sum
+ */
+ sum(iteratee: string): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.sum
+ */
+ sum(): LoDashExplicitWrapper<number>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.sum
+ */
+ sum<TValue>(
+ iteratee: ListIterator<TValue, number>|DictionaryIterator<TValue, number>,
+ thisArg?: any
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.sum
+ */
+ sum(iteratee: string): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.sum
+ */
+ sum(): LoDashExplicitWrapper<number>;
+ }
+
/**********
* Number *
**********/
@@ -7024,25 +8566,36 @@ declare module _ {
/**
* Checks if n is between start and up to but not including, end. If end is not specified it’s set to start
* with start then set to 0.
+ *
* @param n The number to check.
* @param start The start of the range.
* @param end The end of the range.
* @return Returns true if n is in the range, else false.
*/
- inRange(n: number, start: number, end: number): boolean;
+ inRange(
+ n: number,
+ start: number,
+ end: number
+ ): boolean;
/**
* @see _.inRange
*/
- inRange(n: number, end: number): boolean;
+ inRange(
+ n: number,
+ end: number
+ ): boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.inRange
*/
- inRange(start: number, end: number): boolean;
+ inRange(
+ start: number,
+ end: number
+ ): boolean;
/**
* @see _.inRange
@@ -7050,6 +8603,83 @@ declare module _ {
inRange(end: number): boolean;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.inRange
+ */
+ inRange(
+ start: number,
+ end: number
+ ): LoDashExplicitWrapper<boolean>;
+
+ /**
+ * @see _.inRange
+ */
+ inRange(end: number): LoDashExplicitWrapper<boolean>;
+ }
+
+ //_.random
+ interface LoDashStatic {
+ /**
+ * Produces a random number between min and max (inclusive). If only one argument is provided a number between
+ * 0 and the given number is returned. If floating is true, or either min or max are floats, a floating-point
+ * number is returned instead of an integer.
+ *
+ * @param min The minimum possible value.
+ * @param max The maximum possible value.
+ * @param floating Specify returning a floating-point number.
+ * @return Returns the random number.
+ */
+ random(
+ min?: number,
+ max?: number,
+ floating?: boolean
+ ): number;
+
+ /**
+ * @see _.random
+ */
+ random(
+ min?: number,
+ floating?: boolean
+ ): number;
+
+ /**
+ * @see _.random
+ */
+ random(floating?: boolean): number;
+ }
+
+ interface LoDashImplicitWrapper<T> {
+ /**
+ * @see _.random
+ */
+ random(
+ max?: number,
+ floating?: boolean
+ ): number;
+
+ /**
+ * @see _.random
+ */
+ random(floating?: boolean): number;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.random
+ */
+ random(
+ max?: number,
+ floating?: boolean
+ ): LoDashExplicitWrapper<number>;
+
+ /**
+ * @see _.random
+ */
+ random(floating?: boolean): LoDashExplicitWrapper<number>;
+ }
+
/**********
* Object *
**********/
@@ -7149,7 +8779,7 @@ declare module _ {
thisArg?: any): Result;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.assign
**/
@@ -7258,11 +8888,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
@@ -7280,11 +8910,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
@@ -7300,11 +8930,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
@@ -7360,7 +8990,7 @@ declare module _ {
): string;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.findKey
*/
@@ -7396,32 +9026,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
@@ -7449,13 +9133,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
@@ -7482,13 +9166,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
@@ -7516,13 +9200,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
@@ -7548,13 +9232,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
@@ -7573,16 +9257,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
@@ -7601,7 +9285,7 @@ declare module _ {
): TResult;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.get
**/
@@ -7622,7 +9306,7 @@ declare module _ {
has(object: any, path: string|number|boolean|Array<string|number|boolean>): boolean;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.has
*/
@@ -7642,91 +9326,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
@@ -7739,11 +9343,11 @@ declare module _ {
keys(object?: any): string[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.keys
**/
- keys(): LoDashArrayWrapper<string>
+ keys(): LoDashImplicitArrayWrapper<string>
}
//_.keysIn
@@ -7756,11 +9360,11 @@ declare module _ {
keysIn(object?: any): string[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.keysIn
**/
- keysIn(): LoDashArrayWrapper<string>
+ keysIn(): LoDashImplicitArrayWrapper<string>
}
//_.mapKeys
@@ -7806,52 +9410,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
@@ -7881,89 +9485,156 @@ 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
+ interface MergeCustomizer {
+ (value: any, srcValue: any, key?: string, object?: Object, source?: Object): any;
+ }
+
interface LoDashStatic {
/**
- * Recursively merges own enumerable properties of the source object(s), that don't resolve
- * to undefined into the destination object. Subsequent sources will overwrite property
- * assignments of previous sources. If a callback is provided it will be executed to produce
- * the merged values of the destination and source properties. If the callback returns undefined
- * merging will be handled by the method instead. The callback is bound to thisArg and invoked
- * with two arguments; (objectValue, sourceValue).
- * @param object The destination object.
- * @param s1-8 The source object(s)
- * @param callback The function to customize merging properties.
- * @param thisArg The this binding of callback.
- * @return The destination object.
- **/
- merge<P, T, S1, Value, Result>(
- object: T,
- s1: S1,
- callback?: (objectValue: Value, sourceValue: Value) => Value,
- thisArg?: any): Result;
+ * Recursively merges own enumerable properties of the source object(s), that don’t resolve to undefined into
+ * the destination object. Subsequent sources overwrite property assignments of previous sources. If customizer
+ * is provided it’s invoked to produce the merged values of the destination and source properties. If
+ * customizer returns undefined merging is handled by the method instead. The customizer is bound to thisArg
+ * and invoked with five arguments: (objectValue, sourceValue, key, object, source).
+ *
+ * @param object The destination object.
+ * @param source The source objects.
+ * @param customizer The function to customize assigned values.
+ * @param thisArg The this binding of customizer.
+ * @return Returns object.
+ */
+ merge<TObject, TSource, TResult>(
+ object: TObject,
+ source: TSource,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): TResult;
/**
- * @see _.merge
- **/
- merge<P, T, S1, S2, Value, Result>(
- object: T,
- s1: S1,
- s2: S2,
- callback?: (objectValue: Value, sourceValue: Value) => Value,
- thisArg?: any): Result;
+ * @see _.merge
+ */
+ merge<TObject, TSource1, TSource2, TResult>(
+ object: TObject,
+ source1: TSource1,
+ source2: TSource2,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): TResult;
/**
- * @see _.merge
- **/
- merge<P, T, S1, S2, S3, Value, Result>(
- object: T,
- s1: S1,
- s2: S2,
- s3: S3,
- callback?: (objectValue: Value, sourceValue: Value) => Value,
- thisArg?: any): Result;
+ * @see _.merge
+ */
+ merge<TObject, TSource1, TSource2, TSource3, TResult>(
+ object: TObject,
+ source1: TSource1,
+ source2: TSource2,
+ source3: TSource3,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): TResult;
/**
- * @see _.merge
- **/
- merge<P, T, S1, S2, S3, S4, Value, Result>(
- object: T,
- s1: S1,
- s2: S2,
- s3: S3,
- s4: S4,
- callback?: (objectValue: Value, sourceValue: Value) => Value,
- thisArg?: any): Result;
+ * @see _.merge
+ */
+ merge<TObject, TSource1, TSource2, TSource3, TSource4, TResult>(
+ object: TObject,
+ source1: TSource1,
+ source2: TSource2,
+ source3: TSource3,
+ source4: TSource4,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): TResult;
+
+ /**
+ * @see _.merge
+ */
+ merge<TObject, TResult>(
+ object: TObject,
+ ...otherArgs: any[]
+ ): TResult;
+ }
+
+ interface LoDashImplicitObjectWrapper<T> {
+ /**
+ * @see _.merge
+ */
+ merge<TSource, TResult>(
+ source: TSource,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.merge
+ */
+ merge<TSource1, TSource2, TResult>(
+ source1: TSource1,
+ source2: TSource2,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.merge
+ */
+ merge<TSource1, TSource2, TSource3, TResult>(
+ source1: TSource1,
+ source2: TSource2,
+ source3: TSource3,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.merge
+ */
+ merge<TSource1, TSource2, TSource3, TSource4, TResult>(
+ source1: TSource1,
+ source2: TSource2,
+ source3: TSource3,
+ source4: TSource4,
+ customizer?: MergeCustomizer,
+ thisArg?: any
+ ): LoDashImplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.merge
+ */
+ merge<TResult>(
+ ...otherArgs: any[]
+ ): LoDashImplicitObjectWrapper<TResult>;
}
//_.omit
@@ -7998,25 +9669,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
@@ -8030,11 +9701,11 @@ declare module _ {
pairs(object?: any): any[][];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.pairs
**/
- pairs(): LoDashArrayWrapper<any[]>;
+ pairs(): LoDashImplicitArrayWrapper<any[]>;
}
//_.pick
@@ -8066,21 +9737,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
@@ -8101,7 +9772,7 @@ declare module _ {
): TResult;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.result
*/
@@ -8128,14 +9799,14 @@ declare module _ {
): T;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.set
*/
set(
path: StringRepresentable|StringRepresentable[],
value: any
- ): LoDashObjectWrapper<T>;
+ ): LoDashImplicitObjectWrapper<T>;
}
//_.transform
@@ -8190,7 +9861,7 @@ declare module _ {
): TResult[];
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.transform
*/
@@ -8198,7 +9869,7 @@ declare module _ {
iteratee?: MemoVoidArrayIterator<T, TResult[]>,
accumulator?: TResult[],
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
/**
* @see _.transform
@@ -8207,10 +9878,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
*/
@@ -8218,7 +9889,7 @@ declare module _ {
iteratee?: MemoVoidDictionaryIterator<T, Dictionary<TResult>>,
accumulator?: Dictionary<TResult>,
thisArg?: any
- ): LoDashObjectWrapper<Dictionary<TResult>>;
+ ): LoDashImplicitObjectWrapper<Dictionary<TResult>>;
/**
* @see _.transform
@@ -8227,7 +9898,7 @@ declare module _ {
iteratee?: MemoVoidDictionaryIterator<T, TResult[]>,
accumulator?: TResult[],
thisArg?: any
- ): LoDashArrayWrapper<TResult>;
+ ): LoDashImplicitArrayWrapper<TResult>;
}
//_.values
@@ -8240,11 +9911,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
@@ -8257,11 +9928,11 @@ declare module _ {
valuesIn<T>(object?: any): T[];
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.valuesIn
**/
- valuesIn<TResult>(): LoDashObjectWrapper<TResult[]>;
+ valuesIn<TResult>(): LoDashImplicitObjectWrapper<TResult[]>;
}
/**********
@@ -8272,137 +9943,232 @@ declare module _ {
interface LoDashStatic {
/**
* Converts string to camel case.
+ *
* @param string The string to convert.
* @return Returns the camel cased string.
*/
camelCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.camelCase
*/
camelCase(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.camelCase
+ */
+ camelCase(): LoDashExplicitWrapper<string>;
+ }
+
//_.capitalize
interface LoDashStatic {
capitalize(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.capitalize
*/
capitalize(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.capitalize
+ */
+ capitalize(): LoDashExplicitWrapper<string>;
+ }
+
//_.deburr
interface LoDashStatic {
/**
* Deburrs string by converting latin-1 supplementary letters to basic latin letters and removing combining
* diacritical marks.
+ *
* @param string The string to deburr.
* @return Returns the deburred string.
*/
deburr(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.deburr
*/
deburr(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.deburr
+ */
+ deburr(): LoDashExplicitWrapper<string>;
+ }
+
//_.endsWith
interface LoDashStatic {
/**
* Checks if string ends with the given target string.
+ *
* @param string The string to search.
* @param target The string to search for.
* @param position The position to search from.
* @return Returns true if string ends with target, else false.
*/
- endsWith(string?: string, target?: string, position?: number): boolean;
+ endsWith(
+ string?: string,
+ target?: string,
+ position?: number
+ ): boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.endsWith
*/
- endsWith(target?: string, position?: number): boolean;
+ endsWith(
+ target?: string,
+ position?: number
+ ): boolean;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.endsWith
+ */
+ endsWith(
+ target?: string,
+ position?: number
+ ): LoDashExplicitWrapper<boolean>;
}
// _.escape
interface LoDashStatic {
/**
* Converts the characters "&", "<", ">", '"', "'", and "`", in string to their corresponding HTML entities.
+ *
+ * Note: No other characters are escaped. To escape additional characters use a third-party library like he.
+ *
+ * Though the ">" character is escaped for symmetry, characters like ">" and "/" don’t need escaping in HTML
+ * and have no special meaning unless they're part of a tag or unquoted attribute value. See Mathias Bynens’s
+ * article (under "semi-related fun fact") for more details.
+ *
+ * Backticks are escaped because in Internet Explorer < 9, they can break out of attribute values or HTML
+ * comments. See #59, #102, #108, and #133 of the HTML5 Security Cheatsheet for more details.
+ *
+ * When working with HTML you should always quote attribute values to reduce XSS vectors.
+ *
* @param string The string to escape.
* @return Returns the escaped string.
*/
escape(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.escape
*/
escape(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.escape
+ */
+ escape(): LoDashExplicitWrapper<string>;
+ }
+
// _.escapeRegExp
interface LoDashStatic {
/**
* Escapes the RegExp special characters "\", "/", "^", "$", ".", "|", "?", "*", "+", "(", ")", "[", "]",
* "{" and "}" in string.
+ *
* @param string The string to escape.
* @return Returns the escaped string.
*/
escapeRegExp(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.escapeRegExp
*/
escapeRegExp(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.escapeRegExp
+ */
+ escapeRegExp(): LoDashExplicitWrapper<string>;
+ }
+
//_.kebabCase
interface LoDashStatic {
/**
* Converts string to kebab case.
+ *
* @param string The string to convert.
* @return Returns the kebab cased string.
*/
kebabCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.kebabCase
*/
kebabCase(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.kebabCase
+ */
+ kebabCase(): LoDashExplicitWrapper<string>;
+ }
+
+ //_.pad
interface LoDashStatic {
/**
+ * Pads string on the left and right sides if it’s shorter than length. Padding characters are truncated if
+ * they can’t be evenly divided by length.
*
* @param string The string to pad.
* @param length The padding length.
* @param chars The string used as padding.
* @return Returns the padded string.
*/
- pad(string?: string, length?: number, chars?: string): string;
+ pad(
+ string?: string,
+ length?: number,
+ chars?: string
+ ): string;
}
- //_.pad
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.pad
*/
- pad(length?: number, chars?: string): string;
+ pad(
+ length?: number,
+ chars?: string
+ ): string;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.pad
+ */
+ pad(
+ length?: number,
+ chars?: string
+ ): LoDashExplicitWrapper<string>;
}
//_.padLeft
@@ -8410,20 +10176,37 @@ declare module _ {
/**
* Pads string on the left side if it’s shorter than length. Padding characters are truncated if they exceed
* length.
+ *
* @param string The string to pad.
* @param length The padding length.
* @param chars The string used as padding.
* @return Returns the padded string.
*/
- padLeft(string?: string, length?: number, chars?: string): string;
+ padLeft(
+ string?: string,
+ length?: number,
+ chars?: string
+ ): string;
}
- //_.padLeft
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.padLeft
*/
- padLeft(length?: number, chars?: string): string;
+ padLeft(
+ length?: number,
+ chars?: string
+ ): string;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.padLeft
+ */
+ padLeft(
+ length?: number,
+ chars?: string
+ ): LoDashExplicitWrapper<string>;
}
//_.padRight
@@ -8431,20 +10214,37 @@ declare module _ {
/**
* Pads string on the right side if it’s shorter than length. Padding characters are truncated if they exceed
* length.
+ *
* @param string The string to pad.
* @param length The padding length.
* @param chars The string used as padding.
* @return Returns the padded string.
*/
- padRight(string?: string, length?: number, chars?: string): string;
+ padRight(
+ string?: string,
+ length?: number,
+ chars?: string
+ ): string;
}
- //_.padRight
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.padRight
*/
- padRight(length?: number, chars?: string): string;
+ padRight(
+ length?: number,
+ chars?: string
+ ): string;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.padRight
+ */
+ padRight(
+ length?: number,
+ chars?: string
+ ): LoDashExplicitWrapper<string>;
}
//_.parseInt
@@ -8452,93 +10252,157 @@ declare module _ {
/**
* Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used
* unless value is a hexadecimal, in which case a radix of 16 is used.
+ *
* Note: This method aligns with the ES5 implementation of parseInt.
+ *
* @param string The string to convert.
* @param radix The radix to interpret value by.
* @return Returns the converted integer.
*/
- parseInt(string: string, radix?: number): number;
+ parseInt(
+ string: string,
+ radix?: number
+ ): number;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.parseInt
*/
parseInt(radix?: number): number;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.parseInt
+ */
+ parseInt(radix?: number): LoDashExplicitWrapper<number>;
+ }
+
//_.repeat
interface LoDashStatic {
/**
* Repeats the given string n times.
+ *
* @param string The string to repeat.
* @param n The number of times to repeat the string.
* @return Returns the repeated string.
*/
- repeat(string?: string, n?: number): string;
+ repeat(
+ string?: string,
+ n?: number
+ ): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.repeat
*/
repeat(n?: number): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.repeat
+ */
+ repeat(n?: number): LoDashExplicitWrapper<string>;
+ }
+
//_.snakeCase
interface LoDashStatic {
/**
* Converts string to snake case.
+ *
* @param string The string to convert.
* @return Returns the snake cased string.
*/
snakeCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.snakeCase
*/
snakeCase(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.snakeCase
+ */
+ snakeCase(): LoDashExplicitWrapper<string>;
+ }
+
//_.startCase
interface LoDashStatic {
/**
* Converts string to start case.
+ *
* @param string The string to convert.
* @return Returns the start cased string.
*/
startCase(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.startCase
*/
startCase(): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.startCase
+ */
+ startCase(): LoDashExplicitWrapper<string>;
+ }
+
//_.startsWith
interface LoDashStatic {
/**
* Checks if string starts with the given target string.
+ *
* @param string The string to search.
* @param target The string to search for.
* @param position The position to search from.
* @return Returns true if string starts with target, else false.
*/
- startsWith(string?: string, target?: string, position?: number): boolean;
+ startsWith(
+ string?: string,
+ target?: string,
+ position?: number
+ ): boolean;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.startsWith
*/
- startsWith(target?: string, position?: number): boolean;
+ startsWith(
+ target?: string,
+ position?: number
+ ): boolean;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.startsWith
+ */
+ startsWith(
+ target?: string,
+ position?: number
+ ): LoDashExplicitWrapper<boolean>;
}
//_.template
+ interface TemplateOptions extends TemplateSettings {
+ /**
+ * The sourceURL of the template's compiled source.
+ */
+ sourceURL?: string;
+ }
+
interface TemplateExecutor {
(data?: Object): string;
source: string;
@@ -8567,19 +10431,28 @@ declare module _ {
* @param options.evaluate The "evaluate" delimiter.
* @param options.imports An object to import into the template as free variables.
* @param options.interpolate The "interpolate" delimiter.
+ * @param options.sourceURL The sourceURL of the template's compiled source.
* @param options.variable The data object variable name.
* @return Returns the compiled template function.
*/
template(
string: string,
- options?: TemplateSettings): TemplateExecutor;
+ options?: TemplateOptions
+ ): TemplateExecutor;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.template
*/
- template(options?: TemplateSettings): TemplateExecutor;
+ template(options?: TemplateOptions): TemplateExecutor;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.template
+ */
+ template(options?: TemplateOptions): LoDashExplicitObjectWrapper<TemplateExecutor>;
}
//_.trim
@@ -8593,7 +10466,7 @@ declare module _ {
trim(string?: string, chars?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trim
*/
@@ -8604,20 +10477,31 @@ declare module _ {
interface LoDashStatic {
/**
* Removes leading whitespace or specified characters from string.
+ *
* @param string The string to trim.
* @param chars The characters to trim.
* @return Returns the trimmed string.
*/
- trimLeft(string?: string, chars?: string): string;
+ trimLeft(
+ string?: string,
+ chars?: string
+ ): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trimLeft
*/
trimLeft(chars?: string): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.trimLeft
+ */
+ trimLeft(chars?: string): LoDashExplicitWrapper<string>;
+ }
+
//_.trimRight
interface LoDashStatic {
/**
@@ -8629,7 +10513,7 @@ declare module _ {
trimRight(string?: string, chars?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trimRight
*/
@@ -8650,20 +10534,31 @@ declare module _ {
/**
* Truncates string if it’s longer than the given maximum string length. The last characters of the truncated
* string are replaced with the omission string which defaults to "…".
+ *
* @param string The string to truncate.
* @param options The options object or maximum string length.
* @return Returns the truncated string.
*/
- trunc(string?: string, options?: TruncOptions|number): string;
+ trunc(
+ string?: string,
+ options?: TruncOptions|number
+ ): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.trunc
*/
trunc(options?: TruncOptions|number): string;
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.trunc
+ */
+ trunc(options?: TruncOptions|number): LoDashExplicitWrapper<string>;
+ }
+
//_.unescape
interface LoDashStatic {
/**
@@ -8675,7 +10570,7 @@ declare module _ {
unescape(string?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.unescape
*/
@@ -8686,20 +10581,31 @@ declare module _ {
interface LoDashStatic {
/**
* Splits string into an array of its words.
+ *
* @param string The string to inspect.
* @param pattern The pattern to match words.
* @return Returns the words of string.
*/
- words(string?: string, pattern?: string|RegExp): string[];
+ words(
+ string?: string,
+ pattern?: string|RegExp
+ ): string[];
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.words
*/
words(pattern?: string|RegExp): string[];
}
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.words
+ */
+ words(pattern?: string|RegExp): LoDashExplicitArrayWrapper<string>;
+ }
+
/***********
* Utility *
***********/
@@ -8709,19 +10615,27 @@ declare module _ {
/**
* Attempts to invoke func, returning either the result or the caught error object. Any additional arguments
* are provided to func when it’s invoked.
+ *
* @param func The function to attempt.
* @return Returns the func result or error object.
*/
attempt<TResult>(func: (...args: any[]) => TResult): TResult|Error;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.attempt
*/
attempt<TResult>(): TResult|Error;
}
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.attempt
+ */
+ attempt<TResult>(): LoDashExplicitObjectWrapper<TResult|Error>;
+ }
+
//_.callback
interface LoDashStatic {
/**
@@ -8761,23 +10675,67 @@ 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>;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.callback
+ */
+ callback<TResult>(thisArg?: any): LoDashExplicitObjectWrapper<(object: any) => TResult>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.callback
+ */
+ callback(thisArg?: any): LoDashExplicitObjectWrapper<(object: any) => boolean>;
+
+ /**
+ * @see _.callback
+ */
+ callback<TResult>(thisArg?: any): LoDashExplicitObjectWrapper<(...args: any[]) => TResult>;
+ }
+
+ //_.constant
+ interface LoDashStatic {
+ /**
+ * Creates a function that returns value.
+ *
+ * @param value The value to return from the new function.
+ * @return Returns the new function.
+ */
+ constant<T>(value: T): () => T;
+ }
+
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.constant
+ */
+ constant<TResult>(): LoDashImplicitObjectWrapper<() => TResult>;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.constant
+ */
+ constant<TResult>(): LoDashExplicitObjectWrapper<() => TResult>;
}
//_.identity
@@ -8790,21 +10748,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
*/
@@ -8843,23 +10801,42 @@ 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>;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.callback
+ */
+ iteratee<TResult>(thisArg?: any): LoDashExplicitObjectWrapper<(object: any) => TResult>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.callback
+ */
+ iteratee(thisArg?: any): LoDashExplicitObjectWrapper<(object: any) => boolean>;
+
+ /**
+ * @see _.callback
+ */
+ iteratee<TResult>(thisArg?: any): LoDashExplicitObjectWrapper<(...args: any[]) => TResult>;
}
//_.matches
@@ -8875,23 +10852,26 @@ declare module _ {
* @param source The object of property values to match.
* @return Returns the new function.
*/
- matches<T>(
- source: T
- ): (value: any) => boolean;
+ matches<T>(source: T): (value: any) => boolean;
/**
* @see _.matches
*/
- matches<T, V>(
- source: T
- ): (value: V) => boolean;
+ matches<T, V>(source: T): (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>;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.matches
+ */
+ matches<V>(): LoDashExplicitObjectWrapper<(value: V) => boolean>;
}
//_.matchesProperty
@@ -8920,20 +10900,36 @@ 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>;
+ }
+
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.matchesProperty
+ */
+ matchesProperty<SrcValue>(
+ srcValue: SrcValue
+ ): LoDashExplicitObjectWrapper<(value: any) => boolean>;
+
+ /**
+ * @see _.matchesProperty
+ */
+ matchesProperty<SrcValue, Value>(
+ srcValue: SrcValue
+ ): LoDashExplicitObjectWrapper<(value: Value) => boolean>;
}
//_.method
@@ -8941,40 +10937,71 @@ declare module _ {
/**
* Creates a function that invokes the method at path on a given object. Any additional arguments are provided
* to the invoked method.
+ *
* @param path The path of the method to invoke.
* @param args The arguments to invoke the method with.
* @return Returns the new function.
*/
- method<TResult>(path: string, ...args: any[]): (object: any) => TResult;
+ method<TObject, TResult>(
+ path: string|StringRepresentable[],
+ ...args: any[]
+ ): (object: TObject) => TResult;
/**
* @see _.method
*/
- method<TResult>(path: any[], ...args: any[]): (object: any) => TResult;
+ method<TResult>(
+ path: string|StringRepresentable[],
+ ...args: any[]
+ ): (object: any) => TResult;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TObject, TResult>(...args: any[]): LoDashImplicitObjectWrapper<(object: TObject) => TResult>;
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TResult>(...args: any[]): LoDashImplicitObjectWrapper<(object: any) => TResult>;
}
- interface LoDashArrayWrapper<T> {
+ interface LoDashImplicitArrayWrapper<T> {
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TObject, TResult>(...args: any[]): LoDashImplicitObjectWrapper<(object: TObject) => TResult>;
/**
* @see _.method
*/
- method<TResult>(...args: any[]): LoDashWrapper<(object: any) => TResult>;
+ method<TResult>(...args: any[]): LoDashImplicitObjectWrapper<(object: any) => TResult>;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.method
+ */
+ method<TObject, TResult>(...args: any[]): LoDashExplicitObjectWrapper<(object: TObject) => TResult>;
+
+ /**
+ * @see _.method
+ */
+ method<TResult>(...args: any[]): LoDashExplicitObjectWrapper<(object: any) => TResult>;
+ }
+
+ interface LoDashExplicitArrayWrapper<T> {
+ /**
+ * @see _.method
+ */
+ method<TObject, TResult>(...args: any[]): LoDashExplicitObjectWrapper<(object: TObject) => TResult>;
+
+ /**
+ * @see _.method
+ */
+ method<TResult>(...args: any[]): LoDashExplicitObjectWrapper<(object: any) => TResult>;
}
//_.methodOf
@@ -8989,11 +11016,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
@@ -9030,21 +11057,38 @@ 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>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.mixin
+ */
+ mixin<TResult>(
+ source: Dictionary<Function>,
+ options?: MixinOptions
+ ): LoDashExplicitObjectWrapper<TResult>;
+
+ /**
+ * @see _.mixin
+ */
+ mixin<TResult>(
+ options?: MixinOptions
+ ): LoDashExplicitObjectWrapper<TResult>;
}
//_.noConflict
@@ -9057,7 +11101,7 @@ declare module _ {
noConflict(): typeof _;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.noConflict
*/
@@ -9068,18 +11112,26 @@ declare module _ {
interface LoDashStatic {
/**
* A no-operation function that returns undefined regardless of the arguments it receives.
+ *
* @return undefined
*/
noop(...args: any[]): void;
}
- interface LoDashWrapperBase<T, TWrapper> {
+ interface LoDashImplicitWrapperBase<T, TWrapper> {
/**
* @see _.noop
*/
noop(...args: any[]): void;
}
+ interface LoDashExplicitWrapperBase<T, TWrapper> {
+ /**
+ * @see _.noop
+ */
+ noop(...args: any[]): _.LoDashExplicitWrapper<void>;
+ }
+
//_.property
interface LoDashStatic {
/**
@@ -9090,18 +11142,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
@@ -9109,17 +11161,25 @@ declare module _ {
/**
* The opposite of _.property; this method creates a function that returns the property value at a given path
* on object.
+ *
* @param object The object to query.
* @return Returns the new function.
*/
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>;
+ }
+
+ interface LoDashExplicitObjectWrapper<T> {
+ /**
+ * @see _.propertyOf
+ */
+ propertyOf(): LoDashExplicitObjectWrapper<(path: string|string[]) => any>;
}
//_.range
@@ -9146,33 +11206,13 @@ declare module _ {
step?: number): number[];
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.range
*/
range(
end?: number,
- step?: number): LoDashArrayWrapper<number>;
- }
-
- //_.random
- interface LoDashStatic {
- /**
- * Produces a random number between min and max (inclusive). If only one argument is provided a
- * number between 0 and the given number will be returned. If floating is truey or either min or
- * max are floats a floating-point number will be returned instead of an integer.
- * @param max The maximum possible value.
- * @param floating Specify returning a floating-point number.
- * @return A random number.
- **/
- random(max: number, floating?: boolean): number;
-
- /**
- * @see _.random
- * @param min The minimum possible value.
- * @return A random number between `min` and `max`.
- **/
- random(min: number, max: number, floating?: boolean): number;
+ step?: number): LoDashImplicitArrayWrapper<number>;
}
//_.runInContext
@@ -9186,7 +11226,7 @@ declare module _ {
runInContext(context?: Object): typeof _;
}
- interface LoDashObjectWrapper<T> {
+ interface LoDashImplicitObjectWrapper<T> {
/**
* @see _.runInContext
*/
@@ -9216,19 +11256,34 @@ 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>;
+ }
+
+ interface LoDashExplicitWrapper<T> {
+ /**
+ * @see _.times
+ */
+ times<TResult>(
+ iteratee: (num: number) => TResult,
+ thisArgs?: any
+ ): LoDashExplicitArrayWrapper<TResult>;
+
+ /**
+ * @see _.times
+ */
+ times(): LoDashExplicitArrayWrapper<number>;
}
//_.uniqueId
@@ -9241,30 +11296,13 @@ declare module _ {
uniqueId(prefix?: string): string;
}
- interface LoDashWrapper<T> {
+ interface LoDashImplicitWrapper<T> {
/**
* @see _.uniqueId
*/
uniqueId(): string;
}
- //_.constant
- interface LoDashStatic {
- /**
- * Creates a function that returns value.
- * @param value The value to return from the new function.
- * @return Returns the new function.
- */
- constant<T>(value: T): () => T;
- }
-
- interface LoDashWrapperBase<T, TWrapper> {
- /**
- * @see _.constant
- */
- constant<TResult>(): () => TResult;
- }
-
interface ListIterator<T, TResult> {
(value: T, index: number, collection: List<T>): TResult;
}
@@ -9277,6 +11315,10 @@ declare module _ {
(element: T, key?: string, collection?: any): TResult;
}
+ interface StringIterator<TResult> {
+ (char: string, index?: number, string?: string): TResult;
+ }
+
interface MemoVoidIterator<T, TResult> {
(prev: TResult, curr: T, indexOrKey?: any, list?: T[]): void;
}
diff --git a/long/long-tests.ts b/long/long-tests.ts
index 928cc94530..f70835f662 100644
--- a/long/long-tests.ts
+++ b/long/long-tests.ts
@@ -2,7 +2,7 @@
import Long = require("long");
-var val: Long;
+var val: dcodeIO.Long;
var n: number = 42;
var b: boolean = true;
var s: string = "1337";
diff --git a/long/long.d.ts b/long/long.d.ts
index 5c3704a816..32d773b9d1 100644
--- a/long/long.d.ts
+++ b/long/long.d.ts
@@ -3,70 +3,73 @@
// Definitions by: Peter Kooijmans <https://github.com/peterkooijmans/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-declare module "long" {
+declare module dcodeIO {
+ interface LongStatic {
+ new (low: number, high?: number, unsigned?: boolean): Long;
- module Long {
- export var MAX_UNSIGNED_VALUE: Long;
- export var MAX_VALUE: Long;
- export var MIN_VALUE: Long;
- export var NEG_ONE: Long;
- export var ONE: Long;
- export var UONE: Long;
- export var UZERO: Long;
- export var ZERO: Long;
+ MAX_UNSIGNED_VALUE: Long;
+ MAX_VALUE: Long;
+ MIN_VALUE: Long;
+ NEG_ONE: Long;
+ ONE: Long;
+ UONE: Long;
+ UZERO: Long;
+ ZERO: Long;
- export function fromBits(lowBits: number, highBits: number, unsigned?: boolean): Long;
- export function fromInt(value: number, unsigned?: boolean): Long;
- export function fromNumber(value: number, unsigned?: boolean): Long;
- export function fromString(str: string, unsigned?: boolean | number, radix?: number): Long;
- export function fromValue(val: Long | number | string): Long;
+ fromBits(lowBits: number, highBits: number, unsigned?: boolean): Long;
+ fromInt(value: number, unsigned?: boolean): Long;
+ fromNumber(value: number, unsigned?: boolean): Long;
+ fromString(str: string, unsigned?: boolean | number, radix?: number): Long;
+ fromValue(val: Long | number | string): Long;
+ isLong(obj: any): boolean;
+ }
- export function isLong(obj: any): boolean;
- }
+ interface Long {
+ high: number;
+ low: number;
+ unsigned: boolean;
- class Long {
- high: number;
- low: number;
- unsigned :boolean;
+ add(other: Long | number | string): Long;
+ and(other: Long | number | string): Long;
+ compare(other: Long | number | string): number;
+ div(divisor: Long | number | string): Long;
+ equals(other: Long | number | string): boolean;
+ getHighBits(): number;
+ getHighBitsUnsigned(): number;
+ getLowBits(): number;
+ getLowBitsUnsigned(): number;
+ getNumBitsAbs(): number;
+ greaterThan(other: Long | number | string): boolean;
+ greaterThanOrEqual(other: Long | number | string): boolean;
+ isEven(): boolean;
+ isNegative(): boolean;
+ isOdd(): boolean;
+ isPositive(): boolean;
+ isZero(): boolean;
+ lessThan(other: Long | number | string): boolean;
+ lessThanOrEqual(other: Long | number | string): boolean;
+ modulo(divisor: Long | number | string): Long;
+ multiply(multiplier: Long | number | string): Long;
+ negate(): Long;
+ not(): Long;
+ notEquals(other: Long | number | string): boolean;
+ or(other: Long | number | string): Long;
+ shiftLeft(numBits: number | Long): Long;
+ shiftRight(numBits: number | Long): Long;
+ shiftRightUnsigned(numBits: number | Long): Long;
+ subtract(other: Long | number | string): Long;
+ toInt(): number;
+ toNumber(): number;
+ toSigned(): Long;
+ toString(radix?: number): string;
+ toUnsigned(): Long;
+ xor(other: Long | number | string): Long;
+ }
- constructor(low: number, high?: number, unsigned?:boolean);
-
- add(other: Long | number | string): Long;
- and(other: Long | number | string): Long;
- compare(other: Long | number | string): number;
- div(divisor: Long | number | string): Long;
- equals(other: Long | number | string): boolean;
- getHighBits(): number;
- getHighBitsUnsigned(): number;
- getLowBits(): number;
- getLowBitsUnsigned(): number;
- getNumBitsAbs(): number;
- greaterThan(other: Long | number | string): boolean;
- greaterThanOrEqual(other: Long | number | string): boolean;
- isEven(): boolean;
- isNegative(): boolean;
- isOdd(): boolean;
- isPositive(): boolean;
- isZero(): boolean;
- lessThan(other: Long | number | string): boolean;
- lessThanOrEqual(other: Long | number | string): boolean;
- modulo(divisor: Long | number | string): Long;
- multiply(multiplier: Long | number | string): Long;
- negate(): Long;
- not(): Long;
- notEquals(other: Long | number | string): boolean;
- or(other: Long | number | string): Long;
- shiftLeft(numBits: number | Long): Long;
- shiftRight(numBits: number | Long): Long;
- shiftRightUnsigned(numBits: number | Long): Long;
- subtract(other: Long | number | string): Long;
- toInt(): number;
- toNumber(): number;
- toSigned(): Long;
- toString(radix?: number): string;
- toUnsigned(): Long;
- xor(other: Long | number | string): Long;
- }
-
- export = Long;
+ export var Long: LongStatic;
}
+
+declare module "long" {
+ var Long: dcodeIO.LongStatic;
+ export = Long;
+}
\ No newline at end of file
diff --git a/mapbox/mapbox.d.ts b/mapbox/mapbox.d.ts
index 3c774bdf66..1d4d7e19f8 100644
--- a/mapbox/mapbox.d.ts
+++ b/mapbox/mapbox.d.ts
@@ -18,8 +18,8 @@ declare module L.mapbox {
/**
* Create and automatically configure a map with layers, markers, and interactivity.
*/
- function map(element: string, id: string, options?: MapOptions): L.mapbox.Map;
- function map(element: string, tilejson: any, options?: MapOptions): L.mapbox.Map;
+ function map(element: string|Element, id: string, options?: MapOptions): L.mapbox.Map;
+ function map(element: string|Element, tilejson: any, options?: MapOptions): L.mapbox.Map;
interface MapOptions extends L.Map.MapOptions {
featureLayer? : FeatureLayerOptions;
diff --git a/marionette/marionette.d.ts b/marionette/marionette.d.ts
index 14d0a0b6c2..314fcc4328 100644
--- a/marionette/marionette.d.ts
+++ b/marionette/marionette.d.ts
@@ -1216,6 +1216,8 @@ declare module Marionette {
*/
class Application extends Backbone.Events {
+ constructor(options?: any);
+
/**
* The Event Aggregator is available through this property. It is
* convenient for passively sharing information between pieces of your
diff --git a/marked/marked.d.ts b/marked/marked.d.ts
index 8e78cdabbd..198cd26262 100644
--- a/marked/marked.d.ts
+++ b/marked/marked.d.ts
@@ -59,7 +59,7 @@ interface MarkedStatic {
*
* @param options Hash of options
*/
- setOptions(options: MarkedOptions): void;
+ setOptions(options: MarkedOptions): MarkedStatic;
}
interface MarkedOptions {
diff --git a/material-ui/material-ui-tests.tsx b/material-ui/material-ui-tests.tsx
index 39691caa84..4c69f34104 100644
--- a/material-ui/material-ui-tests.tsx
+++ b/material-ui/material-ui-tests.tsx
@@ -2,7 +2,7 @@
///<reference path='material-ui.d.ts' />
import * as React from "react/addons";
-import mui = require("material-ui");
+import Checkbox = require("material-ui/lib/checkbox");
import Colors = require("material-ui/lib/styles/colors");
import AppBar = require("material-ui/lib/app-bar");
import IconButton = require("material-ui/lib/icon-button");
@@ -27,6 +27,7 @@ import IconMenu = require("material-ui/lib/menus/icon-menu");
import Menu = require('material-ui/lib/menus/menu');
import MenuItem = require('material-ui/lib/menus/menu-item');
import MenuDivider = require('material-ui/lib/menus/menu-divider');
+import ThemeManager = require('material-ui/lib/styles/theme-manager');
import NavigationClose = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/navigation/close", but they aren't defined yet.
import FileFolder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/file/folder", but they aren't defined yet.
@@ -35,37 +36,37 @@ import ActionGrade = require("material-ui/lib/svg-icon"); // TODO: Should actua
import ToggleStarBorder = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet.
import ArrowDropRight = require("material-ui/lib/svg-icon"); // TODO: Should actually import the actual "material-ui/lib/svg-icons/toggle/star-border", but they aren't defined yet.
+type CheckboxProps = __MaterialUI.CheckboxProps;
+type MuiTheme = __MaterialUI.Styles.MuiTheme;
+type TouchTapEvent = __MaterialUI.TouchTapEvent;
+
class MaterialUiTests extends React.Component<{}, {}> implements React.LinkedStateMixin {
// injected with mixin
linkState: <T>(key: string) => React.ReactLink<T>;
- dialog: mui.Dialog;
- //dialog2: Dialog; // can't get type directly from require("material-ui/lib/dialog");
+ dialog: Dialog;
- private touchTapEventHandler(e: __MaterialUI.TouchTapEvent) {
+ private touchTapEventHandler(e: TouchTapEvent) {
this.dialog.show();
- //this.dialog2.show();
}
private formEventHandler(e: React.FormEvent) {
}
- private selectFieldChangeHandler(e: __MaterialUI.TouchTapEvent, si: number, mi: any) {
+ private selectFieldChangeHandler(e: TouchTapEvent, si: number, mi: any) {
}
render() {
// "http://material-ui.com/#/customization/themes"
- let ThemeManager = mui.Styles.ThemeManager;
- let muiTheme: mui.Styles.MuiTheme = ThemeManager.getMuiTheme({
+ let muiTheme: MuiTheme = ThemeManager.getMuiTheme({
palette: {
accent1Color: Colors.cyan100
},
spacing: {
-
+
}
});
// "http://material-ui.com/#/customization/inline-styles"
- let Checkbox = mui.Checkbox;
let element: React.ReactElement<any>;
element = <Checkbox
id="checkboxId1"
@@ -79,7 +80,7 @@ class MaterialUiTests extends React.Component<{}, {}> implements React.LinkedSta
iconStyle={{
fill: '#FF4081'
}}/>
- element = React.createElement<__MaterialUI.CheckboxProps>(Checkbox, {
+ element = React.createElement<CheckboxProps>(Checkbox, {
id: "checkboxId1", name: "checkboxName1", value: "checkboxValue1", label: "went for a run today", style: {
width: '50%',
margin: '0 auto'
diff --git a/material-ui/material-ui.d.ts b/material-ui/material-ui.d.ts
index 8b1201bf53..ecd32ae066 100644
--- a/material-ui/material-ui.d.ts
+++ b/material-ui/material-ui.d.ts
@@ -6,8 +6,6 @@
///<reference path='../react/react.d.ts' />
declare module "material-ui" {
- // The reason for exporting the namespace types (__MaterialUI.*) is to also export the type for casting variable.
-
export import AppBar = __MaterialUI.AppBar; // require('material-ui/lib/app-bar');
export import AppCanvas = __MaterialUI.AppCanvas; // require('material-ui/lib/app-canvas');
export import Avatar = __MaterialUI.Avatar; // require('material-ui/lib/avatar');
@@ -51,16 +49,7 @@ declare module "material-ui" {
export import SelectField = __MaterialUI.SelectField; // require('material-ui/lib/select-field');
export import Slider = __MaterialUI.Slider; // require('material-ui/lib/slider');
export import SvgIcon = __MaterialUI.SvgIcon; // require('material-ui/lib/svg-icon');
-
- import NavigationMenu = require('material-ui/lib/svg-icons/navigation/menu');
- import NavigationChevronLeft = require('material-ui/lib/svg-icons/navigation/chevron-left');
- import NavigationChevronRight = require('material-ui/lib/svg-icons/navigation/chevron-right');
- export var Icons: {
- NavigationMenu: __MaterialUI.NavigationMenu;
- NavigationChevronLeft: __MaterialUI.NavigationChevronLeft;
- NavigationChevronRight: __MaterialUI.NavigationChevronRight;
- };
-
+ export import Icons = __MaterialUI.Icons;
export import Styles = __MaterialUI.Styles; // require('material-ui/lib/styles/');
export import Snackbar = __MaterialUI.Snackbar; // require('material-ui/lib/snackbar');
export import Tab = __MaterialUI.Tabs.Tab; // require('material-ui/lib/tabs/tab');
@@ -84,9 +73,9 @@ declare module "material-ui" {
export import Utils = __MaterialUI.Utils; // require('material-ui/lib/utils/');
// export type definitions
- export import TouchTapEvent = __MaterialUI.TouchTapEvent;
- export import TouchTapEventHandler = __MaterialUI.TouchTapEventHandler;
- export import DialogAction = __MaterialUI.DialogAction;
+ export type TouchTapEvent = __MaterialUI.TouchTapEvent;
+ export type TouchTapEventHandler = __MaterialUI.TouchTapEventHandler;
+ export type DialogAction = __MaterialUI.DialogAction;
}
declare namespace __MaterialUI {
@@ -805,6 +794,12 @@ declare namespace __MaterialUI {
export class SvgIcon extends React.Component<SvgIconProps, {}> {
}
+ export namespace Icons {
+ export import NavigationMenu = __MaterialUI.NavigationMenu;
+ export import NavigationChevronLeft = __MaterialUI.NavigationChevronLeft;
+ export import NavigationChevronRight = __MaterialUI.NavigationChevronRight;
+ }
+
interface NavigationMenuProps extends React.Props<NavigationMenu> {
}
export class NavigationMenu extends React.Component<NavigationMenuProps, {}> {
@@ -1478,127 +1473,158 @@ declare namespace __MaterialUI {
} // __MaterialUI
declare module 'material-ui/lib/app-bar' {
- export = __MaterialUI.AppBar;
+ import AppBar = __MaterialUI.AppBar;
+ export = AppBar;
}
declare module 'material-ui/lib/app-canvas' {
- export = __MaterialUI.AppCanvas;
+ import AppCanvas = __MaterialUI.AppCanvas;
+ export = AppCanvas;
}
declare module 'material-ui/lib/avatar' {
- export = __MaterialUI.Avatar;
+ import Avatar = __MaterialUI.Avatar;
+ export = Avatar;
}
declare module 'material-ui/lib/before-after-wrapper' {
- export = __MaterialUI.BeforeAfterWrapper;
+ import BeforeAfterWrapper = __MaterialUI.BeforeAfterWrapper;
+ export = BeforeAfterWrapper;
}
declare module 'material-ui/lib/card/card' {
- export = __MaterialUI.Card.Card;
+ import Card = __MaterialUI.Card.Card;
+ export = Card;
}
declare module 'material-ui/lib/card/card-actions' {
- export = __MaterialUI.Card.CardActions;
+ import CardActions = __MaterialUI.Card.CardActions;
+ export = CardActions;
}
declare module 'material-ui/lib/card/card-expandable' {
- export = __MaterialUI.Card.CardExpandable;
+ import CardExpandable = __MaterialUI.Card.CardExpandable;
+ export = CardExpandable;
}
declare module 'material-ui/lib/card/card-header' {
- export = __MaterialUI.Card.CardHeader;
+ import CardHeader = __MaterialUI.Card.CardHeader;
+ export = CardHeader;
}
declare module 'material-ui/lib/card/card-media' {
- export = __MaterialUI.Card.CardMedia;
+ import CardMedia = __MaterialUI.Card.CardMedia;
+ export = CardMedia;
}
declare module 'material-ui/lib/card/card-text' {
- export = __MaterialUI.Card.CardText;
+ import CardText = __MaterialUI.Card.CardText;
+ export = CardText;
}
declare module 'material-ui/lib/card/card-title' {
- export = __MaterialUI.Card.CardTitle;
+ import CardTitle = __MaterialUI.Card.CardTitle;
+ export = CardTitle;
}
declare module 'material-ui/lib/checkbox' {
- export = __MaterialUI.Checkbox;
+ import Checkbox = __MaterialUI.Checkbox;
+ export = Checkbox;
}
declare module 'material-ui/lib/circular-progress' {
- export = __MaterialUI.CircularProgress;
+ import CircularProgress = __MaterialUI.CircularProgress;
+ export = CircularProgress;
}
declare module 'material-ui/lib/clearfix' {
- export = __MaterialUI.ClearFix;
+ import ClearFix = __MaterialUI.ClearFix;
+ export = ClearFix;
}
declare module 'material-ui/lib/date-picker/date-picker' {
- export = __MaterialUI.DatePicker.DatePicker;
+ import DatePicker = __MaterialUI.DatePicker.DatePicker;
+ export = DatePicker;
}
declare module 'material-ui/lib/date-picker/date-picker-dialog' {
- export = __MaterialUI.DatePicker.DatePickerDialog;
+ import DatePickerDialog = __MaterialUI.DatePicker.DatePickerDialog;
+ export = DatePickerDialog;
}
declare module 'material-ui/lib/dialog' {
- export = __MaterialUI.Dialog;
+ import Dialog = __MaterialUI.Dialog;
+ export = Dialog;
}
declare module 'material-ui/lib/drop-down-icon' {
- export = __MaterialUI.DropDownIcon;
+ import DropDownIcon = __MaterialUI.DropDownIcon;
+ export = DropDownIcon;
}
declare module 'material-ui/lib/drop-down-menu' {
- export = __MaterialUI.DropDownMenu;
+ import DropDownMenu = __MaterialUI.DropDownMenu;
+ export = DropDownMenu;
}
declare module 'material-ui/lib/enhanced-button' {
- export = __MaterialUI.EnhancedButton;
+ import EnhancedButton = __MaterialUI.EnhancedButton;
+ export = EnhancedButton;
}
declare module 'material-ui/lib/flat-button' {
- export = __MaterialUI.FlatButton;
+ import FlatButton = __MaterialUI.FlatButton;
+ export = FlatButton;
}
declare module 'material-ui/lib/floating-action-button' {
- export = __MaterialUI.FloatingActionButton;
+ import FloatingActionButton = __MaterialUI.FloatingActionButton;
+ export = FloatingActionButton;
}
declare module 'material-ui/lib/font-icon' {
- export = __MaterialUI.FontIcon;
+ import FontIcon = __MaterialUI.FontIcon;
+ export = FontIcon;
}
declare module 'material-ui/lib/icon-button' {
- export = __MaterialUI.IconButton;
+ import IconButton = __MaterialUI.IconButton;
+ export = IconButton;
}
declare module 'material-ui/lib/left-nav' {
- export = __MaterialUI.LeftNav;
+ import LeftNav = __MaterialUI.LeftNav;
+ export = LeftNav;
}
declare module 'material-ui/lib/linear-progress' {
- export = __MaterialUI.LinearProgress;
+ import LinearProgress = __MaterialUI.LinearProgress;
+ export = LinearProgress;
}
declare module 'material-ui/lib/lists/list' {
- export = __MaterialUI.Lists.List;
+ import List = __MaterialUI.Lists.List;
+ export = List;
}
declare module 'material-ui/lib/lists/list-divider' {
- export = __MaterialUI.Lists.ListDivider;
+ import ListDivider = __MaterialUI.Lists.ListDivider;
+ export = ListDivider;
}
declare module 'material-ui/lib/lists/list-item' {
- export = __MaterialUI.Lists.ListItem;
+ import ListItem = __MaterialUI.Lists.ListItem;
+ export = ListItem;
}
declare module 'material-ui/lib/menu/menu' {
- export = __MaterialUI.Menu.Menu;
+ import Menu = __MaterialUI.Menu.Menu;
+ export = Menu;
}
declare module 'material-ui/lib/menu/menu-item' {
- export = __MaterialUI.Menu.MenuItem;
+ import MenuItem = __MaterialUI.Menu.MenuItem;
+ export = MenuItem;
}
declare module 'material-ui/lib/mixins/' {
@@ -1609,43 +1635,53 @@ declare module 'material-ui/lib/mixins/' {
}
declare module 'material-ui/lib/mixins/click-awayable' {
- export = __MaterialUI.Mixins.ClickAwayable;
+ import ClickAwayable = __MaterialUI.Mixins.ClickAwayable;
+ export = ClickAwayable;
}
declare module 'material-ui/lib/mixins/window-listenable' {
- export = __MaterialUI.Mixins.WindowListenable;
+ import WindowListenable = __MaterialUI.Mixins.WindowListenable;
+ export = WindowListenable;
}
declare module 'material-ui/lib/mixins/style-propable' {
- export = __MaterialUI.Mixins.StylePropable;
+ import StylePropable = __MaterialUI.Mixins.StylePropable;
+ export = StylePropable;
}
declare module 'material-ui/lib/mixins/style-resizable' {
- export = __MaterialUI.Mixins.StyleResizable;
+ import StyleResizable = __MaterialUI.Mixins.StyleResizable;
+ export = StyleResizable;
}
declare module 'material-ui/lib/overlay' {
- export = __MaterialUI.Overlay;
+ import Overlay = __MaterialUI.Overlay;
+ export = Overlay;
}
declare module 'material-ui/lib/paper' {
- export = __MaterialUI.Paper;
+ import Paper = __MaterialUI.Paper;
+ export = Paper;
}
declare module 'material-ui/lib/radio-button' {
- export = __MaterialUI.RadioButton;
+ import RadioButton = __MaterialUI.RadioButton;
+ export = RadioButton;
}
declare module 'material-ui/lib/radio-button-group' {
- export = __MaterialUI.RadioButtonGroup;
+ import RadioButtonGroup = __MaterialUI.RadioButtonGroup;
+ export = RadioButtonGroup;
}
declare module 'material-ui/lib/raised-button' {
- export = __MaterialUI.RaisedButton;
+ import RaisedButton = __MaterialUI.RaisedButton;
+ export = RaisedButton;
}
declare module 'material-ui/lib/refresh-indicator' {
- export = __MaterialUI.RefreshIndicator;
+ import RefreshIndicator = __MaterialUI.RefreshIndicator;
+ export = RefreshIndicator;
}
declare module 'material-ui/lib/ripples/' {
@@ -1655,27 +1691,33 @@ declare module 'material-ui/lib/ripples/' {
}
declare module 'material-ui/lib/select-field' {
- export = __MaterialUI.SelectField;
+ import SelectField = __MaterialUI.SelectField;
+ export = SelectField;
}
declare module 'material-ui/lib/slider' {
- export = __MaterialUI.Slider;
+ import Slider = __MaterialUI.Slider;
+ export = Slider;
}
declare module 'material-ui/lib/svg-icon' {
- export = __MaterialUI.SvgIcon;
+ import SvgIcon = __MaterialUI.SvgIcon;
+ export = SvgIcon;
}
declare module 'material-ui/lib/svg-icons/navigation/menu' {
- export = __MaterialUI.NavigationMenu;
+ import NavigationMenu = __MaterialUI.NavigationMenu;
+ export = NavigationMenu;
}
declare module 'material-ui/lib/svg-icons/navigation/chevron-left' {
- export = __MaterialUI.NavigationChevronLeft;
+ import NavigationChevronLeft = __MaterialUI.NavigationChevronLeft;
+ export = NavigationChevronLeft;
}
declare module 'material-ui/lib/svg-icons/navigation/chevron-right' {
- export = __MaterialUI.NavigationChevronRight;
+ import NavigationChevronRight = __MaterialUI.NavigationChevronRight;
+ export = NavigationChevronRight;
}
declare module 'material-ui/lib/styles/' {
@@ -1691,113 +1733,140 @@ declare module 'material-ui/lib/styles/' {
}
declare module 'material-ui/lib/styles/auto-prefix' {
- export = __MaterialUI.Styles.AutoPrefix;
+ import AutoPrefix = __MaterialUI.Styles.AutoPrefix;
+ export = AutoPrefix;
}
declare module 'material-ui/lib/styles/spacing' {
- var Spacing: __MaterialUI.Styles.Spacing;
+ type Spacing = __MaterialUI.Styles.Spacing;
+ var Spacing: Spacing;
export = Spacing;
}
declare module 'material-ui/lib/styles/theme-manager' {
- export = __MaterialUI.Styles.ThemeManager;
+ import ThemeManager = __MaterialUI.Styles.ThemeManager;
+ export = ThemeManager;
}
declare module 'material-ui/lib/styles/transitions' {
- export = __MaterialUI.Styles.Transitions;
+ import Transitions = __MaterialUI.Styles.Transitions;
+ export = Transitions;
}
declare module 'material-ui/lib/styles/typography' {
- export = __MaterialUI.Styles.Typography;
+ import Typography = __MaterialUI.Styles.Typography;
+ export = Typography;
}
declare module 'material-ui/lib/styles/raw-themes/light-raw-theme' {
- export = __MaterialUI.Styles.LightRawTheme;
+ import LightRawTheme = __MaterialUI.Styles.LightRawTheme;
+ export = LightRawTheme;
}
declare module 'material-ui/lib/styles/raw-themes/dark-raw-theme' {
- export = __MaterialUI.Styles.DarkRawTheme;
+ import DarkRawTheme = __MaterialUI.Styles.DarkRawTheme;
+ export = DarkRawTheme;
}
declare module 'material-ui/lib/styles/theme-decorator' {
- export = __MaterialUI.Styles.ThemeDecorator;
+ import ThemeDecorator = __MaterialUI.Styles.ThemeDecorator;
+ export = ThemeDecorator;
}
declare module 'material-ui/lib/snackbar' {
- export = __MaterialUI.Snackbar;
+ import Snackbar = __MaterialUI.Snackbar;
+ export = Snackbar;
}
declare module 'material-ui/lib/tabs/tab' {
- export = __MaterialUI.Tabs.Tab;
+ import Tab = __MaterialUI.Tabs.Tab;
+ export = Tab;
}
declare module 'material-ui/lib/tabs/tabs' {
- export = __MaterialUI.Tabs.Tabs;
+ import Tabs = __MaterialUI.Tabs.Tabs;
+ export = Tabs;
}
declare module 'material-ui/lib/table/table' {
- export = __MaterialUI.Table.Table;
+ import Table = __MaterialUI.Table.Table;
+ export = Table;
}
declare module 'material-ui/lib/table/table-body' {
- export = __MaterialUI.Table.TableBody;
+ import TableBody = __MaterialUI.Table.TableBody;
+ export = TableBody;
}
declare module 'material-ui/lib/table/table-footer' {
- export = __MaterialUI.Table.TableFooter;
+ import TableFooter = __MaterialUI.Table.TableFooter;
+ export = TableFooter;
}
declare module 'material-ui/lib/table/table-header' {
- export = __MaterialUI.Table.TableHeader;
+ import TableHeader = __MaterialUI.Table.TableHeader;
+ export = TableHeader;
}
declare module 'material-ui/lib/table/table-header-column' {
- export = __MaterialUI.Table.TableHeaderColumn;
+ import TableHeaderColumn = __MaterialUI.Table.TableHeaderColumn;
+ export = TableHeaderColumn;
}
declare module 'material-ui/lib/table/table-row' {
- export = __MaterialUI.Table.TableRow;
+ import TableRow = __MaterialUI.Table.TableRow;
+ export = TableRow;
}
declare module 'material-ui/lib/table/table-row-column' {
- export = __MaterialUI.Table.TableRowColumn;
+ import TableRowColumn = __MaterialUI.Table.TableRowColumn;
+ export = TableRowColumn;
}
declare module 'material-ui/lib/theme-wrapper' {
- export = __MaterialUI.ThemeWrapper;
+ import ThemeWrapper = __MaterialUI.ThemeWrapper;
+ export = ThemeWrapper;
}
declare module 'material-ui/lib/toggle' {
- export = __MaterialUI.Toggle;
+ import Toggle = __MaterialUI.Toggle;
+ export = Toggle;
}
declare module 'material-ui/lib/time-picker' {
- export = __MaterialUI.TimePicker;
+ import TimePicker = __MaterialUI.TimePicker;
+ export = TimePicker;
}
declare module 'material-ui/lib/text-field' {
- export = __MaterialUI.TextField;
+ import TextField = __MaterialUI.TextField;
+ export = TextField;
}
declare module 'material-ui/lib/toolbar/toolbar' {
- export = __MaterialUI.Toolbar.Toolbar;
+ import Toolbar = __MaterialUI.Toolbar.Toolbar;
+ export = Toolbar;
}
declare module 'material-ui/lib/toolbar/toolbar-group' {
- export = __MaterialUI.Toolbar.ToolbarGroup;
+ import ToolbarGroup = __MaterialUI.Toolbar.ToolbarGroup;
+ export = ToolbarGroup;
}
declare module 'material-ui/lib/toolbar/toolbar-separator' {
- export = __MaterialUI.Toolbar.ToolbarSeparator;
+ import ToolbarSeparator = __MaterialUI.Toolbar.ToolbarSeparator;
+ export = ToolbarSeparator;
}
declare module 'material-ui/lib/toolbar/toolbar-title' {
- export = __MaterialUI.Toolbar.ToolbarTitle;
+ import ToolbarTitle = __MaterialUI.Toolbar.ToolbarTitle;
+ export = ToolbarTitle;
}
declare module 'material-ui/lib/tooltip' {
- export = __MaterialUI.Tooltip;
+ import Tooltip = __MaterialUI.Tooltip;
+ export = Tooltip;
}
declare module 'material-ui/lib/utils/' {
@@ -1814,63 +1883,78 @@ declare module 'material-ui/lib/utils/' {
}
declare module 'material-ui/lib/utils/color-manipulator' {
- export = __MaterialUI.Utils.ColorManipulator;
+ import ColorManipulator = __MaterialUI.Utils.ColorManipulator;
+ export = ColorManipulator;
}
declare module 'material-ui/lib/utils/css-event' {
- export = __MaterialUI.Utils.CssEvent;
+ import CssEvent = __MaterialUI.Utils.CssEvent;
+ export = CssEvent;
}
declare module 'material-ui/lib/utils/dom' {
- export = __MaterialUI.Utils.Dom;
+ import Dom = __MaterialUI.Utils.Dom;
+ export = Dom;
}
declare module 'material-ui/lib/utils/events' {
- export = __MaterialUI.Utils.Events;
+ import Events = __MaterialUI.Utils.Events;
+ export = Events;
}
declare module 'material-ui/lib/utils/extend' {
- export = __MaterialUI.Utils.Extend;
+ import Extend = __MaterialUI.Utils.Extend;
+ export = Extend;
}
declare module 'material-ui/lib/utils/immutability-helper' {
- export = __MaterialUI.Utils.ImmutabilityHelper;
+ import ImmutabilityHelper = __MaterialUI.Utils.ImmutabilityHelper;
+ export = ImmutabilityHelper;
}
declare module 'material-ui/lib/utils/key-code' {
- export = __MaterialUI.Utils.KeyCode;
+ import KeyCode = __MaterialUI.Utils.KeyCode;
+ export = KeyCode;
}
declare module 'material-ui/lib/utils/key-line' {
- export = __MaterialUI.Utils.KeyLine;
+ import KeyLine = __MaterialUI.Utils.KeyLine;
+ export = KeyLine;
}
declare module 'material-ui/lib/utils/unique-id' {
- export = __MaterialUI.Utils.UniqueId;
+ import UniqueId = __MaterialUI.Utils.UniqueId;
+ export = UniqueId;
}
declare module 'material-ui/lib/utils/styles' {
- export = __MaterialUI.Utils.Styles;
+ import Styles = __MaterialUI.Utils.Styles;
+ export = Styles;
}
declare module "material-ui/lib/menus/icon-menu" {
- export = __MaterialUI.Menus.IconMenu;
+ import IconMenu = __MaterialUI.Menus.IconMenu;
+ export = IconMenu;
}
declare module "material-ui/lib/menus/menu" {
- export = __MaterialUI.Menus.Menu;
+ import Menu = __MaterialUI.Menus.Menu;
+ export = Menu;
}
declare module "material-ui/lib/menus/menu-item" {
- export = __MaterialUI.Menus.MenuItem;
+ import MenuItem = __MaterialUI.Menus.MenuItem;
+ export = MenuItem;
}
declare module "material-ui/lib/menus/menu-divider" {
- export = __MaterialUI.Menus.MenuDivider;
+ import MenuDivider = __MaterialUI.Menus.MenuDivider;
+ export = MenuDivider;
}
declare module "material-ui/lib/styles/colors" {
- export = __MaterialUI.Styles.Colors;
+ import Colors = __MaterialUI.Styles.Colors;
+ export = Colors;
}
declare namespace __MaterialUI.Styles {
diff --git a/md5/md5-test.ts b/md5/md5-tests.ts
similarity index 100%
rename from md5/md5-test.ts
rename to md5/md5-tests.ts
diff --git a/mendixmodelsdk/mendixmodelsdk-tests.ts.tscparams b/mendixmodelsdk/mendixmodelsdk-tests.ts.tscparams
deleted file mode 100644
index f067224898..0000000000
--- a/mendixmodelsdk/mendixmodelsdk-tests.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
--m commonjs -t es5
\ No newline at end of file
diff --git a/meteor/README.md b/meteor/README.md
index 8f93e1816e..500823745b 100644
--- a/meteor/README.md
+++ b/meteor/README.md
@@ -1,6 +1,6 @@
# Meteor Type Definitions
-These are the definitions for version 1.1.0.1 of Meteor.
+These are the definitions for version 1.2.0.2 of Meteor.
Although these definitions can be downloaded separately for use, the recommended way to use these definitions in a Meteor application is by installing the
[typescript-libs](https://atmospherejs.com/meteortypescript/typescript-libs) Meteor smart package from atmosphere. The smart package contains TypeScript
@@ -14,14 +14,14 @@ These definitions were generated from the from the same [Meteor data.js file] (h
to generate the official [Meteor docs] (http://docs.meteor.com/).
-## Usage
+## Usage (OSX/Linux)
-1. Add a symbolic link to the definitions from within some directory within your project (e.g. ".typescript" or "lib"). The definitions can be found somewhere
-deep within `<project_root_dir>/.meteor/...`. The following will probably work:
+1. Add a symbolic link to the definitions from within some directory within your project (e.g. ".typescript" or "lib"). The definitions can be found somewhere deep within `<project_root_dir>/.meteor/...`. The following will probably work:
$ ln -s ../.meteor/local/build/programs/server/assets/packages/meteortypescript_typescript-libs/definitions package_defs
- If the definitions can't be found within the .meteor directory, you will have to manually pull down the definitions from github and add them to your project:
+ If the definitions can't be found within the .meteor directory, you will have to manually pull down the definitions from github and add them to your project:
+
<https://github.com/meteor-typescript/meteor-typescript-libs>
2. Install the [Typescript compiler for Meteor](https://github.com/meteor-typescript/meteor-typescript-compiler) or an [IDE which can transpile TypeScript to JavaScript](#transpiling-typescript).
@@ -29,12 +29,23 @@ deep within `<project_root_dir>/.meteor/...`. The following will probably work:
/// <reference path=".typescript/package_defs/all-definitions.d.ts" /> (substitute path in your project)
- Or you can reference definition files individually:
+ Or you can reference definition files individually:
- /// <reference path=".typescript/package_defs/meteor.d.ts" /> (substitue path in your project)
+ /// <reference path=".typescript/package_defs/meteor.d.ts" /> (substitute path in your project)
/// <reference path=".typescript/package_defs/underscore.d.ts" />
/// <reference path=".typescript/package_defs/jquery.d.ts" />
+ Meteor core definitions can be referenced in an "all-in-one" definition file ( *meteor.d.ts* ) or definition files specific to the locus of execution:
+
+ - *meteor.d.ts*: all meteor core definitions
+ - *meteor.common.d.ts*: meteor core code running on both client and server
+ - *meteor.client.d.ts*: meteor core client-only code
+ - *meteor.server.d.ts*: meteor core server-only code
+ - *meteor.package.d.ts*: meteor core package-only code
+ - *meteor.build.d.ts*: meteor core build-only code
+
+ *meteor.d.ts* contains all of the definitions found in *meteor.common.d.ts*, *meteor.client.d.ts*, *meteor.server.d.ts*, *meteor.package.d.ts*, and *meteor.build.d.ts*
+
4. Be aware of differences in coding styles when using TypeScript (see below)
@@ -42,14 +53,15 @@ deep within `<project_root_dir>/.meteor/...`. The following will probably work:
### References
-Meteor code can run on the client and the server, for this reason you should try to stay away from referencing *file.ts* directly: you may get unexpected results.
-Rather generate a *file.d.ts* using `tsc --reference file.ts`, and reference it in your file.
+Meteor code can run on the client and the server, for this reason you should try to stay away from referencing *file.ts* directly: you may get unexpected results.
+
+Rather generate a *file.d.ts* using `tsc --declaration file.ts`, and reference it in your file.
-Compilation will be much faster and code cleaner - it's always better to split definition from implementation anyways.
+Compilation will be much faster and code will be cleaner - it's always better to split definition from implementation anyways.
### Templates
-With the exception of the **body** and **head** templates, Meteor's Template dot notation cannot be used (ie. *Template.mytemplate*). Thanks to Typescript static typing checks, you will need to used the *bracket notation* to access the Template.
+With the exception of the **body** and **head** templates, Meteor's Template dot notation cannot be used (ie. *Template.mytemplate*). Thanks to Typescript static typing checks, you will need to use the *bracket notation* to access the Template.
Template['myTemplateName'].helpers({
@@ -58,16 +70,16 @@ With the exception of the **body** and **head** templates, Meteor's Template dot
}
});
- Template['myTemplateName'].rendered = function ( ) { ... }
+ Template['myTemplateName'].onRendered(function ( ) { ... });
### Form fields
-Form fields typically need to be casted to <HTMLInputElement>. For instance to read a form field value, use `(<HTMLInputElement>evt.target).value`.
+Form fields typically need to be cast to `<HTMLInputElement>`. For instance to read a form field value, use `(<HTMLInputElement>evt.target).value`.
### Global variables
-Preface any global variable declarations with a TypeScript "declare var" statement:
+Preface any global variable declarations with a TypeScript "declare var" statement (or place the statement in a definition file):
declare var NavbarHelpers;
NavbarHelpers = {};
@@ -75,8 +87,7 @@ Preface any global variable declarations with a TypeScript "declare var" stateme
### Collections
-The majority of extra work required to use TypeScript with Meteor is creating and maintaining the collection interfaces. However, doing so also provides the
-additional benefit of succinctly documenting collection schema definitions (that are actually enforced).
+The majority of extra work required to use TypeScript with Meteor is creating and maintaining the collection interfaces. However, doing so also provides the additional benefit of succinctly documenting collection schema definitions (that are actually enforced).
To define collections, you will need to create an interface representing the collection and then declare a Collection type variable with that interface type (as a generic):
@@ -104,8 +115,7 @@ If you have lots of custom definitions for a project, you can:
- Create multiple definition files and include individual references to each definition file.
- Create one huge monolithic definition file so you only have to refer to that file.
-- Create multiple definition files, and create a definition file with references to the other definitions files so that you only have to maintain one reference
-for all of you custom definitions. e.g. contents of ".typescript/custom_defs/custom-definitions.d.ts":
+- Create multiple definition files, and create a definition file with references to the other definitions files so that you only have to maintain one reference for all of you custom definitions. e.g. contents of ".typescript/custom_defs/custom-definitions.d.ts":
/// <reference path='collections.ts' />
/// <reference path='paraview_helpers.d.ts'/>
@@ -116,18 +126,26 @@ for all of you custom definitions. e.g. contents of ".typescript/custom_defs/cu
## Transpiling TypeScript
### Meteor plugin
-One solution for transpiling typescript is to install the following meteor package [https://github.com/meteor-typescript/meteor-typescript-compiler](https://github.com/meteor-typescript/meteor-typescript-compiler)
+One solution for transpiling typescript is to install the following meteor package: [https://github.com/meteor-typescript/meteor-typescript-compiler](https://github.com/meteor-typescript/meteor-typescript-compiler)
### IDE/Editor Transpilation
-WebStorm is a good TypeScript-aware editor. It can automatically transpile your TypeScript code into JavaScript every time you save a file. To enable this
-feature in WebStorm on OSX, first install the TypeScript transpiler on your system:
+WebStorm, SublimeText, Atom, and VisualStudio all support TypeScript. They can automatically transpile your TypeScript code into JavaScript every time you save a file.
+
+#### WebStorm ####
+To support TypeScript in WebStorm on OSX, first install the TypeScript transpiler on your system:
$ [sudo -H] npm install -g typescript
-Then, within WebStorm, go to Preferences -> File Watchers -> "+" symbol and add TypeScript.
+On version 10 of WebStorm or later, got to Preferences -> Languages & Frameworks -> TypeScript and check "Enable TypeScript Compiler"
+
+On older versions of WebStorm (9 or earlier), go to Preferences -> File Watchers -> "+" symbol and add TypeScript.
+
+#### SublimeText, Atom, and VisualStudio ####
+Please refer to the documentation for these editors.
### Command line
-Last option, is to compile code from the command line. With node and the typescript compiler installed:
+The last option is to compile code from the command line. With node and the TypeScript compiler installed:
$ tsc *.ts
+
diff --git a/meteor/meteor-tests.ts b/meteor/meteor-tests.ts
index f265279113..e6f1e6f28f 100644
--- a/meteor/meteor-tests.ts
+++ b/meteor/meteor-tests.ts
@@ -92,8 +92,8 @@ Tracker.autorun(function () {
});
console.log("Current room has " +
-Counts.find(Session.get("roomId")).count +
-" messages.");
+ Counts.find(Session.get("roomId")).count +
+ " messages.");
/**
* From Publish and Subscribe, Meteor.subscribe section
@@ -128,6 +128,22 @@ Meteor.methods({
}
});
+/**
+ * From Methods, Meteor.Error section
+ */
+throw new Meteor.Error("logged-out",
+ "The user must be logged in to post a comment.");
+
+Meteor.call("methodName", function (error) {
+ if (error.error === "logged-out") {
+ Session.set("errorMessage", "Please log in to post a comment.");
+ }
+});
+var error = new Meteor.Error("logged-out", "The user must be logged in to post a comment.");
+console.log(error.error === "logged-out");
+console.log(error.reason === "The user must be logged in to post a comment.");
+console.log(error.details !== "");
+
/**
* From Methods, Meteor.call section
*/
@@ -183,8 +199,10 @@ Animal.prototype = {
interface AnimalDAO {
- _id: string;
- makeNoise: () => void;
+ _id?: string;
+ name: string;
+ sound: string;
+ makeNoise?: () => void;
}
// Define a Collection that uses Animal as its document
@@ -224,8 +242,8 @@ Template['adminDashboard'].events({
Meteor.methods({
declareWinners: function () {
Players.update({score: {$gt: 10}},
- {$addToSet: {badges: "Winner"}},
- {multi: true});
+ {$addToSet: {badges: "Winner"}},
+ {multi: true});
}
});
@@ -251,18 +269,26 @@ Meteor.startup(function () {
/***
* From Collections, collection.allow section
*/
-Posts = new Mongo.Collection("posts");
+
+interface iPost {
+ _id: string;
+ owner: string;
+ userId: string;
+ locked: boolean;
+}
+
+Posts = new Mongo.Collection<iPost>("posts");
Posts.allow({
- insert: function (userId, doc) {
+ insert: function (userId, doc: iPost) {
// the user must be logged in, and the document must be owned by the user
return (userId && doc.owner === userId);
},
- update: function (userId, doc, fields, modifier) {
+ update: function (userId, doc: iPost, fields, modifier) {
// can only change your own documents
return doc.owner === userId;
},
- remove: function (userId, doc) {
+ remove: function (userId, doc: iPost) {
// can only remove your own documents
return doc.owner === userId;
},
@@ -270,11 +296,11 @@ Posts.allow({
});
Posts.deny({
- update: function (userId, docs, fields, modifier) {
+ update: function (userId, doc: iPost, fields, modifier) {
// can't change owners
- return docs.userId !== userId;
+ return doc.userId !== userId;
},
- remove: function (userId, doc) {
+ remove: function (userId, doc: iPost) {
// can't remove locked documents
return doc.locked;
},
@@ -347,7 +373,7 @@ Session.equals("key", value);
*/
Meteor.publish("userData", function () {
return Meteor.users.find({_id: this.userId},
- {fields: {'other': 1, 'things': 1}});
+ {fields: {'other': 1, 'things': 1}});
});
Meteor.users.deny({update: function () { return true; }});
@@ -411,8 +437,8 @@ Accounts.emailTemplates.enrollAccount.subject = function (user) {
};
Accounts.emailTemplates.enrollAccount.text = function (user, url) {
return "You have been selected to participate in building a better future!"
- + " To activate your account, simply click the link below:\n\n"
- + url;
+ + " To activate your account, simply click the link below:\n\n"
+ + url;
};
/**
@@ -441,7 +467,7 @@ Template['newTemplate'].destroyed = function () {
};
Template['newTemplate'].events({
- 'click .something': function (event) {
+ 'click .something': function (event: Meteor.Event, template: Blaze.TemplateInstance) {
}
});
@@ -540,7 +566,7 @@ Meteor.methods({checkTwitter: function (userId) {
check(userId, String);
this.unblock();
var result = HTTP.call("GET", "http://api.twitter.com/xyz",
- {params: {user: userId}});
+ {params: {user: userId}});
if (result.statusCode === 200)
return true
return false;
@@ -548,12 +574,12 @@ Meteor.methods({checkTwitter: function (userId) {
HTTP.call("POST", "http://api.twitter.com/xyz",
- {data: {some: "json", stuff: 1}},
- function (error, result) {
- if (result.statusCode === 200) {
- Session.set("twizzled", true);
- }
- });
+ {data: {some: "json", stuff: 1}},
+ function (error, result) {
+ if (result.statusCode === 200) {
+ Session.set("twizzled", true);
+ }
+ });
/**
* From Email, Email.send section
@@ -570,9 +596,9 @@ Meteor.methods({
// In your client code: asynchronously send an email
Meteor.call('sendEmail',
- 'alice@example.com',
- 'Hello from Meteor!',
- 'This is a test of Email.send.');
+ 'alice@example.com',
+ 'Hello from Meteor!',
+ 'This is a test of Email.send.');
var testTemplate = new Blaze.Template();
var testView = new Blaze.View();
@@ -594,4 +620,4 @@ var reactiveVar1 = new ReactiveVar<string>('test value');
var reactiveVar2 = new ReactiveVar<string>('test value', function(oldVal) { return true; });
var varValue: string = reactiveVar1.get();
-reactiveVar1.set('new value');
\ No newline at end of file
+reactiveVar1.set('new value');
diff --git a/meteor/meteor.d.ts b/meteor/meteor.d.ts
index 9b5dacbe22..ee6c1db412 100644
--- a/meteor/meteor.d.ts
+++ b/meteor/meteor.d.ts
@@ -1,10 +1,10 @@
-// Type definitions for Meteor 1.1.0.1
+// Type definitions for Meteor 1.2.0.2
// Project: http://www.meteor.com/
// Definitions by: Dave Allen <https://github.com/fullflavedave>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/**
- * These are the modules and interfaces that can't be automatically generated from the Meteor data.js file
+ * These are the common (for client and server) modules and interfaces that can't be automatically generated from the Meteor data.js file
*/
interface EJSONable {
@@ -16,59 +16,20 @@ interface JSONable {
interface EJSON extends EJSONable {}
declare module Match {
- var Any:any;
- var String:any;
- var Integer:any;
- var Boolean:any;
- var undefined:any;
+ var Any: any;
+ var String: any;
+ var Integer: any;
+ var Boolean: any;
+ var undefined: any;
//function null(); // not allowed in TypeScript
- var Object:any;
- function Optional(pattern:any):boolean;
- function ObjectIncluding(dico:any):boolean;
- function OneOf(...patterns:any[]):any;
- function Where(condition:any):any;
+ var Object: any;
+ function Optional(pattern: any):boolean;
+ function ObjectIncluding(dico: any):boolean;
+ function OneOf(...patterns: any[]): any;
+ function Where(condition: any): any;
}
declare module Meteor {
- /** Start definitions for Template **/
- interface Event {
- type:string;
- target:HTMLElement;
- currentTarget:HTMLElement;
- which: number;
- stopPropagation():void;
- stopImmediatePropagation():void;
- preventDefault():void;
- isPropagationStopped():boolean;
- isImmediatePropagationStopped():boolean;
- isDefaultPrevented():boolean;
- }
-
- interface EventHandlerFunction extends Function {
- (event?:Meteor.Event):void;
- }
-
- interface EventMap {
- [id:string]:Meteor.EventHandlerFunction;
- }
- /** End definitions for Template **/
-
- interface LoginWithExternalServiceOptions {
- requestPermissions?: string[];
- requestOfflineToken?: Boolean;
- forceApprovalPrompt?: Boolean;
- userEmail?: string;
- loginStyle?: string;
- }
-
- function loginWithMeteorDeveloperAccount(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
- function loginWithFacebook(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
- function loginWithGithub(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
- function loginWithGoogle(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
- function loginWithMeetup(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
- function loginWithTwitter(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
- function loginWithWeibo(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
-
interface UserEmail {
address:string;
verified:boolean;
@@ -83,16 +44,6 @@ declare module Meteor {
services?: any;
}
- interface SubscriptionHandle {
- stop(): void;
- ready(): boolean;
- }
-
- interface Tinytest {
- add(name:string, func:Function):any;
- addAsync(name:string, func:Function):any;
- }
-
enum StatusEnum {
connected,
connecting,
@@ -104,53 +55,40 @@ declare module Meteor {
interface LiveQueryHandle {
stop(): void;
}
+}
- interface EmailFields {
- subject?: Function;
- text?: Function;
+declare module DDP {
+ interface DDPStatic {
+ subscribe(name: string, ...rest: any[]): Meteor.SubscriptionHandle;
+ call(method: string, ...parameters: any[]):void;
+ apply(method: string, ...parameters: any[]):void;
+ methods(IMeteorMethodsDictionary: any): any;
+ status():DDPStatus;
+ reconnect(): void;
+ disconnect(): void;
+ onReconnect(): void;
}
- interface EmailTemplates {
- from: string;
- siteName: string;
- resetPassword: Meteor.EmailFields;
- enrollAccount: Meteor.EmailFields;
- verifyEmail: Meteor.EmailFields;
- }
-
- interface Error {
- error: number;
+ interface DDPStatus {
+ connected: boolean;
+ status: Meteor.StatusEnum;
+ retryCount: number;
+ //To turn this into an interval until the next reconnection, use retryTime - (new Date()).getTime()
+ retryTime?: number;
reason?: string;
- details?: string;
- }
-
- interface Connection {
- id: string;
- close: Function;
- onClose: Function;
- clientAddress: string;
- httpHeaders: Object;
}
}
declare module Mongo {
- interface Selector {}
+ interface Selector {
+ [key: string]:any;
+ }
+ interface Selector extends Object {}
interface Modifier {}
interface SortSpecifier {}
interface FieldSpecifier {
[id: string]: Number;
}
- enum IdGenerationEnum {
- STRING,
- MONGO
- }
- interface AllowDenyOptions {
- insert?: (userId:string, doc:any) => boolean;
- update?: (userId:string, doc:any, fieldNames:string[], modifier:any) => boolean;
- remove?: (userId:string, doc:any) => boolean;
- fetch?: string[];
- transform?: Function;
- }
}
declare module HTTP {
@@ -178,43 +116,6 @@ declare module HTTP {
function get(url: string, callOptions?: HTTP.HTTPRequest, asyncCallback?: Function): HTTP.HTTPResponse;
function post(url: string, callOptions?: HTTP.HTTPRequest, asyncCallback?: Function): HTTP.HTTPResponse;
function put(url: string, callOptions?: HTTP.HTTPRequest, asyncCallback?: Function): HTTP.HTTPResponse;
-
-}
-
-declare module Email {
- interface EmailMessage {
- from: string;
- to: string|string[];
- cc?: string|string[];
- bcc?: string|string[];
- replyTo?: string|string[];
- subject: string;
- text?: string;
- html?: string;
- headers?: {[id: string]: string};
- }
-}
-
-declare module DDP {
- interface DDPStatic {
- subscribe(name:string, ...rest:any[]):void;
- call(method:string, ...parameters:any[]):void;
- apply(method:string, ...parameters:any[]):void;
- methods(IMeteorMethodsDictionary:any):any;
- status():DDPStatus;
- reconnect():void;
- disconnect():void;
- onReconnect():void;
- }
-
- interface DDPStatus {
- connected: boolean;
- status: Meteor.StatusEnum;
- retryCount: number;
- //To turn this into an interval until the next reconnection, use retryTime - (new Date()).getTime()
- retryTime?: number;
- reason?: string;
- }
}
declare module Random {
@@ -226,6 +127,56 @@ declare module Random {
function choice(str:string):string; // @param str, @return a random char in str
}
+/**
+ * These are the client modules and interfaces that can't be automatically generated from the Meteor data.js file
+ */
+
+declare module Meteor {
+ /** Start definitions for Template **/
+ interface Event {
+ type:string;
+ target:HTMLElement;
+ currentTarget:HTMLElement;
+ which: number;
+ stopPropagation():void;
+ stopImmediatePropagation():void;
+ preventDefault():void;
+ isPropagationStopped():boolean;
+ isImmediatePropagationStopped():boolean;
+ isDefaultPrevented():boolean;
+ }
+
+ interface EventHandlerFunction extends Function {
+ (event?:Meteor.Event, templateInstance?: Blaze.TemplateInstance):void;
+ }
+
+ interface EventMap {
+ [id:string]:Meteor.EventHandlerFunction;
+ }
+ /** End definitions for Template **/
+
+ interface LoginWithExternalServiceOptions {
+ requestPermissions?: string[];
+ requestOfflineToken?: Boolean;
+ forceApprovalPrompt?: Boolean;
+ userEmail?: string;
+ loginStyle?: string;
+ }
+
+ function loginWithMeteorDeveloperAccount(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+ function loginWithFacebook(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+ function loginWithGithub(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+ function loginWithGoogle(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+ function loginWithMeetup(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+ function loginWithTwitter(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+ function loginWithWeibo(options?: Meteor.LoginWithExternalServiceOptions, callback?: Function): void;
+
+ interface SubscriptionHandle {
+ stop(): void;
+ ready(): boolean;
+ }
+}
+
declare module Blaze {
interface View {
name: string;
@@ -286,25 +237,113 @@ declare module BrowserPolicy {
}
}
-declare module Tracker {
- export var ComputationFunction: (computation: Tracker.Computation) => void;
-
-}
-
-declare var IterationCallback: <T>(doc: T, index: number, cursor: Mongo.Cursor<T>) => void;
/**
- * These modules and interfaces are automatically generated from the Meteor api.js file
+ * These are the server modules and interfaces that can't be automatically generated from the Meteor data.js file
*/
+
+declare module Meteor {
+ interface EmailFields {
+ subject?: Function;
+ text?: Function;
+ }
+
+ interface EmailTemplates {
+ from: string;
+ siteName: string;
+ resetPassword: Meteor.EmailFields;
+ enrollAccount: Meteor.EmailFields;
+ verifyEmail: Meteor.EmailFields;
+ }
+
+ interface Connection {
+ id: string;
+ close: Function;
+ onClose: Function;
+ clientAddress: string;
+ httpHeaders: Object;
+ }
+}
+
+declare module Mongo {
+ interface AllowDenyOptions {
+ insert?: (userId: string, doc: any) => boolean;
+ update?: (userId: string, doc: any, fieldNames: string[], modifier: any) => boolean;
+ remove?: (userId: string, doc: any) => boolean;
+ fetch?: string[];
+ transform?: Function;
+ }
+}
+
+interface MailComposerOptions {
+ escapeSMTP: boolean;
+ encoding: string;
+ charset: string;
+ keepBcc: boolean;
+ forceEmbeddedImages: boolean;
+}
+
+declare var MailComposer: MailComposerStatic;
+interface MailComposerStatic {
+ new(options: MailComposerOptions): MailComposer;
+}
+interface MailComposer {
+ addHeader(name: string, value: string): void;
+ setMessageOption(from: string, to: string, body: string, html: string): void;
+ streamMessage(): void;
+ pipe(stream: any /** fs.WriteStream **/): void;
+}
+/**
+ * These are the modules and interfaces for packages that can't be automatically generated from the Meteor data.js file
+ */
+
+interface ILengthAble {
+ length: number;
+}
+
+interface ITinytestAssertions {
+ ok(doc: Object): void;
+ expect_fail(): void;
+ fail(doc: Object): void;
+ runId(): string;
+ equal<T>(actual: T, expected: T, message?: string, not?: boolean): void;
+ notEqual<T>(actual: T, expected: T, message?: string): void;
+ instanceOf(obj : Object, klass: Function, message?: string): void;
+ notInstanceOf(obj : Object, klass: Function, message?: string): void;
+ matches(actual : any, regexp: RegExp, message?: string): void;
+ notMatches(actual : any, regexp: RegExp, message?: string): void;
+ throws(f: Function, expected?: string|RegExp): void;
+ isTrue(v: boolean, msg?: string): void;
+ isFalse(v: boolean, msg?: string): void;
+ isNull(v: any, msg?: string): void;
+ isNotNull(v: any, msg?: string): void;
+ isUndefined(v: any, msg?: string): void;
+ isNotUndefined(v: any, msg?: string): void;
+ isNan(v: any, msg?: string): void;
+ isNotNan(v: any, msg?: string): void;
+ include<T>(s: Array<T>|Object|string, value: any, msg?: string, not?: boolean): void;
+
+ notInclude<T>(s: Array<T>|Object|string, value: any, msg?: string, not?: boolean): void;
+ length(obj: ILengthAble, expected_length: number, msg?: string): void;
+ _stringEqual(actual: string, expected: string, msg?: string): void;
+}
+
+declare module Tinytest {
+ function add(description : string , func : (test : ITinytestAssertions) => void) : void;
+ function addAsync(description : string , func : (test : ITinytestAssertions) => void) : void;
+}
+
+// Kept in for backwards compatibility
+declare module Meteor {
+ interface Tinytest {
+ add(description : string , func : (test : ITinytestAssertions) => void) : void;
+ addAsync(description : string , func : (test : ITinytestAssertions) => void) : void;
+ }
+}
+
declare module Accounts {
+ function addEmail(userId: string, newEmail: string, verified?: boolean): void;
function changePassword(oldPassword: string, newPassword: string, callback?: Function): void;
- function config(options: {
- sendVerificationEmail?: boolean;
- forbidClientAccountCreation?: boolean;
- restrictCreationByEmailDomain?: string | Function;
- loginExpirationInDays?: number;
- oauthSecretKey?: string;
- }): void;
function createUser(options: {
username?: string;
email?: string;
@@ -312,15 +351,15 @@ declare module Accounts {
profile?: Object;
}, callback?: Function): string;
var emailTemplates: Meteor.EmailTemplates;
+ function findUserByEmail(email: string): Object;
+ function findUserByUsername(username: string): Object;
function forgotPassword(options: {
email?: string;
}, callback?: Function): void;
- function onCreateUser(func: Function): void;
function onEmailVerificationLink(callback: Function): void;
function onEnrollmentLink(callback: Function): void;
- function onLogin(func: Function): {stop: Function};
- function onLoginFailure(func: Function): {stop: Function};
function onResetPasswordLink(callback: Function): void;
+ function removeEmail(userId: string, email: string): void;
function resetPassword(token: string, newPassword: string, callback?: Function): void;
function sendEnrollmentEmail(userId: string, email?: string): void;
function sendResetPasswordEmail(userId: string, email?: string): void;
@@ -328,6 +367,7 @@ declare module Accounts {
function setPassword(userId: string, newPassword: string, options?: {
logout?: Object;
}): void;
+ function setUsername(userId: string, newUsername: string): void;
var ui: {
config(options: {
requestPermissions?: Object;
@@ -336,16 +376,31 @@ declare module Accounts {
passwordSignupFields?: string;
}): void;
};
- function validateLoginAttempt(func: Function): {stop: Function};
- function validateNewUser(func: Function): void;
function verifyEmail(token: string, callback?: Function): void;
+ function config(options: {
+ sendVerificationEmail?: boolean;
+ forbidClientAccountCreation?: boolean;
+ restrictCreationByEmailDomain?: string | Function;
+ loginExpirationInDays?: number;
+ oauthSecretKey?: string;
+ }): void;
+ function onLogin(func: Function): { stop: () => void };
+ function onLoginFailure(func: Function): { stop: () => void };
+ function user(): Meteor.User;
+ function userId(): string;
+ function loggingIn(): boolean;
+ function logout(callback?: Function): void;
+ function logoutOtherClients(callback?: Function): void;
+ function onCreateUser(func: Function): void;
+ function validateLoginAttempt(func: Function): { stop: () => void };
+ function validateNewUser(func: Function): boolean;
}
declare module App {
function accessRule(domainRule: string, options?: {
launchExternal?: boolean;
- }):any; /** TODO: add return value **/
-function configurePlugin(pluginName: string, config: Object): void;
+ }): void;
+ function configurePlugin(id: string, config: Object): void;
function icons(icons: Object): void;
function info(options: {
id?: string;
@@ -357,7 +412,7 @@ function configurePlugin(pluginName: string, config: Object): void;
website?: string;
}): void;
function launchScreens(launchScreens: Object): void;
- function setPreference(name: string, value: string): void;
+ function setPreference(name: string, value: string, platform?: string): void;
}
declare module Assets {
@@ -368,6 +423,7 @@ declare module Assets {
declare module Blaze {
function Each(argFunc: Function, contentFunc: Function, elseFunc?: Function): Blaze.View;
function If(conditionFunc: Function, contentFunc: Function, elseFunc?: Function): Blaze.View;
+ function Let(bindings: Function, contentFunc: Function): Blaze.View;
var Template: TemplateStatic;
interface TemplateStatic {
new(viewName?: string, renderFunction?: Function): Template;
@@ -426,6 +482,11 @@ declare module DDP {
function connect(url: string): DDP.DDPStatic;
}
+declare module DDPCommon {
+ function MethodInvocation(options: {
+ }): any;
+}
+
declare module EJSON {
var CustomType: CustomTypeStatic;
interface CustomTypeStatic {
@@ -434,16 +495,16 @@ declare module EJSON {
interface CustomType {
clone(): EJSON.CustomType;
equals(other: Object): boolean;
- toJSONValue(): JSON;
+ toJSONValue(): JSONable;
typeName(): string;
}
- function addType(name: string, factory: (val: EJSONable) => JSONable): void;
+ function addType(name: string, factory: (val: JSONable) => EJSON.CustomType): void;
function clone<T>(val:T): T;
function equals(a: EJSON, b: EJSON, options?: {
keyOrderSensitive?: boolean;
}): boolean;
- function fromJSONValue(val: JSON): any;
+ function fromJSONValue(val: JSONable): any;
function isBinary(x: Object): boolean;
var newBinary: any;
function parse(str: string): EJSON;
@@ -451,7 +512,7 @@ declare module EJSON {
indent?: boolean | number | string;
canonical?: boolean;
}): string;
- function toJSONValue(val: EJSON): JSON;
+ function toJSONValue(val: EJSON): JSONable;
}
declare module Match {
@@ -464,8 +525,10 @@ declare module Meteor {
new(error: string, reason?: string, details?: string): Error;
}
interface Error {
+ error: string;
+ reason?: string;
+ details?: string;
}
-
function absoluteUrl(path?: string, options?: {
secure?: boolean;
replaceLocalhost?: boolean;
@@ -486,9 +549,10 @@ declare module Meteor {
function loginWith<ExternalService>(options?: {
requestPermissions?: string[];
requestOfflineToken?: boolean;
- forceApprovalPrompt?: boolean;
+ loginUrlParameters?: Object;
userEmail?: string;
loginStyle?: string;
+ redirectUrl?: string;
}, callback?: Function): void;
function loginWithPassword(user: Object | string, password: string, callback?: Function): void;
function logout(callback?: Function): void;
@@ -521,20 +585,20 @@ declare module Mongo {
}
interface Collection<T> {
allow(options: {
- insert?: (userId:string, doc:any) => boolean;
- update?: (userId:string, doc:any, fieldNames:string[], modifier:any) => boolean;
- remove?: (userId:string, doc:any) => boolean;
+ insert?: (userId: string, doc: T) => boolean;
+ update?: (userId: string, doc: T, fieldNames: string[], modifier: any) => boolean;
+ remove?: (userId: string, doc: T) => boolean;
fetch?: string[];
transform?: Function;
}): boolean;
deny(options: {
- insert?: (userId:string, doc:any) => boolean;
- update?: (userId:string, doc:any, fieldNames:string[], modifier:any) => boolean;
- remove?: (userId:string, doc:any) => boolean;
+ insert?: (userId: string, doc: T) => boolean;
+ update?: (userId: string, doc: T, fieldNames: string[], modifier: any) => boolean;
+ remove?: (userId: string, doc: T) => boolean;
fetch?: string[];
transform?: Function;
}): boolean;
- find(selector?: Mongo.Selector, options?: {
+ find(selector?: Mongo.Selector | Mongo.ObjectID | string, options?: {
sort?: Mongo.SortSpecifier;
skip?: number;
limit?: number;
@@ -542,20 +606,22 @@ declare module Mongo {
reactive?: boolean;
transform?: Function;
}): Mongo.Cursor<T>;
- findOne(selector?: Mongo.Selector, options?: {
+ findOne(selector?: Mongo.Selector | Mongo.ObjectID | string, options?: {
sort?: Mongo.SortSpecifier;
skip?: number;
fields?: Mongo.FieldSpecifier;
reactive?: boolean;
transform?: Function;
}): T;
- insert(doc: Object, callback?: Function): string;
- remove(selector: Mongo.Selector, callback?: Function): void;
- update(selector: Mongo.Selector, modifier: Mongo.Modifier, options?: {
+ insert(doc: T, callback?: Function): string;
+ rawCollection(): any;
+ rawDatabase(): any;
+ remove(selector: Mongo.Selector | Mongo.ObjectID | string, callback?: Function): void;
+ update(selector: Mongo.Selector | Mongo.ObjectID | string, modifier: Mongo.Modifier, options?: {
multi?: boolean;
upsert?: boolean;
}, callback?: Function): number;
- upsert(selector: Mongo.Selector, modifier: Mongo.Modifier, options?: {
+ upsert(selector: Mongo.Selector | Mongo.ObjectID | string, modifier: Mongo.Modifier, options?: {
multi?: boolean;
}, callback?: Function): {numberAffected?: number; insertedId?: string;};
_ensureIndex(indexName: string, options?: {[key: string]: any}): void;
@@ -569,7 +635,7 @@ declare module Mongo {
count(): number;
fetch(): Array<T>;
forEach(callback: <T>(doc: T, index: number, cursor: Mongo.Cursor<T>) => void, thisArg?: any): void;
- map(callback: <T>(doc: T, index: number, cursor: Mongo.Cursor<T>) => void, thisArg?: any): Array<T>;
+ map<U>(callback: (doc: T, index: number, cursor: Mongo.Cursor<T>) => U, thisArg?: any): Array<U>;
observe(callbacks: Object): Meteor.LiveQueryHandle;
observeChanges(callbacks: Object): Meteor.LiveQueryHandle;
}
@@ -595,6 +661,8 @@ declare module Package {
name?: string;
git?: string;
documentation?: string;
+ debugOnly?: boolean;
+ prodOnly?: boolean;
}): void;
function onTest(func: Function): void;
function onUse(func: Function): void;
@@ -613,6 +681,7 @@ declare module Tracker {
invalidate(): void;
invalidated: boolean;
onInvalidate(callback: Function): void;
+ onStop(callback: Function): void;
stop(): void;
stopped: boolean;
}
@@ -656,6 +725,7 @@ declare module HTTP {
timeout?: number;
followRedirects?: boolean;
npmRequestOptions?: Object;
+ beforeSend?: Function;
}, asyncCallback?: Function): HTTP.HTTPResponse;
function del(url: string, callOptions?: Object, asyncCallback?: Function): HTTP.HTTPResponse;
function get(url: string, callOptions?: Object, asyncCallback?: Function): HTTP.HTTPResponse;
@@ -675,6 +745,7 @@ declare module Email {
html?: string;
headers?: Object;
attachments?: Object[];
+ mailComposer?: MailComposer;
}): void;
}
@@ -684,30 +755,30 @@ interface CompileStepStatic {
}
interface CompileStep {
addAsset(options: {
- }, path: string, data: any /** Buffer **/ | string): any; /** TODO: add return value **/
+ }, path: string, data: any /** Buffer **/ | string): any;
addHtml(options: {
section?: string;
data?: string;
- }): any; /** TODO: add return value **/
+ }): any;
addJavaScript(options: {
path?: string;
data?: string;
sourcePath?: string;
- }): any; /** TODO: add return value **/
+ }): any;
addStylesheet(options: {
- }, path: string, data: string, sourceMap: string): any; /** TODO: add return value **/
- arch: any; /** TODO: add return value **/
- declaredExports: any; /** TODO: add return value **/
+ }, path: string, data: string, sourceMap: string): any;
+ arch: any;
+ declaredExports: any;
error(options: {
- }, message: string, sourcePath?: string, line?: number, func?: string): any; /** TODO: add return value **/
- fileOptions: any; /** TODO: add return value **/
- fullInputPath: any; /** TODO: add return value **/
- inputPath: any; /** TODO: add return value **/
- inputSize: any; /** TODO: add return value **/
- packageName: any; /** TODO: add return value **/
- pathForSourceMap: any; /** TODO: add return value **/
+ }, message: string, sourcePath?: string, line?: number, func?: string): any;
+ fileOptions: any;
+ fullInputPath: any;
+ inputPath: any;
+ inputSize: any;
+ packageName: any;
+ pathForSourceMap: any;
read(n?: number): any;
- rootOutputPath: any; /** TODO: add return value **/
+ rootOutputPath: any;
}
declare var PackageAPI: PackageAPIStatic;
@@ -715,10 +786,13 @@ interface PackageAPIStatic {
new(): PackageAPI;
}
interface PackageAPI {
- addFiles(filename: string | string[], architecture?: string): void;
- export(exportedObject: string, architecture?: string): void;
- imply(packageSpecs: string | string[]): void;
- use(packageNames: string | string[], architecture?: string, options?: {
+ addAssets(filenames: string | string[], architecture: string | string[]): void;
+ addFiles(filenames: string | string[], architecture?: string | string[], options?: {
+ bare?: boolean;
+ }): void;
+ export(exportedObjects: string | string[], architecture?: string | string[], exportOptions?: Object, testOnly?: boolean): void;
+ imply(packageNames: string | string[], architecture?: string | string[]): void;
+ use(packageNames: string | string[], architecture?: string | string[], options?: {
weak?: boolean;
unordered?: boolean;
}): void;
@@ -768,7 +842,7 @@ interface TemplateStatic {
interface Template {
created: Function;
destroyed: Function;
- events(eventMap: {[actions: string]: Function}): void;
+ events(eventMap: Meteor.EventMap): void;
helpers(helpers:{[id:string]: any}): void;
onCreated: Function;
onDestroyed: Function;
@@ -776,6 +850,19 @@ interface Template {
rendered: Function;
}
-declare function MethodInvocation(options: {
-}): any; /** TODO: add return value **/
declare function check(value: any, pattern: any): void;
+declare function execFileAsync(command: string, args?: any[], options?: {
+ cwd?: Object;
+ env?: Object;
+ stdio?: any[] | string;
+ destination?: any;
+ waitForClose?: string;
+}): any;
+declare function execFileSync(command: string, args?: any[], options?: {
+ cwd?: Object;
+ env?: Object;
+ stdio?: any[] | string;
+ destination?: any;
+ waitForClose?: string;
+}): String;
+declare function getExtension(): String;
diff --git a/mobservable-react/mobservable-react.d.ts b/mobservable-react/mobservable-react.d.ts
index f42627a857..e95fc69f5d 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/mobservable/mobservable-tests.ts.tscparams b/mobservable/mobservable-tests.ts.tscparams
index 77f208cc0d..64e543982c 100644
--- a/mobservable/mobservable-tests.ts.tscparams
+++ b/mobservable/mobservable-tests.ts.tscparams
@@ -1 +1 @@
---noImplicitAny --module commonjs --target es5 --experimentalDecorators
+--noImplicitAny --module commonjs --target es5 --experimentalDecorators
diff --git a/mocha/mocha-tests.ts b/mocha/mocha-tests.ts
index f90fefaf96..d0108263ec 100644
--- a/mocha/mocha-tests.ts
+++ b/mocha/mocha-tests.ts
@@ -70,6 +70,10 @@ function test_before() {
before(() => { });
before((done) => { done(); });
+
+ before("my description", () => { });
+
+ before("my description", done => { });
}
function test_setup() {
@@ -82,6 +86,10 @@ function test_after() {
after(() => { });
after((done) => { done(); });
+
+ after("my description", () => { });
+
+ after("my description", done => { });
}
function test_teardown() {
@@ -94,6 +102,10 @@ function test_beforeEach() {
beforeEach(() => { });
beforeEach((done) => { done(); });
+
+ beforeEach("my description", () => { });
+
+ beforeEach("my description", done => { });
}
function test_suiteSetup() {
@@ -106,6 +118,10 @@ function test_afterEach() {
afterEach(() => { });
afterEach((done) => { done(); });
+
+ afterEach("my description", () => { });
+
+ afterEach("my description", done => { });
}
function test_suiteTeardown() {
@@ -249,3 +265,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 88dc359fcc..1e09d7b531 100644
--- a/mocha/mocha.d.ts
+++ b/mocha/mocha.d.ts
@@ -49,6 +49,10 @@ declare function before(action: () => void): void;
declare function before(action: (done: MochaDone) => void): void;
+declare function before(description: string, action: () => void): void;
+
+declare function before(description: string, action: (done: MochaDone) => void): void;
+
declare function setup(action: () => void): void;
declare function setup(action: (done: MochaDone) => void): void;
@@ -57,6 +61,10 @@ declare function after(action: () => void): void;
declare function after(action: (done: MochaDone) => void): void;
+declare function after(description: string, action: () => void): void;
+
+declare function after(description: string, action: (done: MochaDone) => void): void;
+
declare function teardown(action: () => void): void;
declare function teardown(action: (done: MochaDone) => void): void;
@@ -65,6 +73,10 @@ declare function beforeEach(action: () => void): void;
declare function beforeEach(action: (done: MochaDone) => void): void;
+declare function beforeEach(description: string, action: () => void): void;
+
+declare function beforeEach(description: string, action: (done: MochaDone) => void): void;
+
declare function suiteSetup(action: () => void): void;
declare function suiteSetup(action: (done: MochaDone) => void): void;
@@ -73,6 +85,10 @@ declare function afterEach(action: () => void): void;
declare function afterEach(action: (done: MochaDone) => void): void;
+declare function afterEach(description: string, action: () => void): void;
+
+declare function afterEach(description: string, action: (done: MochaDone) => void): void;
+
declare function suiteTeardown(action: () => void): void;
declare function suiteTeardown(action: (done: MochaDone) => void): void;
@@ -100,6 +116,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/mockery/mockery-test.ts b/mockery/mockery-tests.ts
similarity index 100%
rename from mockery/mockery-test.ts
rename to mockery/mockery-tests.ts
diff --git a/moment/moment-external-tests.ts b/moment/moment-external-tests.ts
index ed3e1e2a82..c8108d1b99 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 93be9f6d44..babde41c92 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 */
@@ -303,6 +303,7 @@ declare module moment {
get(unit: string): number;
set(unit: string, value: number): Moment;
+ set(objectLiteral: MomentInput): Moment;
}
type formatFunction = () => string;
@@ -345,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 {
@@ -453,8 +456,8 @@ declare module moment {
weekdaysMin(format: string): string[];
weekdaysMin(format: string, index: number): string;
- min(moments: Moment[]): Moment;
- max(moments: Moment[]): Moment;
+ min(...moments: Moment[]): Moment;
+ max(...moments: Moment[]): Moment;
normalizeUnits(unit: string): string;
relativeTimeThreshold(threshold: string): number|boolean;
diff --git a/moment/moment-tests.ts b/moment/moment-tests.ts
index 29712c1156..14e58c6128 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 2fc3f0227f..38037f0039 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/nedb/nedb-test.ts b/nedb/nedb-tests.ts
similarity index 100%
rename from nedb/nedb-test.ts
rename to nedb/nedb-tests.ts
diff --git a/ng-cordova/appAvailability-tests.ts b/ng-cordova/appAvailability-tests.ts
new file mode 100644
index 0000000000..c9e2be537b
--- /dev/null
+++ b/ng-cordova/appAvailability-tests.ts
@@ -0,0 +1,41 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.appavailability {
+ 'use strict';
+
+ export class AppAvailabilityController {
+
+ isAvailable:boolean;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaDevice", "$cordovaAppAvailability"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService,
+ private $cordovaDevice:ngCordova.IDeviceService,
+ private $cordovaAppAvailability:ngCordova.IAppAvailabilityService) {
+
+ this.isAvailable = false;
+
+ var scheme = "com.twitter.android";
+
+ if ($cordovaDevice.getPlatform() == 'iOS') {
+ scheme = "twitter://";
+ }
+
+ $ionicPlatform.ready(() => {
+ $cordovaAppAvailability.check(scheme).then(() => {
+ this.isAvailable = true;
+ }, (err) => {
+ // bad api design in plugin as well as in ngCordova !!
+ this.isAvailable = false;
+ })
+ });
+ }
+
+ }
+
+ angular.module("demo.appavailability").controller("AppAvailabilityController", AppAvailabilityController);
+}
diff --git a/ng-cordova/appAvailability.d.ts b/ng-cordova/appAvailability.d.ts
new file mode 100644
index 0000000000..ec873ba8da
--- /dev/null
+++ b/ng-cordova/appAvailability.d.ts
@@ -0,0 +1,14 @@
+// Type definitions for ngCordova AppAvailability plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface IAppAvailabilityService {
+ check(urlScheme: string): ng.IPromise<any>;
+ }
+
+}
diff --git a/ng-cordova/device-tests.ts b/ng-cordova/device-tests.ts
new file mode 100644
index 0000000000..37a30bf663
--- /dev/null
+++ b/ng-cordova/device-tests.ts
@@ -0,0 +1,42 @@
+/// <reference path="device.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.device {
+ 'use strict';
+
+ interface IDeviceViewModel {
+ available:boolean;
+ cordova:string;
+ model:string;
+ platform:string;
+ uuid:string;
+ version:string;
+ }
+
+ export class DeviceController {
+
+ public vm:IDeviceViewModel;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaDevice"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService, $cordovaDevice:ngCordova.IDeviceService) {
+
+ $ionicPlatform.ready(() => {
+ this.vm = {
+ available : $cordovaDevice.getDevice().available,
+ cordova : $cordovaDevice.getCordova(),
+ model : $cordovaDevice.getModel(),
+ platform : $cordovaDevice.getPlatform(),
+ uuid : $cordovaDevice.getUUID(),
+ version : $cordovaDevice.getVersion()
+ };
+ });
+ }
+
+ }
+
+ angular.module("demo.device").controller("DeviceController", DeviceController);
+}
\ No newline at end of file
diff --git a/ng-cordova/device.d.ts b/ng-cordova/device.d.ts
new file mode 100644
index 0000000000..8171fb3fc0
--- /dev/null
+++ b/ng-cordova/device.d.ts
@@ -0,0 +1,78 @@
+// Type definitions for ngCordova device plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+declare module ngCordova {
+
+ interface IDeviceInfo {
+ available:boolean;
+ platform:string;
+ version:string;
+ uuid:string;
+ cordova:string;
+ model:string;
+ manufacturer:string;
+ isVirtual:boolean;
+ serial:string;
+ }
+
+ interface IDeviceService {
+
+ /**
+ * Returns the whole device object.
+ * @see https://github.com/apache/cordova-plugin-device
+ * @returns {Object} The device object.
+ */
+ getDevice():IDeviceInfo;
+
+ /**
+ * Returns the Cordova version.
+ * @see https://github.com/apache/cordova-plugin-device#devicecordova
+ * @returns {String} The Cordova version.
+ */
+ getCordova():string;
+
+ /**
+ * Returns the name of the device's model or product.
+ * @see https://github.com/apache/cordova-plugin-device#devicemodel
+ * @returns {String} The name of the device's model or product.
+ */
+ getModel():string;
+
+
+ /**
+ * @deprecated device.name is deprecated as of version 2.3.0. Use device.model instead.
+ * @returns {String}
+ */
+ getName():string;
+
+ /**
+ * Returns the device's operating system name.
+ * @see https://github.com/apache/cordova-plugin-device#deviceplatform
+ * @returns {String} The device's operating system name.
+ */
+ getPlatform():string;
+
+
+ /**
+ * Returns the device's Universally Unique Identifier.
+ * @see https://github.com/apache/cordova-plugin-device#deviceuuid
+ * @returns {String} The device's Universally Unique Identifier
+ */
+ getUUID():string;
+
+ /**
+ * Returns the operating system version.
+ * @see https://github.com/apache/cordova-plugin-device#deviceversion
+ * @returns {String}
+ */
+ getVersion():string;
+
+ /**
+ * Returns the device manufacturer.
+ * @returns {String}
+ */
+ getManufacturer():string;
+ }
+}
\ No newline at end of file
diff --git a/ng-cordova/deviceMotion-tests.ts b/ng-cordova/deviceMotion-tests.ts
new file mode 100644
index 0000000000..b838661978
--- /dev/null
+++ b/ng-cordova/deviceMotion-tests.ts
@@ -0,0 +1,58 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.devicemotion {
+ 'use strict';
+
+ export class DeviceMotionController {
+
+ motion:ngCordova.IDeviceMotionAcceleration;
+ this_watch:ngCordova.IDeviceMotionWatchPromise;
+ msg:string;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaDeviceMotion"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService, private $cordovaDeviceMotion:ngCordova.IDeviceMotionService) {
+ $ionicPlatform.ready(() => {
+ this.getAcceleration();
+ });
+ }
+
+ getAcceleration () {
+ this.$cordovaDeviceMotion.getCurrentAcceleration().then( (motion) => {
+ this.motion = motion;
+ console.log(motion);
+ }, function (err) {
+ this.msg = err.message;
+ console.log(err);
+ });
+ }
+
+ watchAcceleration () {
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ this.this_watch = this.$cordovaDeviceMotion.watchAcceleration(options);
+
+ this.this_watch.then(
+ () => { /* unused */
+ },
+ (err) => {
+ this.msg = err.message;
+ },
+ (motion) => {
+ this.motion = motion;
+ });
+ };
+
+ clearWatch () {
+ // use watchID from watchAccelaration()
+ this.$cordovaDeviceMotion.clearWatch(this.this_watch.watchID);
+ };
+
+ }
+
+ angular.module("demo.devicemotion").controller("DeviceMotionController", DeviceMotionController);
+}
diff --git a/ng-cordova/deviceMotion.d.ts b/ng-cordova/deviceMotion.d.ts
new file mode 100644
index 0000000000..11e917ac7b
--- /dev/null
+++ b/ng-cordova/deviceMotion.d.ts
@@ -0,0 +1,33 @@
+// Type definitions for ngCordova device motion plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Michel Vidailhet <https://github.com/mvidailhet>, Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface IDeviceMotionAcceleration {
+ x: number;
+ y: number;
+ z: number;
+ timestamp: number;
+ }
+
+ export interface IDeviceMotionAccelerometerOptions {
+ frequency: number;
+ }
+
+ export interface IDeviceMotionWatchPromise extends ng.IPromise<IDeviceMotionAcceleration> {
+ watchID: number;
+ cancel: () => void;
+ clearWatch: (watchId?: number) => void;
+ }
+
+ export interface IDeviceMotionService {
+ getCurrentAcceleration(): ng.IPromise<IDeviceMotionAcceleration>;
+ watchAcceleration(options: IDeviceMotionAccelerometerOptions): IDeviceMotionWatchPromise;
+ clearWatch(watchId: number): void;
+ }
+
+}
diff --git a/ng-cordova/deviceOrientation-tests.ts b/ng-cordova/deviceOrientation-tests.ts
new file mode 100644
index 0000000000..b192fe583e
--- /dev/null
+++ b/ng-cordova/deviceOrientation-tests.ts
@@ -0,0 +1,65 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.deviceorientation {
+ 'use strict';
+
+ export class DeviceOrientationController {
+
+ msg:string;
+ heading:ngCordova.IDeviceOrientationHeading;
+ this_watch:ngCordova.IDeviceOrientationWatchPromise;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$timeout", "$cordovaDeviceOrientation"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService,
+ private $timeout:ng.ITimeoutService,
+ private $cordovaDeviceOrientation:ngCordova.IDeviceOrientationService) {
+
+ $ionicPlatform.ready(() => {
+ this.getHeading();
+ });
+
+ }
+
+ getHeading() {
+ this.$cordovaDeviceOrientation
+ .getCurrentHeading()
+ .then((position) => {
+ this.heading = position;
+ }, (err) => {
+ this.msg = err.message;
+ });
+ };
+
+
+ watchHeading () {
+ this.this_watch = this.$cordovaDeviceOrientation.watchHeading({frequency: 1000});
+
+ this.this_watch.then(
+ () => {
+ /* unused */
+ },
+ (err) => {
+ this.msg = err.message;
+ },
+ (position) => {
+ this.$timeout(() => {
+ this.heading = position;
+ });
+ }
+ );
+
+ };
+
+ clearWatch () {
+ this.$cordovaDeviceOrientation.clearWatch(this.this_watch.watchID);
+ };
+
+ }
+
+ angular.module("demo.deviceorientation").controller("DeviceOrientationController", DeviceOrientationController);
+}
diff --git a/ng-cordova/deviceOrientation.d.ts b/ng-cordova/deviceOrientation.d.ts
new file mode 100644
index 0000000000..1198a330a3
--- /dev/null
+++ b/ng-cordova/deviceOrientation.d.ts
@@ -0,0 +1,34 @@
+// Type definitions for ngCordova device orientation plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Michel Vidailhet <https://github.com/mvidailhet>, Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface IDeviceOrientationHeading {
+ magneticHeading: number;
+ trueHeading?: number;
+ headingAccuracy?: number;
+ timestamp?: number;
+ }
+
+ export interface IDeviceOrientationWatchOptions {
+ frequency?: number;
+ filter?: number;
+ }
+
+ export interface IDeviceOrientationWatchPromise extends ng.IPromise<IDeviceOrientationHeading> {
+ watchID: number;
+ cancel: () => void;
+ clearWatch: (watchId?: number) => void;
+ }
+
+ export interface IDeviceOrientationService {
+ getCurrentHeading(): ng.IPromise<IDeviceOrientationHeading>;
+ watchHeading(options: IDeviceOrientationWatchOptions): IDeviceOrientationWatchPromise;
+ clearWatch(watchID: number): void;
+ }
+
+}
diff --git a/ng-cordova/dialogs-tests.ts b/ng-cordova/dialogs-tests.ts
new file mode 100644
index 0000000000..2e6c152b9c
--- /dev/null
+++ b/ng-cordova/dialogs-tests.ts
@@ -0,0 +1,47 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.dialog {
+ 'use strict';
+
+ export class DialogController {
+
+ action:string;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaDialogs"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService, private $cordovaDialogs:ngCordova.IDialogsService) {
+ this.action = "Press any button !";
+ }
+
+ alert() {
+ this.action = "Alert";
+ this.$cordovaDialogs.alert('Wow!');
+ }
+
+ confirm() {
+ this.action = "Confirm";
+ this.$cordovaDialogs.confirm('Are you sure?', "Custom title").then(function (buttonIndex) {
+ this.$cordovaDialogs.alert("Button index : " + buttonIndex);
+ });
+ }
+
+ prompt() {
+ this.action = "Prompt";
+ this.$cordovaDialogs.prompt('Please Login', "Custom title").then(function (result) {
+ this.$cordovaDialogs.alert("Input: " + result.input1 + "\n Button index : " + result.buttonIndex);
+ });
+ }
+
+ beep() {
+ this.action = "Beep";
+ this.$cordovaDialogs.beep(3);
+ }
+
+ }
+
+ angular.module("demo.dialog").controller("DialogController", DialogController);
+}
diff --git a/ng-cordova/dialogs.d.ts b/ng-cordova/dialogs.d.ts
new file mode 100644
index 0000000000..7a67705dee
--- /dev/null
+++ b/ng-cordova/dialogs.d.ts
@@ -0,0 +1,22 @@
+// Type definitions for ngCordova dialogs plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Michel Vidailhet <https://github.com/mvidailhet>, Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface IDialogsPromptResult {
+ input1: string;
+ buttonIndex: number;
+ }
+
+ export interface IDialogsService {
+ alert(message: string, title?: string, buttonName?: string): ng.IPromise<void>;
+ confirm(message: string, title?: string, buttonArray?: Array<string>): ng.IPromise<number>;
+ prompt(message: string, title?: string, buttonArray?: Array<string>, defaultText?: string): ng.IPromise<IDialogsPromptResult>;
+ beep(repetitions: number): void;
+ }
+
+}
diff --git a/ng-cordova/emailComposer-tests.ts b/ng-cordova/emailComposer-tests.ts
new file mode 100644
index 0000000000..8880939a51
--- /dev/null
+++ b/ng-cordova/emailComposer-tests.ts
@@ -0,0 +1,47 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.email {
+ 'use strict';
+
+ export class EmailComposerController {
+
+ isAvailable:boolean;
+ status:string;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaEmailComposer"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService, $cordovaEmailComposer:ngCordova.IEmailComposerService) {
+
+ this.status = "";
+
+ $ionicPlatform.ready(() => {
+
+ $cordovaEmailComposer.isAvailable().then((available) => {
+ this.isAvailable = available;
+ });
+
+ let email = <ngCordova.IEmailComposerOptions>{
+ to: 'max@mustermann.de',
+ cc: 'erika@mustermann.de',
+ bcc: ['john@doe.com', 'jane@doe.com'],
+ subject: 'Cordova Icons',
+ body: 'How are you? Nice greetings from Leipzig',
+ isHtml: true
+ };
+
+ $cordovaEmailComposer.open(email).then(null, () => {
+ // user cancelled email
+ this.status = "User Cancelled Email";
+ });
+
+ });
+ }
+
+ }
+
+ angular.module("demo.email").controller("EmailComposerController", EmailComposerController);
+}
diff --git a/ng-cordova/emailComposer.d.ts b/ng-cordova/emailComposer.d.ts
new file mode 100644
index 0000000000..5ef1fa6859
--- /dev/null
+++ b/ng-cordova/emailComposer.d.ts
@@ -0,0 +1,28 @@
+// Type definitions for ngCordova emailComposer plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface IEmailComposerOptions {
+ to: string | Array<string>;
+ cc?: string | Array<string>;
+ bcc?: string | Array<string>;
+ attachments?: Array<any>;
+ subject?: string;
+ body?: string;
+ isHtml?: boolean;
+ }
+
+ export interface IEmailComposerService {
+
+ isAvailable(): ng.IPromise<boolean>;
+ open(properties: IEmailComposerOptions) : ng.IPromise<any>;
+ addAlias(app: string, schema: string) : void;
+
+ }
+
+}
diff --git a/ng-cordova/geolocation-tests.ts b/ng-cordova/geolocation-tests.ts
new file mode 100644
index 0000000000..731280de7c
--- /dev/null
+++ b/ng-cordova/geolocation-tests.ts
@@ -0,0 +1,39 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.geolocation {
+ 'use strict';
+
+ export class GeolocationController {
+
+ erroMsg:string;
+ position:ngCordova.IGeoPosition;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaGeolocation"];
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService, private $cordovaGeolocation:ngCordova.IGeolocationService) {
+
+ }
+
+ getLocation = function () {
+
+ this.$cordovaGeolocation
+ .getCurrentPosition(<ngCordova.IGeolocationOptions>{timeout: 10000, enableHighAccuracy: false})
+ .then((position:ngCordova.IGeoPosition) => {
+ console.log("position found");
+ this.position = position;
+ // long = position.coords.longitude
+ // lat = position.coords.latitude
+ }, (err:ngCordova.IGeoPositionError) => {
+ console.log("unable to find location");
+ this.errorMsg = "Error : " + err.message;
+ });
+ };
+
+ }
+
+ angular.module("demo.geolocation").controller("GeolocationController", GeolocationController);
+}
diff --git a/ng-cordova/geolocation.d.ts b/ng-cordova/geolocation.d.ts
new file mode 100644
index 0000000000..15a0c55eed
--- /dev/null
+++ b/ng-cordova/geolocation.d.ts
@@ -0,0 +1,42 @@
+// Type definitions for ngCordova geolocation plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface IGeoPositionError {
+ code:number;
+ message:string;
+ }
+
+ export interface IGeoCoordinates {
+ latitude?:number;
+ longitude?:number;
+ accuracy?:number;
+ altitude?:number;
+ heading?:number;
+ speed?:number;
+ altitudeAccuracy?:number;
+ }
+
+ export interface IGeoPosition {
+ coords:IGeoCoordinates;
+ timestamp:Date;
+ }
+
+ export interface IGeolocationOptions {
+ timeout?: number;
+ maximumAge?: number;
+ enableHighAccuracy?: boolean;
+ }
+
+ export interface IGeolocationService {
+ getCurrentPosition(options?: IGeolocationOptions) : ng.IPromise<IGeoPosition>;
+ watchPosition(options?: IGeolocationOptions) : ng.IPromise<IGeoPosition>;
+ clearWatch(watchID: {[key: string]: any}) : void;
+ }
+
+}
diff --git a/ng-cordova/network-tests.ts b/ng-cordova/network-tests.ts
new file mode 100644
index 0000000000..35b270cbe5
--- /dev/null
+++ b/ng-cordova/network-tests.ts
@@ -0,0 +1,43 @@
+/// <reference path="tsd.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.network {
+ 'use strict';
+
+ export class NetworkController {
+
+ networkType:string;
+ connectionType:string;
+ errorMsg:string;
+
+ static $inject:Array<string> = ["$ionicPlatform", "$cordovaNetwork"];
+
+ constructor($ionicPlatform:ionic.platform.IonicPlatformService, private $cordovaNetwork:ngCordova.INetworkInformationService) {
+
+ $ionicPlatform.ready(() => {
+ this.refresh();
+ });
+ }
+
+ refresh() {
+ this.networkType = this.$cordovaNetwork.getNetwork();
+ if (this.$cordovaNetwork.isOnline()) {
+ this.connectionType = 'Online';
+ }
+ else if (this.$cordovaNetwork.isOffline()) {
+ this.connectionType = 'Offline';
+ }
+ else {
+ this.errorMsg = 'Error getting isOffline / isOnline methods';
+ }
+ }
+
+ }
+
+
+ angular.module("demo.network").controller("NetworkController", NetworkController);
+}
diff --git a/ng-cordova/network.d.ts b/ng-cordova/network.d.ts
new file mode 100644
index 0000000000..218871418a
--- /dev/null
+++ b/ng-cordova/network.d.ts
@@ -0,0 +1,19 @@
+// Type definitions for ngCordova network plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ export interface INetworkInformationService {
+
+ getNetwork(): string;
+ isOnline(): boolean;
+ isOffline(): boolean;
+ clearOfflineWatch(): void;
+ clearOnlineWatch(): void;
+ }
+
+}
diff --git a/ng-cordova/toast-tests.ts b/ng-cordova/toast-tests.ts
new file mode 100644
index 0000000000..43ed529e5d
--- /dev/null
+++ b/ng-cordova/toast-tests.ts
@@ -0,0 +1,51 @@
+/// <reference path="toast.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../ionic/ionic.d.ts" />
+
+// For the full application demo please see following repo :
+// https://github.com/ksachdeva/ngCordova-typescript-demo
+
+namespace demo.toast {
+ 'use strict';
+
+ export class ToastController {
+
+ toastMessage:string = 'enter a message';
+ msg:string;
+
+ static $inject:Array<string> = ["$cordovaToast"];
+ constructor(private $cordovaToast:ngCordova.IToastService) {
+
+ }
+
+ center() {
+ this.$cordovaToast.show(this.toastMessage, 'long', 'center')
+ .then((success) => {
+ console.log("center msg displayed");
+ }, (error) => {
+ this.msg = error.message;
+ });
+ }
+
+ top() {
+ this.$cordovaToast.showShortTop(this.toastMessage)
+ .then((success) => {
+ console.log("short top msg displayed");
+ }, (error) => {
+ this.msg = error.message;
+ });
+ }
+
+ bottom() {
+ this.$cordovaToast.showLongBottom(this.toastMessage)
+ .then((success) => {
+ console.log("long bottom msg displayed");
+ }, (error) => {
+ this.msg = error.message;
+ });
+ }
+
+ }
+
+ angular.module("demo.toast").controller("ToastController", ToastController);
+}
\ No newline at end of file
diff --git a/ng-cordova/toast.d.ts b/ng-cordova/toast.d.ts
new file mode 100644
index 0000000000..8e5c6ba0c1
--- /dev/null
+++ b/ng-cordova/toast.d.ts
@@ -0,0 +1,22 @@
+// Type definitions for ngCordova toast plugin
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module ngCordova {
+
+ interface IToastService {
+
+ showShortTop(message:string):angular.IPromise<any>;
+ showShortCenter(message:string):angular.IPromise<any>;
+ showShortBottom(message:string):angular.IPromise<any>;
+
+ showLongTop(message:string):angular.IPromise<any>;
+ showLongCenter(message:string):angular.IPromise<any>;
+ showLongBottom(message:string):angular.IPromise<any>;
+
+ show(message:string, duration:string, position:string):angular.IPromise<any>;
+ }
+}
\ No newline at end of file
diff --git a/ng-cordova/tsd.d.ts b/ng-cordova/tsd.d.ts
new file mode 100644
index 0000000000..188cb367d1
--- /dev/null
+++ b/ng-cordova/tsd.d.ts
@@ -0,0 +1,14 @@
+// Type definitions for ngCordova plugins
+// Project: https://github.com/driftyco/ng-cordova
+// Definitions by: Kapil Sachdeva <https://github.com/ksachdeva>
+// Definitions: https://github.com/ksachdeva/DefinitelyTyped
+
+/// <reference path="device.d.ts"/>
+/// <reference path="toast.d.ts"/>
+/// <reference path="network.d.ts"/>
+/// <reference path="emailComposer.d.ts"/>
+/// <reference path="dialogs.d.ts"/>
+/// <reference path="geolocation.d.ts"/>
+/// <reference path="deviceMotion.d.ts"/>
+/// <reference path="deviceOrientation.d.ts"/>
+/// <reference path="appAvailability.d.ts"/>
diff --git a/ng-file-upload/ng-file-upload-tests.ts b/ng-file-upload/ng-file-upload-tests.ts
index f55272295f..6ff4404025 100644
--- a/ng-file-upload/ng-file-upload-tests.ts
+++ b/ng-file-upload/ng-file-upload-tests.ts
@@ -40,7 +40,7 @@ module controllers {
.error((data: any, status: number, response: any, headers: any) => {
console.error(data, status, response, headers);
})
- .success((data: any, status: number, headers: any, config: angular.angularFileUpload.IFileUploadConfig) => {
+ .success((data: any, status: number, headers: any, config: angular.angularFileUpload.IFileUploadConfigFile) => {
// file is uploaded successfully
console.log("Success!", data, status, headers, config);
});
diff --git a/ng-file-upload/ng-file-upload.d.ts b/ng-file-upload/ng-file-upload.d.ts
index d38c432262..79b1a91f1f 100644
--- a/ng-file-upload/ng-file-upload.d.ts
+++ b/ng-file-upload/ng-file-upload.d.ts
@@ -10,7 +10,7 @@ declare module angular.angularFileUpload {
interface IUploadService {
http<T>(config: IRequestConfig): IUploadPromise<T>;
- upload<T>(config: IFileUploadConfig): IUploadPromise<T>;
+ upload<T>(config: IFileUploadConfigFiles|IFileUploadConfigFile): IUploadPromise<T>;
}
interface IUploadPromise<T> extends IHttpPromise<T> {
@@ -19,14 +19,25 @@ declare module angular.angularFileUpload {
xhr(callback: IHttpPromiseCallback<T>): IUploadPromise<T>;
}
- interface IFileUploadConfig extends IRequestConfig {
+ interface IFileUploadConfigFile extends IRequestConfig {
file: File;
fileName?: string;
}
+ interface IFileUploadConfigFiles extends IRequestConfig {
+
+ file: File[];
+ fileName?: string;
+ }
+
+ interface IFilesProgressEvent extends ProgressEvent {
+
+ config: IFileUploadConfigFiles;
+ }
+
interface IFileProgressEvent extends ProgressEvent {
- config: IFileUploadConfig;
+ config: IFileUploadConfigFile;
}
-}
\ No newline at end of file
+}
diff --git a/node-array-ext/node-array-ext-tests.ts b/node-array-ext/node-array-ext-tests.ts
new file mode 100644
index 0000000000..8981165cd3
--- /dev/null
+++ b/node-array-ext/node-array-ext-tests.ts
@@ -0,0 +1,23 @@
+/// <reference path="./node-array-ext.d.ts" />
+import extensions = require("node-array-ext");
+
+var array: Array<string> = [ "hello", "world", "test" ];
+var result: string = "";
+var finish = function(err?: Error) {
+ if(err) {
+ console.log(err);
+ }
+ else {
+ console.log(result);
+ }
+}
+function each(i: number, element: string, next: (err?: Error) => void): void {
+ setTimeout(function() {
+ console.log("%s => %s", i, element);
+ result += element + " ";
+ next();
+ }, 50 * (array.length - i));
+}
+
+extensions.asyncEach<string>(array, each, finish);
+extensions.awaitEach<string>(array, each, finish);
\ No newline at end of file
diff --git a/node-array-ext/node-array-ext.d.ts b/node-array-ext/node-array-ext.d.ts
new file mode 100644
index 0000000000..e8474d6a64
--- /dev/null
+++ b/node-array-ext/node-array-ext.d.ts
@@ -0,0 +1,17 @@
+// Type definitions for node-array-ext v1.0.00
+// Project: https://github.com/Beng89/node-array-ext
+// Definitions by: Ben Goltz <https://github.com/Beng89>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "node-array-ext" {
+ /**
+ * Processes each of the elements in the array and triggers a callback once every element has been processed.
+ * - note that the elements are called in order but are not guaranteed to finish in order.
+ */
+ export function asyncEach<T> (array: Array<T>, each: (i: number, element: T, done: (err?: Error) => void) => void, finish: (err?: Error) => void): void;
+ /**
+ * Processes each of the elements in the array and triggers a callback once every element has been processed.
+ * - note that the elements are called in order and are guaranteed to finish in order.
+ */
+ export function awaitEach<T> (array: Array<T>, each: (i: number, element: T, done: (err?: Error) => void) => void, finish: (err?: Error) => void): void;
+}
\ No newline at end of file
diff --git a/node-getopt/node-getopt-test.ts b/node-getopt/node-getopt-tests.ts
similarity index 100%
rename from node-getopt/node-getopt-test.ts
rename to node-getopt/node-getopt-tests.ts
diff --git a/node/node-0.10.d.ts b/node/node-0.10.d.ts
index 9a8eac40e8..a4cd5b1a6b 100644
--- a/node/node-0.10.d.ts
+++ b/node/node-0.10.d.ts
@@ -720,7 +720,7 @@ declare module "child_process" {
env?: any;
encoding?: string;
timeout?: number;
- maxBuffer?: string;
+ maxBuffer?: number;
killSignal?: string;
}, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess;
export function fork(modulePath: string, args?: string[], options?: {
@@ -732,21 +732,7 @@ declare module "child_process" {
declare module "url" {
export interface Url {
- href: string;
- protocol: string;
- auth: string;
- hostname: string;
- port: string;
- host: string;
- pathname: string;
- search: string;
- query: any; // string | Object
- slashes: boolean;
- hash?: string;
- path?: string;
- }
-
- export interface UrlOptions {
+ href?: string;
protocol?: string;
auth?: string;
hostname?: string;
@@ -754,13 +740,14 @@ declare module "url" {
host?: string;
pathname?: string;
search?: string;
- query?: any;
+ query?: any; // string | Object
+ slashes?: boolean;
hash?: string;
path?: string;
}
export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url;
- export function format(url: UrlOptions): string;
+ export function format(url: Url): string;
export function resolve(from: string, to: string): string;
}
@@ -833,10 +820,10 @@ declare module "net" {
}
export function createServer(connectionListener?: (socket: Socket) =>void ): Server;
export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) =>void ): Server;
- export function connect(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
+ export function connect(options: { port: number, host?: string, localAddress? : string, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
export function connect(port: number, host?: string, connectionListener?: Function): Socket;
export function connect(path: string, connectionListener?: Function): Socket;
- export function createConnection(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
+ export function createConnection(options: { port: number, host?: string, localAddress? : string, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
export function createConnection(port: number, host?: string, connectionListener?: Function): Socket;
export function createConnection(path: string, connectionListener?: Function): Socket;
export function isIP(input: string): number;
diff --git a/node/node-0.11.d.ts b/node/node-0.11.d.ts
index e4bfa91dcb..05aee911de 100644
--- a/node/node-0.11.d.ts
+++ b/node/node-0.11.d.ts
@@ -639,7 +639,7 @@ declare module "child_process" {
env?: any;
encoding?: string;
timeout?: number;
- maxBuffer?: string;
+ maxBuffer?: number;
killSignal?: string;
}, callback: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess;
export function fork(modulePath: string, args?: string[], options?: {
@@ -651,21 +651,7 @@ declare module "child_process" {
declare module "url" {
export interface Url {
- href: string;
- protocol: string;
- auth: string;
- hostname: string;
- port: string;
- host: string;
- pathname: string;
- search: string;
- query: any; // string | Object
- slashes: boolean;
- hash?: string;
- path?: string;
- }
-
- export interface UrlOptions {
+ href?: string;
protocol?: string;
auth?: string;
hostname?: string;
@@ -673,13 +659,14 @@ declare module "url" {
host?: string;
pathname?: string;
search?: string;
- query?: any;
+ query?: any; // string | Object
+ slashes?: boolean;
hash?: string;
path?: string;
}
export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url;
- export function format(url: UrlOptions): string;
+ export function format(url: Url): string;
export function resolve(from: string, to: string): string;
}
@@ -749,10 +736,10 @@ declare module "net" {
}
export function createServer(connectionListener?: (socket: Socket) =>void ): Server;
export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) =>void ): Server;
- export function connect(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
+ export function connect(options: { port: number, host?: string, localAddress? : string, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
export function connect(port: number, host?: string, connectionListener?: Function): Socket;
export function connect(path: string, connectionListener?: Function): Socket;
- export function createConnection(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
+ export function createConnection(options: { port: number, host?: string, localAddress? : string, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
export function createConnection(port: number, host?: string, connectionListener?: Function): Socket;
export function createConnection(path: string, connectionListener?: Function): Socket;
export function isIP(input: string): number;
diff --git a/node/node-0.8.8.d.ts b/node/node-0.8.8.d.ts
index 154025749e..1972e0cdcf 100644
--- a/node/node-0.8.8.d.ts
+++ b/node/node-0.8.8.d.ts
@@ -573,7 +573,7 @@ declare module "child_process" {
env?: any;
encoding?: string;
timeout?: number;
- maxBuffer?: string;
+ maxBuffer?: number;
killSignal?: string;
}, callback: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess;
export function fork(modulePath: string, args?: string[], options?: {
diff --git a/node/node-tests.ts b/node/node-tests.ts
index a73a35e223..bd80329dca 100644
--- a/node/node-tests.ts
+++ b/node/node-tests.ts
@@ -13,6 +13,7 @@ import * as dgram from "dgram";
import * as querystring from "querystring";
import * as path from "path";
import * as readline from "readline";
+import * as childProcess from "child_process";
assert(1 + 1 - 2 === 0, "The universe isn't how it should.");
@@ -34,7 +35,7 @@ assert.doesNotThrow(() => {
fs.writeFile("thebible.txt",
"Do unto others as you would have them do unto you.",
assert.ifError);
-
+
fs.write(1234, "test");
fs.writeFile("Harry Potter",
@@ -87,6 +88,25 @@ function bufferTests() {
console.log(Buffer.byteLength('xyz123', 'ascii'));
var result1 = Buffer.concat([utf8Buffer, base64Buffer]);
var result2 = Buffer.concat([utf8Buffer, base64Buffer], 9999999);
+
+ // Test that TS 1.6 works with the 'as Buffer' annotation
+ // on isBuffer.
+ var a: Buffer | number;
+ a = new Buffer(10);
+ if (Buffer.isBuffer(a)) {
+ a.writeUInt8(3, 4);
+ }
+
+ // write* methods return offsets.
+ var b = new Buffer(16);
+ var result: number = b.writeUInt32LE(0, 0);
+ result = b.writeUInt16LE(0, 4);
+ result = b.writeUInt8(0, 6);
+ result = b.writeInt8(0, 7);
+ result = b.writeDoubleLE(0, 8);
+
+ // fill returns the input buffer.
+ b.fill('a').fill('b');
}
@@ -382,3 +402,10 @@ rl.prompt(true);
rl.question("do you like typescript?", function(answer: string) {
rl.close();
});
+
+//////////////////////////////////////////////////////////////////////
+/// Child Process tests: https://nodejs.org/api/child_process.html ///
+//////////////////////////////////////////////////////////////////////
+
+childProcess.exec("echo test");
+childProcess.spawnSync("echo test");
diff --git a/node/node.d.ts b/node/node.d.ts
index e90a4a1461..11fd92d245 100644
--- a/node/node.d.ts
+++ b/node/node.d.ts
@@ -119,7 +119,7 @@ declare var Buffer: {
*
* @param obj object to test.
*/
- isBuffer(obj: any): boolean;
+ isBuffer(obj: any): obj is Buffer;
/**
* Returns true if {encoding} is a valid encoding argument.
* Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
@@ -334,6 +334,7 @@ declare module NodeJS {
undefined: typeof undefined;
unescape: (str: string) => string;
gc: () => void;
+ v8debug?: any;
}
export interface Timer {
@@ -377,21 +378,21 @@ interface NodeBuffer {
readFloatBE(offset: number, noAssert?: boolean): number;
readDoubleLE(offset: number, noAssert?: boolean): number;
readDoubleBE(offset: number, noAssert?: boolean): number;
- writeUInt8(value: number, offset: number, noAssert?: boolean): void;
- writeUInt16LE(value: number, offset: number, noAssert?: boolean): void;
- writeUInt16BE(value: number, offset: number, noAssert?: boolean): void;
- writeUInt32LE(value: number, offset: number, noAssert?: boolean): void;
- writeUInt32BE(value: number, offset: number, noAssert?: boolean): void;
- writeInt8(value: number, offset: number, noAssert?: boolean): void;
- writeInt16LE(value: number, offset: number, noAssert?: boolean): void;
- writeInt16BE(value: number, offset: number, noAssert?: boolean): void;
- writeInt32LE(value: number, offset: number, noAssert?: boolean): void;
- writeInt32BE(value: number, offset: number, noAssert?: boolean): void;
- writeFloatLE(value: number, offset: number, noAssert?: boolean): void;
- writeFloatBE(value: number, offset: number, noAssert?: boolean): void;
- writeDoubleLE(value: number, offset: number, noAssert?: boolean): void;
- writeDoubleBE(value: number, offset: number, noAssert?: boolean): void;
- fill(value: any, offset?: number, end?: number): void;
+ writeUInt8(value: number, offset: number, noAssert?: boolean): number;
+ writeUInt16LE(value: number, offset: number, noAssert?: boolean): number;
+ writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
+ writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
+ writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
+ writeInt8(value: number, offset: number, noAssert?: boolean): number;
+ writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
+ writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
+ writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
+ writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
+ writeFloatLE(value: number, offset: number, noAssert?: boolean): number;
+ writeFloatBE(value: number, offset: number, noAssert?: boolean): number;
+ writeDoubleLE(value: number, offset: number, noAssert?: boolean): number;
+ writeDoubleBE(value: number, offset: number, noAssert?: boolean): number;
+ fill(value: any, offset?: number, end?: number): Buffer;
}
/************************************************
@@ -860,7 +861,7 @@ declare module "child_process" {
env?: any;
encoding?: string;
timeout?: number;
- maxBuffer?: string;
+ maxBuffer?: number;
killSignal?: string;
}, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess;
export function fork(modulePath: string, args?: string[], options?: {
@@ -868,6 +869,26 @@ declare module "child_process" {
env?: any;
encoding?: string;
}): ChildProcess;
+ export function spawnSync(command: string, args?: string[], options?: {
+ cwd?: string;
+ input?: string | Buffer;
+ stdio?: any;
+ env?: any;
+ uid?: number;
+ gid?: number;
+ timeout?: number;
+ maxBuffer?: number;
+ killSignal?: string;
+ encoding?: string;
+ }): {
+ pid: number;
+ output: string[];
+ stdout: string | Buffer;
+ stderr: string | Buffer;
+ status: number;
+ signal: string;
+ error: Error;
+ };
export function execSync(command: string, options?: {
cwd?: string;
input?: string|Buffer;
@@ -879,7 +900,7 @@ declare module "child_process" {
maxBuffer?: number;
killSignal?: string;
encoding?: string;
- }): ChildProcess;
+ }): string | Buffer;
export function execFileSync(command: string, args?: string[], options?: {
cwd?: string;
input?: string|Buffer;
@@ -891,26 +912,12 @@ declare module "child_process" {
maxBuffer?: number;
killSignal?: string;
encoding?: string;
- }): ChildProcess;
+ }): string | Buffer;
}
declare module "url" {
export interface Url {
- href: string;
- protocol: string;
- auth: string;
- hostname: string;
- port: string;
- host: string;
- pathname: string;
- search: string;
- query: any; // string | Object
- slashes: boolean;
- hash?: string;
- path?: string;
- }
-
- export interface UrlOptions {
+ href?: string;
protocol?: string;
auth?: string;
hostname?: string;
@@ -918,13 +925,14 @@ declare module "url" {
host?: string;
pathname?: string;
search?: string;
- query?: any;
+ query?: any; // string | Object
+ slashes?: boolean;
hash?: string;
path?: string;
}
export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url;
- export function format(url: UrlOptions): string;
+ export function format(url: Url): string;
export function resolve(from: string, to: string): string;
}
@@ -1000,10 +1008,10 @@ declare module "net" {
}
export function createServer(connectionListener?: (socket: Socket) =>void ): Server;
export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) =>void ): Server;
- export function connect(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
+ export function connect(options: { port: number, host?: string, localAddress? : string, localPort? : string, family? : number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
export function connect(port: number, host?: string, connectionListener?: Function): Socket;
export function connect(path: string, connectionListener?: Function): Socket;
- export function createConnection(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
+ export function createConnection(options: { port: number, host?: string, localAddress? : string, localPort? : string, family? : number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
export function createConnection(port: number, host?: string, connectionListener?: Function): Socket;
export function createConnection(path: string, connectionListener?: Function): Socket;
export function isIP(input: string): number;
diff --git a/node_redis/node_redis-tests.ts b/node_redis/node_redis-tests.ts
deleted file mode 100644
index 4dcd432816..0000000000
--- a/node_redis/node_redis-tests.ts
+++ /dev/null
@@ -1,1850 +0,0 @@
-/// <reference path="node_redis.d.ts" />
-
-import redis = require('redis');
-
-function test1() {
- var client = redis.createClient();
-
- client.on("error", function (err) {
- console.log("Error " + err);
- });
-
- client.set("string key", "string val", redis.print);
- client.hset("hash key", "hashtest 1", "some value", redis.print);
- client.hset(["hash key", "hashtest 2", "some other value"], redis.print);
- client.hkeys("hash key", (err, replies) => {
- console.log(replies.length + " replies:");
- replies.forEach((reply, i) => {
- console.log(" " + i + ": " + reply);
- });
- client.quit();
- });
-
- client.mset(["test keys 1", "test val 1", "test keys 2", "test val 2"], function (err, res) { });
- client.mset("test keys 1", "test val 1", "test keys 2", "test val 2", function (err, res) { });
- client.set("some key", "some val");
- client.set(["some other key", "some val"]);
- client.get("missingkey", (err, reply) => { });
-}
-
-declare var Buffer;
-
-function test2() {
- var client = redis.createClient(null, null, {
- detect_buffers: true
- });
-
- client.set("foo_rand000000000000", "OK");
- client.get("foo_rand000000000000", (err, reply) => {
- console.log(reply.toString());
- });
-
- client.get(new Buffer("foo_rand000000000000"), (err, reply) => {
- console.log(reply.toString());
- });
- client.end();
-}
-
-function test3() {
- var client = redis.createClient();
-
- client.set("foo_rand000000000000", "some fantastic value");
- client.get("foo_rand000000000000", (err, reply) => {
- console.log(reply.toString());
- });
- client.end();
-
- client.hmset("hosts", "mjr", "1", "another", "23", "home", "1234");
- client.hgetall("hosts", function (err, obj) {
- console.dir(obj);
- });
-
- var key1, key2;
- client.HMSET(key2, {
- "0123456789": "abcdefghij", // NOTE: the key and value must both be strings
- "some manner of key": "a type of value"
- });
-
- client.HMSET(key1, "0123456789", "abcdefghij", "some manner of key", "a type of value");
-}
-
-function test4() {
- var client1 = redis.createClient(), client2 = redis.createClient(),
- msg_count = 0;
-
- client1.on("subscribe", function (channel, count) {
- client2.publish("a nice channel", "I am sending a message.");
- client2.publish("a nice channel", "I am sending a second message.");
- client2.publish("a nice channel", "I am sending my last message.");
- });
-
- client1.on("message", function (channel, message) {
- console.log("client1 channel " + channel + ": " + message);
- msg_count += 1;
- if (msg_count === 3) {
- client1.unsubscribe();
- client1.end();
- client2.end();
- }
- });
-
- client1.incr("did a thing");
- client1.subscribe("a nice channel");
-}
-
-function test5() {
- var client = redis.createClient(), set_size = 20;
-
- client.sadd("bigset", "a member");
- client.sadd("bigset", "another member");
-
- while (set_size > 0) {
- client.sadd("bigset", "member " + set_size);
- set_size -= 1;
- }
-
- client.multi()
- .scard("bigset")
- .smembers("bigset")
- .keys("*", function (err, replies) {
- client.mget(replies, redis.print);
- })
- .dbsize()
- .exec(function (err, replies) {
- console.log("MULTI got " + replies.length + " replies");
- replies.forEach(function (reply, index) {
- console.log("Reply " + index + ": " + reply.toString());
- });
- }
- );
-}
-
-function test6() {
- var client = redis.createClient(), multi;
-
- multi = client.multi();
- multi.incr("incr thing", redis.print);
- multi.incr("incr other thing", redis.print);
-
- client.mset("incr thing", 100, "incr other thing", 1, redis.print);
-
- multi.exec(function (err, replies) {
- console.log(replies);
- });
-
- multi.exec(function (err, replies) {
- console.log(replies);
- client.quit();
- });
-}
-
-function test7() {
- var client = redis.createClient(), multi;
-
- client.multi([
- ["mget", "multifoo", "multibar", <any>redis.print],
- ["incr", "multifoo"],
- ["incr", "multibar"]
- ]).exec(function (err, replies) {
- console.log(replies);
- });
-}
-
-function test8() {
- var client = redis.createClient();
-
- client.on("connect", function () {
- client.set("foo_rand000000000000", "some fantastic value", redis.print);
- client.get("foo_rand000000000000", redis.print);
- });
-}
-
-function test9() {
- var client = redis.createClient();
-
- redis.debug_mode = true;
-
- client.on("connect", function () {
- client.set("foo_rand000000000000", "some fantastic value");
- });
-
- var args: any[] = ['myzset', 1, 'one', 2, 'two', 3, 'three', 99, 'ninety-nine'];
- client.zadd(args, function (err, response) {
- if (err) throw err;
- console.log('added ' + response + ' items.');
-
- var args1 = ['myzset', '+inf', '-inf'];
- client.zrevrangebyscore(args1, function (err, response) {
- if (err) throw err;
- console.log('example1', response);
- });
-
- var max = 3, min = 1, offset = 1, count = 2;
- var args2 = ['myzset', <any>max, <any>min, 'WITHSCORES', 'LIMIT', <any>offset, <any>count];
- client.zrevrangebyscore(args2, function (err, response) {
- if (err) throw err;
- console.log('example2', response);
- });
- });
-}
-
-
-
-
-
-
-
-
-
-
-
-
-/*global require console setTimeout process Buffer */
-var
- client = redis.createClient(),
- client2 = redis.createClient(),
- client3 = redis.createClient(),
- assert,
- crypto,
- util,
- test_db_num = 15, // this DB will be flushed and used for testing
- connected = false,
- ended = false,
- next, cur_start, run_next_test, all_tests, all_start, test_count;
-
-
-function buffers_to_strings(arr) {
- return arr.map(function (val) {
- return val.toString();
- });
-}
-
-function require_number(expected, label) {
- return function (err, results) {
- assert.strictEqual(null, err, label + " expected " + expected + ", got error: " + err);
- assert.strictEqual(expected, results, label + " " + expected + " !== " + results);
- assert.strictEqual(typeof results, "number", label);
- return true;
- };
-}
-
-function require_number_any(label) {
- return function (err, results) {
- assert.strictEqual(null, err, label + " expected any number, got error: " + err);
- assert.strictEqual(typeof results, "number", label + " " + results + " is not a number");
- return true;
- };
-}
-
-function require_number_pos(label) {
- return function (err, results) {
- assert.strictEqual(null, err, label + " expected positive number, got error: " + err);
- assert.strictEqual(true, (results > 0), label + " " + results + " is not a positive number");
- return true;
- };
-}
-
-function require_string(str, label) {
- return function (err, results) {
- assert.strictEqual(null, err, label + " expected string '" + str + "', got error: " + err);
- assert.equal(str, results, label + " " + str + " does not match " + results);
- return true;
- };
-}
-
-function require_null(label) {
- return function (err, results) {
- assert.strictEqual(null, err, label + " expected null, got error: " + err);
- assert.strictEqual(null, results, label + ": " + results + " is not null");
- return true;
- };
-}
-
-function require_error(label) {
- return function (err, results) {
- assert.notEqual(err, null, label + " err is null, but an error is expected here.");
- return true;
- };
-}
-
-function is_empty_array(obj) {
- return Array.isArray(obj) && obj.length === 0;
-}
-
-function last(name, fn) {
- return function (err, results) {
- fn(err, results);
- next(name);
- };
-}
-
-next = function next(name) {
- console.log(" \x1b[33m" + (Date.now() - cur_start) + "\x1b[0m ms");
- run_next_test();
-};
-
-declare var tests: any;
-
-tests.FLUSHDB = function () {
- var name = "FLUSHDB";
- client.select(test_db_num, require_string("OK", name));
- client2.select(test_db_num, require_string("OK", name));
- client3.select(test_db_num, require_string("OK", name));
- client.mset("flush keys 1", "flush val 1", "flush keys 2", "flush val 2", require_string("OK", name));
- client.FLUSHDB(require_string("OK", name));
- client.dbsize(last(name, require_number(0, name)));
-};
-
-tests.MULTI_1 = function () {
- var name = "MULTI_1", multi1, multi2;
-
- // Provoke an error at queue time
- multi1 = client.multi();
- multi1.mset("multifoo", "10", "multibar", "20", require_string("OK", name));
- multi1.set("foo2", require_error(name));
- multi1.incr("multifoo", require_number(11, name));
- multi1.incr("multibar", require_number(21, name));
- multi1.exec();
-
- // Confirm that the previous command, while containing an error, still worked.
- multi2 = client.multi();
- multi2.incr("multibar", require_number(22, name));
- multi2.incr("multifoo", require_number(12, name));
- multi2.exec(function (err, replies) {
- assert.strictEqual(22, replies[0]);
- assert.strictEqual(12, replies[1]);
- next(name);
- });
-};
-
-tests.MULTI_2 = function () {
- var name = "MULTI_2";
-
- // test nested multi-bulk replies
- client.multi([
- ["mget", "multifoo", "multibar", <any>function (err, res) {
- assert.strictEqual(2, res.length, name);
- assert.strictEqual("12", res[0].toString(), name);
- assert.strictEqual("22", res[1].toString(), name);
- }],
- ["set", "foo2", <any>require_error(name)],
- ["incr", "multifoo", <any>require_number(13, name)],
- ["incr", "multibar", <any>require_number(23, name)]
- ]).exec(function (err, replies) {
- assert.strictEqual(2, replies[0].length, name);
- assert.strictEqual("12", replies[0][0].toString(), name);
- assert.strictEqual("22", replies[0][1].toString(), name);
-
- assert.strictEqual("13", replies[1].toString());
- assert.strictEqual("23", replies[2].toString());
- next(name);
- });
-};
-
-tests.MULTI_3 = function () {
- var name = "MULTI_3";
-
- client.sadd("some set", "mem 1");
- client.sadd("some set", "mem 2");
- client.sadd("some set", "mem 3");
- client.sadd("some set", "mem 4");
-
- // make sure empty mb reply works
- client.del("some missing set");
- client.smembers("some missing set", function (err, reply) {
- // make sure empty mb reply works
- assert.strictEqual(true, is_empty_array(reply), name);
- });
-
- // test nested multi-bulk replies with empty mb elements.
- client.multi([
- ["smembers", "some set"],
- ["del", "some set"],
- ["smembers", "some set"]
- ])
- .scard("some set")
- .exec(function (err, replies) {
- assert.strictEqual(true, is_empty_array(replies[2]), name);
- next(name);
- });
-};
-
-tests.MULTI_4 = function () {
- var name = "MULTI_4";
-
- client.multi()
- .mset('some', '10', 'keys', '20')
- .incr('some')
- .incr('keys')
- .mget('some', 'keys')
- .exec(function (err, replies) {
- assert.strictEqual(null, err);
- assert.equal('OK', replies[0]);
- assert.equal(11, replies[1]);
- assert.equal(21, replies[2]);
- assert.equal(11, replies[3][0].toString());
- assert.equal(21, replies[3][1].toString());
- next(name);
- });
-};
-
-tests.MULTI_5 = function () {
- var name = "MULTI_5";
-
- // test nested multi-bulk replies with nulls.
- client.multi([
- ["mget", <any>["multifoo", "some", "random value", "keys"]],
- ["incr", "multifoo"]
- ])
- .exec(function (err, replies) {
- assert.strictEqual(replies.length, 2, name);
- assert.strictEqual(replies[0].length, 4, name);
- next(name);
- });
-};
-
-tests.MULTI_6 = function () {
- var name = "MULTI_6";
-
- client.multi()
- .hmset("multihash", "a", "foo", "b", 1)
- .hmset("multihash", {
- extra: "fancy",
- things: "here"
- })
- .hgetall("multihash")
- .exec(function (err, replies) {
- assert.strictEqual(null, err);
- assert.equal("OK", replies[0]);
- assert.equal(Object.keys(replies[2]).length, 4);
- assert.equal("foo", replies[2].a);
- assert.equal("1", replies[2].b);
- assert.equal("fancy", replies[2].extra);
- assert.equal("here", replies[2].things);
- next(name);
- });
-};
-
-tests.EVAL_1 = function () {
- var name = "EVAL_1";
-
- if (client.server_info.versions[0] >= 2 && client.server_info.versions[1] >= 5) {
- // test {EVAL - Lua integer -> Redis protocol type conversion}
- client.eval("return 100.5", 0, require_number(100, name));
- // test {EVAL - Lua string -> Redis protocol type conversion}
- client.eval("return 'hello world'", 0, require_string("hello world", name));
- // test {EVAL - Lua true boolean -> Redis protocol type conversion}
- client.eval("return true", 0, require_number(1, name));
- // test {EVAL - Lua false boolean -> Redis protocol type conversion}
- client.eval("return false", 0, require_null(name));
- // test {EVAL - Lua status code reply -> Redis protocol type conversion}
- client.eval("return {ok='fine'}", 0, require_string("fine", name));
- // test {EVAL - Lua error reply -> Redis protocol type conversion}
- client.eval("return {err='this is an error'}", 0, require_error(name));
- // test {EVAL - Lua table -> Redis protocol type conversion}
- client.eval("return {1,2,3,'ciao',{1,2}}", 0, function (err, res) {
- assert.strictEqual(5, res.length, name);
- assert.strictEqual(1, res[0], name);
- assert.strictEqual(2, res[1], name);
- assert.strictEqual(3, res[2], name);
- assert.strictEqual("ciao", res[3], name);
- assert.strictEqual(2, res[4].length, name);
- assert.strictEqual(1, res[4][0], name);
- assert.strictEqual(2, res[4][1], name);
- });
- // test {EVAL - Are the KEYS and ARGS arrays populated correctly?}
- client.eval("return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}", 2, "a", "b", "c", "d", function (err, res) {
- assert.strictEqual(4, res.length, name);
- assert.strictEqual("a", res[0], name);
- assert.strictEqual("b", res[1], name);
- assert.strictEqual("c", res[2], name);
- assert.strictEqual("d", res[3], name);
- });
-
- // prepare sha sum for evalsha cache test
- var source = "return redis.call('get', 'sha test')",
- sha = crypto.createHash('sha1').update(source).digest('hex');
-
- client.set("sha test", "eval get sha test", function (err, res) {
- if (err) throw err;
- // test {EVAL - is Lua able to call Redis API?}
- client.eval(source, 0, function (err, res) {
- require_string("eval get sha test", name)(err, res);
- // test {EVALSHA - Can we call a SHA1 if already defined?}
- client.evalsha(sha, 0, require_string("eval get sha test", name));
- // test {EVALSHA - Do we get an error on non defined SHA1?}
- client.evalsha("ffffffffffffffffffffffffffffffffffffffff", 0, require_error(name));
- });
- });
-
- // test {EVAL - Redis integer -> Lua type conversion}
- client.set("incr key", 0, function (err, reply) {
- if (err) throw err;
- client.eval("local foo = redis.call('incr','incr key')\n" + "return {type(foo),foo}", 0, function (err, res) {
- if (err) throw err;
- assert.strictEqual(2, res.length, name);
- assert.strictEqual("number", res[0], name);
- assert.strictEqual(1, res[1], name);
- });
- });
-
- client.set("bulk reply key", "bulk reply value", function (err, res) {
- // test {EVAL - Redis bulk -> Lua type conversion}
- client.eval("local foo = redis.call('get','bulk reply key'); return {type(foo),foo}", 0, function (err, res) {
- if (err) throw err;
- assert.strictEqual(2, res.length, name);
- assert.strictEqual("string", res[0], name);
- assert.strictEqual("bulk reply value", res[1], name);
- });
- });
-
- // test {EVAL - Redis multi bulk -> Lua type conversion}
- client.multi()
- .del("mylist")
- .rpush("mylist", "a")
- .rpush("mylist", "b")
- .rpush("mylist", "c")
- .exec(function (err, replies) {
- if (err) throw err;
- client.eval("local foo = redis.call('lrange','mylist',0,-1); return {type(foo),foo[1],foo[2],foo[3],# foo}", 0, function (err, res) {
- assert.strictEqual(5, res.length, name);
- assert.strictEqual("table", res[0], name);
- assert.strictEqual("a", res[1], name);
- assert.strictEqual("b", res[2], name);
- assert.strictEqual("c", res[3], name);
- assert.strictEqual(3, res[4], name);
- });
- });
- // test {EVAL - Redis status reply -> Lua type conversion}
- client.eval("local foo = redis.call('set','mykey','myval'); return {type(foo),foo['ok']}", 0, function (err, res) {
- if (err) throw err;
- assert.strictEqual(2, res.length, name);
- assert.strictEqual("table", res[0], name);
- assert.strictEqual("OK", res[1], name);
- });
- // test {EVAL - Redis error reply -> Lua type conversion}
- client.set("error reply key", "error reply value", function (err, res) {
- if (err) throw err;
- client.eval("local foo = redis.pcall('incr','error reply key'); return {type(foo),foo['err']}", 0, function (err, res) {
- if (err) throw err;
- assert.strictEqual(2, res.length, name);
- assert.strictEqual("table", res[0], name);
- assert.strictEqual("ERR value is not an integer or out of range", res[1], name);
- });
- });
- // test {EVAL - Redis nil bulk reply -> Lua type conversion}
- client.del("nil reply key", function (err, res) {
- if (err) throw err;
- client.eval("local foo = redis.call('get','nil reply key'); return {type(foo),foo == false}", 0, function (err, res) {
- if (err) throw err;
- assert.strictEqual(2, res.length, name);
- assert.strictEqual("boolean", res[0], name);
- assert.strictEqual(1, res[1], name);
- next(name);
- });
- });
- } else {
- console.log("Skipping " + name + " because server version isn't new enough.");
- next(name);
- }
-};
-
-tests.WATCH_MULTI = function () {
- var name = 'WATCH_MULTI', multi;
-
- if (client.server_info.versions[0] >= 2 && client.server_info.versions[1] >= 1) {
- client.watch(name);
- client.incr(name);
- multi = client.multi();
- multi.incr(name);
- multi.exec(last(name, require_null(name)));
- } else {
- console.log("Skipping " + name + " because server version isn't new enough.");
- next(name);
- }
-};
-
-tests.detect_buffers = function () {
- var name = "detect_buffers", detect_client = redis.createClient(null, null, {detect_buffers: true});
-
- detect_client.on("ready", function () {
- // single Buffer or String
- detect_client.set("string key 1", "string value");
- detect_client.get("string key 1", require_string("string value", name));
- detect_client.get(new Buffer("string key 1"), function (err, reply) {
- assert.strictEqual(null, err, name);
- assert.strictEqual(true, Buffer.isBuffer(reply), name);
- assert.strictEqual("<Buffer 73 74 72 69 6e 67 20 76 61 6c 75 65>", reply.inspect(), name);
- });
-
- detect_client.hmset("hash key 2", "key 1", "val 1", "key 2", "val 2");
- // array of Buffers or Strings
- detect_client.hmget("hash key 2", "key 1", "key 2", function (err, reply) {
- assert.strictEqual(null, err, name);
- assert.strictEqual(true, Array.isArray(reply), name);
- assert.strictEqual(2, reply.length, name);
- assert.strictEqual("val 1", reply[0], name);
- assert.strictEqual("val 2", reply[1], name);
- });
- detect_client.hmget(new Buffer("hash key 2"), "key 1", "key 2", function (err, reply) {
- assert.strictEqual(null, err, name);
- assert.strictEqual(true, Array.isArray(reply));
- assert.strictEqual(2, reply.length, name);
- assert.strictEqual(true, Buffer.isBuffer(reply[0]));
- assert.strictEqual(true, Buffer.isBuffer(reply[1]));
- assert.strictEqual("<Buffer 76 61 6c 20 31>", reply[0].inspect(), name);
- assert.strictEqual("<Buffer 76 61 6c 20 32>", reply[1].inspect(), name);
- });
-
- // Object of Buffers or Strings
- detect_client.hgetall("hash key 2", function (err, reply) {
- assert.strictEqual(null, err, name);
- assert.strictEqual("object", typeof reply, name);
- assert.strictEqual(2, Object.keys(reply).length, name);
- assert.strictEqual("val 1", reply["key 1"], name);
- assert.strictEqual("val 2", reply["key 2"], name);
- });
- detect_client.hgetall(new Buffer("hash key 2"), function (err, reply) {
- assert.strictEqual(null, err, name);
- assert.strictEqual("object", typeof reply, name);
- assert.strictEqual(2, Object.keys(reply).length, name);
- assert.strictEqual(true, Buffer.isBuffer(reply["key 1"]));
- assert.strictEqual(true, Buffer.isBuffer(reply["key 2"]));
- assert.strictEqual("<Buffer 76 61 6c 20 31>", reply["key 1"].inspect(), name);
- assert.strictEqual("<Buffer 76 61 6c 20 32>", reply["key 2"].inspect(), name);
- });
-
- detect_client.quit(function (err, res) {
- next(name);
- });
- });
-};
-
-tests.socket_nodelay = function () {
- var name = "socket_nodelay", c1, c2, c3, ready_count = 0, quit_count = 0;
-
- c1 = redis.createClient(null, null, {socket_nodelay: true});
- c2 = redis.createClient(null, null, {socket_nodelay: false});
- c3 = redis.createClient(null, null);
-
- function quit_check() {
- quit_count++;
-
- if (quit_count === 3) {
- next(name);
- }
- }
-
- function run() {
- assert.strictEqual(true, c1.options.socket_nodelay, name);
- assert.strictEqual(false, c2.options.socket_nodelay, name);
- assert.strictEqual(true, c3.options.socket_nodelay, name);
-
- c1.set(["set key 1", "set val"], require_string("OK", name));
- c1.set(["set key 2", "set val"], require_string("OK", name));
- c1.get(["set key 1"], require_string("set val", name));
- c1.get(["set key 2"], require_string("set val", name));
-
- c2.set(["set key 3", "set val"], require_string("OK", name));
- c2.set(["set key 4", "set val"], require_string("OK", name));
- c2.get(["set key 3"], require_string("set val", name));
- c2.get(["set key 4"], require_string("set val", name));
-
- c3.set(["set key 5", "set val"], require_string("OK", name));
- c3.set(["set key 6", "set val"], require_string("OK", name));
- c3.get(["set key 5"], require_string("set val", name));
- c3.get(["set key 6"], require_string("set val", name));
-
- c1.quit(quit_check);
- c2.quit(quit_check);
- c3.quit(quit_check);
- }
-
- function ready_check() {
- ready_count++;
- if (ready_count === 3) {
- run();
- }
- }
-
- c1.on("ready", ready_check);
- c2.on("ready", ready_check);
- c3.on("ready", ready_check);
-};
-
-tests.reconnect = function () {
- var name = "reconnect";
-
- client.set("recon 1", "one");
- client.set("recon 2", "two", function (err, res) {
- // Do not do this in normal programs. This is to simulate the server closing on us.
- // For orderly shutdown in normal programs, do client.quit()
- client.stream.destroy();
- });
-
- client.on("reconnecting", function on_recon(params) {
- client.on("connect", function on_connect() {
- client.select(test_db_num, require_string("OK", name));
- client.get("recon 1", require_string("one", name));
- client.get("recon 1", require_string("one", name));
- client.get("recon 2", require_string("two", name));
- client.get("recon 2", require_string("two", name));
- client.removeListener("connect", on_connect);
- client.removeListener("reconnecting", on_recon);
- next(name);
- });
- });
-};
-
-tests.idle = function () {
- var name = "idle";
-
- client.on("idle", function on_idle() {
- client.removeListener("idle", on_idle);
- next(name);
- });
-
- client.set("idle", "test");
-};
-
-tests.HSET = function () {
- var key = "test hash",
- field1 = new Buffer("0123456789"),
- value1 = new Buffer("abcdefghij"),
- field2 = new Buffer(0),
- value2 = new Buffer(0),
- name = "HSET";
-
- client.HSET(key, field1, value1, require_number(1, name));
- client.HGET(key, field1, require_string(value1.toString(), name));
-
- // Empty value
- client.HSET(key, field1, value2, require_number(0, name));
- client.HGET([key, field1], require_string("", name));
-
- // Empty key, empty value
- client.HSET([key, field2, value1], require_number(1, name));
- client.HSET(key, field2, value2, last(name, require_number(0, name)));
-};
-
-tests.HLEN = function () {
- var key = "test hash",
- field1 = new Buffer("0123456789"),
- value1 = new Buffer("abcdefghij"),
- field2 = new Buffer(0),
- value2 = new Buffer(0),
- name = "HSET",
- timeout = 1000;
-
- client.HSET(key, field1, value1, function (err, results) {
- client.HLEN(key, function (err, len) {
- assert.ok(2 === +len);
- next(name);
- });
- });
-}
-
-tests.HMSET_BUFFER_AND_ARRAY = function () {
- // Saving a buffer and an array to the same key should not error
- var key = "test hash",
- field1 = "buffer",
- value1 = new Buffer("abcdefghij"),
- field2 = "array",
- value2 = ["array contents"],
- name = "HSET";
-
- client.HMSET(key, field1, value1, field2, value2, last(name, require_string("OK", name)));
-};
-
-// TODO - add test for HMSET with optional callbacks
-
-tests.HMGET = function () {
- var key1 = "test hash 1", key2 = "test hash 2", name = "HMGET";
-
- // redis-like hmset syntax
- client.HMSET(key1, "0123456789", "abcdefghij", "some manner of key", "a type of value", require_string("OK", name));
-
- // fancy hmset syntax
- client.HMSET(key2, {
- "0123456789": "abcdefghij",
- "some manner of key": "a type of value"
- }, require_string("OK", name));
-
- client.HMGET(key1, "0123456789", "some manner of key", function (err, reply) {
- assert.strictEqual("abcdefghij", reply[0].toString(), name);
- assert.strictEqual("a type of value", reply[1].toString(), name);
- });
-
- client.HMGET(key2, "0123456789", "some manner of key", function (err, reply) {
- assert.strictEqual("abcdefghij", reply[0].toString(), name);
- assert.strictEqual("a type of value", reply[1].toString(), name);
- });
-
- client.HMGET(key1, ["0123456789"], function (err, reply) {
- assert.strictEqual("abcdefghij", reply[0], name);
- });
-
- client.HMGET(key1, ["0123456789", "some manner of key"], function (err, reply) {
- assert.strictEqual("abcdefghij", reply[0], name);
- assert.strictEqual("a type of value", reply[1], name);
- });
-
- client.HMGET(key1, "missing thing", "another missing thing", function (err, reply) {
- assert.strictEqual(null, reply[0], name);
- assert.strictEqual(null, reply[1], name);
- next(name);
- });
-};
-
-tests.HINCRBY = function () {
- var name = "HINCRBY";
- client.hset("hash incr", "value", 10, require_number(1, name));
- client.HINCRBY("hash incr", "value", 1, require_number(11, name));
- client.HINCRBY("hash incr", "value 2", 1, last(name, require_number(1, name)));
-};
-
-tests.SUBSCRIBE = function () {
- var client1 = client, msg_count = 0, name = "SUBSCRIBE";
-
- client1.on("subscribe", function (channel, count) {
- if (channel === "chan1") {
- client2.publish("chan1", "message 1", require_number(1, name));
- client2.publish("chan2", "message 2", require_number(1, name));
- client2.publish("chan1", "message 3", require_number(1, name));
- }
- });
-
- client1.on("unsubscribe", function (channel, count) {
- if (count === 0) {
- // make sure this connection can go into and out of pub/sub mode
- client1.incr("did a thing", last(name, require_number(2, name)));
- }
- });
-
- client1.on("message", function (channel, message) {
- msg_count += 1;
- assert.strictEqual("message " + msg_count, message.toString());
- if (msg_count === 3) {
- client1.unsubscribe("chan1", "chan2");
- }
- });
-
- client1.set("did a thing", 1, require_string("OK", name));
- client1.subscribe("chan1", "chan2", function (err, results) {
- assert.strictEqual(null, err, "result sent back unexpected error: " + err);
- assert.strictEqual("chan1", results.toString(), name);
- });
-};
-
-tests.SUB_UNSUB_SUB = function () {
- var name = "SUB_UNSUB_SUB";
- client3.subscribe('chan3');
- client3.unsubscribe('chan3');
- client3.subscribe('chan3', function (err, results) {
- assert.strictEqual(null, err, "unexpected error: " + err);
- client2.publish('chan3', 'foo');
- });
- client3.on('message', function (channel, message) {
- assert.strictEqual(channel, 'chan3');
- assert.strictEqual(message, 'foo');
- next(name);
- });
-};
-
-tests.SUBSCRIBE_QUIT = function () {
- var name = "SUBSCRIBE_QUIT";
- client3.on("end", function () {
- next(name);
- });
- client3.on("subscribe", function (channel, count) {
- client3.quit();
- });
- client3.subscribe("chan3");
-};
-
-tests.SUBSCRIBE_CLOSE_RESUBSCRIBE = function () {
- var name = "SUBSCRIBE_CLOSE_RESUBSCRIBE";
- var c1 = redis.createClient();
- var c2 = redis.createClient();
- var count = 0;
-
- /* Create two clients. c1 subscribes to two channels, c2 will publish to them.
- c2 publishes the first message.
- c1 gets the message and drops its connection. It must resubscribe itself.
- When it resubscribes, c2 publishes the second message, on the same channel
- c1 gets the message and drops its connection. It must resubscribe itself, again.
- When it resubscribes, c2 publishes the third message, on the second channel
- c1 gets the message and drops its connection. When it reconnects, the test ends.
- */
-
- c1.on("message", function(channel, message) {
- if (channel === "chan1") {
- assert.strictEqual(message, "hi on channel 1");
- c1.stream.end();
-
- } else if (channel === "chan2") {
- assert.strictEqual(message, "hi on channel 2");
- c1.stream.end();
-
- } else {
- c1.quit();
- c2.quit();
- assert.fail("test failed");
- }
- })
-
- c1.subscribe("chan1", "chan2");
-
- c2.once("ready", function() {
- console.log("c2 is ready");
- c1.on("ready", function(err, results) {
- console.log("c1 is ready", count);
-
- count++;
- if (count == 1) {
- c2.publish("chan1", "hi on channel 1");
- return;
-
- } else if (count == 2) {
- c2.publish("chan2", "hi on channel 2");
-
- } else {
- c1.quit(function() {
- c2.quit(function() {
- next(name);
- });
- });
- }
- });
-
- c2.publish("chan1", "hi on channel 1");
-
- });
-};
-
-tests.EXISTS = function () {
- var name = "EXISTS";
- client.del("foo", "foo2", require_number_any(name));
- client.set("foo", "bar", require_string("OK", name));
- client.EXISTS("foo", require_number(1, name));
- client.EXISTS("foo2", last(name, require_number(0, name)));
-};
-
-tests.DEL = function () {
- var name = "DEL";
- client.DEL("delkey", require_number_any(name));
- client.set("delkey", "delvalue", require_string("OK", name));
- client.DEL("delkey", require_number(1, name));
- client.exists("delkey", require_number(0, name));
- client.DEL("delkey", require_number(0, name));
- client.mset("delkey", "delvalue", "delkey2", "delvalue2", require_string("OK", name));
- client.DEL("delkey", "delkey2", last(name, require_number(2, name)));
-};
-
-tests.TYPE = function () {
- var name = "TYPE";
- client.set(["string key", "should be a string"], require_string("OK", name));
- client.rpush(["list key", "should be a list"], require_number_pos(name));
- client.sadd(["set key", "should be a set"], require_number_any(name));
- client.zadd(["zset key", "10.0", "should be a zset"], require_number_any(name));
- client.hset(["hash key", "hashtest", "should be a hash"], require_number_any(name));
-
- client.TYPE(["string key"], require_string("string", name));
- client.TYPE(["list key"], require_string("list", name));
- client.TYPE(["set key"], require_string("set", name));
- client.TYPE(["zset key"], require_string("zset", name));
- client.TYPE("not here yet", require_string("none", name));
- client.TYPE(["hash key"], last(name, require_string("hash", name)));
-};
-
-tests.KEYS = function () {
- var name = "KEYS";
- client.mset(["test keys 1", "test val 1", "test keys 2", "test val 2"], require_string("OK", name));
- client.KEYS(["test keys*"], function (err, results) {
- assert.strictEqual(null, err, "result sent back unexpected error: " + err);
- assert.strictEqual(2, results.length, name);
- assert.strictEqual("test keys 1", results[0].toString(), name);
- assert.strictEqual("test keys 2", results[1].toString(), name);
- next(name);
- });
-};
-
-tests.MULTIBULK = function() {
- var name = "MULTIBULK",
- keys_values = [];
-
- for (var i = 0; i < 200; i++) {
- var key_value = [
- "multibulk:" + crypto.randomBytes(256).toString("hex"), // use long strings as keys to ensure generation of large packet
- "test val " + i
- ];
- keys_values.push(key_value);
- }
-
- client.mset(keys_values.reduce(function(a, b) {
- return a.concat(b);
- }), require_string("OK", name));
-
- client.KEYS("multibulk:*", function(err, results) {
- assert.strictEqual(null, err, "result sent back unexpected error: " + err);
- assert.deepEqual(keys_values.map(function(val) {
- return val[0];
- }).sort(), results.sort(), name);
- });
-
- next(name);
-};
-
-tests.MULTIBULK_ZERO_LENGTH = function () {
- var name = "MULTIBULK_ZERO_LENGTH";
- client.KEYS(['users:*'], function (err, results) {
- assert.strictEqual(null, err, 'error on empty multibulk reply');
- assert.strictEqual(true, is_empty_array(results), "not an empty array");
- next(name);
- });
-};
-
-tests.RANDOMKEY = function () {
- var name = "RANDOMKEY";
- client.mset(["test keys 1", "test val 1", "test keys 2", "test val 2"], require_string("OK", name));
- client.RANDOMKEY([], function (err, results) {
- assert.strictEqual(null, err, name + " result sent back unexpected error: " + err);
- assert.strictEqual(true, /\w+/.test(results), name);
- next(name);
- });
-};
-
-tests.RENAME = function () {
- var name = "RENAME";
- client.set(['foo', 'bar'], require_string("OK", name));
- client.RENAME(["foo", "new foo"], require_string("OK", name));
- client.exists(["foo"], require_number(0, name));
- client.exists(["new foo"], last(name, require_number(1, name)));
-};
-
-tests.RENAMENX = function () {
- var name = "RENAMENX";
- client.set(['foo', 'bar'], require_string("OK", name));
- client.set(['foo2', 'bar2'], require_string("OK", name));
- client.RENAMENX(["foo", "foo2"], require_number(0, name));
- client.exists(["foo"], require_number(1, name));
- client.exists(["foo2"], require_number(1, name));
- client.del(["foo2"], require_number(1, name));
- client.RENAMENX(["foo", "foo2"], require_number(1, name));
- client.exists(["foo"], require_number(0, name));
- client.exists(["foo2"], last(name, require_number(1, name)));
-};
-
-tests.DBSIZE = function () {
- var name = "DBSIZE";
- client.set(['foo', 'bar'], require_string("OK", name));
- client.DBSIZE([], last(name, require_number_pos("DBSIZE")));
-};
-
-tests.GET_1 = function () {
- var name = "GET_1";
- client.set(["get key", "get val"], require_string("OK", name));
- client.GET(["get key"], last(name, require_string("get val", name)));
-};
-
-tests.GET_2 = function() {
- var name = "GET_2";
-
- // tests handling of non-existent keys
- client.GET('this_key_shouldnt_exist', last(name, require_null(name)));
-};
-
-tests.SET = function () {
- var name = "SET";
- client.SET(["set key", "set val"], require_string("OK", name));
- client.get(["set key"], last(name, require_string("set val", name)));
-};
-
-tests.GETSET = function () {
- var name = "GETSET";
- client.set(["getset key", "getset val"], require_string("OK", name));
- client.GETSET(["getset key", "new getset val"], require_string("getset val", name));
- client.get(["getset key"], last(name, require_string("new getset val", name)));
-};
-
-tests.MGET = function () {
- var name = "MGET";
- client.mset(["mget keys 1", "mget val 1", "mget keys 2", "mget val 2", "mget keys 3", "mget val 3"], require_string("OK", name));
- client.MGET("mget keys 1", "mget keys 2", "mget keys 3", function (err, results) {
- assert.strictEqual(null, err, "result sent back unexpected error: " + err);
- assert.strictEqual(3, results.length, name);
- assert.strictEqual("mget val 1", results[0].toString(), name);
- assert.strictEqual("mget val 2", results[1].toString(), name);
- assert.strictEqual("mget val 3", results[2].toString(), name);
- });
- client.MGET(["mget keys 1", "mget keys 2", "mget keys 3"], function (err, results) {
- assert.strictEqual(null, err, "result sent back unexpected error: " + err);
- assert.strictEqual(3, results.length, name);
- assert.strictEqual("mget val 1", results[0].toString(), name);
- assert.strictEqual("mget val 2", results[1].toString(), name);
- assert.strictEqual("mget val 3", results[2].toString(), name);
- });
- client.MGET(["mget keys 1", "some random shit", "mget keys 2", "mget keys 3"], function (err, results) {
- assert.strictEqual(null, err, "result sent back unexpected error: " + err);
- assert.strictEqual(4, results.length, name);
- assert.strictEqual("mget val 1", results[0].toString(), name);
- assert.strictEqual(null, results[1], name);
- assert.strictEqual("mget val 2", results[2].toString(), name);
- assert.strictEqual("mget val 3", results[3].toString(), name);
- next(name);
- });
-};
-
-tests.SETNX = function () {
- var name = "SETNX";
- client.set(["setnx key", "setnx value"], require_string("OK", name));
- client.SETNX(["setnx key", "new setnx value"], require_number(0, name));
- client.del(["setnx key"], require_number(1, name));
- client.exists(["setnx key"], require_number(0, name));
- client.SETNX(["setnx key", "new setnx value"], require_number(1, name));
- client.exists(["setnx key"], last(name, require_number(1, name)));
-};
-
-tests.SETEX = function () {
- var name = "SETEX";
- client.SETEX(["setex key", "100", "setex val"], require_string("OK", name));
- client.exists(["setex key"], require_number(1, name));
- client.ttl(["setex key"], last(name, require_number_pos(name)));
-};
-
-tests.MSETNX = function () {
- var name = "MSETNX";
- client.mset(["mset1", "val1", "mset2", "val2", "mset3", "val3"], require_string("OK", name));
- client.MSETNX(["mset3", "val3", "mset4", "val4"], require_number(0, name));
- client.del(["mset3"], require_number(1, name));
- client.MSETNX(["mset3", "val3", "mset4", "val4"], require_number(1, name));
- client.exists(["mset3"], require_number(1, name));
- client.exists(["mset4"], last(name, require_number(1, name)));
-};
-
-tests.HGETALL = function () {
- var name = "HGETALL";
- client.hmset(["hosts", "mjr", "1", "another", "23", "home", "1234"], require_string("OK", name));
- client.HGETALL(["hosts"], function (err, obj) {
- assert.strictEqual(null, err, name + " result sent back unexpected error: " + err);
- assert.strictEqual(3, Object.keys(obj).length, name);
- assert.strictEqual("1", obj.mjr.toString(), name);
- assert.strictEqual("23", obj.another.toString(), name);
- assert.strictEqual("1234", obj.home.toString(), name);
- next(name);
- });
-};
-
-tests.HGETALL_NULL = function () {
- var name = "HGETALL_NULL";
-
- client.hgetall("missing", function (err, obj) {
- assert.strictEqual(null, err);
- assert.strictEqual(null, obj);
- next(name);
- });
-};
-
-tests.UTF8 = function () {
- var name = "UTF8",
- utf8_sample = "?_?";
-
- client.set(["utf8test", utf8_sample], require_string("OK", name));
- client.get(["utf8test"], function (err, obj) {
- assert.strictEqual(null, err);
- assert.strictEqual(utf8_sample, obj);
- next(name);
- });
-};
-
-// Set tests were adapted from Brian Hammond's redis-node-client.js, which has a comprehensive test suite
-
-tests.SADD = function () {
- var name = "SADD";
-
- client.del('set0');
- client.SADD('set0', 'member0', require_number(1, name));
- client.sadd('set0', 'member0', last(name, require_number(0, name)));
-};
-
-tests.SADD2 = function () {
- var name = "SADD2";
-
- client.del("set0");
- client.sadd("set0", ["member0", "member1", "member2"], require_number(3, name));
- client.smembers("set0", function (err, res) {
- assert.strictEqual(res.length, 3);
- assert.strictEqual(res[0], "member0");
- assert.strictEqual(res[1], "member1");
- assert.strictEqual(res[2], "member2");
- });
- client.SADD("set1", ["member0", "member1", "member2"], require_number(3, name));
- client.smembers("set1", function (err, res) {
- assert.strictEqual(res.length, 3);
- assert.strictEqual(res[0], "member0");
- assert.strictEqual(res[1], "member1");
- assert.strictEqual(res[2], "member2");
- next(name);
- });
-};
-
-tests.SISMEMBER = function () {
- var name = "SISMEMBER";
-
- client.del('set0');
- client.sadd('set0', 'member0', require_number(1, name));
- client.sismember('set0', 'member0', require_number(1, name));
- client.sismember('set0', 'member1', last(name, require_number(0, name)));
-};
-
-tests.SCARD = function () {
- var name = "SCARD";
-
- client.del('set0');
- client.sadd('set0', 'member0', require_number(1, name));
- client.scard('set0', require_number(1, name));
- client.sadd('set0', 'member1', require_number(1, name));
- client.scard('set0', last(name, require_number(2, name)));
-};
-
-tests.SREM = function () {
- var name = "SREM";
-
- client.del('set0');
- client.sadd('set0', 'member0', require_number(1, name));
- client.srem('set0', 'foobar', require_number(0, name));
- client.srem('set0', 'member0', require_number(1, name));
- client.scard('set0', last(name, require_number(0, name)));
-};
-
-tests.SPOP = function () {
- var name = "SPOP";
-
- client.del('zzz');
- client.sadd('zzz', 'member0', require_number(1, name));
- client.scard('zzz', require_number(1, name));
-
- client.spop('zzz', function (err, value) {
- if (err) {
- assert.fail(err);
- }
- assert.equal(value, 'member0', name);
- });
-
- client.scard('zzz', last(name, require_number(0, name)));
-};
-
-tests.SDIFF = function () {
- var name = "SDIFF";
-
- client.del('foo');
- client.sadd('foo', 'x', require_number(1, name));
- client.sadd('foo', 'a', require_number(1, name));
- client.sadd('foo', 'b', require_number(1, name));
- client.sadd('foo', 'c', require_number(1, name));
-
- client.sadd('bar', 'c', require_number(1, name));
-
- client.sadd('baz', 'a', require_number(1, name));
- client.sadd('baz', 'd', require_number(1, name));
-
- client.sdiff('foo', 'bar', 'baz', function (err, values) {
- if (err) {
- assert.fail(err, name);
- }
- values.sort();
- assert.equal(values.length, 2, name);
- assert.equal(values[0], 'b', name);
- assert.equal(values[1], 'x', name);
- next(name);
- });
-};
-
-tests.SDIFFSTORE = function () {
- var name = "SDIFFSTORE";
-
- client.del('foo');
- client.del('bar');
- client.del('baz');
- client.del('quux');
-
- client.sadd('foo', 'x', require_number(1, name));
- client.sadd('foo', 'a', require_number(1, name));
- client.sadd('foo', 'b', require_number(1, name));
- client.sadd('foo', 'c', require_number(1, name));
-
- client.sadd('bar', 'c', require_number(1, name));
-
- client.sadd('baz', 'a', require_number(1, name));
- client.sadd('baz', 'd', require_number(1, name));
-
- // NB: SDIFFSTORE returns the number of elements in the dstkey
-
- client.sdiffstore('quux', 'foo', 'bar', 'baz', require_number(2, name));
-
- client.smembers('quux', function (err, values) {
- if (err) {
- assert.fail(err, name);
- }
- var members = buffers_to_strings(values).sort();
-
- assert.deepEqual(members, [ 'b', 'x' ], name);
- next(name);
- });
-};
-
-tests.SMEMBERS = function () {
- var name = "SMEMBERS";
-
- client.del('foo');
- client.sadd('foo', 'x', require_number(1, name));
-
- client.smembers('foo', function (err, members) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(members), [ 'x' ], name);
- });
-
- client.sadd('foo', 'y', require_number(1, name));
-
- client.smembers('foo', function (err, values) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(values.length, 2, name);
- var members = buffers_to_strings(values).sort();
-
- assert.deepEqual(members, [ 'x', 'y' ], name);
- next(name);
- });
-};
-
-tests.SMOVE = function () {
- var name = "SMOVE";
-
- client.del('foo');
- client.del('bar');
-
- client.sadd('foo', 'x', require_number(1, name));
- client.smove('foo', 'bar', 'x', require_number(1, name));
- client.sismember('foo', 'x', require_number(0, name));
- client.sismember('bar', 'x', require_number(1, name));
- client.smove('foo', 'bar', 'x', last(name, require_number(0, name)));
-};
-
-tests.SINTER = function () {
- var name = "SINTER";
-
- client.del('sa');
- client.del('sb');
- client.del('sc');
-
- client.sadd('sa', 'a', require_number(1, name));
- client.sadd('sa', 'b', require_number(1, name));
- client.sadd('sa', 'c', require_number(1, name));
-
- client.sadd('sb', 'b', require_number(1, name));
- client.sadd('sb', 'c', require_number(1, name));
- client.sadd('sb', 'd', require_number(1, name));
-
- client.sadd('sc', 'c', require_number(1, name));
- client.sadd('sc', 'd', require_number(1, name));
- client.sadd('sc', 'e', require_number(1, name));
-
- client.sinter('sa', 'sb', function (err, intersection) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(intersection.length, 2, name);
- assert.deepEqual(buffers_to_strings(intersection).sort(), [ 'b', 'c' ], name);
- });
-
- client.sinter('sb', 'sc', function (err, intersection) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(intersection.length, 2, name);
- assert.deepEqual(buffers_to_strings(intersection).sort(), [ 'c', 'd' ], name);
- });
-
- client.sinter('sa', 'sc', function (err, intersection) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(intersection.length, 1, name);
- assert.equal(intersection[0], 'c', name);
- });
-
- // 3-way
-
- client.sinter('sa', 'sb', 'sc', function (err, intersection) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(intersection.length, 1, name);
- assert.equal(intersection[0], 'c', name);
- next(name);
- });
-};
-
-tests.SINTERSTORE = function () {
- var name = "SINTERSTORE";
-
- client.del('sa');
- client.del('sb');
- client.del('sc');
- client.del('foo');
-
- client.sadd('sa', 'a', require_number(1, name));
- client.sadd('sa', 'b', require_number(1, name));
- client.sadd('sa', 'c', require_number(1, name));
-
- client.sadd('sb', 'b', require_number(1, name));
- client.sadd('sb', 'c', require_number(1, name));
- client.sadd('sb', 'd', require_number(1, name));
-
- client.sadd('sc', 'c', require_number(1, name));
- client.sadd('sc', 'd', require_number(1, name));
- client.sadd('sc', 'e', require_number(1, name));
-
- client.sinterstore('foo', 'sa', 'sb', 'sc', require_number(1, name));
-
- client.smembers('foo', function (err, members) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(members), [ 'c' ], name);
- next(name);
- });
-};
-
-tests.SUNION = function () {
- var name = "SUNION";
-
- client.del('sa');
- client.del('sb');
- client.del('sc');
-
- client.sadd('sa', 'a', require_number(1, name));
- client.sadd('sa', 'b', require_number(1, name));
- client.sadd('sa', 'c', require_number(1, name));
-
- client.sadd('sb', 'b', require_number(1, name));
- client.sadd('sb', 'c', require_number(1, name));
- client.sadd('sb', 'd', require_number(1, name));
-
- client.sadd('sc', 'c', require_number(1, name));
- client.sadd('sc', 'd', require_number(1, name));
- client.sadd('sc', 'e', require_number(1, name));
-
- client.sunion('sa', 'sb', 'sc', function (err, union) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(union).sort(), ['a', 'b', 'c', 'd', 'e'], name);
- next(name);
- });
-};
-
-tests.SUNIONSTORE = function () {
- var name = "SUNIONSTORE";
-
- client.del('sa');
- client.del('sb');
- client.del('sc');
- client.del('foo');
-
- client.sadd('sa', 'a', require_number(1, name));
- client.sadd('sa', 'b', require_number(1, name));
- client.sadd('sa', 'c', require_number(1, name));
-
- client.sadd('sb', 'b', require_number(1, name));
- client.sadd('sb', 'c', require_number(1, name));
- client.sadd('sb', 'd', require_number(1, name));
-
- client.sadd('sc', 'c', require_number(1, name));
- client.sadd('sc', 'd', require_number(1, name));
- client.sadd('sc', 'e', require_number(1, name));
-
- client.sunionstore('foo', 'sa', 'sb', 'sc', function (err, cardinality) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(cardinality, 5, name);
- });
-
- client.smembers('foo', function (err, members) {
- if (err) {
- assert.fail(err, name);
- }
- assert.equal(members.length, 5, name);
- assert.deepEqual(buffers_to_strings(members).sort(), ['a', 'b', 'c', 'd', 'e'], name);
- next(name);
- });
-};
-
-// SORT test adapted from Brian Hammond's redis-node-client.js, which has a comprehensive test suite
-
-tests.SORT = function () {
- var name = "SORT";
-
- client.del('y');
- client.del('x');
-
- client.rpush('y', 'd', require_number(1, name));
- client.rpush('y', 'b', require_number(2, name));
- client.rpush('y', 'a', require_number(3, name));
- client.rpush('y', 'c', require_number(4, name));
-
- client.rpush('x', '3', require_number(1, name));
- client.rpush('x', '9', require_number(2, name));
- client.rpush('x', '2', require_number(3, name));
- client.rpush('x', '4', require_number(4, name));
-
- client.set('w3', '4', require_string("OK", name));
- client.set('w9', '5', require_string("OK", name));
- client.set('w2', '12', require_string("OK", name));
- client.set('w4', '6', require_string("OK", name));
-
- client.set('o2', 'buz', require_string("OK", name));
- client.set('o3', 'foo', require_string("OK", name));
- client.set('o4', 'baz', require_string("OK", name));
- client.set('o9', 'bar', require_string("OK", name));
-
- client.set('p2', 'qux', require_string("OK", name));
- client.set('p3', 'bux', require_string("OK", name));
- client.set('p4', 'lux', require_string("OK", name));
- client.set('p9', 'tux', require_string("OK", name));
-
- // Now the data has been setup, we can test.
-
- // But first, test basic sorting.
-
- // y = [ d b a c ]
- // sort y ascending = [ a b c d ]
- // sort y descending = [ d c b a ]
-
- client.sort('y', 'asc', 'alpha', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), ['a', 'b', 'c', 'd'], name);
- });
-
- client.sort('y', 'desc', 'alpha', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), ['d', 'c', 'b', 'a'], name);
- });
-
- // Now try sorting numbers in a list.
- // x = [ 3, 9, 2, 4 ]
-
- client.sort('x', 'asc', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), [2, 3, 4, 9], name);
- });
-
- client.sort('x', 'desc', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), [9, 4, 3, 2], name);
- });
-
- // Try sorting with a 'by' pattern.
-
- client.sort('x', 'by', 'w*', 'asc', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), [3, 9, 4, 2], name);
- });
-
- // Try sorting with a 'by' pattern and 1 'get' pattern.
-
- client.sort('x', 'by', 'w*', 'asc', 'get', 'o*', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), ['foo', 'bar', 'baz', 'buz'], name);
- });
-
- // Try sorting with a 'by' pattern and 2 'get' patterns.
-
- client.sort('x', 'by', 'w*', 'asc', 'get', 'o*', 'get', 'p*', function (err, sorted) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(sorted), ['foo', 'bux', 'bar', 'tux', 'baz', 'lux', 'buz', 'qux'], name);
- });
-
- // Try sorting with a 'by' pattern and 2 'get' patterns.
- // Instead of getting back the sorted set/list, store the values to a list.
- // Then check that the values are there in the expected order.
-
- client.sort('x', 'by', 'w*', 'asc', 'get', 'o*', 'get', 'p*', 'store', 'bacon', function (err) {
- if (err) {
- assert.fail(err, name);
- }
- });
-
- client.lrange('bacon', 0, -1, function (err, values) {
- if (err) {
- assert.fail(err, name);
- }
- assert.deepEqual(buffers_to_strings(values), ['foo', 'bux', 'bar', 'tux', 'baz', 'lux', 'buz', 'qux'], name);
- next(name);
- });
-
- // TODO - sort by hash value
-};
-
-tests.MONITOR = function () {
- var name = "MONITOR", responses = [], monitor_client;
-
- monitor_client = redis.createClient();
- monitor_client.monitor(function (err, res) {
- client.mget("some", "keys", "foo", "bar");
- client.set("json", JSON.stringify({
- foo: "123",
- bar: "sdflkdfsjk",
- another: false
- }));
- });
- monitor_client.on("monitor", function (time, args) {
- // skip monitor command for Redis <= 2.4.16
- if (args[0] === "monitor") return;
-
- responses.push(args);
- if (responses.length === 2) {
- assert.strictEqual(5, responses[0].length);
- assert.strictEqual("mget", responses[0][0]);
- assert.strictEqual("some", responses[0][1]);
- assert.strictEqual("keys", responses[0][2]);
- assert.strictEqual("foo", responses[0][3]);
- assert.strictEqual("bar", responses[0][4]);
- assert.strictEqual(3, responses[1].length);
- assert.strictEqual("set", responses[1][0]);
- assert.strictEqual("json", responses[1][1]);
- assert.strictEqual('{"foo":"123","bar":"sdflkdfsjk","another":false}', responses[1][2]);
- monitor_client.quit(function (err, res) {
- next(name);
- });
- }
- });
-};
-
-tests.BLPOP = function () {
- var name = "BLPOP";
-
- client.rpush("blocking list", "initial value", function (err, res) {
- client2.BLPOP("blocking list", 0, function (err, res) {
- assert.strictEqual("blocking list", res[0].toString());
- assert.strictEqual("initial value", res[1].toString());
-
- client.rpush("blocking list", "wait for this value");
- });
- client2.BLPOP("blocking list", 0, function (err, res) {
- assert.strictEqual("blocking list", res[0].toString());
- assert.strictEqual("wait for this value", res[1].toString());
- next(name);
- });
- });
-};
-
-tests.BLPOP_TIMEOUT = function () {
- var name = "BLPOP_TIMEOUT";
-
- // try to BLPOP the list again, which should be empty. This should timeout and return null.
- client2.BLPOP("blocking list", 1, function (err, res) {
- if (err) {
- throw err;
- }
-
- assert.strictEqual(res, null);
- next(name);
- });
-};
-
-tests.EXPIRE = function () {
- var name = "EXPIRE";
- client.set(['expiry key', 'bar'], require_string("OK", name));
- client.EXPIRE(["expiry key", "1"], require_number_pos(name));
- setTimeout(function () {
- client.exists(["expiry key"], last(name, require_number(0, name)));
- }, 2000);
-};
-
-tests.TTL = function () {
- var name = "TTL";
- client.set(["ttl key", "ttl val"], require_string("OK", name));
- client.expire(["ttl key", "100"], require_number_pos(name));
- setTimeout(function () {
- client.TTL(["ttl key"], last(name, require_number_pos(name)));
- }, 500);
-};
-
-tests.OPTIONAL_CALLBACK = function () {
- var name = "OPTIONAL_CALLBACK";
- client.del("op_cb1");
- client.set("op_cb1", "x");
- client.get("op_cb1", last(name, require_string("x", name)));
-};
-
-tests.OPTIONAL_CALLBACK_UNDEFINED = function () {
- var name = "OPTIONAL_CALLBACK_UNDEFINED";
- client.del("op_cb2");
- client.set("op_cb2", "y", undefined);
- client.get("op_cb2", last(name, require_string("y", name)));
-};
-
-tests.HMSET_THROWS_ON_NON_STRINGS = function () {
- var name = "HMSET_THROWS_ON_NON_STRINGS";
- var hash = name;
- var data = { "a": [ "this is not a string" ] };
-
- client.hmset(hash, data, cb);
- function cb(e, r) {
- assert(e); // should be an error!
- }
-
- // alternative way it throws
- function thrower() {
- client.hmset(hash, data);
- }
- assert.throws(thrower);
- next(name);
-};
-
-tests.ENABLE_OFFLINE_QUEUE_TRUE = function () {
- var name = "ENABLE_OFFLINE_QUEUE_TRUE";
- var cli = redis.createClient(9999, null, {
- max_attempts: 1
- // default :)
- // enable_offline_queue: true
- });
- cli.on('error', function(e) {
- // ignore, b/c expecting a "can't connect" error
- });
- return setTimeout(function() {
- cli.set(name, name, function(err, result) {
- assert.ifError(err);
- });
-
- return setTimeout(function(){
- assert.strictEqual(cli.offline_queue.length, 1);
- return next(name);
- }, 25);
- }, 50);
-};
-
-tests.ENABLE_OFFLINE_QUEUE_FALSE = function () {
- var name = "ENABLE_OFFLINE_QUEUE_FALSE";
- var cli = redis.createClient(9999, null, {
- max_attempts: 1,
- enable_offline_queue: false
- });
- cli.on('error', function() {
- // ignore, see above
- });
- assert.throws(function () {
- cli.set(name, name)
- })
- assert.doesNotThrow(function () {
- cli.set(name, name, function (err) {
- // should callback with an error
- assert.ok(err);
- setTimeout(function () {
- next(name);
- }, 50);
- });
- });
-};
-
-// TODO - need a better way to test auth, maybe auto-config a local Redis server or something.
-// Yes, this is the real password. Please be nice, thanks.
-tests.auth = function () {
- var name = "AUTH", client4, ready_count = 0;
-
- client4 = redis.createClient(9006, "filefish.redistogo.com");
- client4.auth("664b1b6aaf134e1ec281945a8de702a9", function (err, res) {
- assert.strictEqual(null, err, name);
- assert.strictEqual("OK", res.toString(), name);
- });
-
- // test auth, then kill the connection so it'll auto-reconnect and auto-re-auth
- client4.on("ready", function () {
- ready_count++;
- if (ready_count === 1) {
- client4.stream.destroy();
- } else {
- client4.quit(function (err, res) {
- next(name);
- });
- }
- });
-};
-
-all_tests = Object.keys(tests);
-all_start = new Date();
-test_count = 0;
-
-run_next_test = function run_next_test() {
- var test_name = all_tests.shift();
- if (typeof tests[test_name] === "function") {
- util.print('- \x1b[1m' + test_name.toLowerCase() + '\x1b[0m:');
- cur_start = new Date();
- test_count += 1;
- tests[test_name]();
- } else {
- console.log('\n completed \x1b[32m%d\x1b[0m tests in \x1b[33m%d\x1b[0m ms\n', test_count, Date.now() - all_start);
- client.quit();
- client2.quit();
- }
-};
-
-client.once("ready", function start_tests() {
- console.log("Connected to " + client.host + ":" + client.port + ", Redis server version " + client.server_info.redis_version + "\n");
- console.log("Using reply parser " + client.reply_parser.name);
-
- run_next_test();
-
- connected = true;
-});
-
-client.on('end', function () {
- ended = true;
-});
-
-declare var process;
-// Exit immediately on connection failure, which triggers "exit", below, which fails the test
-client.on("error", function (err) {
- console.error("client: " + err.stack);
- process.exit();
-});
-client2.on("error", function (err) {
- console.error("client2: " + err.stack);
- process.exit();
-});
-client3.on("error", function (err) {
- console.error("client3: " + err.stack);
- process.exit();
-});
-client.on("reconnecting", function (params) {
- console.log("reconnecting: " + util.inspect(params));
-});
-
-process.on('uncaughtException', function (err) {
- console.error("Uncaught exception: " + err.stack);
- process.exit(1);
-});
-
-process.on('exit', function (code) {
- assert.equal(true, connected);
- assert.equal(true, ended);
-});
diff --git a/node_redis/node_redis-tests.ts.tscparams b/node_redis/node_redis-tests.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/node_redis/node_redis-tests.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/node_redis/node_redis.d.ts b/node_redis/node_redis.d.ts
index 4328e299b9..cdae4de063 100644
--- a/node_redis/node_redis.d.ts
+++ b/node_redis/node_redis.d.ts
@@ -3,351 +3,7 @@
// Definitions by: Boris Yankov <https://github.com/borisyankov/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
+/// <reference path="../redis/redis.d.ts" />
-declare module 'redis' {
- export var debug_mode: boolean;
- export function createClient(): RedisClient;
- export function createClient(port: number, host: string, options?: RedisOptions): RedisClient;
- export function print(err: string, reply?: string);
+// PLEASE USE redis/redis.d.ts directly!
- interface RedisOptions {
- parser?: string;
- return_buffers?: boolean;
- detect_buffers?: boolean;
- socket_nodelay?: boolean;
- no_ready_check?: boolean;
- enable_offline_queue?: boolean;
- retry_max_delay?: number;
- connect_timeout?: boolean;
- max_attempts?: number;
- auth_pass?: string;
- family?: string; // "IPv4" | "IPv6"
- }
-
- interface Command {
- (...args: any[]): any;
- }
-
- interface Commands {
-
- get: Command;
- set: Command;
- setnx: Command;
- setex: Command;
- append: Command;
- strlen: Command;
- del: Command;
- exists: Command;
- setbit: Command;
- getbit: Command;
- setrange: Command;
- getrange: Command;
- substr: Command;
- incr: Command;
- decr: Command;
- mget: Command;
-
- rpush: Command;
- lpush: Command;
- rpushx: Command;
- lpushx: Command;
- linsert: Command;
- rpop: Command;
- lpop: Command;
- brpop: Command;
- brpoplpush: Command;
- blpop: Command;
- llen: Command;
- lindex: Command;
- lset: Command;
- lrange: Command;
- ltrim: Command;
- lrem: Command;
- rpoplpush: Command;
-
- sadd: Command;
- srem: Command;
- smove: Command;
- sismember: Command;
- scard: Command;
- spop: Command;
- srandmember: Command;
- sinter: Command;
- sinterstore: Command;
- sunion: Command;
- sunionstore: Command;
- sdiff: Command;
- sdiffstore: Command;
- smembers: Command;
-
- zadd: Command;
- zincrby: Command;
- zrem: Command;
- zremrangebyscore: Command;
- zremrangebyrank: Command;
- zunionstore: Command;
- zinterstore: Command;
- zrange: Command;
- zrangebyscore: Command;
- zrevrangebyscore: Command;
- zcount: Command;
- zrevrange: Command;
- zcard: Command;
- zscore: Command;
- zrank: Command;
- zrevrank: Command;
-
- hset: Command;
- hsetnx: Command;
- hget: Command;
- hmset: Command;
- hmget: Command;
- hincrby: Command;
- hdel: Command;
- hlen: Command;
- hkeys: Command;
- hvals: Command;
- hgetall: Command;
- hexists: Command;
-
- incrby: Command;
- decrby: Command;
- getset: Command;
- mset: Command;
- msetnx: Command;
- randomkey: Command;
- select: Command;
- move: Command;
- rename: Command;
- renamenx: Command;
- expire: Command;
- expireat: Command;
- keys: Command;
- dbsize: Command;
- auth: Command;
- ping: Command;
- echo: Command;
- save: Command;
- bgsave: Command;
- bgrewriteaof: Command;
- shutdown: Command;
- lastsave: Command;
- type: Command;
- multi: Command;
- exec: Command;
- discard: Command;
- sync: Command;
- flushdb: Command;
- flushall: Command;
- sort: Command;
- info: Command;
- monitor: Command;
- ttl: Command;
- persist: Command;
- slaveof: Command;
- debug: Command;
- config: Command;
- subscribe: Command;
- unsubscribe: Command;
- psubscribe: Command;
- punsubscribe: Command;
- publish: Command;
- watch: Command;
- unwatch: Command;
- cluster: Command;
- restore: Command;
- migrate: Command;
- dump: Command;
- object: Command;
- client: Command;
- eval: Command;
- evalsha: Command;
-
- quit: Command;
-
- /////////////////
-
- GET: Command;
- SET: Command;
- SETNX: Command;
- SETEX: Command;
- APPEND: Command;
- STRLEN: Command;
- DEL: Command;
- EXISTS: Command;
- SETBIT: Command;
- GETBIT: Command;
- SETRANGE: Command;
- GETRANGE: Command;
- SUBSTR: Command;
- INCR: Command;
- DECR: Command;
- MGET: Command;
-
- RPUSH: Command;
- LPUSH: Command;
- RPUSHX: Command;
- LPUSHX: Command;
- LINSERT: Command;
- RPOP: Command;
- LPOP: Command;
- BRPOP: Command;
- BRPOPLPUSH: Command;
- BLPOP: Command;
- LLEN: Command;
- LINDEX: Command;
- LSET: Command;
- LRANGE: Command;
- LTRIM: Command;
- LREM: Command;
- RPOPLPUSH: Command;
-
- SADD: Command;
- SREM: Command;
- SMOVE: Command;
- SISMEMBER: Command;
- SCARD: Command;
- SPOP: Command;
- SRANDMEMBER: Command;
- SINTER: Command;
- SINTERSTORE: Command;
- SUNION: Command;
- SUNIONSTORE: Command;
- SDIFF: Command;
- SDIFFSTORE: Command;
- SMEMBERS: Command;
-
- ZADD: Command;
- ZINCRBY: Command;
- ZREM: Command;
- ZREMRANGEBYSCORE: Command;
- ZREMRANGEBYRANK: Command;
- ZUNIONSTORE: Command;
- ZINTERSTORE: Command;
- ZRANGE: Command;
- ZRANGEBYSCORE: Command;
- ZREVRANGEBYSCORE: Command;
- ZCOUNT: Command;
- ZREVRANGE: Command;
- ZCARD: Command;
- ZSCORE: Command;
- ZRANK: Command;
- ZREVRANK: Command;
-
- HSET: Command;
- HSETNX: Command;
- HGET: Command;
- HMSET: Command;
- HMGET: Command;
- HINCRBY: Command;
- HDEL: Command;
- HLEN: Command;
- HKEYS: Command;
- HVALS: Command;
- HGETALL: Command;
- HEXISTS: Command;
-
- INCRBY: Command;
- DECRBY: Command;
- GETSET: Command;
- MSET: Command;
- MSETNX: Command;
- RANDOMKEY: Command;
- SELECT: Command;
- MOVE: Command;
- RENAME: Command;
- RENAMENX: Command;
- EXPIRE: Command;
- EXPIREAT: Command;
- KEYS: Command;
- DBSIZE: Command;
- AUTH: Command;
- PING: Command;
- ECHO: Command;
- SAVE: Command;
- BGSAVE: Command;
- BGREWRITEAOF: Command;
- SHUTDOWN: Command;
- LASTSAVE: Command;
- TYPE: Command;
- MULTI: Command;
- EXEC: Command;
- DISCARD: Command;
- SYNC: Command;
- FLUSHDB: Command;
- FLUSHALL: Command;
- SORT: Command;
- INFO: Command;
- MONITOR: Command;
- TTL: Command;
- PERSIST: Command;
- SLAVEOF: Command;
- DEBUG: Command;
- CONFIG: Command;
- SUBSCRIBE: Command;
- UNSUBSCRIBE: Command;
- PSUBSCRIBE: Command;
- PUNSUBSCRIBE: Command;
- PUBLISH: Command;
- WATCH: Command;
- UNWATCH: Command;
- CLUSTER: Command;
- RESTORE: Command;
- MIGRATE: Command;
- DUMP: Command;
- OBJECT: Command;
- CLIENT: Command;
- EVAL: Command;
- EVALSHA: Command;
-
- QUIT: Command;
- }
-
- interface Multi extends Commands {
- }
-
- interface RedisClient extends Commands {
-
- initialize_retry_vars(): void;
- flush_and_error(message: string): void;
- on_error(message: string): void;
- do_auth(): void;
- on_connect(): void;
- init_parser(): void;
- on_ready(): void;
- on_info_cmd(err, res): void;
- ready_check(): void;
- send_offline_queue(): void;
- connection_gone(why: string): void;
- on_data(data): void;
- return_error(err): void;
- return_reply(reply): void;
- send_command(command: string, args: any[], callback?: Function);
- send_command(command: string, ...args: any[]);
- pub_sub_command(command: { command: string; args: any[]; });
-
- port: number;
- host: string;
- reply_parser;
- stream;
-
- server_info;
- connected: boolean;
- command_queue: any[];
- offline_queue: any[];
- retry_delay : number;
- retry_backoff: number;
-
- auth(password?: string, callback?: Function): void;
- AUTH(password?: string, callback?: Function): void;
-
- end(): RedisClient;
-
- on(eventName: string, callback: Function): void;
- once(eventName: string, callback: Function): void;
- removeListener(eventName: string, callback: Function): void;
-
- multi(commands?: any[]): Multi;
- MULTI(): Multi;
- }
-}
\ No newline at end of file
diff --git a/node_redis/node_redis.d.ts.tscparams b/node_redis/node_redis.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/node_redis/node_redis.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/nodemailer-smtp-transport/nodemailer-smtp-transport.d.ts b/nodemailer-smtp-transport/nodemailer-smtp-transport.d.ts
index 3a4c626b0e..fa49fb54f3 100644
--- a/nodemailer-smtp-transport/nodemailer-smtp-transport.d.ts
+++ b/nodemailer-smtp-transport/nodemailer-smtp-transport.d.ts
@@ -20,35 +20,35 @@ declare module "nodemailer-smtp-transport" {
export interface SmtpOptions {
/**
* Fills in certain SMTP configurations options (e.g. 'host', 'port', and 'secure') for
- * well-known services. Possible values:
- * - '1und1'
- * - 'AOL'
- * - 'DebugMail.io'
- * - 'DynectEmail'
- * - 'FastMail'
- * - 'GandiMail'
- * - 'Gmail'
- * - 'Godaddy'
- * - 'GodaddyAsia'
- * - 'GodaddyEurope'
- * - 'hot.ee'
- * - 'Hotmail'
- * - 'iCloud'
- * - 'mail.ee'
- * - 'Mail.ru'
- * - 'Mailgun'
- * - 'Mailjet'
- * - 'Mandrill'
- * - 'Naver'
- * - 'Postmark'
- * - 'QQ'
- * - 'QQex'
- * - 'SendCloud'
- * - 'SendGrid'
- * - 'SES'
- * - 'Sparkpost'
- * - 'Yahoo'
- * - 'Yandex'
+ * well-known services. Possible values:
+ * - '1und1'
+ * - 'AOL'
+ * - 'DebugMail.io'
+ * - 'DynectEmail'
+ * - 'FastMail'
+ * - 'GandiMail'
+ * - 'Gmail'
+ * - 'Godaddy'
+ * - 'GodaddyAsia'
+ * - 'GodaddyEurope'
+ * - 'hot.ee'
+ * - 'Hotmail'
+ * - 'iCloud'
+ * - 'mail.ee'
+ * - 'Mail.ru'
+ * - 'Mailgun'
+ * - 'Mailjet'
+ * - 'Mandrill'
+ * - 'Naver'
+ * - 'Postmark'
+ * - 'QQ'
+ * - 'QQex'
+ * - 'SendCloud'
+ * - 'SendGrid'
+ * - 'SES'
+ * - 'Sparkpost'
+ * - 'Yahoo'
+ * - 'Yandex'
* - 'Zoho'
*/
service?: string;
diff --git a/nouislider/nouislider.d.ts b/nouislider/nouislider.d.ts
index e632159818..4b10680199 100644
--- a/nouislider/nouislider.d.ts
+++ b/nouislider/nouislider.d.ts
@@ -1,176 +1,176 @@
-// Type definitions for nouislider v8.0.2
-// Project: https://github.com/leongersen/noUiSlider
-// Definitions by: Patrick Davies <https://github.com/bleuarg>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-/// <reference path="../wnumb/wnumb.d.ts"/>
-
-declare module noUiSlider {
- /**
- * To create a slider, call noUiSlider.create() with an element and your options.
- */
- function create(target: HTMLElement, options: Options): void;
-
- interface Options {
- /**
- * The start option sets the number of handles and their start positions, relative to range.
- */
- start: number | number[] | number[][];
- /**
- * The connect setting can be used to control the bar between the handles,
- * or the edges of the slider. Use "lower" to connect to the lower side,
- * or "upper" to connect to the upper side. Setting true sets the bar between the handles.
- */
- range: Object;
- /**
- * noUiSlider offers several ways to handle user interaction.
- * The range can be set to drag, and handles can move to taps.
- * All these effects are optional, and can be enable by adding their keyword to the behaviour option.
- * This option accepts a "-" separated list of "drag", "tap", "fixed", "snap" or "none".
- */
- connect?: string | boolean;
- /**
- * When using two handles, the minimum distance between the handles can be set using the margin option.
- * The margin value is relative to the value set in 'range'.
- * This option is only available on standard linear sliders.
- */
- margin?: number;
- /**
- * The limit option is the oposite of the margin option,
- * limiting the maximum distance between two handles.
- * As with the margin option, the limit option can only be used on linear sliders.
- */
- limit?: number;
- /**
- * By default, the slider slides fluently.
- * In order to make the handles jump between intervals, you can use this option.
- * The step option is relative to the values provided to range.
- */
- step?: number;
- /**
- * The orientation setting can be used to set the slider to "vertical" or "horizontal".
- * Set dimensions! Vertical sliders don't assume a default height, so you'll need to set one.
- * You can use any unit you want, including % or px.
- */
- orientation?: string;
- /**
- * By default the sliders are top-to-bottom and left-to-right,
- * but you can change this using the direction option,
- * which decides where the upper side of the slider is.
- */
- direction?: string;
- /**
- * Set the animate option to false to prevent the slider from animating to a new value with when calling .val().
- */
- animate?: boolean;
- /**
- * All values on the slider are part of a range. The range has a minimum and maximum value.
- */
- behaviour?: string;
- /**
- * To format the slider output, noUiSlider offers a format option.
- * Simply specify to and from functions to encode and decode the values.
- * See manual formatting to the right for usage information.
- * By default, noUiSlider will format output with 2 decimals.
- */
- format?: Object | ((...args:any[]) => any);
-
- /**
- * Allows you to generate points along the slider.
- */
- pips?: PipsOptions;
- }
-
- interface PipsOptions {
- /**
- * The 'range' mode uses the slider range to determine where the pips should be. A pip is generated for every percentage specified.
- *
- * The 'steps', like 'range', uses the slider range. In steps mode, a pip is generated for every step.
- * The 'filter' option can be used to filter the generated pips from the 'steps' options'
- * The filter function must return 0 (no value), 1 (large value) or 2 (small value).
- *
- * In 'positions' mode, pips are generated at percentage-based positions on the slider.
- * Optionally, the stepped option can be set to true to match the pips to the slider steps.
- *
- * The 'count' mode can be used to generate a fixed number of pips. As with positions mode, the stepped option can be used.
- *
- * The 'values' mode is similar to positions, but it accepts values instead of percentages. The stepped option can be used for this mode.
- *
- */
- mode: string; // "range" | "steps" | "positions" | "count" | "values"
- /**
- * Range Mode: percentage for range mode
- * Step Mode: step number for steps
- * Positions Mode: percentage-based positions on the slider
- * Count Mode: positions between pips
- */
- density?: number;
- /**
- * Step Mode: The filter option can be used to filter the generated pips.
- * The filter function must return 0 (no value), 1 (large value) or 2 (small value).
- */
- filter?: (...args: any[]) => PipFilterResult;
- /**
- * format for step mode
- * see noUiSlider format
- */
- format?: Object;
- /**
- *
- * values for positions and values mode
- * number pips for count mode
- */
- values?: number | number[];
- /**
- * stepped option for positions, values and count mode
- */
- stepped?: boolean;
- }
-
- const enum PipFilterResult {
- NoValue,
- LargeValue,
- SmallValue,
- }
-
- interface Callback {
- /**
- * Array for both one-handle and two-handle sliders. It contains the current slider values,
- * with formatting applied.
- */
- (values: any[], handle: number, unencoded: number): void
- }
-
-
- interface noUiSlider {
- /**
- * Bind event to the slider.
- */
- on(eventName: string, callback: Callback): void;
- /**
- * Unbind event to the slider.
- */
- off(eventName: string): void;
- /**
- * Destroy's the slider.
- */
- destroy(): void;
-
- /**
- * To get the current slider value. For one-handle sliders, calling .get() will return the value.
- * For two-handle sliders, an array[value, value] will be returned.
- */
- get(): number | number[];
- /**
- * noUiSlider will keep your values within the slider range, which saves you a bunch of validation.
- * If you have configured the slider to use one handle, you can change the current value by passing
- * a number to the .set() method. If you have two handles, pass an array. One-handled sliders
- * will also accept arrays. Within an array, you can set one position to null
- * if you want to leave a handle unchanged.
- */
- set(value: number | number[]): void;
- }
-
- interface Instance extends HTMLElement {
- noUiSlider: noUiSlider
- }
-}
+// Type definitions for nouislider v8.0.2
+// Project: https://github.com/leongersen/noUiSlider
+// Definitions by: Patrick Davies <https://github.com/bleuarg>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+/// <reference path="../wnumb/wnumb.d.ts"/>
+
+declare module noUiSlider {
+ /**
+ * To create a slider, call noUiSlider.create() with an element and your options.
+ */
+ function create(target: HTMLElement, options: Options): void;
+
+ interface Options {
+ /**
+ * The start option sets the number of handles and their start positions, relative to range.
+ */
+ start: number | number[] | number[][];
+ /**
+ * The connect setting can be used to control the bar between the handles,
+ * or the edges of the slider. Use "lower" to connect to the lower side,
+ * or "upper" to connect to the upper side. Setting true sets the bar between the handles.
+ */
+ range: Object;
+ /**
+ * noUiSlider offers several ways to handle user interaction.
+ * The range can be set to drag, and handles can move to taps.
+ * All these effects are optional, and can be enable by adding their keyword to the behaviour option.
+ * This option accepts a "-" separated list of "drag", "tap", "fixed", "snap" or "none".
+ */
+ connect?: string | boolean;
+ /**
+ * When using two handles, the minimum distance between the handles can be set using the margin option.
+ * The margin value is relative to the value set in 'range'.
+ * This option is only available on standard linear sliders.
+ */
+ margin?: number;
+ /**
+ * The limit option is the oposite of the margin option,
+ * limiting the maximum distance between two handles.
+ * As with the margin option, the limit option can only be used on linear sliders.
+ */
+ limit?: number;
+ /**
+ * By default, the slider slides fluently.
+ * In order to make the handles jump between intervals, you can use this option.
+ * The step option is relative to the values provided to range.
+ */
+ step?: number;
+ /**
+ * The orientation setting can be used to set the slider to "vertical" or "horizontal".
+ * Set dimensions! Vertical sliders don't assume a default height, so you'll need to set one.
+ * You can use any unit you want, including % or px.
+ */
+ orientation?: string;
+ /**
+ * By default the sliders are top-to-bottom and left-to-right,
+ * but you can change this using the direction option,
+ * which decides where the upper side of the slider is.
+ */
+ direction?: string;
+ /**
+ * Set the animate option to false to prevent the slider from animating to a new value with when calling .val().
+ */
+ animate?: boolean;
+ /**
+ * All values on the slider are part of a range. The range has a minimum and maximum value.
+ */
+ behaviour?: string;
+ /**
+ * To format the slider output, noUiSlider offers a format option.
+ * Simply specify to and from functions to encode and decode the values.
+ * See manual formatting to the right for usage information.
+ * By default, noUiSlider will format output with 2 decimals.
+ */
+ format?: Object | ((...args:any[]) => any);
+
+ /**
+ * Allows you to generate points along the slider.
+ */
+ pips?: PipsOptions;
+ }
+
+ interface PipsOptions {
+ /**
+ * The 'range' mode uses the slider range to determine where the pips should be. A pip is generated for every percentage specified.
+ *
+ * The 'steps', like 'range', uses the slider range. In steps mode, a pip is generated for every step.
+ * The 'filter' option can be used to filter the generated pips from the 'steps' options'
+ * The filter function must return 0 (no value), 1 (large value) or 2 (small value).
+ *
+ * In 'positions' mode, pips are generated at percentage-based positions on the slider.
+ * Optionally, the stepped option can be set to true to match the pips to the slider steps.
+ *
+ * The 'count' mode can be used to generate a fixed number of pips. As with positions mode, the stepped option can be used.
+ *
+ * The 'values' mode is similar to positions, but it accepts values instead of percentages. The stepped option can be used for this mode.
+ *
+ */
+ mode: string; // "range" | "steps" | "positions" | "count" | "values"
+ /**
+ * Range Mode: percentage for range mode
+ * Step Mode: step number for steps
+ * Positions Mode: percentage-based positions on the slider
+ * Count Mode: positions between pips
+ */
+ density?: number;
+ /**
+ * Step Mode: The filter option can be used to filter the generated pips.
+ * The filter function must return 0 (no value), 1 (large value) or 2 (small value).
+ */
+ filter?: (...args: any[]) => PipFilterResult;
+ /**
+ * format for step mode
+ * see noUiSlider format
+ */
+ format?: Object;
+ /**
+ *
+ * values for positions and values mode
+ * number pips for count mode
+ */
+ values?: number | number[];
+ /**
+ * stepped option for positions, values and count mode
+ */
+ stepped?: boolean;
+ }
+
+ const enum PipFilterResult {
+ NoValue,
+ LargeValue,
+ SmallValue,
+ }
+
+ interface Callback {
+ /**
+ * Array for both one-handle and two-handle sliders. It contains the current slider values,
+ * with formatting applied.
+ */
+ (values: any[], handle: number, unencoded: number): void
+ }
+
+
+ interface noUiSlider {
+ /**
+ * Bind event to the slider.
+ */
+ on(eventName: string, callback: Callback): void;
+ /**
+ * Unbind event to the slider.
+ */
+ off(eventName: string): void;
+ /**
+ * Destroy's the slider.
+ */
+ destroy(): void;
+
+ /**
+ * To get the current slider value. For one-handle sliders, calling .get() will return the value.
+ * For two-handle sliders, an array[value, value] will be returned.
+ */
+ get(): number | number[];
+ /**
+ * noUiSlider will keep your values within the slider range, which saves you a bunch of validation.
+ * If you have configured the slider to use one handle, you can change the current value by passing
+ * a number to the .set() method. If you have two handles, pass an array. One-handled sliders
+ * will also accept arrays. Within an array, you can set one position to null
+ * if you want to leave a handle unchanged.
+ */
+ set(value: number | number[]): void;
+ }
+
+ interface Instance extends HTMLElement {
+ noUiSlider: noUiSlider
+ }
+}
diff --git a/observe-js/observe-js-test.ts b/observe-js/observe-js-tests.ts
similarity index 98%
rename from observe-js/observe-js-test.ts
rename to observe-js/observe-js-tests.ts
index 37ad0216c5..3dc4c73df5 100644
--- a/observe-js/observe-js-test.ts
+++ b/observe-js/observe-js-tests.ts
@@ -1,7 +1,7 @@
/// <reference path="observe-js.d.ts" />
module observejs {
-
+
function Test_PathObserver() {
var obj = { foo: { bar: 'baz' } };
var defaultValue = 42;
@@ -10,8 +10,8 @@ module observejs {
// respond to obj.foo.bar having changed value.
});
}
-
-
+
+
function Test_ArrayObserver() {
var arr = [0, 1, 2, 4];
var observer = new ArrayObserver(arr);
@@ -24,7 +24,7 @@ module observejs {
});
});
}
-
+
function Test_ObejctObserver() {
var myObj = { id: 1, foo: 'bar' };
var observer = new ObjectObserver(myObj);
@@ -45,15 +45,15 @@ module observejs {
});
});
}
-
+
function Test_CompounObserver() {
var obj = {
a: 1,
b: 2,
};
-
+
var otherObj = { c: 3 };
-
+
var observer = new CompoundObserver();
observer.addPath(obj, 'a');
observer.addObserver(new PathObserver(obj, 'b'));
@@ -66,25 +66,25 @@ module observejs {
}
});
}
-
+
function Test_ObserverTransform_1() {
var obj = { value: 10 };
var observer = new PathObserver(obj, 'value');
function getValue(value:any) { return value * 2 };
function setValue(value:any) { return value / 2 };
-
+
var transform = new ObserverTransform(observer, getValue, setValue);
-
+
// returns 20.
transform.open(function(newValue, oldValue) {
console.log('new: ' + newValue + ', old: ' + oldValue);
});
-
+
obj.value = 20;
transform.deliver(); // 'new: 40, old: 20'
transform.setValue(4); // obj.value === 2;
}
-
+
function Test_ObserverTransform_2() {
var obj = { a: 1, b: 2, c: 3 };
var observer = new CompoundObserver();
@@ -97,12 +97,12 @@ module observejs {
value += values[i]
return value;
});
-
+
// returns 6.
transform.open(function(newValue, oldValue) {
console.log('new: ' + newValue + ', old: ' + oldValue);
});
-
+
obj.a = 2;
obj.c = 10;
transform.deliver(); // 'new: 14, old: 6'
diff --git a/observe-js/observe-js.d.ts b/observe-js/observe-js.d.ts
index abd2caa008..5e453f5671 100644
--- a/observe-js/observe-js.d.ts
+++ b/observe-js/observe-js.d.ts
@@ -231,7 +231,7 @@ declare module observejs {
}
}
-declare module "observejs" {
+declare module "observe-js" {
var PathObserver: typeof observejs.PathObserver;
var ArrayObserver: typeof observejs.ArrayObserver;
var ObjectObserver: typeof observejs.ObjectObserver;
@@ -247,4 +247,4 @@ declare module "observejs" {
ObserverTransform,
Path
};
-}
\ No newline at end of file
+}
diff --git a/office-js/office-js-tests.ts b/office-js/office-js-tests.ts
new file mode 100644
index 0000000000..3e1b0c495f
--- /dev/null
+++ b/office-js/office-js-tests.ts
@@ -0,0 +1,170 @@
+/*
+office-js
+Copyright (c) Microsoft Corporation
+*/
+
+/// <reference path="office-js.d.ts" />
+
+function test_excel() {
+
+ // Range
+ Excel.run(function(ctx) {
+ var range = ctx.workbook.getSelectedRange().load("values");
+ return ctx.sync()
+ .then(function() {
+ var vals = range.values;
+ for (var i = 0; i < vals.length; i++){
+ for (var j = 0; j < vals[i].length; j++){
+ vals[i][j] = vals[i][j].toUpperCase();
+ }
+ }
+ range.values = vals;
+ })
+ .then(ctx.sync);
+ }).catch(function (error) {
+ console.log(error);
+ });
+
+
+ // Chart
+ Excel.run(function (ctx) {
+ var sheet = ctx.workbook.worksheets.getItem("Sheet1");
+
+ var range = sheet.getRange("A1:B3");
+ range.values = [
+ ["", "Gender"],
+ ["Male", 12],
+ ["Female", 14]
+ ];
+
+ var chart = sheet.charts.add("pie", range, "auto");
+
+ chart.format.fill.setSolidColor("F8F8FF");
+
+ chart.title.text = "Class Demographics";
+ chart.title.format.font.bold = true;
+ chart.title.format.font.size = 18;
+ chart.title.format.font.color = "568568";
+
+ chart.legend.position = "right";
+ chart.legend.format.font.name = "Algerian";
+ chart.legend.format.font.size = 13;
+
+ chart.dataLabels.showPercentage = true;
+ chart.dataLabels.format.font.size = 15;
+ chart.dataLabels.format.font.color = "444444";
+
+ var points = chart.series.getItemAt(0).points;
+ points.getItemAt(0).format.fill.setSolidColor("8FBC8F");
+ points.getItemAt(1).format.fill.setSolidColor("D87093");
+
+ return ctx.sync();
+ }).catch(function (error) {
+ console.log(error);
+ });
+
+
+ // Table
+ Excel.run(function (ctx) {
+ var rows = ctx.workbook.tables.getItem("Table1").rows.load("values");
+ return ctx.sync()
+ .then(function () {
+ var largestRow = 0;
+ var largestValue = 0;
+
+ for (var i = 0; i < rows.items.length; i++){
+ if (rows.items[i].values[0][1] > largestValue){
+ largestRow = i;
+ largestValue = rows.items[i].values[0][1];
+ }
+ }
+
+ var largestRowRng = rows.getItemAt(largestRow).getRange();
+ largestRowRng.format.fill.color = "#ff0000";
+
+ })
+ .then(ctx.sync);
+ }).catch(function (error) {
+ console.log(error);
+ });
+
+}
+
+function test_word() {
+
+ // Search
+ Word.run(function (context) {
+
+ // Create a proxy object for the document body.
+ var body = context.document.body;
+
+ // Setup the search options.
+ var options = Word.SearchOptions.newObject(context);
+ options.matchCase = false
+
+ // Queue a commmand to search the document.
+ var searchResults = context.document.body.search('video', options);
+
+ // Queue a commmand to load the results.
+ context.load(searchResults, 'text, font');
+
+ // Synchronize the document state by executing the queued-up commands,
+ // and return a promise to indicate task completion.
+ return context.sync().then(function () {
+ var results = 'Found count: ' + searchResults.items.length +
+ '; we highlighted the results.';
+
+ // Queue a command to change the font for each found item.
+ for (var i = 0; i < searchResults.items.length; i++) {
+ searchResults.items[i].font.color = '#FF0000' // Change color to Red
+ searchResults.items[i].font.highlightColor = '#FFFF00';
+ searchResults.items[i].font.bold = true;
+ }
+
+ // Synchronize the document state by executing the queued-up commands,
+ // and return a promise to indicate task completion.
+ return context.sync().then(function () {
+ console.log(results);
+ });
+ });
+ })
+ .catch(function (error) {
+ console.log('Error: ' + JSON.stringify(error));
+ if (error instanceof OfficeExtension.Error) {
+ console.log('Debug info: ' + JSON.stringify(error.debugInfo));
+ }
+ });
+
+
+ // Content control
+ Word.run(function (context) {
+
+ // Create a proxy range object for the current selection.
+ var range = context.document.getSelection();
+
+ // Queue a commmand to create the content control.
+ var myContentControl = range.insertContentControl();
+ myContentControl.tag = 'Customer-Address';
+ myContentControl.title = 'Enter Customer Address Here:';
+ myContentControl.style = 'Heading 2';
+ myContentControl.insertText('One Microsoft Way, Redmond, WA 98052', 'replace');
+ myContentControl.cannotEdit = true;
+ myContentControl.appearance = 'tags';
+
+ // Queue a command to load the id property for the content control you created.
+ context.load(myContentControl, 'id');
+
+ // Synchronize the document state by executing the queued-up commands,
+ // and return a promise to indicate task completion.
+ return context.sync().then(function () {
+ console.log('Created content control with id: ' + myContentControl.id);
+ });
+ })
+ .catch(function (error) {
+ console.log('Error: ' + JSON.stringify(error));
+ if (error instanceof OfficeExtension.Error) {
+ console.log('Debug info: ' + JSON.stringify(error.debugInfo));
+ }
+ });
+
+}
diff --git a/office-js/office-js.d.ts b/office-js/office-js.d.ts
new file mode 100644
index 0000000000..e82e78fb3f
--- /dev/null
+++ b/office-js/office-js.d.ts
@@ -0,0 +1,5294 @@
+// Type definitions for Office.js
+// Project: http://dev.office.com
+// Definitions by: OfficeDev <https://github.com/OfficeDev>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/*
+office-js
+Copyright (c) Microsoft Corporation
+*/
+
+declare module Office {
+ export var context: Context;
+ /**
+ * This method is called after the Office API was loaded.
+ * @param reason Indicates how the app was initialized
+ */
+ export function initialize(reason: InitializationReason): void;
+ /**
+ * Indicates if the large namespace for objects will be used or not.
+ * @param useShortNamespace Indicates if 'true' that the short namespace will be used
+ */
+ export function useShortNamespace(useShortNamespace: boolean): void;
+ // Enumerations
+ export enum AsyncResultStatus {
+ /**
+ * Operation succeeded
+ */
+ Succeeded,
+ /**
+ * Operation failed, check error object
+ */
+ Failed
+ }
+ export enum InitializationReason {
+ /**
+ * Indicates the app was just inserted in the document
+ */
+ Inserted,
+ /**
+ * Indicates if the extension already existed in the document
+ */
+ DocumentOpened
+ }
+ // Objects
+ export interface AsyncResult {
+ asyncContext: any;
+ status: AsyncResultStatus;
+ error: Error;
+ value: any;
+ }
+ export interface Context {
+ contentLanguage: string;
+ displayLanguage: string;
+ license: string;
+ touchEnabled: boolean;
+ requirements: {
+ /**
+ * Check if the specified requirement set is supported by the host Office application.
+ * @param name - Set name. e.g.: "MatrixBindings".
+ * @param minVersion - The minimum required version.
+ */
+ isSetSupported(name: string, minVersion?: number): boolean;
+ }
+ }
+ export interface Error {
+ message: string;
+ name: string;
+ }
+}
+declare module OfficeExtension {
+ /** An abstract proxy object that represents an object in an Office document. You create proxy objects from the context (or from other proxy objects), add commands to a queue to act on the object, and then synchronize the proxy object state with the document by calling "context.sync()". */
+ class ClientObject {
+ /** The request context associated with the object */
+ context: ClientRequestContext;
+ }
+}
+declare module OfficeExtension {
+ interface LoadOption {
+ select?: string | string[];
+ expand?: string | string[];
+ top?: number;
+ skip?: number;
+ }
+ /** An abstract RequestContext object that facilitates requests to the host Office application. The "Excel.run" and "Word.run" methods provide a request context. */
+ class ClientRequestContext {
+ constructor(url?: string);
+ /** Collection of objects that are tracked for automatic adjustments based on surrounding changes in the document. */
+ trackedObjects: TrackedObjects;
+ /** Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties. */
+ load(object: ClientObject, option?: string | string[] | LoadOption): void;
+ /** Adds a trace message to the queue. If the promise returned by "context.sync()" is rejected due to an error, this adds a ".traceMessages" array to the OfficeExtension.Error object, containing all trace messages that were executed. These messages can help you monitor the program execution sequence and detect the cause of the error. */
+ trace(message: string): void;
+ /** Synchronizes the state between JavaScript proxy objects and the Office document, by executing instructions queued on the request context and retrieving properties of loaded Office objects for use in your code.�This method returns a promise, which is resolved when the synchronization is complete. */
+ sync<T>(passThroughValue?: T): IPromise<T>;
+ }
+}
+declare module OfficeExtension {
+ /** Contains the result for methods that return primitive types. The object's value property is retrieved from the document after "context.sync()" is invoked. */
+ class ClientResult<T> {
+ /** The value of the result that is retrieved from the document after "context.sync()" is invoked. */
+ value: T;
+ }
+}
+declare module OfficeExtension {
+ /** The error object returned by "context.sync()", if a promise is rejected due to an error while processing the request. */
+ class Error {
+ /** Error name: "OfficeExtension.Error".*/
+ name: string;
+ /** The error message passed through from the host Office application. */
+ message: string;
+ /** Stack trace, if applicable. */
+ stack: string;
+ /** Error code string, such as "InvalidArgument". */
+ code: string;
+ /** Trace messages (if any) that were added via a "context.trace()" invocation before calling "context.sync()". If there was an error, this contains all trace messages that were executed before the error occurred. These messages can help you monitor the program execution sequence and detect the case of the error. */
+ traceMessages: Array<string>;
+ /** Debug info, if applicable. The ".errorLocation" property can describe the object and method or property that caused the error. */
+ debugInfo: {
+ /** If applicable, will return the object type and the name of the method or property that caused the error. */
+ errorLocation?: string;
+ };
+ }
+}
+declare module OfficeExtension {
+ class ErrorCodes {
+ static accessDenied: string;
+ static generalException: string;
+ static activityLimitReached: string;
+ }
+}
+declare module OfficeExtension {
+ /** A Promise object that represents a deferred interaction with the host Office application. Promises can be chained via ".then", and errors can be caught via ".catch". Remember to always use a ".catch" on the outer promise, and to return intermediary promises so as not to break the promise chain. */
+ interface IPromise<R> {
+ /**
+ * This method will be called once the previous promise has been resolved.
+ * Both the onFulfilled on onRejected callbacks are optional.
+ * If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
+ * @returns A new promise for the value or error that was returned from onFulfilled/onRejected.
+ */
+ then<U>(onFulfilled?: (value: R) => IPromise<U>, onRejected?: (error: any) => IPromise<U>): IPromise<U>;
+ /**
+ * This method will be called once the previous promise has been resolved.
+ * Both the onFulfilled on onRejected callbacks are optional.
+ * If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
+ * @returns A new promise for the value or error that was returned from onFulfilled/onRejected.
+ */
+ then<U>(onFulfilled?: (value: R) => IPromise<U>, onRejected?: (error: any) => U): IPromise<U>;
+ /**
+ * This method will be called once the previous promise has been resolved.
+ * Both the onFulfilled on onRejected callbacks are optional.
+ * If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
+ * @returns A new promise for the value or error that was returned from onFulfilled/onRejected.
+ */
+ then<U>(onFulfilled?: (value: R) => IPromise<U>, onRejected?: (error: any) => void): IPromise<U>;
+ /**
+ * This method will be called once the previous promise has been resolved.
+ * Both the onFulfilled on onRejected callbacks are optional.
+ * If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
+ * @returns A new promise for the value or error that was returned from onFulfilled/onRejected.
+ */
+ then<U>(onFulfilled?: (value: R) => U, onRejected?: (error: any) => IPromise<U>): IPromise<U>;
+ /**
+ * This method will be called once the previous promise has been resolved.
+ * Both the onFulfilled on onRejected callbacks are optional.
+ * If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
+ * @returns A new promise for the value or error that was returned from onFulfilled/onRejected.
+ */
+ then<U>(onFulfilled?: (value: R) => U, onRejected?: (error: any) => U): IPromise<U>;
+ /**
+ * This method will be called once the previous promise has been resolved.
+ * Both the onFulfilled on onRejected callbacks are optional.
+ * If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
+ * @returns A new promise for the value or error that was returned from onFulfilled/onRejected.
+ */
+ then<U>(onFulfilled?: (value: R) => U, onRejected?: (error: any) => void): IPromise<U>;
+ /**
+ * Catches failures or exceptions from actions within the promise, or from an unhandled exception earlier in the call stack.
+ * @param onRejected function to be called if or when the promise rejects.
+ */
+ catch<U>(onRejected?: (error: any) => IPromise<U>): IPromise<U>;
+ /**
+ * Catches failures or exceptions from actions within the promise, or from an unhandled exception earlier in the call stack.
+ * @param onRejected function to be called if or when the promise rejects.
+ */
+ catch<U>(onRejected?: (error: any) => U): IPromise<U>;
+ /**
+ * Catches failures or exceptions from actions within the promise, or from an unhandled exception earlier in the call stack.
+ * @param onRejected function to be called if or when the promise rejects.
+ */
+ catch<U>(onRejected?: (error: any) => void): IPromise<U>;
+ }
+}
+declare module OfficeExtension {
+ /** Collection of tracked objects, contained within a request context. See "context.trackedObjects" for more information. */
+ class TrackedObjects {
+ /** Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */
+ add(object: ClientObject): void;
+ /** Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */
+ add(objects: ClientObject[]): void;
+ /** Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */
+ remove(object: ClientObject): void;
+ /** Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect. */
+ remove(objects: ClientObject[]): void;
+ }
+}
+
+declare module Office {
+ /**
+ * Returns a promise of an object described in the expression. Callback is invoked only if method fails.
+ * @param expression The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'
+ * @param callback The optional callback method
+ */
+ export function select(expression: string, callback?: (result: AsyncResult) => void): Binding;
+ // Enumerations
+ export enum ActiveView {
+ Read,
+ Edit
+ }
+ export enum BindingType {
+ /**
+ * Text based Binding
+ */
+ Text,
+ /**
+ * Matrix based Binding
+ */
+ Matrix,
+ /**
+ * Table based Binding
+ */
+ Table
+ }
+ export enum CoercionType {
+ /**
+ * Coerce as Text
+ */
+ Text,
+ /**
+ * Coerce as Matrix
+ */
+ Matrix,
+ /**
+ * Coerce as Table
+ */
+ Table,
+ /**
+ * Coerce as HTML
+ */
+ Html,
+ /**
+ * Coerce as Office Open XML
+ */
+ Ooxml,
+ /**
+ * Coerce as JSON object containing an array of the ids, titles, and indexes of the selected slides.
+ */
+ SlideRange
+ }
+ export enum DocumentMode {
+ /**
+ * Document in Read Only Mode
+ */
+ ReadOnly,
+ /**
+ * Document in Read/Write Mode
+ */
+ ReadWrite
+ }
+ export enum EventType {
+ /**
+ * Occurs when the user changes the current view of the document.
+ */
+ ActiveViewChanged,
+ /**
+ * Triggers when a binding level data change happens
+ */
+ BindingDataChanged,
+ /**
+ * Triggers when a binding level selection happens
+ */
+ BindingSelectionChanged,
+ /**
+ * Triggers when a document level selection happens
+ */
+ DocumentSelectionChanged,
+ /**
+ * Triggers when a customXmlPart node was deleted
+ */
+ NodeDeleted,
+ /**
+ * Triggers when a customXmlPart node was inserted
+ */
+ NodeInserted,
+ /**
+ * Triggers when a customXmlPart node was replaced
+ */
+ NodeReplaced,
+ /**
+ * Triggers when settings change in a co-Auth session.
+ */
+ SettingsChanged,
+ /**
+ * Triggers when a Task selection happens in Project.
+ */
+ TaskSelectionChanged,
+ /**
+ * Triggers when a Resource selection happens in Project.
+ */
+ ResourceSelectionChanged,
+ /**
+ * Triggers when a View selection happens in Project.
+ */
+ ViewSelectionChanged
+ }
+ export enum FileType {
+ /**
+ * Returns the file as plain text
+ */
+ Text,
+ /**
+ * Returns the file as a byte array
+ */
+ Compressed,
+ /**
+ * Returns the file in PDF format as a byte array
+ */
+ Pdf
+ }
+ export enum FilterType {
+ /**
+ * Returns all items
+ */
+ All,
+ /**
+ * Returns only visible items
+ */
+ OnlyVisible
+ }
+ export enum GoToType {
+ /**
+ * Goes to a binding object using the specified binding id.
+ */
+ Binding,
+ /**
+ * Goes to a named item using that item's name.
+ * In Excel, you can use any structured reference for a named range or table: "Worksheet2!Table1"
+ */
+ NamedItem,
+ /**
+ * Goes to a slide using the specified id.
+ */
+ Slide,
+ /**
+ * Goes to the specified index by slide number or enum Office.Index
+ */
+ Index
+ }
+ export enum Index {
+ First,
+ Last,
+ Next,
+ Previous
+ }
+ export enum SelectionMode {
+ Default,
+ Selected,
+ None
+ }
+ export enum ValueFormat {
+ /**
+ * Returns items without format
+ */
+ Unformatted,
+ /**
+ * Returns items with format
+ */
+ Formatted
+ }
+ // Objects
+ export interface Binding {
+ document: Document;
+ /**
+ * Id of the Binding
+ */
+ id: string;
+ type: BindingType;
+ /**
+ * Adds an event handler to the object using the specified event type.
+ * @param eventType The event type. For binding it can be 'bindingDataChanged' and 'bindingSelectionChanged'
+ * @param handler The name of the handler
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addHandlerAsync(eventType: EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Returns the current selection.
+ * @param options Syntax example: {coercionType: 'matrix,'valueFormat: 'formatted', filterType:'all'}
+ * coercionType: The expected shape of the selection. If not specified returns the bindingType shape. Use Office.CoercionType or text value.
+ * valueFormat: Get data with or without format. Use Office.ValueFormat or text value.
+ * startRow: Used in partial get for table/matrix. Indicates the start row.
+ * startColumn: Used in partial get for table/matrix. Indicates the start column.
+ * rowCount: Used in partial get for table/matrix. Indicates the number of rows from the start row.
+ * columnCount: Used in partial get for table/matrix. Indicates the number of columns from the start column.
+ * filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value.
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getDataAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes an event handler from the object using the specified event type.
+ * @param eventType The event type. For binding can be 'bindingDataChanged' and 'bindingSelectionChanged'
+ * @param options Syntax example: {handler:eventHandler}
+ * handler: Indicates a specific handler to be removed, if not specified all handlers are removed
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Writes the specified data into the current selection.
+ * @param data The data to be set. Either a string or value, 2d array or TableData object
+ * @param options Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'}
+ * coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type.
+ * startRow: Used in partial set for table/matrix. Indicates the start row.
+ * startColumn: Used in partial set for table/matrix. Indicates the start column.
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setDataAsync(data: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface Bindings {
+ document: Document;
+ /**
+ * Creates a binding against a named object in the document
+ * @param itemName Name of the bindable object in the document. For Example 'MyExpenses' table in Excel."
+ * @param bindingType The Office BindingType for the data
+ * @param options Syntax example: {id: "BindingID"}
+ * id: Name of the binding, autogenerated if not supplied.
+ * asyncContext: Object keeping state for the callback
+ * columns: The string[] of the columns involved in the binding
+ * @param callback The optional callback method
+ */
+ addFromNamedItemAsync(itemName: string, bindingType: BindingType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Create a binding by prompting the user to make a selection on the document.
+ * @param bindingType The Office BindingType for the data
+ * @param options addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"}
+ * promptText: Greet your users with a friendly word.
+ * asyncContext: Object keeping state for the callback
+ * id: Identifier.
+ * sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string.
+ * @param callback The optional callback method
+ */
+ addFromPromptAsync(bindingType: BindingType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Create a binding based on what the user's current selection.
+ * @param bindingType The Office BindingType for the data
+ * @param options addFromSelectionAsyncOptions- e.g. {id: "BindingID"}
+ * id: Identifier.
+ * asyncContext: Object keeping state for the callback
+ * columns: The string[] of the columns involved in the binding
+ * sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string.
+ * @param callback The optional callback method
+ */
+ addFromSelectionAsync(bindingType: BindingType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets an array with all the binding objects in the document.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getAllAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Retrieves a binding based on its Name
+ * @param id The binding id
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getByIdAsync(id: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes the binding from the document
+ * @param id The binding id
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ releaseByIdAsync(id: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface Bindings {
+ /**
+ * Gets a value that indicates whether the content is in HTML or text format.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getTypeAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Adds the specified content to the beginning of the item body
+ * @param data The string to be inserted at the beginning of the body
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ prependAsync(data: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Replaces the selection in the body with the specified text
+ * @param data The string to be inserted at the beginning of the body
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setSelectedDataAsync(data: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface Context {
+ document: Document;
+ }
+ export interface CustomXmlNode {
+ baseName: string;
+ namespaceUri: string;
+ nodeType: string;
+ /**
+ * Gets the nodes associated with the xPath expression.
+ * @param xPath The xPath expression
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getNodesAsync(xPath: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the node value.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getNodeValueAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the node's XML.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getXmlAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Sets the node value.
+ * @param value The value to be set on the node
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setNodeValueAsync(value: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Sets the node XML.
+ * @param xml The XML to be set on the node
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setXmlAsync(xml: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface CustomXmlPart {
+ builtIn: boolean;
+ id: string;
+ namespaceManager: CustomXmlPrefixMappings;
+ /**
+ * Adds an event handler to the object using the specified event type.
+ * @param eventType The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced'
+ * @param handler The name of the handler
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addHandlerAsync(eventType: EventType, handler?: (result: any) => void, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Deletes the Custom XML Part.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ deleteAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the nodes associated with the xPath expression.
+ * @param xPath The xPath expression
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getNodesAsync(xPath: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the XML for the Custom XML Part.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getXmlAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes an event handler from the object using the specified event type.
+ * @param eventType The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced'
+ * @param options Syntax example: {handler:eventHandler}
+ * handler: Indicates a specific handler to be removed, if not specified all handlers are removed
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface CustomXmlParts {
+ /**
+ * Asynchronously adds a new custom XML part to a file.
+ * @param xml The XML to add to the newly created custom XML part.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ */
+ addAsync(xml: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Asynchronously gets the specified custom XML part by its id.
+ * @param id The id of the custom XML part.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ */
+ getByIdAsync(id: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Asynchronously gets the specified custom XML part(s) by its namespace.
+ * @param ns The namespace to search.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.
+ */
+ getByNamespaceAsync(ns: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface CustomXmlPrefixMappings {
+ /**
+ * Adds a namespace.
+ * @param prefix The namespace prefix
+ * @param ns The namespace URI
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addNamespaceAsync(prefix: string, ns: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets a namespace with the specified prefix
+ * @param prefix The namespace prefix
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getNamespaceAsync(prefix: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets a prefix for the specified URI
+ * @param ns The namespace URI
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getPrefixAsync(ns: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface Document {
+ bindings: Bindings;
+ customXmlParts: CustomXmlParts;
+ mode: DocumentMode;
+ settings: Settings;
+ url: string;
+ /**
+ * Adds an event handler for the specified event type.
+ * @param eventType The event type. For document can be 'DocumentSelectionChanged'
+ * @param handler The name of the handler
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addHandlerAsync(eventType: EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Returns the current view of the presentation.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getActiveViewAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the entire file in slices of up to 4MB.
+ * @param fileType The format in which the file will be returned
+ * @param options Syntax example: {sliceSize:1024}
+ * sliceSize: Specifies the desired slice size (in bytes) up to 4MB. If not specified a default slice size of 4MB will be used.
+ * @param callback The optional callback method
+ */
+ getFileAsync(fileType: FileType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets file properties of the current document.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getFilePropertiesAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Returns the current selection.
+ * @param coercionType The expected shape of the selection.
+ * @param options Syntax example: {valueFormat: 'formatted', filterType:'all'}
+ * valueFormat: Get data with or without format. Use Office.ValueFormat or text value.
+ * filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value.
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getSelectedDataAsync(coercionType: CoercionType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Goes to the specified object or location in the document.
+ * @param id The identifier of the object or location to go to.
+ * @param goToType The type of the location to go to.
+ * @param options Syntax example: {asyncContext:context}
+ * selectionMode: Use Office.SelectionMode or text value.
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ goToByIdAsync(id: string, goToType: GoToType, options?: any, callback?: (result: AsyncResult) => void): void;
+ goToByIdAsync(id: number, goToType: GoToType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes an event handler for the specified event type.
+ * @param eventType The event type. For document can be 'DocumentSelectionChanged'
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * handler: The name of the handler. If not specified all handlers are removed
+ * @param callback The optional callback method
+ */
+ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Writes the specified data into the current selection.
+ * @param data The data to be set. Either a string or value, 2d array or TableData object
+ * @param options Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'}
+ * coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type.
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setSelectedDataAsync(data: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface File {
+ size: number;
+ sliceCount: number;
+ /**
+ * Closes the File.
+ * @param callback The optional callback method
+ */
+ closeAsync(callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the specified slice.
+ * @param sliceIndex The index of the slice to be retrieved
+ * @param callback The optional callback method
+ */
+ getSliceAsync(sliceIndex: number, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface FileProperties {
+ /**
+ * File's URL
+ */
+ url: string
+ }
+ export interface MatrixBinding extends Binding {
+ columnCount: number;
+ rowCount: number;
+ }
+ export interface Settings {
+ /**
+ * Adds an event handler for the object using the specified event type.
+ * @param eventType The event type. For settings can be 'settingsChanged'
+ * @param handler The name of the handler
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addHandlerAsync(eventType: EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Retrieves the setting with the specified name.
+ * @param settingName The name of the setting
+ */
+ get(name: string): any;
+ /**
+ * Gets the latest version of the settings object.
+ * @param callback The optional callback method
+ */
+ refreshAsync(callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes the setting with the specified name.
+ * @param settingName The name of the setting
+ */
+ remove(name: string): void;
+ /**
+ * Removes an event handler for the specified event type.
+ * @param eventType The event type. For settings can be 'settingsChanged'
+ * @param options Syntax example: {handler:eventHandler}
+ * handler: Indicates a specific handler to be removed, if not specified all handlers are removed
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ removeHandlerAsync(eventType: EventType, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Saves all settings.
+ * @param options Syntax example: {overwriteIfStale:false}
+ * overwriteIfStale: Indicates whether the setting will be replaced if stale.
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ saveAsync(callback?: (result: AsyncResult) => void): void;
+ /**
+ * Sets a value for the setting with the specified name.
+ * @param settingName The name of the setting
+ * @param value The value for the setting
+ */
+ set(name: string, value: any): void;
+ }
+ export interface Slice {
+ data: any;
+ index: number;
+ size: number;
+ }
+ export interface TableBinding extends Binding {
+ columnCount: number;
+ hasHeaders: boolean;
+ rowCount: number;
+ /**
+ * Adds the specified columns to the table
+ * @param tableData A TableData object with the headers and rows
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addColumnsAsync(tableData: TableData, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Adds the specified rows to the table
+ * @param rows A 2D array with the rows to add
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ addRowsAsync(rows: any[][], options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Clears the table
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ deleteAllDataValuesAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Clears formatting on the bound table.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ clearFormatsAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Gets the formatting on specified items in the table.
+ * @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
+ * @param formats An array specifying the format properties to get.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getFormatsAsync(cellReference?: any, formats?: any[], options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Sets formatting on specified items and data in the table.
+ * @param formatsInfo Array elements are themselves three-element arrays:[target, type, formats]
+ * target: The identifier of the item to format. String.
+ * type: The kind of item to format. String.
+ * formats: An object literal containing a list of property name-value pairs that define the formatting to apply.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setFormatsAsync(formatsInfo?: any[][], options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Updates table formatting options on the bound table.
+ * @param tableOptions An object literal containing a list of property name-value pairs that define the table options to apply.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ setTableOptionsAsync(tableOptions: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export class TableData {
+ constructor(rows: any[][], headers: any[][]);
+ headers: any[][];
+ rows: any[][];
+ }
+ export interface TextBinding extends Binding { }
+ export enum ProjectProjectFields {
+ CurrencyDigits,
+ CurrencySymbol,
+ CurrencySymbolPosition,
+ DurationUnits,
+ GUID,
+ Finish,
+ Start,
+ ReadOnly,
+ VERSION,
+ WorkUnits,
+ ProjectServerUrl,
+ WSSUrl,
+ WSSList
+ }
+ export enum ProjectResourceFields {
+ Accrual,
+ ActualCost,
+ ActualOvertimeCost,
+ ActualOvertimeWork,
+ ActualOvertimeWorkProtected,
+ ActualWork,
+ ActualWorkProtected,
+ BaseCalendar,
+ Baseline10BudgetCost,
+ Baseline10BudgetWork,
+ Baseline10Cost,
+ Baseline10Work,
+ Baseline1BudgetCost,
+ Baseline1BudgetWork,
+ Baseline1Cost,
+ Baseline1Work,
+ Baseline2BudgetCost,
+ Baseline2BudgetWork,
+ Baseline2Cost,
+ Baseline2Work,
+ Baseline3BudgetCost,
+ Baseline3BudgetWork,
+ Baseline3Cost,
+ Baseline3Work,
+ Baseline4BudgetCost,
+ Baseline4BudgetWork,
+ Baseline4Cost,
+ Baseline4Work,
+ Baseline5BudgetCost,
+ Baseline5BudgetWork,
+ Baseline5Cost,
+ Baseline5Work,
+ Baseline6BudgetCost,
+ Baseline6BudgetWork,
+ Baseline6Cost,
+ Baseline6Work,
+ Baseline7BudgetCost,
+ Baseline7BudgetWork,
+ Baseline7Cost,
+ Baseline7Work,
+ Baseline8BudgetCost,
+ Baseline8BudgetWork,
+ Baseline8Cost,
+ Baseline8Work,
+ Baseline9BudgetCost,
+ Baseline9BudgetWork,
+ Baseline9Cost,
+ Baseline9Work,
+ BaselineBudgetCost,
+ BaselineBudgetWork,
+ BaselineCost,
+ BaselineWork,
+ BudgetCost,
+ BudgetWork,
+ ResourceCalendarGUID,
+ Code,
+ Cost1,
+ Cost10,
+ Cost2,
+ Cost3,
+ Cost4,
+ Cost5,
+ Cost6,
+ Cost7,
+ Cost8,
+ Cost9,
+ ResourceCreationDate,
+ Date1,
+ Date10,
+ Date2,
+ Date3,
+ Date4,
+ Date5,
+ Date6,
+ Date7,
+ Date8,
+ Date9,
+ Duration1,
+ Duration10,
+ Duration2,
+ Duration3,
+ Duration4,
+ Duration5,
+ Duration6,
+ Duration7,
+ Duration8,
+ Duration9,
+ Email,
+ End,
+ Finish1,
+ Finish10,
+ Finish2,
+ Finish3,
+ Finish4,
+ Finish5,
+ Finish6,
+ Finish7,
+ Finish8,
+ Finish9,
+ Flag10,
+ Flag1,
+ Flag11,
+ Flag12,
+ Flag13,
+ Flag14,
+ Flag15,
+ Flag16,
+ Flag17,
+ Flag18,
+ Flag19,
+ Flag2,
+ Flag20,
+ Flag3,
+ Flag4,
+ Flag5,
+ Flag6,
+ Flag7,
+ Flag8,
+ Flag9,
+ Group,
+ Units,
+ Name,
+ Notes,
+ Number1,
+ Number10,
+ Number11,
+ Number12,
+ Number13,
+ Number14,
+ Number15,
+ Number16,
+ Number17,
+ Number18,
+ Number19,
+ Number2,
+ Number20,
+ Number3,
+ Number4,
+ Number5,
+ Number6,
+ Number7,
+ Number8,
+ Number9,
+ OvertimeCost,
+ OvertimeRate,
+ OvertimeWork,
+ PercentWorkComplete,
+ CostPerUse,
+ Generic,
+ OverAllocated,
+ RegularWork,
+ RemainingCost,
+ RemainingOvertimeCost,
+ RemainingOvertimeWork,
+ RemainingWork,
+ ResourceGUID,
+ Cost,
+ Work,
+ Start,
+ Start1,
+ Start10,
+ Start2,
+ Start3,
+ Start4,
+ Start5,
+ Start6,
+ Start7,
+ Start8,
+ Start9,
+ StandardRate,
+ Text1,
+ Text10,
+ Text11,
+ Text12,
+ Text13,
+ Text14,
+ Text15,
+ Text16,
+ Text17,
+ Text18,
+ Text19,
+ Text2,
+ Text20,
+ Text21,
+ Text22,
+ Text23,
+ Text24,
+ Text25,
+ Text26,
+ Text27,
+ Text28,
+ Text29,
+ Text3,
+ Text30,
+ Text4,
+ Text5,
+ Text6,
+ Text7,
+ Text8,
+ Text9
+ }
+ export enum ProjectTaskFields {
+ ActualCost,
+ ActualDuration,
+ ActualFinish,
+ ActualOvertimeCost,
+ ActualOvertimeWork,
+ ActualStart,
+ ActualWork,
+ Text1,
+ Text10,
+ Finish10,
+ Start10,
+ Text11,
+ Text12,
+ Text13,
+ Text14,
+ Text15,
+ Text16,
+ Text17,
+ Text18,
+ Text19,
+ Finish1,
+ Start1,
+ Text2,
+ Text20,
+ Text21,
+ Text22,
+ Text23,
+ Text24,
+ Text25,
+ Text26,
+ Text27,
+ Text28,
+ Text29,
+ Finish2,
+ Start2,
+ Text3,
+ Text30,
+ Finish3,
+ Start3,
+ Text4,
+ Finish4,
+ Start4,
+ Text5,
+ Finish5,
+ Start5,
+ Text6,
+ Finish6,
+ Start6,
+ Text7,
+ Finish7,
+ Start7,
+ Text8,
+ Finish8,
+ Start8,
+ Text9,
+ Finish9,
+ Start9,
+ Baseline10BudgetCost,
+ Baseline10BudgetWork,
+ Baseline10Cost,
+ Baseline10Duration,
+ Baseline10Finish,
+ Baseline10FixedCost,
+ Baseline10FixedCostAccrual,
+ Baseline10Start,
+ Baseline10Work,
+ Baseline1BudgetCost,
+ Baseline1BudgetWork,
+ Baseline1Cost,
+ Baseline1Duration,
+ Baseline1Finish,
+ Baseline1FixedCost,
+ Baseline1FixedCostAccrual,
+ Baseline1Start,
+ Baseline1Work,
+ Baseline2BudgetCost,
+ Baseline2BudgetWork,
+ Baseline2Cost,
+ Baseline2Duration,
+ Baseline2Finish,
+ Baseline2FixedCost,
+ Baseline2FixedCostAccrual,
+ Baseline2Start,
+ Baseline2Work,
+ Baseline3BudgetCost,
+ Baseline3BudgetWork,
+ Baseline3Cost,
+ Baseline3Duration,
+ Baseline3Finish,
+ Baseline3FixedCost,
+ Baseline3FixedCostAccrual,
+ Basline3Start,
+ Baseline3Work,
+ Baseline4BudgetCost,
+ Baseline4BudgetWork,
+ Baseline4Cost,
+ Baseline4Duration,
+ Baseline4Finish,
+ Baseline4FixedCost,
+ Baseline4FixedCostAccrual,
+ Baseline4Start,
+ Baseline4Work,
+ Baseline5BudgetCost,
+ Baseline5BudgetWork,
+ Baseline5Cost,
+ Baseline5Duration,
+ Baseline5Finish,
+ Baseline5FixedCost,
+ Baseline5FixedCostAccrual,
+ Baseline5Start,
+ Baseline5Work,
+ Baseline6BudgetCost,
+ Baseline6BudgetWork,
+ Baseline6Cost,
+ Baseline6Duration,
+ Baseline6Finish,
+ Baseline6FixedCost,
+ Baseline6FixedCostAccrual,
+ Baseline6Start,
+ Baseline6Work,
+ Baseline7BudgetCost,
+ Baseline7BudgetWork,
+ Baseline7Cost,
+ Baseline7Duration,
+ Baseline7Finish,
+ Baseline7FixedCost,
+ Baseline7FixedCostAccrual,
+ Baseline7Start,
+ Baseline7Work,
+ Baseline8BudgetCost,
+ Baseline8BudgetWork,
+ Baseline8Cost,
+ Baseline8Duration,
+ Baseline8Finish,
+ Baseline8FixedCost,
+ Baseline8FixedCostAccrual,
+ Baseline8Start,
+ Baseline8Work,
+ Baseline9BudgetCost,
+ Baseline9BudgetWork,
+ Baseline9Cost,
+ Baseline9Duration,
+ Baseline9Finish,
+ Baseline9FixedCost,
+ Baseline9FixedCostAccrual,
+ Baseline9Start,
+ Baseline9Work,
+ BaselineBudgetCost,
+ BaselineBudgetWork,
+ BaselineCost,
+ BaselineDuration,
+ BaselineFinish,
+ BaselineFixedCost,
+ BaselineFixedCostAccrual,
+ BaselineStart,
+ BaselineWork,
+ BudgetCost,
+ BudgetFixedCost,
+ BudgetFixedWork,
+ BudgetWork,
+ TaskCalendarGUID,
+ ConstraintDate,
+ ConstraintType,
+ Cost1,
+ Cost10,
+ Cost2,
+ Cost3,
+ Cost4,
+ Cost5,
+ Cost6,
+ Cost7,
+ Cost8,
+ Cost9,
+ Date1,
+ Date10,
+ Date2,
+ Date3,
+ Date4,
+ Date5,
+ Date6,
+ Date7,
+ Date8,
+ Date9,
+ Deadline,
+ Duration1,
+ Duration10,
+ Duration2,
+ Duration3,
+ Duration4,
+ Duration5,
+ Duration6,
+ Duration7,
+ Duration8,
+ Duration9,
+ Duration,
+ EarnedValueMethod,
+ FinishSlack,
+ FixedCost,
+ FixedCostAccrual,
+ Flag10,
+ Flag1,
+ Flag11,
+ Flag12,
+ Flag13,
+ Flag14,
+ Flag15,
+ Flag16,
+ Flag17,
+ Flag18,
+ Flag19,
+ Flag2,
+ Flag20,
+ Flag3,
+ Flag4,
+ Flag5,
+ Flag6,
+ Flag7,
+ Flag8,
+ Flag9,
+ FreeSlack,
+ HasRollupSubTasks,
+ ID,
+ Name,
+ Notes,
+ Number1,
+ Number10,
+ Number11,
+ Number12,
+ Number13,
+ Number14,
+ Number15,
+ Number16,
+ Number17,
+ Number18,
+ Number19,
+ Number2,
+ Number20,
+ Number3,
+ Number4,
+ Number5,
+ Number6,
+ Number7,
+ Number8,
+ Number9,
+ ScheduledDuration,
+ ScheduledFinish,
+ ScheduledStart,
+ OutlineLevel,
+ OvertimeCost,
+ OvertimeWork,
+ PercentComplete,
+ PercentWorkComplete,
+ Predecessors,
+ PreleveledFinish,
+ PreleveledStart,
+ Priority,
+ Active,
+ Critical,
+ Milestone,
+ Overallocated,
+ IsRollup,
+ Summary,
+ RegularWork,
+ RemainingCost,
+ RemainingDuration,
+ RemainingOvertimeCost,
+ RemainingWork,
+ ResourceNames,
+ Cost,
+ Finish,
+ Start,
+ Work,
+ StartSlack,
+ Status,
+ Successors,
+ StatusManager,
+ TotalSlack,
+ TaskGUID,
+ Type,
+ WBS,
+ WBSPREDECESSORS,
+ WBSSUCCESSORS,
+ WSSID
+ }
+ export enum ProjectViewTypes {
+ Gantt,
+ NetworkDiagram,
+ TaskDiagram,
+ TaskForm,
+ TaskSheet,
+ ResourceForm,
+ ResourceSheet,
+ ResourceGraph,
+ TeamPlanner,
+ TaskDetails,
+ TaskNameForm,
+ ResourceNames,
+ Calendar,
+ TaskUsage,
+ ResourceUsage,
+ Timeline
+ }
+ // Objects
+ export interface Document {
+ /**
+ * Get Project field (Ex. ProjectWebAccessURL).
+ * @param fieldId Project level fields.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getProjectFieldAsync(fieldId: number, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get resource field for provided resource Id. (Ex.ResourceName)
+ * @param resourceId Either a string or value of the Resource Id.
+ * @param fieldId Resource Fields.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getResourceFieldAsync(resourceId: string, fieldId: number, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get the current selected Resource's Id.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getSelectedResourceAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get the current selected Task's Id.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getSelectedTaskAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get the current selected View Type (Ex. Gantt) and View Name.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getSelectedViewAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get the Task Name, WSS Task Id, and ResourceNames for given taskId.
+ * @param taskId Either a string or value of the Task Id.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getTaskAsync(taskId: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get task field for provided task Id. (Ex. StartDate).
+ * @param taskId Either a string or value of the Task Id.
+ * @param fieldId Task Fields.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getTaskFieldAsync(taskId: string, fieldId: number, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Get the WSS Url and list name for the Tasks List, the MPP is synced too.
+ * @param options Syntax example: {asyncContext:context}
+ * asyncContext: Object keeping state for the callback
+ * @param callback The optional callback method
+ */
+ getWSSUrlAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+}
+
+
+declare module Excel {
+ /**
+ *
+ * Represents the Excel application that manages the workbook.
+ */
+ class Application extends OfficeExtension.ClientObject {
+ private m_calculationMode;
+ /**
+ *
+ * Returns the calculation mode used in the workbook. See Excel.CalculationMode for details. Read-only.
+ */
+ calculationMode: string;
+ /**
+ *
+ * Recalculate all currently opened workbooks in Excel.
+ *
+ * @param calculationType Specifies the calculation type to use. See Excel.CalculationType for details.
+ */
+ calculate(calculationType: string): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Application;
+ }
+ /**
+ *
+ * Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.
+ */
+ class Workbook extends OfficeExtension.ClientObject {
+ private m_application;
+ private m_bindings;
+ private m_names;
+ private m_tables;
+ private m_worksheets;
+ /**
+ *
+ * Represents Excel application instance that contains this workbook. Read-only.
+ */
+ application: Excel.Application;
+ /**
+ *
+ * Represents a collection of bindings that are part of the workbook. Read-only.
+ */
+ bindings: Excel.BindingCollection;
+ /**
+ *
+ * Represents a collection of workbook scoped named items (named ranges and constants). Read-only.
+ */
+ names: Excel.NamedItemCollection;
+ /**
+ *
+ * Represents a collection of tables associated with the workbook. Read-only.
+ */
+ tables: Excel.TableCollection;
+ /**
+ *
+ * Represents a collection of worksheets associated with the workbook. Read-only.
+ */
+ worksheets: Excel.WorksheetCollection;
+ /**
+ *
+ * Gets the currently selected range from the workbook.
+ *
+ */
+ getSelectedRange(): Excel.Range;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Workbook;
+ }
+ /**
+ *
+ * An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.
+ */
+ class Worksheet extends OfficeExtension.ClientObject {
+ private m_charts;
+ private m_id;
+ private m_name;
+ private m_position;
+ private m_tables;
+ private m_visibility;
+ /**
+ *
+ * Returns collection of charts that are part of the worksheet. Read-only.
+ */
+ charts: Excel.ChartCollection;
+ /**
+ *
+ * Collection of tables that are part of the worksheet. Read-only.
+ */
+ tables: Excel.TableCollection;
+ /**
+ *
+ * Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only.
+ */
+ id: string;
+ /**
+ *
+ * The display name of the worksheet.
+ */
+ name: string;
+ /**
+ *
+ * The zero-based position of the worksheet within the workbook.
+ */
+ position: number;
+ /**
+ *
+ * The Visibility of the worksheet, Read-only.
+ */
+ visibility: string;
+ /**
+ *
+ * Activate the worksheet in the Excel UI.
+ *
+ */
+ activate(): void;
+ /**
+ *
+ * Deletes the worksheet from the workbook.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid.
+ *
+ * @param row The row number of the cell to be retrieved. Zero-indexed.
+ * @param column the column number of the cell to be retrieved. Zero-indexed.
+ */
+ getCell(row: number, column: number): Excel.Range;
+ /**
+ *
+ * Gets the range object specified by the address or name.
+ *
+ * @param address The address or the name of the range. If not specified, the entire worksheet range is returned.
+ */
+ getRange(address?: string): Excel.Range;
+ /**
+ *
+ * The used range is the smallest range than encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell.
+ *
+ */
+ getUsedRange(): Excel.Range;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Worksheet;
+ }
+ /**
+ *
+ * Represents a collection of worksheet objects that are part of the workbook.
+ */
+ class WorksheetCollection extends OfficeExtension.ClientObject {
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.Worksheet>;
+ /**
+ *
+ * Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call ".activate() on it.
+ *
+ * @param name The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.
+ */
+ add(name?: string): Excel.Worksheet;
+ /**
+ *
+ * Gets the currently active worksheet in the workbook.
+ *
+ */
+ getActiveWorksheet(): Excel.Worksheet;
+ /**
+ *
+ * Gets a worksheet object using its Name or ID.
+ *
+ * @param key The Name or ID of the worksheet.
+ */
+ getItem(key: string): Excel.Worksheet;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.WorksheetCollection;
+ }
+ /**
+ *
+ * Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc.
+ */
+ class Range extends OfficeExtension.ClientObject {
+ private m_address;
+ private m_addressLocal;
+ private m_cellCount;
+ private m_columnCount;
+ private m_columnIndex;
+ private m_format;
+ private m_formulas;
+ private m_formulasLocal;
+ private m_numberFormat;
+ private m_rowCount;
+ private m_rowIndex;
+ private m_text;
+ private m_valueTypes;
+ private m_values;
+ private m_worksheet;
+ private m__ReferenceId;
+ /**
+ *
+ * Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. Read-only.
+ */
+ format: Excel.RangeFormat;
+ /**
+ *
+ * The worksheet containing the current range. Read-only.
+ */
+ worksheet: Excel.Worksheet;
+ /**
+ *
+ * Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only.
+ */
+ address: string;
+ /**
+ *
+ * Represents range reference for the specified range in the language of the user. Read-only.
+ */
+ addressLocal: string;
+ /**
+ *
+ * Number of cells in the range. Read-only.
+ */
+ cellCount: number;
+ /**
+ *
+ * Represents the total number of columns in the range. Read-only.
+ */
+ columnCount: number;
+ /**
+ *
+ * Represents the column number of the first cell in the range. Zero-indexed. Read-only.
+ */
+ columnIndex: number;
+ /**
+ *
+ * Represents the formula in A1-style notation.
+ */
+ formulas: Array<Array<any>>;
+ /**
+ *
+ * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German.
+ */
+ formulasLocal: Array<Array<any>>;
+ /**
+ *
+ * Represents Excel's number format code for the given cell.
+ */
+ numberFormat: Array<Array<any>>;
+ /**
+ *
+ * Returns the total number of rows in the range. Read-only.
+ */
+ rowCount: number;
+ /**
+ *
+ * Returns the row number of the first cell in the range. Zero-indexed. Read-only.
+ */
+ rowIndex: number;
+ /**
+ *
+ * Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only.
+ */
+ text: Array<Array<any>>;
+ /**
+ *
+ * Represents the type of data of each cell. Read-only.
+ */
+ valueTypes: Array<Array<string>>;
+ /**
+ *
+ * Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.
+ */
+ values: Array<Array<any>>;
+ /**
+ *
+ * Clear range values, format, fill, border, etc.
+ *
+ * @param applyTo Determines the type of clear action. See Excel.ClearApplyTo for details.
+ */
+ clear(applyTo?: string): void;
+ /**
+ *
+ * Deletes the cells associated with the range.
+ *
+ * @param shift Specifies which way to shift the cells. See Excel.DeleteShiftDirection for details.
+ */
+ delete(shift: string): void;
+ /**
+ *
+ * Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16".
+ *
+ * @param anotherRange The range object or address or range name.
+ */
+ getBoundingRect(anotherRange: Excel.Range | string): Excel.Range;
+ /**
+ *
+ * Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. The returned cell is located relative to the top left cell of the range.
+ *
+ * @param row Row number of the cell to be retrieved. Zero-indexed.
+ * @param column Column number of the cell to be retrieved. Zero-indexed.
+ */
+ getCell(row: number, column: number): Excel.Range;
+ /**
+ *
+ * Gets a column contained in the range.
+ *
+ * @param column Column number of the range to be retrieved. Zero-indexed.
+ */
+ getColumn(column: number): Excel.Range;
+ /**
+ *
+ * Gets an object that represents the entire column of the range.
+ *
+ */
+ getEntireColumn(): Excel.Range;
+ /**
+ *
+ * Gets an object that represents the entire row of the range.
+ *
+ */
+ getEntireRow(): Excel.Range;
+ /**
+ *
+ * Gets the range object that represents the rectangular intersection of the given ranges.
+ *
+ * @param anotherRange The range object or range address that will be used to determine the intersection of ranges.
+ */
+ getIntersection(anotherRange: Excel.Range | string): Excel.Range;
+ /**
+ *
+ * Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".
+ *
+ */
+ getLastCell(): Excel.Range;
+ /**
+ *
+ * Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".
+ *
+ */
+ getLastColumn(): Excel.Range;
+ /**
+ *
+ * Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".
+ *
+ */
+ getLastRow(): Excel.Range;
+ /**
+ *
+ * Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown.
+ *
+ * @param rowOffset The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward.
+ * @param columnOffset The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left.
+ */
+ getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;
+ /**
+ *
+ * Gets a row contained in the range.
+ *
+ * @param row Row number of the range to be retrieved. Zero-indexed.
+ */
+ getRow(row: number): Excel.Range;
+ /**
+ *
+ * Returns the used range of the given range object.
+ *
+ */
+ getUsedRange(): Excel.Range;
+ /**
+ *
+ * Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.
+ *
+ * @param shift Specifies which way to shift the cells. See Excel.InsertShiftDirection for details.
+ */
+ insert(shift: string): Excel.Range;
+ /**
+ *
+ * Selects the specified range in the Excel UI.
+ *
+ */
+ select(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Range;
+ }
+ /**
+ *
+ * A collection of all the nameditem objects that are part of the workbook.
+ */
+ class NamedItemCollection extends OfficeExtension.ClientObject {
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.NamedItem>;
+ /**
+ *
+ * Gets a nameditem object using its name
+ *
+ * @param name nameditem name.
+ */
+ getItem(name: string): Excel.NamedItem;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.NamedItemCollection;
+ }
+ /**
+ *
+ * Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names.
+ */
+ class NamedItem extends OfficeExtension.ClientObject {
+ private m_name;
+ private m_type;
+ private m_value;
+ private m_visible;
+ private m__Id;
+ /**
+ *
+ * The name of the object. Read-only.
+ */
+ name: string;
+ /**
+ *
+ * Indicates what type of reference is associated with the name. See Excel.NamedItemType for details. Read-only.
+ */
+ type: string;
+ /**
+ *
+ * Represents the formula that the name is defined to refer to. E.g. =Sheet14!$B$2:$H$12, =4.75, etc. Read-only.
+ */
+ value: any;
+ /**
+ *
+ * Specifies whether the object is visible or not.
+ */
+ visible: boolean;
+ /**
+ *
+ * Returns the range object that is associated with the name. Throws an exception if the named item's type is not a range.
+ *
+ */
+ getRange(): Excel.Range;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.NamedItem;
+ }
+ /**
+ *
+ * Represents an Office.js binding that is defined in the workbook.
+ */
+ class Binding extends OfficeExtension.ClientObject {
+ private m_id;
+ private m_type;
+ /**
+ *
+ * Represents binding identifier. Read-only.
+ */
+ id: string;
+ /**
+ *
+ * Returns the type of the binding. See Excel.BindingType for details. Read-only.
+ */
+ type: string;
+ /**
+ *
+ * Returns the range represented by the binding. Will throw an error if binding is not of the correct type.
+ *
+ */
+ getRange(): Excel.Range;
+ /**
+ *
+ * Returns the table represented by the binding. Will throw an error if binding is not of the correct type.
+ *
+ */
+ getTable(): Excel.Table;
+ /**
+ *
+ * Returns the text represented by the binding. Will throw an error if binding is not of the correct type.
+ *
+ */
+ getText(): OfficeExtension.ClientResult<string>;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Binding;
+ }
+ /**
+ *
+ * Represents the collection of all the binding objects that are part of the workbook.
+ */
+ class BindingCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.Binding>;
+ /**
+ *
+ * Returns the number of bindings in the collection. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Gets a binding object by ID.
+ *
+ * @param id Id of the binding object to be retrieved.
+ */
+ getItem(id: string): Excel.Binding;
+ /**
+ *
+ * Gets a binding object based on its position in the items array.
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.Binding;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.BindingCollection;
+ }
+ /**
+ *
+ * Represents a collection of all the tables that are part of the workbook.
+ */
+ class TableCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.Table>;
+ /**
+ *
+ * Returns the number of tables in the workbook. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Create a new table. The range source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown.
+ *
+ * @param address Address or name of the range object representing the data source. If the address does not contain a sheet name, the currently-active sheet is used.
+ * @param hasHeaders Boolean value that indicates whether the data being imported has column labels. If the source does not contain headers (i.e,. when this property set to false), Excel will automatically generate header shifting the data down by one row.
+ */
+ add(address: string, hasHeaders: boolean): Excel.Table;
+ /**
+ *
+ * Gets a table by Name or ID.
+ *
+ * @param key Name or ID of the table to be retrieved.
+ */
+ getItem(key: number | string): Excel.Table;
+ /**
+ *
+ * Gets a table based on its position in the collection.
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.Table;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.TableCollection;
+ }
+ /**
+ *
+ * Represents an Excel table.
+ */
+ class Table extends OfficeExtension.ClientObject {
+ private m_columns;
+ private m_id;
+ private m_name;
+ private m_rows;
+ private m_showHeaders;
+ private m_showTotals;
+ private m_style;
+ /**
+ *
+ * Represents a collection of all the columns in the table. Read-only.
+ */
+ columns: Excel.TableColumnCollection;
+ /**
+ *
+ * Represents a collection of all the rows in the table. Read-only.
+ */
+ rows: Excel.TableRowCollection;
+ /**
+ *
+ * Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. Read-only.
+ */
+ id: number;
+ /**
+ *
+ * Name of the table.
+ */
+ name: string;
+ /**
+ *
+ * Indicates whether the header row is visible or not. This value can be set to show or remove the header row.
+ */
+ showHeaders: boolean;
+ /**
+ *
+ * Indicates whether the total row is visible or not. This value can be set to show or remove the total row.
+ */
+ showTotals: boolean;
+ /**
+ *
+ * Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.
+ */
+ style: string;
+ /**
+ *
+ * Deletes the table.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Gets the range object associated with the data body of the table.
+ *
+ */
+ getDataBodyRange(): Excel.Range;
+ /**
+ *
+ * Gets the range object associated with header row of the table.
+ *
+ */
+ getHeaderRowRange(): Excel.Range;
+ /**
+ *
+ * Gets the range object associated with the entire table.
+ *
+ */
+ getRange(): Excel.Range;
+ /**
+ *
+ * Gets the range object associated with totals row of the table.
+ *
+ */
+ getTotalRowRange(): Excel.Range;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Table;
+ }
+ /**
+ *
+ * Represents a collection of all the columns that are part of the table.
+ */
+ class TableColumnCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.TableColumn>;
+ /**
+ *
+ * Returns the number of columns in the table. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Adds a new column to the table.
+ *
+ * @param index Specifies the relative position of the new column. The previous column at this position is shifted to the right. The index value should be equal to or less than the last column's index value, so it cannot be used to append a column at the end of the table. Zero-indexed.
+ * @param values A 2-dimensional array of unformatted values of the table column.
+ */
+ add(index: number, values?: Array<Array<boolean | string | number>> | boolean | string | number): Excel.TableColumn;
+ /**
+ *
+ * Gets a column object by Name or ID.
+ *
+ * @param key Column Name or ID.
+ */
+ getItem(key: number | string): Excel.TableColumn;
+ /**
+ *
+ * Gets a column based on its position in the collection.
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.TableColumn;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.TableColumnCollection;
+ }
+ /**
+ *
+ * Represents a column in a table.
+ */
+ class TableColumn extends OfficeExtension.ClientObject {
+ private m_id;
+ private m_index;
+ private m_name;
+ private m_values;
+ /**
+ *
+ * Returns a unique key that identifies the column within the table. Read-only.
+ */
+ id: number;
+ /**
+ *
+ * Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only.
+ */
+ index: number;
+ /**
+ *
+ * Returns the name of the table column. Read-only.
+ */
+ name: string;
+ /**
+ *
+ * Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.
+ */
+ values: Array<Array<any>>;
+ /**
+ *
+ * Deletes the column from the table.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Gets the range object associated with the data body of the column.
+ *
+ */
+ getDataBodyRange(): Excel.Range;
+ /**
+ *
+ * Gets the range object associated with the header row of the column.
+ *
+ */
+ getHeaderRowRange(): Excel.Range;
+ /**
+ *
+ * Gets the range object associated with the entire column.
+ *
+ */
+ getRange(): Excel.Range;
+ /**
+ *
+ * Gets the range object associated with the totals row of the column.
+ *
+ */
+ getTotalRowRange(): Excel.Range;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.TableColumn;
+ }
+ /**
+ *
+ * Represents a collection of all the rows that are part of the table.
+ */
+ class TableRowCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.TableRow>;
+ /**
+ *
+ * Returns the number of rows in the table. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Adds a new row to the table.
+ *
+ * @param index Specifies the relative position of the new row. If null, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
+ * @param values A 2-dimensional array of unformatted values of the table row.
+ */
+ add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number): Excel.TableRow;
+ /**
+ *
+ * Gets a row based on its position in the collection.
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.TableRow;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.TableRowCollection;
+ }
+ /**
+ *
+ * Represents a row in a table.
+ */
+ class TableRow extends OfficeExtension.ClientObject {
+ private m_index;
+ private m_values;
+ /**
+ *
+ * Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only.
+ */
+ index: number;
+ /**
+ *
+ * Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.
+ */
+ values: Array<Array<any>>;
+ /**
+ *
+ * Deletes the row from the table.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Returns the range object associated with the entire row.
+ *
+ */
+ getRange(): Excel.Range;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.TableRow;
+ }
+ /**
+ *
+ * A format object encapsulating the range's font, fill, borders, alignment, and other properties.
+ */
+ class RangeFormat extends OfficeExtension.ClientObject {
+ private m_borders;
+ private m_fill;
+ private m_font;
+ private m_horizontalAlignment;
+ private m_verticalAlignment;
+ private m_wrapText;
+ /**
+ *
+ * Collection of border objects that apply to the overall range selected Read-only.
+ */
+ borders: Excel.RangeBorderCollection;
+ /**
+ *
+ * Returns the fill object defined on the overall range. Read-only.
+ */
+ fill: Excel.RangeFill;
+ /**
+ *
+ * Returns the font object defined on the overall range selected Read-only.
+ */
+ font: Excel.RangeFont;
+ /**
+ *
+ * Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details.
+ */
+ horizontalAlignment: string;
+ /**
+ *
+ * Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details.
+ */
+ verticalAlignment: string;
+ /**
+ *
+ * Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting
+ */
+ wrapText: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.RangeFormat;
+ }
+ /**
+ *
+ * Represents the background of a range object.
+ */
+ class RangeFill extends OfficeExtension.ClientObject {
+ private m_color;
+ /**
+ *
+ * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")
+ */
+ color: string;
+ /**
+ *
+ * Resets the range background.
+ *
+ */
+ clear(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.RangeFill;
+ }
+ /**
+ *
+ * Represents the border of an object.
+ */
+ class RangeBorder extends OfficeExtension.ClientObject {
+ private m_color;
+ private m_sideIndex;
+ private m_style;
+ private m_weight;
+ /**
+ *
+ * HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
+ */
+ color: string;
+ /**
+ *
+ * Constant value that indicates the specific side of the border. See Excel.BorderIndex for details. Read-only.
+ */
+ sideIndex: string;
+ /**
+ *
+ * One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details.
+ */
+ style: string;
+ /**
+ *
+ * Specifies the weight of the border around a range. See Excel.BorderWeight for details.
+ */
+ weight: string;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.RangeBorder;
+ }
+ /**
+ *
+ * Represents the border objects that make up range border.
+ */
+ class RangeBorderCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.RangeBorder>;
+ /**
+ *
+ * Number of border objects in the collection. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Gets a border object using its name
+ *
+ * @param index Index value of the border object to be retrieved. See Excel.BorderIndex for details.
+ */
+ getItem(index: string): Excel.RangeBorder;
+ /**
+ *
+ * Gets a border object using its index
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.RangeBorder;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.RangeBorderCollection;
+ }
+ /**
+ *
+ * This object represents the font attributes (font name, font size, color, etc.) for an object.
+ */
+ class RangeFont extends OfficeExtension.ClientObject {
+ private m_bold;
+ private m_color;
+ private m_italic;
+ private m_name;
+ private m_size;
+ private m_underline;
+ /**
+ *
+ * Represents the bold status of font.
+ */
+ bold: boolean;
+ /**
+ *
+ * HTML color code representation of the text color. E.g. #FF0000 represents Red.
+ */
+ color: string;
+ /**
+ *
+ * Represents the italic status of the font.
+ */
+ italic: boolean;
+ /**
+ *
+ * Font name (e.g. "Calibri")
+ */
+ name: string;
+ /**
+ *
+ * Font size.
+ */
+ size: number;
+ /**
+ *
+ * Type of underline applied to the font. See Excel.RangeUnderlineStyle for details.
+ */
+ underline: string;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.RangeFont;
+ }
+ /**
+ *
+ * A collection of all the chart objects on a worksheet.
+ */
+ class ChartCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.Chart>;
+ /**
+ *
+ * Returns the number of charts in the worksheet. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Creates a new chart.
+ *
+ * @param type Represents the type of a chart. See Excel.ChartType for details.
+ * @param sourceData The Range object corresponding to the source data.
+ * @param seriesBy Specifies the way columns or rows are used as data series on the chart. See Excel.ChartSeriesBy for details.
+ */
+ add(type: string, sourceData: Excel.Range, seriesBy?: string): Excel.Chart;
+ /**
+ *
+ * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.
+ *
+ * @param name Name of the chart to be retrieved.
+ */
+ getItem(name: string): Excel.Chart;
+ /**
+ *
+ * Gets a chart based on its position in the collection.
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.Chart;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartCollection;
+ }
+ /**
+ *
+ * Represents a chart object in a workbook.
+ */
+ class Chart extends OfficeExtension.ClientObject {
+ private m_axes;
+ private m_dataLabels;
+ private m_format;
+ private m_height;
+ private m_left;
+ private m_legend;
+ private m_name;
+ private m_series;
+ private m_title;
+ private m_top;
+ private m_width;
+ private m__Id;
+ /**
+ *
+ * Represents chart axes. Read-only.
+ */
+ axes: Excel.ChartAxes;
+ /**
+ *
+ * Represents the datalabels on the chart. Read-only.
+ */
+ dataLabels: Excel.ChartDataLabels;
+ /**
+ *
+ * Encapsulates the format properties for the chart area. Read-only.
+ */
+ format: Excel.ChartAreaFormat;
+ /**
+ *
+ * Represents the legend for the chart. Read-only.
+ */
+ legend: Excel.ChartLegend;
+ /**
+ *
+ * Represents either a single series or collection of series in the chart. Read-only.
+ */
+ series: Excel.ChartSeriesCollection;
+ /**
+ *
+ * Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.
+ */
+ title: Excel.ChartTitle;
+ /**
+ *
+ * Represents the height, in points, of the chart object.
+ */
+ height: number;
+ /**
+ *
+ * The distance, in points, from the left side of the chart to the worksheet origin.
+ */
+ left: number;
+ /**
+ *
+ * Represents the name of a chart object.
+ */
+ name: string;
+ /**
+ *
+ * Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
+ */
+ top: number;
+ /**
+ *
+ * Represents the width, in points, of the chart object.
+ */
+ width: number;
+ /**
+ *
+ * Deletes the chart object.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Resets the source data for the chart.
+ *
+ * @param sourceData The Range object corresponding to the source data.
+ * @param seriesBy Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. See Excel.ChartSeriesBy for details.
+ */
+ setData(sourceData: Excel.Range, seriesBy?: string): void;
+ /**
+ *
+ * Positions the chart relative to cells on the worksheet.
+ *
+ * @param startCell The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.
+ * @param endCell (Optional) The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.
+ */
+ setPosition(startCell: Excel.Range | string, endCell?: Excel.Range | string): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.Chart;
+ }
+ /**
+ *
+ * Encapsulates the format properties for the overall chart area.
+ */
+ class ChartAreaFormat extends OfficeExtension.ClientObject {
+ private m_fill;
+ private m_font;
+ /**
+ *
+ * Represents the fill format of an object, which includes background formatting information. Read-only.
+ */
+ fill: Excel.ChartFill;
+ /**
+ *
+ * Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.
+ */
+ font: Excel.ChartFont;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartAreaFormat;
+ }
+ /**
+ *
+ * Represents a collection of chart series.
+ */
+ class ChartSeriesCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.ChartSeries>;
+ /**
+ *
+ * Returns the number of series in the collection. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Retrieves a series based on its position in the collection
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.ChartSeries;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartSeriesCollection;
+ }
+ /**
+ *
+ * Represents a series in a chart.
+ */
+ class ChartSeries extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_name;
+ private m_points;
+ /**
+ *
+ * Represents the formatting of a chart series, which includes fill and line formatting. Read-only.
+ */
+ format: Excel.ChartSeriesFormat;
+ /**
+ *
+ * Represents a collection of all points in the series. Read-only.
+ */
+ points: Excel.ChartPointsCollection;
+ /**
+ *
+ * Represents the name of a series in a chart.
+ */
+ name: string;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartSeries;
+ }
+ /**
+ *
+ * encapsulates the format properties for the chart series
+ */
+ class ChartSeriesFormat extends OfficeExtension.ClientObject {
+ private m_fill;
+ private m_line;
+ /**
+ *
+ * Represents the fill format of a chart series, which includes background formating information. Read-only.
+ */
+ fill: Excel.ChartFill;
+ /**
+ *
+ * Represents line formatting. Read-only.
+ */
+ line: Excel.ChartLineFormat;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartSeriesFormat;
+ }
+ /**
+ *
+ * A collection of all the chart points within a series inside a chart.
+ */
+ class ChartPointsCollection extends OfficeExtension.ClientObject {
+ private m_count;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Excel.ChartPoint>;
+ /**
+ *
+ * Returns the number of chart points in the collection. Read-only.
+ */
+ count: number;
+ /**
+ *
+ * Retrieve a point based on its position within the series.
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): Excel.ChartPoint;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartPointsCollection;
+ }
+ /**
+ *
+ * Represents a point of a series in a chart.
+ */
+ class ChartPoint extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_value;
+ /**
+ *
+ * Encapsulates the format properties chart point. Read-only.
+ */
+ format: Excel.ChartPointFormat;
+ /**
+ *
+ * Returns the value of a chart point. Read-only.
+ */
+ value: any;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartPoint;
+ }
+ /**
+ *
+ * Represents formatting object for chart points.
+ */
+ class ChartPointFormat extends OfficeExtension.ClientObject {
+ private m_fill;
+ /**
+ *
+ * Represents the fill format of a chart, which includes background formating information. Read-only.
+ */
+ fill: Excel.ChartFill;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartPointFormat;
+ }
+ /**
+ *
+ * Represents the chart axes.
+ */
+ class ChartAxes extends OfficeExtension.ClientObject {
+ private m_categoryAxis;
+ private m_seriesAxis;
+ private m_valueAxis;
+ /**
+ *
+ * Represents the category axis in a chart. Read-only.
+ */
+ categoryAxis: Excel.ChartAxis;
+ /**
+ *
+ * Represents the series axis of a 3-dimensional chart. Read-only.
+ */
+ seriesAxis: Excel.ChartAxis;
+ /**
+ *
+ * Represents the value axis in an axis. Read-only.
+ */
+ valueAxis: Excel.ChartAxis;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartAxes;
+ }
+ /**
+ *
+ * Represents a single axis in a chart.
+ */
+ class ChartAxis extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_majorGridlines;
+ private m_majorUnit;
+ private m_maximum;
+ private m_minimum;
+ private m_minorGridlines;
+ private m_minorUnit;
+ private m_title;
+ /**
+ *
+ * Represents the formatting of a chart object, which includes line and font formatting. Read-only.
+ */
+ format: Excel.ChartAxisFormat;
+ /**
+ *
+ * Returns a gridlines object that represents the major gridlines for the specified axis. Read-only.
+ */
+ majorGridlines: Excel.ChartGridlines;
+ /**
+ *
+ * Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only.
+ */
+ minorGridlines: Excel.ChartGridlines;
+ /**
+ *
+ * Represents the axis title. Read-only.
+ */
+ title: Excel.ChartAxisTitle;
+ /**
+ *
+ * Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.
+ */
+ majorUnit: any;
+ /**
+ *
+ * Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
+ */
+ maximum: any;
+ /**
+ *
+ * Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
+ */
+ minimum: any;
+ /**
+ *
+ * Represents the interval between two minor tick marks. "Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
+ */
+ minorUnit: any;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartAxis;
+ }
+ /**
+ *
+ * Encapsulates the format properties for the chart axis.
+ */
+ class ChartAxisFormat extends OfficeExtension.ClientObject {
+ private m_font;
+ private m_line;
+ /**
+ *
+ * Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only.
+ */
+ font: Excel.ChartFont;
+ /**
+ *
+ * Represents chart line formatting. Read-only.
+ */
+ line: Excel.ChartLineFormat;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartAxisFormat;
+ }
+ /**
+ *
+ * Represents the title of a chart axis.
+ */
+ class ChartAxisTitle extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_text;
+ private m_visible;
+ /**
+ *
+ * Represents the formatting of chart axis title. Read-only.
+ */
+ format: Excel.ChartAxisTitleFormat;
+ /**
+ *
+ * Represents the axis title.
+ */
+ text: string;
+ /**
+ *
+ * A boolean that specifies the visibility of an axis title.
+ */
+ visible: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartAxisTitle;
+ }
+ /**
+ *
+ * Represents the chart axis title formatting.
+ */
+ class ChartAxisTitleFormat extends OfficeExtension.ClientObject {
+ private m_font;
+ /**
+ *
+ * Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only.
+ */
+ font: Excel.ChartFont;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartAxisTitleFormat;
+ }
+ /**
+ *
+ * Represents a collection of all the data labels on a chart point.
+ */
+ class ChartDataLabels extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_position;
+ private m_separator;
+ private m_showBubbleSize;
+ private m_showCategoryName;
+ private m_showLegendKey;
+ private m_showPercentage;
+ private m_showSeriesName;
+ private m_showValue;
+ /**
+ *
+ * Represents the format of chart data labels, which includes fill and font formatting. Read-only.
+ */
+ format: Excel.ChartDataLabelFormat;
+ /**
+ *
+ * DataLabelPosition value that represents the position of the data label. See Excel.ChartDataLabelPosition for details.
+ */
+ position: string;
+ /**
+ *
+ * String representing the separator used for the data labels on a chart.
+ */
+ separator: string;
+ /**
+ *
+ * Boolean value representing if the data label bubble size is visible or not.
+ */
+ showBubbleSize: boolean;
+ /**
+ *
+ * Boolean value representing if the data label category name is visible or not.
+ */
+ showCategoryName: boolean;
+ /**
+ *
+ * Boolean value representing if the data label legend key is visible or not.
+ */
+ showLegendKey: boolean;
+ /**
+ *
+ * Boolean value representing if the data label percentage is visible or not.
+ */
+ showPercentage: boolean;
+ /**
+ *
+ * Boolean value representing if the data label series name is visible or not.
+ */
+ showSeriesName: boolean;
+ /**
+ *
+ * Boolean value representing if the data label value is visible or not.
+ */
+ showValue: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartDataLabels;
+ }
+ /**
+ *
+ * Encapsulates the format properties for the chart data labels.
+ */
+ class ChartDataLabelFormat extends OfficeExtension.ClientObject {
+ private m_fill;
+ private m_font;
+ /**
+ *
+ * Represents the fill format of the current chart data label. Read-only.
+ */
+ fill: Excel.ChartFill;
+ /**
+ *
+ * Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only.
+ */
+ font: Excel.ChartFont;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartDataLabelFormat;
+ }
+ /**
+ *
+ * Represents major or minor gridlines on a chart axis.
+ */
+ class ChartGridlines extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_visible;
+ /**
+ *
+ * Represents the formatting of chart gridlines. Read-only.
+ */
+ format: Excel.ChartGridlinesFormat;
+ /**
+ *
+ * Boolean value representing if the axis gridlines are visible or not.
+ */
+ visible: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartGridlines;
+ }
+ /**
+ *
+ * Encapsulates the format properties for chart gridlines.
+ */
+ class ChartGridlinesFormat extends OfficeExtension.ClientObject {
+ private m_line;
+ /**
+ *
+ * Represents chart line formatting. Read-only.
+ */
+ line: Excel.ChartLineFormat;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartGridlinesFormat;
+ }
+ /**
+ *
+ * Represents the legend in a chart.
+ */
+ class ChartLegend extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_overlay;
+ private m_position;
+ private m_visible;
+ /**
+ *
+ * Represents the formatting of a chart legend, which includes fill and font formatting. Read-only.
+ */
+ format: Excel.ChartLegendFormat;
+ /**
+ *
+ * Boolean value for whether the chart legend should overlap with the main body of the chart.
+ */
+ overlay: boolean;
+ /**
+ *
+ * Represents the position of the legend on the chart. See Excel.ChartLegendPosition for details.
+ */
+ position: string;
+ /**
+ *
+ * A boolean value the represents the visibility of a ChartLegend object.
+ */
+ visible: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartLegend;
+ }
+ /**
+ *
+ * Encapsulates the format properties of a chart legend.
+ */
+ class ChartLegendFormat extends OfficeExtension.ClientObject {
+ private m_fill;
+ private m_font;
+ /**
+ *
+ * Represents the fill format of an object, which includes background formating information. Read-only.
+ */
+ fill: Excel.ChartFill;
+ /**
+ *
+ * Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.
+ */
+ font: Excel.ChartFont;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartLegendFormat;
+ }
+ /**
+ *
+ * Represents a chart title object of a chart.
+ */
+ class ChartTitle extends OfficeExtension.ClientObject {
+ private m_format;
+ private m_overlay;
+ private m_text;
+ private m_visible;
+ /**
+ *
+ * Represents the formatting of a chart title, which includes fill and font formatting. Read-only.
+ */
+ format: Excel.ChartTitleFormat;
+ /**
+ *
+ * Boolean value representing if the chart title will overlay the chart or not.
+ */
+ overlay: boolean;
+ /**
+ *
+ * Represents the title text of a chart.
+ */
+ text: string;
+ /**
+ *
+ * A boolean value the represents the visibility of a chart title object.
+ */
+ visible: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartTitle;
+ }
+ /**
+ *
+ * Provides access to the office art formatting for chart title.
+ */
+ class ChartTitleFormat extends OfficeExtension.ClientObject {
+ private m_fill;
+ private m_font;
+ /**
+ *
+ * Represents the fill format of an object, which includes background formating information. Read-only.
+ */
+ fill: Excel.ChartFill;
+ /**
+ *
+ * Represents the font attributes (font name, font size, color, etc.) for an object. Read-only.
+ */
+ font: Excel.ChartFont;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartTitleFormat;
+ }
+ /**
+ *
+ * Represents the fill formatting for a chart element.
+ */
+ class ChartFill extends OfficeExtension.ClientObject {
+ /**
+ *
+ * Clear the fill color of a chart element.
+ *
+ */
+ clear(): void;
+ /**
+ *
+ * Sets the fill formatting of a chart element to a uniform color.
+ *
+ * @param color HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").
+ */
+ setSolidColor(color: string): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartFill;
+ }
+ /**
+ *
+ * Enapsulates the formatting options for line elements.
+ */
+ class ChartLineFormat extends OfficeExtension.ClientObject {
+ private m_color;
+ /**
+ *
+ * HTML color code representing the color of lines in the chart.
+ */
+ color: string;
+ /**
+ *
+ * Clear the line format of a chart element.
+ *
+ */
+ clear(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartLineFormat;
+ }
+ /**
+ *
+ * This object represents the font attributes (font name, font size, color, etc.) for a chart object.
+ */
+ class ChartFont extends OfficeExtension.ClientObject {
+ private m_bold;
+ private m_color;
+ private m_italic;
+ private m_name;
+ private m_size;
+ private m_underline;
+ /**
+ *
+ * Represents the bold status of font.
+ */
+ bold: boolean;
+ /**
+ *
+ * HTML color code representation of the text color. E.g. #FF0000 represents Red.
+ */
+ color: string;
+ /**
+ *
+ * Represents the italic status of the font.
+ */
+ italic: boolean;
+ /**
+ *
+ * Font name (e.g. "Calibri")
+ */
+ name: string;
+ /**
+ *
+ * Size of the font (e.g. 11)
+ */
+ size: number;
+ /**
+ *
+ * Type of underline applied to the font. See Excel.ChartUnderlineStyle for details.
+ */
+ underline: string;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Excel.ChartFont;
+ }
+ module BindingType {
+ var range: string;
+ var table: string;
+ var text: string;
+ }
+ module BorderIndex {
+ var edgeTop: string;
+ var edgeBottom: string;
+ var edgeLeft: string;
+ var edgeRight: string;
+ var insideVertical: string;
+ var insideHorizontal: string;
+ var diagonalDown: string;
+ var diagonalUp: string;
+ }
+ module BorderLineStyle {
+ var none: string;
+ var continuous: string;
+ var dash: string;
+ var dashDot: string;
+ var dashDotDot: string;
+ var dot: string;
+ var double: string;
+ var slantDashDot: string;
+ }
+ module BorderWeight {
+ var hairline: string;
+ var thin: string;
+ var medium: string;
+ var thick: string;
+ }
+ module CalculationMode {
+ var automatic: string;
+ var automaticExceptTables: string;
+ var manual: string;
+ }
+ module CalculationType {
+ var recalculate: string;
+ var full: string;
+ var fullRebuild: string;
+ }
+ module ClearApplyTo {
+ var all: string;
+ var formats: string;
+ var contents: string;
+ }
+ module ChartDataLabelPosition {
+ var invalid: string;
+ var none: string;
+ var center: string;
+ var insideEnd: string;
+ var insideBase: string;
+ var outsideEnd: string;
+ var left: string;
+ var right: string;
+ var top: string;
+ var bottom: string;
+ var bestFit: string;
+ var callout: string;
+ }
+ module ChartLegendPosition {
+ var invalid: string;
+ var top: string;
+ var bottom: string;
+ var left: string;
+ var right: string;
+ var corner: string;
+ var custom: string;
+ }
+ module ChartSeriesBy {
+ var auto: string;
+ var columns: string;
+ var rows: string;
+ }
+ module ChartType {
+ var invalid: string;
+ var columnClustered: string;
+ var columnStacked: string;
+ var columnStacked100: string;
+ var _3DColumnClustered: string;
+ var _3DColumnStacked: string;
+ var _3DColumnStacked100: string;
+ var barClustered: string;
+ var barStacked: string;
+ var barStacked100: string;
+ var _3DBarClustered: string;
+ var _3DBarStacked: string;
+ var _3DBarStacked100: string;
+ var lineStacked: string;
+ var lineStacked100: string;
+ var lineMarkers: string;
+ var lineMarkersStacked: string;
+ var lineMarkersStacked100: string;
+ var pieOfPie: string;
+ var pieExploded: string;
+ var _3DPieExploded: string;
+ var barOfPie: string;
+ var xyscatterSmooth: string;
+ var xyscatterSmoothNoMarkers: string;
+ var xyscatterLines: string;
+ var xyscatterLinesNoMarkers: string;
+ var areaStacked: string;
+ var areaStacked100: string;
+ var _3DAreaStacked: string;
+ var _3DAreaStacked100: string;
+ var doughnutExploded: string;
+ var radarMarkers: string;
+ var radarFilled: string;
+ var surface: string;
+ var surfaceWireframe: string;
+ var surfaceTopView: string;
+ var surfaceTopViewWireframe: string;
+ var bubble: string;
+ var bubble3DEffect: string;
+ var stockHLC: string;
+ var stockOHLC: string;
+ var stockVHLC: string;
+ var stockVOHLC: string;
+ var cylinderColClustered: string;
+ var cylinderColStacked: string;
+ var cylinderColStacked100: string;
+ var cylinderBarClustered: string;
+ var cylinderBarStacked: string;
+ var cylinderBarStacked100: string;
+ var cylinderCol: string;
+ var coneColClustered: string;
+ var coneColStacked: string;
+ var coneColStacked100: string;
+ var coneBarClustered: string;
+ var coneBarStacked: string;
+ var coneBarStacked100: string;
+ var coneCol: string;
+ var pyramidColClustered: string;
+ var pyramidColStacked: string;
+ var pyramidColStacked100: string;
+ var pyramidBarClustered: string;
+ var pyramidBarStacked: string;
+ var pyramidBarStacked100: string;
+ var pyramidCol: string;
+ var _3DColumn: string;
+ var line: string;
+ var _3DLine: string;
+ var _3DPie: string;
+ var pie: string;
+ var xyscatter: string;
+ var _3DArea: string;
+ var area: string;
+ var doughnut: string;
+ var radar: string;
+ }
+ module ChartUnderlineStyle {
+ var none: string;
+ var single: string;
+ }
+ module DeleteShiftDirection {
+ var up: string;
+ var left: string;
+ }
+ module HorizontalAlignment {
+ var general: string;
+ var left: string;
+ var center: string;
+ var right: string;
+ var fill: string;
+ var justify: string;
+ var centerAcrossSelection: string;
+ var distributed: string;
+ }
+ module InsertShiftDirection {
+ var down: string;
+ var right: string;
+ }
+ module NamedItemType {
+ var string: string;
+ var integer: string;
+ var double: string;
+ var boolean: string;
+ var range: string;
+ }
+ module RangeUnderlineStyle {
+ var none: string;
+ var single: string;
+ var double: string;
+ var singleAccountant: string;
+ var doubleAccountant: string;
+ }
+ module SheetVisibility {
+ var visible: string;
+ var hidden: string;
+ var veryHidden: string;
+ }
+ module RangeValueType {
+ var unknown: string;
+ var empty: string;
+ var string: string;
+ var integer: string;
+ var double: string;
+ var boolean: string;
+ var error: string;
+ }
+ module VerticalAlignment {
+ var top: string;
+ var center: string;
+ var bottom: string;
+ var justify: string;
+ var distributed: string;
+ }
+ module ErrorCodes {
+ var accessDenied: string;
+ var generalException: string;
+ var insertDeleteConflict: string;
+ var invalidArgument: string;
+ var invalidBinding: string;
+ var invalidOperation: string;
+ var invalidReference: string;
+ var invalidSelection: string;
+ var itemAlreadyExists: string;
+ var itemNotFound: string;
+ var notImplemented: string;
+ var unsupportedOperation: string;
+ }
+}
+declare module Excel {
+ /**
+ * The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.
+ */
+ class RequestContext extends OfficeExtension.ClientRequestContext {
+ private m_workbook;
+ constructor(url?: string);
+ workbook: Workbook;
+ }
+ /**
+ * Executes a batch script that performs actions on the Excel object model. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
+ * @param batch - A function that takes in an Excel.RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.
+ */
+ function run<T>(batch: (context: Excel.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;
+}
+
+declare module Word {
+ /**
+ *
+ * Represents the body of a document or a section.
+ */
+ class Body extends OfficeExtension.ClientObject {
+ private m_contentControls;
+ private m_font;
+ private m_inlinePictures;
+ private m_paragraphs;
+ private m_parentContentControl;
+ private m_style;
+ private m_text;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets the collection of rich text content control objects that are in the body. Read-only.
+ */
+ contentControls: Word.ContentControlCollection;
+ /**
+ *
+ * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. Read-only.
+ */
+ font: Word.Font;
+ /**
+ *
+ * Gets the collection of inlinePicture objects that are in the body. The collection does not include floating images. Read-only.
+ */
+ inlinePictures: Word.InlinePictureCollection;
+ /**
+ *
+ * Gets the collection of paragraph objects that are in the body. Read-only.
+ */
+ paragraphs: Word.ParagraphCollection;
+ /**
+ *
+ * Gets the content control that contains the body. Returns null if there isn't a parent content control. Read-only.
+ */
+ parentContentControl: Word.ContentControl;
+ /**
+ *
+ * Gets or sets the style used for the body. This is the name of the pre-installed or custom style.
+ */
+ style: string;
+ /**
+ *
+ * Gets the text of the body. Use the insertText method to insert text. Read-only.
+ */
+ text: string;
+ /**
+ *
+ * Clears the contents of the body object. The user can perform the undo operation on the cleared content.
+ *
+ */
+ clear(): void;
+ /**
+ *
+ * Gets the HTML representation of the body object.
+ *
+ */
+ getHtml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Gets the OOXML (Office Open XML) representation of the body object.
+ *
+ */
+ getOoxml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Inserts a break at the specified location. The insertLocation value can be 'Start' or 'End'.
+ *
+ * @param breakType Required. The break type to add to the body.
+ * @param insertLocation Required. The value can be 'Start' or 'End'.
+ */
+ insertBreak(breakType: string, insertLocation: string): void;
+ /**
+ *
+ * Wraps the body object with a Rich Text content control.
+ *
+ */
+ insertContentControl(): Word.ContentControl;
+ /**
+ *
+ * Inserts a document into the body at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param base64File Required. The base64 encoded file contents to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertFileFromBase64(base64File: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts HTML at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param html Required. The HTML to be inserted in the document.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertHtml(html: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts OOXML at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param ooxml Required. The OOXML to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertOoxml(ooxml: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts a paragraph at the specified location. The insertLocation value can be 'Start' or 'End'.
+ *
+ * @param paragraphText Required. The paragraph text to be inserted.
+ * @param insertLocation Required. The value can be 'Start' or 'End'.
+ */
+ insertParagraph(paragraphText: string, insertLocation: string): Word.Paragraph;
+ /**
+ *
+ * Inserts text into the body at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param text Required. Text to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertText(text: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Performs a search with the specified searchOptions on the scope of the body object. The search results are a collection of range objects.
+ *
+ * @param searchText Required. The search text.
+ * @param searchOptions Optional. Options for the search.
+ */
+ search(searchText: string, searchOptions?: Word.SearchOptions | {
+ ignorePunct?: boolean;
+ ignoreSpace?: boolean;
+ matchCase?: boolean;
+ matchPrefix?: boolean;
+ matchSoundsLike?: boolean;
+ matchSuffix?: boolean;
+ matchWholeWord?: boolean;
+ matchWildCards?: boolean;
+ }): Word.SearchResultCollection;
+ /**
+ *
+ * Selects the body and navigates the Word UI to it.
+ *
+ */
+ select(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.Body;
+ }
+ /**
+ *
+ * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
+ */
+ class ContentControl extends OfficeExtension.ClientObject {
+ private m_appearance;
+ private m_cannotDelete;
+ private m_cannotEdit;
+ private m_color;
+ private m_contentControls;
+ private m_font;
+ private m_id;
+ private m_inlinePictures;
+ private m_paragraphs;
+ private m_parentContentControl;
+ private m_placeholderText;
+ private m_removeWhenEdited;
+ private m_style;
+ private m_tag;
+ private m_text;
+ private m_title;
+ private m_type;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets the collection of content control objects in the content control. Read-only.
+ */
+ contentControls: Word.ContentControlCollection;
+ /**
+ *
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only.
+ */
+ font: Word.Font;
+ /**
+ *
+ * Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only.
+ */
+ inlinePictures: Word.InlinePictureCollection;
+ /**
+ *
+ * Get the collection of paragraph objects in the content control. Read-only.
+ */
+ paragraphs: Word.ParagraphCollection;
+ /**
+ *
+ * Gets the content control that contains the content control. Returns null if there isn't a parent content control. Read-only.
+ */
+ parentContentControl: Word.ContentControl;
+ /**
+ *
+ * Gets or sets the appearance of the content control. The value can be 'boundingBox', 'tags' or 'hidden'.
+ */
+ appearance: string;
+ /**
+ *
+ * Gets or sets a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited.
+ */
+ cannotDelete: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether the user can edit the contents of the content control.
+ */
+ cannotEdit: boolean;
+ /**
+ *
+ * Gets or sets the color of the content control. Color is set in "#RRGGBB" format or by using the color name.
+ */
+ color: string;
+ /**
+ *
+ * Gets an integer that represents the content control identifier. Read-only.
+ */
+ id: number;
+ /**
+ *
+ * Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
+ */
+ placeholderText: string;
+ /**
+ *
+ * Gets or sets a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete.
+ */
+ removeWhenEdited: boolean;
+ /**
+ *
+ * Gets or sets the style used for the content control. This is the name of the pre-installed or custom style.
+ */
+ style: string;
+ /**
+ *
+ * Gets or sets a tag to identify a content control.
+ */
+ tag: string;
+ /**
+ *
+ * Gets the text of the content control. Read-only.
+ */
+ text: string;
+ /**
+ *
+ * Gets or sets the title for a content control.
+ */
+ title: string;
+ /**
+ *
+ * Gets the content control type. Only rich text content controls are supported currently. Read-only.
+ */
+ type: string;
+ /**
+ *
+ * Clears the contents of the content control. The user can perform the undo operation on the cleared content.
+ *
+ */
+ clear(): void;
+ /**
+ *
+ * Deletes the content control and its content. If keepContent is set to true, the content is not deleted.
+ *
+ * @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.
+ */
+ delete(keepContent: boolean): void;
+ /**
+ *
+ * Gets the HTML representation of the content control object.
+ *
+ */
+ getHtml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Gets the Office Open XML (OOXML) representation of the content control object.
+ *
+ */
+ getOoxml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Inserts a break at the specified location. The insertLocation value can be 'Before', 'After', 'Start' or 'End'.
+ *
+ * @param breakType Required. Type of break (breakType.md)
+ * @param insertLocation Required. The value can be 'Before', 'After', 'Start' or 'End'.
+ */
+ insertBreak(breakType: string, insertLocation: string): void;
+ /**
+ *
+ * Inserts a document into the current content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param base64File Required. Base64 encoded contents of the file to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertFileFromBase64(base64File: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts HTML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param html Required. The HTML to be inserted in to the content control.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertHtml(html: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts OOXML into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param ooxml Required. The OOXML to be inserted in to the content control.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertOoxml(ooxml: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts a paragraph at the specified location. The insertLocation value can be 'Before', 'After', 'Start' or 'End'.
+ *
+ * @param paragraphText Required. The paragrph text to be inserted.
+ * @param insertLocation Required. The value can be 'Before', 'After', 'Start' or 'End'.
+ */
+ insertParagraph(paragraphText: string, insertLocation: string): Word.Paragraph;
+ /**
+ *
+ * Inserts text into the content control at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param text Required. The text to be inserted in to the content control.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertText(text: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Performs a search with the specified searchOptions on the scope of the content control object. The search results are a collection of range objects.
+ *
+ * @param searchText Required. The search text.
+ * @param searchOptions Optional. Options for the search.
+ */
+ search(searchText: string, searchOptions?: Word.SearchOptions | {
+ ignorePunct?: boolean;
+ ignoreSpace?: boolean;
+ matchCase?: boolean;
+ matchPrefix?: boolean;
+ matchSoundsLike?: boolean;
+ matchSuffix?: boolean;
+ matchWholeWord?: boolean;
+ matchWildCards?: boolean;
+ }): Word.SearchResultCollection;
+ /**
+ *
+ * Selects the content control. This causes Word to scroll to the selection.
+ *
+ */
+ select(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.ContentControl;
+ }
+ /**
+ *
+ * Contains a collection of ContentControl objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported.
+ */
+ class ContentControlCollection extends OfficeExtension.ClientObject {
+ private m__ReferenceId;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Word.ContentControl>;
+ /**
+ *
+ * Gets a content control by its identifier.
+ *
+ * @param id Required. A content control identifier.
+ */
+ getById(id: number): Word.ContentControl;
+ /**
+ *
+ * Gets the content controls that have the specified tag.
+ *
+ * @param tag Required. A tag set on a content control.
+ */
+ getByTag(tag: string): Word.ContentControlCollection;
+ /**
+ *
+ * Gets the content controls that have the specified title.
+ *
+ * @param title Required. The title of a content control.
+ */
+ getByTitle(title: string): Word.ContentControlCollection;
+ /**
+ *
+ * Gets a content control by its index in the collection.
+ *
+ * @param index The index
+ */
+ getItem(index: number): Word.ContentControl;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.ContentControlCollection;
+ }
+ /**
+ *
+ * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document.
+ */
+ class Document extends OfficeExtension.ClientObject {
+ private m_body;
+ private m_contentControls;
+ private m_saved;
+ private m_sections;
+ /**
+ *
+ * Gets the body of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only.
+ */
+ body: Word.Body;
+ /**
+ *
+ * Gets the collection of content control objects that are in the current document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only.
+ */
+ contentControls: Word.ContentControlCollection;
+ /**
+ *
+ * Gets the collection of section objects that are in the document. Read-only.
+ */
+ sections: Word.SectionCollection;
+ /**
+ *
+ * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.
+ */
+ saved: boolean;
+ /**
+ *
+ * Gets the current selection of the document. Multiple selections are not supported.
+ *
+ */
+ getSelection(): Word.Range;
+ /**
+ *
+ * Saves the document. This will use the Word default file naming convention if the document has not been saved before.
+ *
+ */
+ save(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.Document;
+ }
+ /**
+ *
+ * Represents a font.
+ */
+ class Font extends OfficeExtension.ClientObject {
+ private m_bold;
+ private m_color;
+ private m_doubleStrikeThrough;
+ private m_highlightColor;
+ private m_italic;
+ private m_name;
+ private m_size;
+ private m_strikeThrough;
+ private m_subscript;
+ private m_superscript;
+ private m_underline;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false.
+ */
+ bold: boolean;
+ /**
+ *
+ * Gets or sets the color for the specified font. You can provide the value in the "#RRGGBB" format or the color name.
+ */
+ color: string;
+ /**
+ *
+ * Gets or sets a value that indicates whether the font has a double strike through. True if the font is formatted as double strikethrough text, otherwise, false.
+ */
+ doubleStrikeThrough: boolean;
+ /**
+ *
+ * Gets or sets the highlight color for the specified font. You can provide the value as either in the "#RRGGBB" format or the color name.
+ */
+ highlightColor: string;
+ /**
+ *
+ * Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false.
+ */
+ italic: boolean;
+ /**
+ *
+ * Gets or sets a value that represents the name of the font.
+ */
+ name: string;
+ /**
+ *
+ * Gets or sets a value that represents the font size in points.
+ */
+ size: number;
+ /**
+ *
+ * Gets or sets a value that indicates whether the font has a strike through. True if the font is formatted as strikethrough text, otherwise, false.
+ */
+ strikeThrough: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false.
+ */
+ subscript: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false.
+ */
+ superscript: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates the font's underline type. 'None' if the font is not underlined.
+ */
+ underline: string;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.Font;
+ }
+ /**
+ *
+ * Represents an inline picture.
+ */
+ class InlinePicture extends OfficeExtension.ClientObject {
+ private m_altTextDescription;
+ private m_altTextTitle;
+ private m_height;
+ private m_hyperlink;
+ private m_lockAspectRatio;
+ private m_parentContentControl;
+ private m_width;
+ private m__Id;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets the content control that contains the inline image. Returns null if there isn't a parent content control. Read-only.
+ */
+ parentContentControl: Word.ContentControl;
+ /**
+ *
+ * Gets or sets a string that represents the alternative text associated with the inline image
+ */
+ altTextDescription: string;
+ /**
+ *
+ * Gets or sets a string that contains the title for the inline image.
+ */
+ altTextTitle: string;
+ /**
+ *
+ * Gets or sets a number that describes the height of the inline image.
+ */
+ height: number;
+ /**
+ *
+ * Gets or sets the hyperlink associated with the inline image.
+ */
+ hyperlink: string;
+ /**
+ *
+ * Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it.
+ */
+ lockAspectRatio: boolean;
+ /**
+ *
+ * Gets or sets a number that describes the width of the inline image.
+ */
+ width: number;
+ /**
+ *
+ * Gets the base64 encoded string representation of the inline image.
+ *
+ */
+ getBase64ImageSrc(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Wraps the inline picture with a rich text content control.
+ *
+ */
+ insertContentControl(): Word.ContentControl;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.InlinePicture;
+ }
+ /**
+ *
+ * Contains a collection of [inlinePicture](inlinePicture.md) objects.
+ */
+ class InlinePictureCollection extends OfficeExtension.ClientObject {
+ private m__ReferenceId;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Word.InlinePicture>;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.InlinePictureCollection;
+ }
+ /**
+ *
+ * Represents a single paragraph in a selection, range, content control, or document body.
+ */
+ class Paragraph extends OfficeExtension.ClientObject {
+ private m_alignment;
+ private m_contentControls;
+ private m_firstLineIndent;
+ private m_font;
+ private m_inlinePictures;
+ private m_leftIndent;
+ private m_lineSpacing;
+ private m_lineUnitAfter;
+ private m_lineUnitBefore;
+ private m_outlineLevel;
+ private m_parentContentControl;
+ private m_rightIndent;
+ private m_spaceAfter;
+ private m_spaceBefore;
+ private m_style;
+ private m_text;
+ private m__Id;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets the collection of content control objects that are in the paragraph. Read-only.
+ */
+ contentControls: Word.ContentControlCollection;
+ /**
+ *
+ * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only.
+ */
+ font: Word.Font;
+ /**
+ *
+ * Gets the collection of inlinePicture objects that are in the paragraph. The collection does not include floating images. Read-only.
+ */
+ inlinePictures: Word.InlinePictureCollection;
+ /**
+ *
+ * Gets the content control that contains the paragraph. Returns null if there isn't a parent content control. Read-only.
+ */
+ parentContentControl: Word.ContentControl;
+ /**
+ *
+ * Gets or sets the alignment for a paragraph. The value can be "left", "centered", "right", or "justified".
+ */
+ alignment: string;
+ /**
+ *
+ * Gets or sets the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.
+ */
+ firstLineIndent: number;
+ /**
+ *
+ * Gets or sets the left indent value, in points, for the paragraph.
+ */
+ leftIndent: number;
+ /**
+ *
+ * Gets or sets the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12.
+ */
+ lineSpacing: number;
+ /**
+ *
+ * Gets or sets the amount of spacing, in grid lines. after the paragraph.
+ */
+ lineUnitAfter: number;
+ /**
+ *
+ * Gets or sets the amount of spacing, in grid lines, before the paragraph.
+ */
+ lineUnitBefore: number;
+ /**
+ *
+ * Gets or sets the outline level for the paragraph.
+ */
+ outlineLevel: number;
+ /**
+ *
+ * Gets or sets the right indent value, in points, for the paragraph.
+ */
+ rightIndent: number;
+ /**
+ *
+ * Gets or sets the spacing, in points, after the paragraph.
+ */
+ spaceAfter: number;
+ /**
+ *
+ * Gets or sets the spacing, in points, before the paragraph.
+ */
+ spaceBefore: number;
+ /**
+ *
+ * Gets or sets the style used for the paragraph. This is the name of the pre-installed or custom style.
+ */
+ style: string;
+ /**
+ *
+ * Gets the text of the paragraph. Read-only.
+ */
+ text: string;
+ /**
+ *
+ * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content.
+ *
+ */
+ clear(): void;
+ /**
+ *
+ * Deletes the paragraph and its content from the document.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Gets the HTML representation of the paragraph object.
+ *
+ */
+ getHtml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Gets the Office Open XML (OOXML) representation of the paragraph object.
+ *
+ */
+ getOoxml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Inserts a break at the specified location. The insertLocation value can be 'Start' or 'End'.
+ *
+ * @param breakType Required. The break type to add to the document.
+ * @param insertLocation Required. The value can be 'Before' or 'After'.
+ */
+ insertBreak(breakType: string, insertLocation: string): void;
+ /**
+ *
+ * Wraps the paragraph object with a rich text content control.
+ *
+ */
+ insertContentControl(): Word.ContentControl;
+ /**
+ *
+ * Inserts a document into the current paragraph at the specified location. The insertLocation value can be 'Start' or 'End'.
+ *
+ * @param base64File Required. The file base64 encoded file contents to be inserted.
+ * @param insertLocation Required. The value can be 'Start' or 'End'.
+ */
+ insertFileFromBase64(base64File: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts HTML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param html Required. The HTML to be inserted in the paragraph.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertHtml(html: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts a picture into the paragraph at the specified location. The insertLocation value can be 'Before', 'After', 'Start' or 'End'.
+ *
+ * @param base64EncodedImage Required. The HTML to be inserted in the paragraph.
+ * @param insertLocation Required. The value can be 'Before', 'After', 'Start' or 'End'.
+ */
+ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: string): Word.InlinePicture;
+ /**
+ *
+ * Inserts OOXML into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param ooxml Required. The OOXML to be inserted in the paragraph.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertOoxml(ooxml: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts a paragraph at the specified location. The insertLocation value can be 'Before' or 'After'.
+ *
+ * @param paragraphText Required. The paragraph text to be inserted.
+ * @param insertLocation Required. The value can be 'Before' or 'After'.
+ */
+ insertParagraph(paragraphText: string, insertLocation: string): Word.Paragraph;
+ /**
+ *
+ * Inserts text into the paragraph at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param text Required. Text to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertText(text: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Performs a search with the specified searchOptions on the scope of the paragraph object. The search results are a collection of range objects.
+ *
+ * @param searchText Required. The search text.
+ * @param searchOptions Optional. Options for the search.
+ */
+ search(searchText: string, searchOptions?: Word.SearchOptions | {
+ ignorePunct?: boolean;
+ ignoreSpace?: boolean;
+ matchCase?: boolean;
+ matchPrefix?: boolean;
+ matchSoundsLike?: boolean;
+ matchSuffix?: boolean;
+ matchWholeWord?: boolean;
+ matchWildCards?: boolean;
+ }): Word.SearchResultCollection;
+ /**
+ *
+ * Selects and navigates the Word UI to the paragraph.
+ *
+ */
+ select(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.Paragraph;
+ }
+ /**
+ *
+ * Contains a collection of [paragraph](paragraph.md) objects.
+ */
+ class ParagraphCollection extends OfficeExtension.ClientObject {
+ private m__ReferenceId;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Word.Paragraph>;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.ParagraphCollection;
+ }
+ /**
+ *
+ * Represents a contiguous area in a document.
+ */
+ class Range extends OfficeExtension.ClientObject {
+ private m_contentControls;
+ private m_font;
+ private m_paragraphs;
+ private m_parentContentControl;
+ private m_style;
+ private m_text;
+ private m__Id;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets the collection of content control objects that are in the range. Read-only.
+ */
+ contentControls: Word.ContentControlCollection;
+ /**
+ *
+ * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only.
+ */
+ font: Word.Font;
+ /**
+ *
+ * Gets the collection of paragraph objects that are in the range. Read-only.
+ */
+ paragraphs: Word.ParagraphCollection;
+ /**
+ *
+ * Gets the content control that contains the range. Returns null if there isn't a parent content control. Read-only.
+ */
+ parentContentControl: Word.ContentControl;
+ /**
+ *
+ * Gets or sets the style used for the range. This is the name of the pre-installed or custom style.
+ */
+ style: string;
+ /**
+ *
+ * Gets the text of the range. Read-only.
+ */
+ text: string;
+ /**
+ *
+ * Clears the contents of the range object. The user can perform the undo operation on the cleared content.
+ *
+ */
+ clear(): void;
+ /**
+ *
+ * Deletes the range and its content from the document.
+ *
+ */
+ delete(): void;
+ /**
+ *
+ * Gets the HTML representation of the range object.
+ *
+ */
+ getHtml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Gets the OOXML representation of the range object.
+ *
+ */
+ getOoxml(): OfficeExtension.ClientResult<string>;
+ /**
+ *
+ * Inserts a break at the specified location. The insertLocation value can be 'Replace', 'Before' or 'After'.
+ *
+ * @param breakType Required. The break type to add to the range.
+ * @param insertLocation Required. The value can be 'Replace', 'Before' or 'After'.
+ */
+ insertBreak(breakType: string, insertLocation: string): void;
+ /**
+ *
+ * Wraps the range object with a rich text content control.
+ *
+ */
+ insertContentControl(): Word.ContentControl;
+ /**
+ *
+ * Inserts a document into the range at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param base64File Required. The file base64 encoded file contents to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertFileFromBase64(base64File: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts HTML into the range at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param html Required. The HTML to be inserted in the range.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertHtml(html: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts OOXML into the range at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param ooxml Required. The OOXML to be inserted in the range.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertOoxml(ooxml: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Inserts a paragraph into the range at the specified location. The insertLocation value can be 'Before' or 'After'.
+ *
+ * @param paragraphText Required. The paragraph text to be inserted.
+ * @param insertLocation Required. The value can be 'Before' or 'After'.
+ */
+ insertParagraph(paragraphText: string, insertLocation: string): Word.Paragraph;
+ /**
+ *
+ * Inserts text into the range at the specified location. The insertLocation value can be 'Replace', 'Start' or 'End'.
+ *
+ * @param text Required. Text to be inserted.
+ * @param insertLocation Required. The value can be 'Replace', 'Start' or 'End'.
+ */
+ insertText(text: string, insertLocation: string): Word.Range;
+ /**
+ *
+ * Performs a search with the specified searchOptions on the scope of the range object. The search results are a collection of range objects.
+ *
+ * @param searchText Required. The search text.
+ * @param searchOptions Optional. Options for the search.
+ */
+ search(searchText: string, searchOptions?: Word.SearchOptions | {
+ ignorePunct?: boolean;
+ ignoreSpace?: boolean;
+ matchCase?: boolean;
+ matchPrefix?: boolean;
+ matchSoundsLike?: boolean;
+ matchSuffix?: boolean;
+ matchWholeWord?: boolean;
+ matchWildCards?: boolean;
+ }): Word.SearchResultCollection;
+ /**
+ *
+ * Selects and navigates the Word UI to the range.
+ *
+ */
+ select(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.Range;
+ }
+ /**
+ *
+ * Specifies the options to be included in a search operation.
+ */
+ class SearchOptions extends OfficeExtension.ClientObject {
+ private m_ignorePunct;
+ private m_ignoreSpace;
+ private m_matchCase;
+ private m_matchPrefix;
+ private m_matchSoundsLike;
+ private m_matchSuffix;
+ private m_matchWholeWord;
+ private m_matchWildCards;
+ /**
+ *
+ * Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box.
+ */
+ ignorePunct: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether to ignore all white space between words. Corresponds to the Ignore white-space characters check box in the Find and Replace dialog box.
+ */
+ ignoreSpace: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box (Edit menu).
+ */
+ matchCase: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box.
+ */
+ matchPrefix: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether to find words that sound similar to the search string. Corresponds to the Sounds like check box in the Find and Replace dialog box
+ */
+ matchSoundsLike: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box.
+ */
+ matchSuffix: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box.
+ */
+ matchWholeWord: boolean;
+ /**
+ *
+ * Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box.
+ */
+ matchWildCards: boolean;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.SearchOptions;
+ /**
+ * Create a new instance of Word.SearchOptions object
+ */
+ static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions;
+ }
+ /**
+ *
+ * Contains a collection of [range](range.md) objects as a result of a search operation.
+ */
+ class SearchResultCollection extends OfficeExtension.ClientObject {
+ private m__ReferenceId;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Word.Range>;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.SearchResultCollection;
+ }
+ /**
+ *
+ * Represents a section in a Word document.
+ */
+ class Section extends OfficeExtension.ClientObject {
+ private m_body;
+ private m__Id;
+ private m__ReferenceId;
+ /**
+ *
+ * Gets the body of the section. This does not include the header/footer and other section metadata. Read-only.
+ */
+ body: Word.Body;
+ /**
+ *
+ * Gets one of the section's footers.
+ *
+ * @param type Required. The type of footer to return. This value can be: 'primary', 'firstPage' or 'evenPages'.
+ */
+ getFooter(type: string): Word.Body;
+ /**
+ *
+ * Gets one of the section's headers.
+ *
+ * @param type Required. The type of header to return. This value can be: 'primary', 'firstPage' or 'evenPages'.
+ */
+ getHeader(type: string): Word.Body;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.Section;
+ }
+ /**
+ *
+ * Contains the collection of the document's [section](section.md) objects.
+ */
+ class SectionCollection extends OfficeExtension.ClientObject {
+ private m__ReferenceId;
+ private m__items;
+ /** Gets the loaded child items in this collection. */
+ items: Array<Word.Section>;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
+ */
+ load(option?: string | string[] | OfficeExtension.LoadOption): Word.SectionCollection;
+ }
+ /**
+ *
+ * ContentControl types
+ */
+ module ContentControlType {
+ var richText: string;
+ }
+ /**
+ *
+ * ContentControl appearance
+ */
+ module ContentControlAppearance {
+ var boundingBox: string;
+ var tags: string;
+ var hidden: string;
+ }
+ /**
+ *
+ * Underline types
+ */
+ module UnderlineType {
+ var none: string;
+ var single: string;
+ var word: string;
+ var double: string;
+ var dotted: string;
+ var hidden: string;
+ var thick: string;
+ var dashLine: string;
+ var dotLine: string;
+ var dotDashLine: string;
+ var twoDotDashLine: string;
+ var wave: string;
+ }
+ module BreakType {
+ var page: string;
+ var column: string;
+ var next: string;
+ var sectionContinuous: string;
+ var sectionEven: string;
+ var sectionOdd: string;
+ var line: string;
+ var lineClearLeft: string;
+ var lineClearRight: string;
+ var textWrapping: string;
+ }
+ module InsertLocation {
+ var before: string;
+ var after: string;
+ var start: string;
+ var end: string;
+ var replace: string;
+ }
+ module Alignment {
+ var unknown: string;
+ var left: string;
+ var centered: string;
+ var right: string;
+ var justified: string;
+ }
+ module HeaderFooterType {
+ var primary: string;
+ var firstPage: string;
+ var evenPages: string;
+ }
+ module ErrorCodes {
+ var accessDenied: string;
+ var generalException: string;
+ var invalidArgument: string;
+ var itemNotFound: string;
+ var notImplemented: string;
+ }
+}
+declare module Word {
+ /**
+ * The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in.
+ */
+ class RequestContext extends OfficeExtension.ClientRequestContext {
+ private m_document;
+ constructor(url?: string);
+ document: Document;
+ }
+ /**
+ * Executes a batch script that performs actions on the Word object model. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
+ * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in.
+ */
+ function run<T>(batch: (context: Word.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;
+}
+
+declare module Office.MailboxEnums {
+ export enum BodyType {
+ /**
+ * The body is in HTML format
+ */
+ HTML,
+ /**
+ * The body is in text format
+ */
+ text
+ }
+ export enum EntityType {
+ /**
+ * Specifies that the entity is a meeting suggestion
+ */
+ MeetingSuggestion,
+ /**
+ * Specifies that the entity is a task suggestion
+ */
+ TaskSuggestion,
+ /**
+ * Specifies that the entity is a postal address
+ */
+ Address,
+ /**
+ * Specifies that the entity is SMTP email address
+ */
+ EmailAddress,
+ /**
+ * Specifies that the entity is an Internet URL
+ */
+ Url,
+ /**
+ * Specifies that the entity is US phone number
+ */
+ PhoneNumber,
+ /**
+ * Specifies that the entity is a contact
+ */
+ Contact
+ }
+ export enum ItemType {
+ /**
+ * A meeting request, response, or cancellation
+ */
+ Message,
+ /**
+ * Specifies an appointment item
+ */
+ Appointment
+ }
+ export enum ResponseType {
+ /**
+ * There has been no response from the attendee
+ */
+ None,
+ /**
+ * The attendee is the meeting organizer
+ */
+ Organizer,
+ /**
+ * The meeting request was tentatively accepted by the attendee
+ */
+ Tentative,
+ /**
+ * The meeting request was accepted by the attendee
+ */
+ Accepted,
+ /**
+ * The meeting request was declined by the attendee
+ */
+ Declined
+ }
+ export enum RecipientType {
+ /**
+ * Specifies that the recipient is not one of the other recipient types
+ */
+ Other,
+ /**
+ * Specifies that the recipient is a distribution list containing a list of email addresses
+ */
+ DistributionList,
+ /**
+ * Specifies that the recipient is an SMTP email address that is on the Exchange server
+ */
+ User,
+ /**
+ * Specifies that the recipient is an SMTP email address that is not on the Exchange server
+ */
+ ExternalUser
+ }
+ export enum AttachmentType {
+ /**
+ * The attachment is a file
+ */
+ File,
+ /**
+ * The attachment is an Exchange item
+ */
+ Item
+ }
+}
+declare module Office {
+ export module Types {
+ export interface ItemRead extends Office.Item {
+ subject: any;
+ /**
+ * Displays a reply form that includes the sender and all the recipients of the selected message
+ * @param htmlBody A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
+ */
+ displayReplyAllForm(htmlBody: string): void;
+ /**
+ * Displays a reply form that includes only the sender of the selected message
+ * @param htmlBody A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
+ */
+ displayReplyForm(htmlBody: string): void;
+ /**
+ * Gets an array of entities found in an message
+ */
+ getEntities(): Office.Entities;
+ /**
+ * Gets an array of entities of the specified entity type found in an message
+ * @param entityType One of the EntityType enumeration values
+ */
+ getEntitiesByType(entityType: Office.MailboxEnums.EntityType): Office.Entities;
+ /**
+ * Returns well-known entities that pass the named filter defined in the manifest XML file
+ * @param name A TableData object with the headers and rows
+ */
+ getFilteredEntitiesByName(name: string): Office.Entities;
+ /**
+ * Returns string values in the currently selected message object that match the regular expressions defined in the manifest XML file
+ */
+ getRegExMatches(): string[];
+ /**
+ * Returns string values that match the named regular expression defined in the manifest XML file
+ */
+ getRegExMatchesByName(name: string): string[];
+ }
+ export interface ItemCompose extends Office.Item {
+ body: Office.Body;
+ subject: any;
+ /**
+ * Adds a file to a message as an attachment
+ * @param uri The URI that provides the location of the file to attach to the message. The maximum length is 2048 characters
+ * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ addFileAttachmentAsync(uri: string, attachmentName: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Adds an Exchange item, such as a message, as an attachment to the message
+ * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters
+ * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ addItemAttachmentAsync(itemId: any, attachmentName: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes an attachment from a message
+ * @param attachmentIndex The index of the attachment to remove. The maximum length of the string is 100 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ removeAttachmentAsync(attachmentIndex: string, option?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface MessageCompose extends Office.Message {
+ attachments: Office.AttachmentDetails[];
+ body: Office.Body;
+ bcc: Office.Recipients;
+ cc: Office.Recipients;
+ subject: Office.Subject;
+ to: Office.Recipients;
+ /**
+ * Adds a file to a message as an attachment
+ * @param uri The URI that provides the location of the file to attach to the message. The maximum length is 2048 characters
+ * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ addFileAttachmentAsync(uri: string, attachmentName: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Adds an Exchange item, such as a message, as an attachment to the message
+ * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters
+ * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ addItemAttachmentAsync(itemId: any, attachmentName: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes an attachment from a message
+ * @param attachmentIndex The index of the attachment to remove. The maximum length of the string is 100 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ removeAttachmentAsync(attachmentIndex: string, option?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface MessageRead extends Office.Message {
+ cc: Office.EmailAddressDetails[];
+ from: Office.EmailAddressDetails;
+ internetMessageId: string;
+ normalizedSubject: string;
+ sender: Office.EmailAddressDetails;
+ subject: string;
+ to: Office.EmailAddressDetails;
+ /**
+ * Displays a reply form that includes the sender and all the recipients of the selected message
+ * @param htmlBody A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
+ */
+ displayReplyAllForm(htmlBody: string): void;
+ /**
+ * Displays a reply form that includes only the sender of the selected message
+ * @param htmlBody A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
+ */
+ displayReplyForm(htmlBody: string): void;
+ /**
+ * Gets an array of entities found in an message
+ */
+ getEntities(): Office.Entities;
+ /**
+ * Gets an array of entities of the specified entity type found in an message
+ * @param entityType One of the EntityType enumeration values
+ */
+ getEntitiesByType(entityType: Office.MailboxEnums.EntityType): Office.Entities;
+ /**
+ * Returns well-known entities that pass the named filter defined in the manifest XML file
+ * @param name A TableData object with the headers and rows
+ */
+ getFilteredEntitiesByName(name: string): Office.Entities;
+ /**
+ * Returns string values in the currently selected message object that match the regular expressions defined in the manifest XML file
+ */
+ getRegExMatches(): string[];
+ /**
+ * Returns string values that match the named regular expression defined in the manifest XML file
+ */
+ getRegExMatchesByName(name: string): string[];
+ }
+ export interface AppointmentCompose extends Office.Appointment {
+ body: Office.Body;
+ end: Office.Time;
+ location: Office.Location;
+ optionalAttendees: Office.Recipients;
+ requiredAttendees: Office.Recipients;
+ start: Office.Time;
+ subject: Office.Subject;
+ /**
+ * Adds a file to an appointment as an attachment
+ * @param uri The URI that provides the location of the file to attach to the appointment. The maximum length is 2048 characters
+ * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ addFileAttachmentAsync(uri: string, attachmentName: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Adds an Exchange item, such as a message, as an attachment to the appointment
+ * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters
+ * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ addItemAttachmentAsync(itemId: any, attachmentName: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Removes an attachment from a appointment
+ * @param attachmentIndex The index of the attachment to remove. The maximum length of the string is 100 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional callback method
+ */
+ removeAttachmentAsync(attachmentIndex: string, option?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface AppointmentRead extends Office.Appointment {
+ attachments: Office.AttachmentDetails[];
+ end: Date;
+ location: string;
+ normalizedSubject: string;
+ optionalAttendees: Office.EmailAddressDetails;
+ organizer: Office.EmailAddressDetails;
+ requiredAttendees: Office.EmailAddressDetails;
+ resources: string[];
+ start: Date;
+ subject: string;
+ /**
+ * Displays a reply form that includes the organizer and all the attendees of the selected appointment item
+ * @param htmlBody A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
+ */
+ displayReplyAllForm(htmlBody: string): void;
+ /**
+ * Displays a reply form that includes only the organizer of the selected appointment item
+ * @param htmlBody A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
+ */
+ displayReplyForm(htmlBody: string): void;
+ /**
+ * Gets an array of entities found in an appointment
+ */
+ getEntities(): Office.Entities;
+ /**
+ * Gets an array of entities of the specified entity type found in an appointment
+ * @param entityType One of the EntityType enumeration values
+ */
+ getEntitiesByType(entityType: Office.MailboxEnums.EntityType): Office.Entities;
+ /**
+ * Returns well-known entities that pass the named filter defined in the manifest XML file
+ * @param name A TableData object with the headers and rows
+ */
+ getFilteredEntitiesByName(name: string): Office.Entities;
+ /**
+ * Returns string values in the currently selected appointment object that match the regular expressions defined in the manifest XML file
+ */
+ getRegExMatches(): string[];
+ /**
+ * Returns string values that match the named regular expression defined in the manifest XML file
+ */
+ getRegExMatchesByName(name: string): string[];
+ }
+ }
+ export module cast {
+ export module item {
+ function toAppointmentCompose(item: Office.Item): Office.Types.AppointmentCompose;
+ function toAppointmentRead(item: Office.Item): Office.Types.AppointmentRead;
+ function toAppointment(item: Office.Item): Office.Appointment;
+ function toMessageCompose(item: Office.Item): Office.Types.MessageCompose;
+ function toMessageRead(item: Office.Item): Office.Types.MessageRead;
+ function toMessage(item: Office.Item): Office.Message;
+ function toItemCompose(item: Office.Item): Office.Types.ItemCompose;
+ function toItemRead(item: Office.Item): Office.Types.ItemRead;
+ }
+ }
+ export interface AttachmentDetails {
+ attachmentType: Office.MailboxEnums.AttachmentType;
+ contentType: string;
+ id: string;
+ isInline: boolean;
+ name: string;
+ size: number;
+ }
+ export interface Contact {
+ personName: string;
+ businessName: string;
+ phoneNumbers: PhoneNumber[];
+ emailAddresses: string[];
+ urls: string[];
+ addresses: string[];
+ contactString: string;
+ }
+
+ export interface Context {
+ mailbox: Mailbox;
+ roamingSettings: RoamingSettings;
+ }
+ export interface CustomProperties {
+ /**
+ * Returns the value of the specified custom property
+ * @param name The name of the property to be returned
+ */
+ get(name: string): any;
+ /**
+ * Sets the specified property to the specified value
+ * @param name The name of the property to be set
+ * @param value The value of the property to be set
+ */
+ set(name: string, value: string): void;
+ /**
+ * Removes the specified property from the custom property collection.
+ * @param name The name of the property to be removed
+ */
+ remove(name: string): void;
+ /**
+ * Saves the custom property collection to the server
+ * @param callback The optional callback method
+ * @param userContext Optional variable for any state data that is passed to the saveAsync method
+ */
+ saveAsync(callback?: (result: AsyncResult) => void, userContext?: any): void;
+ }
+ export interface EmailAddressDetails {
+ emailAddress: string;
+ displayName: string;
+ appointmentResponse: Office.MailboxEnums.ResponseType;
+ recipientType: Office.MailboxEnums.RecipientType;
+ }
+ export interface EmailUser {
+ name: string;
+ userId: string;
+ }
+ export interface Entities {
+ addresses: string[];
+ taskSuggestions: string[];
+ meetingSuggestions: MeetingSuggestion[];
+ emailAddresses: string[];
+ urls: string[];
+ phoneNumbers: PhoneNumber[];
+ contacts: Contact[];
+ }
+ export interface Item {
+ dateTimeCreated: Date;
+ dateTimeModified: Date;
+ itemClass: string;
+ itemId: string;
+ itemType: Office.MailboxEnums.ItemType;
+ /**
+ * Asynchronously loads custom properties that are specific to the item and a app for Office
+ * @param callback The optional callback method
+ * @param userContext Optional variable for any state data that is passed to the asynchronous method
+ */
+ loadCustomPropertiesAsync(callback?: (result: AsyncResult) => void, userContext?: any): void;
+ }
+ export interface Appointment extends Item {
+ }
+ export interface Body {
+ /**
+ * Gets a value that indicates whether the content is in HTML or text format
+ * @param tableData A TableData object with the headers and rows
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the getTypeAsync method returns
+ */
+ getTypeAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Adds the specified content to the beginning of the item body
+ * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ prependAsync(data: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Replaces the selection in the body with the specified text
+ * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ setSelectedDataAsync(data: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface Location {
+ /**
+ * Begins an asynchronous request for the location of an appointment
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ getAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Begins an asynchronous request to set the location of an appointment
+ * @param data The location of the appointment. The string is limited to 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the location is set
+ */
+ setAsync(location: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface Mailbox {
+ item: Item;
+ userProfile: UserProfile;
+ /**
+ * Gets a Date object from a dictionary containing time information
+ * @param timeValue A Date object
+ */
+ convertToLocalClientTime(timeValue: Date): any;
+ /**
+ * Gets a dictionary containing time information in local client time
+ * @param input A dictionary containing a date. The dictionary should contain the following fields: year, month, date, hours, minutes, seconds, time zone, time zone offset
+ */
+ convertToUtcClientTime(input: any): Date;
+ /**
+ * Displays an existing calendar appointment
+ * @param itemId The Exchange Web Services (EWS) identifier for an existing calendar appointment
+ */
+ displayAppointmentForm(itemId: any): void;
+ /**
+ * Displays an existing message
+ * @param itemId The Exchange Web Services (EWS) identifier for an existing message
+ */
+ displayMessageForm(itemId: any): void;
+ /**
+ * Displays a form for creating a new calendar appointment
+ * @param requiredAttendees An array of strings containing the email addresses or an array containing an EmailAddressDetails object for each of the required attendees for the appointment. The array is limited to a maximum of 100 entries
+ * @param optionalAttendees An array of strings containing the email addresses or an array containing an EmailAddressDetails object for each of the optional attendees for the appointment. The array is limited to a maximum of 100 entries
+ * @param start A Date object specifying the start date and time of the appointment
+ * @param end A Date object specifying the end date and time of the appointment
+ * @param location A string containing the location of the appointment. The string is limited to a maximum of 255 characters
+ * @param resources An array of strings containing the resources required for the appointment. The array is limited to a maximum of 100 entries
+ * @param subject A string containing the subject of the appointment. The string is limited to a maximum of 255 characters
+ * @param body The body of the appointment message. The body content is limited to a maximum size of 32 KB
+ */
+ displayNewAppointmentForm(requiredAttendees: any, optionalAttendees: any, start: Date, end: Date, location: string, resources: string[], subject: string, body: string): void;
+ /**
+ * Gets a string that contains a token used to get an attachment or item from an Exchange Server
+ * @param callback The optional method to call when the string is inserted
+ * @param userContext Optional variable for any state data that is passed to the asynchronous method
+ */
+ getCallbackTokenAsync(callback?: (result: AsyncResult) => void, userContext?: any): void;
+ /**
+ * Gets a token identifying the user and the app for Office
+ * @param callback The optional method to call when the string is inserted
+ * @param userContext Optional variable for any state data that is passed to the asynchronous method
+ */
+ getUserIdentityTokenAsync(callback?: (result: AsyncResult) => void, userContext?: any): void;
+ /**
+ * Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user’s mailbox
+ * @param data The EWS request
+ * @param callback The optional method to call when the string is inserted
+ * @param userContext Optional variable for any state data that is passed to the asynchronous method
+ */
+ makeEwsRequestAsync(data: any, callback?: (result: AsyncResult) => void, userContext?: any): void;
+ }
+ export interface Message extends Item {
+ conversationId: string;
+ }
+ export interface MeetingRequest extends Message {
+ start: Date;
+ end: Date;
+ location: string;
+ optionalAttendees: EmailAddressDetails[];
+ requiredAttendees: EmailAddressDetails[];
+ }
+ export interface MeetingSuggestion {
+ meetingString: string;
+ attendees: EmailAddressDetails[];
+ location: string;
+ subject: string;
+ start: Date;
+ end: Date;
+ }
+ export interface PhoneNumber {
+ phoneString: string;
+ originalPhoneString: string;
+ type: string;
+ }
+ export interface Recipients {
+ /**
+ * Begins an asynchronous request to add a recipient list to an appointment or message
+ * @param recipients The recipients to add to the recipients list
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ addAsync(recipients: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Begins an asynchronous request to get the recipient list for an appointment or message
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ getAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Begins an asynchronous request to set the recipient list for an appointment or message
+ * @param recipients The recipients to add to the recipients list
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ setAsync(recipients: any, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface RoamingSettings {
+ /**
+ * Retrieves the specified setting
+ * @param name The case-sensitive name of the setting to retrieve
+ */
+ get(name: string): any;
+ /**
+ * Removes the specified setting
+ * @param name The case-sensitive name of the setting to remove
+ */
+ remove(name: string): void;
+ /**
+ * Saves the settings
+ * @param callback A function that is invoked when the callback returns, whose only parameter is of type AsyncResult
+ */
+ saveAsync(callback?: (result: AsyncResult) => void): void;
+ /**
+ * Sets or creates the specified setting
+ * @param name The case-sensitive name of the setting to set or create
+ * @param value Specifies the value to be stored
+ */
+ set(name: string, value: any): void;
+ }
+ export interface Subject {
+ /**
+ * Begins an asynchronous request to get the subject of an appointment or message
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ getAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Begins an asynchronous call to set the subject of an appointment or message
+ * @param data The subject of the appointment. The string is limited to 255 characters
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ setAsync(data: string, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface TaskSuggestion {
+ assignees: EmailUser[];
+ taskString: string;
+ }
+ export interface Time {
+ /**
+ * Begins an asynchronous request to get the start or end time
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ getAsync(options?: any, callback?: (result: AsyncResult) => void): void;
+ /**
+ * Begins an asynchronous request to set the start or end time
+ * @param dateTime A date-time object in Coordinated Universal Time (UTC)
+ * @param options Any optional parameters or state data passed to the method
+ * @param callback The optional method to call when the string is inserted
+ */
+ setAsync(dateTime: Date, options?: any, callback?: (result: AsyncResult) => void): void;
+ }
+ export interface UserProfile {
+ displayName: string;
+ emailAddress: string;
+ timeZone: string;
+ }
+}
diff --git a/openlayers/openlayers.d.ts b/openlayers/openlayers.d.ts
index 89680ac91d..c81a42084f 100644
--- a/openlayers/openlayers.d.ts
+++ b/openlayers/openlayers.d.ts
@@ -4368,3 +4368,7 @@ declare module ol {
*/
interface TransformFunction { (input: Array<number>, output?: Array<number>, dimension?: number): Array<number> }
}
+
+declare module "openlayers" {
+ export = ol;
+}
diff --git a/pdf/pdf.d.ts b/pdf/pdf.d.ts
index 802c0e601a..523cfc5e81 100644
--- a/pdf/pdf.d.ts
+++ b/pdf/pdf.d.ts
@@ -72,66 +72,66 @@ interface PDFProgressData {
interface PDFDocumentProxy {
/**
- * Total number of pages the PDF contains.
- **/
+ * Total number of pages the PDF contains.
+ **/
numPages: number;
/**
- * A unique ID to identify a PDF. Not guaranteed to be unique. [jbaldwin: haha what]
- **/
+ * A unique ID to identify a PDF. Not guaranteed to be unique. [jbaldwin: haha what]
+ **/
fingerprint: string;
/**
- * True if embedded document fonts are in use. Will be set during rendering of the pages.
- **/
+ * True if embedded document fonts are in use. Will be set during rendering of the pages.
+ **/
embeddedFontsUsed(): boolean;
/**
- * @param number The page number to get. The first page is 1.
- * @return A promise that is resolved with a PDFPageProxy.
- **/
+ * @param number The page number to get. The first page is 1.
+ * @return A promise that is resolved with a PDFPageProxy.
+ **/
getPage(number: number): PDFPromise<PDFPageProxy>;
/**
- * TODO: return type of Promise<???>
- * A promise that is resolved with a lookup table for mapping named destinations to reference numbers.
- **/
+ * TODO: return type of Promise<???>
+ * A promise that is resolved with a lookup table for mapping named destinations to reference numbers.
+ **/
getDestinations(): PDFPromise<any[]>;
/**
- * A promise that is resolved with an array of all the JavaScript strings in the name tree.
- **/
+ * A promise that is resolved with an array of all the JavaScript strings in the name tree.
+ **/
getJavaScript(): PDFPromise<string[]>;
/**
- * A promise that is resolved with an array that is a tree outline (if it has one) of the PDF. @see PDFTreeNode
- **/
+ * A promise that is resolved with an array that is a tree outline (if it has one) of the PDF. @see PDFTreeNode
+ **/
getOutline(): PDFPromise<PDFTreeNode[]>;
/**
- * A promise that is resolved with the info and metadata of the PDF.
- **/
+ * A promise that is resolved with the info and metadata of the PDF.
+ **/
getMetadata(): PDFPromise<{ info: PDFInfo; metadata: PDFMetadata }>;
/**
- * Is the PDF encrypted?
- **/
+ * Is the PDF encrypted?
+ **/
isEncrypted(): PDFPromise<boolean>;
/**
- * A promise that is resolved with Uint8Array that has the raw PDF data.
- **/
+ * A promise that is resolved with Uint8Array that has the raw PDF data.
+ **/
getData(): PDFPromise<Uint8Array>;
/**
- * TODO: return type of Promise<???>
- * A promise that is resolved when the document's data is loaded.
- **/
+ * TODO: return type of Promise<???>
+ * A promise that is resolved when the document's data is loaded.
+ **/
dataLoaded(): PDFPromise<any[]>;
/**
- *
- **/
+ *
+ **/
destroy(): void;
}
@@ -173,11 +173,11 @@ interface PDFAnnotationData {
interface PDFAnnotations {
getData(): PDFAnnotationData;
hasHtml(): boolean; // always false
- getHtmlElement(commonOjbs): HTMLElement; // throw new NotImplementedException()
+ getHtmlElement(commonOjbs: any): HTMLElement; // throw new NotImplementedException()
getEmptyContainer(tagName: string, rect: number[]): HTMLElement; // deprecated
isViewable(): boolean;
- loadResources(keys): PDFPromise<any>;
- getOperatorList(evaluator): PDFPromise<any>;
+ loadResources(keys: any): PDFPromise<any>;
+ getOperatorList(evaluator: any): PDFPromise<any>;
// ... todo
}
@@ -206,142 +206,142 @@ interface PDFViewerParams {
}
/**
-* RenderTask is basically a promise but adds a cancel function to termiate it.
-**/
+ * RenderTask is basically a promise but adds a cancel function to termiate it.
+ **/
interface PDFRenderTask extends PDFPromise<PDFPageProxy> {
/**
- * Cancel the rendering task. If the task is currently rendering it will not be cancelled until graphics pauses with a timeout. The promise that this object extends will resolve when cancelled.
- **/
+ * Cancel the rendering task. If the task is currently rendering it will not be cancelled until graphics pauses with a timeout. The promise that this object extends will resolve when cancelled.
+ **/
cancel(): void;
}
interface PDFPageProxy {
/**
- * Page number of the page. First page is 1.
- **/
+ * Page number of the page. First page is 1.
+ **/
pageNumber(): number;
/**
- * The number of degrees the page is rotated clockwise.
- **/
+ * The number of degrees the page is rotated clockwise.
+ **/
rotate(): number;
/**
- * The reference that points to this page.
- **/
+ * The reference that points to this page.
+ **/
ref(): PDFRef;
/**
- * @return An array of the visible portion of the PDF page in the user space units - [x1, y1, x2, y2].
- **/
+ * @return An array of the visible portion of the PDF page in the user space units - [x1, y1, x2, y2].
+ **/
view(): number[];
/**
- * @param scale The desired scale of the viewport.
- * @param rotate Degrees to rotate the viewport. If omitted this defaults to the page rotation.
- * @return
- **/
+ * @param scale The desired scale of the viewport.
+ * @param rotate Degrees to rotate the viewport. If omitted this defaults to the page rotation.
+ * @return
+ **/
getViewport(scale: number, rotate?: number): PDFPageViewport;
/**
- * A promise that is resolved with an array of the annotation objects.
- **/
+ * A promise that is resolved with an array of the annotation objects.
+ **/
getAnnotations(): PDFPromise<PDFAnnotations>;
/**
- * Begins the process of rendering a page to the desired context.
- * @param params Rendering options.
- * @return An extended promise that is resolved when the page finishes rendering.
- **/
+ * Begins the process of rendering a page to the desired context.
+ * @param params Rendering options.
+ * @return An extended promise that is resolved when the page finishes rendering.
+ **/
render(params: PDFRenderParams): PDFRenderTask;
/**
- * A promise that is resolved with the string that is the text content frm the page.
- **/
- getTextContent(): PDFPromise<TextContent>;
+ * A promise that is resolved with the string that is the text content frm the page.
+ **/
+ getTextContent(): PDFPromise<TextContent>;
/**
- * marked as future feature
- **/
+ * marked as future feature
+ **/
//getOperationList(): PDFPromise<>;
/**
- * Destroyes resources allocated by the page.
- **/
+ * Destroyes resources allocated by the page.
+ **/
destroy(): void;
}
interface TextContentItem {
- str: string;
- transform: number[]; // [0..5] 4=x, 5=y
- width: number;
- height: number;
- dir: string; // Left-to-right (ltr), etc
- fontName: string; // A lookup into the styles map of the owning TextContent
+ str: string;
+ transform: number[]; // [0..5] 4=x, 5=y
+ width: number;
+ height: number;
+ dir: string; // Left-to-right (ltr), etc
+ fontName: string; // A lookup into the styles map of the owning TextContent
}
interface TextContent {
- items: TextContentItem[];
- styles: any;
+ items: TextContentItem[];
+ styles: any;
}
/**
-* A PDF document and page is built of many objects. E.g. there are objects for fonts, images, rendering code and such. These objects might get processed inside of a worker. The `PDFObjects` implements some basic functions to manage these objects.
-**/
+ * A PDF document and page is built of many objects. E.g. there are objects for fonts, images, rendering code and such. These objects might get processed inside of a worker. The `PDFObjects` implements some basic functions to manage these objects.
+ **/
interface PDFObjects {
- get(objId, callback?): any;
- resolve(objId, data);
- isResolved(objId): boolean;
- hasData(objId): boolean;
- getData(objId): any;
+ get(objId: number, callback?: any): any;
+ resolve(objId: number, data: any): any;
+ isResolved(objId: number): boolean;
+ hasData(objId: number): boolean;
+ getData(objId: number): any;
clear(): void;
}
interface PDFJSStatic {
/**
- * The maximum allowed image size in total pixels e.g. width * height. Images above this value will not be drawn. Use -1 for no limit.
- **/
+ * The maximum allowed image size in total pixels e.g. width * height. Images above this value will not be drawn. Use -1 for no limit.
+ **/
maxImageSize: number;
/**
- * By default fonts are converted to OpenType fonts and loaded via font face rules. If disabled, the font will be rendered using a built in font renderer that constructs the glyphs with primitive path commands.
- **/
+ * By default fonts are converted to OpenType fonts and loaded via font face rules. If disabled, the font will be rendered using a built in font renderer that constructs the glyphs with primitive path commands.
+ **/
disableFontFace: boolean;
/**
- * This is the main entry point for loading a PDF and interacting with it.
- * NOTE: If a URL is used to fetch the PDF data a standard XMLHttpRequest(XHR)
- * is used, which means it must follow the same origin rules that any XHR does
- * e.g. No corss domain requests without CORS.
- * @param source
- * @param pdfDataRangeTransport Used if you want to manually server range requests for data in the PDF. @ee viewer.js for an example of pdfDataRangeTransport's interface.
- * @param passwordCallback Used to request a password if wrong or no password was provided. The callback receives two parameters: function that needs to be called with new password and the reason.
- * @param progressCallback Progress callback.
- * @return A promise that is resolved with PDFDocumentProxy object.
- **/
+ * This is the main entry point for loading a PDF and interacting with it.
+ * NOTE: If a URL is used to fetch the PDF data a standard XMLHttpRequest(XHR)
+ * is used, which means it must follow the same origin rules that any XHR does
+ * e.g. No corss domain requests without CORS.
+ * @param source
+ * @param pdfDataRangeTransport Used if you want to manually server range requests for data in the PDF. @ee viewer.js for an example of pdfDataRangeTransport's interface.
+ * @param passwordCallback Used to request a password if wrong or no password was provided. The callback receives two parameters: function that needs to be called with new password and the reason.
+ * @param progressCallback Progress callback.
+ * @return A promise that is resolved with PDFDocumentProxy object.
+ **/
getDocument(
- source: string,
- pdfDataRangeTransport?,
- passwordCallback?: (fn: (password: string) => void, reason: string) => string,
- progressCallback?: (progressData: PDFProgressData) => void)
- : PDFPromise<PDFDocumentProxy>;
+ source: string,
+ pdfDataRangeTransport?: any,
+ passwordCallback?: (fn: (password: string) => void, reason: string) => string,
+ progressCallback?: (progressData: PDFProgressData) => void)
+ : PDFPromise<PDFDocumentProxy>;
getDocument(
- source: Uint8Array,
- pdfDataRangeTransport?,
- passwordCallback?: (fn: (password: string) => void, reason: string) => string,
- progressCallback?: (progressData: PDFProgressData) => void)
- : PDFPromise<PDFDocumentProxy>;
+ source: Uint8Array,
+ pdfDataRangeTransport?: any,
+ passwordCallback?: (fn: (password: string) => void, reason: string) => string,
+ progressCallback?: (progressData: PDFProgressData) => void)
+ : PDFPromise<PDFDocumentProxy>;
getDocument(
- source: PDFSource,
- pdfDataRangeTransport?,
- passwordCallback?: (fn: (password: string) => void, reason: string) => string,
- progressCallback?: (progressData: PDFProgressData) => void)
- : PDFPromise<PDFDocumentProxy>;
+ source: PDFSource,
+ pdfDataRangeTransport?: any,
+ passwordCallback?: (fn: (password: string) => void, reason: string) => string,
+ progressCallback?: (progressData: PDFProgressData) => void)
+ : PDFPromise<PDFDocumentProxy>;
PDFViewer(params: PDFViewerParams): void;
}
diff --git a/pgwmodal/pgwmodal-test.ts b/pgwmodal/pgwmodal-tests.ts
similarity index 100%
rename from pgwmodal/pgwmodal-test.ts
rename to pgwmodal/pgwmodal-tests.ts
diff --git a/pinkyswear/pinkyswear-tests.ts b/pinkyswear/pinkyswear-tests.ts
new file mode 100644
index 0000000000..14709dda4d
--- /dev/null
+++ b/pinkyswear/pinkyswear-tests.ts
@@ -0,0 +1,40 @@
+/// <reference path="pinkyswear.d.ts" />
+
+var promise: PinkySwear.Promise = pinkySwear();
+
+promise.then(function(value) {
+ console.log("Success with value " + value + "1");
+}, function(value) {
+ console.log("Failure with value " + value + "!");
+});
+
+promise(true, [42]);
+
+// Promise rejected with multiple values
+
+promise = pinkySwear();
+
+promise.then(function(...values: any[]) {
+ console.log("Success with value " + values.join(',') + "1");
+}, function(...values: any[]) {
+ console.log("Failure with value " + values.join(',') + "!");
+});
+
+promise(false, [6, 6, 6]);
+
+var state: boolean = promise();
+
+// A PinkySwear-powered timeout function that returns a promise:
+
+function promiseTimeout(timeoutMs: number) {
+ var prom = pinkySwear();
+ setTimeout(function() {
+ prom(true, []);
+ }, timeoutMs);
+ return prom;
+}
+
+console.log('Starting timeout now.');
+promiseTimeout(5000).then(function() {
+ console.log('5s have passed.');
+});
diff --git a/pinkyswear/pinkyswear.d.ts b/pinkyswear/pinkyswear.d.ts
new file mode 100644
index 0000000000..6cc3b9d648
--- /dev/null
+++ b/pinkyswear/pinkyswear.d.ts
@@ -0,0 +1,235 @@
+// Type definitions for PinkySwear v2.2.2
+// Project: https://github.com/timjansen/PinkySwear.js
+// Definitions by: Chance Snow <https://github.com/chances/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/*
+ * PinkySwear.js 2.2.2 - Minimalistic implementation of the Promises/A+ spec
+ *
+ * Public Domain. Use, modify and distribute it any way you like. No attribution required.
+ *
+ * NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
+*/
+
+declare module PinkySwear {
+
+ interface Promise {
+
+ /**
+ * Get the promise's current state; true if fulfilled, false if rejected, and undefined, otherwise.
+ */
+ (): boolean;
+
+ /**
+ * Fulfill or reject the promise.
+ *
+ * @param fulfilled true to fulfill promise, false to reject
+ * @param values Value(s) with which to fulfill or reject the promise
+ * @returns PinkySwear.Promise
+ */
+ (fulfilled: boolean, ...values: any[]): Promise;
+
+ /**
+ * Called when or if the promise is either resolved or rejected.
+ *
+ * @returns PinkySwear.Promise
+ */
+ then(): Promise;
+
+ /**
+ * Called when or if the promise is either resolved or rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: () => Promise, onRejected?: () => void): Promise;
+
+ /**
+ * Called when or if the promise is either resolved or rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: () => void, onRejected?: () => void): Promise;
+
+ /**
+ * Called when or if the promise is either resolved or rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: () => any, onRejected?: () => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (...values: any[]) => Promise, onRejected?: (...values: any[]) => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (...values: any[]) => void, onRejected?: (...values: any[]) => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (...values: any[]) => any, onRejected?: (...values: any[]) => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (...values: any[]) => Promise, onRejected?: (error?: TypeError) => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (...values: any[]) => void, onRejected?: (error: TypeError) => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (...values: any[]) => any, onRejected?: (error: TypeError) => void): Promise;
+ }
+
+ interface GenericPromise<T> extends Promise {
+
+ /**
+ * Fulfill or reject the promise.
+ *
+ * @param fulfilled true to fulfill promise, false to reject
+ * @param value Value with which to fulfill or reject the promise
+ */
+ (fulfilled: boolean, value: T): boolean;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.GenericPromise
+ */
+ then<G>(onFulfilled?: (value: T) => G, onRejected?: (value: T) => void): GenericPromise<G>;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.GenericPromise
+ */
+ then<G>(onFulfilled?: (value: T) => GenericPromise<G>, onRejected?: (value: T) => void): GenericPromise<G>;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (value: T) => void, onRejected?: (value: T) => void): Promise;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.GenericPromise
+ */
+ then<G>(onFulfilled?: (value: T) => G, onRejected?: (error: TypeError) => void): GenericPromise<G>;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.GenericPromise
+ */
+ then<G>(onFulfilled?: (value: T) => GenericPromise<G>, onRejected?: (error: TypeError) => void): GenericPromise<G>;
+
+ /**
+ * onFulfilled is called when or if the promise is resolved.
+ * onRejected is called when or if the promise is rejected.
+ *
+ * @param onFulfilled Called when or if the promise is resolved.
+ * @param onRejected Called when or if the promise is rejected.
+ * @returns PinkySwear.Promise
+ */
+ then(onFulfilled?: (value: T) => void, onRejected?: (error: TypeError) => void): Promise;
+ }
+}
+
+interface PinkySwearStatic {
+ /**
+ * Create a new generic promise in pending state that promises a value of a specific type and that also extends
+ * the returned generic promise object as specified in an extend function.
+ *
+ * @param extend Called when the promise is created and is ready to be extended.
+ * @returns PinkySwear.GenericPromise
+ */
+ <T>(extend: (promise: PinkySwear.GenericPromise<T>) => PinkySwear.GenericPromise<T>): PinkySwear.GenericPromise<T>;
+
+ /**
+ * Create a new generic promise in pending state that promises a value of a specific type.
+ *
+ * @see PinkySwear.GenericPromise
+ * @returns PinkySwear.GenericPromise
+ */
+ <T>(): PinkySwear.GenericPromise<T>;
+
+ /**
+ * Create a new promise in pending state that promises a value of a specific type and that also extends the
+ * returned promise object as specified in an extend function.
+ *
+ * @param extend Called when the promise is created and is ready to be extended.
+ * @returns PinkySwear.Promise
+ */
+ <T>(extend: (promise: PinkySwear.Promise) => PinkySwear.Promise): PinkySwear.Promise;
+
+ /**
+ * Create a new promise in pending state that promises a value or set of values.
+ *
+ * @see PinkySwear.Promise
+ * @returns PinkySwear.Promise
+ */
+ (): PinkySwear.Promise;
+}
+
+declare var pinkySwear: PinkySwearStatic;
diff --git a/pngjs2/pngjs2-tests.ts b/pngjs2/pngjs2-tests.ts
new file mode 100644
index 0000000000..ae2d73e7b3
--- /dev/null
+++ b/pngjs2/pngjs2-tests.ts
@@ -0,0 +1,26 @@
+/// <reference path="pngjs2.d.ts" />
+
+import * as fs from "fs";
+import { PNG } from "pngjs2";
+
+let png = new PNG({ filterType: 4 });
+
+fs.createReadStream("in.png")
+ .pipe(png)
+ .on("parsed", () => {
+ for (let y = 0; y < png.height; y++) {
+ for (let x = 0; x < png.width; x++) {
+ let idx = (png.width * y + x) << 2;
+
+ // invert color
+ png.data[idx] = 255 - png.data[idx];
+ png.data[idx+1] = 255 - png.data[idx+1];
+ png.data[idx+2] = 255 - png.data[idx+2];
+
+ // and reduce opacity
+ png.data[idx+3] = png.data[idx+3] >> 1;
+ }
+ }
+
+ png.pack().pipe(fs.createWriteStream('out.png'));
+ });
diff --git a/pngjs2/pngjs2.d.ts b/pngjs2/pngjs2.d.ts
new file mode 100644
index 0000000000..e44dbfdd69
--- /dev/null
+++ b/pngjs2/pngjs2.d.ts
@@ -0,0 +1,64 @@
+// Type definitions for pngjs2 2.0.0
+// Project: https://www.npmjs.com/package/pngjs2
+// Definitions by: Elisée Maurer <https://sparklinlabs.com/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module "pngjs2" {
+ import fs = require("fs");
+ import events = require("events");
+ import stream = require("stream");
+
+ interface PNGOptions {
+ width?: number;
+ height?: number;
+ checkCRC?: boolean;
+ deflateChunkSize?: number;
+ deflateLevel?: number;
+ deflateStrategy?: number;
+ deflateFactory?: any;
+ filterType?: number|number[];
+ colorType?: number;
+ inputHasAlpha?: boolean;
+ }
+
+ interface PNGMetadata {
+ width: number;
+ height: number;
+ palette: boolean;
+ color: boolean;
+ alpha: boolean;
+ interlace: boolean;
+ }
+
+ export class PNG extends stream.Writable {
+ constructor(options?: PNGOptions);
+
+ width: number;
+ height: number;
+ data: Buffer;
+ gamma: number;
+
+ on(event: string, callback: Function): PNG;
+ on(event: "metadata", callback: (metadata: PNGMetadata) => void): PNG;
+ on(event: "parsed", callback: (data: Buffer) => void): PNG;
+ on(event: "error", callback: (err: Error) => void): PNG;
+
+ parse(data: string|Buffer, callback?: (err: Error, data: Buffer) => void): PNG;
+ pack(): PNG;
+ pipe(destination: fs.WriteStream): PNG;
+
+ static bitblt(src: PNG, dst: PNG, srcX: number, srcY: number,
+ width: number, height: number, deltaX: number, deltaY: number): void;
+
+ bitblt(dst: PNG, srcX: number, srcY: number,
+ width: number, height: number, deltaX: number, deltaY: number): PNG;
+ }
+
+ export namespace PNG {
+ namespace sync {
+ function read(buffer: string|Buffer, options?: PNGOptions): PNG;
+ }
+ }
+}
diff --git a/polymer/polymer-tests.ts b/polymer/polymer-tests.ts
index 311fda9676..8a44ed285a 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 b764aeb2a8..c346de8b36 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/precond/precond-tests.ts.tscparams b/precond/precond-tests.ts.tscparams
deleted file mode 100644
index 2988d8fd66..0000000000
--- a/precond/precond-tests.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
---noImplicitAny --module commonjs
\ No newline at end of file
diff --git a/progress/progress-test.ts b/progress/progress-tests.ts
similarity index 100%
rename from progress/progress-test.ts
rename to progress/progress-tests.ts
diff --git a/proxyquire/proxyquire-test.ts b/proxyquire/proxyquire-tests.ts
similarity index 100%
rename from proxyquire/proxyquire-test.ts
rename to proxyquire/proxyquire-tests.ts
diff --git a/raphael/raphael.d.ts b/raphael/raphael.d.ts
index 593d5eb61e..4d174fa717 100644
--- a/raphael/raphael.d.ts
+++ b/raphael/raphael.d.ts
@@ -42,8 +42,8 @@ interface RaphaelElement {
hide(): RaphaelElement;
hover(f_in: Function, f_out: Function, icontext?: any, ocontext?: any): RaphaelElement;
id: string;
- insertAfter(): RaphaelElement;
- insertBefore(): RaphaelElement;
+ insertAfter(el: RaphaelElement): RaphaelElement;
+ insertBefore(el: RaphaelElement): RaphaelElement;
isPointInside(x: number, y: number): boolean;
isVisible(): boolean;
matrix: RaphaelMatrix;
@@ -129,8 +129,8 @@ interface RaphaelSet {
hide(): RaphaelSet;
hover(f_in: Function, f_out: Function, icontext?: any, ocontext?: any): RaphaelSet;
id: string;
- insertAfter(): RaphaelSet;
- insertBefore(): RaphaelSet;
+ insertAfter(el: RaphaelElement): RaphaelSet;
+ insertBefore(el: RaphaelElement): RaphaelSet;
isPointInside(x: number, y: number): boolean;
isVisible(): boolean;
matrix: RaphaelMatrix;
diff --git a/react-bootstrap/react-bootstrap-test.tsx b/react-bootstrap/react-bootstrap-tests.tsx
similarity index 98%
rename from react-bootstrap/react-bootstrap-test.tsx
rename to react-bootstrap/react-bootstrap-tests.tsx
index cdb1c7baec..8b0dd0fc0a 100644
--- a/react-bootstrap/react-bootstrap-test.tsx
+++ b/react-bootstrap/react-bootstrap-tests.tsx
@@ -1,9 +1,9 @@
-// React-Bootstrap Test
+// React-Bootstrap Test
// ================================================================================
///<reference path="react-bootstrap.d.ts"/>
///<reference path="../react/react.d.ts"/>
-// Imports
+// Imports
// --------------------------------------------------------------------------------
import * as React from 'react';
import { Component, CSSProperties } from 'react';
@@ -11,7 +11,7 @@ import { Button, ButtonToolbar, Modal, Well, ButtonGroup, DropdownButton, MenuIt
export class ReactBootstrapTest extends Component<any, any> {
- callback() {
+ callback() {
alert('Callback: ' + JSON.stringify(arguments));
}
@@ -30,7 +30,7 @@ export class ReactBootstrapTest extends Component<any, any> {
const innerCheckbox = <input type='checkbox' aria-label='...' />;
return (
- <div style={style}>
+ <div style={style}>
<div style={style}>
<ButtonToolbar>
<Button>Default</Button>
@@ -40,7 +40,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<Button bsStyle='warning'>Warning</Button>
<Button bsStyle='danger'>Danger</Button>
<Button bsStyle='link'>Link</Button>
- </ButtonToolbar>
+ </ButtonToolbar>
</div>
<div style={style}>
@@ -81,7 +81,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<ButtonToolbar>
<Button href='#'>Link</Button>
<Button>Button</Button>
- </ButtonToolbar>
+ </ButtonToolbar>
</div>
@@ -177,7 +177,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<MenuItem eventKey='3' active>Active Item</MenuItem>
<MenuItem divider />
<MenuItem eventKey='4'>Separated link</MenuItem>
- </DropdownButton>
+ </DropdownButton>
</div>
<div style={style}>
@@ -202,7 +202,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<div style={style}>
<Panel onClick={this.callback}>
Basic panel example
- </Panel>
+ </Panel>
</div>
<div style={style}>
@@ -464,7 +464,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<MenuItem eventKey='4'>Separated link</MenuItem>
</NavDropdown>
</Nav>
- </Navbar>
+ </Navbar>
</div>
<div style={style}>
@@ -473,7 +473,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<NavItem eventKey={1} href='#'>Link</NavItem>
<NavItem eventKey={2} href='#'>Link</NavItem>
</Nav>
- </Navbar>
+ </Navbar>
</div>
<div style={style}>
@@ -526,7 +526,7 @@ export class ReactBootstrapTest extends Component<any, any> {
activePage={1}
onSelect={this.callback} />
<br />
-
+
<Pagination
bsSize='small'
items={10}
@@ -564,7 +564,7 @@ export class ReactBootstrapTest extends Component<any, any> {
<p>Praesent commodo cursus magna, vel scelerisque nisl consectetur.</p>
</div>
</CarouselItem>
- </Carousel>
+ </Carousel>
</div>
<div style={style}>
diff --git a/react-bootstrap/react-bootstrap.d.ts b/react-bootstrap/react-bootstrap.d.ts
index 0c05844742..c63c55e9d0 100644
--- a/react-bootstrap/react-bootstrap.d.ts
+++ b/react-bootstrap/react-bootstrap.d.ts
@@ -4,7 +4,6 @@
// Definitions: https://github.com/borisyankov/DefinitelyTyped
///<reference path="../react/react.d.ts"/>
-///<reference path="../es6-promise/es6-promise.d.ts" />
declare module "react-bootstrap" {
// Import React
@@ -13,7 +12,7 @@ declare module "react-bootstrap" {
// <Button />
// ----------------------------------------
- interface ButtonProps {
+ interface ButtonProps extends React.Props<ButtonClass>{
// Optional
active?: boolean;
@@ -21,6 +20,7 @@ declare module "react-bootstrap" {
block?: boolean;
bsStyle?: string;
bsSize?: string;
+ className?: string;
navItem?: boolean;
navDropdown?: boolean;
componentClass?: string;
@@ -36,12 +36,13 @@ declare module "react-bootstrap" {
// <ButtonToolbar />
// ----------------------------------------
- interface ButtonToolbarProps {
+ interface ButtonToolbarProps extends React.Props<ButtonToolbarClass> {
// Optional
block?: boolean;
bsSize?: string;
bsStyle?: string;
+ className?: string;
justified?: boolean;
vertical?: boolean;
}
@@ -51,11 +52,12 @@ declare module "react-bootstrap" {
// <ButtonGroup />
// ----------------------------------------
- interface ButtonGroupProps {
+ interface ButtonGroupProps extends React.Props<ButtonGroupClass> {
// Optional
block?: boolean;
bsSize?: string;
bsStyle?: string;
+ className?: string;
justified?: boolean;
vertical?: boolean;
}
@@ -66,16 +68,14 @@ declare module "react-bootstrap" {
// <DropdownButton />
// ----------------------------------------
- interface DropdownButtonProps {
+ interface DropdownButtonProps extends React.Props<DropdownButtonClass> {
bsStyle?: string;
bsSize?: string;
buttonClassName?: string;
- children?: any; // TODO: Add more specific type
className?: string;
dropup?: boolean;
href?: string;
id?: string | number;
- key?: any; // TODO: Add more specific type
navItem?: boolean;
noCaret?: boolean;
onClick?: Function; // TODO: Add more specifc type
@@ -90,10 +90,9 @@ declare module "react-bootstrap" {
// <SplitButton />
// ----------------------------------------
- interface SplitButtonProps {
+ interface SplitButtonProps extends React.Props<SplitButtonClass>{
bsStyle?: string;
bsSize?: string;
- children?: any; // TODO: Add more specific type
className?: string;
disabled?: boolean;
dropdownTitle?: any; // TODO: Add more specific type
@@ -113,14 +112,14 @@ declare module "react-bootstrap" {
// <MenuItem />
// ----------------------------------------
- interface MenuItemProps {
+ interface MenuItemProps extends React.Props<MenuItemClass> {
active?: boolean;
+ className?: string;
disabled?: boolean;
divider?: boolean;
eventKey?: any;
header?: boolean;
href?: string;
- key?: any;
onSelect?: Function;
target?: string;
title?: string;
@@ -132,7 +131,8 @@ declare module "react-bootstrap" {
// <Panel />
// ----------------------------------------
- interface PanelProps {
+ interface PanelProps extends React.Props<PanelClass> {
+ className?: string;
bsSize?: string;
bsStyle?: string;
collapsible?: boolean;
@@ -152,7 +152,7 @@ declare module "react-bootstrap" {
// <Accordion />
// ----------------------------------------
- interface AccordionProps {
+ interface AccordionProps extends React.Props<AccordionClass> {
bsSize?: string;
bsStyle?: string;
collapsible?: boolean;
@@ -171,12 +171,11 @@ declare module "react-bootstrap" {
// <PanelGroup />
// ----------------------------------------
- interface PanelGroupProps {
+ interface PanelGroupProps extends React.Props<PanelGroupClass> {
accordion?: boolean;
activeKey?: any;
bsSize?: string;
bsStyle?: string;
- children?: any;
className?: string;
defaultActiveKey?: any;
onSelect?: Function;
@@ -188,7 +187,7 @@ declare module "react-bootstrap" {
// <Modal.Dialog />
// ----------------------------------------
- interface ModalDialogProps {
+ interface ModalDialogProps extends React.Props<ModalDialogClass> {
// TODO: Add more specific type
}
interface ModalDialog extends React.ReactElement<ModalDialogProps> { }
@@ -197,7 +196,8 @@ declare module "react-bootstrap" {
// <Modal.Header />
// ----------------------------------------
- interface ModalHeaderProps {
+ interface ModalHeaderProps extends React.Props<ModalHeaderClass> {
+ className?: string;
closeButton?: boolean;
modalClassName?: string;
onHide?: Function;
@@ -209,7 +209,8 @@ declare module "react-bootstrap" {
// <Modal.Title/>
// ----------------------------------------
- interface ModalTitleProps {
+ interface ModalTitleProps extends React.Props<ModalTitleClass> {
+ className?: string;
modalClassName?: string;
}
interface ModalTitle extends React.ReactElement<ModalTitleProps> { }
@@ -218,7 +219,8 @@ declare module "react-bootstrap" {
// <Modal.Body />
// ----------------------------------------
- interface ModalBodyProps {
+ interface ModalBodyProps extends React.Props<ModalBodyClass> {
+ className?: string;
modalClassName?: string;
}
interface ModalBody extends React.ReactElement<ModalBodyProps> { }
@@ -227,7 +229,8 @@ declare module "react-bootstrap" {
// <Modal.Footer />
// ----------------------------------------
- interface ModalFooterProps {
+ interface ModalFooterProps extends React.Props<ModalFooterClass> {
+ className?: string;
modalClassName?: string;
}
interface ModalFooter extends React.ReactElement<ModalFooterProps> { }
@@ -236,7 +239,7 @@ declare module "react-bootstrap" {
// <Modal />
// ----------------------------------------
- interface ModalProps {
+ interface ModalProps extends React.Props<ModalClass> {
// Required
onHide: Function;
@@ -250,9 +253,10 @@ declare module "react-bootstrap" {
dialogComponent?: any; // TODO: Add more specific type
enforceFocus?: boolean;
keyboard?: boolean;
+ show?: boolean;
}
interface Modal extends React.ReactElement<ModalProps> { }
- interface ModalClass extends React.ComponentClass<ModalProps> {
+ interface ModalClass extends React.ComponentClass<ModalProps> {
Header: ModalHeaderClass;
Title: ModalTitleClass;
Body: ModalBodyClass;
@@ -264,7 +268,7 @@ declare module "react-bootstrap" {
// <OverlayTrigger />
// ----------------------------------------
- interface OverlayTriggerProps {
+ interface OverlayTriggerProps extends React.Props<OverlayTriggerClass> {
// Required
overlay: any; // TODO: Add more specific type
@@ -293,7 +297,7 @@ declare module "react-bootstrap" {
// <Tooltip />
// ----------------------------------------
- interface TooltipProps {
+ interface TooltipProps extends React.Props<TooltipClass> {
// Optional
arrowOffsetLeft?: number | string;
arrowOffsetTop?: number | string;
@@ -313,12 +317,13 @@ declare module "react-bootstrap" {
// <Popover/>
// ----------------------------------------
- interface PopoverProps {
+ interface PopoverProps extends React.Props<PopoverClass> {
// Optional
arrowOffsetLeft?: number | string;
arrowOffsetTop?: number | string;
bsSize?: string;
bsStyle?: string;
+ className?: string;
id?: string;
placement?: string;
positionLeft?: number;
@@ -332,7 +337,7 @@ declare module "react-bootstrap" {
// <Overlay />
// ----------------------------------------
- interface OverlayProps {
+ interface OverlayProps extends React.Props<OverlayClass> {
// Optional
animation?: any; // TODO: Add more specific type
container?: any; // TODO: Add more specific type
@@ -356,16 +361,14 @@ declare module "react-bootstrap" {
// <ProgressBar />
// ----------------------------------------
- interface ProgressBarProps {
+ interface ProgressBarProps extends React.Props<ProgressBarClass> {
// Optional
active?: boolean;
bsSize?: string;
bsStyle?: string;
- children?: any; // TODO: Add more specific type
className?: string;
interpolatedClass?: any; // TODO: Add more specific type
label?: any; // TODO: Add more specific type
- key?: number; // TODO: Add more specific type
max?: number;
min?: number;
now?: number;
@@ -380,7 +383,7 @@ declare module "react-bootstrap" {
// <Nav />
// ----------------------------------------
// TODO: This one turned into a union of two different types
- interface NavProps {
+ interface NavProps extends React.Props<NavClass> {
// Optional
activeHref?: string;
activeKey?: any;
@@ -407,11 +410,12 @@ declare module "react-bootstrap" {
// <NavItem />
// ----------------------------------------
- interface NavItemProps {
+ interface NavItemProps extends React.Props<NavItemClass> {
active?: boolean;
brand?: any; // TODO: Add more specific type
bsSize?: string;
bsStyle?: string;
+ className?: string;
componentClass?: any; // TODO: Add more specific type
defaultNavExpanded?: boolean;
disabled?: boolean;
@@ -423,6 +427,7 @@ declare module "react-bootstrap" {
inverse?: boolean;
linkId?: string;
navExpanded?: boolean;
+ onClick?: Function;
onSelect?: Function;
onToggle?: Function;
role?: string;
@@ -439,10 +444,11 @@ declare module "react-bootstrap" {
// <Navbar />
// ----------------------------------------
- interface NavbarProps {
+ interface NavbarProps extends React.Props<NavbarClass> {
brand?: any; // TODO: Add more specific type
bsSize?: string;
bsStyle?: string;
+ className?: string;
componentClass?: any; // TODO: Add more specific type
defaultNavExpanded?: boolean;
fixedBottom?: boolean;
@@ -459,11 +465,21 @@ declare module "react-bootstrap" {
interface Navbar extends React.ReactElement<NavbarProps> { }
interface NavbarClass extends React.ComponentClass<NavbarProps> { }
var Navbar: NavbarClass;
+
+ // <NavBrand />
+ // ----------------------------------------
+ interface NavBrandProps {
+
+ }
+ interface NavBrand extends React.ReactElement<NavbarProps> { }
+ interface NavBrandClass extends React.ComponentClass<NavbarProps> { }
+ var NavBrand: NavBrandClass;
// <NavDropdown />
// ----------------------------------------
- interface NavDropdownProps {
+ interface NavDropdownProps extends React.Props<NavDropdownClass> {
+ className?: string;
eventKey?: any;
title?: string;
id?: string;
@@ -475,7 +491,7 @@ declare module "react-bootstrap" {
// <Tabs />
// ----------------------------------------
- interface TabsProps {
+ interface TabsProps extends React.Props<TabsClass> {
activeKey?: any;
animation?: boolean;
bsStyle?: string;
@@ -493,8 +509,9 @@ declare module "react-bootstrap" {
// <Tab />
// ----------------------------------------
- interface TabProps {
+ interface TabProps extends React.Props<TabClass> {
animation?: boolean;
+ className?: string;
disabled?: boolean;
eventKey?: any; // TODO: Add more specific type
title?: any; // TODO: Add more specific type
@@ -506,7 +523,8 @@ declare module "react-bootstrap" {
// <Pager />
// ----------------------------------------
- interface PagerProps {
+ interface PagerProps extends React.Props<PagerClass> {
+ className?: string;
onSelect?: Function;
}
interface Pager extends React.ReactElement<PagerProps> { }
@@ -516,7 +534,8 @@ declare module "react-bootstrap" {
// <PageItem />
// ----------------------------------------
- interface PageItemProps {
+ interface PageItemProps extends React.Props<PageItemClass> {
+ className?: string;
disabled?: boolean;
eventKey?: any;
href?: string;
@@ -533,11 +552,12 @@ declare module "react-bootstrap" {
// <Pagination />
// ----------------------------------------
- interface PaginationProps {
+ interface PaginationProps extends React.Props<PaginationClass> {
activePage?: number;
bsSize?: string;
bsStyle?: string;
buttonComponentClass?: any; // TODO: Add more specific type
+ className?: string;
ellipsis?: boolean;
first?: boolean;
items?: number;
@@ -554,9 +574,10 @@ declare module "react-bootstrap" {
// <Alert />
// ----------------------------------------
- interface AlertProps {
+ interface AlertProps extends React.Props<AlertClass> {
bsSize?: string;
bsStyle?: string;
+ className?: string;
closeLabel?: string;
dismissAfter?: number;
onDismiss?: Function;
@@ -568,10 +589,11 @@ declare module "react-bootstrap" {
// <Carousel />
// ----------------------------------------
- interface CarouselProps {
+ interface CarouselProps extends React.Props<CarouselClass> {
activeIndex?: number;
bsSize?: string;
bsStyle?: string;
+ className?: string;
controls?: boolean;
defaultActiveIndex?: number;
direction?: string;
@@ -592,11 +614,12 @@ declare module "react-bootstrap" {
// <CarouselItem />
// ----------------------------------------
- interface CarouselItemProps {
+ interface CarouselItemProps extends React.Props<CarouselItemClass> {
active?: boolean;
animtateIn?: boolean;
animateOut?: boolean;
caption?: any; // TODO: Add more specific type
+ className?: string;
direction?: string;
index?: number;
onAnimateOutEnd?: Function;
@@ -608,7 +631,8 @@ declare module "react-bootstrap" {
// <Grid />
// ----------------------------------------
- interface GridProps {
+ interface GridProps extends React.Props<GridClass> {
+ className?: string;
componentClass?: any; // TODO: Add more specific type
fluid?: boolean;
}
@@ -619,7 +643,7 @@ declare module "react-bootstrap" {
// <Row />
// ----------------------------------------
- interface RowProps {
+ interface RowProps extends React.Props<RowClass> {
className?: string;
componentClass?: any; // TODO: Add more specific type
}
@@ -630,7 +654,8 @@ declare module "react-bootstrap" {
// <Col />
// ----------------------------------------
- interface ColProps {
+ interface ColProps extends React.Props<ColClass> {
+ className?: string;
componentClass?: any; // TODO: Add more specific type
lg?: number;
lgOffset?: number;
@@ -656,10 +681,11 @@ declare module "react-bootstrap" {
// <Thumbnail />
// ----------------------------------------
- interface ThumbnailProps {
+ interface ThumbnailProps extends React.Props<ThumbnailClass> {
alt?: string;
bsSize?: string;
bsStyle?: string;
+ className?: string;
href?: string;
src?: string;
}
@@ -670,7 +696,7 @@ declare module "react-bootstrap" {
// <ListGroup />
// ----------------------------------------
- interface ListGroupProps {
+ interface ListGroupProps extends React.Props<ListGroupClass> {
className?: string;
id?: string | number;
fill?: boolean; // TODO: Add more specific type
@@ -682,7 +708,7 @@ declare module "react-bootstrap" {
// <ListGroupItem />
// ----------------------------------------
- interface ListGroupItemProps {
+ interface ListGroupItemProps extends React.Props<ListGroupItemClass> {
active?: any;
bsSize?: string;
bsStyle?: string;
@@ -703,9 +729,10 @@ declare module "react-bootstrap" {
// <Label />
// ----------------------------------------
- interface LabelProps {
+ interface LabelProps extends React.Props<LabelClass> {
bsSize?: string;
bsStyle?: string;
+ className?: string;
}
interface Label extends React.ReactElement<LabelProps> { }
interface LabelClass extends React.ComponentClass<LabelProps> { }
@@ -714,7 +741,8 @@ declare module "react-bootstrap" {
// <Badge />
// ----------------------------------------
- interface BadgeProps {
+ interface BadgeProps extends React.Props<BadgeClass> {
+ className?: string;
pullRight?: boolean;
}
interface Badge extends React.ReactElement<BadgeProps> { }
@@ -724,7 +752,8 @@ declare module "react-bootstrap" {
// <Jumbotron />
// ----------------------------------------
- interface JumbotronProps {
+ interface JumbotronProps extends React.Props<JumbotronClass> {
+ className?: string;
componentClass?: any; // TODO: Add more specific type
}
interface Jumbotron extends React.ReactElement<JumbotronProps> { }
@@ -734,8 +763,8 @@ declare module "react-bootstrap" {
// <PageHeader />
// ----------------------------------------
- interface PageHeaderProps {
- // No props
+ interface PageHeaderProps extends React.Props<PageHeaderClass> {
+ className?: string;
}
interface PageHeader extends React.ReactElement<PageHeaderProps> { }
interface PageHeaderClass extends React.ComponentClass<PageHeaderProps> { }
@@ -744,9 +773,10 @@ declare module "react-bootstrap" {
// <Well />
// ----------------------------------------
- interface WellProps {
+ interface WellProps extends React.Props<WellClass> {
bsSize?: string;
bsStyle?: string;
+ className?: string;
}
interface Well extends React.ReactElement<WellProps> { }
interface WellClass extends React.ComponentClass<WellProps> { }
@@ -755,7 +785,8 @@ declare module "react-bootstrap" {
// <Glyphicon />
// ----------------------------------------
- interface GlyphiconProps {
+ interface GlyphiconProps extends React.Props<GlyphiconClass> {
+ className?: string;
// Required
glyph: string;
}
@@ -766,8 +797,9 @@ declare module "react-bootstrap" {
// <Table />
// ----------------------------------------
- interface TableProps {
+ interface TableProps extends React.Props<TableClass> {
bordered?: boolean;
+ className?: string;
condensed?: boolean;
hover?: boolean;
responsive?: boolean;
@@ -780,13 +812,14 @@ declare module "react-bootstrap" {
// <Input />
// ----------------------------------------
- interface InputProps {
+ interface InputProps extends React.Props<InputClass> {
addonAfter?: any; // TODO: Add more specific type
addonBefore?: any; // TODO: Add more specific type
bsSize?: string;
bsStyle?: string;
buttonAfter?: any; // TODO: Add more specific type
- buttonBefore?: any; // TODO: Add more specific type
+ buttonBefore?: any; // TODO: Add more specific type
+ className?: string;
checked?: boolean;
disabled?: boolean;
feedbackIcon?: any; // TODO: Add more specific type
@@ -798,7 +831,6 @@ declare module "react-bootstrap" {
labelClassName?: string;
multiple?: boolean;
placeholder?: string;
- ref?: string;
readOnly?: boolean;
type?: string;
onChange?: Function; // TODO: Add more specific type
@@ -815,13 +847,14 @@ declare module "react-bootstrap" {
// <ButtonInput />
// ----------------------------------------
- interface ButtonInputProps {
+ interface ButtonInputProps extends React.Props<ButtonInputClass> {
addonAfter?: any; // TODO: Add more specific type
addonBefore?: any; // TODO: Add more specific type
bsSize?: string;
bsStyle?: string;
buttonAfter?: any; // TODO: Add more specific type
- buttonBefore?: any; // TODO: Add more specific type
+ buttonBefore?: any; // TODO: Add more specific type
+ className?: string;
disabled?: boolean;
feedbackIcon?: any; // TODO: Add more specific type
groupClassName?: string;
@@ -846,7 +879,7 @@ declare module "react-bootstrap" {
// <Portal />
// ----------------------------------------
- interface PortalProps {
+ interface PortalProps extends React.Props<PortalClass> {
dimension?: string | Function;
getDimensionValue?: Function;
in?: boolean;
@@ -868,7 +901,7 @@ declare module "react-bootstrap" {
// <Position />
// ----------------------------------------
- interface PositionProps {
+ interface PositionProps extends React.Props<PositionClass> {
dimension?: string | Function;
getDimensionValue?: Function;
in?: boolean;
@@ -890,7 +923,7 @@ declare module "react-bootstrap" {
// <Fade />
// ----------------------------------------
- interface FadeProps {
+ interface FadeProps extends React.Props<FadeClass> {
in?: boolean;
onEnter?: Function;
onEntered?: Function;
diff --git a/react-dnd/react-dnd-tests.ts b/react-dnd/react-dnd-tests.ts
index 9846c6c83a..2c92b7b33f 100644
--- a/react-dnd/react-dnd-tests.ts
+++ b/react-dnd/react-dnd-tests.ts
@@ -13,7 +13,7 @@ import DragSource = ReactDnd.DragSource;
import DropTarget = ReactDnd.DropTarget;
import DragLayer = ReactDnd.DragLayer;
import DragDropContext = ReactDnd.DragDropContext;
-import HTML5Backend = require('react-dnd/modules/backends/HTML5');
+import HTML5Backend, { getEmptyImage } from 'react-dnd/modules/backends/HTML5';
import TestBackend = require('react-dnd/modules/backends/Test');
// Game Component
@@ -82,11 +82,11 @@ module Knight {
export class Knight extends React.Component<KnightP, {}> {
static defaultProps: KnightP;
-
+
static create = React.createFactory(Knight);
componentDidMount() {
- var img = HTML5Backend.getEmptyImage();
+ var img = getEmptyImage();
img.onload = () => this.props.connectDragPreview(img);
}
@@ -157,7 +157,7 @@ module BoardSquare {
export class BoardSquare extends React.Component<BoardSquareP, {}> {
static defaultProps: BoardSquareP;
-
+
private _renderOverlay = (color: string) => {
return r.div({
style: {
diff --git a/react-dnd/react-dnd.d.ts b/react-dnd/react-dnd.d.ts
index 151f0a4041..982478f78d 100644
--- a/react-dnd/react-dnd.d.ts
+++ b/react-dnd/react-dnd.d.ts
@@ -176,13 +176,9 @@ declare module "react-dnd" {
}
declare module "react-dnd/modules/backends/HTML5" {
- enum _NativeTypes { FILE, URL, TEXT }
- class HTML5Backend implements __ReactDnd.Backend {
- static getEmptyImage(): any; // Image
- static NativeTypes: _NativeTypes;
- }
-
- export = HTML5Backend;
+ export enum NativeTypes { FILE, URL, TEXT }
+ export function getEmptyImage(): any; // Image
+ export default class HTML5Backend implements __ReactDnd.Backend {}
}
declare module "react-dnd/modules/backends/Test" {
diff --git a/react-dom/react-dom.d.ts b/react-dom/react-dom.d.ts
new file mode 100644
index 0000000000..1351fa02ed
--- /dev/null
+++ b/react-dom/react-dom.d.ts
@@ -0,0 +1,40 @@
+// Type definitions for React-DOM v0.14.0-rc
+// Project: https://www.npmjs.com/package/react-dom
+// Definitions by: Stefan-Bieliauskas <http://www.conts.de>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="./../react/react.d.ts" />
+
+declare namespace __ReactDom {
+ function render<P>(
+ element: __React.DOMElement<P>,
+ container: Element,
+ callback?: () => any): __React.DOMComponent<P>;
+ function render<P, S>(
+ element: __React.ClassicElement<P>,
+ container: Element,
+ callback?: () => any): __React.ClassicComponent<P, S>;
+ function render<P, S>(
+ element: __React.ReactElement<P>,
+ container: Element,
+ callback?: () => any): __React.Component<P, S>;
+
+ function findDOMNode<TElement extends Element>(
+ componentOrElement: __React.Component<any, any> | Element): TElement;
+ function findDOMNode(
+ componentOrElement: __React.Component<any, any> | Element): Element;
+
+ function unmountComponentAtNode(container: Element): boolean;
+}
+
+declare namespace __ReactDomServer {
+ function renderToString(element: __React.ReactElement<any>): string;
+ function renderToStaticMarkup(element: __React.ReactElement<any>): string;
+}
+declare module "react-dom" {
+ export = __ReactDom
+}
+
+declare module "react-dom/server" {
+ export = __ReactDomServer
+}
diff --git a/react-dropzone/react-dropzone-tests.tsx b/react-dropzone/react-dropzone-tests.tsx
new file mode 100644
index 0000000000..6216b5f20e
--- /dev/null
+++ b/react-dropzone/react-dropzone-tests.tsx
@@ -0,0 +1,32 @@
+///<reference path='../react/react.d.ts' />
+///<reference path='../react-dropzone/react-dropzone.d.ts' />
+import * as React from 'react';
+import Dropzone = require('react-dropzone');
+
+class Test extends React.Component<any, any> {
+ constructor(props: any) {
+ super(props);
+ }
+
+ render() {
+ return (<div>
+ <Dropzone
+ onDrop={(e: any) => { e.preventDefault(); } }
+ onDropAccepted={(e: any) => { e.preventDefault(); } }
+ onDropRejected={(e: any) => { e.preventDefault(); } }
+ onDragEnter={(e: any) => { e.preventDefault(); } }
+ onDragLeave={(e: any) => { e.preventDefault(); } }
+ style={{ borderStyle: "dashed" }}
+ activeStyle={{ borderStyle: "dotted" }}
+ className="regular"
+ activeClassName="active"
+ rejectClassName="reject"
+ disableClick={true}
+ multiple={false}
+ accept="*.png"
+ />
+ </div>);
+ }
+}
+
+export default Test;
diff --git a/redux-devtools/redux-devtools-tests.tsx.tscparams b/react-dropzone/react-dropzone-tests.tsx.tscparams
similarity index 100%
rename from redux-devtools/redux-devtools-tests.tsx.tscparams
rename to react-dropzone/react-dropzone-tests.tsx.tscparams
diff --git a/react-dropzone/react-dropzone.d.ts b/react-dropzone/react-dropzone.d.ts
new file mode 100644
index 0000000000..0bd3e472b8
--- /dev/null
+++ b/react-dropzone/react-dropzone.d.ts
@@ -0,0 +1,37 @@
+// Type definitions for react-dropzone
+// Project: https://github.com/paramaggarwal/react-dropzone
+// Definitions by: Mathieu Larouche Dube <https://github.com/matdube>
+// Definitions: https://github.com/Vooban/DefinitelyTyped
+
+///<reference path='../react/react.d.ts' />
+
+declare module "react-dropzone" {
+
+ import * as React from 'react';
+
+ namespace reactDropzone {
+
+ interface DropzoneProps {
+ onDrop?: Function;
+ onDropAccepted?: Function;
+ onDropRejected?: Function;
+ onDragEnter?: Function;
+ onDragLeave?: Function;
+ style?: Object;
+ activeStyle?: Object;
+ className?: string;
+ activeClassName?: string;
+ rejectClassName?: string;
+ disableClick?: boolean;
+ multiple?: boolean;
+ accept?: string;
+ }
+
+ export class Dropzone extends React.Component<DropzoneProps, {}> {
+ }
+
+ }
+
+ export = reactDropzone.Dropzone;
+}
+
diff --git a/react-input-calendar/react-input-calendar-tests.tsx b/react-input-calendar/react-input-calendar-tests.tsx
new file mode 100644
index 0000000000..1271064249
--- /dev/null
+++ b/react-input-calendar/react-input-calendar-tests.tsx
@@ -0,0 +1,6 @@
+/// <reference path="./react-input-calendar.d.ts"/>
+/// <reference path="../react/react.d.ts"/>
+
+import * as ReactInputCalendar from 'react-input-calendar';
+import * as React from 'react';
+React.render(<ReactInputCalendar />, document.body);
diff --git a/react-input-calendar/react-input-calendar.d.ts b/react-input-calendar/react-input-calendar.d.ts
new file mode 100644
index 0000000000..d8c518b830
--- /dev/null
+++ b/react-input-calendar/react-input-calendar.d.ts
@@ -0,0 +1,59 @@
+// Type definitions for react-input-calendar
+// Project: https://github.com/Rudeg/react-input-calendar
+// Definitions by: Stepan Mikhaylyuk <https://github.com/stepancar>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../react/react.d.ts"/>
+declare module reactInputCalendar {
+ export interface ReactInputCalendarProps {
+ /**
+ * Format of date, which display in input and set in date property.
+ * Allowed Keys: All formats supported by moment.js
+ * @default 'MM-DD-YYYY'
+ */
+ format?: string;
+ /**
+ * Set initial date value
+ * @default current date
+ */
+ date?: string | Date;
+ /**
+ * Set minimal view. Values:
+ * 0 - days
+ * 1 - months
+ * 2 - years.
+ * @default 0 (DaysView)
+ */
+ minView?: number;
+ /**
+ * Format of date for the onChange event. Default on the date format (ISO 8601) to ease the save of data.
+ * Allowed Keys: All formats supported by moment.js
+ * @default 'MM-DD-YYYY'
+ */
+ computableFormat?: string;
+ /**
+ * Set an function that will be triggered whenever there is a change in the selected date. It will return the date in the props.computableFormat format.
+ */
+ onChange?:(selectedDate: string)=>any;
+ /**
+ * Define state when date picker would close once the user has clicked on a date.
+ */
+ closeOnSelect?:boolean;
+ /**
+ * Setting this value to true makes the calendar widget open when the iput field is focused.
+ */
+ openOnInputFocus?: boolean;
+ /**
+ * Value to show in the input text box if no date is set.
+ */
+ placeholder?:string
+ }
+ interface ReactInputCalendarState { }
+ export class ReactInputCalendar extends __React.Component<ReactInputCalendarProps, ReactInputCalendarState>{
+ render(): __React.DOMElement<any>
+ }
+}
+declare var ReactInputCalendar: typeof reactInputCalendar.ReactInputCalendar
+declare module "react-input-calendar" {
+ export = ReactInputCalendar
+}
diff --git a/react-intl/react-intl-tests.tsx b/react-intl/react-intl-tests.tsx
new file mode 100644
index 0000000000..2258343fd5
--- /dev/null
+++ b/react-intl/react-intl-tests.tsx
@@ -0,0 +1,138 @@
+/**
+ * Created by Bruno Grieder
+ */
+
+///<reference path='../react/react.d.ts' />
+///<reference path='../react-mixin/react-mixin.d.ts' />
+///<reference path='../react-intl/react-intl.d.ts' />
+
+import * as React from 'react'
+
+import * as reactMixin from 'react-mixin'
+import {IntlMixin, IntlComponent, FormattedNumber, FormattedMessage, FormattedDate} from 'react-intl'
+
+
+///////////////////////////////////////////////////////////////////////////
+//
+// This class does not use the mixin and react-mixin is not required
+// The MESSAGES are maintained in the file
+// To use it call <I18nDirect locales={['en-US']}/>
+//
+////////////////////////////////////////////////////////////////////////////
+
+
+const MESSAGES: {[key: string] : { [lang: string]: string }} = {
+
+ Sorry: {
+ 'en-US': 'Sorry {name}',
+ 'fr-FR': 'Désolé {name}'
+ }
+}
+
+
+module I18nDirect {
+
+ export interface Props extends IntlComponent.Props {}
+}
+
+class I18nDirect extends React.Component<I18nDirect.Props, any> {
+
+ private _currentLocale: string
+ private _messages: {[key: string]: string}
+
+ constructor( props: I18nDirect.Props ) {
+ super( props )
+ }
+
+
+ render() {
+
+ return (
+
+ <ul>
+ <li>FormattedNumber:
+ <FormattedNumber value={99.95} style="currency" currency="USD"/>
+ </li>
+ <li>FormattedMessage:
+ <FormattedMessage message={this._messages['Sorry']} name='Dave'/>
+ </li>
+ <li>FormattedDate:
+ <FormattedDate value={new Date()}/>
+ </li>
+ </ul>
+
+ )
+ }
+
+ componentWillReceiveProps( nextProps: I18nDirect.Props ) {
+ this.compileMessages(nextProps)
+ }
+
+ componentWillMount() {
+ this.compileMessages(this.props)
+ }
+
+
+ private compileMessages = (props: I18nDirect.Props): void => {
+
+ let locale: string = ( props.locales && props.locales[ 0 ] ) || 'en-US'
+
+ if (this._currentLocale !== locale) {
+
+ this._messages = Object.keys( MESSAGES ).reduce(
+ ( dic , key ) => {
+ dic[ key ] = MESSAGES[ key ][ locale ]
+ return dic
+ },
+ {} as { [key: string]: string; }
+ )
+ }
+ }
+
+}
+
+///////////////////////////////////////////////////////////////////////////
+//
+// This class uses the mixin and react-mixin is
+// The MESSAGES are passed from messages property of the props
+// To use it call <I18nMixin {...props}/>
+//
+////////////////////////////////////////////////////////////////////////////
+
+
+module I18nMixin {
+
+ export interface Props extends IntlComponent.Props {}
+}
+
+@reactMixin.decorate( IntlMixin )
+class I18nMixin extends React.Component<I18nMixin.Props, any> implements IntlComponent {
+
+ private _currentLocale: string
+
+ constructor( props: I18nMixin.Props ) {
+ super( props )
+ }
+
+ //Expose the method provided by the Mixin
+ getIntlMessage: (key: string) => string = this['getIntlMessage']
+
+
+ render() {
+
+ return (
+
+ <ul>
+ <li>FormattedNumber:
+ <FormattedNumber value={99.95} style="currency" currency="USD"/>
+ </li>
+ <li>FormattedMessage:
+ <FormattedMessage message={this.getIntlMessage('Sorry')} name='Dave'/> {/* this uses the mixin */}
+ </li>
+ </ul>
+
+ )
+ }
+}
+
+export { I18nDirect, I18nMixin }
diff --git a/react-intl/react-intl-tests.tsx.tscparams b/react-intl/react-intl-tests.tsx.tscparams
new file mode 100644
index 0000000000..c90abf04fc
--- /dev/null
+++ b/react-intl/react-intl-tests.tsx.tscparams
@@ -0,0 +1 @@
+--target es5 --noImplicitAny --experimentalDecorators --jsx react
diff --git a/react-intl/react-intl.d.ts b/react-intl/react-intl.d.ts
new file mode 100644
index 0000000000..3d7a9b7378
--- /dev/null
+++ b/react-intl/react-intl.d.ts
@@ -0,0 +1,99 @@
+// Type definitions for react-intl 1.2.0
+// Project: http://formatjs.io/react/
+// Definitions by: Bruno Grieder <https://github.com/bgrieder>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+///<reference path='../react/react.d.ts' />
+
+declare module "react-intl" {
+
+ import * as React from 'react'
+
+ module ReactIntl {
+
+
+ interface IIntlMixin extends React.Mixin<any,any> {
+ getIntlMessage(key: string): string
+ }
+
+ var IntlMixin: IIntlMixin
+
+ module IntlComponent {
+ interface Props {
+ locales?: string[]
+ messages?: {[key: string]: any}
+ formats?: string[]
+ }
+ }
+ interface IntlComponent {
+ getIntlMessage(key: string): string;
+ }
+
+
+ module FormattedDate {
+ export interface Props extends IntlComponent.Props {
+ value: Date
+ day?: string
+ month?: string
+ year?: string
+ }
+ }
+ class FormattedDate extends React.Component<FormattedDate.Props,any> {}
+
+
+ module FormattedTime {
+ export interface Props extends IntlComponent.Props {
+ value: Date
+ day?: string
+ month?: string
+ year?: string
+ format?: string
+ }
+ }
+ class FormattedTime extends React.Component<FormattedTime.Props,any> {}
+
+
+ module FormattedRelative {
+ export interface Props extends IntlComponent.Props {
+ value: number
+ units?: string //"second", "minute", "hour", "day", "month" or "year"
+ style?: string //"best fit" (default) or "numeric"
+ format?: string
+ }
+ }
+ class FormattedRelative extends React.Component<FormattedRelative.Props,any> {}
+
+
+ module FormattedMessage {
+ export interface Props extends IntlComponent.Props {
+ message: string;
+ [prop: string]: any
+ }
+ }
+ class FormattedMessage extends React.Component<FormattedMessage.Props,any> {}
+
+
+ module FormattedHTMLMessage {
+ export interface Props extends IntlComponent.Props {
+ message: string;
+ [prop: string]: any
+ }
+ }
+ class FormattedHTMLMessage extends React.Component<FormattedHTMLMessage.Props,any> {}
+
+
+ module FormattedNumber {
+ export interface Props extends IntlComponent.Props {
+ value: number
+ style?: string
+ currency?: string
+ format?: string
+ }
+ }
+ class FormattedNumber extends React.Component<FormattedNumber.Props,any> {}
+
+ }
+
+ export = ReactIntl
+
+}
diff --git a/react-redux/react-redux-tests.tsx b/react-redux/react-redux-tests.tsx
index 9bd662295a..abbacabef2 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 f1ef5458e1..767b6b1097 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-router/react-router-test.ts b/react-router/react-router-tests.ts
similarity index 99%
rename from react-router/react-router-test.ts
rename to react-router/react-router-tests.ts
index 115c8b77f9..54b0545e2e 100644
--- a/react-router/react-router-test.ts
+++ b/react-router/react-router-tests.ts
@@ -129,7 +129,7 @@ class DefaultRouteTest {
var Handler: React.ComponentClass<any>;
React.createElement(Router.DefaultRoute, null);
React.createElement(Router.DefaultRoute, {name: 'name', handler: Handler});
-
+
ReactAddons.createElement(Router.DefaultRoute, null);
ReactAddons.createElement(Router.DefaultRoute, {name: 'name', handler: Handler});
}
@@ -169,7 +169,7 @@ class LinkTest {
query: {},
onClick: () => console.log(1)
});
-
+
ReactAddons.createElement(Router.Link, null);
ReactAddons.createElement(Router.Link, {to: 'home'});
ReactAddons.createElement(Router.Link, {
@@ -195,7 +195,7 @@ class NotFoundRouteTest {
React.createElement(Router.NotFoundRoute, null);
React.createElement(Router.NotFoundRoute, {handler: Handler});
React.createElement(Router.NotFoundRoute, {handler: Handler, name: "home"});
-
+
ReactAddons.createElement(Router.NotFoundRoute, null);
ReactAddons.createElement(Router.NotFoundRoute, {handler: Handler});
ReactAddons.createElement(Router.NotFoundRoute, {handler: Handler, name: "home"});
@@ -215,7 +215,7 @@ class RedirectTest {
React.createElement(Router.Redirect, null);
React.createElement(Router.Redirect, {});
React.createElement(Router.Redirect, {path: 'a', from: 'a', to: 'b'});
-
+
ReactAddons.createElement(Router.Redirect, null);
ReactAddons.createElement(Router.Redirect, {});
ReactAddons.createElement(Router.Redirect, {path: 'a', from: 'a', to: 'b'});
@@ -237,7 +237,7 @@ class RouteTest {
React.createElement(Router.Route, null);
React.createElement(Router.Route, {});
React.createElement(Router.Route, {name: "home", path: "/", handler: Handler, ignoreScrollBehavior: true});
-
+
ReactAddons.createElement(Router.Route, null);
ReactAddons.createElement(Router.Route, {});
ReactAddons.createElement(Router.Route, {name: "home", path: "/", handler: Handler, ignoreScrollBehavior: true});
@@ -250,7 +250,7 @@ class RouteHandlerTest {
createElement() {
React.createElement(Router.RouteHandler, null);
React.createElement(Router.RouteHandler, {});
-
+
ReactAddons.createElement(Router.RouteHandler, null);
ReactAddons.createElement(Router.RouteHandler, {});
}
diff --git a/react/react.d.ts b/react/react.d.ts
index 4fd7d5e771..ba86c4690b 100644
--- a/react/react.d.ts
+++ b/react/react.d.ts
@@ -354,6 +354,7 @@ declare namespace __React {
onInput?: FormEventHandler;
onSubmit?: FormEventHandler;
onClick?: MouseEventHandler;
+ onContextMenu?: MouseEventHandler;
onDoubleClick?: MouseEventHandler;
onDrag?: DragEventHandler;
onDragEnd?: DragEventHandler;
@@ -426,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/read/read-tests.ts b/read/read-tests.ts
new file mode 100644
index 0000000000..54d2708135
--- /dev/null
+++ b/read/read-tests.ts
@@ -0,0 +1,18 @@
+/// <reference path="read.d.ts" />
+
+import read = require('read');
+
+var opts: read.Options;
+opts = {
+ prompt: 'please enter...',
+ silent: true,
+ replace: '*',
+ timeout: 1500,
+ default: 'nothing',
+ edit: false,
+ terminal: true,
+ input: {x: 'thing'},
+ output: {y: 'thang'}
+};
+
+read(opts, function (error, result, isDefault) { });
diff --git a/read/read.d.ts b/read/read.d.ts
new file mode 100644
index 0000000000..9ab7f15d48
--- /dev/null
+++ b/read/read.d.ts
@@ -0,0 +1,24 @@
+// Type definitions for read
+// Project: https://github.com/isaacs/read
+// Definitions by: Tim JK <https://github.com/timjk>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module 'read' {
+ function Read(options: Read.Options, callback: (error: any, result: string, isDefault: boolean) => any): void;
+
+ module Read {
+ interface Options {
+ prompt?: string;
+ silent?: boolean;
+ replace?: string;
+ timeout?: number;
+ default?: string;
+ edit?: boolean;
+ terminal?: boolean;
+ input?: any;
+ output?: any;
+ }
+ }
+
+ export = Read;
+}
diff --git a/redlock/redlock-test.ts b/redlock/redlock-tests.ts
similarity index 100%
rename from redlock/redlock-test.ts
rename to redlock/redlock-tests.ts
diff --git a/redux/redux.d.ts b/redux/redux.d.ts
index 1bcbedc63b..669ab6b99a 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 0000000000..afebd1a811
--- /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 0000000000..035bca7f3f
--- /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-promise/request-promise.d.ts b/request-promise/request-promise.d.ts
index 1832787be5..94e3d3152e 100644
--- a/request-promise/request-promise.d.ts
+++ b/request-promise/request-promise.d.ts
@@ -10,7 +10,7 @@
declare module 'request-promise' {
import request = require('request');
- import http = require('http');
+ import http = require('http');
interface RequestPromise extends request.Request {
then(onFulfilled: Function, onRejected?: Function): Promise<any>;
@@ -19,7 +19,7 @@ declare module 'request-promise' {
promise(): Promise<any>;
}
- interface RequestPromiseOptions extends request.Options {
+ interface RequestPromiseOptions extends request.OptionalOptions {
simple?: boolean;
transform?: (body: any, response: http.IncomingMessage) => any;
resolveWithFullResponse?: boolean;
diff --git a/request/request.d.ts b/request/request.d.ts
index db8ca8c7d3..bba6848561 100644
--- a/request/request.d.ts
+++ b/request/request.d.ts
@@ -16,47 +16,53 @@ declare module 'request' {
import fs = require('fs');
namespace request {
- export interface RequestAPI<TRequest extends Request, TOptions extends Options> {
+ export interface RequestAPI<TRequest extends Request, TOptions extends OptionalOptions> {
defaults(options: TOptions): RequestAPI<TRequest, TOptions>;
(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
(uri: string, callback?: RequestCallback): TRequest;
- (options?: TOptions, callback?: RequestCallback): TRequest;
-
+ (options?: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
get(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
get(uri: string, callback?: RequestCallback): TRequest;
- get(options: TOptions, callback?: RequestCallback): TRequest;
-
+ get(options: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
post(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
post(uri: string, callback?: RequestCallback): TRequest;
- post(options: TOptions, callback?: RequestCallback): TRequest;
-
+ post(options: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
put(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
put(uri: string, callback?: RequestCallback): TRequest;
- put(options: TOptions, callback?: RequestCallback): TRequest;
-
+ put(options: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
head(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
head(uri: string, callback?: RequestCallback): TRequest;
- head(options: TOptions, callback?: RequestCallback): TRequest;
-
+ head(options: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
patch(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
patch(uri: string, callback?: RequestCallback): TRequest;
- patch(options: TOptions, callback?: RequestCallback): TRequest;
-
+ patch(options: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
del(uri: string, options?: TOptions, callback?: RequestCallback): TRequest;
del(uri: string, callback?: RequestCallback): TRequest;
- del(options: TOptions, callback?: RequestCallback): TRequest;
-
+ del(options: RequiredOptions & TOptions, callback?: RequestCallback): TRequest;
+
forever(agentOptions: any, optionsArg: any): TRequest;
jar(): CookieJar;
cookie(str: string): Cookie;
-
+
initParams: any;
debug: boolean;
}
-
- export interface Options {
- url?: string;
- uri?: string;
+
+ interface UriOptions {
+ uri: string;
+ }
+
+ interface UrlOptions {
+ url: string;
+ }
+
+ interface OptionalOptions {
callback?: (error: any, response: http.IncomingMessage, body: any) => void;
jar?: any; // CookieJar
formData?: any; // Object
@@ -64,7 +70,7 @@ declare module 'request' {
auth?: AuthOptions;
oauth?: OAuthOptions;
aws?: AWSOptions;
- hawk ?: HawkOptions;
+ hawk?: HawkOptions;
qs?: any;
json?: any;
multipart?: RequestPart[] | Multipart;
@@ -76,7 +82,7 @@ declare module 'request' {
method?: string;
headers?: Headers;
body?: any;
- followRedirect?: boolean;
+ followRedirect?: boolean | ((response: http.IncomingMessage) => boolean);
followAllRedirects?: boolean;
maxRedirects?: number;
encoding?: string;
@@ -93,11 +99,14 @@ declare module 'request' {
ca?: Buffer;
har?: HttpArchiveRequest;
}
-
+
+ export type RequiredOptions = UriOptions | UrlOptions;
+ export type Options = RequiredOptions & OptionalOptions;
+
export interface RequestCallback {
(error: any, response: http.IncomingMessage, body: any): void;
}
-
+
export interface HttpArchiveRequest {
url?: string;
method?: string;
@@ -106,30 +115,30 @@ declare module 'request' {
mimeType?: string;
params?: NameValuePair[];
}
- }
+ }
export interface NameValuePair {
name: string;
value: string;
}
-
+
export interface Multipart {
- chunked?: boolean;
- data?: {
- 'content-type'?: string,
- body: string
- }[];
+ chunked?: boolean;
+ data?: {
+ 'content-type'?: string,
+ body: string
+ }[];
}
-
+
export interface RequestPart {
headers?: Headers;
body: any;
}
-
+
export interface Request extends stream.Stream {
readable: boolean;
writable: boolean;
-
+
getAgent(): http.Agent;
//start(): void;
//abort(): void;
@@ -145,9 +154,9 @@ declare module 'request' {
auth(username: string, password: string, sendInmediately?: boolean, bearer?: string): Request;
oauth(oauth: OAuthOptions): Request;
jar(jar: CookieJar): Request;
-
+
on(event: string, listener: Function): Request;
-
+
write(buffer: Buffer, cb?: Function): boolean;
write(str: string, cb?: Function): boolean;
write(str: string, encoding: string, cb?: Function): boolean;
@@ -162,11 +171,11 @@ declare module 'request' {
destroy(): void;
toJSON(): Object;
}
-
+
export interface Headers {
[key: string]: any;
}
-
+
export interface AuthOptions {
user?: string;
username?: string;
@@ -175,7 +184,7 @@ declare module 'request' {
sendImmediately?: boolean;
bearer?: string;
}
-
+
export interface OAuthOptions {
callback?: string;
consumer_key?: string;
@@ -184,28 +193,28 @@ declare module 'request' {
token_secret?: string;
verifier?: string;
}
-
+
export interface HawkOptions {
credentials: any;
}
-
+
export interface AWSOptions {
secret: string;
bucket?: string;
}
-
+
export interface CookieJar {
- setCookie(cookie: Cookie, uri: string|url.Url, options?: any): void
- getCookieString(uri: string|url.Url): string
- getCookies(uri: string|url.Url): Cookie[]
+ setCookie(cookie: Cookie, uri: string | url.Url, options?: any): void
+ getCookieString(uri: string | url.Url): string
+ getCookies(uri: string | url.Url): Cookie[]
}
-
+
export interface CookieValue {
name: string;
value: any;
httpOnly: boolean;
}
-
+
export interface Cookie extends Array<CookieValue> {
constructor(name: string, req: Request): void;
str: string;
@@ -213,7 +222,7 @@ declare module 'request' {
path: string;
toString(): string;
}
- }
- var request: request.RequestAPI<request.Request, request.Options>;
+ }
+ var request: request.RequestAPI<request.Request, request.OptionalOptions>;
export = request;
}
diff --git a/requirejs-domready/domready-tests.ts b/requirejs-domready/domready-tests.ts
new file mode 100644
index 0000000000..fb7b59acd0
--- /dev/null
+++ b/requirejs-domready/domready-tests.ts
@@ -0,0 +1,7 @@
+/// <reference path="domready.d.ts" />
+
+import domReady = require("domReady");
+
+domReady(() => {
+ return domReady.version;
+});
diff --git a/requirejs-domready/domready.d.ts b/requirejs-domready/domready.d.ts
new file mode 100644
index 0000000000..a0557e1e00
--- /dev/null
+++ b/requirejs-domready/domready.d.ts
@@ -0,0 +1,15 @@
+// Type definitions for domReady 2.0.1
+// Project: https://github.com/requirejs/domReady
+// Definitions by: Nobuhiro Nakamura <https://github.com/lefb766>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "domReady" {
+ interface DomReady {
+ (callback: () => any): DomReady;
+ version: string;
+ }
+
+ let domReady: DomReady;
+
+ export = domReady;
+}
diff --git a/requirejs/require.d.ts b/requirejs/require.d.ts
index 5ca4b476a7..beee7deaa2 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,7 @@ interface RequireConfig {
// baseUrl.
paths?: { [key: string]: any; };
+
// Dictionary of Shim's.
// does not cover case of key->string[]
shim?: { [key: string]: RequireShim; };
@@ -115,6 +116,19 @@ interface RequireConfig {
};
};
+ /**
+ * Allows pointing multiple module IDs to a module ID that contains a bundle of modules.
+ *
+ * @example
+ * requirejs.config({
+ * bundles: {
+ * 'primary': ['main', 'util', 'text', 'text!template.html'],
+ * 'secondary': ['text!secondary.html']
+ * }
+ * });
+ **/
+ bundles?: { [key: string]: string[]; };
+
/**
* AMD configurations, use module.config() to access in
* define() functions
@@ -182,6 +196,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 e94e5271cf..a6911e3021 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 2c65a7cf4d..22b721b9a1 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/riot-games-api/riot-games-api-tests.ts b/riot-games-api/riot-games-api-tests.ts
new file mode 100644
index 0000000000..32815f2ca8
--- /dev/null
+++ b/riot-games-api/riot-games-api-tests.ts
@@ -0,0 +1,10 @@
+/// <reference path="riot-games-api.d.ts" />
+
+let champion: RiotGamesAPI.Champion.ChampionDto = {
+ active: true,
+ botEnabled: true,
+ botMmEnabled: false,
+ freeToPlay: false,
+ id: 42,
+ rankedPlayEnabled: false
+}
diff --git a/riot-games-api/riot-games-api.d.ts b/riot-games-api/riot-games-api.d.ts
new file mode 100644
index 0000000000..8be033694a
--- /dev/null
+++ b/riot-games-api/riot-games-api.d.ts
@@ -0,0 +1,1112 @@
+// Type definitions for Riot Games API
+// Project: https://developer.riotgames.com/
+// Definitions by: Xavier Stouder <https://github.com/xstoudi/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module RiotGamesAPI{
+ /**
+ * champion-v1.2
+ */
+ module Champion{
+ interface ChampionDto{
+ active: boolean,
+ botEnabled: boolean,
+ botMmEnabled: boolean,
+ freeToPlay: boolean,
+ id: number,
+ rankedPlayEnabled: boolean
+ }
+ interface ChampionListDto{
+ champions: Array<ChampionDto>
+ }
+ }
+
+ /**
+ * current-game-v1.0
+ */
+ module CurrentGame{
+ interface CurrentGameInfo{
+ bannedChampion: Array<BannedChampion>,
+ gameId: number,
+ gameLength: number,
+ gameMode: number,
+ gameQueueConfigId: number,
+ gameStartTime: number,
+ gameType: string,
+ mapId: number,
+ observers: Observer,
+ participants: Array<CurrentGameParticipant>
+ platformId: string
+ }
+ interface BannedChampion{
+ championId: number,
+ pickTurn: number,
+ teamId: number
+ }
+ interface CurrentGameParticipant{
+ bot: boolean,
+ championId: number,
+ masteries: Array<Mastery>
+ profileIconId: number,
+ runes: Array<Rune>,
+ spell1Id: number,
+ spell2Id: number,
+ summonerId: number,
+ summonerName: string,
+ teamId: number
+ }
+ interface Observer{
+ encryptionKey: string
+ }
+ interface Mastery{
+ masterId: number,
+ rank: number
+ }
+ interface Rune{
+ count: number,
+ runeId: number
+ }
+ }
+
+ /**
+ * featured-games-v1.0
+ */
+ module FeaturedGames{
+ interface FeaturedGames{
+ clientRefreshInterval: number,
+ gameList: Array<FeaturedGameInfo>
+ }
+ interface FeaturedGameInfo{
+ bannedChampions: Array<BannedChampion>
+ gameId: number,
+ gameLength: number,
+ gameMode: string,
+ gameQueueConfigId: number,
+ gameStartTime: number,
+ gameType: string,
+ mapId: number,
+ observers: Observer,
+ participants: Array<Participant>,
+ plateformId: string
+ }
+ interface Participant{
+ bot: boolean,
+ championId: number,
+ profileIconId: number,
+ spell1Id: number,
+ spell2Id: number,
+ summonerName: string,
+ teamId: number
+ }
+ interface BannedChampion{
+ championId: number,
+ pickTurn: number,
+ teamId: number
+ }
+ interface Observer{
+ encryptionKey: string
+ }
+ }
+
+ /**
+ * game-v1.3
+ */
+ module Game{
+ interface RecentGamesDto{
+ games: Array<GameDto>,
+ summonerId: number
+ }
+ interface GameDto{
+ championId: number,
+ createDate: number,
+ fellowPlayers: Array<PlayerDto>,
+ gameId: number,
+ gameMode: string,
+ gameType: string,
+ invalid: boolean,
+ ipEarned: number,
+ level: number,
+ mapId: number,
+ spell1: number,
+ spell2: number
+ stats: RawStatsDto,
+ subType: string,
+ teamId: number
+ }
+ interface PlayerDto{
+ championId: number,
+ summonerId: number,
+ teamId: number
+ }
+ interface RawStatsDto{
+ assists: number,
+ barracksKilled: number,
+ championsKilled: number,
+ combatPlayerScore: number,
+ consumablesPurchased: number,
+ damageDealtPlayer: number,
+ doubleKills: number,
+ firstBlood: number,
+ gold: number,
+ goldEarned: number,
+ goldSpent: number,
+ item0: number,
+ item1: number,
+ item2: number,
+ item3: number,
+ item4: number,
+ item5: number,
+ item6: number,
+ itemsPurchased: number,
+ killingSprees: number,
+ largestCriticalStrike: number,
+ largestKillingSpree: number,
+ largestMultiKill: number,
+ legendaryItemsCreated: number,
+ level: number,
+ magicDamageDealtPlayer: number,
+ magicDamageDealtToChampions: number,
+ magicDamageTaken: number,
+ minionsDenied: number,
+ minionsKilled: number,
+ neutralMinionsKilled: number,
+ neutralMinionsKilledEnemyJungle: number,
+ neutralMinionsKilledYourJungle: number,
+ nexusKilled: boolean,
+ nodeCapture: number,
+ nodeCaptureAssist: number,
+ nodeNeutralize: number,
+ nodeNeutralizeAssist: number,
+ numDeaths: number,
+ numItemsBought: number,
+ objectivePlayerScore: number,
+ pentaKills: number,
+ physicalDamageDealtPlayer: number,
+ physicalDamageDealtToChampions: number,
+ physicalDamageTaken: number,
+ playerPosition: number,
+ playerRole: number,
+ quadraKills: number,
+ sightWardsBought: number,
+ spell1Cast: number,
+ spell2Cast: number,
+ spell3Cast: number,
+ spell4Cast: number,
+ summonSpell1Cast: number,
+ summonSpell2Cast: number,
+ superMonsterKilled: number,
+ team: number,
+ teamObjective: number,
+ timePlayed: number,
+ totalDamageDealt: number,
+ totalDamageDealtToChampions: number,
+ totalDamageTaker: number,
+ totalHeal: number,
+ totalPlayerScore: number,
+ totalScoreRank: number,
+ totalTimeCrowdControlDealt: number,
+ totalUnitsHealed: number,
+ tripleKills: number,
+ trueDamageDealtPlayer: number,
+ trueDamageDealtToChampions: number,
+ trueDamageTaken: number,
+ turrentsKilled: number,
+ unrealKills: number,
+ victoryPointTotal: number,
+ visionWardsBought: number,
+ wardKilled: number,
+ wardPlaced: number,
+ win: boolean
+ }
+ }
+
+ /**
+ * league-v2.5
+ */
+ module League{
+ interface LeagueDto{
+ entries: Array<LeagueEntryDto>,
+ name: string,
+ participantId: string,
+ queue: string,
+ tier: string
+ }
+ interface LeagueEntryDto{
+ division: string,
+ isFreshBlood: boolean,
+ isHotStreak: boolean,
+ isInactive: boolean,
+ isVeteran: boolean,
+ leaguePoints: number,
+ losses: number,
+ miniSeries: MiniSeriesDto,
+ playerOrTeamId: string,
+ playerOrTeamName: string,
+ wins: number
+ }
+ interface MiniSeriesDto{
+ losses: number,
+ progress: string,
+ target: number,
+ wins: number
+ }
+ }
+
+ /**
+ * lol-static-data-v1.2
+ */
+ module LolStaticData{
+ interface ChampionListDto{
+ data: {[str: string]: ChampionDto},
+ format: string,
+ keys: {[str: string]: string},
+ type: string,
+ version: string
+ }
+ interface ChampionDto{
+ allytips: Array<string>,
+ blurb: string,
+ enemytips: Array<string>,
+ id: number,
+ image: ImageDto,
+ info: InfoDto,
+ key: string,
+ lore: string,
+ name: string,
+ partype: string,
+ passive: PassiveDto,
+ recommended: Array<RecommendedDto>,
+ skins: Array<SkinDto>,
+ spells: Array<ChampionSpellDto>,
+ stats: StatsDto,
+ tags: Array<string>,
+ title: string
+ }
+ interface ChampionSpellDto{
+ altimages: Array<ImageDto>,
+ cooldown: Array<number>,
+ cooldownBurn: string,
+ cost: Array<number>,
+ costBurn: string,
+ costType: string,
+ description: string,
+ effect: Array<Array<number>>,
+ effectBurn: Array<string>
+ image: ImageDto,
+ key: string,
+ leveltip: LevelTipDto,
+ maxrank: number,
+ name: string,
+ range: Array<number> | string,
+ rangeBurn: string,
+ resource: string,
+ sanitizedDescription: string,
+ sanitizedTooltip: string,
+ tooltip: string,
+ vars: Array<SpellVarsDto>
+ }
+ interface ImageDto{
+ full: string,
+ group: string,
+ h: number,
+ sprite: string,
+ w: number,
+ x: number,
+ y: number
+ }
+ interface InfoDto{
+ attack: number,
+ defense: number,
+ difficulty: number,
+ magic: number
+ }
+ interface PassiveDto{
+ description: string,
+ image: ImageDto,
+ name: string,
+ sanitizedDescription: string
+ }
+ interface RecommendedDto{
+ block: Array<BlockDto>,
+ champion: string,
+ map: string,
+ mode: string,
+ priority: boolean,
+ title: string,
+ type: string
+ }
+ interface SkinDto{
+ id: number,
+ name: string,
+ num: number
+ }
+ interface StatsDto{
+ armor: number,
+ armorperlevel: number,
+ attackdamage: number,
+ attackdamageperlevel: number,
+ attackrange: number,
+ attackspeedoffset: number,
+ attackspeedperlevel: number,
+ crit: number,
+ critperlevel: number,
+ hp: number,
+ hpperlevel: number,
+ hpregen: number,
+ hpregenperlevel: number,
+ movespeed: number,
+ mp: number,
+ mpperlevel: number,
+ mpregen: number,
+ mpregenperlevel: number,
+ spellblock: number,
+ spellblockperlevel: number
+ }
+ interface LevelTipDto{
+ effect: Array<string>,
+ label: Array<string>
+ }
+ interface SpellVarsDto{
+ coeff: Array<number>,
+ dyn: string,
+ key: string,
+ link: string,
+ ranksWith: string
+ }
+ interface BlockDto{
+ items: Array<BlockItemDto>,
+ recMath: boolean,
+ type: string
+ }
+ interface BlockItemDto{
+ count: number,
+ id: number
+ }
+ interface ItemListDto{
+ basic: BasicDataDto,
+ data: Array<{[str: string]: ItemDto}>
+ groups: Array<GroupDto>,
+ tree: Array<ItemTreeDto>,
+ type: string,
+ version: string
+ }
+ interface BasicDataDto{
+ colloq: string,
+ consumeOnFull: boolean,
+ consumed: boolean,
+ depth: number,
+ description: string,
+ from: Array<string>,
+ gold: GoldDto,
+ group: string,
+ hideFromAll: boolean,
+ id: number,
+ image: ImageDto,
+ inStore: boolean,
+ into: Array<string>,
+ maps: Array<{[str: string]: boolean}>,
+ name: string,
+ plaintext: string,
+ requiredChampion: string,
+ rune: MetaDataDto,
+ sanitizedDescription: string,
+ specialRecipe: number,
+ stacks: number,
+ stats: BasicDataStatsDto,
+ tags: Array<string>
+ }
+ interface GroupDto{
+ MaxGroupOwnable: string,
+ key: string
+ }
+ interface ItemDto{
+ colloq: string,
+ consumeOnFull: boolean,
+ consumed: boolean,
+ depth: number,
+ description: string,
+ effect: Array<{[str: string]: string}>,
+ from: Array<string>,
+ gold: GoldDto,
+ group: string,
+ hideFromAll: boolean,
+ id: number,
+ image: ImageDto,
+ inStore: boolean,
+ into: Array<string>,
+ maps: Array<{[str: string]: boolean}>,
+ name: string,
+ plaintext: string,
+ requiredChampion: string,
+ rune: MetaDataDto,
+ sanitizedDescription: string,
+ specialRecipe: number,
+ stacks: number,
+ stats: BasicDataStatsDto,
+ tags: Array<string>
+ }
+ interface ItemTreeDto{
+ header: string,
+ tags: Array<string>
+ }
+ interface BasicDataStatsDto{
+ FlatArmorMod: number,
+ FlatAttackSpeedMod: number,
+ FlatBlockMod: number,
+ FlatCritChanceMod: number,
+ FlatCritDamageMod: number,
+ FlatEXPBonus: number,
+ FlatEnergyPoolMod: number,
+ FlatEnergyRegenMod: number,
+ FlatHPPoolMod: number,
+ FlatHPRegenMod: number,
+ FlatMPPoolMod: number,
+ FlatMPRegenMod: number,
+ FlatMagicDamageMod: number,
+ FlatMovementSpeedMod: number,
+ FlatPhysicalDamageMod: number,
+ FlatSpellBlockMod: number,
+ PercentArmorMod: number,
+ PercentAttackSpeedMod: number,
+ PercentBlockMod: number,
+ PercentCritChanceMod: number,
+ PercentCritDamageMod: number,
+ PercentDodgeMod: number,
+ PercentEXPBonus: number,
+ PercentHPPoolMod: number,
+ PercentHPRegenMod: number,
+ PercentLifeStealMod: number,
+ PercentMPPoolMod: number,
+ PercentMPRegenMod: number,
+ PercentMagicDamageMod: number,
+ PercentMovementSpeedMod: number,
+ PercentPhysicalDamageMod: number,
+ PercentSpellBlockMod: number,
+ PercentSpellVampMod: number,
+ rFlatArmorModPerLevel: number,
+ rFlatArmorPenetrationMod: number,
+ rFlatArmorPenetrationModPerLevel: number,
+ rFlatCritChanceModPerLevel: number,
+ rFlatCritDamageModPerLevel: number,
+ rFlatDodgeMod: number,
+ rFlatDodgeModPerLevel: number,
+ rFlatEnergyModPerLevel: number,
+ rFlatEnergyRegenModPerLevel: number,
+ rFlatGoldPer10Mod: number,
+ rFlatHPModPerLevel: number,
+ rFlatHPRegenModPerLevel: number,
+ rFlatMPModPerLevel: number,
+ rFlatMPRegenModPerLevel: number,
+ rFlatMagicDamageModPerLevel: number,
+ rFlatMagicPenetrationMod: number,
+ rFlatMagicPenetrationModPerLevel: number,
+ rFlatMovementSpeedModPerLevel: number,
+ rFlatPhysicalDamageModPerLevel: number,
+ rFlatSpellBlockModPerLevel: number,
+ rFlatTimeDeadMod: number,
+ rFlatTimeDeadModPerLevel: number,
+ rPercentArmorPenetrationMod: number,
+ rPercentArmorPenetrationModPerLevel: number,
+ rPercentAttackSpeedModPerLevel: number,
+ rPercentCooldownMod: number,
+ rPercentCooldownModPerLevel: number,
+ rPercentMagicPenetrationMod: number,
+ rPercentMagicPenetrationModPerLevel: number,
+ rPercentMovementSpeedModPerLevel: number,
+ rPercentTimeDeadMod: number,
+ rPercentTimeDeadModPerLevel: number
+ }
+ interface GoldDto{
+ base: number,
+ purchasable: boolean,
+ sell: number,
+ total: number
+ }
+ interface MetaDataDto{
+ isRune: boolean,
+ tier: string,
+ type: string
+ }
+ interface LanguageStringsDto{
+ data: Array<{[str: string]: string}>,
+ type: string,
+ version: string
+ }
+ interface MapDataDto{
+ data: Array<{[str: string]: MapDetailsDto}>,
+ type: string,
+ version: string
+ }
+ interface MapDetailsDto{
+ image: ImageDto,
+ mapId: number,
+ mapName: string,
+ unpurchasableItemList: Array<number>,
+ }
+ interface MasteryListDto{
+ data: Array<{[str: string]: MasteryDto}>,
+ tree: MasteryTreeDto,
+ type: string,
+ version: string
+ }
+ interface MasteryDto{
+ description: Array<string>,
+ id: number,
+ image: ImageDto,
+ masteryTree: string,
+ name: string,
+ prereq: string,
+ ranks: number,
+ sanitizedDescription: Array<string>
+ }
+ interface MasteryTreeDto{
+ Defense: Array<MasteryTreeListDto>,
+ Offense: Array<MasteryTreeListDto>,
+ Utility: Array<MasteryTreeListDto>
+ }
+ interface MasteryTreeListDto{
+ masteryTreeItems: Array<MasteryTreeItemDto>
+ }
+ interface MasteryTreeItemDto{
+ masteryId: number,
+ prereq: string
+ }
+ interface RealmDto{
+ cdn: string,
+ css: string,
+ dd: string,
+ l: string,
+ lg: string,
+ n: Array<{[str: string]: string}>,
+ profileiconmax: number,
+ storage: string,
+ v: string
+ }
+ interface RuneListDto{
+ basic: BasicDataDto,
+ data: Array<{[str: string]: RuneDto}>,
+ type: string,
+ version: string
+ }
+ interface RuneDto{
+ colloq: string,
+ consumeOnFull: boolean,
+ consumed: boolean,
+ depth: number,
+ description: string,
+ from: Array<string>,
+ group: string,
+ hideFromAll: boolean,
+ id: number,
+ image: ImageDto,
+ inStore: boolean,
+ into: Array<string>,
+ maps: Array<{[str: string]: boolean}>,
+ name: string,
+ plaintext: string,
+ requiredChampion: string,
+ rune: MetaDataDto,
+ sanitizedDescription: string,
+ specialRecipe: number,
+ stacks: number,
+ stats: BasicDataStatsDto,
+ tags: Array<string>
+ }
+ interface SummonerSpellListDto{
+ data: Array<{[str: string]: SummonerSpellDto}>,
+ type: string,
+ version: string
+ }
+ interface SummonerSpellDto{
+ cooldown: Array<number>,
+ cooldownBurn: string,
+ cost: Array<number>,
+ costBurn: string,
+ costType: string,
+ description: string,
+ effect: Array<Array<number>>,
+ effectBurn: Array<string>,
+ id: number,
+ image: ImageDto,
+ key: string,
+ leveltip: LevelTipDto,
+ maxrank: number,
+ modes: Array<string>,
+ name: string,
+ range: Array<number> | string,
+ rangeBurn: string,
+ resource: string,
+ sanitizedDescription: string,
+ sanitizedTooltip: string,
+ summonerLevel: number,
+ tooltip: string,
+ vars: Array<SpellVarsDto>
+ }
+ }
+
+ /**
+ * lol-status-v1.0
+ */
+ module LolStatus{
+ interface Shard{
+ hostname: string,
+ locales: Array<string>,
+ name: string,
+ region_tag: string,
+ slug: string
+ }
+ interface ShardStatus{
+ hostname: string,
+ locales: Array<string>,
+ name: string,
+ region_tag: string,
+ services: Array<Service>
+ slug: string
+ }
+ interface Service{
+ incidents: Array<Incident>,
+ name: string,
+ slug: string,
+ status: string
+ }
+ interface Incident{
+ active: boolean,
+ created_at: string,
+ id: number,
+ updates: Array<Message>
+ }
+ interface Message{
+ author: string,
+ content: string,
+ created_at: string,
+ id: number,
+ severity: string,
+ translations: Array<Translation>,
+ updated_at: string
+ }
+ interface Translation{
+ content: string,
+ locale: string,
+ updated_at: string
+ }
+ }
+
+ /**
+ * match-v2.2
+ */
+ module Match{
+ interface MatchDetail{
+ mapId: number,
+ matchCreation: number,
+ matchId: number,
+ matchMode: string,
+ matchType: string,
+ matchVersion: string,
+ participantIdentities: Array<ParticipantIdentity>,
+ participants: Array<Participant>,
+ plateformId: string,
+ queueType: string,
+ region: string,
+ season: string,
+ teams: Array<Team>,
+ timeline: Timeline
+ }
+ interface Participant{
+ championId: number,
+ highestAchievedSeasonTier: string,
+ masteries: Array<Mastery>,
+ participantId: number,
+ runes: Array<Rune>,
+ spell1Id: number,
+ spell2Id: number,
+ stats: ParticipantStats,
+ teamId: number,
+ timeline: ParticipantTimeline
+ }
+ interface ParticipantIdentity{
+ participantId: number,
+ player: Player
+ }
+ interface Team{
+ bans: Array<BannedChampion>,
+ baronKills: number,
+ dominionVictoryScore: number,
+ dragonKills: number,
+ firstBaron: boolean,
+ firstBlood: boolean,
+ firstDragon: boolean,
+ firstInhibitor: boolean,
+ firstTower: boolean,
+ inhibitorKills: number,
+ teamId: number,
+ towerKills: number,
+ vilemawKills: number,
+ winner: boolean
+ }
+ interface Timeline{
+ frameInverval: number,
+ frames: Array<Frame>
+ }
+ interface Mastery{
+ masteryId: number,
+ rank: number
+ }
+ interface ParticipantStats{
+ assists: number,
+ champLevel: number,
+ combatPlayerScore: number,
+ deaths: number,
+ doubleKills: number,
+ firstBloodAssist: boolean,
+ firstBloodKill: boolean,
+ firstInhibitorAssist: boolean,
+ firstInhibitorKill: boolean,
+ firstTowerAssist: boolean,
+ firstTowerKill: boolean,
+ goldEarned: number,
+ goldSpent: number,
+ inhibitorKills: number,
+ item0: number,
+ item1: number,
+ item2: number,
+ item3: number,
+ item4: number,
+ item5: number,
+ item6: number,
+ killingSprees: number,
+ kills: number,
+ largestCriticalStrike: number,
+ largestKillingSpree: number,
+ largestMultiKill: number,
+ magicDamageDealt: number,
+ magicDamageDealtToChampions: number,
+ magicDamageTaken: number,
+ minionsKilled: number,
+ neutralMinionsKilled: number,
+ neutralMinionsKilledEnemyJungle: number,
+ neutralMinionsKilledTeamJungle: number,
+ nodeCapture: number,
+ nodeCaptureAssist: number,
+ nodeNeutralize: number,
+ nodeNeutralizeAssist: number,
+ objectivePlayerScore: number,
+ pentaKills: number,
+ physicalDamageDealt: number,
+ physicalDamageDealtToChampions: number,
+ physicalDamageTaken: number,
+ quadraKills: number,
+ sightWardsBoughtInGame: number,
+ teamObjective: number,
+ totalDamageDealt: number,
+ totalDamageDealtToChampions: number,
+ totalDamageTaken: number,
+ totalHeal: number,
+ totalPlayerScore: number,
+ totalScoreRank: number,
+ totalTimeCrowdControlDealt: number,
+ totalUnitsHealed: number,
+ towerKills: number,
+ tripleKills: number,
+ trueDamageDealt: number,
+ trueDamageDealtToChampions: number,
+ trueDamageTaken: number,
+ unrealKills: number,
+ visionWardsBoughtInGame: number,
+ wardsKilled: number,
+ wardsPlaced: number,
+ winner: boolean
+ }
+ interface ParticipantTimeline{
+ ancientGolemAssistsPerMinCounts: ParticipantTimelineData,
+ ancientGolemKillsPerMinCounts: ParticipantTimelineData,
+ assistedLaneDeathsPerMinDeltas: ParticipantTimelineData,
+ assistedLaneKillsPerMinDeltas: ParticipantTimelineData,
+ baronAssistsPerMinCounts: ParticipantTimelineData,
+ baronKillsPerMinCounts: ParticipantTimelineData,
+ creepsPerMinDeltas: ParticipantTimelineData,
+ csDiffPerMinDeltas: ParticipantTimelineData,
+ damageTakenDiffPerMinDeltas: ParticipantTimelineData,
+ damageTakenPerMinDeltas: ParticipantTimelineData,
+ dragonAssistsPerMinCounts: ParticipantTimelineData,
+ dragonKillsPerMinCounts: ParticipantTimelineData,
+ elderLizardAssistsPerMinCounts: ParticipantTimelineData,
+ elderLizardKillsPerMinCounts: ParticipantTimelineData,
+ goldPerMinDeltas: ParticipantTimelineData,
+ inhibitorAssistsPerMinCounts: ParticipantTimelineData,
+ inhibitorKillsPerMinCounts: ParticipantTimelineData,
+ lane: string,
+ role: string,
+ towerAssistsPerMinCounts: ParticipantTimelineData,
+ towerKillsPerMinCounts: ParticipantTimelineData,
+ towerKillsPerMinDeltas: ParticipantTimelineData,
+ vilemawAssistsPerMinCounts: ParticipantTimelineData,
+ vilemawKillsPerMinCounts: ParticipantTimelineData,
+ wardsPerMinDeltas: ParticipantTimelineData,
+ xpDiffPerMinDeltas: ParticipantTimelineData,
+ xpPerMinDeltas: ParticipantTimelineData
+ }
+ interface Rune{
+ rank: number,
+ runeId: number
+ }
+ interface Player{
+ matchHistoryUri: string,
+ profileIcon: number,
+ summonerId: number,
+ summonerName: string
+ }
+ interface BannedChampion{
+ championId: number,
+ pickTurn: number
+ }
+ interface Frame{
+ events: Array<Event>,
+ participanFrames: Array<{[str: string]: ParticipantFrame}>,
+ timestamp: number
+ }
+ interface ParticipantTimelineData{
+ tenToTwenty: number,
+ thirtyToEnd: number,
+ twentyToThirty: number,
+ zeroToTen: number
+ }
+ interface Event{
+ ascendedType: string,
+ assistingParticipantIds: Array<number>,
+ buildingType: string,
+ creatorId: number,
+ eventType: string,
+ itemAfter: number,
+ itemBefore: number,
+ itemId: number,
+ killerId: number,
+ laneType: string,
+ levelUpType: string,
+ monsterType: string,
+ participantId: number,
+ pointCaptured: string,
+ position: Position,
+ skillSlot: number,
+ teamId: number,
+ timestamp: number,
+ towerType: string,
+ victimId: number,
+ wardType: string,
+ }
+ interface ParticipantFrame{
+ currentGold: number,
+ dominionScore: number,
+ jungleMinionsKilled: number,
+ level: number,
+ minionsKilled: number,
+ participantId: number,
+ position: Position,
+ teamScore: number,
+ totalGold: number,
+ xp: number
+ }
+ interface Position{
+ x: number,
+ y: number
+ }
+ }
+
+ /**
+ * matchlist-v2.2
+ */
+ module MatchList{
+ interface MatchList{
+ endIndex: number,
+ matches: Array<MatchReference>,
+ startIndex: number,
+ totalGames: number
+ }
+ interface MatchReference{
+ champion: number,
+ lane: string,
+ matchId: number,
+ plateformId: string,
+ queue: string,
+ region: string,
+ role: string,
+ season: string,
+ timestamp: number
+ }
+ }
+
+ /**
+ * stats-v1.3
+ */
+ module Stats{
+ interface RankedStatsDto{
+ champions: Array<ChampionStatsDto>,
+ modifyDate: number,
+ summonerId: number,
+ }
+ interface ChampionStatsDto{
+ id: number,
+ stats: AggregatedStatsDto
+ }
+ interface AggregatedStatsDto{
+ averageAssists: number,
+ averageChampionsKilled: number,
+ averageCombatPlayerScore: number,
+ averageNodeCapture: number,
+ averageNodeCaptureAssist: number,
+ averageNodeNeutralize: number,
+ averageNodeNeutralizeAssist: number,
+ averageNumDeaths: number,
+ averageObjectivePlayerScore: number,
+ averageTeamObjective: number,
+ averageTotalPlayerScore: number,
+ botGamesPlayed: number,
+ killingSpree: number,
+ maxAssists: number,
+ maxChampionsKilled: number,
+ maxCombatPlayerScore: number,
+ maxLargestCriticalStrike: number,
+ maxLargestKillingSpree: number,
+ maxNodeCapture: number,
+ maxNodeCaptureAssist: number,
+ maxNodeNeutralize: number,
+ maxNodeNeutralizeAssist: number,
+ maxNumDeaths: number,
+ maxObjectivePlayerScore: number,
+ maxTeamObjective: number,
+ maxTimePlayed: number,
+ maxTimeSpentLiving: number,
+ maxTotalPlayerScore: number,
+ mostChampionKillsPerSession: number,
+ mostSpellsCast: number,
+ normalGamesPlayed: number,
+ rankedPremadeGamesPlayed: number,
+ rankedSoloGamesPlayed: number,
+ totalAssists: number,
+ totalChampionKills: number,
+ totalDamageDealt: number,
+ totalDamageTaken: number,
+ totalDeathsPerSession: number,
+ totalDoubleKills: number,
+ totalFirstBlood: number,
+ totalGoldEarned: number,
+ totalHeal: number,
+ totalMagicDamageDealt: number,
+ totalMinionsKills: number,
+ totalNeutralMinionsKilled: number,
+ totalNodeCapture: number,
+ totalNodeNeutralize: number,
+ totalPentaKills: number,
+ totalPhysicalDamageDealt: number,
+ totalQuadraKills: number,
+ totalSessionsLost: number,
+ totalSessionsPlayed: number,
+ totalSessionsWon: number,
+ totalTripleKills: number,
+ totalTurretsKilleds: number,
+ totalUnrealKills: number
+ }
+ interface PlayerStatsSummaryListDto{
+ playerStatSummaries: Array<PlayerStatsSummaryDto>,
+ summonerId: number
+ }
+ interface PlayerStatsSummaryDto{
+ aggregatedStats: AggregatedStatsDto,
+ losses: number,
+ modifyDate: number,
+ playerStatSummaryType: string,
+ wins: number
+ }
+ }
+
+ /**
+ * summoner-v1.4
+ */
+ module Summoner{
+ interface SummonerDto{
+ id: number,
+ name: string,
+ profileIconId: number,
+ revisionDate: number,
+ summonerLevel: number
+ }
+ interface MasteryPagesDto{
+ pages: Array<MasteryPageDto>,
+ summonerId: number
+ }
+ interface MasteryPageDto{
+ current: boolean,
+ id: number,
+ masteries: Array<MasteryDto>,
+ name: string
+ }
+ interface MasteryDto{
+ id: number,
+ rank: number
+ }
+ interface RunePagesDto{
+ pages: Array<RunePageDto>,
+ summonerId: number
+ }
+ interface RunePageDto{
+ current: boolean,
+ id: number,
+ name: string,
+ slots: Array<RuneSlotDto>
+ }
+ interface RuneSlotDto{
+ runeId: number,
+ runeSlotId: number
+ }
+ }
+
+ /**
+ * team-v2.4
+ */
+ module Team{
+ interface TeamDto{
+ createDate: number,
+ fullId: string,
+ lastGameDate: number,
+ lastJoinDate: number,
+ lastJoinedRankedTeamQueueDate: number,
+ matchHistory: Array<MatchHistorySummaryDto>,
+ modifyDate: number,
+ name: string,
+ roster: RosterDto,
+ secondLastJoinDate: number,
+ status: string,
+ tag: string,
+ teamStatDetails: Array<TeamStatDetailDto>,
+ thirdLastJoinDate: number
+ }
+ interface MatchHistorySummaryDto{
+ assists: number,
+ date: number,
+ deaths: number,
+ gameId: number,
+ gameMode: string,
+ invalid: boolean,
+ kills: number,
+ mapId: number,
+ opposingTeamKills: number,
+ opposingTeamName: string,
+ win: boolean
+ }
+ interface RosterDto{
+ memberList: Array<TeamMemberInfoDto>,
+ ownerId: number
+ }
+ interface TeamStatDetailDto{
+ averageGamesPlayed: number,
+ losses: number,
+ teamStatType: string,
+ wins: number
+ }
+ interface TeamMemberInfoDto{
+ inviteDate: number,
+ joinDate: number,
+ playerId: number,
+ status: string
+ }
+ }
+}
\ No newline at end of file
diff --git a/roslib/roslib-tests.ts b/roslib/roslib-tests.ts
new file mode 100644
index 0000000000..c209b4a0c4
--- /dev/null
+++ b/roslib/roslib-tests.ts
@@ -0,0 +1,13 @@
+/// <reference path="roslib.d.ts" />
+
+var ros = new ROSLIB.Ros({url: "http://localhost:9090"});
+
+ros.on('error', function(event) {
+ //do nothing
+});
+
+var service = new ROSLIB.Service({
+ ros: ros,
+ name: '/service_name',
+ serviceType: 'service_type'
+});
diff --git a/roslib/roslib.d.ts b/roslib/roslib.d.ts
new file mode 100644
index 0000000000..8610ea7d46
--- /dev/null
+++ b/roslib/roslib.d.ts
@@ -0,0 +1,375 @@
+// Type definitions for roslib.js
+// Project: http://wiki.ros.org/roslibjs
+// 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 {
+ /**
+ * 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 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 {
+ /**
+ * 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/rx/rx-lite-tests.ts b/rx/rx-lite-tests.ts
new file mode 100644
index 0000000000..9949fa2ea8
--- /dev/null
+++ b/rx/rx-lite-tests.ts
@@ -0,0 +1,13 @@
+/// <reference path="rx-lite.d.ts" />
+function test_scan() {
+
+ /* Without a seed */
+ const source1: Rx.Observable<number> = Rx.Observable.range(1, 3)
+ .scan((acc, x, i, source) => acc + x);
+
+ /* With a seed */
+ const source2: Rx.Observable<string> = Rx.Observable.range(1, 3)
+ .scan((acc, x, i, source) => acc + x, '...');
+
+}
+
diff --git a/rx/rx-lite.d.ts b/rx/rx-lite.d.ts
index 10aec5d791..14f40fdb39 100644
--- a/rx/rx-lite.d.ts
+++ b/rx/rx-lite.d.ts
@@ -323,8 +323,20 @@ declare module Rx {
materialize(): Observable<Notification<T>>;
repeat(repeatCount?: number): Observable<T>;
retry(retryCount?: number): Observable<T>;
- scan<TAcc>(accumulator: (acc: TAcc, value: T, seed: TAcc) => TAcc): Observable<TAcc>;
- scan(accumulator: (acc: T, value: T) => T): Observable<T>;
+
+ /**
+ * Applies an accumulator function over an observable sequence and returns each intermediate result. The optional seed value is used as the initial accumulator value.
+ * For aggregation behavior with no intermediate results, see Observable.aggregate.
+ * @example
+ * var res = source.scan(function (acc, x) { return acc + x; });
+ * var res = source.scan(function (acc, x) { return acc + x; }, 0);
+ * @param accumulator An accumulator function to be invoked on each element.
+ * @param seed The initial accumulator value.
+ * @returns An observable sequence containing the accumulated values.
+ */
+ scan<TAcc>(accumulator: (acc: TAcc, value: T, index?: number, source?: Observable<TAcc>) => TAcc, seed: TAcc): Observable<TAcc>;
+ scan(accumulator: (acc: T, value: T, index?: number, source?: Observable<T>) => T): Observable<T>;
+
skipLast(count: number): Observable<T>;
startWith(...values: T[]): Observable<T>;
startWith(scheduler: IScheduler, ...values: T[]): Observable<T>;
diff --git a/satnav/satnav-tests.ts b/satnav/satnav-tests.ts
index 6382c0481a..aae59ba1f5 100644
--- a/satnav/satnav-tests.ts
+++ b/satnav/satnav-tests.ts
@@ -1,18 +1,18 @@
-/// <reference path="satnav.d.ts" />
-Satnav({})
-.navigate({
- path: 'product/{required}/?{optional}',
- directions: (params) => {
- // Logic for product route
- console.log(params.required);
- console.log(params.hasOwnProperty('optional'));
- }
-})
-.otherwise('/product/1')
-.change(function (hash, params, old) {
- // Logic for any change
- console.log(hash);
- console.log(params);
- console.log(old);
-})
+/// <reference path="satnav.d.ts" />
+Satnav({})
+.navigate({
+ path: 'product/{required}/?{optional}',
+ directions: (params) => {
+ // Logic for product route
+ console.log(params.required);
+ console.log(params.hasOwnProperty('optional'));
+ }
+})
+.otherwise('/product/1')
+.change(function (hash, params, old) {
+ // Logic for any change
+ console.log(hash);
+ console.log(params);
+ console.log(old);
+})
.go(); //Resolve current route
\ No newline at end of file
diff --git a/satnav/satnav.d.ts b/satnav/satnav.d.ts
index 5b16a3ffb4..d57cf565d3 100644
--- a/satnav/satnav.d.ts
+++ b/satnav/satnav.d.ts
@@ -1,28 +1,28 @@
-// Type definitions for satnav
-// Project: https://github.com/f5io/satnav-js
-// Definitions by: Christian Holm Diget <https://github.com/DotNetNerd>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-declare type Callback = () => void;
-
-interface ISatnavOptions {
- html5?: boolean,
- force?: boolean,
- poll?: number,
- matchAll?: boolean
-}
-
-interface INavigationOptions {
- path?: string,
- directions?: (params : any) => any,
- title?: string | Callback
-}
-
-interface ISatnav {
- navigate(navigationOptions: INavigationOptions): ISatnav;
- otherwise(route: string): ISatnav;
- change(onChange: (hash: string, params: any, old: any) => any): ISatnav;
- go(): ISatnav;
-}
-
+// Type definitions for satnav
+// Project: https://github.com/f5io/satnav-js
+// Definitions by: Christian Holm Diget <https://github.com/DotNetNerd>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare type Callback = () => void;
+
+interface ISatnavOptions {
+ html5?: boolean,
+ force?: boolean,
+ poll?: number,
+ matchAll?: boolean
+}
+
+interface INavigationOptions {
+ path?: string,
+ directions?: (params : any) => any,
+ title?: string | Callback
+}
+
+interface ISatnav {
+ navigate(navigationOptions: INavigationOptions): ISatnav;
+ otherwise(route: string): ISatnav;
+ change(onChange: (hash: string, params: any, old: any) => any): ISatnav;
+ go(): ISatnav;
+}
+
declare function Satnav(options?: ISatnavOptions): ISatnav;
\ No newline at end of file
diff --git a/segment-analytics/segment-analytics-tests.ts b/segment-analytics/segment-analytics-tests.ts
old mode 100755
new mode 100644
diff --git a/segment-analytics/segment-analytics.d.ts b/segment-analytics/segment-analytics.d.ts
old mode 100755
new mode 100644
diff --git a/select2/select2.d.ts b/select2/select2.d.ts
index 259dd16cf8..0752ddf98a 100644
--- a/select2/select2.d.ts
+++ b/select2/select2.d.ts
@@ -71,6 +71,12 @@ interface Select2Options {
dropdownCss?: any;
dropdownCssClass?: any;
escapeMarkup?: (markup: string) => string;
+ theme?: string;
+ /**
+ * Template can return both plain string that will be HTML escaped and a jquery object that can render HTML
+ */
+ templateSelection?: (object: Select2SelectionObject) => any;
+ templateResult?: (object: Select2SelectionObject) => any;
}
interface Select2JQueryEventObject extends JQueryEventObject {
@@ -83,6 +89,15 @@ interface Select2JQueryEventObject extends JQueryEventObject {
};
}
+interface Select2SelectionObject {
+ disabled: boolean,
+ element: HTMLOptionElement,
+ id: string,
+ selected: boolean,
+ text: string,
+ title: string,
+}
+
interface JQuery {
off(events?: "change", selector?: any, handler?: (eventObject: Select2JQueryEventObject) => any): JQuery;
diff --git a/sequelize/sequelize-tests.ts b/sequelize/sequelize-tests.ts
index ae6fd7af4c..cda4aff119 100644
--- a/sequelize/sequelize-tests.ts
+++ b/sequelize/sequelize-tests.ts
@@ -151,6 +151,317 @@ Post.belongsToMany( User, {
Post.belongsToMany( Post, { through : { model : Post, unique : false }, foreignKey : 'tag_id' } );
Post.belongsToMany( Post, { as : 'Parents', through : 'Family', foreignKey : 'ChildId', otherKey : 'PersonId' } );
+//
+// Mixins
+// ~~~~~~
+//
+// https://github.com/sequelize/sequelize/tree/v3.4.1/test/integration/associations
+//
+
+var Product = s.define<ProductInstance, ProductAttributes>('product', {});
+var product = Product.build();
+
+var Barcode = s.define<BarcodeInstance, BarcodeAttributes>('barcode', {});
+var barcode = Barcode.build();
+
+var Warehouse = s.define<WarehouseInstance, WarehouseAttributes>('warehouse', {});
+var warehouse = Warehouse.build();
+
+var Branch = s.define<BranchInstance, BranchAttributes>('brach', {});
+var branch = Branch.build();
+
+var WarehouseBranch = s.define<WarehouseBranchInstance, WarehouseBranchAttributes>('warehouseBranch', {});
+
+var Customer = s.define<CustomerInstance, CustomerAttributes>('customer', {});
+var customer = Customer.build();
+
+Product.hasOne(Barcode);
+Barcode.belongsTo(Product);
+
+Warehouse.hasMany(Product);
+Product.belongsTo(Warehouse);
+
+Warehouse.belongsToMany(Branch, { through: WarehouseBranch });
+Branch.belongsToMany(Warehouse, { through: WarehouseBranch });
+
+Branch.belongsToMany(Customer, { through: 'branchCustomer' });
+Customer.belongsToMany(Branch, { through: 'branchCustomer' });
+
+// hasOne
+product.getBarcode();
+product.getBarcode({ scope: null }).then(b => b.code);
+
+product.setBarcode();
+product.setBarcode(1);
+product.setBarcode(barcode);
+product.setBarcode(barcode, { save: true }).then(() => { });
+
+product.createBarcode();
+product.createBarcode({ id: 1, code: '1434-2' });
+product.createBarcode({ id: 1 }, { save: true, silent: true }).then(() => { });
+
+// belongsTo
+barcode.getProduct();
+barcode.getProduct({ scope: 'foo' }).then(p => p.name);
+
+barcode.setProduct();
+barcode.setProduct(1);
+barcode.setProduct(product);
+barcode.setProduct(product, { save: true }).then(() => { });
+
+barcode.createProduct();
+barcode.createProduct({ id: 1, name: 'Crowbar' });
+barcode.createProduct({ id: 1 }, { save: true, silent: true }).then(() => { });
+
+product.getWarehouse();
+product.getWarehouse({ scope: null }).then(w => w.capacity);
+
+product.setWarehouse();
+product.setWarehouse(1);
+product.setWarehouse(warehouse);
+product.setWarehouse(warehouse, { save: true }).then(() => { });
+
+product.createWarehouse();
+product.createWarehouse({ id: 1, capacity: 10000 });
+product.createWarehouse({ id: 1 }, { save: true, silent: true }).then(() => { });
+
+// hasMany
+warehouse.getProducts();
+warehouse.getProducts({ where: {}, scope: false });
+warehouse.getProducts({ where: {}, scope: false }).then((products) => products[0].id);
+
+warehouse.setProducts();
+warehouse.setProducts([product]);
+warehouse.setProducts([product], { validate: true }).then(() => { });
+
+warehouse.addProducts();
+warehouse.addProducts([product]);
+warehouse.addProducts([product, 2], { validate: false }).then(() => { });
+
+warehouse.addProduct();
+warehouse.addProduct(product);
+warehouse.addProduct(2, { validate: true }).then(() => { });
+
+warehouse.createProduct();
+warehouse.createProduct({ id: 1, name: 'baz' });
+warehouse.createProduct({ id: 1 }, { silent: true }).then(() => { });
+
+warehouse.removeProducts();
+warehouse.removeProducts([product]);
+warehouse.removeProducts([product, 2], { validate: false }).then(() => { });
+
+warehouse.removeProduct();
+warehouse.removeProduct(product);
+warehouse.removeProduct(2, { validate: true }).then(() => { });
+
+warehouse.hasProducts([product]);
+warehouse.hasProducts([product, 2], { scope: 'bar' }).then((result: boolean) => { });
+
+warehouse.hasProduct(product);
+warehouse.hasProduct(2, { scope: 'baz' }).then((result: boolean) => { });
+
+warehouse.countProducts();
+warehouse.countProducts({ scope: 'baz' }).then((result: number) => { });
+
+// belongsToMany <Model>
+warehouse.getBranches();
+warehouse.getBranches({ where: {} });
+warehouse.getBranches({ where: {} }).then((branches) => branches[0].rank);
+
+warehouse.setBranches();
+warehouse.setBranches([branch]);
+warehouse.setBranches([branch, 2], { validate: true, distance: 1 }).then(() => { });
+
+warehouse.addBranches();
+warehouse.addBranches([branch]);
+warehouse.addBranches([branch, 2], { validate: false, distance: 1 }).then(() => { });
+
+warehouse.addBranch();
+warehouse.addBranch(branch);
+warehouse.addBranch(2, { validate: true, distance: 1 }).then(() => { });
+
+warehouse.createBranch();
+warehouse.createBranch({ id: 1, address: 'baz' });
+warehouse.createBranch({ id: 1 }, { silent: true, distance: 1 }).then(() => { });
+
+warehouse.removeBranches();
+warehouse.removeBranches([branch]);
+warehouse.removeBranches([branch, 2], { validate: false }).then(() => { });
+
+warehouse.removeBranch();
+warehouse.removeBranch(branch);
+warehouse.removeBranch(2, { validate: true }).then(() => { });
+
+warehouse.hasBranches([branch]);
+warehouse.hasBranches([branch, 2], { scope: 'bar' }).then((result: boolean) => { });
+
+warehouse.hasBranch(branch);
+warehouse.hasBranch(2, { scope: 'baz' }).then((result: boolean) => { });
+
+warehouse.countBranches();
+warehouse.countBranches({ scope: 'baz' }).then((result: number) => { });
+
+// belongsToMany <void>
+customer.getBranches();
+customer.getBranches({ where: {} });
+customer.getBranches({ where: {} }).then((branches) => branches[0].rank);
+
+customer.setBranches();
+customer.setBranches([branch]);
+customer.setBranches([branch, 2], { validate: true }).then(() => { });
+
+customer.addBranches();
+customer.addBranches([branch]);
+customer.addBranches([branch, 2], { validate: false }).then(() => { });
+
+customer.addBranch();
+customer.addBranch(branch);
+customer.addBranch(2, { validate: true }).then(() => { });
+
+customer.createBranch();
+customer.createBranch({ id: 1, address: 'baz' });
+customer.createBranch({ id: 1 }, { silent: true }).then(() => { });
+
+customer.removeBranches();
+customer.removeBranches([branch]);
+customer.removeBranches([branch, 2], { validate: false }).then(() => { });
+
+customer.removeBranch();
+customer.removeBranch(branch);
+customer.removeBranch(2, { validate: true }).then(() => { });
+
+customer.hasBranches([branch]);
+customer.hasBranches([branch, 2], { scope: 'bar' }).then((result: boolean) => { });
+
+customer.hasBranch(branch);
+customer.hasBranch(2, { scope: 'baz' }).then((result: boolean) => { });
+
+customer.countBranches();
+customer.countBranches({ scope: 'baz' }).then((result: number) => { });
+
+
+
+interface ProductAttributes {
+ id?: number;
+ name?: string;
+ price?: number;
+};
+
+interface ProductInstance extends Sequelize.Instance<ProductInstance, ProductAttributes>, ProductAttributes {
+ // hasOne association mixins:
+ getBarcode: Sequelize.HasOneGetAssociationMixin<BarcodeInstance>;
+ setBarcode: Sequelize.HasOneSetAssociationMixin<BarcodeInstance, number>;
+ createBarcode: Sequelize.HasOneCreateAssociationMixin<BarcodeAttributes>;
+
+ // belongsTo association mixins:
+ getWarehouse: Sequelize.BelongsToGetAssociationMixin<WarehouseInstance>;
+ setWarehouse: Sequelize.BelongsToSetAssociationMixin<WarehouseInstance, number>;
+ createWarehouse: Sequelize.BelongsToCreateAssociationMixin<WarehouseAttributes>;
+};
+
+interface BarcodeAttributes {
+ id?: number;
+ code?: string;
+ dateIssued?: Date;
+};
+
+interface BarcodeInstance extends Sequelize.Instance<BarcodeInstance, BarcodeAttributes>, BarcodeAttributes {
+ // belongsTo association mixins:
+ getProduct: Sequelize.BelongsToGetAssociationMixin<ProductInstance>;
+ setProduct: Sequelize.BelongsToSetAssociationMixin<ProductInstance, number>;
+ createProduct: Sequelize.BelongsToCreateAssociationMixin<ProductAttributes>;
+};
+
+interface WarehouseAttributes {
+ id?: number;
+ address?: string;
+ capacity?: number;
+};
+
+interface WarehouseInstance extends Sequelize.Instance<WarehouseInstance, WarehouseAttributes>, WarehouseAttributes {
+ // hasMany association mixins:
+ getProducts: Sequelize.HasManyGetAssociationsMixin<ProductInstance>;
+ setProducts: Sequelize.HasManySetAssociationsMixin<ProductInstance, number>;
+ addProducts: Sequelize.HasManyAddAssociationsMixin<ProductInstance, number>;
+ addProduct: Sequelize.HasManyAddAssociationMixin<ProductInstance, number>;
+ createProduct: Sequelize.HasManyCreateAssociationMixin<ProductAttributes>;
+ removeProduct: Sequelize.HasManyRemoveAssociationMixin<ProductInstance, number>;
+ removeProducts: Sequelize.HasManyRemoveAssociationsMixin<ProductInstance, number>;
+ hasProduct: Sequelize.HasManyHasAssociationMixin<ProductInstance, number>;
+ hasProducts: Sequelize.HasManyHasAssociationsMixin<ProductInstance, number>;
+ countProducts: Sequelize.HasManyCountAssociationsMixin;
+
+ // belongsToMany association mixins:
+ getBranches: Sequelize.BelongsToManyGetAssociationsMixin<BranchInstance>;
+ setBranches: Sequelize.BelongsToManySetAssociationsMixin<BranchInstance, number, WarehouseBranchAttributes>;
+ addBranches: Sequelize.BelongsToManyAddAssociationsMixin<BranchInstance, number, WarehouseBranchAttributes>;
+ addBranch: Sequelize.BelongsToManyAddAssociationMixin<BranchInstance, number, WarehouseBranchAttributes>;
+ createBranch: Sequelize.BelongsToManyCreateAssociationMixin<BranchAttributes, WarehouseBranchAttributes>;
+ removeBranch: Sequelize.BelongsToManyRemoveAssociationMixin<BranchInstance, number>;
+ removeBranches: Sequelize.BelongsToManyRemoveAssociationsMixin<BranchInstance, number>;
+ hasBranch: Sequelize.BelongsToManyHasAssociationMixin<BranchInstance, number>;
+ hasBranches: Sequelize.BelongsToManyHasAssociationsMixin<BranchInstance, number>;
+ countBranches: Sequelize.BelongsToManyCountAssociationsMixin;
+};
+
+interface BranchAttributes {
+ id?: number;
+ address?: string;
+ rank?: number;
+};
+
+interface BranchInstance extends Sequelize.Instance<BranchInstance, BranchAttributes>, BranchAttributes {
+ // belongsToMany association mixins:
+ getWarehouses: Sequelize.BelongsToManyGetAssociationsMixin<WarehouseInstance>;
+ setWarehouses: Sequelize.BelongsToManySetAssociationsMixin<WarehouseInstance, number, WarehouseBranchAttributes>;
+ addWarehouses: Sequelize.BelongsToManyAddAssociationsMixin<WarehouseInstance, number, WarehouseBranchAttributes>;
+ addWarehouse: Sequelize.BelongsToManyAddAssociationMixin<WarehouseInstance, number, WarehouseBranchAttributes>;
+ createWarehouse: Sequelize.BelongsToManyCreateAssociationMixin<WarehouseAttributes, WarehouseBranchAttributes>;
+ removeWarehouse: Sequelize.BelongsToManyRemoveAssociationMixin<WarehouseInstance, number>;
+ removeWarehouses: Sequelize.BelongsToManyRemoveAssociationsMixin<WarehouseInstance, number>;
+ hasWarehouse: Sequelize.BelongsToManyHasAssociationMixin<WarehouseInstance, number>;
+ hasWarehouses: Sequelize.BelongsToManyHasAssociationsMixin<WarehouseInstance, number>;
+ countWarehouses: Sequelize.BelongsToManyCountAssociationsMixin;
+
+ // belongsToMany association mixins:
+ getCustomers: Sequelize.BelongsToManyGetAssociationsMixin<CustomerInstance>;
+ setCustomers: Sequelize.BelongsToManySetAssociationsMixin<CustomerInstance, number, void>;
+ addCustomers: Sequelize.BelongsToManyAddAssociationsMixin<CustomerInstance, number, void>;
+ addCustomer: Sequelize.BelongsToManyAddAssociationMixin<CustomerInstance, number, void>;
+ createCustomer: Sequelize.BelongsToManyCreateAssociationMixin<CustomerAttributes, void>;
+ removeCustomer: Sequelize.BelongsToManyRemoveAssociationMixin<CustomerInstance, number>;
+ removeCustomers: Sequelize.BelongsToManyRemoveAssociationsMixin<CustomerInstance, number>;
+ hasCustomer: Sequelize.BelongsToManyHasAssociationMixin<CustomerInstance, number>;
+ hasCustomers: Sequelize.BelongsToManyHasAssociationsMixin<CustomerInstance, number>;
+ countCustomers: Sequelize.BelongsToManyCountAssociationsMixin;
+};
+
+interface WarehouseBranchAttributes {
+ distance?: number;
+};
+
+interface WarehouseBranchInstance extends Sequelize.Instance<WarehouseBranchInstance, WarehouseBranchAttributes>, WarehouseBranchAttributes { };
+
+interface CustomerAttributes {
+ id?: number;
+ fullname?: string;
+ credit?: number;
+};
+
+interface CustomerInstance extends Sequelize.Instance<CustomerInstance, CustomerAttributes>, CustomerAttributes {
+ // belongsToMany association mixins:
+ getBranches: Sequelize.BelongsToManyGetAssociationsMixin<BranchInstance>;
+ setBranches: Sequelize.BelongsToManySetAssociationsMixin<BranchInstance, number, void>;
+ addBranches: Sequelize.BelongsToManyAddAssociationsMixin<BranchInstance, number, void>;
+ addBranch: Sequelize.BelongsToManyAddAssociationMixin<BranchInstance, number, void>;
+ createBranch: Sequelize.BelongsToManyCreateAssociationMixin<BranchAttributes, void>;
+ removeBranch: Sequelize.BelongsToManyRemoveAssociationMixin<BranchInstance, number>;
+ removeBranches: Sequelize.BelongsToManyRemoveAssociationsMixin<BranchInstance, number>;
+ hasBranch: Sequelize.BelongsToManyHasAssociationMixin<BranchInstance, number>;
+ hasBranches: Sequelize.BelongsToManyHasAssociationsMixin<BranchInstance, number>;
+ countBranches: Sequelize.BelongsToManyCountAssociationsMixin;
+};
+
//
// DataTypes
// ~~~~~~~~~~~
diff --git a/sequelize/sequelize.d.ts b/sequelize/sequelize.d.ts
index ba8d03d94b..a0a567ecad 100644
--- a/sequelize/sequelize.d.ts
+++ b/sequelize/sequelize.d.ts
@@ -22,23 +22,26 @@ declare module "sequelize" {
/**
- * The options for the get mixin of the BelongsTo association.
- * @see BelongsToAssociationGetMixin
+ * The options for the getAssociation mixin of the belongsTo association.
+ * @see BelongsToGetAssociationMixin
*/
- interface BelongsToAssociationGetMixinOptions {
- /**
- * Apply a scope on the related model, or remove its default scope by passing false.
- */
- scope: string | boolean;
+ interface BelongsToGetAssociationMixinOptions {
+ /**
+ * Apply a scope on the related model, or remove its default scope by passing false.
+ */
+ scope?: string | boolean;
}
/**
- * The get association mixin applied to models with BelongsTo.
+ * The getAssociation mixin applied to models with belongsTo.
* An example of usage is as follows:
*
* ```js
+ *
+ * User.belongsTo(Role);
+ *
* interface UserInstance extends Sequelize.Instance<UserInstance, UserAttrib>, UserAttrib {
- * getRole: Sequelize.BelongsToAssociationGetMixin<RoleInstance>;
+ * getRole: Sequelize.BelongsToGetAssociationMixin<RoleInstance>;
* // setRole...
* // createRole...
* }
@@ -47,33 +50,36 @@ declare module "sequelize" {
* @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to/
* @see Instance
*/
- interface BelongsToAssociationGetMixin<TInstance> {
- /**
- * Get the associated instance.
- * @param options The obtions to use when getting the association.
- */
- (options?: BelongsToAssociationGetMixinOptions): Promise<TInstance>
+ interface BelongsToGetAssociationMixin<TInstance> {
+ /**
+ * Get the associated instance.
+ * @param options The options to use when getting the association.
+ */
+ (options?: BelongsToGetAssociationMixinOptions): Promise<TInstance>
}
/**
- * The options for the set mixin of the BelongsTo association.
- * @see BelongsToAssociationSetMixin
+ * The options for the setAssociation mixin of the belongsTo association.
+ * @see BelongsToSetAssociationMixin
*/
- interface BelongsToAssociationSetMixinOptions {
- /**
- * Skip saving this after setting the foreign key if false.
- */
- save: boolean;
+ interface BelongsToSetAssociationMixinOptions {
+ /**
+ * Skip saving this after setting the foreign key if false.
+ */
+ save?: boolean;
}
/**
- * The set association mixin applied to models with BelongsTo.
+ * The setAssociation mixin applied to models with belongsTo.
* An example of usage is as follows:
*
* ```js
+ *
+ * User.belongsTo(Role);
+ *
* interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
* // getRole...
- * setRole: BelongsToAssociationSetMixin<RoleInstance, RoleId>;
+ * setRole: Sequelize.BelongsToSetAssociationMixin<RoleInstance, RoleId>;
* // createRole...
* }
* ```
@@ -81,48 +87,1093 @@ declare module "sequelize" {
* @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to/
* @see Instance
*/
- interface BelongsToAssociationSetMixin<TInstance, TInstancePrimaryKey> {
- /**
- * Get the associated instance.
- * @param newAssociation An instance or the primary key of an instance to associate with this. Pass null or undefined to remove the association.
- * @param options The obtions to use when setting the association.
- */
- (newAssociation: TInstance | TInstancePrimaryKey, options?: BelongsToAssociationSetMixinOptions): Promise<void>
+ interface BelongsToSetAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Set the associated instance.
+ * @param newAssociation An instance or the primary key of an instance to associate with this. Pass null or undefined to remove the association.
+ * @param options the options passed to `this.save`.
+ */
+ (
+ newAssociation?: TInstance | TInstancePrimaryKey,
+ options?: BelongsToSetAssociationMixinOptions | InstanceSaveOptions
+ ): Promise<void>
}
/**
- * The options for the create mixin of the BelongsTo association.
- * @see BelongsToAssociationCreateMixin
+ * The options for the createAssociation mixin of the belongsTo association.
+ * @see BelongsToCreateAssociationMixin
*/
- interface BelongsToAssociationCreateMixinOptions extends CreateOptions, BelongsToAssociationSetMixinOptions {}
+ interface BelongsToCreateAssociationMixinOptions { }
/**
- * The create association mixin applied to models with BelongsTo.
+ * The createAssociation mixin applied to models with belongsTo.
* An example of usage is as follows:
*
* ```js
+ *
+ * User.belongsTo(Role);
+ *
* interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
* // getRole...
* // setRole...
- * createRole: BelongsToAssociationCreateMixin<RoleAttributes>;
+ * createRole: Sequelize.BelongsToCreateAssociationMixin<RoleAttributes>;
* }
* ```
*
* @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to/
* @see Instance
*/
- interface BelongsToAssociationCreateMixin<TAttributes> {
- /**
- * Create a new instance of the associated model and associate it with this.
- * @param values The values used to create the association.
- * @param options The options passed to `target.create` and `setAssociation`.
- */
- (values?: TAttributes, options?: BelongsToAssociationCreateMixinOptions): Promise<void>
+ interface BelongsToCreateAssociationMixin<TAttributes> {
+ /**
+ * Create a new instance of the associated model and associate it with this.
+ * @param values The values used to create the association.
+ * @param options The options passed to `target.create` and `setAssociation`.
+ */
+ (
+ values?: TAttributes,
+ options?: BelongsToCreateAssociationMixinOptions | CreateOptions | BelongsToSetAssociationMixinOptions
+ ): Promise<void>
}
- // TODO: HasOne Associations
- // TODO: HasMany Associations
- // TODO: BelongsToMany Associations
+ /**
+ * The options for the getAssociation mixin of the hasOne association.
+ * @see HasOneGetAssociationMixin
+ */
+ interface HasOneGetAssociationMixinOptions {
+ /**
+ * Apply a scope on the related model, or remove its default scope by passing false.
+ */
+ scope?: string | boolean;
+ }
+
+ /**
+ * The getAssociation mixin applied to models with hasOne.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasOne(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttrib>, UserAttrib {
+ * getRole: Sequelize.HasOneGetAssociationMixin<RoleInstance>;
+ * // setRole...
+ * // createRole...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-one/
+ * @see Instance
+ */
+ interface HasOneGetAssociationMixin<TInstance> {
+ /**
+ * Get the associated instance.
+ * @param options The options to use when getting the association.
+ */
+ (options?: HasOneGetAssociationMixinOptions): Promise<TInstance>
+ }
+
+ /**
+ * The options for the setAssociation mixin of the hasOne association.
+ * @see HasOneSetAssociationMixin
+ */
+ interface HasOneSetAssociationMixinOptions {
+ /**
+ * Skip saving this after setting the foreign key if false.
+ */
+ save?: boolean;
+ }
+
+ /**
+ * The setAssociation mixin applied to models with hasOne.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasOne(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRole...
+ * setRole: Sequelize.HasOneSetAssociationMixin<RoleInstance, RoleId>;
+ * // createRole...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-one/
+ * @see Instance
+ */
+ interface HasOneSetAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Set the associated instance.
+ * @param newAssociation An instance or the primary key of an instance to associate with this. Pass null or undefined to remove the association.
+ * @param options The options passed to `getAssocation` and `target.save`.
+ */
+ (
+ newAssociation?: TInstance | TInstancePrimaryKey,
+ options?: HasOneSetAssociationMixinOptions | HasOneGetAssociationMixinOptions | InstanceSaveOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the createAssociation mixin of the hasOne association.
+ * @see HasOneCreateAssociationMixin
+ */
+ interface HasOneCreateAssociationMixinOptions { }
+
+ /**
+ * The createAssociation mixin applied to models with hasOne.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasOne(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRole...
+ * // setRole...
+ * createRole: Sequelize.HasOneCreateAssociationMixin<RoleAttributes>;
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-one/
+ * @see Instance
+ */
+ interface HasOneCreateAssociationMixin<TAttributes> {
+ /**
+ * Create a new instance of the associated model and associate it with this.
+ * @param values The values used to create the association.
+ * @param options The options passed to `target.create` and `setAssociation`.
+ */
+ (
+ values?: TAttributes,
+ options?: HasOneCreateAssociationMixinOptions | HasOneSetAssociationMixinOptions | CreateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the getAssociations mixin of the hasMany association.
+ * @see HasManyGetAssociationsMixin
+ */
+ interface HasManyGetAssociationsMixinOptions {
+
+ /**
+ * An optional where clause to limit the associated models.
+ */
+ where?: WhereOptions;
+
+ /**
+ * Apply a scope on the related model, or remove its default scope by passing false.
+ */
+ scope?: string | boolean;
+ }
+
+ /**
+ * The getAssociations mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * getRoles: Sequelize.HasManyGetAssociationsMixin<RoleInstance>;
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyGetAssociationsMixin<TInstance> {
+ /**
+ * Get everything currently associated with this, using an optional where clause.
+ * @param options The options to use when getting the associations.
+ */
+ (options?: HasManyGetAssociationsMixinOptions): Promise<TInstance[]>
+ }
+
+ /**
+ * The options for the setAssociations mixin of the hasMany association.
+ * @see HasManySetAssociationsMixin
+ */
+ interface HasManySetAssociationsMixinOptions {
+
+ /**
+ * Run validation for the join model.
+ */
+ validate?: boolean;
+ }
+
+ /**
+ * The setAssociations mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * setRoles: Sequelize.HasManySetAssociationsMixin<RoleInstance, RoleId>;
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManySetAssociationsMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Set the associated models by passing an array of instances or their primary keys.
+ * Everything that it not in the passed array will be un-associated.
+ * @param newAssociations An array of instances or primary key of instances to associate with this. Pass null or undefined to remove all associations.
+ * @param options The options passed to `target.findAll` and `update`.
+ */
+ (
+ newAssociations?: Array<TInstance | TInstancePrimaryKey>,
+ options?: HasManySetAssociationsMixinOptions | FindOptions | InstanceUpdateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the addAssociations mixin of the hasMany association.
+ * @see HasManyAddAssociationsMixin
+ */
+ interface HasManyAddAssociationsMixinOptions {
+
+ /**
+ * Run validation for the join model.
+ */
+ validate?: boolean;
+ }
+
+ /**
+ * The addAssociations mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * addRoles: Sequelize.HasManyAddAssociationsMixin<RoleInstance, RoleId>;
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyAddAssociationsMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Associate several instances with this.
+ * @param newAssociations An array of instances or primary key of instances to associate with this.
+ * @param options The options passed to `target.update`.
+ */
+ (
+ newAssociations?: Array<TInstance | TInstancePrimaryKey>,
+ options?: HasManyAddAssociationsMixinOptions | InstanceUpdateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the addAssociation mixin of the hasMany association.
+ * @see HasManyAddAssociationMixin
+ */
+ interface HasManyAddAssociationMixinOptions {
+
+ /**
+ * Run validation for the join model.
+ */
+ validate?: boolean;
+ }
+
+ /**
+ * The addAssociation mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * addRole: Sequelize.HasManyAddAssociationMixin<RoleInstance, RoleId>;
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyAddAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Associate an instance with this.
+ * @param newAssociation An instance or the primary key of an instance to associate with this.
+ * @param options The options passed to `target.update`.
+ */
+ (
+ newAssociation?: TInstance | TInstancePrimaryKey,
+ options?: HasManyAddAssociationMixinOptions | InstanceUpdateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the createAssociation mixin of the hasMany association.
+ * @see HasManyCreateAssociationMixin
+ */
+ interface HasManyCreateAssociationMixinOptions { }
+
+ /**
+ * The createAssociation mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * createRole: Sequelize.HasManyCreateAssociationMixin<RoleAttributes>;
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyCreateAssociationMixin<TAttributes> {
+ /**
+ * Create a new instance of the associated model and associate it with this.
+ * @param values The values used to create the association.
+ * @param options The options to use when creating the association.
+ */
+ (
+ values?: TAttributes,
+ options?: HasManyCreateAssociationMixinOptions | CreateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the removeAssociation mixin of the hasMany association.
+ * @see HasManyRemoveAssociationMixin
+ */
+ interface HasManyRemoveAssociationMixinOptions { }
+
+ /**
+ * The removeAssociation mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * removeRole: Sequelize.HasManyRemoveAssociationMixin<RoleInstance, RoleId>;
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyRemoveAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Un-associate the instance.
+ * @param oldAssociated The instance or the primary key of the instance to un-associate.
+ * @param options The options passed to `target.update`.
+ */
+ (
+ oldAssociated?: TInstance | TInstancePrimaryKey,
+ options?: HasManyRemoveAssociationMixinOptions | InstanceUpdateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the removeAssociations mixin of the hasMany association.
+ * @see HasManyRemoveAssociationsMixin
+ */
+ interface HasManyRemoveAssociationsMixinOptions { }
+
+ /**
+ * The removeAssociations mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * removeRoles: Sequelize.HasManyRemoveAssociationsMixin<RoleInstance, RoleId>;
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyRemoveAssociationsMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Un-associate several instances.
+ * @param oldAssociated An array of instances or primary key of instances to un-associate.
+ * @param options The options passed to `target.update`.
+ */
+ (
+ oldAssociateds?: Array<TInstance | TInstancePrimaryKey>,
+ options?: HasManyRemoveAssociationsMixinOptions | InstanceUpdateOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the hasAssociation mixin of the hasMany association.
+ * @see HasManyHasAssociationMixin
+ */
+ interface HasManyHasAssociationMixinOptions { }
+
+ /**
+ * The hasAssociation mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * hasRole: Sequelize.HasManyHasAssociationMixin<RoleInstance, RoleId>;
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyHasAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Check if an instance is associated with this.
+ * @param target The instance or the primary key of the instance to check.
+ * @param options The options passed to `getAssociations`.
+ */
+ (
+ target: TInstance | TInstancePrimaryKey,
+ options?: HasManyHasAssociationMixinOptions | HasManyGetAssociationsMixinOptions
+ ): Promise<boolean>
+ }
+
+ /**
+ * The options for the hasAssociations mixin of the hasMany association.
+ * @see HasManyHasAssociationsMixin
+ */
+ interface HasManyHasAssociationsMixinOptions { }
+
+ /**
+ * The removeAssociations mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles
+ * // hasRole...
+ * hasRoles: Sequelize.HasManyHasAssociationsMixin<RoleInstance, RoleId>;
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyHasAssociationsMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Check if all instances are associated with this.
+ * @param targets An array of instances or primary key of instances to check.
+ * @param options The options passed to `getAssociations`.
+ */
+ (
+ targets: Array<TInstance | TInstancePrimaryKey>,
+ options?: HasManyHasAssociationsMixinOptions | HasManyGetAssociationsMixinOptions
+ ): Promise<boolean>
+ }
+
+ /**
+ * The options for the countAssociations mixin of the hasMany association.
+ * @see HasManyCountAssociationsMixin
+ */
+ interface HasManyCountAssociationsMixinOptions {
+
+ /**
+ * An optional where clause to limit the associated models.
+ */
+ where?: WhereOptions;
+
+ /**
+ * Apply a scope on the related model, or remove its default scope by passing false.
+ */
+ scope?: string | boolean;
+ }
+
+ /**
+ * The countAssociations mixin applied to models with hasMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.hasMany(Role);
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * countRoles: Sequelize.HasManyCountAssociationsMixin;
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/has-many/
+ * @see Instance
+ */
+ interface HasManyCountAssociationsMixin {
+ /**
+ * Count everything currently associated with this, using an optional where clause.
+ * @param options The options to use when counting the associations.
+ */
+ (options?: HasManyCountAssociationsMixinOptions): Promise<number>
+ }
+
+ /**
+ * The options for the getAssociations mixin of the belongsToMany association.
+ * @see BelongsToManyGetAssociationsMixin
+ */
+ interface BelongsToManyGetAssociationsMixinOptions {
+
+ /**
+ * An optional where clause to limit the associated models.
+ */
+ where?: WhereOptions;
+
+ /**
+ * Apply a scope on the related model, or remove its default scope by passing false.
+ */
+ scope?: string | boolean;
+ }
+
+ /**
+ * The getAssociations mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * getRoles: Sequelize.BelongsToManyGetAssociationsMixin<RoleInstance>;
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyGetAssociationsMixin<TInstance> {
+ /**
+ * Get everything currently associated with this, using an optional where clause.
+ * @param options The options to use when getting the associations.
+ */
+ (options?: BelongsToManyGetAssociationsMixinOptions): Promise<TInstance[]>
+ }
+
+ /**
+ * The options for the setAssociations mixin of the belongsToMany association.
+ * @see BelongsToManySetAssociationsMixin
+ */
+ interface BelongsToManySetAssociationsMixinOptions {
+
+ /**
+ * Run validation for the join model.
+ */
+ validate?: boolean;
+ }
+
+ /**
+ * The setAssociations mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * setRoles: Sequelize.BelongsToManySetAssociationsMixin<RoleInstance, RoleId, UserRoleAttributes>;
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManySetAssociationsMixin<TInstance, TInstancePrimaryKey, TJoinTableAttributes> {
+ /**
+ * Set the associated models by passing an array of instances or their primary keys.
+ * Everything that it not in the passed array will be un-associated.
+ * @param newAssociations An array of instances or primary key of instances to associate with this. Pass null or undefined to remove all associations.
+ * @param options The options passed to `through.findAll`, `bulkCreate`, `update` and `destroy`. Can also hold additional attributes for the join table.
+ */
+ (
+ newAssociations?: Array<TInstance | TInstancePrimaryKey>,
+ options?: BelongsToManySetAssociationsMixinOptions | FindOptions | BulkCreateOptions | InstanceUpdateOptions | InstanceDestroyOptions | TJoinTableAttributes
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the addAssociations mixin of the belongsToMany association.
+ * @see BelongsToManyAddAssociationsMixin
+ */
+ interface BelongsToManyAddAssociationsMixinOptions {
+
+ /**
+ * Run validation for the join model.
+ */
+ validate?: boolean;
+ }
+
+ /**
+ * The addAssociations mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * addRoles: Sequelize.BelongsToManyAddAssociationsMixin<RoleInstance, RoleId, UserRoleAttributes>;
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyAddAssociationsMixin<TInstance, TInstancePrimaryKey, TJoinTableAttributes> {
+ /**
+ * Associate several instances with this.
+ * @param newAssociations An array of instances or primary key of instances to associate with this.
+ * @param options The options passed to `through.findAll`, `bulkCreate`, `update` and `destroy`. Can also hold additional attributes for the join table.
+ */
+ (
+ newAssociations?: Array<TInstance | TInstancePrimaryKey>,
+ options?: BelongsToManyAddAssociationsMixinOptions | FindOptions | BulkCreateOptions | InstanceUpdateOptions | InstanceDestroyOptions | TJoinTableAttributes
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the addAssociation mixin of the belongsToMany association.
+ * @see BelongsToManyAddAssociationMixin
+ */
+ interface BelongsToManyAddAssociationMixinOptions {
+
+ /**
+ * Run validation for the join model.
+ */
+ validate?: boolean;
+ }
+
+ /**
+ * The addAssociation mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * addRole: Sequelize.BelongsToManyAddAssociationMixin<RoleInstance, RoleId, UserRoleAttributes>;
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyAddAssociationMixin<TInstance, TInstancePrimaryKey, TJoinTableAttributes> {
+ /**
+ * Associate an instance with this.
+ * @param newAssociation An instance or the primary key of an instance to associate with this.
+ * @param options The options passed to `through.findAll`, `bulkCreate`, `update` and `destroy`. Can also hold additional attributes for the join table.
+ */
+ (
+ newAssociation?: TInstance | TInstancePrimaryKey,
+ options?: BelongsToManyAddAssociationMixinOptions | FindOptions | BulkCreateOptions | InstanceUpdateOptions | InstanceDestroyOptions | TJoinTableAttributes
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the createAssociation mixin of the belongsToMany association.
+ * @see BelongsToManyCreateAssociationMixin
+ */
+ interface BelongsToManyCreateAssociationMixinOptions { }
+
+ /**
+ * The createAssociation mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * createRole: Sequelize.BelongsToManyCreateAssociationMixin<RoleAttributes, UserRoleAttributes>;
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyCreateAssociationMixin<TAttributes, TJoinTableAttributes> {
+ /**
+ * Create a new instance of the associated model and associate it with this.
+ * @param values The values used to create the association.
+ * @param options Options passed to `create` and `add`. Can also hold additional attributes for the join table.
+ */
+ (
+ values?: TAttributes,
+ options?: BelongsToManyCreateAssociationMixinOptions | CreateOptions | TJoinTableAttributes
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the removeAssociation mixin of the belongsToMany association.
+ * @see BelongsToManyRemoveAssociationMixin
+ */
+ interface BelongsToManyRemoveAssociationMixinOptions { }
+
+ /**
+ * The removeAssociation mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * removeRole: Sequelize.BelongsToManyRemoveAssociationMixin<RoleInstance, RoleId>;
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyRemoveAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Un-associate the instance.
+ * @param oldAssociated The instance or the primary key of the instance to un-associate.
+ * @param options The options passed to `through.destroy`.
+ */
+ (
+ oldAssociated?: TInstance | TInstancePrimaryKey,
+ options?: BelongsToManyRemoveAssociationMixinOptions | InstanceDestroyOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the removeAssociations mixin of the belongsToMany association.
+ * @see BelongsToManyRemoveAssociationsMixin
+ */
+ interface BelongsToManyRemoveAssociationsMixinOptions { }
+
+ /**
+ * The removeAssociations mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * removeRoles: Sequelize.BelongsToManyRemoveAssociationsMixin<RoleInstance, RoleId>;
+ * // hasRole...
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyRemoveAssociationsMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Un-associate several instances.
+ * @param oldAssociated An array of instances or primary key of instances to un-associate.
+ * @param options The options passed to `through.destroy`.
+ */
+ (
+ oldAssociateds?: Array<TInstance | TInstancePrimaryKey>,
+ options?: BelongsToManyRemoveAssociationsMixinOptions | InstanceDestroyOptions
+ ): Promise<void>
+ }
+
+ /**
+ * The options for the hasAssociation mixin of the belongsToMany association.
+ * @see BelongsToManyHasAssociationMixin
+ */
+ interface BelongsToManyHasAssociationMixinOptions { }
+
+ /**
+ * The hasAssociation mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * hasRole: Sequelize.BelongsToManyHasAssociationMixin<RoleInstance, RoleId>;
+ * // hasRoles...
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyHasAssociationMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Check if an instance is associated with this.
+ * @param target The instance or the primary key of the instance to check.
+ * @param options The options passed to `getAssociations`.
+ */
+ (
+ target: TInstance | TInstancePrimaryKey,
+ options?: BelongsToManyHasAssociationMixinOptions | BelongsToManyGetAssociationsMixinOptions
+ ): Promise<boolean>
+ }
+
+ /**
+ * The options for the hasAssociations mixin of the belongsToMany association.
+ * @see BelongsToManyHasAssociationsMixin
+ */
+ interface BelongsToManyHasAssociationsMixinOptions { }
+
+ /**
+ * The removeAssociations mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles
+ * // hasRole...
+ * hasRoles: Sequelize.BelongsToManyHasAssociationsMixin<RoleInstance, RoleId>;
+ * // countRoles...
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyHasAssociationsMixin<TInstance, TInstancePrimaryKey> {
+ /**
+ * Check if all instances are associated with this.
+ * @param targets An array of instances or primary key of instances to check.
+ * @param options The options passed to `getAssociations`.
+ */
+ (
+ targets: Array<TInstance | TInstancePrimaryKey>,
+ options?: BelongsToManyHasAssociationsMixinOptions | BelongsToManyGetAssociationsMixinOptions
+ ): Promise<boolean>
+ }
+
+ /**
+ * The options for the countAssociations mixin of the belongsToMany association.
+ * @see BelongsToManyCountAssociationsMixin
+ */
+ interface BelongsToManyCountAssociationsMixinOptions {
+
+ /**
+ * An optional where clause to limit the associated models.
+ */
+ where?: WhereOptions;
+
+ /**
+ * Apply a scope on the related model, or remove its default scope by passing false.
+ */
+ scope?: string | boolean;
+ }
+
+ /**
+ * The countAssociations mixin applied to models with belongsToMany.
+ * An example of usage is as follows:
+ *
+ * ```js
+ *
+ * User.belongsToMany(Role, { through: UserRole });
+ *
+ * interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
+ * // getRoles...
+ * // setRoles...
+ * // addRoles...
+ * // addRole...
+ * // createRole...
+ * // removeRole...
+ * // removeRoles...
+ * // hasRole...
+ * // hasRoles...
+ * countRoles: Sequelize.BelongsToManyCountAssociationsMixin;
+ * }
+ * ```
+ *
+ * @see http://docs.sequelizejs.com/en/latest/api/associations/belongs-to-many/
+ * @see Instance
+ */
+ interface BelongsToManyCountAssociationsMixin {
+ /**
+ * Count everything currently associated with this, using an optional where clause.
+ * @param options The options to use when counting the associations.
+ */
+ (options?: BelongsToManyCountAssociationsMixinOptions): Promise<number>
+ }
/**
* Foreign Key Options
diff --git a/sharepoint/SharePoint.d.ts.tscparams b/sharepoint/SharePoint.d.ts.tscparams
deleted file mode 100644
index ac975cac60..0000000000
--- a/sharepoint/SharePoint.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
---noImplicitAny
\ No newline at end of file
diff --git a/sigmajs/sigmajs-tests.ts b/sigmajs/sigmajs-tests.ts
index f28a9395bd..1fdcdb27e5 100644
--- a/sigmajs/sigmajs-tests.ts
+++ b/sigmajs/sigmajs-tests.ts
@@ -26,6 +26,10 @@ module SigmaJsTests {
sigma.canvas.edges['def'] = function() {};
sigma.svg.nodes['def'] = {create: (obj: SigmaJs.Node) => { return new Element(); },
update: (obj: SigmaJs.Node) => { return; }};
+ sigma.svg.edges['def'] = {create: (obj: SigmaJs.Edge) => { return new Element(); },
+ update: (obj: SigmaJs.Edge) => { return; }};
+ sigma.svg.edges.labels['def'] = {create: (obj: SigmaJs.Edge) => { return new Element(); },
+ update: (obj: SigmaJs.Edge) => { return; }};
var N = 100;
var E = 500;
diff --git a/sigmajs/sigmajs.d.ts b/sigmajs/sigmajs.d.ts
index d1c19730cf..70bd2ff86c 100644
--- a/sigmajs/sigmajs.d.ts
+++ b/sigmajs/sigmajs.d.ts
@@ -287,11 +287,18 @@ declare module SigmaJs{
}
interface SVG {
- edges: {[renderType: string]: SVGObject<SigmaJs.Edge>};
+ edges: {
+ labels: SVGEdgeLabels;
+ [renderType: string]: SVGObject<SigmaJs.Edge> | SVGEdgeLabels;
+ };
labels: {[renderType: string]: SVGObject<SigmaJs.Node>};
nodes: {[renderType: string]: SVGObject<SigmaJs.Node>};
}
+ interface SVGEdgeLabels {
+ [renderType: string]: SVGObject<SigmaJs.Edge>;
+ }
+
interface SVGObject<T> {
create: (object: T, ...a:any[]) => Element;
update: (object: T, ...a:any[]) => void;
diff --git a/signalr/signalr.d.ts b/signalr/signalr.d.ts
index aa17d1e579..e890c8f425 100644
--- a/signalr/signalr.d.ts
+++ b/signalr/signalr.d.ts
@@ -90,6 +90,7 @@ interface HubConnectionSettings {
interface HubConnection extends SignalR {
//(url?: string, queryString?: any, logging?: boolean): HubConnection;
proxies: any;
+ transport: { name: string, supportsKeepAlive: () => boolean };
received(callback: (data: { Id: any; Method: any; Hub: any; State: any; Args: any; }) => void ): HubConnection;
createHubProxy(hubName: string): HubProxy;
}
diff --git a/simplebar/simplebar-tests.ts b/simplebar/simplebar-tests.ts
old mode 100755
new mode 100644
index abf906a089..033b16c741
--- a/simplebar/simplebar-tests.ts
+++ b/simplebar/simplebar-tests.ts
@@ -1,5 +1,5 @@
-/// <reference path="simplebar.d.ts"/>
-/// <reference path="../jquery/jquery.d.ts"/>
-
-var simplebar = $.fn.simplebar.noConflict();
-$.fn.simplebar = simplebar;
+/// <reference path="simplebar.d.ts"/>
+/// <reference path="../jquery/jquery.d.ts"/>
+
+var simplebar = $.fn.simplebar.noConflict();
+$.fn.simplebar = simplebar;
diff --git a/simplebar/simplebar.d.ts b/simplebar/simplebar.d.ts
old mode 100755
new mode 100644
index bab795e1ae..d9ef0a45d3
--- a/simplebar/simplebar.d.ts
+++ b/simplebar/simplebar.d.ts
@@ -1,37 +1,37 @@
-// Type definitions for simplebar.js 1.1.7
-// Project: https://github.com/Grsmto/simplebar
-// Definitions by: Gregor Woiwode <https://github.com/gregonnet>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-interface SimplebarOptions {
- autoHide?: boolean;
- wrapContent?: boolean;
-}
-
-interface JQuery {
- /**
- * Enables simplebar on calling element.
- */
- simplebar: {
- /**
- * Define if scrollbar should be faded out automatically
- *
- * @param indicator if scrollbar should be faded out automatically.
- */
- (options?: SimplebarOptions): JQuery;
- };
-}
-
-interface JQueryStatic {
- /**
- * Enables simplebar on calling element.
- */
- simplebar: {
- /**
- * Define if scrollbar should be faded out automatically
- *
- * @param indicator if scrollbar should be faded out automatically.
- */
- (options?: SimplebarOptions): JQuery;
- };
-}
+// Type definitions for simplebar.js 1.1.7
+// Project: https://github.com/Grsmto/simplebar
+// Definitions by: Gregor Woiwode <https://github.com/gregonnet>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+interface SimplebarOptions {
+ autoHide?: boolean;
+ wrapContent?: boolean;
+}
+
+interface JQuery {
+ /**
+ * Enables simplebar on calling element.
+ */
+ simplebar: {
+ /**
+ * Define if scrollbar should be faded out automatically
+ *
+ * @param indicator if scrollbar should be faded out automatically.
+ */
+ (options?: SimplebarOptions): JQuery;
+ };
+}
+
+interface JQueryStatic {
+ /**
+ * Enables simplebar on calling element.
+ */
+ simplebar: {
+ /**
+ * Define if scrollbar should be faded out automatically
+ *
+ * @param indicator if scrollbar should be faded out automatically.
+ */
+ (options?: SimplebarOptions): JQuery;
+ };
+}
diff --git a/simplestorage.js/simplestorage.js-tests.ts b/simplestorage.js/simplestorage.js-tests.ts
new file mode 100644
index 0000000000..1e9f4202a3
--- /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 0000000000..bda285aac9
--- /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/sinon/sinon.d.ts b/sinon/sinon.d.ts
index fec30d70dc..4e23ee650e 100644
--- a/sinon/sinon.d.ts
+++ b/sinon/sinon.d.ts
@@ -92,6 +92,7 @@ declare module Sinon {
resetBehavior(): void;
returns(obj: any): SinonStub;
returnsArg(index: number): SinonStub;
+ returnsThis(): SinonStub;
throws(type?: string): SinonStub;
throws(obj: any): SinonStub;
callsArg(index: number): SinonStub;
diff --git a/sipml/sipml-test.ts b/sipml/sipml-tests.ts
similarity index 99%
rename from sipml/sipml-test.ts
rename to sipml/sipml-tests.ts
index 5fed26fc63..a10c868d42 100644
--- a/sipml/sipml-test.ts
+++ b/sipml/sipml-tests.ts
@@ -110,7 +110,7 @@ var eventsListener = (e:any)=>{
var publishPresence = ()=>{
publishSession = <SIPml.Session.Publish>sipStack.newSession('publish', {
events_listener: { events: '*', listener: eventsListener } // optional: '*' means all events
- });
+ });
var contentType = 'application/pidf+xml';
var content = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n' +
'<presence xmlns=\"urn:ietf:params:xml:ns:pidf\"\n' +
diff --git a/sipml/sipml.d.ts b/sipml/sipml.d.ts
index b6c77d8983..0e3df6873e 100644
--- a/sipml/sipml.d.ts
+++ b/sipml/sipml.d.ts
@@ -1,252 +1,252 @@
-// Type definitions for SIPml5
-// Project: http://sipml5.org/
-// Definitions by: A. Groenenboom <https://github.com/chookies>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-declare namespace SIPml {
- class Event {
- public description: string;
- public type: string;
-
- public getContent(): Object;
- public getContentString(): string;
- public getContentType(): Object;
- public getSipResponseCode(): number;
- }
-
- class EventTarget<EventSubscriptionType extends string, EventType extends Event> {
- public addEventListener(type: EventSubscriptionType, listener: (e: EventType) => void): void;
- public removeEventListener(type: EventSubscriptionType): void;
- }
-
- class Session extends EventTarget<Session.EventSubscriptionType, Session.Event> {
- public accept(configuration?: Session.Configuration): number;
- public getId(): number;
- public getRemoteFriendlyName(): string;
- public getRemoteUri(): string;
- public reject(configuration?: Session.Configuration): number;
- public setConfiguration(configuration?: Session.Configuration): void;
- }
-
- export namespace Session {
- /**
- * Should be
- *
- * "*" |
- * "connecting" |
- * "connected" |
- * "terminating" |
- * "terminated" |
- * "i_ao_request" |
- * "media_added" |
- * "media_removed" |
- * "i_request" |
- * "o_request" |
- * "cancelled_request" |
- * "sent_request" |
- * "transport_error" |
- * "global_error" |
- * "message_error" |
- * "webrtc_error" |
- */
- type EventSubscriptionType = string;
-
- interface Configuration {
- audio_remote?: HTMLElement;
- bandwidth?: { audio: number; video: number; };
- events_listener?: {
- events: EventSubscriptionType | EventSubscriptionType[];
- listener: (e: Session.Event) => void
- };
- expires?: number;
- from?: string;
- sip_caps?: Object[];
- sip_headers?: Object[];
- video_local?: HTMLElement;
- video_remote?: HTMLElement;
- video_size?: {
- minWidth?: number;
- maxWidth?: number;
- minHeight?: number;
- maxHeight?: number;
- };
- }
-
- class Call extends Session implements EventTarget<Call.EventSubscriptionType, Session.Event> {
- public acceptTransfer(configuration?: Session.Configuration): number;
- public call(to: string, configuration?: Session.Configuration): number;
- public dtmf(): number;
- public hangup(configuration?: Session.Configuration): number;
- public hold(configuration?: Session.Configuration): number;
- public info(): number;
- public rejectTransfer(): number;
- public resume(): number;
- public transfer(): number;
- }
-
- namespace Call {
- /**
- * Should be
- *
- * Session.EventSubscriptionType |
- * "m_early_media" |
- * "m_local_hold_ok" |
- * "m_local_hold_nok" |
- * "m_local_resume_ok" |
- * "m_local_resume_nok" |
- * "m_remote_hold" |
- * "m_remote_resume" |
- * "m_stream_video_local_added" |
- * "m_stream_video_local_removed" |
- * "m_stream_video_remote_added" |
- * "m_stream_video_remote_removed" |
- * "m_stream_audio_local_added" |
- * "m_stream_audio_local_removed" |
- * "m_stream_audio_remote_added" |
- * "m_stream_audio_remote_removed" |
- * "i_ect_new_call" |
- * "o_ect_trying" |
- * "o_ect_accepted" |
- * "o_ect_completed" |
- * "i_ect_completed" |
- * "o_ect_failed" |
- * "i_ect_failed" |
- * "o_ect_notify" |
- * "i_ect_notify" |
- * "i_ect_requested " |
- * "m_bfcp_info" |
- * "i_info" |
- */
- type EventSubscriptionType = Session.EventSubscriptionType;
- }
-
- class Event extends SIPml.Event {
- public session: Session;
-
- public getTransferDestinationFriendlyName(): string;
- }
-
- class Message extends Session {
- public send(to: string, content?: any, contentType?: string, configuration?: Session.Configuration): number;
- }
-
- class Publish extends Session {
- public publish(content?: any, contentType?: string, configuration?: Session.Configuration): number;
-
- public unpublish(configuration?: Session.Configuration): void;
- }
-
- class Registration extends Session {
- public register(configuration?: Session.Configuration): void;
- public unregister(configuration?: Session.Configuration): void;
- }
-
- class Subscribe extends Session implements EventTarget<Subscribe.EventSubscriptionType, Session.Event> {
- public subscribe(to: string, configuration?: Session.Configuration): number;
- public unsubscribe(configuration?: Session.Configuration): number;
- }
-
- namespace Subscribe {
- /**
- * Should be
- *
- * Session.EventSubscriptionType | "i_notify"
- */
- type EventSubscriptionType = Session.EventSubscriptionType;
- }
- }
-
- class Stack extends EventTarget<Stack.EventSubscriptionType, Stack.Event> {
- public constructor(configuration?: Stack.Configuration);
- public setConfiguration(configuration: Stack.Configuration): number;
- public newSession(type: string, configuration?: Session.Configuration): any;
- public start(): number;
- public stop(timeout?: number): number;
- }
-
- export namespace Stack {
- /**
- * Should be
- *
- * "*" |
- * "starting" |
- * "started" |
- * "stopping" |
- * "stopped" |
- * "failed_to_start" |
- * "failed_to_stop" |
- * "i_new_call" |
- * "i_new_message" |
- * "m_permission_requested" |
- * "m_permission_accepted" |
- * "m_permission_refused";
- */
- type EventSubscriptionType = string;
-
- interface Configuration {
- bandwidth?: { audio: number; video: number; };
- display_name?: string;
- enable_click2call?: boolean;
- enable_early_ims?: boolean;
- enable_media_stream_cache?: boolean;
- enable_rtcweb_breaker?: boolean;
- events_listener?: {
- events: EventSubscriptionType | EventSubscriptionType[];
- listener: (e: Stack.Event) => void
- };
- ice_servers?: Object[];
- impi?: string;
- impu?: string;
- outbound_proxy_url?: string;
- password?: string;
- realm?: string;
- sip_headers?: Object[];
- video_size?: {
- minWidth?: number;
- maxWidth?: number;
- minHeight?: number;
- maxHeight?: number;
- };
- websocket_proxy_url?: string;
- }
-
- class Event extends SIPml.Event {
- public description: string;
- public newSession: Session;
- public type: string;
- }
- }
-
- function getNavigatorFriendlyName(): string;
-
- function getNavigatorVersion(): string;
-
- function getSystemFriendlyName(): string;
-
- function getWebRtc4AllVersion(): string;
-
- function haveMediaStream(): boolean;
-
- function init(readyCallback?: (e:any) => any, errorCallback?: (e:any) => any): boolean;
-
- function isInitialized(): boolean;
-
- function isNavigatorOutdated(): boolean;
-
- function isReady(): boolean;
-
- function isScreenShareSupported(): boolean;
-
- function isWebRtcPluginOutdated(): boolean;
-
- function isWebRtc4AllSupported(): boolean;
-
- function isWebRtcSupported(): boolean;
-
- function isWebSocketSupported(): boolean;
-
- function setDebugLevel(level: string): void;
-
- function setWebRtcType(type: string): boolean;
-}
-
+// Type definitions for SIPml5
+// Project: http://sipml5.org/
+// Definitions by: A. Groenenboom <https://github.com/chookies>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare namespace SIPml {
+ class Event {
+ public description: string;
+ public type: string;
+
+ public getContent(): Object;
+ public getContentString(): string;
+ public getContentType(): Object;
+ public getSipResponseCode(): number;
+ }
+
+ class EventTarget<EventSubscriptionType extends string, EventType extends Event> {
+ public addEventListener(type: EventSubscriptionType, listener: (e: EventType) => void): void;
+ public removeEventListener(type: EventSubscriptionType): void;
+ }
+
+ class Session extends EventTarget<Session.EventSubscriptionType, Session.Event> {
+ public accept(configuration?: Session.Configuration): number;
+ public getId(): number;
+ public getRemoteFriendlyName(): string;
+ public getRemoteUri(): string;
+ public reject(configuration?: Session.Configuration): number;
+ public setConfiguration(configuration?: Session.Configuration): void;
+ }
+
+ export namespace Session {
+ /**
+ * Should be
+ *
+ * "*" |
+ * "connecting" |
+ * "connected" |
+ * "terminating" |
+ * "terminated" |
+ * "i_ao_request" |
+ * "media_added" |
+ * "media_removed" |
+ * "i_request" |
+ * "o_request" |
+ * "cancelled_request" |
+ * "sent_request" |
+ * "transport_error" |
+ * "global_error" |
+ * "message_error" |
+ * "webrtc_error" |
+ */
+ type EventSubscriptionType = string;
+
+ interface Configuration {
+ audio_remote?: HTMLElement;
+ bandwidth?: { audio: number; video: number; };
+ events_listener?: {
+ events: EventSubscriptionType | EventSubscriptionType[];
+ listener: (e: Session.Event) => void
+ };
+ expires?: number;
+ from?: string;
+ sip_caps?: Object[];
+ sip_headers?: Object[];
+ video_local?: HTMLElement;
+ video_remote?: HTMLElement;
+ video_size?: {
+ minWidth?: number;
+ maxWidth?: number;
+ minHeight?: number;
+ maxHeight?: number;
+ };
+ }
+
+ class Call extends Session implements EventTarget<Call.EventSubscriptionType, Session.Event> {
+ public acceptTransfer(configuration?: Session.Configuration): number;
+ public call(to: string, configuration?: Session.Configuration): number;
+ public dtmf(): number;
+ public hangup(configuration?: Session.Configuration): number;
+ public hold(configuration?: Session.Configuration): number;
+ public info(): number;
+ public rejectTransfer(): number;
+ public resume(): number;
+ public transfer(): number;
+ }
+
+ namespace Call {
+ /**
+ * Should be
+ *
+ * Session.EventSubscriptionType |
+ * "m_early_media" |
+ * "m_local_hold_ok" |
+ * "m_local_hold_nok" |
+ * "m_local_resume_ok" |
+ * "m_local_resume_nok" |
+ * "m_remote_hold" |
+ * "m_remote_resume" |
+ * "m_stream_video_local_added" |
+ * "m_stream_video_local_removed" |
+ * "m_stream_video_remote_added" |
+ * "m_stream_video_remote_removed" |
+ * "m_stream_audio_local_added" |
+ * "m_stream_audio_local_removed" |
+ * "m_stream_audio_remote_added" |
+ * "m_stream_audio_remote_removed" |
+ * "i_ect_new_call" |
+ * "o_ect_trying" |
+ * "o_ect_accepted" |
+ * "o_ect_completed" |
+ * "i_ect_completed" |
+ * "o_ect_failed" |
+ * "i_ect_failed" |
+ * "o_ect_notify" |
+ * "i_ect_notify" |
+ * "i_ect_requested " |
+ * "m_bfcp_info" |
+ * "i_info" |
+ */
+ type EventSubscriptionType = Session.EventSubscriptionType;
+ }
+
+ class Event extends SIPml.Event {
+ public session: Session;
+
+ public getTransferDestinationFriendlyName(): string;
+ }
+
+ class Message extends Session {
+ public send(to: string, content?: any, contentType?: string, configuration?: Session.Configuration): number;
+ }
+
+ class Publish extends Session {
+ public publish(content?: any, contentType?: string, configuration?: Session.Configuration): number;
+
+ public unpublish(configuration?: Session.Configuration): void;
+ }
+
+ class Registration extends Session {
+ public register(configuration?: Session.Configuration): void;
+ public unregister(configuration?: Session.Configuration): void;
+ }
+
+ class Subscribe extends Session implements EventTarget<Subscribe.EventSubscriptionType, Session.Event> {
+ public subscribe(to: string, configuration?: Session.Configuration): number;
+ public unsubscribe(configuration?: Session.Configuration): number;
+ }
+
+ namespace Subscribe {
+ /**
+ * Should be
+ *
+ * Session.EventSubscriptionType | "i_notify"
+ */
+ type EventSubscriptionType = Session.EventSubscriptionType;
+ }
+ }
+
+ class Stack extends EventTarget<Stack.EventSubscriptionType, Stack.Event> {
+ public constructor(configuration?: Stack.Configuration);
+ public setConfiguration(configuration: Stack.Configuration): number;
+ public newSession(type: string, configuration?: Session.Configuration): any;
+ public start(): number;
+ public stop(timeout?: number): number;
+ }
+
+ export namespace Stack {
+ /**
+ * Should be
+ *
+ * "*" |
+ * "starting" |
+ * "started" |
+ * "stopping" |
+ * "stopped" |
+ * "failed_to_start" |
+ * "failed_to_stop" |
+ * "i_new_call" |
+ * "i_new_message" |
+ * "m_permission_requested" |
+ * "m_permission_accepted" |
+ * "m_permission_refused";
+ */
+ type EventSubscriptionType = string;
+
+ interface Configuration {
+ bandwidth?: { audio: number; video: number; };
+ display_name?: string;
+ enable_click2call?: boolean;
+ enable_early_ims?: boolean;
+ enable_media_stream_cache?: boolean;
+ enable_rtcweb_breaker?: boolean;
+ events_listener?: {
+ events: EventSubscriptionType | EventSubscriptionType[];
+ listener: (e: Stack.Event) => void
+ };
+ ice_servers?: Object[];
+ impi?: string;
+ impu?: string;
+ outbound_proxy_url?: string;
+ password?: string;
+ realm?: string;
+ sip_headers?: Object[];
+ video_size?: {
+ minWidth?: number;
+ maxWidth?: number;
+ minHeight?: number;
+ maxHeight?: number;
+ };
+ websocket_proxy_url?: string;
+ }
+
+ class Event extends SIPml.Event {
+ public description: string;
+ public newSession: Session;
+ public type: string;
+ }
+ }
+
+ function getNavigatorFriendlyName(): string;
+
+ function getNavigatorVersion(): string;
+
+ function getSystemFriendlyName(): string;
+
+ function getWebRtc4AllVersion(): string;
+
+ function haveMediaStream(): boolean;
+
+ function init(readyCallback?: (e:any) => any, errorCallback?: (e:any) => any): boolean;
+
+ function isInitialized(): boolean;
+
+ function isNavigatorOutdated(): boolean;
+
+ function isReady(): boolean;
+
+ function isScreenShareSupported(): boolean;
+
+ function isWebRtcPluginOutdated(): boolean;
+
+ function isWebRtc4AllSupported(): boolean;
+
+ function isWebRtcSupported(): boolean;
+
+ function isWebSocketSupported(): boolean;
+
+ function setDebugLevel(level: string): void;
+
+ function setWebRtcType(type: string): boolean;
+}
+
diff --git a/socket.io-client/socket.io-client-tests.ts b/socket.io-client/socket.io-client-tests.ts
index 215932c460..cd9be6d3d9 100644
--- a/socket.io-client/socket.io-client-tests.ts
+++ b/socket.io-client/socket.io-client-tests.ts
@@ -55,3 +55,7 @@ function testUsingItJustAsACrossBrowserWebSocket() {
});
});
}
+
+function testSettingReconnectionAttempts() {
+ var manager = io.Manager({ reconnection: true, timeout: 0, reconnectionAttempts: 2, reconnectionDelay: 10 });
+}
diff --git a/socket.io-client/socket.io-client.d.ts b/socket.io-client/socket.io-client.d.ts
index 9f93c1f16c..32f51aea49 100644
--- a/socket.io-client/socket.io-client.d.ts
+++ b/socket.io-client/socket.io-client.d.ts
@@ -458,7 +458,7 @@ declare module SocketIOClient {
* How many reconnection attempts should we try?
* @default Infinity
*/
- reconnectionAttempts?: boolean;
+ reconnectionAttempts?: number;
/**
* The time delay in milliseconds between reconnection attempts
diff --git a/sortablejs/sortablejs-tests.ts b/sortablejs/sortablejs-tests.ts
new file mode 100755
index 0000000000..56b8b0a32a
--- /dev/null
+++ b/sortablejs/sortablejs-tests.ts
@@ -0,0 +1,299 @@
+// Examples from project repo used for tests.
+
+/// <reference path="sortablejs.d.ts" />
+
+var simpleList = document.getElementById('list');
+var list = simpleList;
+var el = document.getElementById('el');
+var sortable = new Sortable(simpleList, {});
+var order = sortable.toArray();
+var angular: any;
+var Ply: any;
+
+sortable.sort(order.reverse());
+
+Sortable.create(list, {
+ delay: 500,
+ chosenClass: "chosen"
+});
+
+Sortable.create(el, {
+ handle: ".my-handle"
+});
+
+Sortable.create(list, {
+ filter: ".js-remove, .js-edit",
+ onFilter: function(event) {
+ var item = event.item,
+ control = event.target;
+
+ if (Sortable.utils.is(control, ".js-remove")) {
+ item.parentNode.removeChild(item);
+ }
+ else if (Sortable.utils.is(control, ".js-edit")) {
+ // ..
+ }
+ }
+});
+
+Sortable.create(el, {
+ group: "localStorage-example",
+ store: {
+ get: function(sortable) {
+ var order = localStorage.getItem(sortable.options.group);
+
+ return order ? order.split('|') : [];
+ },
+ set: function(sortable) {
+ var order = sortable.toArray();
+
+ localStorage.setItem(sortable.options.group, order.join('|'));
+ }
+ }
+});
+
+Sortable.create(simpleList, {
+ forceFallback: true
+});
+
+Sortable.create(simpleList, {
+ ghostClass: 'ghost'
+});
+
+simpleList.innerHTML = Array.apply(null, new Array(100)).map(function(value: any, iterator: number) {
+ return `<div class="list-group-item">item ${iterator + 1}</div>`;
+}).join('');
+
+Sortable.create(simpleList, {
+ delay: 500,
+ chosenClass: 'chosen'
+});
+
+simpleList.innerHTML = Array.apply(null, new Array(10)).map(function(value: any, iterator: number) {
+ return '<div class="list-group-item">item ' +
+ (iterator + 1) +
+ '</div>';
+}).join('');
+
+Sortable.create(simpleList, {});
+
+simpleList.innerHTML = Array.apply(null, new Array(100)).map(function(value: any, iterator: number) {
+ return '<div class="list-group-item">item ' +
+ (iterator + 1) +
+ '</div>';
+}).join('');
+
+(function() {
+ 'use strict';
+
+ var byId = function(id: string) { return document.getElementById(id); },
+
+ loadScripts = function(desc: any, callback: any) {
+ var deps: string[] = [];
+ var key: string;
+ var idx = 0;
+
+ for (key in desc) {
+ deps.push(key);
+ }
+
+ (function _next() {
+ var pid: number,
+ name = deps[idx],
+ script = document.createElement('script');
+
+ script.type = 'text/javascript';
+ script.src = desc[deps[idx]];
+
+ document.getElementsByTagName('head')[0].appendChild(script);
+ })()
+ },
+
+ console = window.console;
+
+
+ if (!console.log) {
+ console.log = function() {
+ alert([].join.apply(arguments, ' '));
+ };
+ }
+
+
+ Sortable.create(byId('foo'), {
+ group: "words",
+ animation: 150,
+ store: {
+ get: function(sortable) {
+ var order = localStorage.getItem(sortable.options.group);
+ return order ? order.split('|') : [];
+ },
+ set: function(sortable) {
+ var order = sortable.toArray();
+ localStorage.setItem(sortable.options.group, order.join('|'));
+ }
+ },
+ onAdd: function(evt) { console.log('onAdd.foo:', [evt.item, evt.from]); },
+ onUpdate: function(evt) { console.log('onUpdate.foo:', [evt.item, evt.from]); },
+ onRemove: function(evt) { console.log('onRemove.foo:', [evt.item, evt.from]); },
+ onStart: function(evt) { console.log('onStart.foo:', [evt.item, evt.from]); },
+ onSort: function(evt) { console.log('onStart.foo:', [evt.item, evt.from]); },
+ onEnd: function(evt) { console.log('onEnd.foo:', [evt.item, evt.from]); }
+ });
+
+
+ Sortable.create(byId('bar'), {
+ group: "words",
+ animation: 150,
+ onAdd: function(evt) { console.log('onAdd.bar:', evt.item); },
+ onUpdate: function(evt) { console.log('onUpdate.bar:', evt.item); },
+ onRemove: function(evt) { console.log('onRemove.bar:', evt.item); },
+ onStart: function(evt) { console.log('onStart.foo:', evt.item); },
+ onEnd: function(evt) { console.log('onEnd.foo:', evt.item); }
+ });
+
+
+ // Multi groups
+ Sortable.create(byId('multi'), {
+ animation: 150,
+ draggable: '.tile',
+ handle: '.tile__name'
+ });
+
+ [].forEach.call(byId('multi').getElementsByClassName('tile__list'), function(el: any) {
+ Sortable.create(el, {
+ group: 'photo',
+ animation: 150
+ });
+ });
+
+
+ // Editable list
+ var editableList = Sortable.create(byId('editable'), {
+ animation: 150,
+ filter: '.js-remove',
+ onFilter: function(evt) {
+ evt.item.parentNode.removeChild(evt.item);
+ }
+ });
+
+
+ byId('addUser').onclick = function() {
+ Ply.dialog('prompt', {
+ title: 'Add',
+ form: { name: 'name' }
+ }).done(function(ui: any) {
+ var el = document.createElement('li');
+ el.innerHTML = ui.data.name + '<i class="js-remove">✖</i>';
+ editableList.el.appendChild(el);
+ });
+ };
+
+
+ // Advanced groups
+ [{
+ name: 'advanced',
+ pull: true,
+ put: true
+ },
+ {
+ name: 'advanced',
+ pull: 'clone',
+ put: false
+ }, {
+ name: 'advanced',
+ pull: false,
+ put: true
+ }].forEach(function(groupOpts, i) {
+ Sortable.create(byId('advanced-' + (i + 1)), {
+ sort: (i != 1),
+ group: groupOpts,
+ animation: 150
+ });
+ });
+
+
+ // 'handle' option
+ Sortable.create(byId('handle-1'), {
+ handle: '.drag-handle',
+ animation: 150
+ });
+
+
+ // Angular example
+ angular.module('todoApp', ['ng-sortable'])
+ .constant('ngSortableConfig', {
+ onEnd: function() {
+ console.log('default onEnd()');
+ }
+ })
+ .controller('TodoController', ['$scope', function($scope: any) {
+ $scope.todos = [
+ { text: 'learn angular', done: true },
+ { text: 'build an angular app', done: false }
+ ];
+
+ $scope.addTodo = function() {
+ $scope.todos.push({ text: $scope.todoText, done: false });
+ $scope.todoText = '';
+ };
+
+ $scope.remaining = function() {
+ var count = 0;
+ angular.forEach($scope.todos, function(todo: any) {
+ count += todo.done ? 0 : 1;
+ });
+ return count;
+ };
+
+ $scope.archive = function() {
+ var oldTodos = $scope.todos;
+ $scope.todos = [];
+ angular.forEach(oldTodos, function(todo: any) {
+ if (!todo.done) $scope.todos.push(todo);
+ });
+ };
+ }])
+ .controller('TodoControllerNext', ['$scope', function($scope: any) {
+ $scope.todos = [
+ { text: 'learn Sortable', done: true },
+ { text: 'use ng-sortable', done: false },
+ { text: 'Enjoy', done: false }
+ ];
+
+ $scope.remaining = function() {
+ var count = 0;
+ angular.forEach($scope.todos, function(todo: any) {
+ count += todo.done ? 0 : 1;
+ });
+ return count;
+ };
+
+ $scope.sortableConfig = { group: 'todo', animation: 150 };
+ 'Start End Add Update Remove Sort'.split(' ').forEach(function(name: string) {
+ $scope.sortableConfig['on' + name] = console.log.bind(console, name);
+ });
+ }]);
+})();
+
+// Background
+document.addEventListener("DOMContentLoaded", function() {
+ function setNoiseBackground(el: any, width: number, height: number, opacity: number) {
+ var canvas = document.createElement("canvas");
+ var context = canvas.getContext("2d");
+
+ canvas.width = width;
+ canvas.height = height;
+
+ for (var i = 0; i < width; i++) {
+ for (var j = 0; j < height; j++) {
+ var val = Math.floor(Math.random() * 255);
+ context.fillStyle = "rgba(" + val + "," + val + "," + val + "," + opacity + ")";
+ context.fillRect(i, j, 1, 1);
+ }
+ }
+
+ el.style.background = "url(" + canvas.toDataURL("image/png") + ")";
+ }
+
+ setNoiseBackground(document.getElementsByTagName('body')[0], 50, 50, 0.02);
+}, false);
diff --git a/sortablejs/sortablejs.d.ts b/sortablejs/sortablejs.d.ts
new file mode 100755
index 0000000000..a471a4e694
--- /dev/null
+++ b/sortablejs/sortablejs.d.ts
@@ -0,0 +1,208 @@
+// Type definitions for Sortable.js v1.3.0-rc1
+// Project: https://github.com/RubaXa/Sortable
+// Definitions by: Maw-Fox <github.com/Maw-Fox>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module Sortablejs {
+ interface SortableOptions {
+ group?: any;
+ sort?: boolean;
+ delay?: number;
+ disabled?: boolean;
+ store?: {
+ get: (sortable: Sortable) => any[];
+ set: (sortable: Sortable) => any;
+ };
+ animation?: number;
+ handle?: string;
+ filter?: any;
+ draggable?: string;
+ ghostClass?: string;
+ chosenClass?: string;
+ dataIdAttr?: string;
+ forceFallback?: boolean;
+ fallbackClass?: string;
+ fallbackOnBody?: boolean;
+ scroll?: boolean;
+ scrollSensitivity?: number;
+ scrollSpeed?: number;
+ setData?: (dataTransfer: any, draggedElement: any) => any;
+ onStart?: (event: any) => any;
+ onEnd?: (event: any) => any;
+ onAdd?: (event: any) => any;
+ onUpdate?: (event: any) => any;
+ onSort?: (event: any) => any;
+ onRemove?: (event: any) => any;
+ onFilter?: (event: any) => any;
+ onMove?: (event: any) => boolean;
+ }
+
+ interface SortableUtils {
+ /**
+ * Attach an event handler function
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} event an Event context.
+ * @param {Function} fn
+ */
+ on(element: any, event: string, fn: (event: any) => any): void;
+
+ /**
+ * Remove an event handler function
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} event an Event context.
+ * @param {Function} fn a callback.
+ */
+ off(element: any, event: string, fn: (event: any) => any): void;
+
+ /**
+ * Get the values of all the CSS properties.
+ * @param {HTMLElement} element an HTMLElement.
+ * @returns {Object}
+ */
+ css(element: any): any;
+
+ /**
+ * Get the value of style properties.
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} prop a property key.
+ * @returns {*}
+ */
+ css(element: any, prop: string): any;
+
+ /**
+ * Set one CSS property.
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} prop a property key.
+ * @param {string} value a property value.
+ */
+ css(element: any, prop: string, value: string): void;
+
+ /**
+ * Set CSS properties.
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {Object} props a properties object.
+ */
+ css(element: any, props: any): void;
+
+ /**
+ * Get elements by tag name.
+ * @param {HTMLElement} context an HTMLElement.
+ * @param {string} tagName A tag name.
+ * @param {function} [iterator] An iterator.
+ * @returns {HTMLElement[]}
+ */
+ find(context: any, tagName: string, iterator?: (value: any) => any): any[];
+
+ /**
+ * Takes a function and returns a new one that will always have a particular context.
+ * @param {*} context an HTMLElement.
+ * @param {function} fn a function.
+ * @returns {function}
+ */
+ bind(context: any, fn: () => any): () => any;
+
+ /**
+ * Check the current matched set of elements against a selector.
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} selector an element selector.
+ * @returns {boolean}
+ */
+ is(element: any, selector: string): boolean;
+
+ /**
+ * For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} selector an element seletor.
+ * @param {HTMLElement} [context] a specific element's context.
+ * @returns {HTMLElement}
+ */
+ closest(element: any, selector: string, context?: any): any;
+
+ /**
+ * Add or remove one classes from each element
+ * @param {HTMLElement} element an HTMLElement.
+ * @param {string} name a class name.
+ * @param {boolean} state a class's state.
+ */
+ toggleClass(element: any, name: string, state: boolean): void;
+ }
+
+ class DOMRect {
+ public bottom: number;
+ public height: number;
+ public left: number;
+ public right: number;
+ public top: number;
+ public width: number;
+ public x: number;
+ public y: number;
+ }
+
+ class Sortable {
+ public options: SortableOptions;
+ public el: any;
+
+ /**
+ * Sortable's main constructor.
+ * @param {HTMLElement} element Any variety of HTMLElement.
+ * @param {SortableOptions} options Sortable options object.
+ */
+ constructor(element: any, options: SortableOptions);
+
+ static active: Sortable;
+ static utils: SortableUtils;
+
+ /**
+ * Creation of new instances.
+ * @param {HTMLElement} element Any variety of HTMLElement.
+ * @param {SortableOptions} options Sortable options object.
+ * @returns {Sortable}
+ */
+ static create(element: any, options: SortableOptions): Sortable;
+
+ /**
+ * Options getter/setter
+ * @param {string} name a SortableOptions property.
+ * @param {*} [value] a Value.
+ * @returns {*}
+ */
+ option(name: string, value: any): any;
+ option(name: string): any;
+
+ /**
+ * For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
+ * @param {string|HTMLElement} element an HTMLElement or selector string.
+ * @returns {HTMLElement}
+ */
+ closest(element: any): any;
+
+ /**
+ * Sorts the elements according to the array.
+ * @param {string[]} order an array of strings to sort.
+ */
+ sort(order: string[]): void;
+
+ /**
+ * Saving and restoring of the sort.
+ */
+ save(): void;
+
+ /**
+ * Removes the sortable functionality completely.
+ */
+ destroy(): void;
+
+ /**
+ * Serializes the sortable's item data-id's (dataIdAttr option) into an array of string.
+ * @returns {string[]}
+ */
+ toArray(): string[];
+ }
+}
+
+import Sortable = Sortablejs.Sortable;
+
+declare module 'Sortable' {
+ import Sortable = Sortablejs.Sortable;
+ export = Sortable;
+}
diff --git a/spin/spin-tests.ts b/spin/spin-tests.ts
index b72a2da010..4751b2076e 100644
--- a/spin/spin-tests.ts
+++ b/spin/spin-tests.ts
@@ -23,7 +23,11 @@ var opts2 = {
className: 'spinner',
zIndex: 5,
top: '28',
- left: 'auto'
+ left: 'auto',
+ scale: 1,
+ opacity: 0.25,
+ fps: 20,
+ position: 'absolute'
};
var newTarget = document.getElementById('bar');
diff --git a/spin/spin.d.ts b/spin/spin.d.ts
index 02a0e7cd21..9924aa2c1f 100644
--- a/spin/spin.d.ts
+++ b/spin/spin.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for Spin.js 1.3.1
+// Type definitions for Spin.js 2.3.2
// Project: http://fgnass.github.com/spin.js/
// Definitions by: Boris Yankov <https://github.com/borisyankov/>, Theodore Brown <https://github.com/theodorejb/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
@@ -21,6 +21,10 @@ interface SpinnerOptions {
zIndex?: number; // The z-index (defaults to 2000000000)
top?: string; // Top position relative to parent in px
left?: string; // Left position relative to parent in px
+ scale?: number; // Scales overall size of the spinner
+ opacity?: number; // Opacity of the lines
+ fps?: number; // Frames per second when using setTimeout() as a fallback for CSS
+ position?: string; // Element positioning
}
diff --git a/svg-pan-zoom/svg-pan-zoom-test.ts b/svg-pan-zoom/svg-pan-zoom-tests.ts
similarity index 100%
rename from svg-pan-zoom/svg-pan-zoom-test.ts
rename to svg-pan-zoom/svg-pan-zoom-tests.ts
diff --git a/svg2png/svg2png-test.ts b/svg2png/svg2png-tests.ts
similarity index 100%
rename from svg2png/svg2png-test.ts
rename to svg2png/svg2png-tests.ts
diff --git a/threejs/three-editorcontrols.d.ts b/threejs/three-editorcontrols.d.ts
new file mode 100644
index 0000000000..d25160efbe
--- /dev/null
+++ b/threejs/three-editorcontrols.d.ts
@@ -0,0 +1,25 @@
+// Type definitions for three.js (EditorControls.js)
+// Project: https://github.com/mrdoob/three.js/blob/master/examples/js/controls/EditorControls.js
+// Definitions by: Qinsi ZHU <https://github.com/qszhusightp>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="./three.d.ts" />
+
+declare module THREE {
+
+ class EditorControls extends EventDispatcher {
+
+ constructor(object: Camera, domElement?:HTMLElement);
+
+ enabled: boolean;
+ center: THREE.Vector3;
+
+ focus(target: THREE.Object3D, frame: boolean): void;
+ pan(delta: THREE.Vector3): void;
+ zoom(delta: THREE.Vector3): void;
+ rotate(delta: THREE.Vector3): void;
+ dispose(): void;
+
+ }
+
+}
diff --git a/threejs/three-transformcontrols.d.ts b/threejs/three-transformcontrols.d.ts
index 5be96cd032..7de479fc60 100644
--- a/threejs/three-transformcontrols.d.ts
+++ b/threejs/three-transformcontrols.d.ts
@@ -12,7 +12,7 @@ declare module THREE {
object: Object3D;
update():void;
- detach(object: Object3D): void;
+ detach(): void;
attach(object: Object3D): void;
setMode(mode: string): void;
setSnap(snap: any): void;
diff --git a/threejs/three.d.ts b/threejs/three.d.ts
index 66601f301d..fd165f9366 100644
--- a/threejs/three.d.ts
+++ b/threejs/three.d.ts
@@ -1,7 +1,7 @@
// Type definitions for three.js r71
// Project: http://mrdoob.github.com/three.js/
// Definitions by: Kon <http://phyzkit.net/>, Satoru Kimura <https://github.com/gyohk>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
interface WebGLRenderingContext {}
@@ -357,26 +357,77 @@ declare module THREE {
}
// Core ///////////////////////////////////////////////////////////////////////////////////////////////
- export class BufferAttribute {
- constructor(array: any, itemSize: number); // array parameter should be TypedArray.
- array: number[];
- itemSize: number;
- needsUpdate: boolean;
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/InterleavedBuffer.js">src/core/InterleavedBuffer.js</a>
+ */
+ export class InterleavedBuffer {
+ constructor(array: ArrayLike<number>, stride: number);
+ array: ArrayLike<number>;
+ stride: number;
+ dynamic: boolean;
+ updateRange: {offset:number, count:number};
+ version: number;
length: number;
+ count: number;
+ needsUpdate: boolean;
- copyAt(index1: number, attribute: BufferAttribute, index2: number): void;
- set(value: number, offset?: number): BufferAttribute;
+ setDynamic(dynamic: boolean): InterleavedBuffer;
+ copy(source: InterleavedBuffer): void;
+ copyAt(index1: number, attribute: InterleavedBufferAttribute, index2: number): InterleavedBuffer;
+ set(value: ArrayLike<number>, index: number): InterleavedBuffer;
+ clone(): InterleavedBuffer;
+ }
+
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/InstancedInterleavedBuffer.js">src/core/InstancedInterleavedBuffer.js</a>
+ */
+ export class InstancedInterleavedBuffer extends InterleavedBuffer {
+ constructor(array: ArrayLike<number>, stride: number, meshPerAttribute?: number);
+ meshPerAttribute: number;
+ copy(source: InstancedInterleavedBuffer): InstancedInterleavedBuffer;
+ }
+
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/BufferAttribute.js">src/core/BufferAttribute.js</a>
+ */
+ export class BufferAttribute {
+ constructor(array: ArrayLike<number>, itemSize: number); // array parameter should be TypedArray.
+
+ array: ArrayLike<number>;
+ itemSize: number;
+ dynamic: boolean;
+ updateRange: {offset:number, count:number};
+ needsUpdate: boolean;
+ /** Deprecated, use count instead */
+ length: number;
+ count: number;
+
+ setDynamic(dynamic: boolean): BufferAttribute;
+ copy(source: BufferAttribute): BufferAttribute;
+ copyAt(index1: number, attribute: BufferAttribute, index2: number): BufferAttribute;
+ copyArray(array: ArrayLike<number>): BufferAttribute;
+ copyColorArray(colors: {r:number, g:number, b:number}[]): BufferAttribute;
+ copyIndicesArray(indices: {a:number, b:number, c:number}[]): BufferAttribute;
+ copyVector2sArray(vectors: {x:number, y:number}[]): BufferAttribute;
+ copyVector3sArray(vectors: {x:number, y:number, z:number}[]): BufferAttribute;
+ copyVector4sArray(vectors: {x:number, y:number, z:number, w:number}[]): BufferAttribute;
+ set(value: ArrayLike<number>, offset?: number): BufferAttribute;
+ getX(index: number): number;
setX(index: number, x: number): BufferAttribute;
+ getY(index: number): number;
setY(index: number, y: number): BufferAttribute;
+ getZ(index: number): number;
setZ(index: number, z: number): BufferAttribute;
+ getW(index: number): number;
+ setW(index: number, z: number): BufferAttribute;
setXY(index: number, x: number, y: number): BufferAttribute;
setXYZ(index: number, x: number, y: number, z: number): BufferAttribute;
setXYZW(index: number, x: number, y: number, z: number, w: number): BufferAttribute;
clone(): BufferAttribute;
}
- // deprecated
+ // deprecated (are these actually deprecated?)
export class Int8Attribute extends BufferAttribute{
constructor(data: any, itemSize: number);
}
@@ -421,6 +472,42 @@ declare module THREE {
constructor(data: any, itemSize: number);
}
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/InstancedBufferAttribute.js">src/core/InstancedBufferAttribute.js</a>
+ */
+ export class InstancedBufferAttribute extends BufferAttribute {
+ constructor(data: ArrayLike<number>, itemSize: number, meshPerAttribute?: number);
+ meshPerAttribute: number;
+ copy(source: InstancedBufferAttribute): InstancedBufferAttribute;
+ }
+
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/InterleavedBufferAttribute.js">src/core/InterleavedBufferAttribute.js</a>
+ */
+ export class InterleavedBufferAttribute {
+ constructor(interleavedBuffer: InterleavedBuffer, itemSize: number, offset: number);
+
+ uuid: string;
+ data: InterleavedBuffer;
+ itemSize: number;
+ offset: number;
+ /** Deprecated, use count instead */
+ length: number;
+ count: number;
+
+ getX(index: number): number;
+ setX(index: number, x: number): InterleavedBufferAttribute;
+ getY(index: number): number;
+ setY(index: number, y: number): InterleavedBufferAttribute;
+ getZ(index: number): number;
+ setZ(index: number, z: number): InterleavedBufferAttribute;
+ getW(index: number): number;
+ setW(index: number, z: number): InterleavedBufferAttribute;
+ setXY(index: number, x: number, y: number): InterleavedBufferAttribute;
+ setXYZ(index: number, x: number, y: number, z: number): InterleavedBufferAttribute;
+ setXYZW(index: number, x: number, y: number, z: number, w: number): InterleavedBufferAttribute;
+ }
+
/**
* This is a superefficent class for geometries because it saves all data in buffers.
* It reduces memory costs and cpu cycles. But it is not as easy to work with because of all the nessecary buffer calculations.
@@ -434,6 +521,8 @@ declare module THREE {
*/
constructor();
+ static MaxIndex: number;
+
/**
* Unique number of this buffergeometry instance
*/
@@ -441,26 +530,49 @@ declare module THREE {
uuid: string;
name: string;
type: string;
- attributes: BufferAttribute[];
+ attributes: BufferAttribute|InterleavedBufferAttribute[];
attributesKeys: string[];
+ /** Deprecated. Use groups instead. */
drawcalls: { start: number; count: number; index: number; }[];
+ /** Deprecated. Use groups instead. */
offsets: { start: number; count: number; index: number; }[];
+ groups: {start: number, count: number, materialIndex?: number}[]
boundingBox: Box3;
boundingSphere: BoundingSphere;
-
- addAttribute(name: string, attribute: BufferAttribute): any;
+ /** Deprecated. This overloaded method is deprecated. */
addAttribute(name: string, array: any, itemSize: number): any;
- getAttribute(name: string): any;
+ addAttribute(name: string, attribute: BufferAttribute|InterleavedBufferAttribute): void;
+ getAttribute(name: string): BufferAttribute|InterleavedBufferAttribute;
+ removeAttribute(name: string): void;
+
+ setIndex(index: BufferAttribute): void;
+ getIndex(): BufferAttribute;
+
+ /** Deprecated. Use addGroup */
addDrawCall(start: number, count: number, index: number): void;
+ addGroup(start: number, count: number, materialIndex?: number): void;
+ clearGroups(): void;
+
+ setDrawRange(start:number, count:number): void;
/**
* Bakes matrix transform directly into vertex coordinates.
*/
applyMatrix(matrix: Matrix4): void;
+ rotateX(angle: number): BufferGeometry;
+ rotateY(angle: number): BufferGeometry;
+ rotateZ(angle: number): BufferGeometry;
+ translate(x:number, y:number, z:number): BufferGeometry;
+ scale(x:number, y:number, z:number): BufferGeometry;
+ lookAt(v:Vector3): void;
+
center(): Vector3;
- fromGeometry( geometry: Geometry, settings?: any ): BufferGeometry;
+ setFromObject(object: Object3D) : void;
+ updateFromObject(object: Object3D) : void;
+
+ fromGeometry(geometry: Geometry, settings?: any): BufferGeometry;
/**
* Computes bounding box of the geometry, updating Geometry.boundingBox attribute.
@@ -510,6 +622,49 @@ declare module THREE {
dispatchEvent(event: { type: string; target: any; }): void;
}
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/InstancedBufferGeometry.js">src/core/InstancedBufferGeometry.js</a>
+ */
+ export class InstancedBufferGeometry extends BufferGeometry {
+ constructor();
+ groups: {start:number, count:number, instances:number}[];
+ addGroup(start: number, count: number, instances: number): void;
+ copy(source: InstancedBufferGeometry): InstancedBufferGeometry;
+ }
+
+ /**
+ * @see <a href="https://github.com/mrdoob/three.js/blob/master/src/core/DirectGeometry.js">src/core/DirectGeometry.js</a>
+ */
+ export class DirectGeometry {
+ constructor();
+ id: number;
+ uuid: string;
+ name: string;
+ type: string;
+ indices: number[];
+ vertices: Vector3[];
+ normals: Vector3[];
+ colors: Color[];
+ uvs: Vector2[];
+ uvs2: Vector2[];
+ groups: {start: number, materialIndex: number}[];
+ morphTargets: MorphTarget[];
+ skinWeights: number[];
+ skinIndices: number[];
+ boundingBox: Box3;
+ boundingSphere: BoundingSphere;
+ verticesNeedUpdate: boolean;
+ normalsNeedUpdate: boolean;
+ colorsNeedUpdate: boolean;
+ uvsNeedUpdate: boolean;
+ groupsNeedUpdate: boolean;
+ computeBoundingBox(): void;
+ computeBoundingSphere(): void;
+ computeGroups(geometry: Geometry): void;
+ fromGeometry(geometry: Geometry): DirectGeometry;
+ dispose(): void;
+ }
+
/**
* Object for keeping track of time.
*
@@ -570,6 +725,9 @@ declare module THREE {
getDelta(): number;
}
+ /**
+ * Deprecated. Use new THREE.BufferAttribute().setDynamic(true) instead.
+ */
export class DynamicBufferAttribute extends BufferAttribute{
constructor(array: any, itemSize: number);
@@ -586,21 +744,21 @@ declare module THREE {
*
* # Example
* var Car = function () {
- *
+ *
* EventDispatcher.call( this );
* this.start = function () {
- *
+ *
* this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
- *
+ *
* };
- *
+ *
* };
*
* var car = new Car();
* car.addEventListener( 'start', function ( event ) {
- *
+ *
* alert( event.message );
- *
+ *
* } );
* car.start();
*
@@ -1213,7 +1371,7 @@ declare module THREE {
* Searches through the object's children and returns the first with a matching id, optionally recursive.
* @param id Unique number of the object instance
*/
- getObjectById(id: string): Object3D;
+ getObjectById(id: number): Object3D;
/**
* Searches through the object's children and returns the first with a matching name, optionally recursive.
@@ -1222,7 +1380,7 @@ declare module THREE {
getObjectByName(name: string): Object3D;
getObjectByProperty( name: string, value: string ): Object3D;
-
+
getWorldPosition(optionalTarget?: Vector3): Vector3;
getWorldQuaternion(optionalTarget?: Quaternion): Quaternion;
getWorldRotation(optionalTarget?: Euler): Euler;
@@ -1744,16 +1902,16 @@ declare module THREE {
add(regex:string, loader:Loader):void;
get(file: string):Loader;
}
-
+
export class BinaryTextureLoader {
constructor();
-
+
load(url: string, onLoad: (dataTexture: DataTexture) => void, onProgress?: (event: any) => void, onError?: (event: any) => void): void;
}
export class BufferGeometryLoader {
constructor(manager?: LoadingManager);
-
+
manager: LoadingManager;
load(url: string, onLoad: (bufferGeometry: BufferGeometry) => void, onProgress?: (event: any) => void, onError?: (event: any) => void): void;
setCrossOrigin(crossOrigin: string): void;
@@ -1891,10 +2049,10 @@ declare module THREE {
*/
export class TextureLoader {
constructor(manager?: LoadingManager);
-
+
manager: LoadingManager;
crossOrigin: string;
-
+
/**
* Begin loading from url
*
@@ -3313,8 +3471,8 @@ declare module THREE {
*/
multiplyQuaternions(a: Quaternion, b: Quaternion): Quaternion;
- /**
- * Deprecated. Use Vector3.applyQuaternion instead
+ /**
+ * Deprecated. Use Vector3.applyQuaternion instead
*/
multiplyVector3(vector: Vector3): Vector3;
slerp(qb: Quaternion, t: number): Quaternion;
@@ -4119,6 +4277,21 @@ declare module THREE {
clone(object?: Line): Line;
}
+ export class LineSegments extends Line {
+ constructor(geometry?: Geometry, material?: LineDashedMaterial);
+ constructor(geometry?: Geometry, material?: LineBasicMaterial);
+ constructor(geometry?: Geometry, material?: ShaderMaterial);
+ constructor(geometry?: BufferGeometry, material?: LineDashedMaterial);
+ constructor(geometry?: BufferGeometry, material?: LineBasicMaterial);
+ constructor(geometry?: BufferGeometry, material?: ShaderMaterial);
+
+ geometry: any; // Geometry or BufferGeometry;
+ material: Material; // LineDashedMaterial or LineBasicMaterial or ShaderMaterial
+
+ raycast(raycaster: Raycaster, intersects: any): void;
+ clone(object?: LineSegments): LineSegments;
+ }
+
enum LineMode{}
var LineStrip: LineMode;
var LinePieces: LineMode;
@@ -4245,7 +4418,7 @@ declare module THREE {
normalizeSkinWeights(): void;
updateMatrixWorld(force?: boolean): void;
clone(object?: SkinnedMesh): SkinnedMesh;
-
+
skeleton: Skeleton;
}
@@ -5670,8 +5843,8 @@ declare module THREE {
heightScale: number;
};
}
-
-
+
+
export class TubeGeometry extends Geometry {
constructor(path: Path, segments?: number, radius?: number, radiusSegments?: number, closed?: boolean, taper?: (u: number) => number);
@@ -5690,7 +5863,7 @@ declare module THREE {
static NoTaper(u?: number): number;
static SinusoidalTaper(u: number): number;
static FrenetFrames(path: Path, segments: number, closed: boolean): void;
-
+
}
// Extras / Helpers /////////////////////////////////////////////////////////////////////
diff --git a/through/through-tests.ts.tscparams b/through/through-tests.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/through/through-tests.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/through/through.d.ts.tscparams b/through/through.d.ts.tscparams
deleted file mode 100644
index d3f5a12faa..0000000000
--- a/through/through.d.ts.tscparams
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/tmp/tmp-tests.ts b/tmp/tmp-tests.ts
index 7f489eea41..c5560e7990 100644
--- a/tmp/tmp-tests.ts
+++ b/tmp/tmp-tests.ts
@@ -44,3 +44,25 @@ tmp.tmpName({ template: '/tmp/tmp-XXXXXX' }, (err, path) => {
});
tmp.setGracefulCleanup();
+
+var tmpobj = tmp.fileSync();
+console.log("File: ", tmpobj.name);
+console.log("Filedescriptor: ", tmpobj.fd);
+tmpobj.removeCallback();
+
+tmpobj = tmp.dirSync();
+console.log("Dir: ", tmpobj.name);
+tmpobj.removeCallback();
+
+var name = tmp.tmpNameSync();
+console.log("Created temporary filename: ", name);
+
+tmpobj = tmp.fileSync({ mode: 644, prefix: 'prefix-', postfix: '.txt' });
+console.log("File: ", tmpobj.name);
+console.log("Filedescriptor: ", tmpobj.fd);
+
+tmpobj = tmp.dirSync({ mode: 750, prefix: 'myTmpDir_' });
+console.log("Dir: ", tmpobj.name);
+
+var tmpname = tmp.tmpNameSync({ template: '/tmp/tmp-XXXXXX' });
+console.log("Created temporary filename: ", tmpname );
\ No newline at end of file
diff --git a/tmp/tmp.d.ts b/tmp/tmp.d.ts
index a89d7d1c4d..7c60d33ac8 100644
--- a/tmp/tmp.d.ts
+++ b/tmp/tmp.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for tmp v0.0.24
+// Type definitions for tmp v0.0.28
// Project: https://www.npmjs.com/package/tmp
// Definitions by: Jared Klopper <https://github.com/optical>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
@@ -6,8 +6,11 @@
declare module "tmp" {
module tmp {
- interface Options {
+ interface Options extends SimpleOptions {
mode?: number;
+ }
+
+ interface SimpleOptions {
prefix?: string;
postfix?: string;
template?: string;
@@ -16,15 +19,27 @@ declare module "tmp" {
keep?: boolean;
unsafeCleanup?: boolean;
}
+
+ interface SynchrounousResult {
+ name: string;
+ fd: number;
+ removeCallback: () => void;
+ }
function file(callback: (err: any, path: string, fd: number, cleanupCallback: () => void) => void): void;
function file(config: Options, callback?: (err: any, path: string, fd: number, cleanupCallback: () => void) => void): void;
+ function fileSync(config?: Options): SynchrounousResult;
+
function dir(callback: (err: any, path: string, cleanupCallback: () => void) => void): void;
function dir(config: Options, callback?: (err: any, path: string, cleanupCallback: () => void) => void): void;
+ function dirSync(config?: Options): SynchrounousResult;
+
function tmpName(callback: (err: any, path: string) => void): void;
- function tmpName(config: Options, callback?: (err: any, path: string) => void): void;
+ function tmpName(config: SimpleOptions, callback?: (err: any, path: string) => void): void;
+
+ function tmpNameSync(config?: SimpleOptions): string;
function setGracefulCleanup(): void;
}
diff --git a/typeahead/typeahead.d.ts b/typeahead/typeahead.d.ts
index 7317aa4c79..49538fbd9a 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.
@@ -316,6 +330,19 @@ declare module Bloodhound
* The ajax settings object passed to jQuery.ajax.
*/
ajax?: JQueryAjaxSettings;
+
+ /**
+ * A function that provides a hook to allow you to prepare the settings object passed to transport
+ * when a request is about to be made. The function signature should be prepare(query, settings),
+ * where query is the query #search was called with and settings is the default settings object
+ * created internally by the Bloodhound instance. The prepare function should return a settings object.
+ * [Note: Added in 0.11.1]
+ *
+ * @param query The query #search was called with.
+ * @param settings The default settings object created internally by Bloodhound.
+ * @returns A JqueryAjaxSettings object.
+ */
+ prepare?: (query: string, settings: JQueryAjaxSettings) => JQueryAjaxSettings;
}
/**
@@ -411,3 +438,7 @@ declare class Bloodhound<T> {
*/
public static tokenizers: Bloodhound.Tokenizers;
}
+
+declare module "bloodhound" {
+ export = Bloodhound;
+}
diff --git a/typescript-services/typescriptServices-tests.ts b/typescript-services/typescriptServices-tests.ts
index ab0da7a092..1c704b14ee 100644
--- a/typescript-services/typescriptServices-tests.ts
+++ b/typescript-services/typescriptServices-tests.ts
@@ -1,8 +1,23 @@
/// <reference path="./typescriptServices.d.ts"/>
-import ts = require('typescript-services');
+// transpile
+function transpile(input: string): string {
+ return ts.transpile(input, { module: ts.ModuleKind.CommonJS });
+}
-// formatter:
-var snapshot = ts.SimpleText.fromString('var foo = 123;');
-var formatter = new ts.Services.Formatting.TextSnapshot(snapshot);
-console.log(formatter);
+// compile
+function compile(fileNames: string[], options: ts.CompilerOptions): number {
+ let program = ts.createProgram(fileNames, options);
+ let emitResult = program.emit();
+
+ let allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics);
+
+ allDiagnostics.forEach(diagnostic => {
+ let { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start);
+ let message = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n');
+ console.log(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
+ });
+
+ let exitCode = emitResult.emitSkipped ? 1 : 0;
+ return exitCode;
+}
diff --git a/typescript-services/typescriptServices.d.ts b/typescript-services/typescriptServices.d.ts
index dfa2c633d0..dbd4919bf0 100644
--- a/typescript-services/typescriptServices.d.ts
+++ b/typescript-services/typescriptServices.d.ts
@@ -1,9314 +1,2148 @@
-// Type definitions for TypeScript-Services
-// Project: https://www.npmjs.org/package/typescript-services
-// Definitions by: Basarat Ali Syed <http://github.com/basarat>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-declare module TypeScript {
- var DiagnosticCode: {
- error_TS_0_1: string;
- warning_TS_0_1: string;
- Unrecognized_escape_sequence: string;
- Unexpected_character_0: string;
- Missing_close_quote_character: string;
- Identifier_expected: string;
- _0_keyword_expected: string;
- _0_expected: string;
- Identifier_expected_0_is_a_keyword: string;
- Automatic_semicolon_insertion_not_allowed: string;
- Unexpected_token_0_expected: string;
- Trailing_separator_not_allowed: string;
- AsteriskSlash_expected: string;
- public_or_private_modifier_must_precede_static: string;
- Unexpected_token: string;
- Catch_clause_parameter_cannot_have_a_type_annotation: string;
- Rest_parameter_must_be_last_in_list: string;
- Parameter_cannot_have_question_mark_and_initializer: string;
- Required_parameter_cannot_follow_optional_parameter: string;
- Index_signatures_cannot_have_rest_parameters: string;
- Index_signature_parameter_cannot_have_accessibility_modifiers: string;
- Index_signature_parameter_cannot_have_a_question_mark: string;
- Index_signature_parameter_cannot_have_an_initializer: string;
- Index_signature_must_have_a_type_annotation: string;
- Index_signature_parameter_must_have_a_type_annotation: string;
- Index_signature_parameter_type_must_be_string_or_number: string;
- extends_clause_already_seen: string;
- extends_clause_must_precede_implements_clause: string;
- Classes_can_only_extend_a_single_class: string;
- implements_clause_already_seen: string;
- Accessibility_modifier_already_seen: string;
- _0_modifier_must_precede_1_modifier: string;
- _0_modifier_already_seen: string;
- _0_modifier_cannot_appear_on_a_class_element: string;
- Interface_declaration_cannot_have_implements_clause: string;
- super_invocation_cannot_have_type_arguments: string;
- Only_ambient_modules_can_use_quoted_names: string;
- Statements_are_not_allowed_in_ambient_contexts: string;
- Implementations_are_not_allowed_in_ambient_contexts: string;
- declare_modifier_not_allowed_for_code_already_in_an_ambient_context: string;
- Initializers_are_not_allowed_in_ambient_contexts: string;
- Parameter_property_declarations_can_only_be_used_in_a_non_ambient_constructor_declaration: string;
- Function_implementation_expected: string;
- Constructor_implementation_expected: string;
- Function_overload_name_must_be_0: string;
- _0_modifier_cannot_appear_on_a_module_element: string;
- declare_modifier_cannot_appear_on_an_interface_declaration: string;
- declare_modifier_required_for_top_level_element: string;
- Rest_parameter_cannot_be_optional: string;
- Rest_parameter_cannot_have_an_initializer: string;
- set_accessor_must_have_one_and_only_one_parameter: string;
- set_accessor_parameter_cannot_be_optional: string;
- set_accessor_parameter_cannot_have_an_initializer: string;
- set_accessor_cannot_have_rest_parameter: string;
- get_accessor_cannot_have_parameters: string;
- Modifiers_cannot_appear_here: string;
- Accessors_are_only_available_when_targeting_ECMAScript_5_and_higher: string;
- Class_name_cannot_be_0: string;
- Interface_name_cannot_be_0: string;
- Enum_name_cannot_be_0: string;
- Module_name_cannot_be_0: string;
- Enum_member_must_have_initializer: string;
- Export_assignment_cannot_be_used_in_internal_modules: string;
- Export_assignment_not_allowed_in_module_with_exported_element: string;
- Module_cannot_have_multiple_export_assignments: string;
- Ambient_enum_elements_can_only_have_integer_literal_initializers: string;
- module_class_interface_enum_import_or_statement: string;
- constructor_function_accessor_or_variable: string;
- statement: string;
- case_or_default_clause: string;
- identifier: string;
- call_construct_index_property_or_function_signature: string;
- expression: string;
- type_name: string;
- property_or_accessor: string;
- parameter: string;
- type: string;
- type_parameter: string;
- declare_modifier_not_allowed_on_import_declaration: string;
- Function_overload_must_be_static: string;
- Function_overload_must_not_be_static: string;
- Parameter_property_declarations_cannot_be_used_in_a_constructor_overload: string;
- Invalid_reference_directive_syntax: string;
- Octal_literals_are_not_available_when_targeting_ECMAScript_5_and_higher: string;
- Accessors_are_not_allowed_in_ambient_contexts: string;
- _0_modifier_cannot_appear_on_a_constructor_declaration: string;
- _0_modifier_cannot_appear_on_a_parameter: string;
- Only_a_single_variable_declaration_is_allowed_in_a_for_in_statement: string;
- Type_parameters_cannot_appear_on_a_constructor_declaration: string;
- Type_annotation_cannot_appear_on_a_constructor_declaration: string;
- Duplicate_identifier_0: string;
- The_name_0_does_not_exist_in_the_current_scope: string;
- The_name_0_does_not_refer_to_a_value: string;
- super_can_only_be_used_inside_a_class_instance_method: string;
- The_left_hand_side_of_an_assignment_expression_must_be_a_variable_property_or_indexer: string;
- Value_of_type_0_is_not_callable_Did_you_mean_to_include_new: string;
- Value_of_type_0_is_not_callable: string;
- Value_of_type_0_is_not_newable: string;
- Value_of_type_0_is_not_indexable_by_type_1: string;
- Operator_0_cannot_be_applied_to_types_1_and_2: string;
- Operator_0_cannot_be_applied_to_types_1_and_2_3: string;
- Cannot_convert_0_to_1: string;
- Cannot_convert_0_to_1_NL_2: string;
- Expected_var_class_interface_or_module: string;
- Operator_0_cannot_be_applied_to_type_1: string;
- Getter_0_already_declared: string;
- Setter_0_already_declared: string;
- Exported_class_0_extends_private_class_1: string;
- Exported_class_0_implements_private_interface_1: string;
- Exported_interface_0_extends_private_interface_1: string;
- Exported_class_0_extends_class_from_inaccessible_module_1: string;
- Exported_class_0_implements_interface_from_inaccessible_module_1: string;
- Exported_interface_0_extends_interface_from_inaccessible_module_1: string;
- Public_static_property_0_of_exported_class_has_or_is_using_private_type_1: string;
- Public_property_0_of_exported_class_has_or_is_using_private_type_1: string;
- Property_0_of_exported_interface_has_or_is_using_private_type_1: string;
- Exported_variable_0_has_or_is_using_private_type_1: string;
- Public_static_property_0_of_exported_class_is_using_inaccessible_module_1: string;
- Public_property_0_of_exported_class_is_using_inaccessible_module_1: string;
- Property_0_of_exported_interface_is_using_inaccessible_module_1: string;
- Exported_variable_0_is_using_inaccessible_module_1: string;
- Parameter_0_of_constructor_from_exported_class_has_or_is_using_private_type_1: string;
- Parameter_0_of_public_static_property_setter_from_exported_class_has_or_is_using_private_type_1: string;
- Parameter_0_of_public_property_setter_from_exported_class_has_or_is_using_private_type_1: string;
- Parameter_0_of_constructor_signature_from_exported_interface_has_or_is_using_private_type_1: string;
- Parameter_0_of_call_signature_from_exported_interface_has_or_is_using_private_type_1: string;
- Parameter_0_of_public_static_method_from_exported_class_has_or_is_using_private_type_1: string;
- Parameter_0_of_public_method_from_exported_class_has_or_is_using_private_type_1: string;
- Parameter_0_of_method_from_exported_interface_has_or_is_using_private_type_1: string;
- Parameter_0_of_exported_function_has_or_is_using_private_type_1: string;
- Parameter_0_of_constructor_from_exported_class_is_using_inaccessible_module_1: string;
- Parameter_0_of_public_static_property_setter_from_exported_class_is_using_inaccessible_module_1: string;
- Parameter_0_of_public_property_setter_from_exported_class_is_using_inaccessible_module_1: string;
- Parameter_0_of_constructor_signature_from_exported_interface_is_using_inaccessible_module_1: string;
- Parameter_0_of_call_signature_from_exported_interface_is_using_inaccessible_module_1: string;
- Parameter_0_of_public_static_method_from_exported_class_is_using_inaccessible_module_1: string;
- Parameter_0_of_public_method_from_exported_class_is_using_inaccessible_module_1: string;
- Parameter_0_of_method_from_exported_interface_is_using_inaccessible_module_1: string;
- Parameter_0_of_exported_function_is_using_inaccessible_module_1: string;
- Return_type_of_public_static_property_getter_from_exported_class_has_or_is_using_private_type_0: string;
- Return_type_of_public_property_getter_from_exported_class_has_or_is_using_private_type_0: string;
- Return_type_of_constructor_signature_from_exported_interface_has_or_is_using_private_type_0: string;
- Return_type_of_call_signature_from_exported_interface_has_or_is_using_private_type_0: string;
- Return_type_of_index_signature_from_exported_interface_has_or_is_using_private_type_0: string;
- Return_type_of_public_static_method_from_exported_class_has_or_is_using_private_type_0: string;
- Return_type_of_public_method_from_exported_class_has_or_is_using_private_type_0: string;
- Return_type_of_method_from_exported_interface_has_or_is_using_private_type_0: string;
- Return_type_of_exported_function_has_or_is_using_private_type_0: string;
- Return_type_of_public_static_property_getter_from_exported_class_is_using_inaccessible_module_0: string;
- Return_type_of_public_property_getter_from_exported_class_is_using_inaccessible_module_0: string;
- Return_type_of_constructor_signature_from_exported_interface_is_using_inaccessible_module_0: string;
- Return_type_of_call_signature_from_exported_interface_is_using_inaccessible_module_0: string;
- Return_type_of_index_signature_from_exported_interface_is_using_inaccessible_module_0: string;
- Return_type_of_public_static_method_from_exported_class_is_using_inaccessible_module_0: string;
- Return_type_of_public_method_from_exported_class_is_using_inaccessible_module_0: string;
- Return_type_of_method_from_exported_interface_is_using_inaccessible_module_0: string;
- Return_type_of_exported_function_is_using_inaccessible_module_0: string;
- new_T_cannot_be_used_to_create_an_array_Use_new_Array_T_instead: string;
- A_parameter_list_must_follow_a_generic_type_argument_list_expected: string;
- Multiple_constructor_implementations_are_not_allowed: string;
- Unable_to_resolve_external_module_0: string;
- Module_cannot_be_aliased_to_a_non_module_type: string;
- A_class_may_only_extend_another_class: string;
- A_class_may_only_implement_another_class_or_interface: string;
- An_interface_may_only_extend_another_class_or_interface: string;
- Unable_to_resolve_type: string;
- Unable_to_resolve_type_of_0: string;
- Unable_to_resolve_type_parameter_constraint: string;
- Type_parameter_constraint_cannot_be_a_primitive_type: string;
- Supplied_parameters_do_not_match_any_signature_of_call_target: string;
- Supplied_parameters_do_not_match_any_signature_of_call_target_NL_0: string;
- Invalid_new_expression: string;
- Call_signatures_used_in_a_new_expression_must_have_a_void_return_type: string;
- Could_not_select_overload_for_new_expression: string;
- Type_0_does_not_satisfy_the_constraint_1_for_type_parameter_2: string;
- Could_not_select_overload_for_call_expression: string;
- Cannot_invoke_an_expression_whose_type_lacks_a_call_signature: string;
- Calls_to_super_are_only_valid_inside_a_class: string;
- Generic_type_0_requires_1_type_argument_s: string;
- Type_of_array_literal_cannot_be_determined_Best_common_type_could_not_be_found_for_array_elements: string;
- Could_not_find_enclosing_symbol_for_dotted_name_0: string;
- The_property_0_does_not_exist_on_value_of_type_1: string;
- Could_not_find_symbol_0: string;
- get_and_set_accessor_must_have_the_same_type: string;
- this_cannot_be_referenced_in_current_location: string;
- Static_members_cannot_reference_class_type_parameters: string;
- Class_0_is_recursively_referenced_as_a_base_type_of_itself: string;
- Interface_0_is_recursively_referenced_as_a_base_type_of_itself: string;
- super_property_access_is_permitted_only_in_a_constructor_member_function_or_member_accessor_of_a_derived_class: string;
- super_cannot_be_referenced_in_non_derived_classes: string;
- A_super_call_must_be_the_first_statement_in_the_constructor_when_a_class_contains_initialized_properties_or_has_parameter_properties: string;
- Constructors_for_derived_classes_must_contain_a_super_call: string;
- Super_calls_are_not_permitted_outside_constructors_or_in_nested_functions_inside_constructors: string;
- _0_1_is_inaccessible: string;
- this_cannot_be_referenced_within_module_bodies: string;
- Invalid_expression_types_not_known_to_support_the_addition_operator: string;
- The_right_hand_side_of_an_arithmetic_operation_must_be_of_type_any_number_or_an_enum_type: string;
- The_left_hand_side_of_an_arithmetic_operation_must_be_of_type_any_number_or_an_enum_type: string;
- The_type_of_a_unary_arithmetic_operation_operand_must_be_of_type_any_number_or_an_enum_type: string;
- Variable_declarations_of_a_for_statement_cannot_use_a_type_annotation: string;
- Variable_declarations_of_a_for_statement_must_be_of_types_string_or_any: string;
- The_right_hand_side_of_a_for_in_statement_must_be_of_type_any_an_object_type_or_a_type_parameter: string;
- The_left_hand_side_of_an_in_expression_must_be_of_types_any_string_or_number: string;
- The_right_hand_side_of_an_in_expression_must_be_of_type_any_an_object_type_or_a_type_parameter: string;
- The_left_hand_side_of_an_instanceof_expression_must_be_of_type_any_an_object_type_or_a_type_parameter: string;
- The_right_hand_side_of_an_instanceof_expression_must_be_of_type_any_or_of_a_type_assignable_to_the_Function_interface_type: string;
- Setters_cannot_return_a_value: string;
- Tried_to_query_type_of_uninitialized_module_0: string;
- Tried_to_set_variable_type_to_uninitialized_module_type_0: string;
- Type_0_does_not_have_type_parameters: string;
- Getters_must_return_a_value: string;
- Getter_and_setter_accessors_do_not_agree_in_visibility: string;
- Invalid_left_hand_side_of_assignment_expression: string;
- Function_declared_a_non_void_return_type_but_has_no_return_expression: string;
- Cannot_resolve_return_type_reference: string;
- Constructors_cannot_have_a_return_type_of_void: string;
- Subsequent_variable_declarations_must_have_the_same_type_Variable_0_must_be_of_type_1_but_here_has_type_2: string;
- All_symbols_within_a_with_block_will_be_resolved_to_any: string;
- Import_declarations_in_an_internal_module_cannot_reference_an_external_module: string;
- Class_0_declares_interface_1_but_does_not_implement_it_NL_2: string;
- Class_0_declares_class_1_as_an_interface_but_does_not_implement_it_NL_2: string;
- The_operand_of_an_increment_or_decrement_operator_must_be_a_variable_property_or_indexer: string;
- this_cannot_be_referenced_in_static_initializers_in_a_class_body: string;
- Class_0_cannot_extend_class_1_NL_2: string;
- Interface_0_cannot_extend_class_1_NL_2: string;
- Interface_0_cannot_extend_interface_1_NL_2: string;
- Duplicate_overload_signature_for_0: string;
- Duplicate_constructor_overload_signature: string;
- Duplicate_overload_call_signature: string;
- Duplicate_overload_construct_signature: string;
- Overload_signature_is_not_compatible_with_function_definition: string;
- Overload_signature_is_not_compatible_with_function_definition_NL_0: string;
- Overload_signatures_must_all_be_public_or_private: string;
- Overload_signatures_must_all_be_exported_or_not_exported: string;
- Overload_signatures_must_all_be_ambient_or_non_ambient: string;
- Overload_signatures_must_all_be_optional_or_required: string;
- Specialized_overload_signature_is_not_assignable_to_any_non_specialized_signature: string;
- this_cannot_be_referenced_in_constructor_arguments: string;
- Instance_member_cannot_be_accessed_off_a_class: string;
- Untyped_function_calls_may_not_accept_type_arguments: string;
- Non_generic_functions_may_not_accept_type_arguments: string;
- A_generic_type_may_not_reference_itself_with_a_wrapped_form_of_its_own_type_parameters: string;
- Rest_parameters_must_be_array_types: string;
- Overload_signature_implementation_cannot_use_specialized_type: string;
- Export_assignments_may_only_be_used_at_the_top_level_of_external_modules: string;
- Export_assignments_may_only_be_made_with_variables_functions_classes_interfaces_enums_and_internal_modules: string;
- Only_public_methods_of_the_base_class_are_accessible_via_the_super_keyword: string;
- Numeric_indexer_type_0_must_be_assignable_to_string_indexer_type_1: string;
- Numeric_indexer_type_0_must_be_assignable_to_string_indexer_type_1_NL_2: string;
- All_numerically_named_properties_must_be_assignable_to_numeric_indexer_type_0: string;
- All_numerically_named_properties_must_be_assignable_to_numeric_indexer_type_0_NL_1: string;
- All_named_properties_must_be_assignable_to_string_indexer_type_0: string;
- All_named_properties_must_be_assignable_to_string_indexer_type_0_NL_1: string;
- Generic_type_references_must_include_all_type_arguments: string;
- Default_arguments_are_only_allowed_in_implementation: string;
- Overloads_cannot_differ_only_by_return_type: string;
- Function_expression_declared_a_non_void_return_type_but_has_no_return_expression: string;
- Import_declaration_referencing_identifier_from_internal_module_can_only_be_made_with_variables_functions_classes_interfaces_enums_and_internal_modules: string;
- Could_not_find_symbol_0_in_module_1: string;
- Unable_to_resolve_module_reference_0: string;
- Could_not_find_module_0_in_module_1: string;
- Exported_import_declaration_0_is_assigned_value_with_type_that_has_or_is_using_private_type_1: string;
- Exported_import_declaration_0_is_assigned_value_with_type_that_is_using_inaccessible_module_1: string;
- Exported_import_declaration_0_is_assigned_type_that_has_or_is_using_private_type_1: string;
- Exported_import_declaration_0_is_assigned_type_that_is_using_inaccessible_module_1: string;
- Exported_import_declaration_0_is_assigned_container_that_is_or_is_using_inaccessible_module_1: string;
- Type_name_0_in_extends_clause_does_not_reference_constructor_function_for_1: string;
- Internal_module_reference_0_in_import_declaration_does_not_reference_module_instance_for_1: string;
- Module_0_cannot_merge_with_previous_declaration_of_1_in_a_different_file_2: string;
- Interface_0_cannot_simultaneously_extend_types_1_and_2_NL_3: string;
- Initializer_of_parameter_0_cannot_reference_identifier_1_declared_after_it: string;
- Ambient_external_module_declaration_cannot_be_reopened: string;
- All_declarations_of_merged_declaration_0_must_be_exported_or_not_exported: string;
- super_cannot_be_referenced_in_constructor_arguments: string;
- Return_type_of_constructor_signature_must_be_assignable_to_the_instance_type_of_the_class: string;
- Ambient_external_module_declaration_must_be_defined_in_global_context: string;
- Ambient_external_module_declaration_cannot_specify_relative_module_name: string;
- Import_declaration_in_an_ambient_external_module_declaration_cannot_reference_external_module_through_relative_external_module_name: string;
- Could_not_find_the_best_common_type_of_types_of_all_return_statement_expressions: string;
- Import_declaration_cannot_refer_to_external_module_reference_when_noResolve_option_is_set: string;
- Duplicate_identifier_this_Compiler_uses_variable_declaration_this_to_capture_this_reference: string;
- continue_statement_can_only_be_used_within_an_enclosing_iteration_statement: string;
- break_statement_can_only_be_used_within_an_enclosing_iteration_or_switch_statement: string;
- Jump_target_not_found: string;
- Jump_target_cannot_cross_function_boundary: string;
- Duplicate_identifier_super_Compiler_uses_super_to_capture_base_class_reference: string;
- Expression_resolves_to_variable_declaration_this_that_compiler_uses_to_capture_this_reference: string;
- Expression_resolves_to_super_that_compiler_uses_to_capture_base_class_reference: string;
- TypeParameter_0_of_constructor_signature_from_exported_interface_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_call_signature_from_exported_interface_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_public_static_method_from_exported_class_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_public_method_from_exported_class_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_method_from_exported_interface_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_exported_function_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_constructor_signature_from_exported_interface_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_call_signature_from_exported_interface_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_public_static_method_from_exported_class_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_public_method_from_exported_class_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_method_from_exported_interface_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_exported_function_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_exported_class_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_exported_interface_has_or_is_using_private_type_1: string;
- TypeParameter_0_of_exported_class_is_using_inaccessible_module_1: string;
- TypeParameter_0_of_exported_interface_is_using_inaccessible_module_1: string;
- Duplicate_identifier_i_Compiler_uses_i_to_initialize_rest_parameter: string;
- Duplicate_identifier_arguments_Compiler_uses_arguments_to_initialize_rest_parameters: string;
- Type_of_conditional_0_must_be_identical_to_1_or_2: string;
- Type_of_conditional_0_must_be_identical_to_1_2_or_3: string;
- Duplicate_identifier_0_Compiler_reserves_name_1_in_top_level_scope_of_an_external_module: string;
- Constraint_of_a_type_parameter_cannot_reference_any_type_parameter_from_the_same_type_parameter_list: string;
- Initializer_of_instance_member_variable_0_cannot_reference_identifier_1_declared_in_the_constructor: string;
- Parameter_0_cannot_be_referenced_in_its_initializer: string;
- Duplicate_string_index_signature: string;
- Duplicate_number_index_signature: string;
- All_declarations_of_an_interface_must_have_identical_type_parameters: string;
- Expression_resolves_to_variable_declaration_i_that_compiler_uses_to_initialize_rest_parameter: string;
- Type_0_is_missing_property_1_from_type_2: string;
- Types_of_property_0_of_types_1_and_2_are_incompatible: string;
- Types_of_property_0_of_types_1_and_2_are_incompatible_NL_3: string;
- Property_0_defined_as_private_in_type_1_is_defined_as_public_in_type_2: string;
- Property_0_defined_as_public_in_type_1_is_defined_as_private_in_type_2: string;
- Types_0_and_1_define_property_2_as_private: string;
- Call_signatures_of_types_0_and_1_are_incompatible: string;
- Call_signatures_of_types_0_and_1_are_incompatible_NL_2: string;
- Type_0_requires_a_call_signature_but_type_1_lacks_one: string;
- Construct_signatures_of_types_0_and_1_are_incompatible: string;
- Construct_signatures_of_types_0_and_1_are_incompatible_NL_2: string;
- Type_0_requires_a_construct_signature_but_type_1_lacks_one: string;
- Index_signatures_of_types_0_and_1_are_incompatible: string;
- Index_signatures_of_types_0_and_1_are_incompatible_NL_2: string;
- Call_signature_expects_0_or_fewer_parameters: string;
- Could_not_apply_type_0_to_argument_1_which_is_of_type_2: string;
- Class_0_defines_instance_member_accessor_1_but_extended_class_2_defines_it_as_instance_member_function: string;
- Class_0_defines_instance_member_property_1_but_extended_class_2_defines_it_as_instance_member_function: string;
- Class_0_defines_instance_member_function_1_but_extended_class_2_defines_it_as_instance_member_accessor: string;
- Class_0_defines_instance_member_function_1_but_extended_class_2_defines_it_as_instance_member_property: string;
- Types_of_static_property_0_of_class_1_and_class_2_are_incompatible: string;
- Types_of_static_property_0_of_class_1_and_class_2_are_incompatible_NL_3: string;
- Type_reference_cannot_refer_to_container_0: string;
- Type_reference_must_refer_to_type: string;
- In_enums_with_multiple_declarations_only_one_declaration_can_omit_an_initializer_for_the_first_enum_element: string;
- _0_overload_s: string;
- Variable_declaration_cannot_have_the_same_name_as_an_import_declaration: string;
- Signature_expected_0_type_arguments_got_1_instead: string;
- Property_0_defined_as_optional_in_type_1_but_is_required_in_type_2: string;
- Types_0_and_1_originating_in_infinitely_expanding_type_reference_do_not_refer_to_same_named_type: string;
- Types_0_and_1_originating_in_infinitely_expanding_type_reference_have_incompatible_type_arguments: string;
- Types_0_and_1_originating_in_infinitely_expanding_type_reference_have_incompatible_type_arguments_NL_2: string;
- Named_properties_0_of_types_1_and_2_are_not_identical: string;
- Types_of_string_indexer_of_types_0_and_1_are_not_identical: string;
- Types_of_number_indexer_of_types_0_and_1_are_not_identical: string;
- Type_of_number_indexer_in_type_0_is_not_assignable_to_string_indexer_type_in_type_1_NL_2: string;
- Type_of_property_0_in_type_1_is_not_assignable_to_string_indexer_type_in_type_2_NL_3: string;
- Type_of_property_0_in_type_1_is_not_assignable_to_number_indexer_type_in_type_2_NL_3: string;
- Static_property_0_defined_as_private_in_type_1_is_defined_as_public_in_type_2: string;
- Static_property_0_defined_as_public_in_type_1_is_defined_as_private_in_type_2: string;
- Types_0_and_1_define_static_property_2_as_private: string;
- Current_host_does_not_support_0_option: string;
- ECMAScript_target_version_0_not_supported_Specify_a_valid_target_version_1_default_or_2: string;
- Module_code_generation_0_not_supported: string;
- Could_not_find_file_0: string;
- A_file_cannot_have_a_reference_to_itself: string;
- Cannot_resolve_referenced_file_0: string;
- Cannot_find_the_common_subdirectory_path_for_the_input_files: string;
- Emit_Error_0: string;
- Cannot_read_file_0_1: string;
- Unsupported_file_encoding: string;
- Locale_must_be_of_the_form_language_or_language_territory_For_example_0_or_1: string;
- Unsupported_locale_0: string;
- Execution_Failed_NL: string;
- Invalid_call_to_up: string;
- Invalid_call_to_down: string;
- Base64_value_0_finished_with_a_continuation_bit: string;
- Unknown_option_0: string;
- Expected_0_arguments_to_message_got_1_instead: string;
- Expected_the_message_0_to_have_1_arguments_but_it_had_2: string;
- Could_not_delete_file_0: string;
- Could_not_create_directory_0: string;
- Error_while_executing_file_0: string;
- Cannot_compile_external_modules_unless_the_module_flag_is_provided: string;
- Option_mapRoot_cannot_be_specified_without_specifying_sourcemap_option: string;
- Option_sourceRoot_cannot_be_specified_without_specifying_sourcemap_option: string;
- Options_mapRoot_and_sourceRoot_cannot_be_specified_without_specifying_sourcemap_option: string;
- Option_0_specified_without_1: string;
- codepage_option_not_supported_on_current_platform: string;
- Concatenate_and_emit_output_to_single_file: string;
- Generates_corresponding_0_file: string;
- Specifies_the_location_where_debugger_should_locate_map_files_instead_of_generated_locations: string;
- Specifies_the_location_where_debugger_should_locate_TypeScript_files_instead_of_source_locations: string;
- Watch_input_files: string;
- Redirect_output_structure_to_the_directory: string;
- Do_not_emit_comments_to_output: string;
- Skip_resolution_and_preprocessing: string;
- Specify_ECMAScript_target_version_0_default_or_1: string;
- Specify_module_code_generation_0_or_1: string;
- Print_this_message: string;
- Print_the_compiler_s_version_0: string;
- Allow_use_of_deprecated_0_keyword_when_referencing_an_external_module: string;
- Specify_locale_for_errors_and_messages_For_example_0_or_1: string;
- Syntax_0: string;
- options: string;
- file1: string;
- Examples: string;
- Options: string;
- Insert_command_line_options_and_files_from_a_file: string;
- Version_0: string;
- Use_the_0_flag_to_see_options: string;
- NL_Recompiling_0: string;
- STRING: string;
- KIND: string;
- file2: string;
- VERSION: string;
- LOCATION: string;
- DIRECTORY: string;
- NUMBER: string;
- Specify_the_codepage_to_use_when_opening_source_files: string;
- Additional_locations: string;
- This_version_of_the_Javascript_runtime_does_not_support_the_0_function: string;
- Unknown_rule: string;
- Invalid_line_number_0: string;
- Warn_on_expressions_and_declarations_with_an_implied_any_type: string;
- Variable_0_implicitly_has_an_any_type: string;
- Parameter_0_of_1_implicitly_has_an_any_type: string;
- Parameter_0_of_function_type_implicitly_has_an_any_type: string;
- Member_0_of_object_type_implicitly_has_an_any_type: string;
- new_expression_which_lacks_a_constructor_signature_implicitly_has_an_any_type: string;
- _0_which_lacks_return_type_annotation_implicitly_has_an_any_return_type: string;
- Function_expression_which_lacks_return_type_annotation_implicitly_has_an_any_return_type: string;
- Parameter_0_of_lambda_function_implicitly_has_an_any_type: string;
- Constructor_signature_which_lacks_return_type_annotation_implicitly_has_an_any_return_type: string;
- Lambda_Function_which_lacks_return_type_annotation_implicitly_has_an_any_return_type: string;
- Array_Literal_implicitly_has_an_any_type_from_widening: string;
- _0_which_lacks_get_accessor_and_parameter_type_annotation_on_set_accessor_implicitly_has_an_any_type: string;
- Index_signature_of_object_type_implicitly_has_an_any_type: string;
- Object_literal_s_property_0_implicitly_has_an_any_type_from_widening: string;
- };
-}
-declare module TypeScript {
- class ArrayUtilities {
- static isArray(value: any): boolean;
- static sequenceEquals<T>(array1: T[], array2: T[], equals: (v1: T, v2: T) => boolean): boolean;
- static contains<T>(array: T[], value: T): boolean;
- static groupBy<T>(array: T[], func: (v: T) => string): any;
- static distinct<T>(array: T[], equalsFn?: (a: T, b: T) => boolean): T[];
- static min<T>(array: T[], func: (v: T) => number): number;
- static max<T>(array: T[], func: (v: T) => number): number;
- static last<T>(array: T[]): T;
- static lastOrDefault<T>(array: T[], predicate: (v: T, index: number) => boolean): T;
- static firstOrDefault<T>(array: T[], func: (v: T, index: number) => boolean): T;
- static first<T>(array: T[], func?: (v: T, index: number) => boolean): T;
- static sum<T>(array: T[], func: (v: T) => number): number;
- static select<T, S>(values: T[], func: (v: T) => S): S[];
- static where<T>(values: T[], func: (v: T) => boolean): T[];
- static any<T>(array: T[], func: (v: T) => boolean): boolean;
- static all<T>(array: T[], func: (v: T) => boolean): boolean;
- static binarySearch(array: number[], value: number): number;
- static createArray<T>(length: number, defaultValue: any): T[];
- static grow<T>(array: T[], length: number, defaultValue: T): void;
- static copy<T>(sourceArray: T[], sourceIndex: number, destinationArray: T[], destinationIndex: number, length: number): void;
- static indexOf<T>(array: T[], predicate: (v: T) => boolean): number;
- }
-}
-declare module TypeScript {
- interface IBitVector {
- valueAt(index: number): boolean;
- setValueAt(index: number, value: boolean): void;
- release(): void;
- }
- module BitVector {
- function getBitVector(allowUndefinedValues: boolean): IBitVector;
- }
-}
-declare module TypeScript {
- interface IBitMatrix {
- valueAt(x: number, y: number): boolean;
- setValueAt(x: number, y: number, value: boolean): void;
- release(): void;
- }
- module BitMatrix {
- function getBitMatrix(allowUndefinedValues: boolean): IBitMatrix;
- }
-}
-declare module TypeScript {
- enum Constants {
- Max31BitInteger = 1073741823,
- Min31BitInteger = -1073741824,
- }
-}
-declare module TypeScript {
- enum AssertionLevel {
- None = 0,
- Normal = 1,
- Aggressive = 2,
- VeryAggressive = 3,
- }
- class Debug {
- private static currentAssertionLevel;
- static shouldAssert(level: AssertionLevel): boolean;
- static assert(expression: any, message?: string, verboseDebugInfo?: () => string): void;
- static fail(message?: string): void;
- }
-}
-declare module TypeScript {
- var LocalizedDiagnosticMessages: IIndexable<any>;
- class Location {
- private _fileName;
- private _lineMap;
- private _start;
- private _length;
- constructor(fileName: string, lineMap: LineMap, start: number, length: number);
- public fileName(): string;
- public lineMap(): LineMap;
- public line(): number;
- public character(): number;
- public start(): number;
- public length(): number;
- static equals(location1: Location, location2: Location): boolean;
- }
- class Diagnostic extends Location {
- private _diagnosticKey;
- private _arguments;
- private _additionalLocations;
- constructor(fileName: string, lineMap: LineMap, start: number, length: number, diagnosticKey: string, _arguments?: any[], additionalLocations?: Location[]);
- public toJSON(key: any): any;
- public diagnosticKey(): string;
- public arguments(): any[];
- public text(): string;
- public message(): string;
- public additionalLocations(): Location[];
- static equals(diagnostic1: Diagnostic, diagnostic2: Diagnostic): boolean;
- public info(): DiagnosticInfo;
- }
- function newLine(): string;
- function getLocalizedText(diagnosticKey: string, args: any[]): string;
- function getDiagnosticMessage(diagnosticKey: string, args: any[]): string;
-}
-declare module TypeScript {
- interface DiagnosticInfo {
- category: DiagnosticCategory;
- message: string;
- code: number;
- }
-}
-declare module TypeScript {
- class Errors {
- static argument(argument: string, message?: string): Error;
- static argumentOutOfRange(argument: string): Error;
- static argumentNull(argument: string): Error;
- static abstract(): Error;
- static notYetImplemented(): Error;
- static invalidOperation(message?: string): Error;
- }
-}
-declare module TypeScript {
- class Hash {
- private static FNV_BASE;
- private static FNV_PRIME;
- private static computeFnv1aCharArrayHashCode(text, start, len);
- static computeSimple31BitCharArrayHashCode(key: number[], start: number, len: number): number;
- static computeSimple31BitStringHashCode(key: string): number;
- static computeMurmur2StringHashCode(key: string, seed: number): number;
- private static primes;
- static getPrime(min: number): number;
- static expandPrime(oldSize: number): number;
- static combine(value: number, currentHash: number): number;
- }
-}
-declare module TypeScript.Collections {
- var DefaultHashTableCapacity: number;
- class HashTable<TKey, TValue> {
- private hash;
- private entries;
- private count;
- constructor(capacity: number, hash: (k: TKey) => number);
- public set(key: TKey, value: TValue): void;
- public add(key: TKey, value: TValue): void;
- public containsKey(key: TKey): boolean;
- public get(key: TKey): TValue;
- private computeHashCode(key);
- private addOrSet(key, value, throwOnExistingEntry);
- private findEntry(key, hashCode);
- private addEntry(key, value, hashCode);
- private grow();
- }
- function createHashTable<TKey, TValue>(capacity?: number, hash?: (k: TKey) => number): HashTable<TKey, TValue>;
- function identityHashCode(value: any): number;
-}
-declare module TypeScript {
- var nodeMakeDirectoryTime: number;
- var nodeCreateBufferTime: number;
- var nodeWriteFileSyncTime: number;
- enum ByteOrderMark {
- None = 0,
- Utf8 = 1,
- Utf16BigEndian = 2,
- Utf16LittleEndian = 3,
- }
- class FileInformation {
- public contents: string;
- public byteOrderMark: ByteOrderMark;
- constructor(contents: string, byteOrderMark: ByteOrderMark);
- }
- interface IEnvironment {
- supportsCodePage(): boolean;
- readFile(path: string, codepage: number): FileInformation;
- writeFile(path: string, contents: string, writeByteOrderMark: boolean): void;
- deleteFile(path: string): void;
- fileExists(path: string): boolean;
- directoryExists(path: string): boolean;
- listFiles(path: string, re?: RegExp, options?: {
- recursive?: boolean;
- }): string[];
- arguments: string[];
- standardOut: ITextWriter;
- currentDirectory(): string;
- newLine: string;
- }
- var Environment: IEnvironment;
-}
-declare module TypeScript {
- interface IIndexable<T> {
- [s: string]: T;
- }
-}
-declare module TypeScript {
- module IntegerUtilities {
- function integerDivide(numerator: number, denominator: number): number;
- function integerMultiplyLow32Bits(n1: number, n2: number): number;
- function integerMultiplyHigh32Bits(n1: number, n2: number): number;
- function isInteger(text: string): boolean;
- function isHexInteger(text: string): boolean;
- }
-}
-declare module TypeScript {
- interface Iterator<T> {
- moveNext(): boolean;
- current(): T;
- }
-}
-declare module TypeScript {
- interface ILineAndCharacter {
- line: number;
- character: number;
- }
-}
-declare module TypeScript {
- class LineMap {
- private _computeLineStarts;
- private length;
- static empty: LineMap;
- private _lineStarts;
- constructor(_computeLineStarts: () => number[], length: number);
- public toJSON(key: any): {
- lineStarts: number[];
- length: number;
- };
- public equals(other: LineMap): boolean;
- public lineStarts(): number[];
- public lineCount(): number;
- public getPosition(line: number, character: number): number;
- public getLineNumberFromPosition(position: number): number;
- public getLineStartPosition(lineNumber: number): number;
- public fillLineAndCharacterFromPosition(position: number, lineAndCharacter: ILineAndCharacter): void;
- public getLineAndCharacterFromPosition(position: number): LineAndCharacter;
- }
-}
-declare module TypeScript {
- class LineAndCharacter {
- private _line;
- private _character;
- constructor(line: number, character: number);
- public line(): number;
- public character(): number;
- }
-}
-declare module TypeScript {
- class MathPrototype {
- static max(a: number, b: number): number;
- static min(a: number, b: number): number;
- }
-}
-declare module TypeScript.Collections {
- var DefaultStringTableCapacity: number;
- class StringTable {
- private entries;
- private count;
- constructor(capacity: number);
- public addCharArray(key: number[], start: number, len: number): string;
- private findCharArrayEntry(key, start, len, hashCode);
- private addEntry(text, hashCode);
- private grow();
- private static textCharArrayEquals(text, array, start, length);
- }
- var DefaultStringTable: StringTable;
-}
-declare module TypeScript {
- class StringUtilities {
- static isString(value: any): boolean;
- static fromCharCodeArray(array: number[]): string;
- static endsWith(string: string, value: string): boolean;
- static startsWith(string: string, value: string): boolean;
- static copyTo(source: string, sourceIndex: number, destination: number[], destinationIndex: number, count: number): void;
- static repeat(value: string, count: number): string;
- static stringEquals(val1: string, val2: string): boolean;
- }
-}
-declare module TypeScript {
- class Timer {
- public startTime: number;
- public time: number;
- public start(): void;
- public end(): void;
- }
-}
-declare module TypeScript {
- enum DiagnosticCategory {
- Warning = 0,
- Error = 1,
- Message = 2,
- NoPrefix = 3,
- }
-}
-declare module TypeScript {
- var diagnosticInformationMap: IIndexable<any>;
-}
-declare module TypeScript {
- enum CharacterCodes {
- nullCharacter = 0,
- maxAsciiCharacter = 127,
- lineFeed = 10,
- carriageReturn = 13,
- lineSeparator = 8232,
- paragraphSeparator = 8233,
- nextLine = 133,
- space = 32,
- nonBreakingSpace = 160,
- enQuad = 8192,
- emQuad = 8193,
- enSpace = 8194,
- emSpace = 8195,
- threePerEmSpace = 8196,
- fourPerEmSpace = 8197,
- sixPerEmSpace = 8198,
- figureSpace = 8199,
- punctuationSpace = 8200,
- thinSpace = 8201,
- hairSpace = 8202,
- zeroWidthSpace = 8203,
- narrowNoBreakSpace = 8239,
- ideographicSpace = 12288,
- _ = 95,
- $ = 36,
- _0 = 48,
- _7 = 55,
- _9 = 57,
- a = 97,
- b = 98,
- c = 99,
- d = 100,
- e = 101,
- f = 102,
- g = 103,
- h = 104,
- i = 105,
- k = 107,
- l = 108,
- m = 109,
- n = 110,
- o = 111,
- p = 112,
- q = 113,
- r = 114,
- s = 115,
- t = 116,
- u = 117,
- v = 118,
- w = 119,
- x = 120,
- y = 121,
- z = 122,
- A = 65,
- E = 69,
- F = 70,
- X = 88,
- Z = 90,
- ampersand = 38,
- asterisk = 42,
- at = 64,
- backslash = 92,
- bar = 124,
- caret = 94,
- closeBrace = 125,
- closeBracket = 93,
- closeParen = 41,
- colon = 58,
- comma = 44,
- dot = 46,
- doubleQuote = 34,
- equals = 61,
- exclamation = 33,
- greaterThan = 62,
- lessThan = 60,
- minus = 45,
- openBrace = 123,
- openBracket = 91,
- openParen = 40,
- percent = 37,
- plus = 43,
- question = 63,
- semicolon = 59,
- singleQuote = 39,
- slash = 47,
- tilde = 126,
- backspace = 8,
- formFeed = 12,
- byteOrderMark = 65279,
- tab = 9,
- verticalTab = 11,
- }
-}
-declare module TypeScript {
- interface IScriptSnapshot {
- getText(start: number, end: number): string;
- getLength(): number;
- getLineStartPositions(): number[];
- getTextChangeRangeSinceVersion(scriptVersion: number): TextChangeRange;
- }
- module ScriptSnapshot {
- function fromString(text: string): IScriptSnapshot;
- }
-}
-declare module TypeScript {
- interface ISimpleText {
- length(): number;
- copyTo(sourceIndex: number, destination: number[], destinationIndex: number, count: number): void;
- substr(start: number, length: number, intern: boolean): string;
- subText(span: TextSpan): ISimpleText;
- charCodeAt(index: number): number;
- lineMap(): LineMap;
- }
- interface IText extends ISimpleText {
- lineCount(): number;
- lines(): ITextLine[];
- charCodeAt(position: number): number;
- getLineFromLineNumber(lineNumber: number): ITextLine;
- getLineFromPosition(position: number): ITextLine;
- getLineNumberFromPosition(position: number): number;
- getLinePosition(position: number): LineAndCharacter;
- toString(span?: TextSpan): string;
- }
-}
-declare module TypeScript {
- interface ITextLine {
- start(): number;
- end(): number;
- endIncludingLineBreak(): number;
- extent(): TextSpan;
- extentIncludingLineBreak(): TextSpan;
- toString(): string;
- lineNumber(): number;
- }
-}
-declare module TypeScript {
- module LineMap1 {
- function fromSimpleText(text: ISimpleText): LineMap;
- function fromScriptSnapshot(scriptSnapshot: IScriptSnapshot): LineMap;
- function fromString(text: string): LineMap;
- }
-}
-declare module TypeScript.TextFactory {
- function createText(value: string): IText;
-}
-declare module TypeScript.SimpleText {
- function fromString(value: string): ISimpleText;
- function fromScriptSnapshot(scriptSnapshot: IScriptSnapshot): ISimpleText;
-}
-declare module TypeScript.TextUtilities {
- interface ICharacterSequence {
- charCodeAt(index: number): number;
- length: number;
- }
- function parseLineStarts(text: ICharacterSequence): number[];
- function getLengthOfLineBreakSlow(text: ICharacterSequence, index: number, c: number): number;
- function getLengthOfLineBreak(text: ICharacterSequence, index: number): number;
- function isAnyLineBreakCharacter(c: number): boolean;
-}
-declare module TypeScript {
- class TextSpan {
- private _start;
- private _length;
- constructor(start: number, length: number);
- public start(): number;
- public length(): number;
- public end(): number;
- public isEmpty(): boolean;
- public containsPosition(position: number): boolean;
- public containsTextSpan(span: TextSpan): boolean;
- public overlapsWith(span: TextSpan): boolean;
- public overlap(span: TextSpan): TextSpan;
- public intersectsWithTextSpan(span: TextSpan): boolean;
- public intersectsWith(start: number, length: number): boolean;
- public intersectsWithPosition(position: number): boolean;
- public intersection(span: TextSpan): TextSpan;
- static fromBounds(start: number, end: number): TextSpan;
- }
-}
-declare module TypeScript {
- class TextChangeRange {
- static unchanged: TextChangeRange;
- private _span;
- private _newLength;
- constructor(span: TextSpan, newLength: number);
- public span(): TextSpan;
- public newLength(): number;
- public newSpan(): TextSpan;
- public isUnchanged(): boolean;
- static collapseChangesFromSingleVersion(changes: TextChangeRange[]): TextChangeRange;
- static collapseChangesAcrossMultipleVersions(changes: TextChangeRange[]): TextChangeRange;
- }
-}
-declare module TypeScript {
- class CharacterInfo {
- static isDecimalDigit(c: number): boolean;
- static isOctalDigit(c: number): boolean;
- static isHexDigit(c: number): boolean;
- static hexValue(c: number): number;
- static isWhitespace(ch: number): boolean;
- static isLineTerminator(ch: number): boolean;
- }
-}
-declare module TypeScript {
- enum SyntaxConstants {
- TriviaNewLineMask = 1,
- TriviaCommentMask = 2,
- TriviaFullWidthShift = 2,
- NodeDataComputed = 1,
- NodeIncrementallyUnusableMask = 2,
- NodeParsedInStrictModeMask = 4,
- NodeFullWidthShift = 3,
- IsVariableWidthKeyword = -2147483648,
- }
-}
-declare class FormattingOptions {
- public useTabs: boolean;
- public spacesPerTab: number;
- public indentSpaces: number;
- public newLineCharacter: string;
- constructor(useTabs: boolean, spacesPerTab: number, indentSpaces: number, newLineCharacter: string);
- static defaultOptions: FormattingOptions;
-}
-declare module TypeScript.Indentation {
- function columnForEndOfToken(token: ISyntaxToken, syntaxInformationMap: SyntaxInformationMap, options: FormattingOptions): number;
- function columnForStartOfToken(token: ISyntaxToken, syntaxInformationMap: SyntaxInformationMap, options: FormattingOptions): number;
- function columnForStartOfFirstTokenInLineContainingToken(token: ISyntaxToken, syntaxInformationMap: SyntaxInformationMap, options: FormattingOptions): number;
- function columnForPositionInString(input: string, position: number, options: FormattingOptions): number;
- function indentationString(column: number, options: FormattingOptions): string;
- function indentationTrivia(column: number, options: FormattingOptions): ISyntaxTrivia;
- function firstNonWhitespacePosition(value: string): number;
-}
-declare module TypeScript {
- enum LanguageVersion {
- EcmaScript3 = 0,
- EcmaScript5 = 1,
- }
-}
-declare module TypeScript {
- class ParseOptions {
- private _languageVersion;
- private _allowAutomaticSemicolonInsertion;
- constructor(languageVersion: LanguageVersion, allowAutomaticSemicolonInsertion: boolean);
- public toJSON(key: any): {
- allowAutomaticSemicolonInsertion: boolean;
- };
- public languageVersion(): LanguageVersion;
- public allowAutomaticSemicolonInsertion(): boolean;
- }
-}
-declare module TypeScript {
- class PositionedElement {
- private _parent;
- private _element;
- private _fullStart;
- constructor(parent: PositionedElement, element: ISyntaxElement, fullStart: number);
- static create(parent: PositionedElement, element: ISyntaxElement, fullStart: number): PositionedElement;
- public parent(): PositionedElement;
- public parentElement(): ISyntaxElement;
- public element(): ISyntaxElement;
- public kind(): SyntaxKind;
- public childIndex(child: ISyntaxElement): number;
- public childCount(): number;
- public childAt(index: number): PositionedElement;
- public childStart(child: ISyntaxElement): number;
- public childEnd(child: ISyntaxElement): number;
- public childStartAt(index: number): number;
- public childEndAt(index: number): number;
- public getPositionedChild(child: ISyntaxElement): PositionedElement;
- public fullStart(): number;
- public fullEnd(): number;
- public fullWidth(): number;
- public start(): number;
- public end(): number;
- public root(): PositionedNode;
- public containingNode(): PositionedNode;
- }
- class PositionedNodeOrToken extends PositionedElement {
- constructor(parent: PositionedElement, nodeOrToken: ISyntaxNodeOrToken, fullStart: number);
- public nodeOrToken(): ISyntaxNodeOrToken;
- }
- class PositionedNode extends PositionedNodeOrToken {
- constructor(parent: PositionedElement, node: SyntaxNode, fullStart: number);
- public node(): SyntaxNode;
- }
- class PositionedToken extends PositionedNodeOrToken {
- constructor(parent: PositionedElement, token: ISyntaxToken, fullStart: number);
- public token(): ISyntaxToken;
- public previousToken(includeSkippedTokens?: boolean): PositionedToken;
- public nextToken(includeSkippedTokens?: boolean): PositionedToken;
- }
- class PositionedList extends PositionedElement {
- constructor(parent: PositionedElement, list: ISyntaxList, fullStart: number);
- public list(): ISyntaxList;
- }
- class PositionedSeparatedList extends PositionedElement {
- constructor(parent: PositionedElement, list: ISeparatedSyntaxList, fullStart: number);
- public list(): ISeparatedSyntaxList;
- }
- class PositionedSkippedToken extends PositionedToken {
- private _parentToken;
- constructor(parentToken: PositionedToken, token: ISyntaxToken, fullStart: number);
- public parentToken(): PositionedToken;
- public previousToken(includeSkippedTokens?: boolean): PositionedToken;
- public nextToken(includeSkippedTokens?: boolean): PositionedToken;
- }
-}
-declare module TypeScript {
- enum SyntaxKind {
- None = 0,
- List = 1,
- SeparatedList = 2,
- TriviaList = 3,
- WhitespaceTrivia = 4,
- NewLineTrivia = 5,
- MultiLineCommentTrivia = 6,
- SingleLineCommentTrivia = 7,
- SkippedTokenTrivia = 8,
- ErrorToken = 9,
- EndOfFileToken = 10,
- IdentifierName = 11,
- RegularExpressionLiteral = 12,
- NumericLiteral = 13,
- StringLiteral = 14,
- BreakKeyword = 15,
- CaseKeyword = 16,
- CatchKeyword = 17,
- ContinueKeyword = 18,
- DebuggerKeyword = 19,
- DefaultKeyword = 20,
- DeleteKeyword = 21,
- DoKeyword = 22,
- ElseKeyword = 23,
- FalseKeyword = 24,
- FinallyKeyword = 25,
- ForKeyword = 26,
- FunctionKeyword = 27,
- IfKeyword = 28,
- InKeyword = 29,
- InstanceOfKeyword = 30,
- NewKeyword = 31,
- NullKeyword = 32,
- ReturnKeyword = 33,
- SwitchKeyword = 34,
- ThisKeyword = 35,
- ThrowKeyword = 36,
- TrueKeyword = 37,
- TryKeyword = 38,
- TypeOfKeyword = 39,
- VarKeyword = 40,
- VoidKeyword = 41,
- WhileKeyword = 42,
- WithKeyword = 43,
- ClassKeyword = 44,
- ConstKeyword = 45,
- EnumKeyword = 46,
- ExportKeyword = 47,
- ExtendsKeyword = 48,
- ImportKeyword = 49,
- SuperKeyword = 50,
- ImplementsKeyword = 51,
- InterfaceKeyword = 52,
- LetKeyword = 53,
- PackageKeyword = 54,
- PrivateKeyword = 55,
- ProtectedKeyword = 56,
- PublicKeyword = 57,
- StaticKeyword = 58,
- YieldKeyword = 59,
- AnyKeyword = 60,
- BooleanKeyword = 61,
- ConstructorKeyword = 62,
- DeclareKeyword = 63,
- GetKeyword = 64,
- ModuleKeyword = 65,
- RequireKeyword = 66,
- NumberKeyword = 67,
- SetKeyword = 68,
- StringKeyword = 69,
- OpenBraceToken = 70,
- CloseBraceToken = 71,
- OpenParenToken = 72,
- CloseParenToken = 73,
- OpenBracketToken = 74,
- CloseBracketToken = 75,
- DotToken = 76,
- DotDotDotToken = 77,
- SemicolonToken = 78,
- CommaToken = 79,
- LessThanToken = 80,
- GreaterThanToken = 81,
- LessThanEqualsToken = 82,
- GreaterThanEqualsToken = 83,
- EqualsEqualsToken = 84,
- EqualsGreaterThanToken = 85,
- ExclamationEqualsToken = 86,
- EqualsEqualsEqualsToken = 87,
- ExclamationEqualsEqualsToken = 88,
- PlusToken = 89,
- MinusToken = 90,
- AsteriskToken = 91,
- PercentToken = 92,
- PlusPlusToken = 93,
- MinusMinusToken = 94,
- LessThanLessThanToken = 95,
- GreaterThanGreaterThanToken = 96,
- GreaterThanGreaterThanGreaterThanToken = 97,
- AmpersandToken = 98,
- BarToken = 99,
- CaretToken = 100,
- ExclamationToken = 101,
- TildeToken = 102,
- AmpersandAmpersandToken = 103,
- BarBarToken = 104,
- QuestionToken = 105,
- ColonToken = 106,
- EqualsToken = 107,
- PlusEqualsToken = 108,
- MinusEqualsToken = 109,
- AsteriskEqualsToken = 110,
- PercentEqualsToken = 111,
- LessThanLessThanEqualsToken = 112,
- GreaterThanGreaterThanEqualsToken = 113,
- GreaterThanGreaterThanGreaterThanEqualsToken = 114,
- AmpersandEqualsToken = 115,
- BarEqualsToken = 116,
- CaretEqualsToken = 117,
- SlashToken = 118,
- SlashEqualsToken = 119,
- SourceUnit = 120,
- QualifiedName = 121,
- ObjectType = 122,
- FunctionType = 123,
- ArrayType = 124,
- ConstructorType = 125,
- GenericType = 126,
- TypeQuery = 127,
- InterfaceDeclaration = 128,
- FunctionDeclaration = 129,
- ModuleDeclaration = 130,
- ClassDeclaration = 131,
- EnumDeclaration = 132,
- ImportDeclaration = 133,
- ExportAssignment = 134,
- MemberFunctionDeclaration = 135,
- MemberVariableDeclaration = 136,
- ConstructorDeclaration = 137,
- IndexMemberDeclaration = 138,
- GetAccessor = 139,
- SetAccessor = 140,
- PropertySignature = 141,
- CallSignature = 142,
- ConstructSignature = 143,
- IndexSignature = 144,
- MethodSignature = 145,
- Block = 146,
- IfStatement = 147,
- VariableStatement = 148,
- ExpressionStatement = 149,
- ReturnStatement = 150,
- SwitchStatement = 151,
- BreakStatement = 152,
- ContinueStatement = 153,
- ForStatement = 154,
- ForInStatement = 155,
- EmptyStatement = 156,
- ThrowStatement = 157,
- WhileStatement = 158,
- TryStatement = 159,
- LabeledStatement = 160,
- DoStatement = 161,
- DebuggerStatement = 162,
- WithStatement = 163,
- PlusExpression = 164,
- NegateExpression = 165,
- BitwiseNotExpression = 166,
- LogicalNotExpression = 167,
- PreIncrementExpression = 168,
- PreDecrementExpression = 169,
- DeleteExpression = 170,
- TypeOfExpression = 171,
- VoidExpression = 172,
- CommaExpression = 173,
- AssignmentExpression = 174,
- AddAssignmentExpression = 175,
- SubtractAssignmentExpression = 176,
- MultiplyAssignmentExpression = 177,
- DivideAssignmentExpression = 178,
- ModuloAssignmentExpression = 179,
- AndAssignmentExpression = 180,
- ExclusiveOrAssignmentExpression = 181,
- OrAssignmentExpression = 182,
- LeftShiftAssignmentExpression = 183,
- SignedRightShiftAssignmentExpression = 184,
- UnsignedRightShiftAssignmentExpression = 185,
- ConditionalExpression = 186,
- LogicalOrExpression = 187,
- LogicalAndExpression = 188,
- BitwiseOrExpression = 189,
- BitwiseExclusiveOrExpression = 190,
- BitwiseAndExpression = 191,
- EqualsWithTypeConversionExpression = 192,
- NotEqualsWithTypeConversionExpression = 193,
- EqualsExpression = 194,
- NotEqualsExpression = 195,
- LessThanExpression = 196,
- GreaterThanExpression = 197,
- LessThanOrEqualExpression = 198,
- GreaterThanOrEqualExpression = 199,
- InstanceOfExpression = 200,
- InExpression = 201,
- LeftShiftExpression = 202,
- SignedRightShiftExpression = 203,
- UnsignedRightShiftExpression = 204,
- MultiplyExpression = 205,
- DivideExpression = 206,
- ModuloExpression = 207,
- AddExpression = 208,
- SubtractExpression = 209,
- PostIncrementExpression = 210,
- PostDecrementExpression = 211,
- MemberAccessExpression = 212,
- InvocationExpression = 213,
- ArrayLiteralExpression = 214,
- ObjectLiteralExpression = 215,
- ObjectCreationExpression = 216,
- ParenthesizedExpression = 217,
- ParenthesizedArrowFunctionExpression = 218,
- SimpleArrowFunctionExpression = 219,
- CastExpression = 220,
- ElementAccessExpression = 221,
- FunctionExpression = 222,
- OmittedExpression = 223,
- VariableDeclaration = 224,
- VariableDeclarator = 225,
- ArgumentList = 226,
- ParameterList = 227,
- TypeArgumentList = 228,
- TypeParameterList = 229,
- ExtendsHeritageClause = 230,
- ImplementsHeritageClause = 231,
- EqualsValueClause = 232,
- CaseSwitchClause = 233,
- DefaultSwitchClause = 234,
- ElseClause = 235,
- CatchClause = 236,
- FinallyClause = 237,
- TypeParameter = 238,
- Constraint = 239,
- SimplePropertyAssignment = 240,
- FunctionPropertyAssignment = 241,
- Parameter = 242,
- EnumElement = 243,
- TypeAnnotation = 244,
- ExternalModuleReference = 245,
- ModuleNameModuleReference = 246,
- Last = 246,
- FirstStandardKeyword = 15,
- LastStandardKeyword = 43,
- FirstFutureReservedKeyword = 44,
- LastFutureReservedKeyword = 50,
- FirstFutureReservedStrictKeyword = 51,
- LastFutureReservedStrictKeyword = 59,
- FirstTypeScriptKeyword = 60,
- LastTypeScriptKeyword = 69,
- FirstKeyword = 15,
- LastKeyword = 69,
- FirstToken = 9,
- LastToken = 119,
- FirstPunctuation = 70,
- LastPunctuation = 119,
- FirstFixedWidth = 15,
- LastFixedWidth = 119,
- FirstTrivia = 4,
- LastTrivia = 8,
- }
-}
-declare module TypeScript.SyntaxFacts {
- function getTokenKind(text: string): SyntaxKind;
- function getText(kind: SyntaxKind): string;
- function isTokenKind(kind: SyntaxKind): boolean;
- function isAnyKeyword(kind: SyntaxKind): boolean;
- function isStandardKeyword(kind: SyntaxKind): boolean;
- function isFutureReservedKeyword(kind: SyntaxKind): boolean;
- function isFutureReservedStrictKeyword(kind: SyntaxKind): boolean;
- function isAnyPunctuation(kind: SyntaxKind): boolean;
- function isPrefixUnaryExpressionOperatorToken(tokenKind: SyntaxKind): boolean;
- function isBinaryExpressionOperatorToken(tokenKind: SyntaxKind): boolean;
- function getPrefixUnaryExpressionFromOperatorToken(tokenKind: SyntaxKind): SyntaxKind;
- function getPostfixUnaryExpressionFromOperatorToken(tokenKind: SyntaxKind): SyntaxKind;
- function getBinaryExpressionFromOperatorToken(tokenKind: SyntaxKind): SyntaxKind;
- function getOperatorTokenFromBinaryExpression(tokenKind: SyntaxKind): SyntaxKind;
- function isAnyDivideToken(kind: SyntaxKind): boolean;
- function isAnyDivideOrRegularExpressionToken(kind: SyntaxKind): boolean;
-}
-declare module TypeScript {
- class Scanner implements ISlidingWindowSource {
- private slidingWindow;
- private fileName;
- private text;
- private _languageVersion;
- constructor(fileName: string, text: ISimpleText, languageVersion: LanguageVersion, window?: number[]);
- public languageVersion(): LanguageVersion;
- public fetchMoreItems(argument: any, sourceIndex: number, window: number[], destinationIndex: number, spaceAvailable: number): number;
- private currentCharCode();
- public absoluteIndex(): number;
- public setAbsoluteIndex(index: number): void;
- public scan(diagnostics: Diagnostic[], allowRegularExpression: boolean): ISyntaxToken;
- private createToken(fullStart, leadingTriviaInfo, start, kind, end, fullEnd, trailingTriviaInfo, isVariableWidthKeyword);
- private static triviaWindow;
- static scanTrivia(text: ISimpleText, start: number, length: number, isTrailing: boolean): ISyntaxTriviaList;
- private scanTrivia(underlyingText, underlyingTextStart, isTrailing);
- private scanTriviaInfo(diagnostics, isTrailing);
- private isNewLineCharacter(ch);
- private scanWhitespaceTrivia(underlyingText, underlyingTextStart);
- private scanSingleLineCommentTrivia(underlyingText, underlyingTextStart);
- private scanSingleLineCommentTriviaLength();
- private scanMultiLineCommentTrivia(underlyingText, underlyingTextStart);
- private scanMultiLineCommentTriviaLength(diagnostics);
- private scanLineTerminatorSequenceTrivia(ch);
- private scanLineTerminatorSequenceLength(ch);
- private scanSyntaxToken(diagnostics, allowRegularExpression);
- private isIdentifierStart(interpretedChar);
- private isIdentifierPart(interpretedChar);
- private tryFastScanIdentifierOrKeyword(firstCharacter);
- private slowScanIdentifierOrKeyword(diagnostics);
- private scanNumericLiteral(diagnostics);
- private isOctalNumericLiteral();
- private scanOctalNumericLiteral(diagnostics);
- private scanDecimalDigits();
- private scanDecimalNumericLiteral();
- private scanHexNumericLiteral();
- private isHexNumericLiteral();
- private advanceAndSetTokenKind(kind);
- private scanLessThanToken();
- private scanBarToken();
- private scanCaretToken();
- private scanAmpersandToken();
- private scanPercentToken();
- private scanMinusToken();
- private scanPlusToken();
- private scanAsteriskToken();
- private scanEqualsToken();
- private isDotPrefixedNumericLiteral();
- private scanDotToken(diagnostics);
- private scanSlashToken(allowRegularExpression);
- private tryScanRegularExpressionToken();
- private scanExclamationToken();
- private scanDefaultCharacter(character, diagnostics);
- private getErrorMessageText(text);
- private skipEscapeSequence(diagnostics);
- private scanStringLiteral(diagnostics);
- private isUnicodeEscape(character);
- private peekCharOrUnicodeEscape();
- private peekUnicodeOrHexEscape();
- private scanCharOrUnicodeEscape(errors);
- private scanUnicodeOrHexEscape(errors);
- public substring(start: number, end: number, intern: boolean): string;
- private createIllegalEscapeDiagnostic(start, end);
- static isValidIdentifier(text: ISimpleText, languageVersion: LanguageVersion): boolean;
- }
-}
-declare module TypeScript {
- class ScannerUtilities {
- static identifierKind(array: number[], startIndex: number, length: number): SyntaxKind;
- }
-}
-declare module TypeScript {
- interface ISeparatedSyntaxList extends ISyntaxElement {
- childAt(index: number): ISyntaxNodeOrToken;
- toArray(): ISyntaxNodeOrToken[];
- toNonSeparatorArray(): ISyntaxNodeOrToken[];
- separatorCount(): number;
- separatorAt(index: number): ISyntaxToken;
- nonSeparatorCount(): number;
- nonSeparatorAt(index: number): ISyntaxNodeOrToken;
- insertChildrenInto(array: ISyntaxElement[], index: number): void;
- }
-}
-declare module TypeScript.Syntax {
- var emptySeparatedList: ISeparatedSyntaxList;
- function separatedList(nodes: ISyntaxNodeOrToken[]): ISeparatedSyntaxList;
-}
-declare module TypeScript {
- interface ISlidingWindowSource {
- fetchMoreItems(argument: any, sourceIndex: number, window: any[], destinationIndex: number, spaceAvailable: number): number;
- }
- class SlidingWindow {
- private source;
- public window: any[];
- private defaultValue;
- private sourceLength;
- public windowCount: number;
- public windowAbsoluteStartIndex: number;
- public currentRelativeItemIndex: number;
- private _pinCount;
- private firstPinnedAbsoluteIndex;
- constructor(source: ISlidingWindowSource, window: any[], defaultValue: any, sourceLength?: number);
- private windowAbsoluteEndIndex();
- private addMoreItemsToWindow(argument);
- private tryShiftOrGrowWindow();
- public absoluteIndex(): number;
- public isAtEndOfSource(): boolean;
- public getAndPinAbsoluteIndex(): number;
- public releaseAndUnpinAbsoluteIndex(absoluteIndex: number): void;
- public rewindToPinnedIndex(absoluteIndex: number): void;
- public currentItem(argument: any): any;
- public peekItemN(n: number): any;
- public moveToNextItem(): void;
- public disgardAllItemsFromCurrentIndexOnwards(): void;
- public setAbsoluteIndex(absoluteIndex: number): void;
- public pinCount(): number;
- }
-}
-declare module TypeScript {
-}
-declare module TypeScript.Syntax {
- function emptySourceUnit(): SourceUnitSyntax;
- function getStandaloneExpression(positionedToken: PositionedToken): PositionedNodeOrToken;
- function isInModuleOrTypeContext(positionedToken: PositionedToken): boolean;
- function isInTypeOnlyContext(positionedToken: PositionedToken): boolean;
- function childOffset(parent: ISyntaxElement, child: ISyntaxElement): number;
- function childOffsetAt(parent: ISyntaxElement, index: number): number;
- function childIndex(parent: ISyntaxElement, child: ISyntaxElement): number;
- function nodeStructuralEquals(node1: SyntaxNode, node2: SyntaxNode): boolean;
- function nodeOrTokenStructuralEquals(node1: ISyntaxNodeOrToken, node2: ISyntaxNodeOrToken): boolean;
- function tokenStructuralEquals(token1: ISyntaxToken, token2: ISyntaxToken): boolean;
- function triviaListStructuralEquals(triviaList1: ISyntaxTriviaList, triviaList2: ISyntaxTriviaList): boolean;
- function triviaStructuralEquals(trivia1: ISyntaxTrivia, trivia2: ISyntaxTrivia): boolean;
- function listStructuralEquals(list1: ISyntaxList, list2: ISyntaxList): boolean;
- function separatedListStructuralEquals(list1: ISeparatedSyntaxList, list2: ISeparatedSyntaxList): boolean;
- function elementStructuralEquals(element1: ISyntaxElement, element2: ISyntaxElement): boolean;
- function identifierName(text: string, info?: ITokenInfo): ISyntaxToken;
- function trueExpression(): IUnaryExpressionSyntax;
- function falseExpression(): IUnaryExpressionSyntax;
- function numericLiteralExpression(text: string): IUnaryExpressionSyntax;
- function stringLiteralExpression(text: string): IUnaryExpressionSyntax;
- function isSuperInvocationExpression(node: IExpressionSyntax): boolean;
- function isSuperInvocationExpressionStatement(node: SyntaxNode): boolean;
- function isSuperMemberAccessExpression(node: IExpressionSyntax): boolean;
- function isSuperMemberAccessInvocationExpression(node: SyntaxNode): boolean;
- function assignmentExpression(left: IExpressionSyntax, token: ISyntaxToken, right: IExpressionSyntax): BinaryExpressionSyntax;
- function nodeHasSkippedOrMissingTokens(node: SyntaxNode): boolean;
- function isUnterminatedStringLiteral(token: ISyntaxToken): boolean;
- function isUnterminatedMultilineCommentTrivia(trivia: ISyntaxTrivia): boolean;
- function isEntirelyInsideCommentTrivia(trivia: ISyntaxTrivia, fullStart: number, position: number): boolean;
- function isEntirelyInsideComment(sourceUnit: SourceUnitSyntax, position: number): boolean;
- function isEntirelyInStringOrRegularExpressionLiteral(sourceUnit: SourceUnitSyntax, position: number): boolean;
- function findSkippedTokenInLeadingTriviaList(positionedToken: PositionedToken, position: number): PositionedSkippedToken;
- function findSkippedTokenInTrailingTriviaList(positionedToken: PositionedToken, position: number): PositionedSkippedToken;
- function findSkippedTokenInPositionedToken(positionedToken: PositionedToken, position: number): PositionedSkippedToken;
- function findSkippedTokenOnLeft(positionedToken: PositionedToken, position: number): PositionedSkippedToken;
- function getAncestorOfKind(positionedToken: PositionedElement, kind: SyntaxKind): PositionedElement;
- function hasAncestorOfKind(positionedToken: PositionedElement, kind: SyntaxKind): boolean;
- function isIntegerLiteral(expression: IExpressionSyntax): boolean;
-}
-declare module TypeScript {
- interface ISyntaxElement {
- kind(): SyntaxKind;
- isNode(): boolean;
- isToken(): boolean;
- isList(): boolean;
- isSeparatedList(): boolean;
- childCount(): number;
- childAt(index: number): ISyntaxElement;
- isTypeScriptSpecific(): boolean;
- isIncrementallyUnusable(): boolean;
- fullWidth(): number;
- width(): number;
- fullText(): string;
- leadingTrivia(): ISyntaxTriviaList;
- trailingTrivia(): ISyntaxTriviaList;
- leadingTriviaWidth(): number;
- trailingTriviaWidth(): number;
- firstToken(): ISyntaxToken;
- lastToken(): ISyntaxToken;
- collectTextElements(elements: string[]): void;
- }
- interface ISyntaxNode extends ISyntaxNodeOrToken {
- }
- interface IModuleReferenceSyntax extends ISyntaxNode {
- isModuleReference(): boolean;
- }
- interface IModuleElementSyntax extends ISyntaxNode {
- }
- interface IStatementSyntax extends IModuleElementSyntax {
- isStatement(): boolean;
- }
- interface IIterationStatementSyntax extends IStatementSyntax {
- isIterationStatement(): boolean;
- }
- interface ITypeMemberSyntax extends ISyntaxNode {
- }
- interface IClassElementSyntax extends ISyntaxNode {
- }
- interface IMemberDeclarationSyntax extends IClassElementSyntax {
- }
- interface IPropertyAssignmentSyntax extends IClassElementSyntax {
- }
- interface ISwitchClauseSyntax extends ISyntaxNode {
- isSwitchClause(): boolean;
- statements: ISyntaxList;
- }
- interface IExpressionSyntax extends ISyntaxNodeOrToken {
- isExpression(): boolean;
- withLeadingTrivia(trivia: ISyntaxTriviaList): IExpressionSyntax;
- withTrailingTrivia(trivia: ISyntaxTriviaList): IExpressionSyntax;
- }
- interface IUnaryExpressionSyntax extends IExpressionSyntax {
- isUnaryExpression(): boolean;
- }
- interface IArrowFunctionExpressionSyntax extends IUnaryExpressionSyntax {
- isArrowFunctionExpression(): boolean;
- equalsGreaterThanToken: ISyntaxToken;
- block: BlockSyntax;
- expression: IExpressionSyntax;
- }
- interface IPostfixExpressionSyntax extends IUnaryExpressionSyntax {
- isPostfixExpression(): boolean;
- }
- interface IMemberExpressionSyntax extends IPostfixExpressionSyntax {
- isMemberExpression(): boolean;
- }
- interface IPrimaryExpressionSyntax extends IMemberExpressionSyntax {
- isPrimaryExpression(): boolean;
- }
- interface ITypeSyntax extends ISyntaxNodeOrToken {
- }
- interface INameSyntax extends ITypeSyntax {
- }
-}
-declare module TypeScript.Syntax {
- interface IFactory {
- sourceUnit(moduleElements: ISyntaxList, endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- externalModuleReference(requireKeyword: ISyntaxToken, openParenToken: ISyntaxToken, stringLiteral: ISyntaxToken, closeParenToken: ISyntaxToken): ExternalModuleReferenceSyntax;
- moduleNameModuleReference(moduleName: INameSyntax): ModuleNameModuleReferenceSyntax;
- importDeclaration(modifiers: ISyntaxList, importKeyword: ISyntaxToken, identifier: ISyntaxToken, equalsToken: ISyntaxToken, moduleReference: IModuleReferenceSyntax, semicolonToken: ISyntaxToken): ImportDeclarationSyntax;
- exportAssignment(exportKeyword: ISyntaxToken, equalsToken: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ExportAssignmentSyntax;
- classDeclaration(modifiers: ISyntaxList, classKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, openBraceToken: ISyntaxToken, classElements: ISyntaxList, closeBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- interfaceDeclaration(modifiers: ISyntaxList, interfaceKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, body: ObjectTypeSyntax): InterfaceDeclarationSyntax;
- heritageClause(kind: SyntaxKind, extendsOrImplementsKeyword: ISyntaxToken, typeNames: ISeparatedSyntaxList): HeritageClauseSyntax;
- moduleDeclaration(modifiers: ISyntaxList, moduleKeyword: ISyntaxToken, name: INameSyntax, stringLiteral: ISyntaxToken, openBraceToken: ISyntaxToken, moduleElements: ISyntaxList, closeBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- functionDeclaration(modifiers: ISyntaxList, functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): FunctionDeclarationSyntax;
- variableStatement(modifiers: ISyntaxList, variableDeclaration: VariableDeclarationSyntax, semicolonToken: ISyntaxToken): VariableStatementSyntax;
- variableDeclaration(varKeyword: ISyntaxToken, variableDeclarators: ISeparatedSyntaxList): VariableDeclarationSyntax;
- variableDeclarator(propertyName: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): VariableDeclaratorSyntax;
- equalsValueClause(equalsToken: ISyntaxToken, value: IExpressionSyntax): EqualsValueClauseSyntax;
- prefixUnaryExpression(kind: SyntaxKind, operatorToken: ISyntaxToken, operand: IUnaryExpressionSyntax): PrefixUnaryExpressionSyntax;
- arrayLiteralExpression(openBracketToken: ISyntaxToken, expressions: ISeparatedSyntaxList, closeBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- omittedExpression(): OmittedExpressionSyntax;
- parenthesizedExpression(openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken): ParenthesizedExpressionSyntax;
- simpleArrowFunctionExpression(identifier: ISyntaxToken, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): SimpleArrowFunctionExpressionSyntax;
- parenthesizedArrowFunctionExpression(callSignature: CallSignatureSyntax, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- qualifiedName(left: INameSyntax, dotToken: ISyntaxToken, right: ISyntaxToken): QualifiedNameSyntax;
- typeArgumentList(lessThanToken: ISyntaxToken, typeArguments: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeArgumentListSyntax;
- constructorType(newKeyword: ISyntaxToken, typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): ConstructorTypeSyntax;
- functionType(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): FunctionTypeSyntax;
- objectType(openBraceToken: ISyntaxToken, typeMembers: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectTypeSyntax;
- arrayType(type: ITypeSyntax, openBracketToken: ISyntaxToken, closeBracketToken: ISyntaxToken): ArrayTypeSyntax;
- genericType(name: INameSyntax, typeArgumentList: TypeArgumentListSyntax): GenericTypeSyntax;
- typeQuery(typeOfKeyword: ISyntaxToken, name: INameSyntax): TypeQuerySyntax;
- typeAnnotation(colonToken: ISyntaxToken, type: ITypeSyntax): TypeAnnotationSyntax;
- block(openBraceToken: ISyntaxToken, statements: ISyntaxList, closeBraceToken: ISyntaxToken): BlockSyntax;
- parameter(dotDotDotToken: ISyntaxToken, modifiers: ISyntaxList, identifier: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): ParameterSyntax;
- memberAccessExpression(expression: IExpressionSyntax, dotToken: ISyntaxToken, name: ISyntaxToken): MemberAccessExpressionSyntax;
- postfixUnaryExpression(kind: SyntaxKind, operand: IMemberExpressionSyntax, operatorToken: ISyntaxToken): PostfixUnaryExpressionSyntax;
- elementAccessExpression(expression: IExpressionSyntax, openBracketToken: ISyntaxToken, argumentExpression: IExpressionSyntax, closeBracketToken: ISyntaxToken): ElementAccessExpressionSyntax;
- invocationExpression(expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): InvocationExpressionSyntax;
- argumentList(typeArgumentList: TypeArgumentListSyntax, openParenToken: ISyntaxToken, arguments: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ArgumentListSyntax;
- binaryExpression(kind: SyntaxKind, left: IExpressionSyntax, operatorToken: ISyntaxToken, right: IExpressionSyntax): BinaryExpressionSyntax;
- conditionalExpression(condition: IExpressionSyntax, questionToken: ISyntaxToken, whenTrue: IExpressionSyntax, colonToken: ISyntaxToken, whenFalse: IExpressionSyntax): ConditionalExpressionSyntax;
- constructSignature(newKeyword: ISyntaxToken, callSignature: CallSignatureSyntax): ConstructSignatureSyntax;
- methodSignature(propertyName: ISyntaxToken, questionToken: ISyntaxToken, callSignature: CallSignatureSyntax): MethodSignatureSyntax;
- indexSignature(openBracketToken: ISyntaxToken, parameter: ParameterSyntax, closeBracketToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): IndexSignatureSyntax;
- propertySignature(propertyName: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): PropertySignatureSyntax;
- callSignature(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax): CallSignatureSyntax;
- parameterList(openParenToken: ISyntaxToken, parameters: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ParameterListSyntax;
- typeParameterList(lessThanToken: ISyntaxToken, typeParameters: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeParameterListSyntax;
- typeParameter(identifier: ISyntaxToken, constraint: ConstraintSyntax): TypeParameterSyntax;
- constraint(extendsKeyword: ISyntaxToken, type: ITypeSyntax): ConstraintSyntax;
- elseClause(elseKeyword: ISyntaxToken, statement: IStatementSyntax): ElseClauseSyntax;
- ifStatement(ifKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, elseClause: ElseClauseSyntax): IfStatementSyntax;
- expressionStatement(expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ExpressionStatementSyntax;
- constructorDeclaration(modifiers: ISyntaxList, constructorKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): ConstructorDeclarationSyntax;
- memberFunctionDeclaration(modifiers: ISyntaxList, propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): MemberFunctionDeclarationSyntax;
- getAccessor(modifiers: ISyntaxList, getKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax, block: BlockSyntax): GetAccessorSyntax;
- setAccessor(modifiers: ISyntaxList, setKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax): SetAccessorSyntax;
- memberVariableDeclaration(modifiers: ISyntaxList, variableDeclarator: VariableDeclaratorSyntax, semicolonToken: ISyntaxToken): MemberVariableDeclarationSyntax;
- indexMemberDeclaration(modifiers: ISyntaxList, indexSignature: IndexSignatureSyntax, semicolonToken: ISyntaxToken): IndexMemberDeclarationSyntax;
- throwStatement(throwKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ThrowStatementSyntax;
- returnStatement(returnKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ReturnStatementSyntax;
- objectCreationExpression(newKeyword: ISyntaxToken, expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): ObjectCreationExpressionSyntax;
- switchStatement(switchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, openBraceToken: ISyntaxToken, switchClauses: ISyntaxList, closeBraceToken: ISyntaxToken): SwitchStatementSyntax;
- caseSwitchClause(caseKeyword: ISyntaxToken, expression: IExpressionSyntax, colonToken: ISyntaxToken, statements: ISyntaxList): CaseSwitchClauseSyntax;
- defaultSwitchClause(defaultKeyword: ISyntaxToken, colonToken: ISyntaxToken, statements: ISyntaxList): DefaultSwitchClauseSyntax;
- breakStatement(breakKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): BreakStatementSyntax;
- continueStatement(continueKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ContinueStatementSyntax;
- forStatement(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, initializer: IExpressionSyntax, firstSemicolonToken: ISyntaxToken, condition: IExpressionSyntax, secondSemicolonToken: ISyntaxToken, incrementor: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForStatementSyntax;
- forInStatement(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, left: IExpressionSyntax, inKeyword: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForInStatementSyntax;
- whileStatement(whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WhileStatementSyntax;
- withStatement(withKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WithStatementSyntax;
- enumDeclaration(modifiers: ISyntaxList, enumKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, enumElements: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- enumElement(propertyName: ISyntaxToken, equalsValueClause: EqualsValueClauseSyntax): EnumElementSyntax;
- castExpression(lessThanToken: ISyntaxToken, type: ITypeSyntax, greaterThanToken: ISyntaxToken, expression: IUnaryExpressionSyntax): CastExpressionSyntax;
- objectLiteralExpression(openBraceToken: ISyntaxToken, propertyAssignments: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- simplePropertyAssignment(propertyName: ISyntaxToken, colonToken: ISyntaxToken, expression: IExpressionSyntax): SimplePropertyAssignmentSyntax;
- functionPropertyAssignment(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionPropertyAssignmentSyntax;
- functionExpression(functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionExpressionSyntax;
- emptyStatement(semicolonToken: ISyntaxToken): EmptyStatementSyntax;
- tryStatement(tryKeyword: ISyntaxToken, block: BlockSyntax, catchClause: CatchClauseSyntax, finallyClause: FinallyClauseSyntax): TryStatementSyntax;
- catchClause(catchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, identifier: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, closeParenToken: ISyntaxToken, block: BlockSyntax): CatchClauseSyntax;
- finallyClause(finallyKeyword: ISyntaxToken, block: BlockSyntax): FinallyClauseSyntax;
- labeledStatement(identifier: ISyntaxToken, colonToken: ISyntaxToken, statement: IStatementSyntax): LabeledStatementSyntax;
- doStatement(doKeyword: ISyntaxToken, statement: IStatementSyntax, whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, semicolonToken: ISyntaxToken): DoStatementSyntax;
- typeOfExpression(typeOfKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): TypeOfExpressionSyntax;
- deleteExpression(deleteKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): DeleteExpressionSyntax;
- voidExpression(voidKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): VoidExpressionSyntax;
- debuggerStatement(debuggerKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): DebuggerStatementSyntax;
- }
- class NormalModeFactory implements IFactory {
- public sourceUnit(moduleElements: ISyntaxList, endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- public externalModuleReference(requireKeyword: ISyntaxToken, openParenToken: ISyntaxToken, stringLiteral: ISyntaxToken, closeParenToken: ISyntaxToken): ExternalModuleReferenceSyntax;
- public moduleNameModuleReference(moduleName: INameSyntax): ModuleNameModuleReferenceSyntax;
- public importDeclaration(modifiers: ISyntaxList, importKeyword: ISyntaxToken, identifier: ISyntaxToken, equalsToken: ISyntaxToken, moduleReference: IModuleReferenceSyntax, semicolonToken: ISyntaxToken): ImportDeclarationSyntax;
- public exportAssignment(exportKeyword: ISyntaxToken, equalsToken: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ExportAssignmentSyntax;
- public classDeclaration(modifiers: ISyntaxList, classKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, openBraceToken: ISyntaxToken, classElements: ISyntaxList, closeBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- public interfaceDeclaration(modifiers: ISyntaxList, interfaceKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, body: ObjectTypeSyntax): InterfaceDeclarationSyntax;
- public heritageClause(kind: SyntaxKind, extendsOrImplementsKeyword: ISyntaxToken, typeNames: ISeparatedSyntaxList): HeritageClauseSyntax;
- public moduleDeclaration(modifiers: ISyntaxList, moduleKeyword: ISyntaxToken, name: INameSyntax, stringLiteral: ISyntaxToken, openBraceToken: ISyntaxToken, moduleElements: ISyntaxList, closeBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- public functionDeclaration(modifiers: ISyntaxList, functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): FunctionDeclarationSyntax;
- public variableStatement(modifiers: ISyntaxList, variableDeclaration: VariableDeclarationSyntax, semicolonToken: ISyntaxToken): VariableStatementSyntax;
- public variableDeclaration(varKeyword: ISyntaxToken, variableDeclarators: ISeparatedSyntaxList): VariableDeclarationSyntax;
- public variableDeclarator(propertyName: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): VariableDeclaratorSyntax;
- public equalsValueClause(equalsToken: ISyntaxToken, value: IExpressionSyntax): EqualsValueClauseSyntax;
- public prefixUnaryExpression(kind: SyntaxKind, operatorToken: ISyntaxToken, operand: IUnaryExpressionSyntax): PrefixUnaryExpressionSyntax;
- public arrayLiteralExpression(openBracketToken: ISyntaxToken, expressions: ISeparatedSyntaxList, closeBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- public omittedExpression(): OmittedExpressionSyntax;
- public parenthesizedExpression(openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken): ParenthesizedExpressionSyntax;
- public simpleArrowFunctionExpression(identifier: ISyntaxToken, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): SimpleArrowFunctionExpressionSyntax;
- public parenthesizedArrowFunctionExpression(callSignature: CallSignatureSyntax, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- public qualifiedName(left: INameSyntax, dotToken: ISyntaxToken, right: ISyntaxToken): QualifiedNameSyntax;
- public typeArgumentList(lessThanToken: ISyntaxToken, typeArguments: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeArgumentListSyntax;
- public constructorType(newKeyword: ISyntaxToken, typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): ConstructorTypeSyntax;
- public functionType(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): FunctionTypeSyntax;
- public objectType(openBraceToken: ISyntaxToken, typeMembers: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectTypeSyntax;
- public arrayType(type: ITypeSyntax, openBracketToken: ISyntaxToken, closeBracketToken: ISyntaxToken): ArrayTypeSyntax;
- public genericType(name: INameSyntax, typeArgumentList: TypeArgumentListSyntax): GenericTypeSyntax;
- public typeQuery(typeOfKeyword: ISyntaxToken, name: INameSyntax): TypeQuerySyntax;
- public typeAnnotation(colonToken: ISyntaxToken, type: ITypeSyntax): TypeAnnotationSyntax;
- public block(openBraceToken: ISyntaxToken, statements: ISyntaxList, closeBraceToken: ISyntaxToken): BlockSyntax;
- public parameter(dotDotDotToken: ISyntaxToken, modifiers: ISyntaxList, identifier: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): ParameterSyntax;
- public memberAccessExpression(expression: IExpressionSyntax, dotToken: ISyntaxToken, name: ISyntaxToken): MemberAccessExpressionSyntax;
- public postfixUnaryExpression(kind: SyntaxKind, operand: IMemberExpressionSyntax, operatorToken: ISyntaxToken): PostfixUnaryExpressionSyntax;
- public elementAccessExpression(expression: IExpressionSyntax, openBracketToken: ISyntaxToken, argumentExpression: IExpressionSyntax, closeBracketToken: ISyntaxToken): ElementAccessExpressionSyntax;
- public invocationExpression(expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): InvocationExpressionSyntax;
- public argumentList(typeArgumentList: TypeArgumentListSyntax, openParenToken: ISyntaxToken, _arguments: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ArgumentListSyntax;
- public binaryExpression(kind: SyntaxKind, left: IExpressionSyntax, operatorToken: ISyntaxToken, right: IExpressionSyntax): BinaryExpressionSyntax;
- public conditionalExpression(condition: IExpressionSyntax, questionToken: ISyntaxToken, whenTrue: IExpressionSyntax, colonToken: ISyntaxToken, whenFalse: IExpressionSyntax): ConditionalExpressionSyntax;
- public constructSignature(newKeyword: ISyntaxToken, callSignature: CallSignatureSyntax): ConstructSignatureSyntax;
- public methodSignature(propertyName: ISyntaxToken, questionToken: ISyntaxToken, callSignature: CallSignatureSyntax): MethodSignatureSyntax;
- public indexSignature(openBracketToken: ISyntaxToken, parameter: ParameterSyntax, closeBracketToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): IndexSignatureSyntax;
- public propertySignature(propertyName: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): PropertySignatureSyntax;
- public callSignature(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax): CallSignatureSyntax;
- public parameterList(openParenToken: ISyntaxToken, parameters: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ParameterListSyntax;
- public typeParameterList(lessThanToken: ISyntaxToken, typeParameters: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeParameterListSyntax;
- public typeParameter(identifier: ISyntaxToken, constraint: ConstraintSyntax): TypeParameterSyntax;
- public constraint(extendsKeyword: ISyntaxToken, type: ITypeSyntax): ConstraintSyntax;
- public elseClause(elseKeyword: ISyntaxToken, statement: IStatementSyntax): ElseClauseSyntax;
- public ifStatement(ifKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, elseClause: ElseClauseSyntax): IfStatementSyntax;
- public expressionStatement(expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ExpressionStatementSyntax;
- public constructorDeclaration(modifiers: ISyntaxList, constructorKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): ConstructorDeclarationSyntax;
- public memberFunctionDeclaration(modifiers: ISyntaxList, propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): MemberFunctionDeclarationSyntax;
- public getAccessor(modifiers: ISyntaxList, getKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax, block: BlockSyntax): GetAccessorSyntax;
- public setAccessor(modifiers: ISyntaxList, setKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax): SetAccessorSyntax;
- public memberVariableDeclaration(modifiers: ISyntaxList, variableDeclarator: VariableDeclaratorSyntax, semicolonToken: ISyntaxToken): MemberVariableDeclarationSyntax;
- public indexMemberDeclaration(modifiers: ISyntaxList, indexSignature: IndexSignatureSyntax, semicolonToken: ISyntaxToken): IndexMemberDeclarationSyntax;
- public throwStatement(throwKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ThrowStatementSyntax;
- public returnStatement(returnKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ReturnStatementSyntax;
- public objectCreationExpression(newKeyword: ISyntaxToken, expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): ObjectCreationExpressionSyntax;
- public switchStatement(switchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, openBraceToken: ISyntaxToken, switchClauses: ISyntaxList, closeBraceToken: ISyntaxToken): SwitchStatementSyntax;
- public caseSwitchClause(caseKeyword: ISyntaxToken, expression: IExpressionSyntax, colonToken: ISyntaxToken, statements: ISyntaxList): CaseSwitchClauseSyntax;
- public defaultSwitchClause(defaultKeyword: ISyntaxToken, colonToken: ISyntaxToken, statements: ISyntaxList): DefaultSwitchClauseSyntax;
- public breakStatement(breakKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): BreakStatementSyntax;
- public continueStatement(continueKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ContinueStatementSyntax;
- public forStatement(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, initializer: IExpressionSyntax, firstSemicolonToken: ISyntaxToken, condition: IExpressionSyntax, secondSemicolonToken: ISyntaxToken, incrementor: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForStatementSyntax;
- public forInStatement(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, left: IExpressionSyntax, inKeyword: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForInStatementSyntax;
- public whileStatement(whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WhileStatementSyntax;
- public withStatement(withKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WithStatementSyntax;
- public enumDeclaration(modifiers: ISyntaxList, enumKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, enumElements: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- public enumElement(propertyName: ISyntaxToken, equalsValueClause: EqualsValueClauseSyntax): EnumElementSyntax;
- public castExpression(lessThanToken: ISyntaxToken, type: ITypeSyntax, greaterThanToken: ISyntaxToken, expression: IUnaryExpressionSyntax): CastExpressionSyntax;
- public objectLiteralExpression(openBraceToken: ISyntaxToken, propertyAssignments: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- public simplePropertyAssignment(propertyName: ISyntaxToken, colonToken: ISyntaxToken, expression: IExpressionSyntax): SimplePropertyAssignmentSyntax;
- public functionPropertyAssignment(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionPropertyAssignmentSyntax;
- public functionExpression(functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionExpressionSyntax;
- public emptyStatement(semicolonToken: ISyntaxToken): EmptyStatementSyntax;
- public tryStatement(tryKeyword: ISyntaxToken, block: BlockSyntax, catchClause: CatchClauseSyntax, finallyClause: FinallyClauseSyntax): TryStatementSyntax;
- public catchClause(catchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, identifier: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, closeParenToken: ISyntaxToken, block: BlockSyntax): CatchClauseSyntax;
- public finallyClause(finallyKeyword: ISyntaxToken, block: BlockSyntax): FinallyClauseSyntax;
- public labeledStatement(identifier: ISyntaxToken, colonToken: ISyntaxToken, statement: IStatementSyntax): LabeledStatementSyntax;
- public doStatement(doKeyword: ISyntaxToken, statement: IStatementSyntax, whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, semicolonToken: ISyntaxToken): DoStatementSyntax;
- public typeOfExpression(typeOfKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): TypeOfExpressionSyntax;
- public deleteExpression(deleteKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): DeleteExpressionSyntax;
- public voidExpression(voidKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): VoidExpressionSyntax;
- public debuggerStatement(debuggerKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): DebuggerStatementSyntax;
- }
- class StrictModeFactory implements IFactory {
- public sourceUnit(moduleElements: ISyntaxList, endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- public externalModuleReference(requireKeyword: ISyntaxToken, openParenToken: ISyntaxToken, stringLiteral: ISyntaxToken, closeParenToken: ISyntaxToken): ExternalModuleReferenceSyntax;
- public moduleNameModuleReference(moduleName: INameSyntax): ModuleNameModuleReferenceSyntax;
- public importDeclaration(modifiers: ISyntaxList, importKeyword: ISyntaxToken, identifier: ISyntaxToken, equalsToken: ISyntaxToken, moduleReference: IModuleReferenceSyntax, semicolonToken: ISyntaxToken): ImportDeclarationSyntax;
- public exportAssignment(exportKeyword: ISyntaxToken, equalsToken: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ExportAssignmentSyntax;
- public classDeclaration(modifiers: ISyntaxList, classKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, openBraceToken: ISyntaxToken, classElements: ISyntaxList, closeBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- public interfaceDeclaration(modifiers: ISyntaxList, interfaceKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, body: ObjectTypeSyntax): InterfaceDeclarationSyntax;
- public heritageClause(kind: SyntaxKind, extendsOrImplementsKeyword: ISyntaxToken, typeNames: ISeparatedSyntaxList): HeritageClauseSyntax;
- public moduleDeclaration(modifiers: ISyntaxList, moduleKeyword: ISyntaxToken, name: INameSyntax, stringLiteral: ISyntaxToken, openBraceToken: ISyntaxToken, moduleElements: ISyntaxList, closeBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- public functionDeclaration(modifiers: ISyntaxList, functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): FunctionDeclarationSyntax;
- public variableStatement(modifiers: ISyntaxList, variableDeclaration: VariableDeclarationSyntax, semicolonToken: ISyntaxToken): VariableStatementSyntax;
- public variableDeclaration(varKeyword: ISyntaxToken, variableDeclarators: ISeparatedSyntaxList): VariableDeclarationSyntax;
- public variableDeclarator(propertyName: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): VariableDeclaratorSyntax;
- public equalsValueClause(equalsToken: ISyntaxToken, value: IExpressionSyntax): EqualsValueClauseSyntax;
- public prefixUnaryExpression(kind: SyntaxKind, operatorToken: ISyntaxToken, operand: IUnaryExpressionSyntax): PrefixUnaryExpressionSyntax;
- public arrayLiteralExpression(openBracketToken: ISyntaxToken, expressions: ISeparatedSyntaxList, closeBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- public omittedExpression(): OmittedExpressionSyntax;
- public parenthesizedExpression(openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken): ParenthesizedExpressionSyntax;
- public simpleArrowFunctionExpression(identifier: ISyntaxToken, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): SimpleArrowFunctionExpressionSyntax;
- public parenthesizedArrowFunctionExpression(callSignature: CallSignatureSyntax, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- public qualifiedName(left: INameSyntax, dotToken: ISyntaxToken, right: ISyntaxToken): QualifiedNameSyntax;
- public typeArgumentList(lessThanToken: ISyntaxToken, typeArguments: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeArgumentListSyntax;
- public constructorType(newKeyword: ISyntaxToken, typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): ConstructorTypeSyntax;
- public functionType(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): FunctionTypeSyntax;
- public objectType(openBraceToken: ISyntaxToken, typeMembers: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectTypeSyntax;
- public arrayType(type: ITypeSyntax, openBracketToken: ISyntaxToken, closeBracketToken: ISyntaxToken): ArrayTypeSyntax;
- public genericType(name: INameSyntax, typeArgumentList: TypeArgumentListSyntax): GenericTypeSyntax;
- public typeQuery(typeOfKeyword: ISyntaxToken, name: INameSyntax): TypeQuerySyntax;
- public typeAnnotation(colonToken: ISyntaxToken, type: ITypeSyntax): TypeAnnotationSyntax;
- public block(openBraceToken: ISyntaxToken, statements: ISyntaxList, closeBraceToken: ISyntaxToken): BlockSyntax;
- public parameter(dotDotDotToken: ISyntaxToken, modifiers: ISyntaxList, identifier: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): ParameterSyntax;
- public memberAccessExpression(expression: IExpressionSyntax, dotToken: ISyntaxToken, name: ISyntaxToken): MemberAccessExpressionSyntax;
- public postfixUnaryExpression(kind: SyntaxKind, operand: IMemberExpressionSyntax, operatorToken: ISyntaxToken): PostfixUnaryExpressionSyntax;
- public elementAccessExpression(expression: IExpressionSyntax, openBracketToken: ISyntaxToken, argumentExpression: IExpressionSyntax, closeBracketToken: ISyntaxToken): ElementAccessExpressionSyntax;
- public invocationExpression(expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): InvocationExpressionSyntax;
- public argumentList(typeArgumentList: TypeArgumentListSyntax, openParenToken: ISyntaxToken, _arguments: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ArgumentListSyntax;
- public binaryExpression(kind: SyntaxKind, left: IExpressionSyntax, operatorToken: ISyntaxToken, right: IExpressionSyntax): BinaryExpressionSyntax;
- public conditionalExpression(condition: IExpressionSyntax, questionToken: ISyntaxToken, whenTrue: IExpressionSyntax, colonToken: ISyntaxToken, whenFalse: IExpressionSyntax): ConditionalExpressionSyntax;
- public constructSignature(newKeyword: ISyntaxToken, callSignature: CallSignatureSyntax): ConstructSignatureSyntax;
- public methodSignature(propertyName: ISyntaxToken, questionToken: ISyntaxToken, callSignature: CallSignatureSyntax): MethodSignatureSyntax;
- public indexSignature(openBracketToken: ISyntaxToken, parameter: ParameterSyntax, closeBracketToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): IndexSignatureSyntax;
- public propertySignature(propertyName: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): PropertySignatureSyntax;
- public callSignature(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax): CallSignatureSyntax;
- public parameterList(openParenToken: ISyntaxToken, parameters: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ParameterListSyntax;
- public typeParameterList(lessThanToken: ISyntaxToken, typeParameters: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeParameterListSyntax;
- public typeParameter(identifier: ISyntaxToken, constraint: ConstraintSyntax): TypeParameterSyntax;
- public constraint(extendsKeyword: ISyntaxToken, type: ITypeSyntax): ConstraintSyntax;
- public elseClause(elseKeyword: ISyntaxToken, statement: IStatementSyntax): ElseClauseSyntax;
- public ifStatement(ifKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, elseClause: ElseClauseSyntax): IfStatementSyntax;
- public expressionStatement(expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ExpressionStatementSyntax;
- public constructorDeclaration(modifiers: ISyntaxList, constructorKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): ConstructorDeclarationSyntax;
- public memberFunctionDeclaration(modifiers: ISyntaxList, propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): MemberFunctionDeclarationSyntax;
- public getAccessor(modifiers: ISyntaxList, getKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax, block: BlockSyntax): GetAccessorSyntax;
- public setAccessor(modifiers: ISyntaxList, setKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax): SetAccessorSyntax;
- public memberVariableDeclaration(modifiers: ISyntaxList, variableDeclarator: VariableDeclaratorSyntax, semicolonToken: ISyntaxToken): MemberVariableDeclarationSyntax;
- public indexMemberDeclaration(modifiers: ISyntaxList, indexSignature: IndexSignatureSyntax, semicolonToken: ISyntaxToken): IndexMemberDeclarationSyntax;
- public throwStatement(throwKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ThrowStatementSyntax;
- public returnStatement(returnKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ReturnStatementSyntax;
- public objectCreationExpression(newKeyword: ISyntaxToken, expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): ObjectCreationExpressionSyntax;
- public switchStatement(switchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, openBraceToken: ISyntaxToken, switchClauses: ISyntaxList, closeBraceToken: ISyntaxToken): SwitchStatementSyntax;
- public caseSwitchClause(caseKeyword: ISyntaxToken, expression: IExpressionSyntax, colonToken: ISyntaxToken, statements: ISyntaxList): CaseSwitchClauseSyntax;
- public defaultSwitchClause(defaultKeyword: ISyntaxToken, colonToken: ISyntaxToken, statements: ISyntaxList): DefaultSwitchClauseSyntax;
- public breakStatement(breakKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): BreakStatementSyntax;
- public continueStatement(continueKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ContinueStatementSyntax;
- public forStatement(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, initializer: IExpressionSyntax, firstSemicolonToken: ISyntaxToken, condition: IExpressionSyntax, secondSemicolonToken: ISyntaxToken, incrementor: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForStatementSyntax;
- public forInStatement(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, left: IExpressionSyntax, inKeyword: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForInStatementSyntax;
- public whileStatement(whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WhileStatementSyntax;
- public withStatement(withKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WithStatementSyntax;
- public enumDeclaration(modifiers: ISyntaxList, enumKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, enumElements: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- public enumElement(propertyName: ISyntaxToken, equalsValueClause: EqualsValueClauseSyntax): EnumElementSyntax;
- public castExpression(lessThanToken: ISyntaxToken, type: ITypeSyntax, greaterThanToken: ISyntaxToken, expression: IUnaryExpressionSyntax): CastExpressionSyntax;
- public objectLiteralExpression(openBraceToken: ISyntaxToken, propertyAssignments: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- public simplePropertyAssignment(propertyName: ISyntaxToken, colonToken: ISyntaxToken, expression: IExpressionSyntax): SimplePropertyAssignmentSyntax;
- public functionPropertyAssignment(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionPropertyAssignmentSyntax;
- public functionExpression(functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionExpressionSyntax;
- public emptyStatement(semicolonToken: ISyntaxToken): EmptyStatementSyntax;
- public tryStatement(tryKeyword: ISyntaxToken, block: BlockSyntax, catchClause: CatchClauseSyntax, finallyClause: FinallyClauseSyntax): TryStatementSyntax;
- public catchClause(catchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, identifier: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, closeParenToken: ISyntaxToken, block: BlockSyntax): CatchClauseSyntax;
- public finallyClause(finallyKeyword: ISyntaxToken, block: BlockSyntax): FinallyClauseSyntax;
- public labeledStatement(identifier: ISyntaxToken, colonToken: ISyntaxToken, statement: IStatementSyntax): LabeledStatementSyntax;
- public doStatement(doKeyword: ISyntaxToken, statement: IStatementSyntax, whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, semicolonToken: ISyntaxToken): DoStatementSyntax;
- public typeOfExpression(typeOfKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): TypeOfExpressionSyntax;
- public deleteExpression(deleteKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): DeleteExpressionSyntax;
- public voidExpression(voidKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): VoidExpressionSyntax;
- public debuggerStatement(debuggerKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): DebuggerStatementSyntax;
- }
- var normalModeFactory: IFactory;
- var strictModeFactory: IFactory;
-}
-declare module TypeScript.SyntaxFacts {
- function isDirectivePrologueElement(node: ISyntaxNodeOrToken): boolean;
- function isUseStrictDirective(node: ISyntaxNodeOrToken): boolean;
- function isIdentifierNameOrAnyKeyword(token: ISyntaxToken): boolean;
-}
-declare module TypeScript {
- interface ISyntaxList extends ISyntaxElement {
- childAt(index: number): ISyntaxNodeOrToken;
- toArray(): ISyntaxNodeOrToken[];
- insertChildrenInto(array: ISyntaxElement[], index: number): void;
- }
-}
-declare module TypeScript.Syntax {
- class EmptySyntaxList implements ISyntaxList {
- public kind(): SyntaxKind;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public toJSON(key: any): any;
- public childCount(): number;
- public childAt(index: number): ISyntaxNodeOrToken;
- public toArray(): ISyntaxNodeOrToken[];
- public collectTextElements(elements: string[]): void;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public fullWidth(): number;
- public width(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public trailingTrivia(): ISyntaxTriviaList;
- public leadingTriviaWidth(): number;
- public trailingTriviaWidth(): number;
- public fullText(): string;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public findTokenInternal(parent: PositionedElement, position: number, fullStart: number): PositionedToken;
- public insertChildrenInto(array: ISyntaxElement[], index: number): void;
- }
- var emptyList: ISyntaxList;
- function list(nodes: ISyntaxNodeOrToken[]): ISyntaxList;
-}
-declare module TypeScript {
- class SyntaxNode implements ISyntaxNodeOrToken {
- private _data;
- constructor(parsedInStrictMode: boolean);
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public insertChildrenInto(array: ISyntaxElement[], index: number): void;
- public leadingTrivia(): ISyntaxTriviaList;
- public trailingTrivia(): ISyntaxTriviaList;
- public toJSON(key: any): any;
- public accept(visitor: ISyntaxVisitor): any;
- public fullText(): string;
- public collectTextElements(elements: string[]): void;
- public replaceToken(token1: ISyntaxToken, token2: ISyntaxToken): SyntaxNode;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): SyntaxNode;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): SyntaxNode;
- public hasLeadingTrivia(): boolean;
- public hasTrailingTrivia(): boolean;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public parsedInStrictMode(): boolean;
- public fullWidth(): number;
- private computeData();
- private data();
- public findToken(position: number, includeSkippedTokens?: boolean): PositionedToken;
- private tryGetEndOfFileAt(position);
- private findTokenInternal(parent, position, fullStart);
- public findTokenOnLeft(position: number, includeSkippedTokens?: boolean): PositionedToken;
- public findCompleteTokenOnLeft(position: number, includeSkippedTokens?: boolean): PositionedToken;
- public isModuleElement(): boolean;
- public isClassElement(): boolean;
- public isTypeMember(): boolean;
- public isStatement(): boolean;
- public isExpression(): boolean;
- public isSwitchClause(): boolean;
- public structuralEquals(node: SyntaxNode): boolean;
- public width(): number;
- public leadingTriviaWidth(): number;
- public trailingTriviaWidth(): number;
- }
-}
-declare module TypeScript {
- interface ISyntaxNodeOrToken extends ISyntaxElement {
- withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxNodeOrToken;
- withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxNodeOrToken;
- accept(visitor: ISyntaxVisitor): any;
- }
-}
-declare module TypeScript {
- class SourceUnitSyntax extends SyntaxNode {
- public moduleElements: ISyntaxList;
- public endOfFileToken: ISyntaxToken;
- constructor(moduleElements: ISyntaxList, endOfFileToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(moduleElements: ISyntaxList, endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- static create(endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- static create1(endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): SourceUnitSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): SourceUnitSyntax;
- public withModuleElements(moduleElements: ISyntaxList): SourceUnitSyntax;
- public withModuleElement(moduleElement: IModuleElementSyntax): SourceUnitSyntax;
- public withEndOfFileToken(endOfFileToken: ISyntaxToken): SourceUnitSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ExternalModuleReferenceSyntax extends SyntaxNode implements IModuleReferenceSyntax {
- public requireKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public stringLiteral: ISyntaxToken;
- public closeParenToken: ISyntaxToken;
- constructor(requireKeyword: ISyntaxToken, openParenToken: ISyntaxToken, stringLiteral: ISyntaxToken, closeParenToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleReference(): boolean;
- public update(requireKeyword: ISyntaxToken, openParenToken: ISyntaxToken, stringLiteral: ISyntaxToken, closeParenToken: ISyntaxToken): ExternalModuleReferenceSyntax;
- static create1(stringLiteral: ISyntaxToken): ExternalModuleReferenceSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ExternalModuleReferenceSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ExternalModuleReferenceSyntax;
- public withRequireKeyword(requireKeyword: ISyntaxToken): ExternalModuleReferenceSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): ExternalModuleReferenceSyntax;
- public withStringLiteral(stringLiteral: ISyntaxToken): ExternalModuleReferenceSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): ExternalModuleReferenceSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ModuleNameModuleReferenceSyntax extends SyntaxNode implements IModuleReferenceSyntax {
- public moduleName: INameSyntax;
- constructor(moduleName: INameSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleReference(): boolean;
- public update(moduleName: INameSyntax): ModuleNameModuleReferenceSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ModuleNameModuleReferenceSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ModuleNameModuleReferenceSyntax;
- public withModuleName(moduleName: INameSyntax): ModuleNameModuleReferenceSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ImportDeclarationSyntax extends SyntaxNode implements IModuleElementSyntax {
- public modifiers: ISyntaxList;
- public importKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public equalsToken: ISyntaxToken;
- public moduleReference: IModuleReferenceSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, importKeyword: ISyntaxToken, identifier: ISyntaxToken, equalsToken: ISyntaxToken, moduleReference: IModuleReferenceSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, importKeyword: ISyntaxToken, identifier: ISyntaxToken, equalsToken: ISyntaxToken, moduleReference: IModuleReferenceSyntax, semicolonToken: ISyntaxToken): ImportDeclarationSyntax;
- static create(importKeyword: ISyntaxToken, identifier: ISyntaxToken, equalsToken: ISyntaxToken, moduleReference: IModuleReferenceSyntax, semicolonToken: ISyntaxToken): ImportDeclarationSyntax;
- static create1(identifier: ISyntaxToken, moduleReference: IModuleReferenceSyntax): ImportDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ImportDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ImportDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): ImportDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): ImportDeclarationSyntax;
- public withImportKeyword(importKeyword: ISyntaxToken): ImportDeclarationSyntax;
- public withIdentifier(identifier: ISyntaxToken): ImportDeclarationSyntax;
- public withEqualsToken(equalsToken: ISyntaxToken): ImportDeclarationSyntax;
- public withModuleReference(moduleReference: IModuleReferenceSyntax): ImportDeclarationSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ImportDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ExportAssignmentSyntax extends SyntaxNode implements IModuleElementSyntax {
- public exportKeyword: ISyntaxToken;
- public equalsToken: ISyntaxToken;
- public identifier: ISyntaxToken;
- public semicolonToken: ISyntaxToken;
- constructor(exportKeyword: ISyntaxToken, equalsToken: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleElement(): boolean;
- public update(exportKeyword: ISyntaxToken, equalsToken: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ExportAssignmentSyntax;
- static create1(identifier: ISyntaxToken): ExportAssignmentSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ExportAssignmentSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ExportAssignmentSyntax;
- public withExportKeyword(exportKeyword: ISyntaxToken): ExportAssignmentSyntax;
- public withEqualsToken(equalsToken: ISyntaxToken): ExportAssignmentSyntax;
- public withIdentifier(identifier: ISyntaxToken): ExportAssignmentSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ExportAssignmentSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ClassDeclarationSyntax extends SyntaxNode implements IModuleElementSyntax {
- public modifiers: ISyntaxList;
- public classKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public typeParameterList: TypeParameterListSyntax;
- public heritageClauses: ISyntaxList;
- public openBraceToken: ISyntaxToken;
- public classElements: ISyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, classKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, openBraceToken: ISyntaxToken, classElements: ISyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, classKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, openBraceToken: ISyntaxToken, classElements: ISyntaxList, closeBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- static create(classKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- static create1(identifier: ISyntaxToken): ClassDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ClassDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ClassDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): ClassDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): ClassDeclarationSyntax;
- public withClassKeyword(classKeyword: ISyntaxToken): ClassDeclarationSyntax;
- public withIdentifier(identifier: ISyntaxToken): ClassDeclarationSyntax;
- public withTypeParameterList(typeParameterList: TypeParameterListSyntax): ClassDeclarationSyntax;
- public withHeritageClauses(heritageClauses: ISyntaxList): ClassDeclarationSyntax;
- public withHeritageClause(heritageClause: HeritageClauseSyntax): ClassDeclarationSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- public withClassElements(classElements: ISyntaxList): ClassDeclarationSyntax;
- public withClassElement(classElement: IClassElementSyntax): ClassDeclarationSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): ClassDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class InterfaceDeclarationSyntax extends SyntaxNode implements IModuleElementSyntax {
- public modifiers: ISyntaxList;
- public interfaceKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public typeParameterList: TypeParameterListSyntax;
- public heritageClauses: ISyntaxList;
- public body: ObjectTypeSyntax;
- constructor(modifiers: ISyntaxList, interfaceKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, body: ObjectTypeSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, interfaceKeyword: ISyntaxToken, identifier: ISyntaxToken, typeParameterList: TypeParameterListSyntax, heritageClauses: ISyntaxList, body: ObjectTypeSyntax): InterfaceDeclarationSyntax;
- static create(interfaceKeyword: ISyntaxToken, identifier: ISyntaxToken, body: ObjectTypeSyntax): InterfaceDeclarationSyntax;
- static create1(identifier: ISyntaxToken): InterfaceDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): InterfaceDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): InterfaceDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): InterfaceDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): InterfaceDeclarationSyntax;
- public withInterfaceKeyword(interfaceKeyword: ISyntaxToken): InterfaceDeclarationSyntax;
- public withIdentifier(identifier: ISyntaxToken): InterfaceDeclarationSyntax;
- public withTypeParameterList(typeParameterList: TypeParameterListSyntax): InterfaceDeclarationSyntax;
- public withHeritageClauses(heritageClauses: ISyntaxList): InterfaceDeclarationSyntax;
- public withHeritageClause(heritageClause: HeritageClauseSyntax): InterfaceDeclarationSyntax;
- public withBody(body: ObjectTypeSyntax): InterfaceDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class HeritageClauseSyntax extends SyntaxNode {
- public extendsOrImplementsKeyword: ISyntaxToken;
- public typeNames: ISeparatedSyntaxList;
- private _kind;
- constructor(kind: SyntaxKind, extendsOrImplementsKeyword: ISyntaxToken, typeNames: ISeparatedSyntaxList, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public kind(): SyntaxKind;
- public update(kind: SyntaxKind, extendsOrImplementsKeyword: ISyntaxToken, typeNames: ISeparatedSyntaxList): HeritageClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): HeritageClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): HeritageClauseSyntax;
- public withKind(kind: SyntaxKind): HeritageClauseSyntax;
- public withExtendsOrImplementsKeyword(extendsOrImplementsKeyword: ISyntaxToken): HeritageClauseSyntax;
- public withTypeNames(typeNames: ISeparatedSyntaxList): HeritageClauseSyntax;
- public withTypeName(typeName: INameSyntax): HeritageClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ModuleDeclarationSyntax extends SyntaxNode implements IModuleElementSyntax {
- public modifiers: ISyntaxList;
- public moduleKeyword: ISyntaxToken;
- public name: INameSyntax;
- public stringLiteral: ISyntaxToken;
- public openBraceToken: ISyntaxToken;
- public moduleElements: ISyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, moduleKeyword: ISyntaxToken, name: INameSyntax, stringLiteral: ISyntaxToken, openBraceToken: ISyntaxToken, moduleElements: ISyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, moduleKeyword: ISyntaxToken, name: INameSyntax, stringLiteral: ISyntaxToken, openBraceToken: ISyntaxToken, moduleElements: ISyntaxList, closeBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- static create(moduleKeyword: ISyntaxToken, openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- static create1(): ModuleDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ModuleDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ModuleDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): ModuleDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): ModuleDeclarationSyntax;
- public withModuleKeyword(moduleKeyword: ISyntaxToken): ModuleDeclarationSyntax;
- public withName(name: INameSyntax): ModuleDeclarationSyntax;
- public withStringLiteral(stringLiteral: ISyntaxToken): ModuleDeclarationSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- public withModuleElements(moduleElements: ISyntaxList): ModuleDeclarationSyntax;
- public withModuleElement(moduleElement: IModuleElementSyntax): ModuleDeclarationSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): ModuleDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class FunctionDeclarationSyntax extends SyntaxNode implements IStatementSyntax {
- public modifiers: ISyntaxList;
- public functionKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- public block: BlockSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): FunctionDeclarationSyntax;
- static create(functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax): FunctionDeclarationSyntax;
- static create1(identifier: ISyntaxToken): FunctionDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): FunctionDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): FunctionDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): FunctionDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): FunctionDeclarationSyntax;
- public withFunctionKeyword(functionKeyword: ISyntaxToken): FunctionDeclarationSyntax;
- public withIdentifier(identifier: ISyntaxToken): FunctionDeclarationSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): FunctionDeclarationSyntax;
- public withBlock(block: BlockSyntax): FunctionDeclarationSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): FunctionDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class VariableStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public modifiers: ISyntaxList;
- public variableDeclaration: VariableDeclarationSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, variableDeclaration: VariableDeclarationSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, variableDeclaration: VariableDeclarationSyntax, semicolonToken: ISyntaxToken): VariableStatementSyntax;
- static create(variableDeclaration: VariableDeclarationSyntax, semicolonToken: ISyntaxToken): VariableStatementSyntax;
- static create1(variableDeclaration: VariableDeclarationSyntax): VariableStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): VariableStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): VariableStatementSyntax;
- public withModifiers(modifiers: ISyntaxList): VariableStatementSyntax;
- public withModifier(modifier: ISyntaxToken): VariableStatementSyntax;
- public withVariableDeclaration(variableDeclaration: VariableDeclarationSyntax): VariableStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): VariableStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class VariableDeclarationSyntax extends SyntaxNode {
- public varKeyword: ISyntaxToken;
- public variableDeclarators: ISeparatedSyntaxList;
- constructor(varKeyword: ISyntaxToken, variableDeclarators: ISeparatedSyntaxList, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(varKeyword: ISyntaxToken, variableDeclarators: ISeparatedSyntaxList): VariableDeclarationSyntax;
- static create1(variableDeclarators: ISeparatedSyntaxList): VariableDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): VariableDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): VariableDeclarationSyntax;
- public withVarKeyword(varKeyword: ISyntaxToken): VariableDeclarationSyntax;
- public withVariableDeclarators(variableDeclarators: ISeparatedSyntaxList): VariableDeclarationSyntax;
- public withVariableDeclarator(variableDeclarator: VariableDeclaratorSyntax): VariableDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class VariableDeclaratorSyntax extends SyntaxNode {
- public propertyName: ISyntaxToken;
- public typeAnnotation: TypeAnnotationSyntax;
- public equalsValueClause: EqualsValueClauseSyntax;
- constructor(propertyName: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(propertyName: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): VariableDeclaratorSyntax;
- static create(propertyName: ISyntaxToken): VariableDeclaratorSyntax;
- static create1(propertyName: ISyntaxToken): VariableDeclaratorSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): VariableDeclaratorSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): VariableDeclaratorSyntax;
- public withPropertyName(propertyName: ISyntaxToken): VariableDeclaratorSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): VariableDeclaratorSyntax;
- public withEqualsValueClause(equalsValueClause: EqualsValueClauseSyntax): VariableDeclaratorSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class EqualsValueClauseSyntax extends SyntaxNode {
- public equalsToken: ISyntaxToken;
- public value: IExpressionSyntax;
- constructor(equalsToken: ISyntaxToken, value: IExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(equalsToken: ISyntaxToken, value: IExpressionSyntax): EqualsValueClauseSyntax;
- static create1(value: IExpressionSyntax): EqualsValueClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): EqualsValueClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): EqualsValueClauseSyntax;
- public withEqualsToken(equalsToken: ISyntaxToken): EqualsValueClauseSyntax;
- public withValue(value: IExpressionSyntax): EqualsValueClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class PrefixUnaryExpressionSyntax extends SyntaxNode implements IUnaryExpressionSyntax {
- public operatorToken: ISyntaxToken;
- public operand: IUnaryExpressionSyntax;
- private _kind;
- constructor(kind: SyntaxKind, operatorToken: ISyntaxToken, operand: IUnaryExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public kind(): SyntaxKind;
- public update(kind: SyntaxKind, operatorToken: ISyntaxToken, operand: IUnaryExpressionSyntax): PrefixUnaryExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): PrefixUnaryExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): PrefixUnaryExpressionSyntax;
- public withKind(kind: SyntaxKind): PrefixUnaryExpressionSyntax;
- public withOperatorToken(operatorToken: ISyntaxToken): PrefixUnaryExpressionSyntax;
- public withOperand(operand: IUnaryExpressionSyntax): PrefixUnaryExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ArrayLiteralExpressionSyntax extends SyntaxNode implements IPrimaryExpressionSyntax {
- public openBracketToken: ISyntaxToken;
- public expressions: ISeparatedSyntaxList;
- public closeBracketToken: ISyntaxToken;
- constructor(openBracketToken: ISyntaxToken, expressions: ISeparatedSyntaxList, closeBracketToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(openBracketToken: ISyntaxToken, expressions: ISeparatedSyntaxList, closeBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- static create(openBracketToken: ISyntaxToken, closeBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- static create1(): ArrayLiteralExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ArrayLiteralExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ArrayLiteralExpressionSyntax;
- public withOpenBracketToken(openBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- public withExpressions(expressions: ISeparatedSyntaxList): ArrayLiteralExpressionSyntax;
- public withExpression(expression: IExpressionSyntax): ArrayLiteralExpressionSyntax;
- public withCloseBracketToken(closeBracketToken: ISyntaxToken): ArrayLiteralExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class OmittedExpressionSyntax extends SyntaxNode implements IExpressionSyntax {
- constructor(parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isExpression(): boolean;
- public update(): OmittedExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): OmittedExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): OmittedExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ParenthesizedExpressionSyntax extends SyntaxNode implements IPrimaryExpressionSyntax {
- public openParenToken: ISyntaxToken;
- public expression: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- constructor(openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken): ParenthesizedExpressionSyntax;
- static create1(expression: IExpressionSyntax): ParenthesizedExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ParenthesizedExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ParenthesizedExpressionSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): ParenthesizedExpressionSyntax;
- public withExpression(expression: IExpressionSyntax): ParenthesizedExpressionSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): ParenthesizedExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class SimpleArrowFunctionExpressionSyntax extends SyntaxNode implements IArrowFunctionExpressionSyntax {
- public identifier: ISyntaxToken;
- public equalsGreaterThanToken: ISyntaxToken;
- public block: BlockSyntax;
- public expression: IExpressionSyntax;
- constructor(identifier: ISyntaxToken, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isArrowFunctionExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(identifier: ISyntaxToken, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): SimpleArrowFunctionExpressionSyntax;
- static create(identifier: ISyntaxToken, equalsGreaterThanToken: ISyntaxToken): SimpleArrowFunctionExpressionSyntax;
- static create1(identifier: ISyntaxToken): SimpleArrowFunctionExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): SimpleArrowFunctionExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): SimpleArrowFunctionExpressionSyntax;
- public withIdentifier(identifier: ISyntaxToken): SimpleArrowFunctionExpressionSyntax;
- public withEqualsGreaterThanToken(equalsGreaterThanToken: ISyntaxToken): SimpleArrowFunctionExpressionSyntax;
- public withBlock(block: BlockSyntax): SimpleArrowFunctionExpressionSyntax;
- public withExpression(expression: IExpressionSyntax): SimpleArrowFunctionExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ParenthesizedArrowFunctionExpressionSyntax extends SyntaxNode implements IArrowFunctionExpressionSyntax {
- public callSignature: CallSignatureSyntax;
- public equalsGreaterThanToken: ISyntaxToken;
- public block: BlockSyntax;
- public expression: IExpressionSyntax;
- constructor(callSignature: CallSignatureSyntax, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isArrowFunctionExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(callSignature: CallSignatureSyntax, equalsGreaterThanToken: ISyntaxToken, block: BlockSyntax, expression: IExpressionSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- static create(callSignature: CallSignatureSyntax, equalsGreaterThanToken: ISyntaxToken): ParenthesizedArrowFunctionExpressionSyntax;
- static create1(): ParenthesizedArrowFunctionExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ParenthesizedArrowFunctionExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ParenthesizedArrowFunctionExpressionSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- public withEqualsGreaterThanToken(equalsGreaterThanToken: ISyntaxToken): ParenthesizedArrowFunctionExpressionSyntax;
- public withBlock(block: BlockSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- public withExpression(expression: IExpressionSyntax): ParenthesizedArrowFunctionExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class QualifiedNameSyntax extends SyntaxNode implements INameSyntax {
- public left: INameSyntax;
- public dotToken: ISyntaxToken;
- public right: ISyntaxToken;
- constructor(left: INameSyntax, dotToken: ISyntaxToken, right: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isName(): boolean;
- public isType(): boolean;
- public update(left: INameSyntax, dotToken: ISyntaxToken, right: ISyntaxToken): QualifiedNameSyntax;
- static create1(left: INameSyntax, right: ISyntaxToken): QualifiedNameSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): QualifiedNameSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): QualifiedNameSyntax;
- public withLeft(left: INameSyntax): QualifiedNameSyntax;
- public withDotToken(dotToken: ISyntaxToken): QualifiedNameSyntax;
- public withRight(right: ISyntaxToken): QualifiedNameSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TypeArgumentListSyntax extends SyntaxNode {
- public lessThanToken: ISyntaxToken;
- public typeArguments: ISeparatedSyntaxList;
- public greaterThanToken: ISyntaxToken;
- constructor(lessThanToken: ISyntaxToken, typeArguments: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(lessThanToken: ISyntaxToken, typeArguments: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeArgumentListSyntax;
- static create(lessThanToken: ISyntaxToken, greaterThanToken: ISyntaxToken): TypeArgumentListSyntax;
- static create1(): TypeArgumentListSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TypeArgumentListSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TypeArgumentListSyntax;
- public withLessThanToken(lessThanToken: ISyntaxToken): TypeArgumentListSyntax;
- public withTypeArguments(typeArguments: ISeparatedSyntaxList): TypeArgumentListSyntax;
- public withTypeArgument(typeArgument: ITypeSyntax): TypeArgumentListSyntax;
- public withGreaterThanToken(greaterThanToken: ISyntaxToken): TypeArgumentListSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ConstructorTypeSyntax extends SyntaxNode implements ITypeSyntax {
- public newKeyword: ISyntaxToken;
- public typeParameterList: TypeParameterListSyntax;
- public parameterList: ParameterListSyntax;
- public equalsGreaterThanToken: ISyntaxToken;
- public type: ITypeSyntax;
- constructor(newKeyword: ISyntaxToken, typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isType(): boolean;
- public update(newKeyword: ISyntaxToken, typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): ConstructorTypeSyntax;
- static create(newKeyword: ISyntaxToken, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): ConstructorTypeSyntax;
- static create1(type: ITypeSyntax): ConstructorTypeSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ConstructorTypeSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ConstructorTypeSyntax;
- public withNewKeyword(newKeyword: ISyntaxToken): ConstructorTypeSyntax;
- public withTypeParameterList(typeParameterList: TypeParameterListSyntax): ConstructorTypeSyntax;
- public withParameterList(parameterList: ParameterListSyntax): ConstructorTypeSyntax;
- public withEqualsGreaterThanToken(equalsGreaterThanToken: ISyntaxToken): ConstructorTypeSyntax;
- public withType(type: ITypeSyntax): ConstructorTypeSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class FunctionTypeSyntax extends SyntaxNode implements ITypeSyntax {
- public typeParameterList: TypeParameterListSyntax;
- public parameterList: ParameterListSyntax;
- public equalsGreaterThanToken: ISyntaxToken;
- public type: ITypeSyntax;
- constructor(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isType(): boolean;
- public update(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): FunctionTypeSyntax;
- static create(parameterList: ParameterListSyntax, equalsGreaterThanToken: ISyntaxToken, type: ITypeSyntax): FunctionTypeSyntax;
- static create1(type: ITypeSyntax): FunctionTypeSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): FunctionTypeSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): FunctionTypeSyntax;
- public withTypeParameterList(typeParameterList: TypeParameterListSyntax): FunctionTypeSyntax;
- public withParameterList(parameterList: ParameterListSyntax): FunctionTypeSyntax;
- public withEqualsGreaterThanToken(equalsGreaterThanToken: ISyntaxToken): FunctionTypeSyntax;
- public withType(type: ITypeSyntax): FunctionTypeSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ObjectTypeSyntax extends SyntaxNode implements ITypeSyntax {
- public openBraceToken: ISyntaxToken;
- public typeMembers: ISeparatedSyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(openBraceToken: ISyntaxToken, typeMembers: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isType(): boolean;
- public update(openBraceToken: ISyntaxToken, typeMembers: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectTypeSyntax;
- static create(openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): ObjectTypeSyntax;
- static create1(): ObjectTypeSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ObjectTypeSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ObjectTypeSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): ObjectTypeSyntax;
- public withTypeMembers(typeMembers: ISeparatedSyntaxList): ObjectTypeSyntax;
- public withTypeMember(typeMember: ITypeMemberSyntax): ObjectTypeSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): ObjectTypeSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ArrayTypeSyntax extends SyntaxNode implements ITypeSyntax {
- public type: ITypeSyntax;
- public openBracketToken: ISyntaxToken;
- public closeBracketToken: ISyntaxToken;
- constructor(type: ITypeSyntax, openBracketToken: ISyntaxToken, closeBracketToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isType(): boolean;
- public update(type: ITypeSyntax, openBracketToken: ISyntaxToken, closeBracketToken: ISyntaxToken): ArrayTypeSyntax;
- static create1(type: ITypeSyntax): ArrayTypeSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ArrayTypeSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ArrayTypeSyntax;
- public withType(type: ITypeSyntax): ArrayTypeSyntax;
- public withOpenBracketToken(openBracketToken: ISyntaxToken): ArrayTypeSyntax;
- public withCloseBracketToken(closeBracketToken: ISyntaxToken): ArrayTypeSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class GenericTypeSyntax extends SyntaxNode implements ITypeSyntax {
- public name: INameSyntax;
- public typeArgumentList: TypeArgumentListSyntax;
- constructor(name: INameSyntax, typeArgumentList: TypeArgumentListSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isType(): boolean;
- public update(name: INameSyntax, typeArgumentList: TypeArgumentListSyntax): GenericTypeSyntax;
- static create1(name: INameSyntax): GenericTypeSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): GenericTypeSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): GenericTypeSyntax;
- public withName(name: INameSyntax): GenericTypeSyntax;
- public withTypeArgumentList(typeArgumentList: TypeArgumentListSyntax): GenericTypeSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TypeQuerySyntax extends SyntaxNode implements ITypeSyntax {
- public typeOfKeyword: ISyntaxToken;
- public name: INameSyntax;
- constructor(typeOfKeyword: ISyntaxToken, name: INameSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isType(): boolean;
- public update(typeOfKeyword: ISyntaxToken, name: INameSyntax): TypeQuerySyntax;
- static create1(name: INameSyntax): TypeQuerySyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TypeQuerySyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TypeQuerySyntax;
- public withTypeOfKeyword(typeOfKeyword: ISyntaxToken): TypeQuerySyntax;
- public withName(name: INameSyntax): TypeQuerySyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TypeAnnotationSyntax extends SyntaxNode {
- public colonToken: ISyntaxToken;
- public type: ITypeSyntax;
- constructor(colonToken: ISyntaxToken, type: ITypeSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(colonToken: ISyntaxToken, type: ITypeSyntax): TypeAnnotationSyntax;
- static create1(type: ITypeSyntax): TypeAnnotationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TypeAnnotationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TypeAnnotationSyntax;
- public withColonToken(colonToken: ISyntaxToken): TypeAnnotationSyntax;
- public withType(type: ITypeSyntax): TypeAnnotationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class BlockSyntax extends SyntaxNode implements IStatementSyntax {
- public openBraceToken: ISyntaxToken;
- public statements: ISyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(openBraceToken: ISyntaxToken, statements: ISyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(openBraceToken: ISyntaxToken, statements: ISyntaxList, closeBraceToken: ISyntaxToken): BlockSyntax;
- static create(openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): BlockSyntax;
- static create1(): BlockSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): BlockSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): BlockSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): BlockSyntax;
- public withStatements(statements: ISyntaxList): BlockSyntax;
- public withStatement(statement: IStatementSyntax): BlockSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): BlockSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ParameterSyntax extends SyntaxNode {
- public dotDotDotToken: ISyntaxToken;
- public modifiers: ISyntaxList;
- public identifier: ISyntaxToken;
- public questionToken: ISyntaxToken;
- public typeAnnotation: TypeAnnotationSyntax;
- public equalsValueClause: EqualsValueClauseSyntax;
- constructor(dotDotDotToken: ISyntaxToken, modifiers: ISyntaxList, identifier: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(dotDotDotToken: ISyntaxToken, modifiers: ISyntaxList, identifier: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, equalsValueClause: EqualsValueClauseSyntax): ParameterSyntax;
- static create(identifier: ISyntaxToken): ParameterSyntax;
- static create1(identifier: ISyntaxToken): ParameterSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ParameterSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ParameterSyntax;
- public withDotDotDotToken(dotDotDotToken: ISyntaxToken): ParameterSyntax;
- public withModifiers(modifiers: ISyntaxList): ParameterSyntax;
- public withModifier(modifier: ISyntaxToken): ParameterSyntax;
- public withIdentifier(identifier: ISyntaxToken): ParameterSyntax;
- public withQuestionToken(questionToken: ISyntaxToken): ParameterSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): ParameterSyntax;
- public withEqualsValueClause(equalsValueClause: EqualsValueClauseSyntax): ParameterSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class MemberAccessExpressionSyntax extends SyntaxNode implements IMemberExpressionSyntax {
- public expression: IExpressionSyntax;
- public dotToken: ISyntaxToken;
- public name: ISyntaxToken;
- constructor(expression: IExpressionSyntax, dotToken: ISyntaxToken, name: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(expression: IExpressionSyntax, dotToken: ISyntaxToken, name: ISyntaxToken): MemberAccessExpressionSyntax;
- static create1(expression: IExpressionSyntax, name: ISyntaxToken): MemberAccessExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): MemberAccessExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): MemberAccessExpressionSyntax;
- public withExpression(expression: IExpressionSyntax): MemberAccessExpressionSyntax;
- public withDotToken(dotToken: ISyntaxToken): MemberAccessExpressionSyntax;
- public withName(name: ISyntaxToken): MemberAccessExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class PostfixUnaryExpressionSyntax extends SyntaxNode implements IPostfixExpressionSyntax {
- public operand: IMemberExpressionSyntax;
- public operatorToken: ISyntaxToken;
- private _kind;
- constructor(kind: SyntaxKind, operand: IMemberExpressionSyntax, operatorToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public kind(): SyntaxKind;
- public update(kind: SyntaxKind, operand: IMemberExpressionSyntax, operatorToken: ISyntaxToken): PostfixUnaryExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): PostfixUnaryExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): PostfixUnaryExpressionSyntax;
- public withKind(kind: SyntaxKind): PostfixUnaryExpressionSyntax;
- public withOperand(operand: IMemberExpressionSyntax): PostfixUnaryExpressionSyntax;
- public withOperatorToken(operatorToken: ISyntaxToken): PostfixUnaryExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ElementAccessExpressionSyntax extends SyntaxNode implements IMemberExpressionSyntax {
- public expression: IExpressionSyntax;
- public openBracketToken: ISyntaxToken;
- public argumentExpression: IExpressionSyntax;
- public closeBracketToken: ISyntaxToken;
- constructor(expression: IExpressionSyntax, openBracketToken: ISyntaxToken, argumentExpression: IExpressionSyntax, closeBracketToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(expression: IExpressionSyntax, openBracketToken: ISyntaxToken, argumentExpression: IExpressionSyntax, closeBracketToken: ISyntaxToken): ElementAccessExpressionSyntax;
- static create1(expression: IExpressionSyntax, argumentExpression: IExpressionSyntax): ElementAccessExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ElementAccessExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ElementAccessExpressionSyntax;
- public withExpression(expression: IExpressionSyntax): ElementAccessExpressionSyntax;
- public withOpenBracketToken(openBracketToken: ISyntaxToken): ElementAccessExpressionSyntax;
- public withArgumentExpression(argumentExpression: IExpressionSyntax): ElementAccessExpressionSyntax;
- public withCloseBracketToken(closeBracketToken: ISyntaxToken): ElementAccessExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class InvocationExpressionSyntax extends SyntaxNode implements IMemberExpressionSyntax {
- public expression: IMemberExpressionSyntax;
- public argumentList: ArgumentListSyntax;
- constructor(expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): InvocationExpressionSyntax;
- static create1(expression: IMemberExpressionSyntax): InvocationExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): InvocationExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): InvocationExpressionSyntax;
- public withExpression(expression: IMemberExpressionSyntax): InvocationExpressionSyntax;
- public withArgumentList(argumentList: ArgumentListSyntax): InvocationExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ArgumentListSyntax extends SyntaxNode {
- public typeArgumentList: TypeArgumentListSyntax;
- public openParenToken: ISyntaxToken;
- public closeParenToken: ISyntaxToken;
- public arguments: ISeparatedSyntaxList;
- constructor(typeArgumentList: TypeArgumentListSyntax, openParenToken: ISyntaxToken, _arguments: ISeparatedSyntaxList, closeParenToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(typeArgumentList: TypeArgumentListSyntax, openParenToken: ISyntaxToken, _arguments: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ArgumentListSyntax;
- static create(openParenToken: ISyntaxToken, closeParenToken: ISyntaxToken): ArgumentListSyntax;
- static create1(): ArgumentListSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ArgumentListSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ArgumentListSyntax;
- public withTypeArgumentList(typeArgumentList: TypeArgumentListSyntax): ArgumentListSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): ArgumentListSyntax;
- public withArguments(_arguments: ISeparatedSyntaxList): ArgumentListSyntax;
- public withArgument(_argument: IExpressionSyntax): ArgumentListSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): ArgumentListSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class BinaryExpressionSyntax extends SyntaxNode implements IExpressionSyntax {
- public left: IExpressionSyntax;
- public operatorToken: ISyntaxToken;
- public right: IExpressionSyntax;
- private _kind;
- constructor(kind: SyntaxKind, left: IExpressionSyntax, operatorToken: ISyntaxToken, right: IExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isExpression(): boolean;
- public kind(): SyntaxKind;
- public update(kind: SyntaxKind, left: IExpressionSyntax, operatorToken: ISyntaxToken, right: IExpressionSyntax): BinaryExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): BinaryExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): BinaryExpressionSyntax;
- public withKind(kind: SyntaxKind): BinaryExpressionSyntax;
- public withLeft(left: IExpressionSyntax): BinaryExpressionSyntax;
- public withOperatorToken(operatorToken: ISyntaxToken): BinaryExpressionSyntax;
- public withRight(right: IExpressionSyntax): BinaryExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ConditionalExpressionSyntax extends SyntaxNode implements IExpressionSyntax {
- public condition: IExpressionSyntax;
- public questionToken: ISyntaxToken;
- public whenTrue: IExpressionSyntax;
- public colonToken: ISyntaxToken;
- public whenFalse: IExpressionSyntax;
- constructor(condition: IExpressionSyntax, questionToken: ISyntaxToken, whenTrue: IExpressionSyntax, colonToken: ISyntaxToken, whenFalse: IExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isExpression(): boolean;
- public update(condition: IExpressionSyntax, questionToken: ISyntaxToken, whenTrue: IExpressionSyntax, colonToken: ISyntaxToken, whenFalse: IExpressionSyntax): ConditionalExpressionSyntax;
- static create1(condition: IExpressionSyntax, whenTrue: IExpressionSyntax, whenFalse: IExpressionSyntax): ConditionalExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ConditionalExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ConditionalExpressionSyntax;
- public withCondition(condition: IExpressionSyntax): ConditionalExpressionSyntax;
- public withQuestionToken(questionToken: ISyntaxToken): ConditionalExpressionSyntax;
- public withWhenTrue(whenTrue: IExpressionSyntax): ConditionalExpressionSyntax;
- public withColonToken(colonToken: ISyntaxToken): ConditionalExpressionSyntax;
- public withWhenFalse(whenFalse: IExpressionSyntax): ConditionalExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ConstructSignatureSyntax extends SyntaxNode implements ITypeMemberSyntax {
- public newKeyword: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- constructor(newKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isTypeMember(): boolean;
- public update(newKeyword: ISyntaxToken, callSignature: CallSignatureSyntax): ConstructSignatureSyntax;
- static create1(): ConstructSignatureSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ConstructSignatureSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ConstructSignatureSyntax;
- public withNewKeyword(newKeyword: ISyntaxToken): ConstructSignatureSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): ConstructSignatureSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class MethodSignatureSyntax extends SyntaxNode implements ITypeMemberSyntax {
- public propertyName: ISyntaxToken;
- public questionToken: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- constructor(propertyName: ISyntaxToken, questionToken: ISyntaxToken, callSignature: CallSignatureSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isTypeMember(): boolean;
- public update(propertyName: ISyntaxToken, questionToken: ISyntaxToken, callSignature: CallSignatureSyntax): MethodSignatureSyntax;
- static create(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax): MethodSignatureSyntax;
- static create1(propertyName: ISyntaxToken): MethodSignatureSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): MethodSignatureSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): MethodSignatureSyntax;
- public withPropertyName(propertyName: ISyntaxToken): MethodSignatureSyntax;
- public withQuestionToken(questionToken: ISyntaxToken): MethodSignatureSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): MethodSignatureSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class IndexSignatureSyntax extends SyntaxNode implements ITypeMemberSyntax {
- public openBracketToken: ISyntaxToken;
- public parameter: ParameterSyntax;
- public closeBracketToken: ISyntaxToken;
- public typeAnnotation: TypeAnnotationSyntax;
- constructor(openBracketToken: ISyntaxToken, parameter: ParameterSyntax, closeBracketToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isTypeMember(): boolean;
- public update(openBracketToken: ISyntaxToken, parameter: ParameterSyntax, closeBracketToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): IndexSignatureSyntax;
- static create(openBracketToken: ISyntaxToken, parameter: ParameterSyntax, closeBracketToken: ISyntaxToken): IndexSignatureSyntax;
- static create1(parameter: ParameterSyntax): IndexSignatureSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): IndexSignatureSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): IndexSignatureSyntax;
- public withOpenBracketToken(openBracketToken: ISyntaxToken): IndexSignatureSyntax;
- public withParameter(parameter: ParameterSyntax): IndexSignatureSyntax;
- public withCloseBracketToken(closeBracketToken: ISyntaxToken): IndexSignatureSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): IndexSignatureSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class PropertySignatureSyntax extends SyntaxNode implements ITypeMemberSyntax {
- public propertyName: ISyntaxToken;
- public questionToken: ISyntaxToken;
- public typeAnnotation: TypeAnnotationSyntax;
- constructor(propertyName: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isTypeMember(): boolean;
- public update(propertyName: ISyntaxToken, questionToken: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax): PropertySignatureSyntax;
- static create(propertyName: ISyntaxToken): PropertySignatureSyntax;
- static create1(propertyName: ISyntaxToken): PropertySignatureSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): PropertySignatureSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): PropertySignatureSyntax;
- public withPropertyName(propertyName: ISyntaxToken): PropertySignatureSyntax;
- public withQuestionToken(questionToken: ISyntaxToken): PropertySignatureSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): PropertySignatureSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class CallSignatureSyntax extends SyntaxNode implements ITypeMemberSyntax {
- public typeParameterList: TypeParameterListSyntax;
- public parameterList: ParameterListSyntax;
- public typeAnnotation: TypeAnnotationSyntax;
- constructor(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isTypeMember(): boolean;
- public update(typeParameterList: TypeParameterListSyntax, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax): CallSignatureSyntax;
- static create(parameterList: ParameterListSyntax): CallSignatureSyntax;
- static create1(): CallSignatureSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): CallSignatureSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): CallSignatureSyntax;
- public withTypeParameterList(typeParameterList: TypeParameterListSyntax): CallSignatureSyntax;
- public withParameterList(parameterList: ParameterListSyntax): CallSignatureSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): CallSignatureSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ParameterListSyntax extends SyntaxNode {
- public openParenToken: ISyntaxToken;
- public parameters: ISeparatedSyntaxList;
- public closeParenToken: ISyntaxToken;
- constructor(openParenToken: ISyntaxToken, parameters: ISeparatedSyntaxList, closeParenToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(openParenToken: ISyntaxToken, parameters: ISeparatedSyntaxList, closeParenToken: ISyntaxToken): ParameterListSyntax;
- static create(openParenToken: ISyntaxToken, closeParenToken: ISyntaxToken): ParameterListSyntax;
- static create1(): ParameterListSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ParameterListSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ParameterListSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): ParameterListSyntax;
- public withParameters(parameters: ISeparatedSyntaxList): ParameterListSyntax;
- public withParameter(parameter: ParameterSyntax): ParameterListSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): ParameterListSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TypeParameterListSyntax extends SyntaxNode {
- public lessThanToken: ISyntaxToken;
- public typeParameters: ISeparatedSyntaxList;
- public greaterThanToken: ISyntaxToken;
- constructor(lessThanToken: ISyntaxToken, typeParameters: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(lessThanToken: ISyntaxToken, typeParameters: ISeparatedSyntaxList, greaterThanToken: ISyntaxToken): TypeParameterListSyntax;
- static create(lessThanToken: ISyntaxToken, greaterThanToken: ISyntaxToken): TypeParameterListSyntax;
- static create1(): TypeParameterListSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TypeParameterListSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TypeParameterListSyntax;
- public withLessThanToken(lessThanToken: ISyntaxToken): TypeParameterListSyntax;
- public withTypeParameters(typeParameters: ISeparatedSyntaxList): TypeParameterListSyntax;
- public withTypeParameter(typeParameter: TypeParameterSyntax): TypeParameterListSyntax;
- public withGreaterThanToken(greaterThanToken: ISyntaxToken): TypeParameterListSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TypeParameterSyntax extends SyntaxNode {
- public identifier: ISyntaxToken;
- public constraint: ConstraintSyntax;
- constructor(identifier: ISyntaxToken, constraint: ConstraintSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(identifier: ISyntaxToken, constraint: ConstraintSyntax): TypeParameterSyntax;
- static create(identifier: ISyntaxToken): TypeParameterSyntax;
- static create1(identifier: ISyntaxToken): TypeParameterSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TypeParameterSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TypeParameterSyntax;
- public withIdentifier(identifier: ISyntaxToken): TypeParameterSyntax;
- public withConstraint(constraint: ConstraintSyntax): TypeParameterSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ConstraintSyntax extends SyntaxNode {
- public extendsKeyword: ISyntaxToken;
- public type: ITypeSyntax;
- constructor(extendsKeyword: ISyntaxToken, type: ITypeSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(extendsKeyword: ISyntaxToken, type: ITypeSyntax): ConstraintSyntax;
- static create1(type: ITypeSyntax): ConstraintSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ConstraintSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ConstraintSyntax;
- public withExtendsKeyword(extendsKeyword: ISyntaxToken): ConstraintSyntax;
- public withType(type: ITypeSyntax): ConstraintSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ElseClauseSyntax extends SyntaxNode {
- public elseKeyword: ISyntaxToken;
- public statement: IStatementSyntax;
- constructor(elseKeyword: ISyntaxToken, statement: IStatementSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(elseKeyword: ISyntaxToken, statement: IStatementSyntax): ElseClauseSyntax;
- static create1(statement: IStatementSyntax): ElseClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ElseClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ElseClauseSyntax;
- public withElseKeyword(elseKeyword: ISyntaxToken): ElseClauseSyntax;
- public withStatement(statement: IStatementSyntax): ElseClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class IfStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public ifKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public condition: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public statement: IStatementSyntax;
- public elseClause: ElseClauseSyntax;
- constructor(ifKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, elseClause: ElseClauseSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(ifKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, elseClause: ElseClauseSyntax): IfStatementSyntax;
- static create(ifKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): IfStatementSyntax;
- static create1(condition: IExpressionSyntax, statement: IStatementSyntax): IfStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): IfStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): IfStatementSyntax;
- public withIfKeyword(ifKeyword: ISyntaxToken): IfStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): IfStatementSyntax;
- public withCondition(condition: IExpressionSyntax): IfStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): IfStatementSyntax;
- public withStatement(statement: IStatementSyntax): IfStatementSyntax;
- public withElseClause(elseClause: ElseClauseSyntax): IfStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ExpressionStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public expression: IExpressionSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(expression: IExpressionSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ExpressionStatementSyntax;
- static create1(expression: IExpressionSyntax): ExpressionStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ExpressionStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ExpressionStatementSyntax;
- public withExpression(expression: IExpressionSyntax): ExpressionStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ExpressionStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ConstructorDeclarationSyntax extends SyntaxNode implements IClassElementSyntax {
- public modifiers: ISyntaxList;
- public constructorKeyword: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- public block: BlockSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, constructorKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isClassElement(): boolean;
- public update(modifiers: ISyntaxList, constructorKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): ConstructorDeclarationSyntax;
- static create(constructorKeyword: ISyntaxToken, callSignature: CallSignatureSyntax): ConstructorDeclarationSyntax;
- static create1(): ConstructorDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ConstructorDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ConstructorDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): ConstructorDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): ConstructorDeclarationSyntax;
- public withConstructorKeyword(constructorKeyword: ISyntaxToken): ConstructorDeclarationSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): ConstructorDeclarationSyntax;
- public withBlock(block: BlockSyntax): ConstructorDeclarationSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ConstructorDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class MemberFunctionDeclarationSyntax extends SyntaxNode implements IMemberDeclarationSyntax {
- public modifiers: ISyntaxList;
- public propertyName: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- public block: BlockSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberDeclaration(): boolean;
- public isClassElement(): boolean;
- public update(modifiers: ISyntaxList, propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, semicolonToken: ISyntaxToken): MemberFunctionDeclarationSyntax;
- static create(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax): MemberFunctionDeclarationSyntax;
- static create1(propertyName: ISyntaxToken): MemberFunctionDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): MemberFunctionDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): MemberFunctionDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): MemberFunctionDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): MemberFunctionDeclarationSyntax;
- public withPropertyName(propertyName: ISyntaxToken): MemberFunctionDeclarationSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): MemberFunctionDeclarationSyntax;
- public withBlock(block: BlockSyntax): MemberFunctionDeclarationSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): MemberFunctionDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class GetAccessorSyntax extends SyntaxNode implements IMemberDeclarationSyntax, IPropertyAssignmentSyntax {
- public modifiers: ISyntaxList;
- public getKeyword: ISyntaxToken;
- public propertyName: ISyntaxToken;
- public parameterList: ParameterListSyntax;
- public typeAnnotation: TypeAnnotationSyntax;
- public block: BlockSyntax;
- constructor(modifiers: ISyntaxList, getKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax, block: BlockSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberDeclaration(): boolean;
- public isPropertyAssignment(): boolean;
- public isClassElement(): boolean;
- public update(modifiers: ISyntaxList, getKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, typeAnnotation: TypeAnnotationSyntax, block: BlockSyntax): GetAccessorSyntax;
- static create(getKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax): GetAccessorSyntax;
- static create1(propertyName: ISyntaxToken): GetAccessorSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): GetAccessorSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): GetAccessorSyntax;
- public withModifiers(modifiers: ISyntaxList): GetAccessorSyntax;
- public withModifier(modifier: ISyntaxToken): GetAccessorSyntax;
- public withGetKeyword(getKeyword: ISyntaxToken): GetAccessorSyntax;
- public withPropertyName(propertyName: ISyntaxToken): GetAccessorSyntax;
- public withParameterList(parameterList: ParameterListSyntax): GetAccessorSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): GetAccessorSyntax;
- public withBlock(block: BlockSyntax): GetAccessorSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class SetAccessorSyntax extends SyntaxNode implements IMemberDeclarationSyntax, IPropertyAssignmentSyntax {
- public modifiers: ISyntaxList;
- public setKeyword: ISyntaxToken;
- public propertyName: ISyntaxToken;
- public parameterList: ParameterListSyntax;
- public block: BlockSyntax;
- constructor(modifiers: ISyntaxList, setKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberDeclaration(): boolean;
- public isPropertyAssignment(): boolean;
- public isClassElement(): boolean;
- public update(modifiers: ISyntaxList, setKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax): SetAccessorSyntax;
- static create(setKeyword: ISyntaxToken, propertyName: ISyntaxToken, parameterList: ParameterListSyntax, block: BlockSyntax): SetAccessorSyntax;
- static create1(propertyName: ISyntaxToken): SetAccessorSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): SetAccessorSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): SetAccessorSyntax;
- public withModifiers(modifiers: ISyntaxList): SetAccessorSyntax;
- public withModifier(modifier: ISyntaxToken): SetAccessorSyntax;
- public withSetKeyword(setKeyword: ISyntaxToken): SetAccessorSyntax;
- public withPropertyName(propertyName: ISyntaxToken): SetAccessorSyntax;
- public withParameterList(parameterList: ParameterListSyntax): SetAccessorSyntax;
- public withBlock(block: BlockSyntax): SetAccessorSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class MemberVariableDeclarationSyntax extends SyntaxNode implements IMemberDeclarationSyntax {
- public modifiers: ISyntaxList;
- public variableDeclarator: VariableDeclaratorSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, variableDeclarator: VariableDeclaratorSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberDeclaration(): boolean;
- public isClassElement(): boolean;
- public update(modifiers: ISyntaxList, variableDeclarator: VariableDeclaratorSyntax, semicolonToken: ISyntaxToken): MemberVariableDeclarationSyntax;
- static create(variableDeclarator: VariableDeclaratorSyntax, semicolonToken: ISyntaxToken): MemberVariableDeclarationSyntax;
- static create1(variableDeclarator: VariableDeclaratorSyntax): MemberVariableDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): MemberVariableDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): MemberVariableDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): MemberVariableDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): MemberVariableDeclarationSyntax;
- public withVariableDeclarator(variableDeclarator: VariableDeclaratorSyntax): MemberVariableDeclarationSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): MemberVariableDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class IndexMemberDeclarationSyntax extends SyntaxNode implements IClassElementSyntax {
- public modifiers: ISyntaxList;
- public indexSignature: IndexSignatureSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, indexSignature: IndexSignatureSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isClassElement(): boolean;
- public update(modifiers: ISyntaxList, indexSignature: IndexSignatureSyntax, semicolonToken: ISyntaxToken): IndexMemberDeclarationSyntax;
- static create(indexSignature: IndexSignatureSyntax, semicolonToken: ISyntaxToken): IndexMemberDeclarationSyntax;
- static create1(indexSignature: IndexSignatureSyntax): IndexMemberDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): IndexMemberDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): IndexMemberDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): IndexMemberDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): IndexMemberDeclarationSyntax;
- public withIndexSignature(indexSignature: IndexSignatureSyntax): IndexMemberDeclarationSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): IndexMemberDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ThrowStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public throwKeyword: ISyntaxToken;
- public expression: IExpressionSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(throwKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(throwKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ThrowStatementSyntax;
- static create1(expression: IExpressionSyntax): ThrowStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ThrowStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ThrowStatementSyntax;
- public withThrowKeyword(throwKeyword: ISyntaxToken): ThrowStatementSyntax;
- public withExpression(expression: IExpressionSyntax): ThrowStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ThrowStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ReturnStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public returnKeyword: ISyntaxToken;
- public expression: IExpressionSyntax;
- public semicolonToken: ISyntaxToken;
- constructor(returnKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(returnKeyword: ISyntaxToken, expression: IExpressionSyntax, semicolonToken: ISyntaxToken): ReturnStatementSyntax;
- static create(returnKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): ReturnStatementSyntax;
- static create1(): ReturnStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ReturnStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ReturnStatementSyntax;
- public withReturnKeyword(returnKeyword: ISyntaxToken): ReturnStatementSyntax;
- public withExpression(expression: IExpressionSyntax): ReturnStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ReturnStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ObjectCreationExpressionSyntax extends SyntaxNode implements IMemberExpressionSyntax {
- public newKeyword: ISyntaxToken;
- public expression: IMemberExpressionSyntax;
- public argumentList: ArgumentListSyntax;
- constructor(newKeyword: ISyntaxToken, expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(newKeyword: ISyntaxToken, expression: IMemberExpressionSyntax, argumentList: ArgumentListSyntax): ObjectCreationExpressionSyntax;
- static create(newKeyword: ISyntaxToken, expression: IMemberExpressionSyntax): ObjectCreationExpressionSyntax;
- static create1(expression: IMemberExpressionSyntax): ObjectCreationExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ObjectCreationExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ObjectCreationExpressionSyntax;
- public withNewKeyword(newKeyword: ISyntaxToken): ObjectCreationExpressionSyntax;
- public withExpression(expression: IMemberExpressionSyntax): ObjectCreationExpressionSyntax;
- public withArgumentList(argumentList: ArgumentListSyntax): ObjectCreationExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class SwitchStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public switchKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public expression: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public openBraceToken: ISyntaxToken;
- public switchClauses: ISyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(switchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, openBraceToken: ISyntaxToken, switchClauses: ISyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(switchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, openBraceToken: ISyntaxToken, switchClauses: ISyntaxList, closeBraceToken: ISyntaxToken): SwitchStatementSyntax;
- static create(switchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): SwitchStatementSyntax;
- static create1(expression: IExpressionSyntax): SwitchStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): SwitchStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): SwitchStatementSyntax;
- public withSwitchKeyword(switchKeyword: ISyntaxToken): SwitchStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): SwitchStatementSyntax;
- public withExpression(expression: IExpressionSyntax): SwitchStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): SwitchStatementSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): SwitchStatementSyntax;
- public withSwitchClauses(switchClauses: ISyntaxList): SwitchStatementSyntax;
- public withSwitchClause(switchClause: ISwitchClauseSyntax): SwitchStatementSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): SwitchStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class CaseSwitchClauseSyntax extends SyntaxNode implements ISwitchClauseSyntax {
- public caseKeyword: ISyntaxToken;
- public expression: IExpressionSyntax;
- public colonToken: ISyntaxToken;
- public statements: ISyntaxList;
- constructor(caseKeyword: ISyntaxToken, expression: IExpressionSyntax, colonToken: ISyntaxToken, statements: ISyntaxList, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isSwitchClause(): boolean;
- public update(caseKeyword: ISyntaxToken, expression: IExpressionSyntax, colonToken: ISyntaxToken, statements: ISyntaxList): CaseSwitchClauseSyntax;
- static create(caseKeyword: ISyntaxToken, expression: IExpressionSyntax, colonToken: ISyntaxToken): CaseSwitchClauseSyntax;
- static create1(expression: IExpressionSyntax): CaseSwitchClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): CaseSwitchClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): CaseSwitchClauseSyntax;
- public withCaseKeyword(caseKeyword: ISyntaxToken): CaseSwitchClauseSyntax;
- public withExpression(expression: IExpressionSyntax): CaseSwitchClauseSyntax;
- public withColonToken(colonToken: ISyntaxToken): CaseSwitchClauseSyntax;
- public withStatements(statements: ISyntaxList): CaseSwitchClauseSyntax;
- public withStatement(statement: IStatementSyntax): CaseSwitchClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class DefaultSwitchClauseSyntax extends SyntaxNode implements ISwitchClauseSyntax {
- public defaultKeyword: ISyntaxToken;
- public colonToken: ISyntaxToken;
- public statements: ISyntaxList;
- constructor(defaultKeyword: ISyntaxToken, colonToken: ISyntaxToken, statements: ISyntaxList, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isSwitchClause(): boolean;
- public update(defaultKeyword: ISyntaxToken, colonToken: ISyntaxToken, statements: ISyntaxList): DefaultSwitchClauseSyntax;
- static create(defaultKeyword: ISyntaxToken, colonToken: ISyntaxToken): DefaultSwitchClauseSyntax;
- static create1(): DefaultSwitchClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): DefaultSwitchClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): DefaultSwitchClauseSyntax;
- public withDefaultKeyword(defaultKeyword: ISyntaxToken): DefaultSwitchClauseSyntax;
- public withColonToken(colonToken: ISyntaxToken): DefaultSwitchClauseSyntax;
- public withStatements(statements: ISyntaxList): DefaultSwitchClauseSyntax;
- public withStatement(statement: IStatementSyntax): DefaultSwitchClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class BreakStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public breakKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public semicolonToken: ISyntaxToken;
- constructor(breakKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(breakKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): BreakStatementSyntax;
- static create(breakKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): BreakStatementSyntax;
- static create1(): BreakStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): BreakStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): BreakStatementSyntax;
- public withBreakKeyword(breakKeyword: ISyntaxToken): BreakStatementSyntax;
- public withIdentifier(identifier: ISyntaxToken): BreakStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): BreakStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ContinueStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public continueKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public semicolonToken: ISyntaxToken;
- constructor(continueKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(continueKeyword: ISyntaxToken, identifier: ISyntaxToken, semicolonToken: ISyntaxToken): ContinueStatementSyntax;
- static create(continueKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): ContinueStatementSyntax;
- static create1(): ContinueStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ContinueStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ContinueStatementSyntax;
- public withContinueKeyword(continueKeyword: ISyntaxToken): ContinueStatementSyntax;
- public withIdentifier(identifier: ISyntaxToken): ContinueStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): ContinueStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ForStatementSyntax extends SyntaxNode implements IIterationStatementSyntax {
- public forKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public variableDeclaration: VariableDeclarationSyntax;
- public initializer: IExpressionSyntax;
- public firstSemicolonToken: ISyntaxToken;
- public condition: IExpressionSyntax;
- public secondSemicolonToken: ISyntaxToken;
- public incrementor: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public statement: IStatementSyntax;
- constructor(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, initializer: IExpressionSyntax, firstSemicolonToken: ISyntaxToken, condition: IExpressionSyntax, secondSemicolonToken: ISyntaxToken, incrementor: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isIterationStatement(): boolean;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, initializer: IExpressionSyntax, firstSemicolonToken: ISyntaxToken, condition: IExpressionSyntax, secondSemicolonToken: ISyntaxToken, incrementor: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForStatementSyntax;
- static create(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, firstSemicolonToken: ISyntaxToken, secondSemicolonToken: ISyntaxToken, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForStatementSyntax;
- static create1(statement: IStatementSyntax): ForStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ForStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ForStatementSyntax;
- public withForKeyword(forKeyword: ISyntaxToken): ForStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): ForStatementSyntax;
- public withVariableDeclaration(variableDeclaration: VariableDeclarationSyntax): ForStatementSyntax;
- public withInitializer(initializer: IExpressionSyntax): ForStatementSyntax;
- public withFirstSemicolonToken(firstSemicolonToken: ISyntaxToken): ForStatementSyntax;
- public withCondition(condition: IExpressionSyntax): ForStatementSyntax;
- public withSecondSemicolonToken(secondSemicolonToken: ISyntaxToken): ForStatementSyntax;
- public withIncrementor(incrementor: IExpressionSyntax): ForStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): ForStatementSyntax;
- public withStatement(statement: IStatementSyntax): ForStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ForInStatementSyntax extends SyntaxNode implements IIterationStatementSyntax {
- public forKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public variableDeclaration: VariableDeclarationSyntax;
- public left: IExpressionSyntax;
- public inKeyword: ISyntaxToken;
- public expression: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public statement: IStatementSyntax;
- constructor(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, left: IExpressionSyntax, inKeyword: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isIterationStatement(): boolean;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, variableDeclaration: VariableDeclarationSyntax, left: IExpressionSyntax, inKeyword: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForInStatementSyntax;
- static create(forKeyword: ISyntaxToken, openParenToken: ISyntaxToken, inKeyword: ISyntaxToken, expression: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): ForInStatementSyntax;
- static create1(expression: IExpressionSyntax, statement: IStatementSyntax): ForInStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ForInStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ForInStatementSyntax;
- public withForKeyword(forKeyword: ISyntaxToken): ForInStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): ForInStatementSyntax;
- public withVariableDeclaration(variableDeclaration: VariableDeclarationSyntax): ForInStatementSyntax;
- public withLeft(left: IExpressionSyntax): ForInStatementSyntax;
- public withInKeyword(inKeyword: ISyntaxToken): ForInStatementSyntax;
- public withExpression(expression: IExpressionSyntax): ForInStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): ForInStatementSyntax;
- public withStatement(statement: IStatementSyntax): ForInStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class WhileStatementSyntax extends SyntaxNode implements IIterationStatementSyntax {
- public whileKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public condition: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public statement: IStatementSyntax;
- constructor(whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isIterationStatement(): boolean;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WhileStatementSyntax;
- static create1(condition: IExpressionSyntax, statement: IStatementSyntax): WhileStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): WhileStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): WhileStatementSyntax;
- public withWhileKeyword(whileKeyword: ISyntaxToken): WhileStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): WhileStatementSyntax;
- public withCondition(condition: IExpressionSyntax): WhileStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): WhileStatementSyntax;
- public withStatement(statement: IStatementSyntax): WhileStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class WithStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public withKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public condition: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public statement: IStatementSyntax;
- constructor(withKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(withKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, statement: IStatementSyntax): WithStatementSyntax;
- static create1(condition: IExpressionSyntax, statement: IStatementSyntax): WithStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): WithStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): WithStatementSyntax;
- public withWithKeyword(withKeyword: ISyntaxToken): WithStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): WithStatementSyntax;
- public withCondition(condition: IExpressionSyntax): WithStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): WithStatementSyntax;
- public withStatement(statement: IStatementSyntax): WithStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class EnumDeclarationSyntax extends SyntaxNode implements IModuleElementSyntax {
- public modifiers: ISyntaxList;
- public enumKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public openBraceToken: ISyntaxToken;
- public enumElements: ISeparatedSyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(modifiers: ISyntaxList, enumKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, enumElements: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isModuleElement(): boolean;
- public update(modifiers: ISyntaxList, enumKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, enumElements: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- static create(enumKeyword: ISyntaxToken, identifier: ISyntaxToken, openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- static create1(identifier: ISyntaxToken): EnumDeclarationSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): EnumDeclarationSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): EnumDeclarationSyntax;
- public withModifiers(modifiers: ISyntaxList): EnumDeclarationSyntax;
- public withModifier(modifier: ISyntaxToken): EnumDeclarationSyntax;
- public withEnumKeyword(enumKeyword: ISyntaxToken): EnumDeclarationSyntax;
- public withIdentifier(identifier: ISyntaxToken): EnumDeclarationSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- public withEnumElements(enumElements: ISeparatedSyntaxList): EnumDeclarationSyntax;
- public withEnumElement(enumElement: EnumElementSyntax): EnumDeclarationSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): EnumDeclarationSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class EnumElementSyntax extends SyntaxNode {
- public propertyName: ISyntaxToken;
- public equalsValueClause: EqualsValueClauseSyntax;
- constructor(propertyName: ISyntaxToken, equalsValueClause: EqualsValueClauseSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(propertyName: ISyntaxToken, equalsValueClause: EqualsValueClauseSyntax): EnumElementSyntax;
- static create(propertyName: ISyntaxToken): EnumElementSyntax;
- static create1(propertyName: ISyntaxToken): EnumElementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): EnumElementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): EnumElementSyntax;
- public withPropertyName(propertyName: ISyntaxToken): EnumElementSyntax;
- public withEqualsValueClause(equalsValueClause: EqualsValueClauseSyntax): EnumElementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class CastExpressionSyntax extends SyntaxNode implements IUnaryExpressionSyntax {
- public lessThanToken: ISyntaxToken;
- public type: ITypeSyntax;
- public greaterThanToken: ISyntaxToken;
- public expression: IUnaryExpressionSyntax;
- constructor(lessThanToken: ISyntaxToken, type: ITypeSyntax, greaterThanToken: ISyntaxToken, expression: IUnaryExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(lessThanToken: ISyntaxToken, type: ITypeSyntax, greaterThanToken: ISyntaxToken, expression: IUnaryExpressionSyntax): CastExpressionSyntax;
- static create1(type: ITypeSyntax, expression: IUnaryExpressionSyntax): CastExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): CastExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): CastExpressionSyntax;
- public withLessThanToken(lessThanToken: ISyntaxToken): CastExpressionSyntax;
- public withType(type: ITypeSyntax): CastExpressionSyntax;
- public withGreaterThanToken(greaterThanToken: ISyntaxToken): CastExpressionSyntax;
- public withExpression(expression: IUnaryExpressionSyntax): CastExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class ObjectLiteralExpressionSyntax extends SyntaxNode implements IPrimaryExpressionSyntax {
- public openBraceToken: ISyntaxToken;
- public propertyAssignments: ISeparatedSyntaxList;
- public closeBraceToken: ISyntaxToken;
- constructor(openBraceToken: ISyntaxToken, propertyAssignments: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(openBraceToken: ISyntaxToken, propertyAssignments: ISeparatedSyntaxList, closeBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- static create(openBraceToken: ISyntaxToken, closeBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- static create1(): ObjectLiteralExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): ObjectLiteralExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): ObjectLiteralExpressionSyntax;
- public withOpenBraceToken(openBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- public withPropertyAssignments(propertyAssignments: ISeparatedSyntaxList): ObjectLiteralExpressionSyntax;
- public withPropertyAssignment(propertyAssignment: IPropertyAssignmentSyntax): ObjectLiteralExpressionSyntax;
- public withCloseBraceToken(closeBraceToken: ISyntaxToken): ObjectLiteralExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class SimplePropertyAssignmentSyntax extends SyntaxNode implements IPropertyAssignmentSyntax {
- public propertyName: ISyntaxToken;
- public colonToken: ISyntaxToken;
- public expression: IExpressionSyntax;
- constructor(propertyName: ISyntaxToken, colonToken: ISyntaxToken, expression: IExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPropertyAssignment(): boolean;
- public update(propertyName: ISyntaxToken, colonToken: ISyntaxToken, expression: IExpressionSyntax): SimplePropertyAssignmentSyntax;
- static create1(propertyName: ISyntaxToken, expression: IExpressionSyntax): SimplePropertyAssignmentSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): SimplePropertyAssignmentSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): SimplePropertyAssignmentSyntax;
- public withPropertyName(propertyName: ISyntaxToken): SimplePropertyAssignmentSyntax;
- public withColonToken(colonToken: ISyntaxToken): SimplePropertyAssignmentSyntax;
- public withExpression(expression: IExpressionSyntax): SimplePropertyAssignmentSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class FunctionPropertyAssignmentSyntax extends SyntaxNode implements IPropertyAssignmentSyntax {
- public propertyName: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- public block: BlockSyntax;
- constructor(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPropertyAssignment(): boolean;
- public update(propertyName: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionPropertyAssignmentSyntax;
- static create1(propertyName: ISyntaxToken): FunctionPropertyAssignmentSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): FunctionPropertyAssignmentSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): FunctionPropertyAssignmentSyntax;
- public withPropertyName(propertyName: ISyntaxToken): FunctionPropertyAssignmentSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): FunctionPropertyAssignmentSyntax;
- public withBlock(block: BlockSyntax): FunctionPropertyAssignmentSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class FunctionExpressionSyntax extends SyntaxNode implements IPrimaryExpressionSyntax {
- public functionKeyword: ISyntaxToken;
- public identifier: ISyntaxToken;
- public callSignature: CallSignatureSyntax;
- public block: BlockSyntax;
- constructor(functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(functionKeyword: ISyntaxToken, identifier: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionExpressionSyntax;
- static create(functionKeyword: ISyntaxToken, callSignature: CallSignatureSyntax, block: BlockSyntax): FunctionExpressionSyntax;
- static create1(): FunctionExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): FunctionExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): FunctionExpressionSyntax;
- public withFunctionKeyword(functionKeyword: ISyntaxToken): FunctionExpressionSyntax;
- public withIdentifier(identifier: ISyntaxToken): FunctionExpressionSyntax;
- public withCallSignature(callSignature: CallSignatureSyntax): FunctionExpressionSyntax;
- public withBlock(block: BlockSyntax): FunctionExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class EmptyStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public semicolonToken: ISyntaxToken;
- constructor(semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(semicolonToken: ISyntaxToken): EmptyStatementSyntax;
- static create1(): EmptyStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): EmptyStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): EmptyStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): EmptyStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TryStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public tryKeyword: ISyntaxToken;
- public block: BlockSyntax;
- public catchClause: CatchClauseSyntax;
- public finallyClause: FinallyClauseSyntax;
- constructor(tryKeyword: ISyntaxToken, block: BlockSyntax, catchClause: CatchClauseSyntax, finallyClause: FinallyClauseSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(tryKeyword: ISyntaxToken, block: BlockSyntax, catchClause: CatchClauseSyntax, finallyClause: FinallyClauseSyntax): TryStatementSyntax;
- static create(tryKeyword: ISyntaxToken, block: BlockSyntax): TryStatementSyntax;
- static create1(): TryStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TryStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TryStatementSyntax;
- public withTryKeyword(tryKeyword: ISyntaxToken): TryStatementSyntax;
- public withBlock(block: BlockSyntax): TryStatementSyntax;
- public withCatchClause(catchClause: CatchClauseSyntax): TryStatementSyntax;
- public withFinallyClause(finallyClause: FinallyClauseSyntax): TryStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class CatchClauseSyntax extends SyntaxNode {
- public catchKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public identifier: ISyntaxToken;
- public typeAnnotation: TypeAnnotationSyntax;
- public closeParenToken: ISyntaxToken;
- public block: BlockSyntax;
- constructor(catchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, identifier: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, closeParenToken: ISyntaxToken, block: BlockSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(catchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, identifier: ISyntaxToken, typeAnnotation: TypeAnnotationSyntax, closeParenToken: ISyntaxToken, block: BlockSyntax): CatchClauseSyntax;
- static create(catchKeyword: ISyntaxToken, openParenToken: ISyntaxToken, identifier: ISyntaxToken, closeParenToken: ISyntaxToken, block: BlockSyntax): CatchClauseSyntax;
- static create1(identifier: ISyntaxToken): CatchClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): CatchClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): CatchClauseSyntax;
- public withCatchKeyword(catchKeyword: ISyntaxToken): CatchClauseSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): CatchClauseSyntax;
- public withIdentifier(identifier: ISyntaxToken): CatchClauseSyntax;
- public withTypeAnnotation(typeAnnotation: TypeAnnotationSyntax): CatchClauseSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): CatchClauseSyntax;
- public withBlock(block: BlockSyntax): CatchClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class FinallyClauseSyntax extends SyntaxNode {
- public finallyKeyword: ISyntaxToken;
- public block: BlockSyntax;
- constructor(finallyKeyword: ISyntaxToken, block: BlockSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public update(finallyKeyword: ISyntaxToken, block: BlockSyntax): FinallyClauseSyntax;
- static create1(): FinallyClauseSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): FinallyClauseSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): FinallyClauseSyntax;
- public withFinallyKeyword(finallyKeyword: ISyntaxToken): FinallyClauseSyntax;
- public withBlock(block: BlockSyntax): FinallyClauseSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class LabeledStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public identifier: ISyntaxToken;
- public colonToken: ISyntaxToken;
- public statement: IStatementSyntax;
- constructor(identifier: ISyntaxToken, colonToken: ISyntaxToken, statement: IStatementSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(identifier: ISyntaxToken, colonToken: ISyntaxToken, statement: IStatementSyntax): LabeledStatementSyntax;
- static create1(identifier: ISyntaxToken, statement: IStatementSyntax): LabeledStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): LabeledStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): LabeledStatementSyntax;
- public withIdentifier(identifier: ISyntaxToken): LabeledStatementSyntax;
- public withColonToken(colonToken: ISyntaxToken): LabeledStatementSyntax;
- public withStatement(statement: IStatementSyntax): LabeledStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class DoStatementSyntax extends SyntaxNode implements IIterationStatementSyntax {
- public doKeyword: ISyntaxToken;
- public statement: IStatementSyntax;
- public whileKeyword: ISyntaxToken;
- public openParenToken: ISyntaxToken;
- public condition: IExpressionSyntax;
- public closeParenToken: ISyntaxToken;
- public semicolonToken: ISyntaxToken;
- constructor(doKeyword: ISyntaxToken, statement: IStatementSyntax, whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isIterationStatement(): boolean;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(doKeyword: ISyntaxToken, statement: IStatementSyntax, whileKeyword: ISyntaxToken, openParenToken: ISyntaxToken, condition: IExpressionSyntax, closeParenToken: ISyntaxToken, semicolonToken: ISyntaxToken): DoStatementSyntax;
- static create1(statement: IStatementSyntax, condition: IExpressionSyntax): DoStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): DoStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): DoStatementSyntax;
- public withDoKeyword(doKeyword: ISyntaxToken): DoStatementSyntax;
- public withStatement(statement: IStatementSyntax): DoStatementSyntax;
- public withWhileKeyword(whileKeyword: ISyntaxToken): DoStatementSyntax;
- public withOpenParenToken(openParenToken: ISyntaxToken): DoStatementSyntax;
- public withCondition(condition: IExpressionSyntax): DoStatementSyntax;
- public withCloseParenToken(closeParenToken: ISyntaxToken): DoStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): DoStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class TypeOfExpressionSyntax extends SyntaxNode implements IUnaryExpressionSyntax {
- public typeOfKeyword: ISyntaxToken;
- public expression: IUnaryExpressionSyntax;
- constructor(typeOfKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(typeOfKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): TypeOfExpressionSyntax;
- static create1(expression: IUnaryExpressionSyntax): TypeOfExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): TypeOfExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): TypeOfExpressionSyntax;
- public withTypeOfKeyword(typeOfKeyword: ISyntaxToken): TypeOfExpressionSyntax;
- public withExpression(expression: IUnaryExpressionSyntax): TypeOfExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class DeleteExpressionSyntax extends SyntaxNode implements IUnaryExpressionSyntax {
- public deleteKeyword: ISyntaxToken;
- public expression: IUnaryExpressionSyntax;
- constructor(deleteKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(deleteKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): DeleteExpressionSyntax;
- static create1(expression: IUnaryExpressionSyntax): DeleteExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): DeleteExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): DeleteExpressionSyntax;
- public withDeleteKeyword(deleteKeyword: ISyntaxToken): DeleteExpressionSyntax;
- public withExpression(expression: IUnaryExpressionSyntax): DeleteExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class VoidExpressionSyntax extends SyntaxNode implements IUnaryExpressionSyntax {
- public voidKeyword: ISyntaxToken;
- public expression: IUnaryExpressionSyntax;
- constructor(voidKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isUnaryExpression(): boolean;
- public isExpression(): boolean;
- public update(voidKeyword: ISyntaxToken, expression: IUnaryExpressionSyntax): VoidExpressionSyntax;
- static create1(expression: IUnaryExpressionSyntax): VoidExpressionSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): VoidExpressionSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): VoidExpressionSyntax;
- public withVoidKeyword(voidKeyword: ISyntaxToken): VoidExpressionSyntax;
- public withExpression(expression: IUnaryExpressionSyntax): VoidExpressionSyntax;
- public isTypeScriptSpecific(): boolean;
- }
- class DebuggerStatementSyntax extends SyntaxNode implements IStatementSyntax {
- public debuggerKeyword: ISyntaxToken;
- public semicolonToken: ISyntaxToken;
- constructor(debuggerKeyword: ISyntaxToken, semicolonToken: ISyntaxToken, parsedInStrictMode: boolean);
- public accept(visitor: ISyntaxVisitor): any;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(slot: number): ISyntaxElement;
- public isStatement(): boolean;
- public isModuleElement(): boolean;
- public update(debuggerKeyword: ISyntaxToken, semicolonToken: ISyntaxToken): DebuggerStatementSyntax;
- static create1(): DebuggerStatementSyntax;
- public withLeadingTrivia(trivia: ISyntaxTriviaList): DebuggerStatementSyntax;
- public withTrailingTrivia(trivia: ISyntaxTriviaList): DebuggerStatementSyntax;
- public withDebuggerKeyword(debuggerKeyword: ISyntaxToken): DebuggerStatementSyntax;
- public withSemicolonToken(semicolonToken: ISyntaxToken): DebuggerStatementSyntax;
- public isTypeScriptSpecific(): boolean;
- }
-}
-declare module TypeScript {
- class SyntaxRewriter implements ISyntaxVisitor {
- public visitToken(token: ISyntaxToken): ISyntaxToken;
- public visitNode(node: SyntaxNode): SyntaxNode;
- public visitNodeOrToken(node: ISyntaxNodeOrToken): ISyntaxNodeOrToken;
- public visitList(list: ISyntaxList): ISyntaxList;
- public visitSeparatedList(list: ISeparatedSyntaxList): ISeparatedSyntaxList;
- public visitSourceUnit(node: SourceUnitSyntax): any;
- public visitExternalModuleReference(node: ExternalModuleReferenceSyntax): any;
- public visitModuleNameModuleReference(node: ModuleNameModuleReferenceSyntax): any;
- public visitImportDeclaration(node: ImportDeclarationSyntax): any;
- public visitExportAssignment(node: ExportAssignmentSyntax): any;
- public visitClassDeclaration(node: ClassDeclarationSyntax): any;
- public visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): any;
- public visitHeritageClause(node: HeritageClauseSyntax): any;
- public visitModuleDeclaration(node: ModuleDeclarationSyntax): any;
- public visitFunctionDeclaration(node: FunctionDeclarationSyntax): any;
- public visitVariableStatement(node: VariableStatementSyntax): any;
- public visitVariableDeclaration(node: VariableDeclarationSyntax): any;
- public visitVariableDeclarator(node: VariableDeclaratorSyntax): any;
- public visitEqualsValueClause(node: EqualsValueClauseSyntax): any;
- public visitPrefixUnaryExpression(node: PrefixUnaryExpressionSyntax): any;
- public visitArrayLiteralExpression(node: ArrayLiteralExpressionSyntax): any;
- public visitOmittedExpression(node: OmittedExpressionSyntax): any;
- public visitParenthesizedExpression(node: ParenthesizedExpressionSyntax): any;
- public visitSimpleArrowFunctionExpression(node: SimpleArrowFunctionExpressionSyntax): any;
- public visitParenthesizedArrowFunctionExpression(node: ParenthesizedArrowFunctionExpressionSyntax): any;
- public visitQualifiedName(node: QualifiedNameSyntax): any;
- public visitTypeArgumentList(node: TypeArgumentListSyntax): any;
- public visitConstructorType(node: ConstructorTypeSyntax): any;
- public visitFunctionType(node: FunctionTypeSyntax): any;
- public visitObjectType(node: ObjectTypeSyntax): any;
- public visitArrayType(node: ArrayTypeSyntax): any;
- public visitGenericType(node: GenericTypeSyntax): any;
- public visitTypeQuery(node: TypeQuerySyntax): any;
- public visitTypeAnnotation(node: TypeAnnotationSyntax): any;
- public visitBlock(node: BlockSyntax): any;
- public visitParameter(node: ParameterSyntax): any;
- public visitMemberAccessExpression(node: MemberAccessExpressionSyntax): any;
- public visitPostfixUnaryExpression(node: PostfixUnaryExpressionSyntax): any;
- public visitElementAccessExpression(node: ElementAccessExpressionSyntax): any;
- public visitInvocationExpression(node: InvocationExpressionSyntax): any;
- public visitArgumentList(node: ArgumentListSyntax): any;
- public visitBinaryExpression(node: BinaryExpressionSyntax): any;
- public visitConditionalExpression(node: ConditionalExpressionSyntax): any;
- public visitConstructSignature(node: ConstructSignatureSyntax): any;
- public visitMethodSignature(node: MethodSignatureSyntax): any;
- public visitIndexSignature(node: IndexSignatureSyntax): any;
- public visitPropertySignature(node: PropertySignatureSyntax): any;
- public visitCallSignature(node: CallSignatureSyntax): any;
- public visitParameterList(node: ParameterListSyntax): any;
- public visitTypeParameterList(node: TypeParameterListSyntax): any;
- public visitTypeParameter(node: TypeParameterSyntax): any;
- public visitConstraint(node: ConstraintSyntax): any;
- public visitElseClause(node: ElseClauseSyntax): any;
- public visitIfStatement(node: IfStatementSyntax): any;
- public visitExpressionStatement(node: ExpressionStatementSyntax): any;
- public visitConstructorDeclaration(node: ConstructorDeclarationSyntax): any;
- public visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): any;
- public visitGetAccessor(node: GetAccessorSyntax): any;
- public visitSetAccessor(node: SetAccessorSyntax): any;
- public visitMemberVariableDeclaration(node: MemberVariableDeclarationSyntax): any;
- public visitIndexMemberDeclaration(node: IndexMemberDeclarationSyntax): any;
- public visitThrowStatement(node: ThrowStatementSyntax): any;
- public visitReturnStatement(node: ReturnStatementSyntax): any;
- public visitObjectCreationExpression(node: ObjectCreationExpressionSyntax): any;
- public visitSwitchStatement(node: SwitchStatementSyntax): any;
- public visitCaseSwitchClause(node: CaseSwitchClauseSyntax): any;
- public visitDefaultSwitchClause(node: DefaultSwitchClauseSyntax): any;
- public visitBreakStatement(node: BreakStatementSyntax): any;
- public visitContinueStatement(node: ContinueStatementSyntax): any;
- public visitForStatement(node: ForStatementSyntax): any;
- public visitForInStatement(node: ForInStatementSyntax): any;
- public visitWhileStatement(node: WhileStatementSyntax): any;
- public visitWithStatement(node: WithStatementSyntax): any;
- public visitEnumDeclaration(node: EnumDeclarationSyntax): any;
- public visitEnumElement(node: EnumElementSyntax): any;
- public visitCastExpression(node: CastExpressionSyntax): any;
- public visitObjectLiteralExpression(node: ObjectLiteralExpressionSyntax): any;
- public visitSimplePropertyAssignment(node: SimplePropertyAssignmentSyntax): any;
- public visitFunctionPropertyAssignment(node: FunctionPropertyAssignmentSyntax): any;
- public visitFunctionExpression(node: FunctionExpressionSyntax): any;
- public visitEmptyStatement(node: EmptyStatementSyntax): any;
- public visitTryStatement(node: TryStatementSyntax): any;
- public visitCatchClause(node: CatchClauseSyntax): any;
- public visitFinallyClause(node: FinallyClauseSyntax): any;
- public visitLabeledStatement(node: LabeledStatementSyntax): any;
- public visitDoStatement(node: DoStatementSyntax): any;
- public visitTypeOfExpression(node: TypeOfExpressionSyntax): any;
- public visitDeleteExpression(node: DeleteExpressionSyntax): any;
- public visitVoidExpression(node: VoidExpressionSyntax): any;
- public visitDebuggerStatement(node: DebuggerStatementSyntax): any;
- }
-}
-declare module TypeScript {
- class SyntaxDedenter extends SyntaxRewriter {
- private dedentationAmount;
- private minimumIndent;
- private options;
- private lastTriviaWasNewLine;
- constructor(dedentFirstToken: boolean, dedentationAmount: number, minimumIndent: number, options: FormattingOptions);
- private abort();
- private isAborted();
- public visitToken(token: ISyntaxToken): ISyntaxToken;
- private dedentTriviaList(triviaList);
- private dedentSegment(segment, hasFollowingNewLineTrivia);
- private dedentWhitespace(trivia, hasFollowingNewLineTrivia);
- private dedentMultiLineComment(trivia);
- static dedentNode(node: ISyntaxNode, dedentFirstToken: boolean, dedentAmount: number, minimumIndent: number, options: FormattingOptions): ISyntaxNode;
- }
-}
-declare module TypeScript {
- class SyntaxIndenter extends SyntaxRewriter {
- private indentationAmount;
- private options;
- private lastTriviaWasNewLine;
- private indentationTrivia;
- constructor(indentFirstToken: boolean, indentationAmount: number, options: FormattingOptions);
- public visitToken(token: ISyntaxToken): ISyntaxToken;
- public indentTriviaList(triviaList: ISyntaxTriviaList): ISyntaxTriviaList;
- private indentSegment(segment);
- private indentWhitespace(trivia, indentThisTrivia, result);
- private indentSingleLineOrSkippedText(trivia, indentThisTrivia, result);
- private indentMultiLineComment(trivia, indentThisTrivia, result);
- static indentNode(node: ISyntaxNode, indentFirstToken: boolean, indentAmount: number, options: FormattingOptions): SyntaxNode;
- static indentNodes(nodes: SyntaxNode[], indentFirstToken: boolean, indentAmount: number, options: FormattingOptions): SyntaxNode[];
- }
-}
-declare module TypeScript.Syntax {
- class VariableWidthTokenWithNoTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- constructor(fullText: string, kind: SyntaxKind);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class VariableWidthTokenWithLeadingTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- private _leadingTriviaInfo;
- constructor(fullText: string, kind: SyntaxKind, leadingTriviaInfo: number);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class VariableWidthTokenWithTrailingTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- private _trailingTriviaInfo;
- constructor(fullText: string, kind: SyntaxKind, trailingTriviaInfo: number);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class VariableWidthTokenWithLeadingAndTrailingTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- private _leadingTriviaInfo;
- private _trailingTriviaInfo;
- constructor(fullText: string, kind: SyntaxKind, leadingTriviaInfo: number, trailingTriviaInfo: number);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class FixedWidthTokenWithNoTrivia implements ISyntaxToken {
- public tokenKind: SyntaxKind;
- constructor(kind: SyntaxKind);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class FixedWidthTokenWithLeadingTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- private _leadingTriviaInfo;
- constructor(fullText: string, kind: SyntaxKind, leadingTriviaInfo: number);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class FixedWidthTokenWithTrailingTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- private _trailingTriviaInfo;
- constructor(fullText: string, kind: SyntaxKind, trailingTriviaInfo: number);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
- class FixedWidthTokenWithLeadingAndTrailingTrivia implements ISyntaxToken {
- private _fullText;
- public tokenKind: SyntaxKind;
- private _leadingTriviaInfo;
- private _trailingTriviaInfo;
- constructor(fullText: string, kind: SyntaxKind, leadingTriviaInfo: number, trailingTriviaInfo: number);
- public clone(): ISyntaxToken;
- public isNode(): boolean;
- public isToken(): boolean;
- public isList(): boolean;
- public isSeparatedList(): boolean;
- public kind(): SyntaxKind;
- public childCount(): number;
- public childAt(index: number): ISyntaxElement;
- public fullWidth(): number;
- public width(): number;
- public text(): string;
- public fullText(): string;
- public value(): any;
- public valueText(): string;
- public hasLeadingTrivia(): boolean;
- public hasLeadingComment(): boolean;
- public hasLeadingNewLine(): boolean;
- public hasLeadingSkippedText(): boolean;
- public leadingTriviaWidth(): number;
- public leadingTrivia(): ISyntaxTriviaList;
- public hasTrailingTrivia(): boolean;
- public hasTrailingComment(): boolean;
- public hasTrailingNewLine(): boolean;
- public hasTrailingSkippedText(): boolean;
- public trailingTriviaWidth(): number;
- public trailingTrivia(): ISyntaxTriviaList;
- public hasSkippedToken(): boolean;
- public toJSON(key: any): any;
- public firstToken(): ISyntaxToken;
- public lastToken(): ISyntaxToken;
- public isTypeScriptSpecific(): boolean;
- public isIncrementallyUnusable(): boolean;
- public accept(visitor: ISyntaxVisitor): any;
- private realize();
- public collectTextElements(elements: string[]): void;
- private findTokenInternal(parent, position, fullStart);
- public withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- public isExpression(): boolean;
- public isPrimaryExpression(): boolean;
- public isMemberExpression(): boolean;
- public isPostfixExpression(): boolean;
- public isUnaryExpression(): boolean;
- }
-}
-declare module TypeScript {
- interface ISyntaxToken extends ISyntaxNodeOrToken, INameSyntax, IPrimaryExpressionSyntax {
- tokenKind: SyntaxKind;
- text(): string;
- value(): any;
- valueText(): string;
- hasLeadingTrivia(): boolean;
- hasLeadingComment(): boolean;
- hasLeadingNewLine(): boolean;
- hasLeadingSkippedText(): boolean;
- hasTrailingTrivia(): boolean;
- hasTrailingComment(): boolean;
- hasTrailingNewLine(): boolean;
- hasTrailingSkippedText(): boolean;
- hasSkippedToken(): boolean;
- leadingTrivia(): ISyntaxTriviaList;
- trailingTrivia(): ISyntaxTriviaList;
- withLeadingTrivia(leadingTrivia: ISyntaxTriviaList): ISyntaxToken;
- withTrailingTrivia(trailingTrivia: ISyntaxTriviaList): ISyntaxToken;
- clone(): ISyntaxToken;
- }
- interface ITokenInfo {
- leadingTrivia?: ISyntaxTrivia[];
- text?: string;
- trailingTrivia?: ISyntaxTrivia[];
- }
-}
-declare module TypeScript.Syntax {
- function isExpression(token: ISyntaxToken): boolean;
- function realizeToken(token: ISyntaxToken): ISyntaxToken;
- function convertToIdentifierName(token: ISyntaxToken): ISyntaxToken;
- function tokenToJSON(token: ISyntaxToken): any;
- function value(token: ISyntaxToken): any;
- function massageEscapes(text: string): string;
- function valueText(token: ISyntaxToken): string;
- function emptyToken(kind: SyntaxKind): ISyntaxToken;
- function token(kind: SyntaxKind, info?: ITokenInfo): ISyntaxToken;
- function identifier(text: string, info?: ITokenInfo): ISyntaxToken;
-}
-declare module TypeScript {
- class SyntaxTokenReplacer extends SyntaxRewriter {
- private token1;
- private token2;
- constructor(token1: ISyntaxToken, token2: ISyntaxToken);
- public visitToken(token: ISyntaxToken): ISyntaxToken;
- public visitNode(node: SyntaxNode): SyntaxNode;
- public visitList(list: ISyntaxList): ISyntaxList;
- public visitSeparatedList(list: ISeparatedSyntaxList): ISeparatedSyntaxList;
- }
-}
-declare module TypeScript {
- interface ISyntaxTrivia {
- kind(): SyntaxKind;
- isWhitespace(): boolean;
- isComment(): boolean;
- isNewLine(): boolean;
- isSkippedToken(): boolean;
- fullWidth(): number;
- fullText(): string;
- skippedToken(): ISyntaxToken;
- }
-}
-declare module TypeScript.Syntax {
- function deferredTrivia(kind: SyntaxKind, text: ISimpleText, fullStart: number, fullWidth: number): ISyntaxTrivia;
- function trivia(kind: SyntaxKind, text: string): ISyntaxTrivia;
- function skippedTokenTrivia(token: ISyntaxToken): ISyntaxTrivia;
- function spaces(count: number): ISyntaxTrivia;
- function whitespace(text: string): ISyntaxTrivia;
- function multiLineComment(text: string): ISyntaxTrivia;
- function singleLineComment(text: string): ISyntaxTrivia;
- var spaceTrivia: ISyntaxTrivia;
- var lineFeedTrivia: ISyntaxTrivia;
- var carriageReturnTrivia: ISyntaxTrivia;
- var carriageReturnLineFeedTrivia: ISyntaxTrivia;
- function splitMultiLineCommentTriviaIntoMultipleLines(trivia: ISyntaxTrivia): string[];
-}
-declare module TypeScript {
- interface ISyntaxTriviaList {
- count(): number;
- syntaxTriviaAt(index: number): ISyntaxTrivia;
- fullWidth(): number;
- fullText(): string;
- hasComment(): boolean;
- hasNewLine(): boolean;
- hasSkippedToken(): boolean;
- last(): ISyntaxTrivia;
- toArray(): ISyntaxTrivia[];
- concat(trivia: ISyntaxTriviaList): ISyntaxTriviaList;
- collectTextElements(elements: string[]): void;
- }
-}
-declare module TypeScript.Syntax {
- var emptyTriviaList: ISyntaxTriviaList;
- function triviaList(trivia: ISyntaxTrivia[]): ISyntaxTriviaList;
- var spaceTriviaList: ISyntaxTriviaList;
-}
-declare module TypeScript {
- class SyntaxUtilities {
- static isAngleBracket(positionedElement: PositionedElement): boolean;
- static getToken(list: ISyntaxList, kind: SyntaxKind): ISyntaxToken;
- static containsToken(list: ISyntaxList, kind: SyntaxKind): boolean;
- static hasExportKeyword(moduleElement: IModuleElementSyntax): boolean;
- static getExportKeyword(moduleElement: IModuleElementSyntax): ISyntaxToken;
- static isAmbientDeclarationSyntax(positionNode: PositionedNode): boolean;
- }
-}
-declare module TypeScript {
- interface ISyntaxVisitor {
- visitToken(token: ISyntaxToken): any;
- visitSourceUnit(node: SourceUnitSyntax): any;
- visitExternalModuleReference(node: ExternalModuleReferenceSyntax): any;
- visitModuleNameModuleReference(node: ModuleNameModuleReferenceSyntax): any;
- visitImportDeclaration(node: ImportDeclarationSyntax): any;
- visitExportAssignment(node: ExportAssignmentSyntax): any;
- visitClassDeclaration(node: ClassDeclarationSyntax): any;
- visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): any;
- visitHeritageClause(node: HeritageClauseSyntax): any;
- visitModuleDeclaration(node: ModuleDeclarationSyntax): any;
- visitFunctionDeclaration(node: FunctionDeclarationSyntax): any;
- visitVariableStatement(node: VariableStatementSyntax): any;
- visitVariableDeclaration(node: VariableDeclarationSyntax): any;
- visitVariableDeclarator(node: VariableDeclaratorSyntax): any;
- visitEqualsValueClause(node: EqualsValueClauseSyntax): any;
- visitPrefixUnaryExpression(node: PrefixUnaryExpressionSyntax): any;
- visitArrayLiteralExpression(node: ArrayLiteralExpressionSyntax): any;
- visitOmittedExpression(node: OmittedExpressionSyntax): any;
- visitParenthesizedExpression(node: ParenthesizedExpressionSyntax): any;
- visitSimpleArrowFunctionExpression(node: SimpleArrowFunctionExpressionSyntax): any;
- visitParenthesizedArrowFunctionExpression(node: ParenthesizedArrowFunctionExpressionSyntax): any;
- visitQualifiedName(node: QualifiedNameSyntax): any;
- visitTypeArgumentList(node: TypeArgumentListSyntax): any;
- visitConstructorType(node: ConstructorTypeSyntax): any;
- visitFunctionType(node: FunctionTypeSyntax): any;
- visitObjectType(node: ObjectTypeSyntax): any;
- visitArrayType(node: ArrayTypeSyntax): any;
- visitGenericType(node: GenericTypeSyntax): any;
- visitTypeQuery(node: TypeQuerySyntax): any;
- visitTypeAnnotation(node: TypeAnnotationSyntax): any;
- visitBlock(node: BlockSyntax): any;
- visitParameter(node: ParameterSyntax): any;
- visitMemberAccessExpression(node: MemberAccessExpressionSyntax): any;
- visitPostfixUnaryExpression(node: PostfixUnaryExpressionSyntax): any;
- visitElementAccessExpression(node: ElementAccessExpressionSyntax): any;
- visitInvocationExpression(node: InvocationExpressionSyntax): any;
- visitArgumentList(node: ArgumentListSyntax): any;
- visitBinaryExpression(node: BinaryExpressionSyntax): any;
- visitConditionalExpression(node: ConditionalExpressionSyntax): any;
- visitConstructSignature(node: ConstructSignatureSyntax): any;
- visitMethodSignature(node: MethodSignatureSyntax): any;
- visitIndexSignature(node: IndexSignatureSyntax): any;
- visitPropertySignature(node: PropertySignatureSyntax): any;
- visitCallSignature(node: CallSignatureSyntax): any;
- visitParameterList(node: ParameterListSyntax): any;
- visitTypeParameterList(node: TypeParameterListSyntax): any;
- visitTypeParameter(node: TypeParameterSyntax): any;
- visitConstraint(node: ConstraintSyntax): any;
- visitElseClause(node: ElseClauseSyntax): any;
- visitIfStatement(node: IfStatementSyntax): any;
- visitExpressionStatement(node: ExpressionStatementSyntax): any;
- visitConstructorDeclaration(node: ConstructorDeclarationSyntax): any;
- visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): any;
- visitGetAccessor(node: GetAccessorSyntax): any;
- visitSetAccessor(node: SetAccessorSyntax): any;
- visitMemberVariableDeclaration(node: MemberVariableDeclarationSyntax): any;
- visitIndexMemberDeclaration(node: IndexMemberDeclarationSyntax): any;
- visitThrowStatement(node: ThrowStatementSyntax): any;
- visitReturnStatement(node: ReturnStatementSyntax): any;
- visitObjectCreationExpression(node: ObjectCreationExpressionSyntax): any;
- visitSwitchStatement(node: SwitchStatementSyntax): any;
- visitCaseSwitchClause(node: CaseSwitchClauseSyntax): any;
- visitDefaultSwitchClause(node: DefaultSwitchClauseSyntax): any;
- visitBreakStatement(node: BreakStatementSyntax): any;
- visitContinueStatement(node: ContinueStatementSyntax): any;
- visitForStatement(node: ForStatementSyntax): any;
- visitForInStatement(node: ForInStatementSyntax): any;
- visitWhileStatement(node: WhileStatementSyntax): any;
- visitWithStatement(node: WithStatementSyntax): any;
- visitEnumDeclaration(node: EnumDeclarationSyntax): any;
- visitEnumElement(node: EnumElementSyntax): any;
- visitCastExpression(node: CastExpressionSyntax): any;
- visitObjectLiteralExpression(node: ObjectLiteralExpressionSyntax): any;
- visitSimplePropertyAssignment(node: SimplePropertyAssignmentSyntax): any;
- visitFunctionPropertyAssignment(node: FunctionPropertyAssignmentSyntax): any;
- visitFunctionExpression(node: FunctionExpressionSyntax): any;
- visitEmptyStatement(node: EmptyStatementSyntax): any;
- visitTryStatement(node: TryStatementSyntax): any;
- visitCatchClause(node: CatchClauseSyntax): any;
- visitFinallyClause(node: FinallyClauseSyntax): any;
- visitLabeledStatement(node: LabeledStatementSyntax): any;
- visitDoStatement(node: DoStatementSyntax): any;
- visitTypeOfExpression(node: TypeOfExpressionSyntax): any;
- visitDeleteExpression(node: DeleteExpressionSyntax): any;
- visitVoidExpression(node: VoidExpressionSyntax): any;
- visitDebuggerStatement(node: DebuggerStatementSyntax): any;
- }
- class SyntaxVisitor implements ISyntaxVisitor {
- public defaultVisit(node: ISyntaxNodeOrToken): any;
- public visitToken(token: ISyntaxToken): any;
- public visitSourceUnit(node: SourceUnitSyntax): any;
- public visitExternalModuleReference(node: ExternalModuleReferenceSyntax): any;
- public visitModuleNameModuleReference(node: ModuleNameModuleReferenceSyntax): any;
- public visitImportDeclaration(node: ImportDeclarationSyntax): any;
- public visitExportAssignment(node: ExportAssignmentSyntax): any;
- public visitClassDeclaration(node: ClassDeclarationSyntax): any;
- public visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): any;
- public visitHeritageClause(node: HeritageClauseSyntax): any;
- public visitModuleDeclaration(node: ModuleDeclarationSyntax): any;
- public visitFunctionDeclaration(node: FunctionDeclarationSyntax): any;
- public visitVariableStatement(node: VariableStatementSyntax): any;
- public visitVariableDeclaration(node: VariableDeclarationSyntax): any;
- public visitVariableDeclarator(node: VariableDeclaratorSyntax): any;
- public visitEqualsValueClause(node: EqualsValueClauseSyntax): any;
- public visitPrefixUnaryExpression(node: PrefixUnaryExpressionSyntax): any;
- public visitArrayLiteralExpression(node: ArrayLiteralExpressionSyntax): any;
- public visitOmittedExpression(node: OmittedExpressionSyntax): any;
- public visitParenthesizedExpression(node: ParenthesizedExpressionSyntax): any;
- public visitSimpleArrowFunctionExpression(node: SimpleArrowFunctionExpressionSyntax): any;
- public visitParenthesizedArrowFunctionExpression(node: ParenthesizedArrowFunctionExpressionSyntax): any;
- public visitQualifiedName(node: QualifiedNameSyntax): any;
- public visitTypeArgumentList(node: TypeArgumentListSyntax): any;
- public visitConstructorType(node: ConstructorTypeSyntax): any;
- public visitFunctionType(node: FunctionTypeSyntax): any;
- public visitObjectType(node: ObjectTypeSyntax): any;
- public visitArrayType(node: ArrayTypeSyntax): any;
- public visitGenericType(node: GenericTypeSyntax): any;
- public visitTypeQuery(node: TypeQuerySyntax): any;
- public visitTypeAnnotation(node: TypeAnnotationSyntax): any;
- public visitBlock(node: BlockSyntax): any;
- public visitParameter(node: ParameterSyntax): any;
- public visitMemberAccessExpression(node: MemberAccessExpressionSyntax): any;
- public visitPostfixUnaryExpression(node: PostfixUnaryExpressionSyntax): any;
- public visitElementAccessExpression(node: ElementAccessExpressionSyntax): any;
- public visitInvocationExpression(node: InvocationExpressionSyntax): any;
- public visitArgumentList(node: ArgumentListSyntax): any;
- public visitBinaryExpression(node: BinaryExpressionSyntax): any;
- public visitConditionalExpression(node: ConditionalExpressionSyntax): any;
- public visitConstructSignature(node: ConstructSignatureSyntax): any;
- public visitMethodSignature(node: MethodSignatureSyntax): any;
- public visitIndexSignature(node: IndexSignatureSyntax): any;
- public visitPropertySignature(node: PropertySignatureSyntax): any;
- public visitCallSignature(node: CallSignatureSyntax): any;
- public visitParameterList(node: ParameterListSyntax): any;
- public visitTypeParameterList(node: TypeParameterListSyntax): any;
- public visitTypeParameter(node: TypeParameterSyntax): any;
- public visitConstraint(node: ConstraintSyntax): any;
- public visitElseClause(node: ElseClauseSyntax): any;
- public visitIfStatement(node: IfStatementSyntax): any;
- public visitExpressionStatement(node: ExpressionStatementSyntax): any;
- public visitConstructorDeclaration(node: ConstructorDeclarationSyntax): any;
- public visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): any;
- public visitGetAccessor(node: GetAccessorSyntax): any;
- public visitSetAccessor(node: SetAccessorSyntax): any;
- public visitMemberVariableDeclaration(node: MemberVariableDeclarationSyntax): any;
- public visitIndexMemberDeclaration(node: IndexMemberDeclarationSyntax): any;
- public visitThrowStatement(node: ThrowStatementSyntax): any;
- public visitReturnStatement(node: ReturnStatementSyntax): any;
- public visitObjectCreationExpression(node: ObjectCreationExpressionSyntax): any;
- public visitSwitchStatement(node: SwitchStatementSyntax): any;
- public visitCaseSwitchClause(node: CaseSwitchClauseSyntax): any;
- public visitDefaultSwitchClause(node: DefaultSwitchClauseSyntax): any;
- public visitBreakStatement(node: BreakStatementSyntax): any;
- public visitContinueStatement(node: ContinueStatementSyntax): any;
- public visitForStatement(node: ForStatementSyntax): any;
- public visitForInStatement(node: ForInStatementSyntax): any;
- public visitWhileStatement(node: WhileStatementSyntax): any;
- public visitWithStatement(node: WithStatementSyntax): any;
- public visitEnumDeclaration(node: EnumDeclarationSyntax): any;
- public visitEnumElement(node: EnumElementSyntax): any;
- public visitCastExpression(node: CastExpressionSyntax): any;
- public visitObjectLiteralExpression(node: ObjectLiteralExpressionSyntax): any;
- public visitSimplePropertyAssignment(node: SimplePropertyAssignmentSyntax): any;
- public visitFunctionPropertyAssignment(node: FunctionPropertyAssignmentSyntax): any;
- public visitFunctionExpression(node: FunctionExpressionSyntax): any;
- public visitEmptyStatement(node: EmptyStatementSyntax): any;
- public visitTryStatement(node: TryStatementSyntax): any;
- public visitCatchClause(node: CatchClauseSyntax): any;
- public visitFinallyClause(node: FinallyClauseSyntax): any;
- public visitLabeledStatement(node: LabeledStatementSyntax): any;
- public visitDoStatement(node: DoStatementSyntax): any;
- public visitTypeOfExpression(node: TypeOfExpressionSyntax): any;
- public visitDeleteExpression(node: DeleteExpressionSyntax): any;
- public visitVoidExpression(node: VoidExpressionSyntax): any;
- public visitDebuggerStatement(node: DebuggerStatementSyntax): any;
- }
-}
-declare module TypeScript {
- class SyntaxWalker implements ISyntaxVisitor {
- public visitToken(token: ISyntaxToken): void;
- public visitNode(node: SyntaxNode): void;
- public visitNodeOrToken(nodeOrToken: ISyntaxNodeOrToken): void;
- private visitOptionalToken(token);
- public visitOptionalNode(node: SyntaxNode): void;
- public visitOptionalNodeOrToken(nodeOrToken: ISyntaxNodeOrToken): void;
- public visitList(list: ISyntaxList): void;
- public visitSeparatedList(list: ISeparatedSyntaxList): void;
- public visitSourceUnit(node: SourceUnitSyntax): void;
- public visitExternalModuleReference(node: ExternalModuleReferenceSyntax): void;
- public visitModuleNameModuleReference(node: ModuleNameModuleReferenceSyntax): void;
- public visitImportDeclaration(node: ImportDeclarationSyntax): void;
- public visitExportAssignment(node: ExportAssignmentSyntax): void;
- public visitClassDeclaration(node: ClassDeclarationSyntax): void;
- public visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): void;
- public visitHeritageClause(node: HeritageClauseSyntax): void;
- public visitModuleDeclaration(node: ModuleDeclarationSyntax): void;
- public visitFunctionDeclaration(node: FunctionDeclarationSyntax): void;
- public visitVariableStatement(node: VariableStatementSyntax): void;
- public visitVariableDeclaration(node: VariableDeclarationSyntax): void;
- public visitVariableDeclarator(node: VariableDeclaratorSyntax): void;
- public visitEqualsValueClause(node: EqualsValueClauseSyntax): void;
- public visitPrefixUnaryExpression(node: PrefixUnaryExpressionSyntax): void;
- public visitArrayLiteralExpression(node: ArrayLiteralExpressionSyntax): void;
- public visitOmittedExpression(node: OmittedExpressionSyntax): void;
- public visitParenthesizedExpression(node: ParenthesizedExpressionSyntax): void;
- public visitSimpleArrowFunctionExpression(node: SimpleArrowFunctionExpressionSyntax): void;
- public visitParenthesizedArrowFunctionExpression(node: ParenthesizedArrowFunctionExpressionSyntax): void;
- public visitQualifiedName(node: QualifiedNameSyntax): void;
- public visitTypeArgumentList(node: TypeArgumentListSyntax): void;
- public visitConstructorType(node: ConstructorTypeSyntax): void;
- public visitFunctionType(node: FunctionTypeSyntax): void;
- public visitObjectType(node: ObjectTypeSyntax): void;
- public visitArrayType(node: ArrayTypeSyntax): void;
- public visitGenericType(node: GenericTypeSyntax): void;
- public visitTypeQuery(node: TypeQuerySyntax): void;
- public visitTypeAnnotation(node: TypeAnnotationSyntax): void;
- public visitBlock(node: BlockSyntax): void;
- public visitParameter(node: ParameterSyntax): void;
- public visitMemberAccessExpression(node: MemberAccessExpressionSyntax): void;
- public visitPostfixUnaryExpression(node: PostfixUnaryExpressionSyntax): void;
- public visitElementAccessExpression(node: ElementAccessExpressionSyntax): void;
- public visitInvocationExpression(node: InvocationExpressionSyntax): void;
- public visitArgumentList(node: ArgumentListSyntax): void;
- public visitBinaryExpression(node: BinaryExpressionSyntax): void;
- public visitConditionalExpression(node: ConditionalExpressionSyntax): void;
- public visitConstructSignature(node: ConstructSignatureSyntax): void;
- public visitMethodSignature(node: MethodSignatureSyntax): void;
- public visitIndexSignature(node: IndexSignatureSyntax): void;
- public visitPropertySignature(node: PropertySignatureSyntax): void;
- public visitCallSignature(node: CallSignatureSyntax): void;
- public visitParameterList(node: ParameterListSyntax): void;
- public visitTypeParameterList(node: TypeParameterListSyntax): void;
- public visitTypeParameter(node: TypeParameterSyntax): void;
- public visitConstraint(node: ConstraintSyntax): void;
- public visitElseClause(node: ElseClauseSyntax): void;
- public visitIfStatement(node: IfStatementSyntax): void;
- public visitExpressionStatement(node: ExpressionStatementSyntax): void;
- public visitConstructorDeclaration(node: ConstructorDeclarationSyntax): void;
- public visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): void;
- public visitGetAccessor(node: GetAccessorSyntax): void;
- public visitSetAccessor(node: SetAccessorSyntax): void;
- public visitMemberVariableDeclaration(node: MemberVariableDeclarationSyntax): void;
- public visitIndexMemberDeclaration(node: IndexMemberDeclarationSyntax): void;
- public visitThrowStatement(node: ThrowStatementSyntax): void;
- public visitReturnStatement(node: ReturnStatementSyntax): void;
- public visitObjectCreationExpression(node: ObjectCreationExpressionSyntax): void;
- public visitSwitchStatement(node: SwitchStatementSyntax): void;
- public visitCaseSwitchClause(node: CaseSwitchClauseSyntax): void;
- public visitDefaultSwitchClause(node: DefaultSwitchClauseSyntax): void;
- public visitBreakStatement(node: BreakStatementSyntax): void;
- public visitContinueStatement(node: ContinueStatementSyntax): void;
- public visitForStatement(node: ForStatementSyntax): void;
- public visitForInStatement(node: ForInStatementSyntax): void;
- public visitWhileStatement(node: WhileStatementSyntax): void;
- public visitWithStatement(node: WithStatementSyntax): void;
- public visitEnumDeclaration(node: EnumDeclarationSyntax): void;
- public visitEnumElement(node: EnumElementSyntax): void;
- public visitCastExpression(node: CastExpressionSyntax): void;
- public visitObjectLiteralExpression(node: ObjectLiteralExpressionSyntax): void;
- public visitSimplePropertyAssignment(node: SimplePropertyAssignmentSyntax): void;
- public visitFunctionPropertyAssignment(node: FunctionPropertyAssignmentSyntax): void;
- public visitFunctionExpression(node: FunctionExpressionSyntax): void;
- public visitEmptyStatement(node: EmptyStatementSyntax): void;
- public visitTryStatement(node: TryStatementSyntax): void;
- public visitCatchClause(node: CatchClauseSyntax): void;
- public visitFinallyClause(node: FinallyClauseSyntax): void;
- public visitLabeledStatement(node: LabeledStatementSyntax): void;
- public visitDoStatement(node: DoStatementSyntax): void;
- public visitTypeOfExpression(node: TypeOfExpressionSyntax): void;
- public visitDeleteExpression(node: DeleteExpressionSyntax): void;
- public visitVoidExpression(node: VoidExpressionSyntax): void;
- public visitDebuggerStatement(node: DebuggerStatementSyntax): void;
- }
-}
-declare module TypeScript {
- class PositionTrackingWalker extends SyntaxWalker {
- private _position;
- public visitToken(token: ISyntaxToken): void;
- public position(): number;
- public skip(element: ISyntaxElement): void;
- }
-}
-declare module TypeScript {
- interface ITokenInformation {
- previousToken: ISyntaxToken;
- nextToken: ISyntaxToken;
- }
- class SyntaxInformationMap extends SyntaxWalker {
- private trackParents;
- private trackPreviousToken;
- private tokenToInformation;
- private elementToPosition;
- private _previousToken;
- private _previousTokenInformation;
- private _currentPosition;
- private _elementToParent;
- private _parentStack;
- constructor(trackParents: boolean, trackPreviousToken: boolean);
- static create(node: SyntaxNode, trackParents: boolean, trackPreviousToken: boolean): SyntaxInformationMap;
- public visitNode(node: SyntaxNode): void;
- public visitToken(token: ISyntaxToken): void;
- public parent(element: ISyntaxElement): SyntaxNode;
- public fullStart(element: ISyntaxElement): number;
- public start(element: ISyntaxElement): number;
- public end(element: ISyntaxElement): number;
- public previousToken(token: ISyntaxToken): ISyntaxToken;
- public tokenInformation(token: ISyntaxToken): ITokenInformation;
- public firstTokenInLineContainingToken(token: ISyntaxToken): ISyntaxToken;
- public isFirstTokenInLine(token: ISyntaxToken): boolean;
- private isFirstTokenInLineWorker(information);
- }
-}
-declare module TypeScript {
- class SyntaxNodeInvariantsChecker extends SyntaxWalker {
- private tokenTable;
- static checkInvariants(node: SyntaxNode): void;
- public visitToken(token: ISyntaxToken): void;
- }
-}
-declare module TypeScript {
- class DepthLimitedWalker extends PositionTrackingWalker {
- private _depth;
- private _maximumDepth;
- constructor(maximumDepth: number);
- public visitNode(node: SyntaxNode): void;
- }
-}
-declare module TypeScript.Parser {
- function parse(fileName: string, text: ISimpleText, isDeclaration: boolean, options: ParseOptions): SyntaxTree;
- function incrementalParse(oldSyntaxTree: SyntaxTree, textChangeRange: TextChangeRange, newText: ISimpleText): SyntaxTree;
-}
-declare module TypeScript {
- class SyntaxTree {
- private _sourceUnit;
- private _isDeclaration;
- private _parserDiagnostics;
- private _allDiagnostics;
- private _fileName;
- private _lineMap;
- private _parseOptions;
- constructor(sourceUnit: SourceUnitSyntax, isDeclaration: boolean, diagnostics: Diagnostic[], fileName: string, lineMap: LineMap, parseOtions: ParseOptions);
- public toJSON(key: any): any;
- public sourceUnit(): SourceUnitSyntax;
- public isDeclaration(): boolean;
- private computeDiagnostics();
- public diagnostics(): Diagnostic[];
- public fileName(): string;
- public lineMap(): LineMap;
- public parseOptions(): ParseOptions;
- public structuralEquals(tree: SyntaxTree): boolean;
- }
-}
-declare module TypeScript {
- class Unicode {
- static unicodeES3IdentifierStart: number[];
- static unicodeES3IdentifierPart: number[];
- static unicodeES5IdentifierStart: number[];
- static unicodeES5IdentifierPart: number[];
- static lookupInUnicodeMap(code: number, map: number[]): boolean;
- static isIdentifierStart(code: number, languageVersion: LanguageVersion): boolean;
- static isIdentifierPart(code: number, languageVersion: LanguageVersion): boolean;
- }
-}
-declare module TypeScript {
- module CompilerDiagnostics {
- var debug: boolean;
- interface IDiagnosticWriter {
- Alert(output: string): void;
- }
- var diagnosticWriter: IDiagnosticWriter;
- var analysisPass: number;
- function Alert(output: string): void;
- function debugPrint(s: string): void;
- function assert(condition: boolean, s: string): void;
- }
- interface ILogger {
- information(): boolean;
- debug(): boolean;
- warning(): boolean;
- error(): boolean;
- fatal(): boolean;
- log(s: string): void;
- }
- class NullLogger implements ILogger {
- public information(): boolean;
- public debug(): boolean;
- public warning(): boolean;
- public error(): boolean;
- public fatal(): boolean;
- public log(s: string): void;
- }
- function timeFunction(logger: ILogger, funcDescription: string, func: () => any): any;
-}
-declare module TypeScript {
- class Document {
- private _compiler;
- private _semanticInfoChain;
- public fileName: string;
- public referencedFiles: string[];
- private _scriptSnapshot;
- public byteOrderMark: ByteOrderMark;
- public version: number;
- public isOpen: boolean;
- private _syntaxTree;
- private _topLevelDecl;
- private _diagnostics;
- private _bloomFilter;
- private _sourceUnit;
- private _lineMap;
- private _declASTMap;
- private _astDeclMap;
- private _amdDependencies;
- private _externalModuleIndicatorSpan;
- constructor(_compiler: TypeScriptCompiler, _semanticInfoChain: SemanticInfoChain, fileName: string, referencedFiles: string[], _scriptSnapshot: IScriptSnapshot, byteOrderMark: ByteOrderMark, version: number, isOpen: boolean, _syntaxTree: SyntaxTree, _topLevelDecl: PullDecl);
- public invalidate(): void;
- public isDeclareFile(): boolean;
- private cacheSyntaxTreeInfo(syntaxTree);
- private getAmdDependency(comment);
- private getImplicitImportSpan(sourceUnitLeadingTrivia);
- private getImplicitImportSpanWorker(trivia, position);
- private getTopLevelImportOrExportSpan(node);
- public sourceUnit(): SourceUnit;
- public diagnostics(): Diagnostic[];
- public lineMap(): LineMap;
- public isExternalModule(): boolean;
- public externalModuleIndicatorSpan(): TextSpan;
- public amdDependencies(): string[];
- public syntaxTree(): SyntaxTree;
- public bloomFilter(): BloomFilter;
- public emitToOwnOutputFile(): boolean;
- public update(scriptSnapshot: IScriptSnapshot, version: number, isOpen: boolean, textChangeRange: TextChangeRange): Document;
- static create(compiler: TypeScriptCompiler, semanticInfoChain: SemanticInfoChain, fileName: string, scriptSnapshot: IScriptSnapshot, byteOrderMark: ByteOrderMark, version: number, isOpen: boolean, referencedFiles: string[]): Document;
- public topLevelDecl(): PullDecl;
- public _getDeclForAST(ast: AST): PullDecl;
- public getEnclosingDecl(ast: AST): PullDecl;
- public _setDeclForAST(ast: AST, decl: PullDecl): void;
- public _getASTForDecl(decl: PullDecl): AST;
- public _setASTForDecl(decl: PullDecl, ast: AST): void;
- }
-}
-declare module TypeScript {
- function hasFlag(val: number, flag: number): boolean;
- enum TypeRelationshipFlags {
- SuccessfulComparison = 0,
- RequiredPropertyIsMissing = 2,
- IncompatibleSignatures = 4,
- SourceSignatureHasTooManyParameters = 3,
- IncompatibleReturnTypes = 16,
- IncompatiblePropertyTypes = 32,
- IncompatibleParameterTypes = 64,
- InconsistantPropertyAccesibility = 128,
- }
- enum ModuleGenTarget {
- Unspecified = 0,
- Synchronous = 1,
- Asynchronous = 2,
- }
-}
-declare module TypeScript {
- function createIntrinsicsObject<T>(): IIndexable<T>;
- interface IHashTable<T> {
- getAllKeys(): string[];
- add(key: string, data: T): boolean;
- addOrUpdate(key: string, data: T): boolean;
- map(fn: (k: string, value: T, context: any) => void, context: any): void;
- every(fn: (k: string, value: T, context: any) => void, context: any): boolean;
- some(fn: (k: string, value: T, context: any) => void, context: any): boolean;
- count(): number;
- lookup(key: string): T;
- }
- class StringHashTable<T> implements IHashTable<T> {
- private itemCount;
- private table;
- public getAllKeys(): string[];
- public add(key: string, data: T): boolean;
- public addOrUpdate(key: string, data: T): boolean;
- public map(fn: (k: string, value: T, context: any) => void, context: any): void;
- public every(fn: (k: string, value: T, context: any) => void, context: any): boolean;
- public some(fn: (k: string, value: T, context: any) => void, context: any): boolean;
- public count(): number;
- public lookup(key: string): T;
- public remove(key: string): void;
- }
- class IdentiferNameHashTable<T> extends StringHashTable<T> {
- public getAllKeys(): string[];
- public add(key: string, data: T): boolean;
- public addOrUpdate(key: string, data: T): boolean;
- public map(fn: (k: string, value: T, context: any) => void, context: any): void;
- public every(fn: (k: string, value: T, context: any) => void, context: any): boolean;
- public some(fn: (k: string, value: any, context: any) => void, context: any): boolean;
- public lookup(key: string): T;
- }
-}
-declare module TypeScript {
- interface IParameters {
- length: number;
- lastParameterIsRest(): boolean;
- ast: AST;
- astAt(index: number): AST;
- identifierAt(index: number): Identifier;
- typeAt(index: number): AST;
- initializerAt(index: number): EqualsValueClause;
- isOptionalAt(index: number): boolean;
- }
-}
-declare module TypeScript.ASTHelpers {
- function scriptIsElided(sourceUnit: SourceUnit): boolean;
- function moduleIsElided(declaration: ModuleDeclaration): boolean;
- function enumIsElided(declaration: EnumDeclaration): boolean;
- function isValidAstNode(ast: IASTSpan): boolean;
- function getAstAtPosition(script: AST, pos: number, useTrailingTriviaAsLimChar?: boolean, forceInclusive?: boolean): AST;
- function getExtendsHeritageClause(clauses: ISyntaxList2): HeritageClause;
- function getImplementsHeritageClause(clauses: ISyntaxList2): HeritageClause;
- function isCallExpression(ast: AST): boolean;
- function isCallExpressionTarget(ast: AST): boolean;
- function isDeclarationASTOrDeclarationNameAST(ast: AST): boolean;
- function getEnclosingParameterForInitializer(ast: AST): Parameter;
- function getEnclosingMemberVariableDeclaration(ast: AST): MemberVariableDeclaration;
- function isNameOfFunction(ast: AST): boolean;
- function isNameOfMemberFunction(ast: AST): boolean;
- function isNameOfMemberAccessExpression(ast: AST): boolean;
- function isRightSideOfQualifiedName(ast: AST): boolean;
- function parentIsModuleDeclaration(ast: AST): boolean;
- function parametersFromIdentifier(id: Identifier): IParameters;
- function parametersFromParameter(parameter: Parameter): IParameters;
- function parametersFromParameterList(list: ParameterList): IParameters;
- function isDeclarationAST(ast: AST): boolean;
- function docComments(ast: AST): Comment[];
- function getParameterList(ast: AST): ParameterList;
- function getType(ast: AST): AST;
- function getVariableDeclaratorModifiers(variableDeclarator: VariableDeclarator): PullElementFlags[];
- function isIntegerLiteralAST(expression: AST): boolean;
- function getEnclosingModuleDeclaration(ast: AST): ModuleDeclaration;
- function getModuleDeclarationFromNameAST(ast: AST): ModuleDeclaration;
- function isLastNameOfModule(ast: ModuleDeclaration, astName: AST): boolean;
- function getNameOfIdenfierOrQualifiedName(name: AST): string;
- function getModuleNames(name: AST, result?: Identifier[]): Identifier[];
-}
-declare module TypeScript {
- class AstWalkOptions {
- public goChildren: boolean;
- public stopWalking: boolean;
- }
- interface IAstWalker {
- options: AstWalkOptions;
- state: any;
- }
- class AstWalkerFactory {
- public walk(ast: AST, pre: (ast: AST, walker: IAstWalker) => void, post?: (ast: AST, walker: IAstWalker) => void, state?: any): void;
- public simpleWalk(ast: AST, pre: (ast: AST, state: any) => void, post?: (ast: AST, state: any) => void, state?: any): void;
- }
- function getAstWalkerFactory(): AstWalkerFactory;
-}
-declare module TypeScript {
- class Base64VLQFormat {
- static encode(inValue: number): string;
- static decode(inString: string): {
- value: number;
- rest: string;
- };
- }
-}
-declare module TypeScript {
- class SourceMapPosition {
- public sourceLine: number;
- public sourceColumn: number;
- public emittedLine: number;
- public emittedColumn: number;
- }
- class SourceMapping {
- public start: SourceMapPosition;
- public end: SourceMapPosition;
- public nameIndex: number;
- public childMappings: SourceMapping[];
- }
- class SourceMapEntry {
- public emittedFile: string;
- public emittedLine: number;
- public emittedColumn: number;
- public sourceFile: string;
- public sourceLine: number;
- public sourceColumn: number;
- public sourceName: string;
- constructor(emittedFile: string, emittedLine: number, emittedColumn: number, sourceFile: string, sourceLine: number, sourceColumn: number, sourceName: string);
- }
- class SourceMapper {
- private jsFile;
- private sourceMapOut;
- static MapFileExtension: string;
- private jsFileName;
- private sourceMapPath;
- private sourceMapDirectory;
- private sourceRoot;
- public names: string[];
- private mappingLevel;
- private tsFilePaths;
- private allSourceMappings;
- public currentMappings: SourceMapping[][];
- public currentNameIndex: number[];
- private sourceMapEntries;
- constructor(jsFile: TextWriter, sourceMapOut: TextWriter, document: Document, jsFilePath: string, emitOptions: EmitOptions, resolvePath: (path: string) => string);
- public getOutputFile(): OutputFile;
- public increaseMappingLevel(ast: IASTSpan): void;
- public decreaseMappingLevel(ast: IASTSpan): void;
- public setNewSourceFile(document: Document, emitOptions: EmitOptions): void;
- private setSourceMapOptions(document, jsFilePath, emitOptions, resolvePath);
- private setNewSourceFilePath(document, emitOptions);
- public emitSourceMapping(): void;
- }
-}
-declare module TypeScript {
- enum EmitContainer {
- Prog = 0,
- Module = 1,
- DynamicModule = 2,
- Class = 3,
- Constructor = 4,
- Function = 5,
- Args = 6,
- Interface = 7,
- }
- class EmitState {
- public column: number;
- public line: number;
- public container: EmitContainer;
- constructor();
- }
- class EmitOptions {
- public resolvePath: (path: string) => string;
- private _diagnostic;
- private _settings;
- private _commonDirectoryPath;
- private _sharedOutputFile;
- private _sourceRootDirectory;
- private _sourceMapRootDirectory;
- private _outputDirectory;
- public diagnostic(): Diagnostic;
- public commonDirectoryPath(): string;
- public sharedOutputFile(): string;
- public sourceRootDirectory(): string;
- public sourceMapRootDirectory(): string;
- public outputDirectory(): string;
- public compilationSettings(): ImmutableCompilationSettings;
- constructor(compiler: TypeScriptCompiler, resolvePath: (path: string) => string);
- private determineCommonDirectoryPath(compiler);
- }
- class Indenter {
- static indentStep: number;
- static indentStepString: string;
- static indentStrings: string[];
- public indentAmt: number;
- public increaseIndent(): void;
- public decreaseIndent(): void;
- public getIndent(): string;
- }
- function lastParameterIsRest(parameterList: ParameterList): boolean;
- class Emitter {
- public emittingFileName: string;
- public outfile: TextWriter;
- public emitOptions: EmitOptions;
- private semanticInfoChain;
- public globalThisCapturePrologueEmitted: boolean;
- public extendsPrologueEmitted: boolean;
- public thisClassNode: ClassDeclaration;
- public inArrowFunction: boolean;
- public moduleName: string;
- public emitState: EmitState;
- public indenter: Indenter;
- public sourceMapper: SourceMapper;
- public captureThisStmtString: string;
- private currentVariableDeclaration;
- private declStack;
- private exportAssignment;
- private inWithBlock;
- public document: Document;
- private detachedCommentsElement;
- constructor(emittingFileName: string, outfile: TextWriter, emitOptions: EmitOptions, semanticInfoChain: SemanticInfoChain);
- private pushDecl(decl);
- private popDecl(decl);
- private getEnclosingDecl();
- public setExportAssignment(exportAssignment: ExportAssignment): void;
- public getExportAssignment(): ExportAssignment;
- public setDocument(document: Document): void;
- public shouldEmitImportDeclaration(importDeclAST: ImportDeclaration): boolean;
- public emitImportDeclaration(importDeclAST: ImportDeclaration): void;
- public createSourceMapper(document: Document, jsFileName: string, jsFile: TextWriter, sourceMapOut: TextWriter, resolvePath: (path: string) => string): void;
- public setSourceMapperNewSourceFile(document: Document): void;
- private updateLineAndColumn(s);
- public writeToOutputWithSourceMapRecord(s: string, astSpan: IASTSpan): void;
- public writeToOutput(s: string): void;
- public writeLineToOutput(s: string, force?: boolean): void;
- public writeCaptureThisStatement(ast: AST): void;
- public setContainer(c: number): number;
- private getIndentString();
- public emitIndent(): void;
- public emitComment(comment: Comment, trailing: boolean, first: boolean): void;
- public emitComments(ast: AST, pre: boolean, onlyPinnedOrTripleSlashComments?: boolean): void;
- private isPinnedOrTripleSlash(comment);
- public emitCommentsArray(comments: Comment[], trailing: boolean): void;
- public emitObjectLiteralExpression(objectLiteral: ObjectLiteralExpression): void;
- public emitArrayLiteralExpression(arrayLiteral: ArrayLiteralExpression): void;
- public emitObjectCreationExpression(objectCreationExpression: ObjectCreationExpression): void;
- public getConstantDecl(dotExpr: MemberAccessExpression): PullEnumElementDecl;
- public tryEmitConstant(dotExpr: MemberAccessExpression): boolean;
- public emitInvocationExpression(callNode: InvocationExpression): void;
- private emitParameterList(list);
- private emitFunctionParameters(parameters);
- private emitFunctionBodyStatements(name, funcDecl, parameterList, block, bodyExpression);
- private emitDefaultValueAssignments(parameters);
- private emitRestParameterInitializer(parameters);
- private getImportDecls(fileName);
- public getModuleImportAndDependencyList(sourceUnit: SourceUnit): {
- importList: string;
- dependencyList: string;
- };
- public shouldCaptureThis(ast: AST): boolean;
- public emitEnum(moduleDecl: EnumDeclaration): void;
- private getModuleDeclToVerifyChildNameCollision(moduleDecl, changeNameIfAnyDeclarationInContext);
- private hasChildNameCollision(moduleName, parentDecl);
- private getModuleName(moduleDecl, changeNameIfAnyDeclarationInContext?);
- private emitModuleDeclarationWorker(moduleDecl);
- public emitSingleModuleDeclaration(moduleDecl: ModuleDeclaration, moduleName: IASTToken): void;
- public emitEnumElement(varDecl: EnumElement): void;
- public emitElementAccessExpression(expression: ElementAccessExpression): void;
- public emitSimpleArrowFunctionExpression(arrowFunction: SimpleArrowFunctionExpression): void;
- public emitParenthesizedArrowFunctionExpression(arrowFunction: ParenthesizedArrowFunctionExpression): void;
- private emitAnyArrowFunctionExpression(arrowFunction, funcName, parameters, block, expression);
- public emitConstructor(funcDecl: ConstructorDeclaration): void;
- public emitGetAccessor(accessor: GetAccessor): void;
- public emitSetAccessor(accessor: SetAccessor): void;
- public emitFunctionExpression(funcDecl: FunctionExpression): void;
- public emitFunction(funcDecl: FunctionDeclaration): void;
- public emitAmbientVarDecl(varDecl: VariableDeclarator): void;
- public emitVarDeclVar(): void;
- public emitVariableDeclaration(declaration: VariableDeclaration): void;
- private emitMemberVariableDeclaration(varDecl);
- public emitVariableDeclarator(varDecl: VariableDeclarator): void;
- private symbolIsUsedInItsEnclosingContainer(symbol, dynamic?);
- private shouldQualifySymbolNameWithParentName(symbol);
- private getSymbolForEmit(ast);
- public emitName(name: Identifier, addThis: boolean): void;
- public recordSourceMappingNameStart(name: string): void;
- public recordSourceMappingNameEnd(): void;
- public recordSourceMappingStart(ast: IASTSpan): void;
- public recordSourceMappingEnd(ast: IASTSpan): void;
- public getOutputFiles(): OutputFile[];
- private emitParameterPropertyAndMemberVariableAssignments();
- private isOnSameLine(pos1, pos2);
- private emitCommaSeparatedList(parent, list, buffer, preserveNewLines);
- public emitList(list: ISyntaxList2, useNewLineSeparator?: boolean, startInclusive?: number, endExclusive?: number): void;
- public emitSeparatedList(list: ISeparatedSyntaxList2, useNewLineSeparator?: boolean, startInclusive?: number, endExclusive?: number): void;
- private isDirectivePrologueElement(node);
- public emitSpaceBetweenConstructs(node1: AST, node2: AST): void;
- private getDetachedComments(element);
- private emitPossibleCopyrightHeaders(script);
- private emitDetachedComments(list);
- public emitScriptElements(sourceUnit: SourceUnit): void;
- public emitConstructorStatements(funcDecl: ConstructorDeclaration): void;
- public emitJavascript(ast: AST, startLine: boolean): void;
- public emitAccessorMemberDeclaration(funcDecl: AST, name: IASTToken, className: string, isProto: boolean): void;
- private emitAccessorBody(funcDecl, parameterList, block);
- public emitClass(classDecl: ClassDeclaration): void;
- private emitClassMembers(classDecl);
- private emitClassMemberFunctionDeclaration(classDecl, funcDecl);
- private requiresExtendsBlock(moduleElements);
- public emitPrologue(sourceUnit: SourceUnit): void;
- public emitThis(): void;
- public emitBlockOrStatement(node: AST): void;
- public emitLiteralExpression(expression: LiteralExpression): void;
- public emitThisExpression(expression: ThisExpression): void;
- public emitSuperExpression(expression: SuperExpression): void;
- public emitParenthesizedExpression(parenthesizedExpression: ParenthesizedExpression): void;
- public emitCastExpression(expression: CastExpression): void;
- public emitPrefixUnaryExpression(expression: PrefixUnaryExpression): void;
- public emitPostfixUnaryExpression(expression: PostfixUnaryExpression): void;
- public emitTypeOfExpression(expression: TypeOfExpression): void;
- public emitDeleteExpression(expression: DeleteExpression): void;
- public emitVoidExpression(expression: VoidExpression): void;
- private canEmitDottedNameMemberAccessExpression(expression);
- private emitDottedNameMemberAccessExpression(expression);
- private emitDottedNameMemberAccessExpressionRecurse(expression);
- public emitMemberAccessExpression(expression: MemberAccessExpression): void;
- public emitQualifiedName(name: QualifiedName): void;
- public emitBinaryExpression(expression: BinaryExpression): void;
- public emitSimplePropertyAssignment(property: SimplePropertyAssignment): void;
- public emitFunctionPropertyAssignment(funcProp: FunctionPropertyAssignment): void;
- public emitConditionalExpression(expression: ConditionalExpression): void;
- public emitThrowStatement(statement: ThrowStatement): void;
- public emitExpressionStatement(statement: ExpressionStatement): void;
- public emitLabeledStatement(statement: LabeledStatement): void;
- public emitBlock(block: Block): void;
- public emitBreakStatement(jump: BreakStatement): void;
- public emitContinueStatement(jump: ContinueStatement): void;
- public emitWhileStatement(statement: WhileStatement): void;
- public emitDoStatement(statement: DoStatement): void;
- public emitIfStatement(statement: IfStatement): void;
- public emitElseClause(elseClause: ElseClause): void;
- public emitReturnStatement(statement: ReturnStatement): void;
- public emitForInStatement(statement: ForInStatement): void;
- public emitForStatement(statement: ForStatement): void;
- public emitWithStatement(statement: WithStatement): void;
- public emitSwitchStatement(statement: SwitchStatement): void;
- public emitCaseSwitchClause(clause: CaseSwitchClause): void;
- private emitSwitchClauseBody(body);
- public emitDefaultSwitchClause(clause: DefaultSwitchClause): void;
- public emitTryStatement(statement: TryStatement): void;
- public emitCatchClause(clause: CatchClause): void;
- public emitFinallyClause(clause: FinallyClause): void;
- public emitDebuggerStatement(statement: DebuggerStatement): void;
- public emitNumericLiteral(literal: NumericLiteral): void;
- public emitRegularExpressionLiteral(literal: RegularExpressionLiteral): void;
- public emitStringLiteral(literal: StringLiteral): void;
- public emitEqualsValueClause(clause: EqualsValueClause): void;
- public emitParameter(parameter: Parameter): void;
- public emitConstructorDeclaration(declaration: ConstructorDeclaration): void;
- public shouldEmitFunctionDeclaration(declaration: FunctionDeclaration): boolean;
- public emitFunctionDeclaration(declaration: FunctionDeclaration): void;
- private emitSourceUnit(sourceUnit);
- public shouldEmitEnumDeclaration(declaration: EnumDeclaration): boolean;
- public emitEnumDeclaration(declaration: EnumDeclaration): void;
- public shouldEmitModuleDeclaration(declaration: ModuleDeclaration): boolean;
- private emitModuleDeclaration(declaration);
- public shouldEmitClassDeclaration(declaration: ClassDeclaration): boolean;
- public emitClassDeclaration(declaration: ClassDeclaration): void;
- public shouldEmitInterfaceDeclaration(declaration: InterfaceDeclaration): boolean;
- public emitInterfaceDeclaration(declaration: InterfaceDeclaration): void;
- private firstVariableDeclarator(statement);
- private isNotAmbientOrHasInitializer(variableStatement);
- public shouldEmitVariableStatement(statement: VariableStatement): boolean;
- public emitVariableStatement(statement: VariableStatement): void;
- public emitGenericType(type: GenericType): void;
- private shouldEmit(ast);
- private emit(ast);
- private emitWorker(ast);
- }
- function getLastConstructor(classDecl: ClassDeclaration): ConstructorDeclaration;
- function getTrimmedTextLines(comment: Comment): string[];
-}
-declare module TypeScript {
- class MemberName {
- public prefix: string;
- public suffix: string;
- public isString(): boolean;
- public isArray(): boolean;
- public isMarker(): boolean;
- public toString(): string;
- static memberNameToString(memberName: MemberName, markerInfo?: number[], markerBaseLength?: number): string;
- static create(text: string): MemberName;
- static create(entry: MemberName, prefix: string, suffix: string): MemberName;
- }
- class MemberNameString extends MemberName {
- public text: string;
- constructor(text: string);
- public isString(): boolean;
- }
- class MemberNameArray extends MemberName {
- public delim: string;
- public entries: MemberName[];
- public isArray(): boolean;
- public add(entry: MemberName): void;
- public addAll(entries: MemberName[]): void;
- constructor();
- }
-}
-declare module TypeScript {
- function stripStartAndEndQuotes(str: string): string;
- function isSingleQuoted(str: string): boolean;
- function isDoubleQuoted(str: string): boolean;
- function isQuoted(str: string): boolean;
- function quoteStr(str: string): string;
- function switchToForwardSlashes(path: string): string;
- function trimModName(modName: string): string;
- function getDeclareFilePath(fname: string): string;
- function isTSFile(fname: string): boolean;
- function isDTSFile(fname: string): boolean;
- function getPrettyName(modPath: string, quote?: boolean, treatAsFileName?: boolean): any;
- function getPathComponents(path: string): string[];
- function getRelativePathToFixedPath(fixedModFilePath: string, absoluteModPath: string, isAbsoultePathURL?: boolean): string;
- function changePathToDTS(modPath: string): string;
- function isRelative(path: string): boolean;
- function isRooted(path: string): boolean;
- function getRootFilePath(outFname: string): string;
- function filePathComponents(fullPath: string): string[];
- function filePath(fullPath: string): string;
- function convertToDirectoryPath(dirPath: string): string;
- function normalizePath(path: string): string;
-}
-declare module TypeScript {
- interface IFileReference extends ILineAndCharacter {
- path: string;
- isResident: boolean;
- position: number;
- length: number;
- }
-}
-declare module TypeScript {
- interface IPreProcessedFileInfo {
- referencedFiles: IFileReference[];
- importedFiles: IFileReference[];
- diagnostics: Diagnostic[];
- isLibFile: boolean;
- }
- var tripleSlashReferenceRegExp: RegExp;
- function preProcessFile(fileName: string, sourceText: IScriptSnapshot, readImportFiles?: boolean): IPreProcessedFileInfo;
- function getParseOptions(settings: ImmutableCompilationSettings): ParseOptions;
- function getReferencedFiles(fileName: string, sourceText: IScriptSnapshot): IFileReference[];
-}
-declare module TypeScript {
- interface IResolvedFile {
- path: string;
- referencedFiles: string[];
- importedFiles: string[];
- }
- interface IReferenceResolverHost {
- getScriptSnapshot(fileName: string): IScriptSnapshot;
- resolveRelativePath(path: string, directory: string): string;
- fileExists(path: string): boolean;
- directoryExists(path: string): boolean;
- getParentDirectory(path: string): string;
- }
- class ReferenceResolutionResult {
- public resolvedFiles: IResolvedFile[];
- public diagnostics: Diagnostic[];
- public seenNoDefaultLibTag: boolean;
- }
- class ReferenceResolver {
- private useCaseSensitiveFileResolution;
- private inputFileNames;
- private host;
- private visited;
- constructor(inputFileNames: string[], host: IReferenceResolverHost, useCaseSensitiveFileResolution: boolean);
- static resolve(inputFileNames: string[], host: IReferenceResolverHost, useCaseSensitiveFileResolution: boolean): ReferenceResolutionResult;
- public resolveInputFiles(): ReferenceResolutionResult;
- private resolveIncludedFile(path, referenceLocation, resolutionResult);
- private resolveImportedFile(path, referenceLocation, resolutionResult);
- private resolveFile(normalizedPath, resolutionResult);
- private getNormalizedFilePath(path, parentFilePath);
- private getUniqueFileId(filePath);
- private recordVisitedFile(filePath);
- private isVisited(filePath);
- private isSameFile(filePath1, filePath2);
- }
-}
-declare module TypeScript {
- class TextWriter {
- private name;
- private writeByteOrderMark;
- private outputFileType;
- private contents;
- public onNewLine: boolean;
- constructor(name: string, writeByteOrderMark: boolean, outputFileType: OutputFileType);
- public Write(s: string): void;
- public WriteLine(s: string): void;
- public Close(): void;
- public getOutputFile(): OutputFile;
- }
- class DeclarationEmitter {
- private emittingFileName;
- public document: Document;
- private compiler;
- private emitOptions;
- private semanticInfoChain;
- private declFile;
- private indenter;
- private emittedReferencePaths;
- constructor(emittingFileName: string, document: Document, compiler: TypeScriptCompiler, emitOptions: EmitOptions, semanticInfoChain: SemanticInfoChain);
- public getOutputFile(): OutputFile;
- public emitDeclarations(sourceUnit: SourceUnit): void;
- private emitDeclarationsForList(list);
- private emitSeparatedList(list);
- private emitDeclarationsForAST(ast);
- private getIndentString(declIndent?);
- private emitIndent();
- private canEmitDeclarations(declAST);
- private getDeclFlagsString(pullDecl, typeString);
- private emitDeclFlags(declarationAST, typeString);
- private emitTypeNamesMember(memberName, emitIndent?);
- private emitTypeSignature(ast, type);
- private emitComment(comment);
- private emitDeclarationComments(ast, endLine?);
- private writeDeclarationComments(declComments, endLine?);
- private emitTypeOfVariableDeclaratorOrParameter(boundDecl);
- private emitPropertySignature(varDecl);
- private emitVariableDeclarator(varDecl, isFirstVarInList, isLastVarInList);
- private emitClassElementModifiers(modifiers);
- private emitDeclarationsForMemberVariableDeclaration(varDecl);
- private emitDeclarationsForVariableStatement(variableStatement);
- private emitDeclarationsForVariableDeclaration(variableDeclaration);
- private emitArgDecl(argDecl, id, isOptional, isPrivate);
- private isOverloadedCallSignature(funcDecl);
- private emitDeclarationsForConstructorDeclaration(funcDecl);
- private emitParameterList(isPrivate, parameterList);
- private emitParameters(isPrivate, parameterList);
- private emitMemberFunctionDeclaration(funcDecl);
- private emitCallSignature(funcDecl);
- private emitConstructSignature(funcDecl);
- private emitMethodSignature(funcDecl);
- private emitDeclarationsForFunctionDeclaration(funcDecl);
- private emitIndexMemberDeclaration(funcDecl);
- private emitIndexSignature(funcDecl);
- private emitBaseList(bases, useExtendsList);
- private emitAccessorDeclarationComments(funcDecl);
- private emitDeclarationsForGetAccessor(funcDecl);
- private emitDeclarationsForSetAccessor(funcDecl);
- private emitMemberAccessorDeclaration(funcDecl, modifiers, name);
- private emitClassMembersFromConstructorDefinition(funcDecl);
- private emitDeclarationsForClassDeclaration(classDecl);
- private emitHeritageClauses(clauses);
- private emitHeritageClause(clause);
- static getEnclosingContainer(ast: AST): AST;
- private emitTypeParameters(typeParams, funcSignature?);
- private emitDeclarationsForInterfaceDeclaration(interfaceDecl);
- private emitDeclarationsForImportDeclaration(importDeclAST);
- private emitDeclarationsForEnumDeclaration(moduleDecl);
- private emitDeclarationsForModuleDeclaration(moduleDecl);
- private emitDeclarationsForExportAssignment(ast);
- private resolveScriptReference(document, reference);
- private emitReferencePaths(sourceUnit);
- private emitDeclarationsForSourceUnit(sourceUnit);
- }
-}
-declare module TypeScript {
- class BloomFilter {
- private bitArray;
- private hashFunctionCount;
- static falsePositiveProbability: number;
- constructor(expectedCount: number);
- static computeM(expectedCount: number): number;
- static computeK(expectedCount: number): number;
- private computeHash(key, seed);
- public addKeys(keys: IIndexable<any>): void;
- public add(value: string): void;
- public probablyContains(value: string): boolean;
- public isEquivalent(filter: BloomFilter): boolean;
- static isEquivalent(array1: boolean[], array2: boolean[]): boolean;
- }
-}
-declare module TypeScript {
- class IdentifierWalker extends SyntaxWalker {
- public list: IIndexable<boolean>;
- constructor(list: IIndexable<boolean>);
- public visitToken(token: ISyntaxToken): void;
- }
-}
-declare module TypeScript {
- class CompilationSettings {
- public propagateEnumConstants: boolean;
- public removeComments: boolean;
- public watch: boolean;
- public noResolve: boolean;
- public allowAutomaticSemicolonInsertion: boolean;
- public noImplicitAny: boolean;
- public noLib: boolean;
- public codeGenTarget: LanguageVersion;
- public moduleGenTarget: ModuleGenTarget;
- public outFileOption: string;
- public outDirOption: string;
- public mapSourceFiles: boolean;
- public mapRoot: string;
- public sourceRoot: string;
- public generateDeclarationFiles: boolean;
- public useCaseSensitiveFileResolution: boolean;
- public gatherDiagnostics: boolean;
- public codepage: number;
- public createFileLog: boolean;
- }
- class ImmutableCompilationSettings {
- private static _defaultSettings;
- private _propagateEnumConstants;
- private _removeComments;
- private _watch;
- private _noResolve;
- private _allowAutomaticSemicolonInsertion;
- private _noImplicitAny;
- private _noLib;
- private _codeGenTarget;
- private _moduleGenTarget;
- private _outFileOption;
- private _outDirOption;
- private _mapSourceFiles;
- private _mapRoot;
- private _sourceRoot;
- private _generateDeclarationFiles;
- private _useCaseSensitiveFileResolution;
- private _gatherDiagnostics;
- private _codepage;
- private _createFileLog;
- public propagateEnumConstants(): boolean;
- public removeComments(): boolean;
- public watch(): boolean;
- public noResolve(): boolean;
- public allowAutomaticSemicolonInsertion(): boolean;
- public noImplicitAny(): boolean;
- public noLib(): boolean;
- public codeGenTarget(): LanguageVersion;
- public moduleGenTarget(): ModuleGenTarget;
- public outFileOption(): string;
- public outDirOption(): string;
- public mapSourceFiles(): boolean;
- public mapRoot(): string;
- public sourceRoot(): string;
- public generateDeclarationFiles(): boolean;
- public useCaseSensitiveFileResolution(): boolean;
- public gatherDiagnostics(): boolean;
- public codepage(): number;
- public createFileLog(): boolean;
- constructor(propagateEnumConstants: boolean, removeComments: boolean, watch: boolean, noResolve: boolean, allowAutomaticSemicolonInsertion: boolean, noImplicitAny: boolean, noLib: boolean, codeGenTarget: LanguageVersion, moduleGenTarget: ModuleGenTarget, outFileOption: string, outDirOption: string, mapSourceFiles: boolean, mapRoot: string, sourceRoot: string, generateDeclarationFiles: boolean, useCaseSensitiveFileResolution: boolean, gatherDiagnostics: boolean, codepage: number, createFileLog: boolean);
- static defaultSettings(): ImmutableCompilationSettings;
- static fromCompilationSettings(settings: CompilationSettings): ImmutableCompilationSettings;
- public toCompilationSettings(): any;
- }
-}
-declare module TypeScript {
- enum PullElementFlags {
- None = 0,
- Exported = 1,
- Private = 2,
- Public = 4,
- Ambient = 8,
- Static = 16,
- Optional = 128,
- Signature = 2048,
- Enum = 4096,
- ArrowFunction = 8192,
- ClassConstructorVariable = 16384,
- InitializedModule = 32768,
- InitializedDynamicModule = 65536,
- MustCaptureThis = 262144,
- DeclaredInAWithBlock = 2097152,
- HasReturnStatement = 4194304,
- PropertyParameter = 8388608,
- IsAnnotatedWithAny = 16777216,
- HasDefaultArgs = 33554432,
- ConstructorParameter = 67108864,
- ImplicitVariable = 118784,
- SomeInitializedModule = 102400,
- }
- function hasModifier(modifiers: PullElementFlags[], flag: PullElementFlags): boolean;
- enum PullElementKind {
- None = 0,
- Global = 0,
- Script = 1,
- Primitive = 2,
- Container = 4,
- Class = 8,
- Interface = 16,
- DynamicModule = 32,
- Enum = 64,
- TypeAlias = 128,
- ObjectLiteral = 256,
- Variable = 512,
- CatchVariable = 1024,
- Parameter = 2048,
- Property = 4096,
- TypeParameter = 8192,
- Function = 16384,
- ConstructorMethod = 32768,
- Method = 65536,
- FunctionExpression = 131072,
- GetAccessor = 262144,
- SetAccessor = 524288,
- CallSignature = 1048576,
- ConstructSignature = 2097152,
- IndexSignature = 4194304,
- ObjectType = 8388608,
- FunctionType = 16777216,
- ConstructorType = 33554432,
- EnumMember = 67108864,
- WithBlock = 134217728,
- CatchBlock = 268435456,
- All = 536869887,
- SomeFunction = 1032192,
- SomeValue = 68147712,
- SomeType = 58728795,
- AcceptableAlias = 59753052,
- SomeContainer = 164,
- SomeSignature = 7340032,
- SomeTypeReference = 58720272,
- SomeInstantiatableType = 8216,
- }
-}
-declare module TypeScript {
- class PullDecl {
- public kind: PullElementKind;
- public name: string;
- private declDisplayName;
- public semanticInfoChain: SemanticInfoChain;
- public declID: number;
- public flags: PullElementFlags;
- private declGroups;
- private childDecls;
- private typeParameters;
- private synthesizedValDecl;
- private containerDecl;
- public childDeclTypeCache: IIndexable<PullDecl[]>;
- public childDeclValueCache: IIndexable<PullDecl[]>;
- public childDeclNamespaceCache: IIndexable<PullDecl[]>;
- public childDeclTypeParameterCache: IIndexable<PullDecl[]>;
- constructor(declName: string, displayName: string, kind: PullElementKind, declFlags: PullElementFlags, semanticInfoChain: SemanticInfoChain);
- public fileName(): string;
- public getParentPath(): PullDecl[];
- public getParentDecl(): PullDecl;
- public isExternalModule(): boolean;
- public getEnclosingDecl(): PullDecl;
- public _getEnclosingDeclFromParentDecl(): PullDecl;
- public getDisplayName(): string;
- public setSymbol(symbol: PullSymbol): void;
- public ensureSymbolIsBound(): void;
- public getSymbol(): PullSymbol;
- public hasSymbol(): boolean;
- public setSignatureSymbol(signatureSymbol: PullSignatureSymbol): void;
- public getSignatureSymbol(): PullSignatureSymbol;
- public hasSignatureSymbol(): boolean;
- public setFlags(flags: PullElementFlags): void;
- public setFlag(flags: PullElementFlags): void;
- public setValueDecl(valDecl: PullDecl): void;
- public getValueDecl(): PullDecl;
- public getContainerDecl(): PullDecl;
- private getChildDeclCache(declKind);
- public addChildDecl(childDecl: PullDecl): void;
- public searchChildDecls(declName: string, searchKind: PullElementKind): PullDecl[];
- public getChildDecls(): PullDecl[];
- public getTypeParameters(): PullDecl[];
- public addVariableDeclToGroup(decl: PullDecl): void;
- public getVariableDeclGroups(): PullDecl[][];
- public hasBeenBound(): boolean;
- public isSynthesized(): boolean;
- public ast(): AST;
- public isRootDecl(): boolean;
- }
- class RootPullDecl extends PullDecl {
- private _isExternalModule;
- private _fileName;
- constructor(name: string, fileName: string, kind: PullElementKind, declFlags: PullElementFlags, semanticInfoChain: SemanticInfoChain, isExternalModule: boolean);
- public fileName(): string;
- public getParentPath(): PullDecl[];
- public getParentDecl(): PullDecl;
- public isExternalModule(): boolean;
- public getEnclosingDecl(): RootPullDecl;
- public isRootDecl(): boolean;
- }
- class NormalPullDecl extends PullDecl {
- private parentDecl;
- public _rootDecl: RootPullDecl;
- private parentPath;
- constructor(declName: string, displayName: string, kind: PullElementKind, declFlags: PullElementFlags, parentDecl: PullDecl, addToParent?: boolean);
- public fileName(): string;
- public getParentDecl(): PullDecl;
- public getParentPath(): PullDecl[];
- public isExternalModule(): boolean;
- public getEnclosingDecl(): PullDecl;
- public isRootDecl(): boolean;
- }
- class PullEnumElementDecl extends NormalPullDecl {
- public constantValue: number;
- constructor(declName: string, displayName: string, parentDecl: PullDecl);
- }
- class PullFunctionExpressionDecl extends NormalPullDecl {
- private functionExpressionName;
- constructor(expressionName: string, declFlags: PullElementFlags, parentDecl: PullDecl, displayName?: string);
- public getFunctionExpressionName(): string;
- }
- class PullSynthesizedDecl extends NormalPullDecl {
- constructor(declName: string, displayName: string, kind: PullElementKind, declFlags: PullElementFlags, parentDecl: PullDecl, semanticInfoChain: SemanticInfoChain);
- public isSynthesized(): boolean;
- public fileName(): string;
- }
- class PullDeclGroup {
- public name: string;
- private _decls;
- constructor(name: string);
- public addDecl(decl: PullDecl): void;
- public getDecls(): PullDecl[];
- }
-}
-declare module TypeScript {
- var pullSymbolID: number;
- var sentinelEmptyArray: any[];
- class PullSymbol {
- public pullSymbolID: number;
- public name: string;
- public kind: PullElementKind;
- private _container;
- public type: PullTypeSymbol;
- private _declarations;
- public isResolved: boolean;
- public isOptional: boolean;
- public inResolution: boolean;
- private isSynthesized;
- public isVarArg: boolean;
- private rootSymbol;
- private _enclosingSignature;
- private _docComments;
- public isPrinting: boolean;
- public isAny(): boolean;
- public isType(): boolean;
- public isTypeReference(): boolean;
- public isSignature(): boolean;
- public isArrayNamedTypeReference(): boolean;
- public isPrimitive(): boolean;
- public isAccessor(): boolean;
- public isError(): boolean;
- public isInterface(): boolean;
- public isMethod(): boolean;
- public isProperty(): boolean;
- public isAlias(): boolean;
- public isContainer(): boolean;
- constructor(name: string, declKind: PullElementKind);
- private findAliasedTypeSymbols(scopeSymbol, skipScopeSymbolAliasesLookIn?, lookIntoOnlyExportedAlias?, aliasSymbols?, visitedScopeDeclarations?);
- public getExternalAliasedSymbols(scopeSymbol: PullSymbol): PullTypeAliasSymbol[];
- static _isExternalModuleReferenceAlias(aliasSymbol: PullTypeAliasSymbol): boolean;
- private getExportedInternalAliasSymbol(scopeSymbol);
- public getAliasSymbolName(scopeSymbol: PullSymbol, aliasNameGetter: (symbol: PullTypeAliasSymbol) => string, aliasPartsNameGetter: (symbol: PullTypeAliasSymbol) => string, skipInternalAlias?: boolean): string;
- public _getResolver(): PullTypeResolver;
- public _resolveDeclaredSymbol(): PullSymbol;
- public getName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- public getDisplayName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string;
- public getIsSpecialized(): boolean;
- public getRootSymbol(): PullSymbol;
- public setRootSymbol(symbol: PullSymbol): void;
- public setIsSynthesized(value?: boolean): void;
- public getIsSynthesized(): any;
- public setEnclosingSignature(signature: PullSignatureSymbol): void;
- public getEnclosingSignature(): PullSignatureSymbol;
- public addDeclaration(decl: PullDecl): void;
- public getDeclarations(): PullDecl[];
- public hasDeclaration(decl: PullDecl): boolean;
- public setContainer(containerSymbol: PullTypeSymbol): void;
- public getContainer(): PullTypeSymbol;
- public setResolved(): void;
- public startResolving(): void;
- public setUnresolved(): void;
- public anyDeclHasFlag(flag: PullElementFlags): boolean;
- public allDeclsHaveFlag(flag: PullElementFlags): boolean;
- public pathToRoot(): PullSymbol[];
- private static unqualifiedNameReferencesDifferentSymbolInScope(symbol, scopePath, endScopePathIndex);
- private findQualifyingSymbolPathInScopeSymbol(scopeSymbol);
- public toString(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- public getNamePartForFullName(): string;
- public fullName(scopeSymbol?: PullSymbol): string;
- public getScopedName(scopeSymbol?: PullSymbol, skipTypeParametersInName?: boolean, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string;
- public getScopedNameEx(scopeSymbol?: PullSymbol, skipTypeParametersInName?: boolean, useConstraintInName?: boolean, getPrettyTypeName?: boolean, getTypeParamMarkerInfo?: boolean, skipInternalAliasName?: boolean): MemberName;
- public getTypeName(scopeSymbol?: PullSymbol, getPrettyTypeName?: boolean): string;
- public getTypeNameEx(scopeSymbol?: PullSymbol, getPrettyTypeName?: boolean): MemberName;
- private getTypeNameForFunctionSignature(prefix, scopeSymbol?, getPrettyTypeName?);
- public getNameAndTypeName(scopeSymbol?: PullSymbol): string;
- public getNameAndTypeNameEx(scopeSymbol?: PullSymbol): MemberName;
- static getTypeParameterString(typars: PullTypeSymbol[], scopeSymbol?: PullSymbol, useContraintInName?: boolean): string;
- static getTypeParameterStringEx(typeParameters: PullTypeSymbol[], scopeSymbol?: PullSymbol, getTypeParamMarkerInfo?: boolean, useContraintInName?: boolean): MemberNameArray;
- static getIsExternallyVisible(symbol: PullSymbol, fromIsExternallyVisibleSymbol: PullSymbol, inIsExternallyVisibleSymbols: PullSymbol[]): boolean;
- public isExternallyVisible(inIsExternallyVisibleSymbols?: PullSymbol[]): boolean;
- private getDocCommentsOfDecl(decl);
- private getDocCommentArray(symbol);
- private static getDefaultConstructorSymbolForDocComments(classSymbol);
- private getDocCommentText(comments);
- private getDocCommentTextValue(comment);
- public docComments(useConstructorAsClass?: boolean): string;
- private getParameterDocCommentText(param, fncDocComments);
- private cleanJSDocComment(content, spacesToRemove?);
- private consumeLeadingSpace(line, startIndex, maxSpacesToRemove?);
- private isSpaceChar(line, index);
- private cleanDocCommentLine(line, jsDocStyleComment, jsDocLineSpaceToRemove?);
- }
- interface InstantiableSymbol {
- getIsSpecialized(): boolean;
- getAllowedToReferenceTypeParameters(): PullTypeParameterSymbol[];
- getTypeParameterArgumentMap(): TypeArgumentMap;
- }
- class PullSignatureSymbol extends PullSymbol implements InstantiableSymbol {
- private _isDefinition;
- private _memberTypeParameterNameCache;
- private _stringConstantOverload;
- public parameters: PullSymbol[];
- public _typeParameters: PullTypeParameterSymbol[];
- public returnType: PullTypeSymbol;
- public functionType: PullTypeSymbol;
- public hasOptionalParam: boolean;
- public nonOptionalParamCount: number;
- public hasVarArgs: boolean;
- private _allowedToReferenceTypeParameters;
- private _instantiationCache;
- public hasBeenChecked: boolean;
- public inWrapCheck: boolean;
- public inWrapInfiniteExpandingReferenceCheck: boolean;
- private _wrapsTypeParameterCache;
- constructor(kind: PullElementKind, _isDefinition?: boolean);
- public isDefinition(): boolean;
- public isGeneric(): boolean;
- public addParameter(parameter: PullSymbol, isOptional?: boolean): void;
- public addTypeParameter(typeParameter: PullTypeParameterSymbol): void;
- public addTypeParametersFromReturnType(): void;
- public getTypeParameters(): PullTypeParameterSymbol[];
- public findTypeParameter(name: string): PullTypeParameterSymbol;
- public getTypeParameterArgumentMap(): TypeArgumentMap;
- public getAllowedToReferenceTypeParameters(): PullTypeParameterSymbol[];
- public addSpecialization(specializedVersionOfThisSignature: PullSignatureSymbol, typeArgumentMap: TypeArgumentMap): void;
- public getSpecialization(typeArgumentMap: TypeArgumentMap): PullSignatureSymbol;
- public isStringConstantOverloadSignature(): boolean;
- public getParameterTypeAtIndex(iParam: number): PullTypeSymbol;
- static getSignatureTypeMemberName(candidateSignature: PullSignatureSymbol, signatures: PullSignatureSymbol[], scopeSymbol: PullSymbol): MemberNameArray;
- static getSignaturesTypeNameEx(signatures: PullSignatureSymbol[], prefix: string, shortform: boolean, brackets: boolean, scopeSymbol?: PullSymbol, getPrettyTypeName?: boolean, candidateSignature?: PullSignatureSymbol): MemberName[];
- public toString(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- public getSignatureTypeNameEx(prefix: string, shortform: boolean, brackets: boolean, scopeSymbol?: PullSymbol, getParamMarkerInfo?: boolean, getTypeParamMarkerInfo?: boolean): MemberNameArray;
- public forAllParameterTypes(length: number, predicate: (parameterType: PullTypeSymbol, iterationIndex: number) => boolean): boolean;
- public forAllCorrespondingParameterTypesInThisAndOtherSignature(otherSignature: PullSignatureSymbol, predicate: (thisSignatureParameterType: PullTypeSymbol, otherSignatureParameterType: PullTypeSymbol, iterationIndex: number) => boolean): boolean;
- public wrapsSomeTypeParameter(typeParameterArgumentMap: TypeArgumentMap): boolean;
- public getWrappingTypeParameterID(typeParameterArgumentMap: TypeArgumentMap): number;
- public getWrappingTypeParameterIDWorker(typeParameterArgumentMap: TypeArgumentMap): number;
- public _wrapsSomeTypeParameterIntoInfinitelyExpandingTypeReference(enclosingType: PullTypeSymbol, knownWrapMap: IBitMatrix): boolean;
- public _wrapsSomeTypeParameterIntoInfinitelyExpandingTypeReferenceWorker(enclosingType: PullTypeSymbol, knownWrapMap: IBitMatrix): boolean;
- }
- class PullTypeSymbol extends PullSymbol implements InstantiableSymbol {
- private _members;
- private _enclosedMemberTypes;
- private _enclosedMemberContainers;
- private _typeParameters;
- private _allowedToReferenceTypeParameters;
- private _specializedVersionsOfThisType;
- private _arrayVersionOfThisType;
- private _implementedTypes;
- private _extendedTypes;
- private _typesThatExplicitlyImplementThisType;
- private _typesThatExtendThisType;
- private _callSignatures;
- private _allCallSignatures;
- private _constructSignatures;
- private _allConstructSignatures;
- private _indexSignatures;
- private _allIndexSignatures;
- private _allIndexSignaturesOfAugmentedType;
- private _memberNameCache;
- private _enclosedTypeNameCache;
- private _enclosedContainerCache;
- private _typeParameterNameCache;
- private _containedNonMemberNameCache;
- private _containedNonMemberTypeNameCache;
- private _containedNonMemberContainerCache;
- private _simpleInstantiationCache;
- private _complexInstantiationCache;
- private _hasGenericSignature;
- private _hasGenericMember;
- private _hasBaseTypeConflict;
- private _knownBaseTypeCount;
- private _associatedContainerTypeSymbol;
- private _constructorMethod;
- private _hasDefaultConstructor;
- private _functionSymbol;
- private _inMemberTypeNameEx;
- public inSymbolPrivacyCheck: boolean;
- public inWrapCheck: boolean;
- public inWrapInfiniteExpandingReferenceCheck: boolean;
- public typeReference: PullTypeReferenceSymbol;
- private _widenedType;
- private _wrapsTypeParameterCache;
- constructor(name: string, kind: PullElementKind);
- private _isArrayNamedTypeReference;
- public isArrayNamedTypeReference(): boolean;
- private computeIsArrayNamedTypeReference();
- public isType(): boolean;
- public isClass(): boolean;
- public isFunction(): boolean;
- public isConstructor(): boolean;
- public isTypeParameter(): boolean;
- public isTypeVariable(): boolean;
- public isError(): boolean;
- public isEnum(): boolean;
- public getTypeParameterArgumentMap(): TypeArgumentMap;
- public isObject(): boolean;
- public isFunctionType(): boolean;
- public getKnownBaseTypeCount(): number;
- public resetKnownBaseTypeCount(): void;
- public incrementKnownBaseCount(): void;
- public setHasBaseTypeConflict(): void;
- public hasBaseTypeConflict(): boolean;
- public hasMembers(): boolean;
- public setHasGenericSignature(): void;
- public getHasGenericSignature(): boolean;
- public setHasGenericMember(): void;
- public getHasGenericMember(): boolean;
- public setAssociatedContainerType(type: PullTypeSymbol): void;
- public getAssociatedContainerType(): PullTypeSymbol;
- public getArrayType(): PullTypeSymbol;
- public getElementType(): PullTypeSymbol;
- public setArrayType(arrayType: PullTypeSymbol): void;
- public getFunctionSymbol(): PullSymbol;
- public setFunctionSymbol(symbol: PullSymbol): void;
- public findContainedNonMember(name: string): PullSymbol;
- public findContainedNonMemberType(typeName: string, kind?: PullElementKind): PullTypeSymbol;
- public findContainedNonMemberContainer(containerName: string, kind?: PullElementKind): PullTypeSymbol;
- public addMember(memberSymbol: PullSymbol): void;
- public addEnclosedMemberType(enclosedType: PullTypeSymbol): void;
- public addEnclosedMemberContainer(enclosedContainer: PullTypeSymbol): void;
- public addEnclosedNonMember(enclosedNonMember: PullSymbol): void;
- public addEnclosedNonMemberType(enclosedNonMemberType: PullTypeSymbol): void;
- public addEnclosedNonMemberContainer(enclosedNonMemberContainer: PullTypeSymbol): void;
- public addTypeParameter(typeParameter: PullTypeParameterSymbol): void;
- public getMembers(): PullSymbol[];
- public setHasDefaultConstructor(hasOne?: boolean): void;
- public getHasDefaultConstructor(): boolean;
- public getConstructorMethod(): PullSymbol;
- public setConstructorMethod(constructorMethod: PullSymbol): void;
- public getTypeParameters(): PullTypeParameterSymbol[];
- public getAllowedToReferenceTypeParameters(): PullTypeParameterSymbol[];
- public isGeneric(): boolean;
- private canUseSimpleInstantiationCache(typeArgumentMap);
- private getSimpleInstantiationCacheId(typeArgumentMap);
- public addSpecialization(specializedVersionOfThisType: PullTypeSymbol, typeArgumentMap: TypeArgumentMap): void;
- public getSpecialization(typeArgumentMap: TypeArgumentMap): PullTypeSymbol;
- public getKnownSpecializations(): PullTypeSymbol[];
- public getTypeArguments(): PullTypeSymbol[];
- public getTypeArgumentsOrTypeParameters(): PullTypeSymbol[];
- private addCallOrConstructSignaturePrerequisiteBase(signature);
- private addCallSignaturePrerequisite(callSignature);
- public appendCallSignature(callSignature: PullSignatureSymbol): void;
- public insertCallSignatureAtIndex(callSignature: PullSignatureSymbol, index: number): void;
- private addConstructSignaturePrerequisite(constructSignature);
- public appendConstructSignature(constructSignature: PullSignatureSymbol): void;
- public insertConstructSignatureAtIndex(constructSignature: PullSignatureSymbol, index: number): void;
- public addIndexSignature(indexSignature: PullSignatureSymbol): void;
- public hasOwnCallSignatures(): boolean;
- public getOwnCallSignatures(): PullSignatureSymbol[];
- public getCallSignatures(): PullSignatureSymbol[];
- public hasOwnConstructSignatures(): boolean;
- public getOwnDeclaredConstructSignatures(): PullSignatureSymbol[];
- public getConstructSignatures(): PullSignatureSymbol[];
- public hasOwnIndexSignatures(): boolean;
- public getOwnIndexSignatures(): PullSignatureSymbol[];
- public getIndexSignatures(): PullSignatureSymbol[];
- public getIndexSignaturesOfAugmentedType(resolver: PullTypeResolver, globalFunctionInterface: PullTypeSymbol, globalObjectInterface: PullTypeSymbol): PullSignatureSymbol[];
- private getBaseClassConstructSignatures(baseType);
- private getDefaultClassConstructSignature();
- public addImplementedType(implementedType: PullTypeSymbol): void;
- public getImplementedTypes(): PullTypeSymbol[];
- public addExtendedType(extendedType: PullTypeSymbol): void;
- public getExtendedTypes(): PullTypeSymbol[];
- public addTypeThatExtendsThisType(type: PullTypeSymbol): void;
- public getTypesThatExtendThisType(): PullTypeSymbol[];
- public addTypeThatExplicitlyImplementsThisType(type: PullTypeSymbol): void;
- public getTypesThatExplicitlyImplementThisType(): PullTypeSymbol[];
- public hasBase(potentialBase: PullTypeSymbol, visited?: PullSymbol[]): boolean;
- public isValidBaseKind(baseType: PullTypeSymbol, isExtendedType: boolean): boolean;
- public findMember(name: string, lookInParent: boolean): PullSymbol;
- public findNestedType(name: string, kind?: PullElementKind): PullTypeSymbol;
- public findNestedContainer(name: string, kind?: PullElementKind): PullTypeSymbol;
- public getAllMembers(searchDeclKind: PullElementKind, memberVisiblity: GetAllMembersVisiblity): PullSymbol[];
- public findTypeParameter(name: string): PullTypeParameterSymbol;
- public setResolved(): void;
- public getNamePartForFullName(): string;
- public getScopedName(scopeSymbol?: PullSymbol, skipTypeParametersInName?: boolean, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string;
- public isNamedTypeSymbol(): boolean;
- public toString(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- public getScopedNameEx(scopeSymbol?: PullSymbol, skipTypeParametersInName?: boolean, useConstraintInName?: boolean, getPrettyTypeName?: boolean, getTypeParamMarkerInfo?: boolean, skipInternalAliasName?: boolean, shouldAllowArrayType?: boolean): MemberName;
- public hasOnlyOverloadCallSignatures(): boolean;
- public getTypeOfSymbol(): PullSymbol;
- private getMemberTypeNameEx(topLevel, scopeSymbol?, getPrettyTypeName?);
- public getGenerativeTypeClassification(enclosingType: PullTypeSymbol): GenerativeTypeClassification;
- public wrapsSomeTypeParameter(typeParameterArgumentMap: CandidateInferenceInfo[]): boolean;
- public wrapsSomeTypeParameter(typeParameterArgumentMap: TypeArgumentMap, skipTypeArgumentCheck?: boolean): boolean;
- public getWrappingTypeParameterID(typeParameterArgumentMap: TypeArgumentMap, skipTypeArgumentCheck?: boolean): number;
- private getWrappingTypeParameterIDFromSignatures(signatures, typeParameterArgumentMap);
- private getWrappingTypeParameterIDWorker(typeParameterArgumentMap, skipTypeArgumentCheck);
- public wrapsSomeTypeParameterIntoInfinitelyExpandingTypeReference(enclosingType: PullTypeSymbol): boolean;
- public _wrapsSomeTypeParameterIntoInfinitelyExpandingTypeReferenceRecurse(enclosingType: PullTypeSymbol, knownWrapMap: IBitMatrix): boolean;
- private _wrapsSomeTypeParameterIntoInfinitelyExpandingTypeReferenceWorker(enclosingType, knownWrapMap);
- private _wrapsSomeTypeParameterIntoInfinitelyExpandingTypeReferenceStructure(enclosingType, knownWrapMap);
- public widenedType(resolver: PullTypeResolver, ast: AST, context: PullTypeResolutionContext): PullTypeSymbol;
- }
- class PullPrimitiveTypeSymbol extends PullTypeSymbol {
- constructor(name: string);
- public isAny(): boolean;
- public isNull(): boolean;
- public isUndefined(): boolean;
- public isStringConstant(): boolean;
- public setUnresolved(): void;
- public getDisplayName(): string;
- }
- class PullStringConstantTypeSymbol extends PullPrimitiveTypeSymbol {
- constructor(name: string);
- public isStringConstant(): boolean;
- }
- class PullErrorTypeSymbol extends PullPrimitiveTypeSymbol {
- public _anyType: PullTypeSymbol;
- constructor(_anyType: PullTypeSymbol, name: string);
- public isError(): boolean;
- public _getResolver(): PullTypeResolver;
- public getName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- public getDisplayName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string;
- public toString(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- }
- class PullContainerSymbol extends PullTypeSymbol {
- public instanceSymbol: PullSymbol;
- private assignedValue;
- private assignedType;
- private assignedContainer;
- constructor(name: string, kind: PullElementKind);
- public isContainer(): boolean;
- public setInstanceSymbol(symbol: PullSymbol): void;
- public getInstanceSymbol(): PullSymbol;
- public setExportAssignedValueSymbol(symbol: PullSymbol): void;
- public getExportAssignedValueSymbol(): PullSymbol;
- public setExportAssignedTypeSymbol(type: PullTypeSymbol): void;
- public getExportAssignedTypeSymbol(): PullTypeSymbol;
- public setExportAssignedContainerSymbol(container: PullContainerSymbol): void;
- public getExportAssignedContainerSymbol(): PullContainerSymbol;
- public hasExportAssignment(): boolean;
- static usedAsSymbol(containerSymbol: PullSymbol, symbol: PullSymbol): boolean;
- public getInstanceType(): PullTypeSymbol;
- }
- class PullTypeAliasSymbol extends PullTypeSymbol {
- private _assignedValue;
- private _assignedType;
- private _assignedContainer;
- private _isUsedAsValue;
- private _typeUsedExternally;
- private _isUsedInExportAlias;
- private retrievingExportAssignment;
- private linkedAliasSymbols;
- constructor(name: string);
- public isUsedInExportedAlias(): boolean;
- public typeUsedExternally(): boolean;
- public isUsedAsValue(): boolean;
- public setTypeUsedExternally(): void;
- public setIsUsedInExportedAlias(): void;
- public addLinkedAliasSymbol(contingentValueSymbol: PullTypeAliasSymbol): void;
- public setIsUsedAsValue(): void;
- public assignedValue(): PullSymbol;
- public assignedType(): PullTypeSymbol;
- public assignedContainer(): PullContainerSymbol;
- public isAlias(): boolean;
- public isContainer(): boolean;
- public setAssignedValueSymbol(symbol: PullSymbol): void;
- public getExportAssignedValueSymbol(): PullSymbol;
- public setAssignedTypeSymbol(type: PullTypeSymbol): void;
- public getExportAssignedTypeSymbol(): PullTypeSymbol;
- public setAssignedContainerSymbol(container: PullContainerSymbol): void;
- public getExportAssignedContainerSymbol(): PullContainerSymbol;
- public getMembers(): PullSymbol[];
- public getCallSignatures(): PullSignatureSymbol[];
- public getConstructSignatures(): PullSignatureSymbol[];
- public getIndexSignatures(): PullSignatureSymbol[];
- public findMember(name: string): PullSymbol;
- public findNestedType(name: string): PullTypeSymbol;
- public findNestedContainer(name: string): PullTypeSymbol;
- public getAllMembers(searchDeclKind: PullElementKind, memberVisibility: GetAllMembersVisiblity): PullSymbol[];
- }
- class PullTypeParameterSymbol extends PullTypeSymbol {
- private _constraint;
- constructor(name: string);
- public isTypeParameter(): boolean;
- public setConstraint(constraintType: PullTypeSymbol): void;
- public getConstraint(): PullTypeSymbol;
- public getBaseConstraint(semanticInfoChain: SemanticInfoChain): PullTypeSymbol;
- private getConstraintRecursively(visitedTypeParameters);
- public getDefaultConstraint(semanticInfoChain: SemanticInfoChain): PullTypeSymbol;
- public getCallSignatures(): PullSignatureSymbol[];
- public getConstructSignatures(): PullSignatureSymbol[];
- public getIndexSignatures(): PullSignatureSymbol[];
- public isGeneric(): boolean;
- public fullName(scopeSymbol?: PullSymbol): string;
- public getName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean): string;
- public getDisplayName(scopeSymbol?: PullSymbol, useConstraintInName?: boolean, skipInternalAliasName?: boolean): string;
- public isExternallyVisible(inIsExternallyVisibleSymbols?: PullSymbol[]): boolean;
- }
- class PullAccessorSymbol extends PullSymbol {
- private _getterSymbol;
- private _setterSymbol;
- constructor(name: string);
- public isAccessor(): boolean;
- public setSetter(setter: PullSymbol): void;
- public getSetter(): PullSymbol;
- public setGetter(getter: PullSymbol): void;
- public getGetter(): PullSymbol;
- }
- function getIDForTypeSubstitutions(instantiatingType: PullTypeSymbol, typeArgumentMap: TypeArgumentMap): string;
- function getIDForTypeSubstitutions(instantiatingSignature: PullSignatureSymbol, typeArgumentMap: TypeArgumentMap): string;
- enum GetAllMembersVisiblity {
- all = 0,
- internallyVisible = 1,
- externallyVisible = 2,
- }
-}
-declare module TypeScript {
- class EnclosingTypeWalkerState {
- public _hasSetEnclosingType: boolean;
- public _currentSymbols: PullSymbol[];
- static getDefaultEnclosingTypeWalkerState(): EnclosingTypeWalkerState;
- static getNonGenericEnclosingTypeWalkerState(): EnclosingTypeWalkerState;
- static getGenericEnclosingTypeWalkerState(genericEnclosingType: PullTypeSymbol): EnclosingTypeWalkerState;
- }
- class PullTypeEnclosingTypeWalker {
- private static _defaultEnclosingTypeWalkerState;
- private static _nonGenericEnclosingTypeWalkerState;
- private enclosingTypeWalkerState;
- constructor();
- private setDefaultTypeWalkerState();
- private setNonGenericEnclosingTypeWalkerState();
- private canSymbolOrDeclBeUsedAsEnclosingTypeHelper(name, kind);
- private canDeclBeUsedAsEnclosingType(decl);
- private canSymbolBeUsedAsEnclosingType(symbol);
- public getEnclosingType(): PullTypeSymbol;
- public _canWalkStructure(): boolean;
- public _getCurrentSymbol(): PullSymbol;
- public getGenerativeClassification(): GenerativeTypeClassification;
- private _pushSymbol(symbol);
- private _popSymbol();
- private setSymbolAsEnclosingType(type);
- private _setEnclosingTypeOfParentDecl(decl, setSignature);
- public setEnclosingTypeForSymbol(symbol: PullSymbol): EnclosingTypeWalkerState;
- public startWalkingType(symbol: PullTypeSymbol): EnclosingTypeWalkerState;
- public endWalkingType(stateWhenStartedWalkingTypes: EnclosingTypeWalkerState): void;
- public walkMemberType(memberName: string, resolver: PullTypeResolver): void;
- public postWalkMemberType(): void;
- public walkSignature(kind: PullElementKind, index: number): void;
- public postWalkSignature(): void;
- public walkTypeArgument(index: number): void;
- public postWalkTypeArgument(): void;
- public walkTypeParameterConstraint(index: number): void;
- public postWalkTypeParameterConstraint(): void;
- public walkReturnType(): void;
- public postWalkReturnType(): void;
- public walkParameterType(iParam: number): void;
- public postWalkParameterType(): void;
- public getBothKindOfIndexSignatures(resolver: PullTypeResolver, context: PullTypeResolutionContext, includeAugmentedType: boolean): IndexSignatureInfo;
- public walkIndexSignatureReturnType(indexSigInfo: IndexSignatureInfo, useStringIndexSignature: boolean, onlySignature?: boolean): void;
- public postWalkIndexSignatureReturnType(onlySignature?: boolean): void;
- public resetEnclosingTypeWalkerState(): EnclosingTypeWalkerState;
- public setEnclosingTypeWalkerState(enclosingTypeWalkerState: EnclosingTypeWalkerState): void;
- }
-}
-declare module TypeScript {
- class CandidateInferenceInfo {
- public typeParameter: PullTypeParameterSymbol;
- public _inferredTypeAfterFixing: PullTypeSymbol;
- public inferenceCandidates: PullTypeSymbol[];
- public addCandidate(candidate: PullTypeSymbol): void;
- public isFixed(): boolean;
- public fixTypeParameter(resolver: PullTypeResolver, context: PullTypeResolutionContext): void;
- }
- class TypeArgumentInferenceContext {
- public resolver: PullTypeResolver;
- public context: PullTypeResolutionContext;
- public signatureBeingInferred: PullSignatureSymbol;
- public inferenceCache: IBitMatrix;
- public candidateCache: CandidateInferenceInfo[];
- constructor(resolver: PullTypeResolver, context: PullTypeResolutionContext, signatureBeingInferred: PullSignatureSymbol);
- public alreadyRelatingTypes(objectType: PullTypeSymbol, parameterType: PullTypeSymbol): boolean;
- public resetRelationshipCache(): void;
- public addInferenceRoot(param: PullTypeParameterSymbol): void;
- public getInferenceInfo(param: PullTypeParameterSymbol): CandidateInferenceInfo;
- public addCandidateForInference(param: PullTypeParameterSymbol, candidate: PullTypeSymbol): void;
- public inferTypeArguments(): PullTypeSymbol[];
- public fixTypeParameter(typeParameter: PullTypeParameterSymbol): void;
- public _finalizeInferredTypeArguments(): PullTypeSymbol[];
- public isInvocationInferenceContext(): boolean;
- }
- class InvocationTypeArgumentInferenceContext extends TypeArgumentInferenceContext {
- public argumentASTs: ISeparatedSyntaxList2;
- constructor(resolver: PullTypeResolver, context: PullTypeResolutionContext, signatureBeingInferred: PullSignatureSymbol, argumentASTs: ISeparatedSyntaxList2);
- public isInvocationInferenceContext(): boolean;
- public inferTypeArguments(): PullTypeSymbol[];
- }
- class ContextualSignatureInstantiationTypeArgumentInferenceContext extends TypeArgumentInferenceContext {
- private contextualSignature;
- private shouldFixContextualSignatureParameterTypes;
- constructor(resolver: PullTypeResolver, context: PullTypeResolutionContext, signatureBeingInferred: PullSignatureSymbol, contextualSignature: PullSignatureSymbol, shouldFixContextualSignatureParameterTypes: boolean);
- public isInvocationInferenceContext(): boolean;
- public inferTypeArguments(): PullTypeSymbol[];
- }
- class PullContextualTypeContext {
- public contextualType: PullTypeSymbol;
- public provisional: boolean;
- public isInferentiallyTyping: boolean;
- public typeArgumentInferenceContext: TypeArgumentInferenceContext;
- public provisionallyTypedSymbols: PullSymbol[];
- public hasProvisionalErrors: boolean;
- private astSymbolMap;
- constructor(contextualType: PullTypeSymbol, provisional: boolean, isInferentiallyTyping: boolean, typeArgumentInferenceContext: TypeArgumentInferenceContext);
- public recordProvisionallyTypedSymbol(symbol: PullSymbol): void;
- public invalidateProvisionallyTypedSymbols(): void;
- public setSymbolForAST(ast: AST, symbol: PullSymbol): void;
- public getSymbolForAST(ast: AST): PullSymbol;
- }
- class PullTypeResolutionContext {
- private resolver;
- public inTypeCheck: boolean;
- public fileName: string;
- private contextStack;
- private typeCheckedNodes;
- private enclosingTypeWalker1;
- private enclosingTypeWalker2;
- constructor(resolver: PullTypeResolver, inTypeCheck?: boolean, fileName?: string);
- public setTypeChecked(ast: AST): void;
- public canTypeCheckAST(ast: AST): boolean;
- private _pushAnyContextualType(type, provisional, isInferentiallyTyping, argContext);
- public pushNewContextualType(type: PullTypeSymbol): void;
- public propagateContextualType(type: PullTypeSymbol): void;
- public pushInferentialType(type: PullTypeSymbol, typeArgumentInferenceContext: TypeArgumentInferenceContext): void;
- public pushProvisionalType(type: PullTypeSymbol): void;
- public popAnyContextualType(): PullContextualTypeContext;
- public hasProvisionalErrors(): boolean;
- public getContextualType(): PullTypeSymbol;
- public fixAllTypeParametersReferencedByType(type: PullTypeSymbol, resolver: PullTypeResolver, argContext?: TypeArgumentInferenceContext): PullTypeSymbol;
- private getCurrentTypeArgumentInferenceContext();
- public isInferentiallyTyping(): boolean;
- public inProvisionalResolution(): boolean;
- private inBaseTypeResolution;
- public isInBaseTypeResolution(): boolean;
- public startBaseTypeResolution(): boolean;
- public doneBaseTypeResolution(wasInBaseTypeResolution: boolean): void;
- public setTypeInContext(symbol: PullSymbol, type: PullTypeSymbol): void;
- public postDiagnostic(diagnostic: Diagnostic): void;
- public typeCheck(): boolean;
- public setSymbolForAST(ast: AST, symbol: PullSymbol): void;
- public getSymbolForAST(ast: AST): PullSymbol;
- public startWalkingTypes(symbol1: PullTypeSymbol, symbol2: PullTypeSymbol): {
- stateWhenStartedWalkingTypes1: EnclosingTypeWalkerState;
- stateWhenStartedWalkingTypes2: EnclosingTypeWalkerState;
- };
- public endWalkingTypes(statesWhenStartedWalkingTypes: {
- stateWhenStartedWalkingTypes1: EnclosingTypeWalkerState;
- stateWhenStartedWalkingTypes2: EnclosingTypeWalkerState;
- }): void;
- public setEnclosingTypeForSymbols(symbol1: PullSymbol, symbol2: PullSymbol): {
- enclosingTypeWalkerState1: EnclosingTypeWalkerState;
- enclosingTypeWalkerState2: EnclosingTypeWalkerState;
- };
- public walkMemberTypes(memberName: string): void;
- public postWalkMemberTypes(): void;
- public walkSignatures(kind: PullElementKind, index: number, index2?: number): void;
- public postWalkSignatures(): void;
- public walkTypeParameterConstraints(index: number): void;
- public postWalkTypeParameterConstraints(): void;
- public walkTypeArgument(index: number): void;
- public postWalkTypeArgument(): void;
- public walkReturnTypes(): void;
- public postWalkReturnTypes(): void;
- public walkParameterTypes(iParam: number): void;
- public postWalkParameterTypes(): void;
- public getBothKindOfIndexSignatures(includeAugmentedType1: boolean, includeAugmentedType2: boolean): {
- indexSigs1: IndexSignatureInfo;
- indexSigs2: IndexSignatureInfo;
- };
- public walkIndexSignatureReturnTypes(indexSigs: {
- indexSigs1: IndexSignatureInfo;
- indexSigs2: IndexSignatureInfo;
- }, useStringIndexSignature1: boolean, useStringIndexSignature2: boolean, onlySignature?: boolean): void;
- public postWalkIndexSignatureReturnTypes(onlySignature?: boolean): void;
- public swapEnclosingTypeWalkers(): void;
- public oneOfClassificationsIsInfinitelyExpanding(): boolean;
- public resetEnclosingTypeWalkerStates(): {
- enclosingTypeWalkerState1: EnclosingTypeWalkerState;
- enclosingTypeWalkerState2: EnclosingTypeWalkerState;
- };
- public setEnclosingTypeWalkerStates(enclosingTypeWalkerStates: {
- enclosingTypeWalkerState1: EnclosingTypeWalkerState;
- enclosingTypeWalkerState2: EnclosingTypeWalkerState;
- }): void;
- }
-}
-declare module TypeScript {
- interface IPullTypeCollection {
- getLength(): number;
- getTypeAtIndex(index: number): PullTypeSymbol;
- }
- class PullAdditionalCallResolutionData {
- public targetSymbol: PullSymbol;
- public resolvedSignatures: PullSignatureSymbol[];
- public candidateSignature: PullSignatureSymbol;
- public actualParametersContextTypeSymbols: PullTypeSymbol[];
- public diagnosticsFromOverloadResolution: Diagnostic[];
- }
- class PullAdditionalObjectLiteralResolutionData {
- public membersContextTypeSymbols: PullTypeSymbol[];
- }
- interface IndexSignatureInfo {
- numericSignature: PullSignatureSymbol;
- stringSignature: PullSignatureSymbol;
- }
- class PullTypeResolver {
- private compilationSettings;
- public semanticInfoChain: SemanticInfoChain;
- private _cachedArrayInterfaceType;
- private _cachedNumberInterfaceType;
- private _cachedStringInterfaceType;
- private _cachedBooleanInterfaceType;
- private _cachedObjectInterfaceType;
- private _cachedFunctionInterfaceType;
- private _cachedIArgumentsInterfaceType;
- private _cachedRegExpInterfaceType;
- private _cachedAnyTypeArgs;
- private typeCheckCallBacks;
- private postTypeCheckWorkitems;
- private _cachedFunctionArgumentsSymbol;
- private assignableCache;
- private subtypeCache;
- private identicalCache;
- private inResolvingOtherDeclsWalker;
- constructor(compilationSettings: ImmutableCompilationSettings, semanticInfoChain: SemanticInfoChain);
- private cachedArrayInterfaceType();
- public getArrayNamedType(): PullTypeSymbol;
- private cachedNumberInterfaceType();
- private cachedStringInterfaceType();
- private cachedBooleanInterfaceType();
- private cachedObjectInterfaceType();
- private cachedFunctionInterfaceType();
- private cachedIArgumentsInterfaceType();
- private cachedRegExpInterfaceType();
- private cachedFunctionArgumentsSymbol();
- private getApparentType(type);
- private setTypeChecked(ast, context);
- private canTypeCheckAST(ast, context);
- private setSymbolForAST(ast, symbol, context);
- private getSymbolForAST(ast, context);
- public getASTForDecl(decl: PullDecl): AST;
- public getNewErrorTypeSymbol(name?: string): PullErrorTypeSymbol;
- public getEnclosingDecl(decl: PullDecl): PullDecl;
- private getExportedMemberSymbol(symbol, parent);
- public _getNamedPropertySymbolOfAugmentedType(symbolName: string, parent: PullTypeSymbol): PullSymbol;
- private getNamedPropertySymbol(symbolName, declSearchKind, parent);
- private getSymbolFromDeclPath(symbolName, declPath, declSearchKind);
- private getVisibleDeclsFromDeclPath(declPath, declSearchKind);
- private addFilteredDecls(decls, declSearchKind, result);
- public getVisibleDecls(enclosingDecl: PullDecl): PullDecl[];
- public getVisibleContextSymbols(enclosingDecl: PullDecl, context: PullTypeResolutionContext): PullSymbol[];
- public getVisibleMembersFromExpression(expression: AST, enclosingDecl: PullDecl, context: PullTypeResolutionContext): PullSymbol[];
- private isAnyOrEquivalent(type);
- private resolveExternalModuleReference(idText, currentFileName);
- public resolveDeclaredSymbol<TSymbol extends PullSymbol>(symbol: TSymbol, context?: PullTypeResolutionContext): TSymbol;
- private resolveDeclaredSymbolWorker<TSymbol extends PullSymbol>(symbol, context);
- private resolveOtherDecl(otherDecl, context);
- private resolveOtherDeclarations(astName, context);
- private resolveSourceUnit(sourceUnit, context);
- private typeCheckSourceUnit(sourceUnit, context);
- private verifyUniquenessOfImportNamesInSourceUnit(sourceUnit);
- private resolveEnumDeclaration(ast, context);
- private typeCheckEnumDeclaration(ast, context);
- private postTypeCheckEnumDeclaration(ast, context);
- private checkInitializersInEnumDeclarations(decl, context);
- private resolveModuleDeclaration(ast, context);
- private ensureAllSymbolsAreBound(containerSymbol);
- private resolveModuleSymbol(containerSymbol, context, moduleDeclAST, moduleDeclNameAST, sourceUnitAST);
- private resolveFirstExportAssignmentStatement(moduleElements, context);
- private resolveSingleModuleDeclaration(ast, astName, context);
- private typeCheckModuleDeclaration(ast, context);
- private typeCheckSingleModuleDeclaration(ast, astName, context);
- private verifyUniquenessOfImportNamesInModule(decl);
- private checkUniquenessOfImportNames(decls, doesNameExistOutside?);
- private scanVariableDeclarationGroups(enclosingDecl, firstDeclHandler, subsequentDeclHandler?);
- private postTypeCheckModuleDeclaration(ast, context);
- private isTypeRefWithoutTypeArgs(term);
- public createInstantiatedType(type: PullTypeSymbol, typeArguments: PullTypeSymbol[]): PullTypeSymbol;
- private resolveReferenceTypeDeclaration(classOrInterface, name, heritageClauses, context);
- private resolveClassDeclaration(classDeclAST, context);
- private typeCheckTypeParametersOfTypeDeclaration(classOrInterface, context);
- private typeCheckClassDeclaration(classDeclAST, context);
- private postTypeCheckClassDeclaration(classDeclAST, context);
- private resolveTypeSymbolSignatures(typeSymbol, context);
- private resolveInterfaceDeclaration(interfaceDeclAST, context);
- private typeCheckInterfaceDeclaration(interfaceDeclAST, context);
- private checkInterfaceDeclForIdenticalTypeParameters(interfaceDeclAST, context);
- private checkTypeForDuplicateIndexSignatures(enclosingTypeSymbol);
- private filterSymbol(symbol, kind, enclosingDecl, context);
- private getMemberSymbolOfKind(symbolName, kind, pullTypeSymbol, enclosingDecl, context);
- private resolveIdentifierOfInternalModuleReference(importDecl, identifier, moduleSymbol, enclosingDecl, context);
- private resolveModuleReference(importDecl, moduleNameExpr, enclosingDecl, context, declPath);
- private resolveInternalModuleReference(importStatementAST, context);
- private resolveImportDeclaration(importStatementAST, context);
- private typeCheckImportDeclaration(importStatementAST, context);
- private postTypeCheckImportDeclaration(importStatementAST, context);
- private resolveExportAssignmentStatement(exportAssignmentAST, context);
- private resolveAnyFunctionTypeSignature(funcDeclAST, typeParameters, parameterList, returnTypeAnnotation, context);
- private resolveFunctionTypeSignatureParameter(argDeclAST, signature, enclosingDecl, context);
- private resolveFunctionExpressionParameter(argDeclAST, id, typeExpr, equalsValueClause, contextParam, enclosingDecl, context);
- private checkNameForCompilerGeneratedDeclarationCollision(astWithName, isDeclaration, name, context);
- private hasRestParameterCodeGen(someFunctionDecl);
- private checkArgumentsCollides(ast, context);
- private checkIndexOfRestArgumentInitializationCollides(ast, isDeclaration, context);
- private checkExternalModuleRequireExportsCollides(ast, name, context);
- private resolveObjectTypeTypeReference(objectType, context);
- private typeCheckObjectTypeTypeReference(objectType, context);
- private resolveTypeAnnotation(typeAnnotation, context);
- public resolveTypeReference(typeRef: AST, context: PullTypeResolutionContext): PullTypeSymbol;
- private getArrayType(elementType);
- private computeTypeReferenceSymbol(term, context);
- private genericTypeIsUsedWithoutRequiredTypeArguments(typeSymbol, term, context);
- private resolveMemberVariableDeclaration(varDecl, context);
- private resolvePropertySignature(varDecl, context);
- private resolveVariableDeclarator(varDecl, context);
- private resolveParameterList(list, context);
- private resolveParameter(parameter, context);
- private getEnumTypeSymbol(enumElement, context);
- private resolveEnumElement(enumElement, context);
- private typeCheckEnumElement(enumElement, context);
- private resolveEqualsValueClause(clause, isContextuallyTyped, context);
- private resolveVariableDeclaratorOrParameterOrEnumElement(varDeclOrParameter, modifiers, name, typeExpr, init, context);
- private resolveAndTypeCheckVariableDeclarationTypeExpr(varDeclOrParameter, name, typeExpr, context);
- private resolveAndTypeCheckVariableDeclaratorOrParameterInitExpr(varDeclOrParameter, name, typeExpr, init, context, typeExprSymbol);
- private typeCheckPropertySignature(varDecl, context);
- private typeCheckMemberVariableDeclaration(varDecl, context);
- private typeCheckVariableDeclarator(varDecl, context);
- private typeCheckParameter(parameter, context);
- private typeCheckVariableDeclaratorOrParameterOrEnumElement(varDeclOrParameter, modifiers, name, typeExpr, init, context);
- private isForInVariableDeclarator(ast);
- private checkSuperCaptureVariableCollides(superAST, isDeclaration, context);
- private checkThisCaptureVariableCollides(_thisAST, isDeclaration, context);
- private postTypeCheckVariableDeclaratorOrParameter(varDeclOrParameter, context);
- private resolveTypeParameterDeclaration(typeParameterAST, context);
- private resolveFirstTypeParameterDeclaration(typeParameterSymbol, context);
- private typeCheckTypeParameterDeclaration(typeParameterAST, context);
- private resolveConstraint(constraint, context);
- private resolveFunctionBodyReturnTypes(funcDeclAST, block, bodyExpression, signature, useContextualType, enclosingDecl, context);
- private typeCheckConstructorDeclaration(funcDeclAST, context);
- private constructorHasSuperCall(constructorDecl);
- private typeCheckFunctionExpression(funcDecl, isContextuallyTyped, context);
- private typeCheckCallSignature(funcDecl, context);
- private typeCheckConstructSignature(funcDecl, context);
- private typeCheckMethodSignature(funcDecl, context);
- private typeCheckMemberFunctionDeclaration(funcDecl, context);
- private containsSingleThrowStatement(block);
- private typeCheckAnyFunctionDeclaration(funcDeclAST, isStatic, name, typeParameters, parameters, returnTypeAnnotation, block, context);
- private checkThatNonVoidFunctionHasReturnExpressionOrThrowStatement(functionDecl, returnTypeAnnotation, returnTypeSymbol, block, context);
- private typeCheckIndexSignature(funcDeclAST, context);
- private postTypeCheckFunctionDeclaration(funcDeclAST, context);
- private resolveReturnTypeAnnotationOfFunctionDeclaration(funcDeclAST, returnTypeAnnotation, context);
- private resolveMemberFunctionDeclaration(funcDecl, context);
- private resolveCallSignature(funcDecl, context);
- private resolveConstructSignature(funcDecl, context);
- private resolveMethodSignature(funcDecl, context);
- private resolveAnyFunctionDeclaration(funcDecl, context);
- private resolveFunctionExpression(funcDecl, isContextuallyTyped, context);
- private resolveSimpleArrowFunctionExpression(funcDecl, isContextuallyTyped, context);
- private resolveParenthesizedArrowFunctionExpression(funcDecl, isContextuallyTyped, context);
- private getEnclosingClassDeclaration(ast);
- private resolveConstructorDeclaration(funcDeclAST, context);
- private resolveIndexMemberDeclaration(ast, context);
- private resolveIndexSignature(funcDeclAST, context);
- private resolveFunctionDeclaration(funcDeclAST, isStatic, name, typeParameters, parameterList, returnTypeAnnotation, block, context);
- private resolveGetterReturnTypeAnnotation(getterFunctionDeclarationAst, enclosingDecl, context);
- private resolveSetterArgumentTypeAnnotation(setterFunctionDeclarationAst, enclosingDecl, context);
- private resolveAccessorDeclaration(funcDeclAst, context);
- private typeCheckAccessorDeclaration(funcDeclAst, context);
- private resolveGetAccessorDeclaration(funcDeclAST, parameters, returnTypeAnnotation, block, setterAnnotatedType, context);
- private checkIfGetterAndSetterTypeMatch(funcDeclAST, context);
- private typeCheckGetAccessorDeclaration(funcDeclAST, context);
- static hasSetAccessorParameterTypeAnnotation(setAccessor: SetAccessor): boolean;
- private resolveSetAccessorDeclaration(funcDeclAST, parameterList, context);
- private typeCheckSetAccessorDeclaration(funcDeclAST, context);
- private resolveList(list, context);
- private resolveSeparatedList(list, context);
- private resolveVoidExpression(ast, context);
- private resolveLogicalOperation(ast, context);
- private typeCheckLogicalOperation(binex, context);
- private resolveLogicalNotExpression(ast, context);
- private resolveUnaryArithmeticOperation(ast, context);
- private resolvePostfixUnaryExpression(ast, context);
- private isAnyOrNumberOrEnum(type);
- private typeCheckUnaryArithmeticOperation(unaryExpression, context);
- private typeCheckPostfixUnaryExpression(unaryExpression, context);
- private resolveBinaryArithmeticExpression(binaryExpression, context);
- private typeCheckBinaryArithmeticExpression(binaryExpression, context);
- private resolveTypeOfExpression(ast, context);
- private resolveThrowStatement(ast, context);
- private resolveDeleteExpression(ast, context);
- private resolveInstanceOfExpression(ast, context);
- private typeCheckInstanceOfExpression(binaryExpression, context);
- private resolveCommaExpression(commaExpression, context);
- private resolveInExpression(ast, context);
- private typeCheckInExpression(binaryExpression, context);
- private resolveForStatement(ast, context);
- private resolveForInStatement(forInStatement, context);
- private typeCheckForInStatement(forInStatement, context);
- private resolveWhileStatement(ast, context);
- private typeCheckWhileStatement(ast, context);
- private resolveDoStatement(ast, context);
- private typeCheckDoStatement(ast, context);
- private resolveIfStatement(ast, context);
- private typeCheckIfStatement(ast, context);
- private resolveElseClause(ast, context);
- private typeCheckElseClause(ast, context);
- private resolveBlock(ast, context);
- private resolveVariableStatement(ast, context);
- private resolveVariableDeclarationList(ast, context);
- private resolveWithStatement(ast, context);
- private typeCheckWithStatement(ast, context);
- private resolveTryStatement(ast, context);
- private typeCheckTryStatement(ast, context);
- private resolveCatchClause(ast, context);
- private typeCheckCatchClause(ast, context);
- private resolveFinallyClause(ast, context);
- private typeCheckFinallyClause(ast, context);
- private getEnclosingFunctionDeclaration(ast);
- private resolveReturnExpression(expression, enclosingFunction, context);
- private typeCheckReturnExpression(expression, expressionType, enclosingFunction, context);
- private resolveReturnStatement(returnAST, context);
- private resolveSwitchStatement(ast, context);
- private typeCheckSwitchStatement(ast, context);
- private resolveLabeledStatement(ast, context);
- private typeCheckLabeledStatement(ast, context);
- private labelIsOnContinuableConstruct(statement);
- private resolveContinueStatement(ast, context);
- private isIterationStatement(ast);
- private isAnyFunctionExpressionOrDeclaration(ast);
- private inSwitchStatement(ast);
- private inIterationStatement(ast, crossFunctions);
- private getEnclosingLabels(ast, breakable, crossFunctions);
- private typeCheckContinueStatement(ast, context);
- private resolveBreakStatement(ast, context);
- private typeCheckBreakStatement(ast, context);
- public resolveAST(ast: AST, isContextuallyTyped: boolean, context: PullTypeResolutionContext): PullSymbol;
- private resolveExpressionAST(ast, isContextuallyOrInferentiallyTyped, context);
- private resolveExpressionWorker(ast, isContextuallyTyped, context);
- private typeCheckAST(ast, isContextuallyTyped, context);
- private processPostTypeCheckWorkItems(context);
- private postTypeCheck(ast, context);
- private resolveRegularExpressionLiteral();
- private postTypeCheckNameExpression(nameAST, context);
- private typeCheckNameExpression(nameAST, context);
- private resolveNameExpression(nameAST, context);
- private isInEnumDecl(decl);
- private getSomeInnermostFunctionScopeDecl(declPath);
- private isFromFunctionScope(nameSymbol, functionScopeDecl);
- private findConstructorDeclOfEnclosingType(decl);
- private checkNameAsPartOfInitializerExpressionForInstanceMemberVariable(nameAST, nameSymbol, context);
- private computeNameExpression(nameAST, context);
- private getCurrentParameterIndexForFunction(parameter, funcDecl);
- private resolveMemberAccessExpression(dottedNameAST, context);
- private resolveDottedNameExpression(dottedNameAST, expression, name, context);
- private computeDottedNameExpression(expression, name, context, checkSuperPrivateAndStaticAccess);
- private computeDottedNameExpressionFromLHS(lhs, expression, name, context, checkSuperPrivateAndStaticAccess);
- private resolveTypeNameExpression(nameAST, context);
- private computeTypeNameExpression(nameAST, context);
- private isInStaticMemberContext(decl);
- private isLeftSideOfQualifiedName(ast);
- private resolveGenericTypeReference(genericTypeAST, context);
- private resolveQualifiedName(dottedNameAST, context);
- private isLastNameOfModuleNameModuleReference(ast);
- private computeQualifiedName(dottedNameAST, context);
- private shouldContextuallyTypeAnyFunctionExpression(functionExpressionAST, typeParameters, parameters, returnTypeAnnotation, context);
- private resolveAnyFunctionExpression(funcDeclAST, typeParameters, parameters, returnTypeAnnotation, block, bodyExpression, isContextuallyTyped, context);
- private resolveAnyFunctionExpressionParameters(funcDeclAST, typeParameters, parameters, returnTypeAnnotation, isContextuallyTyped, context);
- private typeCheckSimpleArrowFunctionExpression(arrowFunction, isContextuallyTyped, context);
- private typeCheckParenthesizedArrowFunctionExpression(arrowFunction, isContextuallyTyped, context);
- private typeCheckAnyFunctionExpression(funcDeclAST, typeParameters, parameters, returnTypeAnnotation, block, bodyExpression, isContextuallyTyped, context);
- private resolveThisExpression(thisExpression, context);
- private inTypeArgumentList(ast);
- private inClassExtendsHeritageClause(ast);
- private inTypeQuery(ast);
- private inArgumentListOfSuperInvocation(ast);
- private inConstructorParameterList(ast);
- private isFunctionAccessorOrNonArrowFunctionExpression(decl);
- private isFunctionOrNonArrowFunctionExpression(decl);
- private typeCheckThisExpression(thisExpression, context, enclosingDecl);
- private getContextualClassSymbolForEnclosingDecl(ast, enclosingDecl);
- private inStaticMemberVariableDeclaration(ast);
- private resolveSuperExpression(ast, context);
- private typeCheckSuperExpression(ast, context, enclosingDecl);
- private resolveSimplePropertyAssignment(propertyAssignment, isContextuallyTyped, context);
- private resolveFunctionPropertyAssignment(funcProp, isContextuallyTyped, context);
- private typeCheckFunctionPropertyAssignment(funcProp, isContextuallyTyped, context);
- public resolveObjectLiteralExpression(expressionAST: ObjectLiteralExpression, isContextuallyTyped: boolean, context: PullTypeResolutionContext, additionalResults?: PullAdditionalObjectLiteralResolutionData): PullSymbol;
- private bindObjectLiteralMembers(objectLiteralDeclaration, objectLiteralTypeSymbol, objectLiteralMembers, isUsingExistingSymbol, pullTypeContext);
- private resolveObjectLiteralMembers(objectLiteralDeclaration, objectLiteralTypeSymbol, objectLiteralContextualType, objectLiteralMembers, stringIndexerSignature, numericIndexerSignature, allMemberTypes, allNumericMemberTypes, boundMemberSymbols, isUsingExistingSymbol, pullTypeContext, additionalResults?);
- private computeObjectLiteralExpression(objectLitAST, isContextuallyTyped, context, additionalResults?);
- private getPropertyAssignmentName(propertyAssignment);
- private stampObjectLiteralWithIndexSignature(objectLiteralSymbol, indexerTypeCandidates, contextualIndexSignature, context);
- private resolveArrayLiteralExpression(arrayLit, isContextuallyTyped, context);
- private computeArrayLiteralExpressionSymbol(arrayLit, isContextuallyTyped, context);
- private resolveElementAccessExpression(callEx, context);
- private typeCheckElementAccessExpression(callEx, context, symbolAndDiagnostic);
- private computeElementAccessExpressionSymbolAndDiagnostic(callEx, context);
- private getBothKindsOfIndexSignaturesIncludingAugmentedType(enclosingType, context);
- private getBothKindsOfIndexSignaturesExcludingAugmentedType(enclosingType, context);
- public _getBothKindsOfIndexSignatures(enclosingType: PullTypeSymbol, context: PullTypeResolutionContext, includeAugmentedType: boolean): IndexSignatureInfo;
- public _addUnhiddenSignaturesFromBaseType(derivedTypeSignatures: PullSignatureSymbol[], baseTypeSignatures: PullSignatureSymbol[], signaturesBeingAggregated: PullSignatureSymbol[]): void;
- private resolveBinaryAdditionOperation(binaryExpression, context);
- private bestCommonTypeOfTwoTypes(type1, type2, context);
- private bestCommonTypeOfThreeTypes(type1, type2, type3, context);
- private resolveLogicalOrExpression(binex, isContextuallyTyped, context);
- private resolveLogicalAndExpression(binex, context);
- private computeTypeOfConditionalExpression(leftType, rightType, isContextuallyTyped, context);
- private resolveConditionalExpression(trinex, isContextuallyTyped, context);
- private conditionExpressionTypesAreValid(leftType, rightType, expressionType, isContextuallyTyped, context);
- private resolveParenthesizedExpression(ast, context);
- private resolveExpressionStatement(ast, context);
- public resolveInvocationExpression(callEx: InvocationExpression, context: PullTypeResolutionContext, additionalResults?: PullAdditionalCallResolutionData): PullSymbol;
- private typeCheckInvocationExpression(callEx, context);
- private computeInvocationExpressionSymbol(callEx, context, additionalResults);
- public resolveObjectCreationExpression(callEx: ObjectCreationExpression, context: PullTypeResolutionContext, additionalResults?: PullAdditionalCallResolutionData): PullSymbol;
- private typeCheckObjectCreationExpression(callEx, context);
- private postOverloadResolutionDiagnostics(diagnostic, additionalResults, context);
- private computeObjectCreationExpressionSymbol(callEx, context, additionalResults);
- private instantiateSignatureInContext(signatureAToInstantiate, contextualSignatureB, context, shouldFixContextualSignatureParameterTypes);
- private resolveCastExpression(assertionExpression, context);
- private typeCheckCastExpression(assertionExpression, context, typeAssertionType);
- private resolveAssignmentExpression(binaryExpression, context);
- private getInstanceTypeForAssignment(lhs, type, context);
- public widenType(type: PullTypeSymbol, ast: AST, context: PullTypeResolutionContext): PullTypeSymbol;
- private widenArrayType(type, ast, context);
- private widenObjectLiteralType(type, ast, context);
- private needsToWidenObjectLiteralType(type, ast, context);
- public findBestCommonType(collection: IPullTypeCollection, context: PullTypeResolutionContext, comparisonInfo?: TypeComparisonInfo): PullTypeSymbol;
- private typeIsBestCommonTypeCandidate(candidateType, collection, context);
- private typesAreIdenticalInEnclosingTypes(t1, t2, context);
- private typesAreIdenticalWithNewEnclosingTypes(t1, t2, context);
- public typesAreIdentical(t1: PullTypeSymbol, t2: PullTypeSymbol, context: PullTypeResolutionContext): boolean;
- private typesAreIdenticalWorker(t1, t2, context);
- private propertiesAreIdentical(propertySymbol1, propertySymbol2, context);
- private propertiesAreIdenticalWithNewEnclosingTypes(type1, type2, property1, property2, context);
- private signatureGroupsAreIdentical(sg1, sg2, context);
- private typeParametersAreIdentical(tp1, tp2, context);
- private typeParametersAreIdenticalWorker(tp1, tp2, context);
- private setTypeParameterIdentity(tp1, tp2, val);
- public signaturesAreIdenticalWithNewEnclosingTypes(s1: PullSignatureSymbol, s2: PullSignatureSymbol, context: PullTypeResolutionContext, includingReturnType?: boolean): boolean;
- private signaturesAreIdentical(s1, s2, context, includingReturnType?);
- public signaturesAreIdenticalWorker(s1: PullSignatureSymbol, s2: PullSignatureSymbol, context: PullTypeResolutionContext, includingReturnType?: boolean): boolean;
- private signatureTypeParametersParametersAndReturnTypesAreIdentical(s1, s2, context, includingReturnType?);
- public signatureReturnTypesAreIdentical(s1: PullSignatureSymbol, s2: PullSignatureSymbol, context: PullTypeResolutionContext): boolean;
- private symbolsShareDeclaration(symbol1, symbol2);
- private sourceIsSubtypeOfTarget(source, target, ast, context, comparisonInfo?, isComparingInstantiatedSignatures?);
- private sourceMembersAreAssignableToTargetMembers(source, target, ast, context, comparisonInfo, isComparingInstantiatedSignatures?);
- private sourcePropertyIsAssignableToTargetProperty(source, target, sourceProp, targetProp, ast, context, comparisonInfo, isComparingInstantiatedSignatures?);
- private sourceCallSignaturesAreAssignableToTargetCallSignatures(source, target, ast, context, comparisonInfo, isComparingInstantiatedSignatures?);
- private sourceConstructSignaturesAreAssignableToTargetConstructSignatures(source, target, ast, context, comparisonInfo, isComparingInstantiatedSignatures?);
- private sourceIndexSignaturesAreAssignableToTargetIndexSignatures(source, target, ast, context, comparisonInfo, isComparingInstantiatedSignatures?);
- private typeIsAssignableToFunction(source, ast, context);
- private signatureIsAssignableToTarget(s1, s2, ast, context, comparisonInfo?, isComparingInstantiatedSignatures?);
- private sourceIsAssignableToTarget(source, target, ast, context, comparisonInfo?, isComparingInstantiatedSignatures?);
- private sourceIsAssignableToTargetWithNewEnclosingTypes(source, target, ast, context, comparisonInfo?, isComparingInstantiatedSignatures?);
- private getSymbolForRelationshipCheck(symbol);
- private sourceIsRelatableToTargetInEnclosingTypes(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private sourceIsRelatableToTargetWithNewEnclosingTypes(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private sourceIsRelatableToTargetInCache(source, target, comparisonCache, comparisonInfo);
- private sourceIsRelatableToTarget(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private isSourceTypeParameterConstrainedToTargetTypeParameter(source, target);
- private sourceIsRelatableToTargetWorker(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private sourceMembersAreRelatableToTargetMembers(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private infinitelyExpandingSourceTypeIsRelatableToTargetType(sourceType, targetType, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private infinitelyExpandingTypesAreIdentical(sourceType, targetType, context);
- private sourcePropertyIsRelatableToTargetProperty(source, target, sourceProp, targetProp, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private sourceCallSignaturesAreRelatableToTargetCallSignatures(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private sourceConstructSignaturesAreRelatableToTargetConstructSignatures(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private sourceIndexSignaturesAreRelatableToTargetIndexSignatures(source, target, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private signatureGroupIsRelatableToTarget(source, target, sourceSG, targetSG, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private signatureIsRelatableToTarget(sourceSig, targetSig, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private signatureIsRelatableToTargetWorker(sourceSig, targetSig, assignableTo, comparisonCache, ast, context, comparisonInfo, isComparingInstantiatedSignatures);
- private resolveOverloads(application, group, haveTypeArgumentsAtCallSite, context, diagnostics);
- private getCallTargetErrorSpanAST(callEx);
- private overloadHasCorrectArity(signature, args);
- private overloadIsApplicable(signature, args, context, comparisonInfo);
- private overloadIsApplicableForArgument(paramType, arg, argIndex, context, comparisonInfo);
- private overloadIsApplicableForAnyFunctionExpressionArgument(paramType, arg, typeParameters, parameters, returnTypeAnnotation, block, bodyExpression, argIndex, context, comparisonInfo);
- private overloadIsApplicableForObjectLiteralArgument(paramType, arg, argIndex, context, comparisonInfo);
- private overloadIsApplicableForArrayLiteralArgument(paramType, arg, argIndex, context, comparisonInfo);
- private overloadIsApplicableForOtherArgument(paramType, arg, argIndex, context, comparisonInfo);
- private overloadIsApplicableForArgumentHelper(paramType, argSym, argumentIndex, comparisonInfo, arg, context);
- private inferArgumentTypesForSignature(argContext, comparisonInfo, context);
- private typeParametersAreInScopeAtArgumentList(typeParameters, args);
- private relateTypeToTypeParametersInEnclosingType(expressionType, parameterType, argContext, context);
- public relateTypeToTypeParametersWithNewEnclosingTypes(expressionType: PullTypeSymbol, parameterType: PullTypeSymbol, argContext: TypeArgumentInferenceContext, context: PullTypeResolutionContext): void;
- public relateTypeToTypeParameters(expressionType: PullTypeSymbol, parameterType: PullTypeSymbol, argContext: TypeArgumentInferenceContext, context: PullTypeResolutionContext): void;
- private relateTypeArgumentsOfTypeToTypeParameters(expressionType, parameterType, argContext, context);
- private relateInifinitelyExpandingTypeToTypeParameters(expressionType, parameterType, argContext, context);
- private relateFunctionSignatureToTypeParameters(expressionSignature, parameterSignature, argContext, context);
- private relateObjectTypeToTypeParameters(objectType, parameterType, argContext, context);
- private relateSignatureGroupToTypeParameters(argumentSignatures, parameterSignatures, signatureKind, argContext, context);
- private alterPotentialGenericFunctionTypeToInstantiatedFunctionTypeForTypeArgumentInference(expressionSymbol, context);
- private isFunctionTypeWithExactlyOneCallSignatureAndNoOtherMembers(type, callSignatureShouldBeGeneric);
- public instantiateTypeToAny(typeToSpecialize: PullTypeSymbol, context: PullTypeResolutionContext): PullTypeSymbol;
- public instantiateSignatureToAny(signature: PullSignatureSymbol): PullSignatureSymbol;
- static globalTypeCheckPhase: number;
- static typeCheck(compilationSettings: ImmutableCompilationSettings, semanticInfoChain: SemanticInfoChain, document: Document): void;
- private validateVariableDeclarationGroups(enclosingDecl, context);
- private typeCheckFunctionOverloads(funcDecl, context, signature?, allSignatures?);
- private checkSymbolPrivacy(declSymbol, symbol, privacyErrorReporter);
- private checkTypePrivacyOfSignatures(declSymbol, signatures, privacyErrorReporter);
- private typeParameterOfTypeDeclarationPrivacyErrorReporter(classOrInterface, typeParameterAST, typeParameter, symbol, context);
- private baseListPrivacyErrorReporter(classOrInterface, declSymbol, baseAst, isExtendedType, symbol, context);
- private variablePrivacyErrorReporter(declAST, declSymbol, symbol, context);
- private checkFunctionTypePrivacy(funcDeclAST, isStatic, typeParameters, parameters, returnTypeAnnotation, block, context);
- private functionTypeArgumentArgumentTypePrivacyErrorReporter(declAST, isStatic, typeParameterAST, typeParameter, symbol, context);
- private functionArgumentTypePrivacyErrorReporter(declAST, isStatic, parameters, argIndex, paramSymbol, symbol, context);
- private functionReturnTypePrivacyErrorReporter(declAST, isStatic, returnTypeAnnotation, block, funcReturnType, symbol, context);
- private enclosingClassIsDerived(classDecl);
- private isSuperInvocationExpression(ast);
- private isSuperInvocationExpressionStatement(node);
- private getFirstStatementOfBlockOrNull(block);
- private superCallMustBeFirstStatementInConstructor(constructorDecl);
- private checkForThisCaptureInArrowFunction(expression);
- private typeCheckMembersAgainstIndexer(containerType, containerTypeDecl, context);
- private determineRelevantIndexerForMember(member, numberIndexSignature, stringIndexSignature);
- private reportErrorThatMemberIsNotSubtypeOfIndexer(member, indexSignature, astForError, context, comparisonInfo);
- private typeCheckIfTypeMemberPropertyOkToOverride(typeSymbol, extendedType, typeMember, extendedTypeMember, enclosingDecl, comparisonInfo);
- private typeCheckIfTypeExtendsType(classOrInterface, name, typeSymbol, extendedType, enclosingDecl, context);
- private typeCheckIfClassImplementsType(classDecl, classSymbol, implementedType, enclosingDecl, context);
- private computeValueSymbolFromAST(valueDeclAST, context);
- private hasClassTypeSymbolConflictAsValue(baseDeclAST, typeSymbol, enclosingDecl, context);
- private typeCheckBase(classOrInterface, name, typeSymbol, baseDeclAST, isExtendedType, enclosingDecl, context);
- private typeCheckBases(classOrInterface, name, heritageClauses, typeSymbol, enclosingDecl, context);
- private checkTypeCompatibilityBetweenBases(name, typeSymbol, context);
- private checkNamedPropertyIdentityBetweenBases(interfaceName, interfaceSymbol, baseTypeSymbol, inheritedMembersMap, context);
- private checkIndexSignatureIdentityBetweenBases(interfaceName, interfaceSymbol, baseTypeSymbol, allInheritedSignatures, derivedTypeHasOwnNumberSignature, derivedTypeHasOwnStringSignature, context);
- private checkInheritedMembersAgainstInheritedIndexSignatures(interfaceName, interfaceSymbol, inheritedIndexSignatures, inheritedMembers, context);
- private checkThatInheritedNumberSignatureIsSubtypeOfInheritedStringSignature(interfaceName, interfaceSymbol, inheritedIndexSignatures, context);
- private checkAssignability(ast, source, target, context);
- private isReference(ast, astSymbol);
- private checkForSuperMemberAccess(expression, name, resolvedName, context);
- private getEnclosingDeclForAST(ast);
- private getEnclosingSymbolForAST(ast);
- private checkForPrivateMemberAccess(name, expressionType, resolvedName, context);
- public instantiateType(type: PullTypeSymbol, typeParameterArgumentMap: TypeArgumentMap): PullTypeSymbol;
- public instantiateTypeParameter(typeParameter: PullTypeParameterSymbol, typeParameterArgumentMap: TypeArgumentMap): PullTypeParameterSymbol;
- public instantiateSignature(signature: PullSignatureSymbol, typeParameterArgumentMap: TypeArgumentMap): PullSignatureSymbol;
- }
- class TypeComparisonInfo {
- public onlyCaptureFirstError: boolean;
- public flags: TypeRelationshipFlags;
- public message: string;
- public stringConstantVal: AST;
- private indent;
- constructor(sourceComparisonInfo?: TypeComparisonInfo, useSameIndent?: boolean);
- private indentString();
- public addMessage(message: string): void;
- }
- function getPropertyAssignmentNameTextFromIdentifier(identifier: AST): {
- actualText: string;
- memberName: string;
- };
- function isTypesOnlyLocation(ast: AST): boolean;
-}
-declare module TypeScript {
- var declCacheHit: number;
- var declCacheMiss: number;
- var symbolCacheHit: number;
- var symbolCacheMiss: number;
- class SemanticInfoChain {
- private compiler;
- private logger;
- private documents;
- private fileNameToDocument;
- public anyTypeDecl: PullDecl;
- public booleanTypeDecl: PullDecl;
- public numberTypeDecl: PullDecl;
- public stringTypeDecl: PullDecl;
- public nullTypeDecl: PullDecl;
- public undefinedTypeDecl: PullDecl;
- public voidTypeDecl: PullDecl;
- public undefinedValueDecl: PullDecl;
- public anyTypeSymbol: PullPrimitiveTypeSymbol;
- public booleanTypeSymbol: PullPrimitiveTypeSymbol;
- public numberTypeSymbol: PullPrimitiveTypeSymbol;
- public stringTypeSymbol: PullPrimitiveTypeSymbol;
- public nullTypeSymbol: PullPrimitiveTypeSymbol;
- public undefinedTypeSymbol: PullPrimitiveTypeSymbol;
- public voidTypeSymbol: PullPrimitiveTypeSymbol;
- public undefinedValueSymbol: PullSymbol;
- public emptyTypeSymbol: PullTypeSymbol;
- private astSymbolMap;
- private astAliasSymbolMap;
- private astCallResolutionDataMap;
- private declSymbolMap;
- private declSignatureSymbolMap;
- private declCache;
- private symbolCache;
- private fileNameToDiagnostics;
- private _binder;
- private _resolver;
- private _topLevelDecls;
- private _fileNames;
- constructor(compiler: TypeScriptCompiler, logger: ILogger);
- public getDocument(fileName: string): Document;
- public lineMap(fileName: string): LineMap;
- public fileNames(): string[];
- private bindPrimitiveSymbol<TSymbol extends PullSymbol>(decl, newSymbol);
- private addPrimitiveTypeSymbol(decl);
- private addPrimitiveValueSymbol(decl, type);
- private resetGlobalSymbols();
- public addDocument(document: Document): void;
- public removeDocument(fileName: string): void;
- private getDeclPathCacheID(declPath, declKind);
- public findTopLevelSymbol(name: string, kind: PullElementKind, doNotGoPastThisDecl: PullDecl): PullSymbol;
- private findTopLevelSymbolInDecl(topLevelDecl, name, kind, doNotGoPastThisDecl);
- public findExternalModule(id: string): PullContainerSymbol;
- public findAmbientExternalModuleInGlobalContext(id: string): PullContainerSymbol;
- public findDecls(declPath: string[], declKind: PullElementKind): PullDecl[];
- public findDeclsFromPath(declPath: PullDecl[], declKind: PullElementKind): PullDecl[];
- public findSymbol(declPath: string[], declType: PullElementKind): PullSymbol;
- public cacheGlobalSymbol(symbol: PullSymbol, kind: PullElementKind): void;
- public invalidate(oldSettings?: ImmutableCompilationSettings, newSettings?: ImmutableCompilationSettings): void;
- private settingsChangeAffectsSyntax(before, after);
- public setSymbolForAST(ast: AST, symbol: PullSymbol): void;
- public getSymbolForAST(ast: AST): PullSymbol;
- public setAliasSymbolForAST(ast: AST, symbol: PullTypeAliasSymbol): void;
- public getAliasSymbolForAST(ast: AST): PullTypeAliasSymbol;
- public getCallResolutionDataForAST(ast: AST): PullAdditionalCallResolutionData;
- public setCallResolutionDataForAST(ast: AST, callResolutionData: PullAdditionalCallResolutionData): void;
- public setSymbolForDecl(decl: PullDecl, symbol: PullSymbol): void;
- public getSymbolForDecl(decl: PullDecl): PullSymbol;
- public setSignatureSymbolForDecl(decl: PullDecl, signatureSymbol: PullSignatureSymbol): void;
- public getSignatureSymbolForDecl(decl: PullDecl): PullSignatureSymbol;
- public addDiagnostic(diagnostic: Diagnostic): void;
- public getDiagnostics(fileName: string): Diagnostic[];
- public getBinder(): PullSymbolBinder;
- public getResolver(): PullTypeResolver;
- public addSyntheticIndexSignature(containingDecl: PullDecl, containingSymbol: PullTypeSymbol, ast: AST, indexParamName: string, indexParamType: PullTypeSymbol, returnType: PullTypeSymbol): void;
- public getDeclForAST(ast: AST): PullDecl;
- public getEnclosingDecl(ast: AST): PullDecl;
- public setDeclForAST(ast: AST, decl: PullDecl): void;
- public getASTForDecl(decl: PullDecl): AST;
- public setASTForDecl(decl: PullDecl, ast: AST): void;
- public topLevelDecl(fileName: string): PullDecl;
- public topLevelDecls(): PullDecl[];
- public addDiagnosticFromAST(ast: AST, diagnosticKey: string, _arguments?: any[], additionalLocations?: Location[]): void;
- public diagnosticFromAST(ast: AST, diagnosticKey: string, _arguments?: any[], additionalLocations?: Location[]): Diagnostic;
- public locationFromAST(ast: AST): Location;
- public duplicateIdentifierDiagnosticFromAST(ast: AST, identifier: string, additionalLocationAST: AST): Diagnostic;
- public addDuplicateIdentifierDiagnosticFromAST(ast: AST, identifier: string, additionalLocationAST: AST): void;
- }
-}
-declare module TypeScript {
- module DeclarationCreator {
- function create(document: Document, semanticInfoChain: SemanticInfoChain, compilationSettings: ImmutableCompilationSettings): PullDecl;
- }
-}
-declare module TypeScript {
- class PullSymbolBinder {
- private semanticInfoChain;
- private declsBeingBound;
- private inBindingOtherDeclsWalker;
- constructor(semanticInfoChain: SemanticInfoChain);
- private getParent(decl, returnInstanceType?);
- private findDeclsInContext(startingDecl, declKind, searchGlobally);
- private getExistingSymbol(decl, searchKind, parent);
- private checkThatExportsMatch(decl, prevSymbol, reportError?);
- private getIndexForInsertingSignatureAtEndOfEnclosingDeclInSignatureList(signature, currentSignatures);
- private bindEnumDeclarationToPullSymbol(enumContainerDecl);
- private bindEnumIndexerDeclsToPullSymbols(enumContainerSymbol);
- private findExistingVariableSymbolForModuleValueDecl(decl);
- private bindModuleDeclarationToPullSymbol(moduleContainerDecl);
- private bindImportDeclaration(importDeclaration);
- private ensurePriorDeclarationsAreBound(container, currentDecl);
- private bindClassDeclarationToPullSymbol(classDecl);
- private bindInterfaceDeclarationToPullSymbol(interfaceDecl);
- private bindObjectTypeDeclarationToPullSymbol(objectDecl);
- private bindConstructorTypeDeclarationToPullSymbol(constructorTypeDeclaration);
- private bindVariableDeclarationToPullSymbol(variableDeclaration);
- private bindCatchVariableToPullSymbol(variableDeclaration);
- private bindEnumMemberDeclarationToPullSymbol(propertyDeclaration);
- private bindPropertyDeclarationToPullSymbol(propertyDeclaration);
- private bindParameterSymbols(functionDeclaration, parameterList, funcType, signatureSymbol);
- private bindFunctionDeclarationToPullSymbol(functionDeclaration);
- private bindFunctionExpressionToPullSymbol(functionExpressionDeclaration);
- private bindFunctionTypeDeclarationToPullSymbol(functionTypeDeclaration);
- private bindMethodDeclarationToPullSymbol(methodDeclaration);
- private bindStaticPrototypePropertyOfClass(classAST, classTypeSymbol, constructorTypeSymbol);
- private bindConstructorDeclarationToPullSymbol(constructorDeclaration);
- private bindConstructSignatureDeclarationToPullSymbol(constructSignatureDeclaration);
- private bindCallSignatureDeclarationToPullSymbol(callSignatureDeclaration);
- private bindIndexSignatureDeclarationToPullSymbol(indexSignatureDeclaration);
- private bindGetAccessorDeclarationToPullSymbol(getAccessorDeclaration);
- private bindSetAccessorDeclarationToPullSymbol(setAccessorDeclaration);
- private getDeclsToBind(decl);
- private shouldBindDeclaration(decl);
- public bindDeclToPullSymbol(decl: PullDecl): void;
- private bindAllDeclsToPullSymbol(askedDecl);
- private bindSingleDeclToPullSymbol(decl);
- }
-}
-declare module TypeScript {
- module PullHelpers {
- function diagnosticFromDecl(decl: PullDecl, diagnosticKey: string, _arguments?: any[], additionalLocations?: Location[]): Diagnostic;
- function resolveDeclaredSymbolToUseType(symbol: PullSymbol): void;
- interface SignatureInfoForFuncDecl {
- signature: PullSignatureSymbol;
- allSignatures: PullSignatureSymbol[];
- }
- function getSignatureForFuncDecl(functionDecl: PullDecl): {
- signature: PullSignatureSymbol;
- allSignatures: PullSignatureSymbol[];
- };
- function getAccessorSymbol(getterOrSetter: AST, semanticInfoChain: SemanticInfoChain): PullAccessorSymbol;
- function getGetterAndSetterFunction(funcDecl: AST, semanticInfoChain: SemanticInfoChain): {
- getter: GetAccessor;
- setter: SetAccessor;
- };
- function symbolIsEnum(source: PullSymbol): boolean;
- function symbolIsModule(symbol: PullSymbol): boolean;
- function isNameNumeric(name: string): boolean;
- function typeSymbolsAreIdentical(a: PullTypeSymbol, b: PullTypeSymbol): boolean;
- function getRootType(type: PullTypeSymbol): PullTypeSymbol;
- function isSymbolLocal(symbol: PullSymbol): boolean;
- function isExportedSymbolInClodule(symbol: PullSymbol): boolean;
- function isSymbolDeclaredInScopeChain(symbol: PullSymbol, scopeSymbol: PullSymbol): boolean;
- interface PullTypeSymbolStructureWalker {
- memberSymbolWalk(memberSymbol: PullSymbol): boolean;
- callSignatureWalk(signatureSymbol: PullSignatureSymbol): boolean;
- constructSignatureWalk(signatureSymbol: PullSignatureSymbol): boolean;
- indexSignatureWalk(signatureSymbol: PullSignatureSymbol): boolean;
- signatureParameterWalk(parameterSymbol: PullSymbol): boolean;
- signatureReturnTypeWalk(returnType: PullTypeSymbol): boolean;
- }
- function walkPullTypeSymbolStructure(typeSymbol: PullTypeSymbol, walker: PullTypeSymbolStructureWalker): void;
- class OtherPullDeclsWalker {
- private currentlyWalkingOtherDecls;
- public walkOtherPullDecls(currentDecl: PullDecl, otherDecls: PullDecl[], callBack: (otherDecl: PullDecl) => void): void;
- }
- }
-}
-declare module TypeScript {
- class WrapsTypeParameterCache {
- private _wrapsTypeParameterCache;
- public getWrapsTypeParameter(typeParameterArgumentMap: TypeArgumentMap): number;
- public setWrapsTypeParameter(typeParameterArgumentMap: TypeArgumentMap, wrappingTypeParameterID: number): void;
- }
- module PullInstantiationHelpers {
- class MutableTypeArgumentMap {
- public typeParameterArgumentMap: TypeArgumentMap;
- public createdDuplicateTypeArgumentMap: boolean;
- constructor(typeParameterArgumentMap: TypeArgumentMap);
- public ensureTypeArgumentCopy(): void;
- }
- function instantiateTypeArgument(resolver: PullTypeResolver, symbol: InstantiableSymbol, mutableTypeParameterMap: MutableTypeArgumentMap): void;
- function cleanUpTypeArgumentMap(symbol: InstantiableSymbol, mutableTypeArgumentMap: MutableTypeArgumentMap): void;
- function getAllowedToReferenceTypeParametersFromDecl(decl: PullDecl): PullTypeParameterSymbol[];
- function createTypeParameterArgumentMap(typeParameters: PullTypeParameterSymbol[], typeArguments: PullTypeSymbol[]): TypeArgumentMap;
- function updateTypeParameterArgumentMap(typeParameters: PullTypeParameterSymbol[], typeArguments: PullTypeSymbol[], typeParameterArgumentMap: TypeArgumentMap): TypeArgumentMap;
- function updateMutableTypeParameterArgumentMap(typeParameters: PullTypeParameterSymbol[], typeArguments: PullTypeSymbol[], mutableMap: MutableTypeArgumentMap): void;
- function twoTypesAreInstantiationsOfSameNamedGenericType(type1: PullTypeSymbol, type2: PullTypeSymbol): boolean;
- }
-}
-declare module TypeScript {
- var fileResolutionTime: number;
- var fileResolutionIOTime: number;
- var fileResolutionScanImportsTime: number;
- var fileResolutionImportFileSearchTime: number;
- var fileResolutionGetDefaultLibraryTime: number;
- var sourceCharactersCompiled: number;
- var syntaxTreeParseTime: number;
- var syntaxDiagnosticsTime: number;
- var astTranslationTime: number;
- var typeCheckTime: number;
- var compilerResolvePathTime: number;
- var compilerDirectoryNameTime: number;
- var compilerDirectoryExistsTime: number;
- var compilerFileExistsTime: number;
- var emitTime: number;
- var emitWriteFileTime: number;
- var declarationEmitTime: number;
- var declarationEmitIsExternallyVisibleTime: number;
- var declarationEmitTypeSignatureTime: number;
- var declarationEmitGetBoundDeclTypeTime: number;
- var declarationEmitIsOverloadedCallSignatureTime: number;
- var declarationEmitFunctionDeclarationGetSymbolTime: number;
- var declarationEmitGetBaseTypeTime: number;
- var declarationEmitGetAccessorFunctionTime: number;
- var declarationEmitGetTypeParameterSymbolTime: number;
- var declarationEmitGetImportDeclarationSymbolTime: number;
- var ioHostResolvePathTime: number;
- var ioHostDirectoryNameTime: number;
- var ioHostCreateDirectoryStructureTime: number;
- var ioHostWriteFileTime: number;
- interface PullSymbolInfo {
- symbol: PullSymbol;
- aliasSymbol: PullTypeAliasSymbol;
- ast: AST;
- enclosingScopeSymbol: PullSymbol;
- }
- interface PullCallSymbolInfo {
- targetSymbol: PullSymbol;
- resolvedSignatures: PullSignatureSymbol[];
- candidateSignature: PullSignatureSymbol;
- isConstructorCall: boolean;
- ast: AST;
- enclosingScopeSymbol: PullSymbol;
- }
- interface PullVisibleSymbolsInfo {
- symbols: PullSymbol[];
- enclosingScopeSymbol: PullSymbol;
- }
- enum EmitOutputResult {
- Succeeded = 0,
- FailedBecauseOfSyntaxErrors = 1,
- FailedBecauseOfCompilerOptionsErrors = 2,
- FailedToGenerateDeclarationsBecauseOfSemanticErrors = 3,
- }
- class EmitOutput {
- public outputFiles: OutputFile[];
- public emitOutputResult: EmitOutputResult;
- constructor(emitOutputResult?: EmitOutputResult);
- }
- enum OutputFileType {
- JavaScript = 0,
- SourceMap = 1,
- Declaration = 2,
- }
- class OutputFile {
- public name: string;
- public writeByteOrderMark: boolean;
- public text: string;
- public fileType: OutputFileType;
- public sourceMapEntries: SourceMapEntry[];
- constructor(name: string, writeByteOrderMark: boolean, text: string, fileType: OutputFileType, sourceMapEntries?: SourceMapEntry[]);
- }
- class CompileResult {
- public diagnostics: Diagnostic[];
- public outputFiles: OutputFile[];
- static fromDiagnostics(diagnostics: Diagnostic[]): CompileResult;
- static fromOutputFiles(outputFiles: OutputFile[]): CompileResult;
- }
- class TypeScriptCompiler {
- public logger: ILogger;
- private _settings;
- private semanticInfoChain;
- constructor(logger?: ILogger, _settings?: ImmutableCompilationSettings);
- public compilationSettings(): ImmutableCompilationSettings;
- public setCompilationSettings(newSettings: ImmutableCompilationSettings): void;
- public getDocument(fileName: string): Document;
- public cleanupSemanticCache(): void;
- public addFile(fileName: string, scriptSnapshot: IScriptSnapshot, byteOrderMark: ByteOrderMark, version: number, isOpen: boolean, referencedFiles?: string[]): void;
- public updateFile(fileName: string, scriptSnapshot: IScriptSnapshot, version: number, isOpen: boolean, textChangeRange: TextChangeRange): void;
- public removeFile(fileName: string): void;
- public mapOutputFileName(document: Document, emitOptions: EmitOptions, extensionChanger: (fname: string, wholeFileNameReplaced: boolean) => string): string;
- private writeByteOrderMarkForDocument(document);
- static mapToDTSFileName(fileName: string, wholeFileNameReplaced: boolean): string;
- public _shouldEmit(document: Document): boolean;
- public _shouldEmitDeclarations(document: Document): boolean;
- private emitDocumentDeclarationsWorker(document, emitOptions, declarationEmitter?);
- public _emitDocumentDeclarations(document: Document, emitOptions: EmitOptions, onSingleFileEmitComplete: (files: OutputFile) => void, sharedEmitter: DeclarationEmitter): DeclarationEmitter;
- public emitAllDeclarations(resolvePath: (path: string) => string): EmitOutput;
- public emitDeclarations(fileName: string, resolvePath: (path: string) => string): EmitOutput;
- public canEmitDeclarations(fileName: string): boolean;
- static mapToFileNameExtension(extension: string, fileName: string, wholeFileNameReplaced: boolean): string;
- static mapToJSFileName(fileName: string, wholeFileNameReplaced: boolean): string;
- private emitDocumentWorker(document, emitOptions, emitter?);
- public _emitDocument(document: Document, emitOptions: EmitOptions, onSingleFileEmitComplete: (files: OutputFile[]) => void, sharedEmitter: Emitter): Emitter;
- public emitAll(resolvePath: (path: string) => string): EmitOutput;
- public emit(fileName: string, resolvePath: (path: string) => string): EmitOutput;
- public compile(resolvePath: (path: string) => string, continueOnDiagnostics?: boolean): Iterator<CompileResult>;
- public getSyntacticDiagnostics(fileName: string): Diagnostic[];
- private getSyntaxTree(fileName);
- private getSourceUnit(fileName);
- public getSemanticDiagnostics(fileName: string): Diagnostic[];
- public getCompilerOptionsDiagnostics(resolvePath: (path: string) => string): Diagnostic[];
- public resolveAllFiles(): void;
- public getSymbolOfDeclaration(decl: PullDecl): PullSymbol;
- private extractResolutionContextFromAST(resolver, ast, document, propagateContextualTypes);
- private extractResolutionContextForVariable(inContextuallyTypedAssignment, propagateContextualTypes, resolver, resolutionContext, enclosingDecl, assigningAST, init);
- private getASTPath(ast);
- public pullGetSymbolInformationFromAST(ast: AST, document: Document): PullSymbolInfo;
- public pullGetCallInformationFromAST(ast: AST, document: Document): PullCallSymbolInfo;
- public pullGetVisibleMemberSymbolsFromAST(ast: AST, document: Document): PullVisibleSymbolsInfo;
- public pullGetVisibleDeclsFromAST(ast: AST, document: Document): PullDecl[];
- public pullGetContextualMembersFromAST(ast: AST, document: Document): PullVisibleSymbolsInfo;
- public pullGetDeclInformation(decl: PullDecl, ast: AST, document: Document): PullSymbolInfo;
- public topLevelDeclaration(fileName: string): PullDecl;
- public getDeclForAST(ast: AST): PullDecl;
- public fileNames(): string[];
- public topLevelDecl(fileName: string): PullDecl;
- private static getLocationText(location, resolvePath);
- static getFullDiagnosticText(diagnostic: Diagnostic, resolvePath: (path: string) => string): string;
- }
- function compareDataObjects(dst: any, src: any): boolean;
-}
-declare module TypeScript {
- enum GenerativeTypeClassification {
- Unknown = 0,
- Open = 1,
- Closed = 2,
- InfinitelyExpanding = 3,
- }
- interface TypeArgumentMap {
- [n: number]: PullTypeSymbol;
- }
- class PullTypeReferenceSymbol extends PullTypeSymbol {
- public referencedTypeSymbol: PullTypeSymbol;
- static createTypeReference(type: PullTypeSymbol): PullTypeReferenceSymbol;
- constructor(referencedTypeSymbol: PullTypeSymbol);
- public isTypeReference(): boolean;
- public isResolved: boolean;
- public setResolved(): void;
- public setUnresolved(): void;
- public invalidate(): void;
- public ensureReferencedTypeIsResolved(): void;
- public getReferencedTypeSymbol(): PullTypeSymbol;
- public _getResolver(): PullTypeResolver;
- public hasMembers(): boolean;
- public setAssociatedContainerType(type: PullTypeSymbol): void;
- public getAssociatedContainerType(): PullTypeSymbol;
- public getFunctionSymbol(): PullSymbol;
- public setFunctionSymbol(symbol: PullSymbol): void;
- public addContainedNonMember(nonMember: PullSymbol): void;
- public findContainedNonMemberContainer(containerName: string, kind?: PullElementKind): PullTypeSymbol;
- public addMember(memberSymbol: PullSymbol): void;
- public addEnclosedMemberType(enclosedType: PullTypeSymbol): void;
- public addEnclosedMemberContainer(enclosedContainer: PullTypeSymbol): void;
- public addEnclosedNonMember(enclosedNonMember: PullSymbol): void;
- public addEnclosedNonMemberType(enclosedNonMemberType: PullTypeSymbol): void;
- public addEnclosedNonMemberContainer(enclosedNonMemberContainer: PullTypeSymbol): void;
- public addTypeParameter(typeParameter: PullTypeParameterSymbol): void;
- public addConstructorTypeParameter(typeParameter: PullTypeParameterSymbol): void;
- public findContainedNonMember(name: string): PullSymbol;
- public findContainedNonMemberType(typeName: string, kind?: PullElementKind): PullTypeSymbol;
- public getMembers(): PullSymbol[];
- public setHasDefaultConstructor(hasOne?: boolean): void;
- public getHasDefaultConstructor(): boolean;
- public getConstructorMethod(): PullSymbol;
- public setConstructorMethod(constructorMethod: PullSymbol): void;
- public getTypeParameters(): PullTypeParameterSymbol[];
- public isGeneric(): boolean;
- public addSpecialization(specializedVersionOfThisType: PullTypeSymbol, substitutingTypes: PullTypeSymbol[]): void;
- public getSpecialization(substitutingTypes: PullTypeSymbol[]): PullTypeSymbol;
- public getKnownSpecializations(): PullTypeSymbol[];
- public getTypeArguments(): PullTypeSymbol[];
- public getTypeArgumentsOrTypeParameters(): PullTypeSymbol[];
- public appendCallSignature(callSignature: PullSignatureSymbol): void;
- public insertCallSignatureAtIndex(callSignature: PullSignatureSymbol, index: number): void;
- public appendConstructSignature(callSignature: PullSignatureSymbol): void;
- public insertConstructSignatureAtIndex(callSignature: PullSignatureSymbol, index: number): void;
- public addIndexSignature(indexSignature: PullSignatureSymbol): void;
- public hasOwnCallSignatures(): boolean;
- public getCallSignatures(): PullSignatureSymbol[];
- public hasOwnConstructSignatures(): boolean;
- public getConstructSignatures(): PullSignatureSymbol[];
- public hasOwnIndexSignatures(): boolean;
- public getIndexSignatures(): PullSignatureSymbol[];
- public addImplementedType(implementedType: PullTypeSymbol): void;
- public getImplementedTypes(): PullTypeSymbol[];
- public addExtendedType(extendedType: PullTypeSymbol): void;
- public getExtendedTypes(): PullTypeSymbol[];
- public addTypeThatExtendsThisType(type: PullTypeSymbol): void;
- public getTypesThatExtendThisType(): PullTypeSymbol[];
- public addTypeThatExplicitlyImplementsThisType(type: PullTypeSymbol): void;
- public getTypesThatExplicitlyImplementThisType(): PullTypeSymbol[];
- public isValidBaseKind(baseType: PullTypeSymbol, isExtendedType: boolean): boolean;
- public findMember(name: string, lookInParent?: boolean): PullSymbol;
- public findNestedType(name: string, kind?: PullElementKind): PullTypeSymbol;
- public findNestedContainer(name: string, kind?: PullElementKind): PullTypeSymbol;
- public getAllMembers(searchDeclKind: PullElementKind, memberVisiblity: GetAllMembersVisiblity): PullSymbol[];
- public findTypeParameter(name: string): PullTypeParameterSymbol;
- public hasOnlyOverloadCallSignatures(): boolean;
- }
- var nSpecializationsCreated: number;
- var nSpecializedSignaturesCreated: number;
- var nSpecializedTypeParameterCreated: number;
- class PullInstantiatedTypeReferenceSymbol extends PullTypeReferenceSymbol {
- public referencedTypeSymbol: PullTypeSymbol;
- private _typeParameterArgumentMap;
- public isInstanceReferenceType: boolean;
- private _instantiatedMembers;
- private _allInstantiatedMemberNameCache;
- private _instantiatedMemberNameCache;
- private _instantiatedCallSignatures;
- private _instantiatedConstructSignatures;
- private _instantiatedIndexSignatures;
- private _typeArgumentReferences;
- private _instantiatedConstructorMethod;
- private _instantiatedAssociatedContainerType;
- private _isArray;
- public getIsSpecialized(): boolean;
- private _generativeTypeClassification;
- public getGenerativeTypeClassification(enclosingType: PullTypeSymbol): GenerativeTypeClassification;
- public isArrayNamedTypeReference(): boolean;
- public getElementType(): PullTypeSymbol;
- public getReferencedTypeSymbol(): PullTypeSymbol;
- static create(resolver: PullTypeResolver, type: PullTypeSymbol, typeParameterArgumentMap: TypeArgumentMap): PullInstantiatedTypeReferenceSymbol;
- constructor(referencedTypeSymbol: PullTypeSymbol, _typeParameterArgumentMap: TypeArgumentMap, isInstanceReferenceType: boolean);
- public isGeneric(): boolean;
- public getTypeParameterArgumentMap(): TypeArgumentMap;
- public getTypeArguments(): PullTypeSymbol[];
- public getTypeArgumentsOrTypeParameters(): PullTypeSymbol[];
- private populateInstantiatedMemberFromReferencedMember(referencedMember);
- public getMembers(): PullSymbol[];
- public findMember(name: string, lookInParent?: boolean): PullSymbol;
- public getAllMembers(searchDeclKind: PullElementKind, memberVisiblity: GetAllMembersVisiblity): PullSymbol[];
- public getConstructorMethod(): PullSymbol;
- public getAssociatedContainerType(): PullTypeSymbol;
- public getCallSignatures(): PullSignatureSymbol[];
- public getConstructSignatures(): PullSignatureSymbol[];
- public getIndexSignatures(): PullSignatureSymbol[];
- }
- class PullInstantiatedSignatureSymbol extends PullSignatureSymbol {
- private _typeParameterArgumentMap;
- public getTypeParameterArgumentMap(): TypeArgumentMap;
- constructor(rootSignature: PullSignatureSymbol, _typeParameterArgumentMap: TypeArgumentMap);
- public getIsSpecialized(): boolean;
- public _getResolver(): PullTypeResolver;
- public getTypeParameters(): PullTypeParameterSymbol[];
- public getAllowedToReferenceTypeParameters(): PullTypeParameterSymbol[];
- }
- class PullInstantiatedTypeParameterSymbol extends PullTypeParameterSymbol {
- constructor(rootTypeParameter: PullTypeSymbol, constraintType: PullTypeSymbol);
- public _getResolver(): PullTypeResolver;
- }
-}
-declare module TypeScript {
- class SyntaxTreeToAstVisitor implements ISyntaxVisitor {
- private fileName;
- public lineMap: LineMap;
- private compilationSettings;
- public position: number;
- public previousTokenTrailingComments: Comment[];
- constructor(fileName: string, lineMap: LineMap, compilationSettings: ImmutableCompilationSettings);
- static visit(syntaxTree: SyntaxTree, fileName: string, compilationSettings: ImmutableCompilationSettings, incrementalAST: boolean): SourceUnit;
- public movePast(element: ISyntaxElement): void;
- private moveTo(element1, element2);
- private setCommentsAndSpan(ast, fullStart, node);
- public createTokenSpan(fullStart: number, element: ISyntaxToken): ASTSpan;
- public setSpan(span: AST, fullStart: number, element: ISyntaxElement, firstToken?: ISyntaxToken, lastToken?: ISyntaxToken): void;
- public setSpanExplicit(span: IASTSpan, start: number, end: number): void;
- public visitSyntaxList(node: ISyntaxList): ISyntaxList2;
- public visitSeparatedSyntaxList(list: ISeparatedSyntaxList): ISeparatedSyntaxList2;
- private convertComment(trivia, commentStartPosition, hasTrailingNewLine);
- private convertComments(triviaList, commentStartPosition);
- private mergeComments(comments1, comments2);
- private convertTokenLeadingComments(token, commentStartPosition);
- private convertTokenTrailingComments(token, commentStartPosition);
- private convertNodeTrailingComments(node, lastToken, nodeStart);
- private visitIdentifier(token);
- public visitToken(token: ISyntaxToken): IASTToken;
- public visitTokenWorker(token: ISyntaxToken): IASTToken;
- public visitSourceUnit(node: SourceUnitSyntax): SourceUnit;
- public visitExternalModuleReference(node: ExternalModuleReferenceSyntax): ExternalModuleReference;
- public visitModuleNameModuleReference(node: ModuleNameModuleReferenceSyntax): ModuleNameModuleReference;
- public visitClassDeclaration(node: ClassDeclarationSyntax): ClassDeclaration;
- private visitModifiers(modifiers);
- public visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): InterfaceDeclaration;
- public visitHeritageClause(node: HeritageClauseSyntax): HeritageClause;
- public visitModuleDeclaration(node: ModuleDeclarationSyntax): ModuleDeclaration;
- public visitFunctionDeclaration(node: FunctionDeclarationSyntax): FunctionDeclaration;
- public visitEnumDeclaration(node: EnumDeclarationSyntax): EnumDeclaration;
- public visitEnumElement(node: EnumElementSyntax): EnumElement;
- public visitImportDeclaration(node: ImportDeclarationSyntax): ImportDeclaration;
- public visitExportAssignment(node: ExportAssignmentSyntax): ExportAssignment;
- public visitVariableStatement(node: VariableStatementSyntax): VariableStatement;
- public visitVariableDeclaration(node: VariableDeclarationSyntax): VariableDeclaration;
- public visitVariableDeclarator(node: VariableDeclaratorSyntax): VariableDeclarator;
- public visitEqualsValueClause(node: EqualsValueClauseSyntax): EqualsValueClause;
- public visitPrefixUnaryExpression(node: PrefixUnaryExpressionSyntax): PrefixUnaryExpression;
- public visitArrayLiteralExpression(node: ArrayLiteralExpressionSyntax): ArrayLiteralExpression;
- public visitOmittedExpression(node: OmittedExpressionSyntax): OmittedExpression;
- public visitParenthesizedExpression(node: ParenthesizedExpressionSyntax): ParenthesizedExpression;
- public visitSimpleArrowFunctionExpression(node: SimpleArrowFunctionExpressionSyntax): SimpleArrowFunctionExpression;
- public visitParenthesizedArrowFunctionExpression(node: ParenthesizedArrowFunctionExpressionSyntax): ParenthesizedArrowFunctionExpression;
- public visitType(type: ITypeSyntax): AST;
- public visitTypeQuery(node: TypeQuerySyntax): TypeQuery;
- public visitQualifiedName(node: QualifiedNameSyntax): QualifiedName;
- public visitTypeArgumentList(node: TypeArgumentListSyntax): TypeArgumentList;
- public visitConstructorType(node: ConstructorTypeSyntax): ConstructorType;
- public visitFunctionType(node: FunctionTypeSyntax): FunctionType;
- public visitObjectType(node: ObjectTypeSyntax): ObjectType;
- public visitArrayType(node: ArrayTypeSyntax): ArrayType;
- public visitGenericType(node: GenericTypeSyntax): GenericType;
- public visitTypeAnnotation(node: TypeAnnotationSyntax): TypeAnnotation;
- public visitBlock(node: BlockSyntax): Block;
- public visitParameter(node: ParameterSyntax): Parameter;
- public visitMemberAccessExpression(node: MemberAccessExpressionSyntax): MemberAccessExpression;
- public visitPostfixUnaryExpression(node: PostfixUnaryExpressionSyntax): PostfixUnaryExpression;
- public visitElementAccessExpression(node: ElementAccessExpressionSyntax): ElementAccessExpression;
- public visitInvocationExpression(node: InvocationExpressionSyntax): InvocationExpression;
- public visitArgumentList(node: ArgumentListSyntax): ArgumentList;
- public visitBinaryExpression(node: BinaryExpressionSyntax): BinaryExpression;
- public visitConditionalExpression(node: ConditionalExpressionSyntax): ConditionalExpression;
- public visitConstructSignature(node: ConstructSignatureSyntax): ConstructSignature;
- public visitMethodSignature(node: MethodSignatureSyntax): MethodSignature;
- public visitIndexSignature(node: IndexSignatureSyntax): IndexSignature;
- public visitPropertySignature(node: PropertySignatureSyntax): PropertySignature;
- public visitParameterList(node: ParameterListSyntax): ParameterList;
- public visitCallSignature(node: CallSignatureSyntax): CallSignature;
- public visitTypeParameterList(node: TypeParameterListSyntax): TypeParameterList;
- public visitTypeParameter(node: TypeParameterSyntax): TypeParameter;
- public visitConstraint(node: ConstraintSyntax): Constraint;
- public visitIfStatement(node: IfStatementSyntax): IfStatement;
- public visitElseClause(node: ElseClauseSyntax): ElseClause;
- public visitExpressionStatement(node: ExpressionStatementSyntax): ExpressionStatement;
- public visitConstructorDeclaration(node: ConstructorDeclarationSyntax): ConstructorDeclaration;
- public visitIndexMemberDeclaration(node: IndexMemberDeclarationSyntax): IndexMemberDeclaration;
- public visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): MemberFunctionDeclaration;
- public visitGetAccessor(node: GetAccessorSyntax): GetAccessor;
- public visitSetAccessor(node: SetAccessorSyntax): SetAccessor;
- public visitMemberVariableDeclaration(node: MemberVariableDeclarationSyntax): MemberVariableDeclaration;
- public visitThrowStatement(node: ThrowStatementSyntax): ThrowStatement;
- public visitReturnStatement(node: ReturnStatementSyntax): ReturnStatement;
- public visitObjectCreationExpression(node: ObjectCreationExpressionSyntax): ObjectCreationExpression;
- public visitSwitchStatement(node: SwitchStatementSyntax): SwitchStatement;
- public visitCaseSwitchClause(node: CaseSwitchClauseSyntax): CaseSwitchClause;
- public visitDefaultSwitchClause(node: DefaultSwitchClauseSyntax): DefaultSwitchClause;
- public visitBreakStatement(node: BreakStatementSyntax): BreakStatement;
- public visitContinueStatement(node: ContinueStatementSyntax): ContinueStatement;
- public visitForStatement(node: ForStatementSyntax): ForStatement;
- public visitForInStatement(node: ForInStatementSyntax): ForInStatement;
- public visitWhileStatement(node: WhileStatementSyntax): WhileStatement;
- public visitWithStatement(node: WithStatementSyntax): WithStatement;
- public visitCastExpression(node: CastExpressionSyntax): CastExpression;
- public visitObjectLiteralExpression(node: ObjectLiteralExpressionSyntax): ObjectLiteralExpression;
- public visitSimplePropertyAssignment(node: SimplePropertyAssignmentSyntax): SimplePropertyAssignment;
- public visitFunctionPropertyAssignment(node: FunctionPropertyAssignmentSyntax): FunctionPropertyAssignment;
- public visitFunctionExpression(node: FunctionExpressionSyntax): FunctionExpression;
- public visitEmptyStatement(node: EmptyStatementSyntax): EmptyStatement;
- public visitTryStatement(node: TryStatementSyntax): TryStatement;
- public visitCatchClause(node: CatchClauseSyntax): CatchClause;
- public visitFinallyClause(node: FinallyClauseSyntax): FinallyClause;
- public visitLabeledStatement(node: LabeledStatementSyntax): LabeledStatement;
- public visitDoStatement(node: DoStatementSyntax): DoStatement;
- public visitTypeOfExpression(node: TypeOfExpressionSyntax): TypeOfExpression;
- public visitDeleteExpression(node: DeleteExpressionSyntax): DeleteExpression;
- public visitVoidExpression(node: VoidExpressionSyntax): VoidExpression;
- public visitDebuggerStatement(node: DebuggerStatementSyntax): DebuggerStatement;
- }
-}
-declare module TypeScript {
- interface IASTSpan {
- _start: number;
- _end: number;
- start(): number;
- end(): number;
- }
- class ASTSpan implements IASTSpan {
- public _start: number;
- public _end: number;
- constructor(_start: number, _end: number);
- public start(): number;
- public end(): number;
- }
- function structuralEqualsNotIncludingPosition(ast1: AST, ast2: AST): boolean;
- function structuralEqualsIncludingPosition(ast1: AST, ast2: AST): boolean;
- class AST implements IASTSpan {
- public parent: AST;
- public _start: number;
- public _end: number;
- public _trailingTriviaWidth: number;
- private _astID;
- private _preComments;
- private _postComments;
- constructor();
- public syntaxID(): number;
- public start(): number;
- public end(): number;
- public trailingTriviaWidth(): number;
- public fileName(): string;
- public kind(): SyntaxKind;
- public preComments(): Comment[];
- public postComments(): Comment[];
- public setPreComments(comments: Comment[]): void;
- public setPostComments(comments: Comment[]): void;
- public width(): number;
- public structuralEquals(ast: AST, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- interface IASTToken extends AST {
- text(): string;
- valueText(): string;
- }
- class ISyntaxList2 extends AST {
- private _fileName;
- private members;
- constructor(_fileName: string, members: AST[]);
- public childCount(): number;
- public childAt(index: number): AST;
- public fileName(): string;
- public kind(): SyntaxKind;
- public firstOrDefault(func: (v: AST, index: number) => boolean): AST;
- public lastOrDefault(func: (v: AST, index: number) => boolean): AST;
- public any(func: (v: AST) => boolean): boolean;
- public structuralEquals(ast: ISyntaxList2, includingPosition: boolean): boolean;
- }
- class ISeparatedSyntaxList2 extends AST {
- private _fileName;
- private members;
- private _separatorCount;
- constructor(_fileName: string, members: AST[], _separatorCount: number);
- public nonSeparatorCount(): number;
- public separatorCount(): number;
- public nonSeparatorAt(index: number): AST;
- public nonSeparatorIndexOf(ast: AST): number;
- public fileName(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: ISeparatedSyntaxList2, includingPosition: boolean): boolean;
- }
- class SourceUnit extends AST {
- public moduleElements: ISyntaxList2;
- public endOfFileTokenLeadingComments: Comment[];
- private _fileName;
- constructor(moduleElements: ISyntaxList2, endOfFileTokenLeadingComments: Comment[], _fileName: string);
- public fileName(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: SourceUnit, includingPosition: boolean): boolean;
- }
- class Identifier extends AST implements IASTToken {
- private _text;
- private _valueText;
- constructor(_text: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: Identifier, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class LiteralExpression extends AST {
- private _nodeType;
- private _text;
- private _valueText;
- constructor(_nodeType: SyntaxKind, _text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: ParenthesizedExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ThisExpression extends AST implements IASTToken {
- private _text;
- private _valueText;
- constructor(_text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: ParenthesizedExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class SuperExpression extends AST implements IASTToken {
- private _text;
- private _valueText;
- constructor(_text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: ParenthesizedExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class NumericLiteral extends AST implements IASTToken {
- private _value;
- private _text;
- private _valueText;
- constructor(_value: number, _text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public value(): any;
- public kind(): SyntaxKind;
- public structuralEquals(ast: NumericLiteral, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class RegularExpressionLiteral extends AST implements IASTToken {
- private _text;
- private _valueText;
- constructor(_text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- public isExpression(): boolean;
- }
- class StringLiteral extends AST implements IASTToken {
- private _text;
- private _valueText;
- constructor(_text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: StringLiteral, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class TypeAnnotation extends AST {
- public type: AST;
- constructor(type: AST);
- public kind(): SyntaxKind;
- }
- class BuiltInType extends AST implements IASTToken {
- private _nodeType;
- private _text;
- private _valueText;
- constructor(_nodeType: SyntaxKind, _text: string, _valueText: string);
- public text(): string;
- public valueText(): string;
- public kind(): SyntaxKind;
- }
- class ExternalModuleReference extends AST {
- public stringLiteral: StringLiteral;
- constructor(stringLiteral: StringLiteral);
- public kind(): SyntaxKind;
- }
- class ModuleNameModuleReference extends AST {
- public moduleName: AST;
- constructor(moduleName: AST);
- public kind(): SyntaxKind;
- }
- class ImportDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public identifier: Identifier;
- public moduleReference: AST;
- constructor(modifiers: PullElementFlags[], identifier: Identifier, moduleReference: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ImportDeclaration, includingPosition: boolean): boolean;
- }
- class ExportAssignment extends AST {
- public identifier: Identifier;
- constructor(identifier: Identifier);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ExportAssignment, includingPosition: boolean): boolean;
- }
- class TypeParameterList extends AST {
- public typeParameters: ISeparatedSyntaxList2;
- constructor(typeParameters: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- }
- class ClassDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public identifier: Identifier;
- public typeParameterList: TypeParameterList;
- public heritageClauses: ISyntaxList2;
- public classElements: ISyntaxList2;
- public closeBraceToken: ASTSpan;
- constructor(modifiers: PullElementFlags[], identifier: Identifier, typeParameterList: TypeParameterList, heritageClauses: ISyntaxList2, classElements: ISyntaxList2, closeBraceToken: ASTSpan);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ClassDeclaration, includingPosition: boolean): boolean;
- }
- class InterfaceDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public identifier: Identifier;
- public typeParameterList: TypeParameterList;
- public heritageClauses: ISyntaxList2;
- public body: ObjectType;
- constructor(modifiers: PullElementFlags[], identifier: Identifier, typeParameterList: TypeParameterList, heritageClauses: ISyntaxList2, body: ObjectType);
- public kind(): SyntaxKind;
- public structuralEquals(ast: InterfaceDeclaration, includingPosition: boolean): boolean;
- }
- class HeritageClause extends AST {
- private _nodeType;
- public typeNames: ISeparatedSyntaxList2;
- constructor(_nodeType: SyntaxKind, typeNames: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: HeritageClause, includingPosition: boolean): boolean;
- }
- class ModuleDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public name: AST;
- public stringLiteral: StringLiteral;
- public moduleElements: ISyntaxList2;
- public endingToken: ASTSpan;
- constructor(modifiers: PullElementFlags[], name: AST, stringLiteral: StringLiteral, moduleElements: ISyntaxList2, endingToken: ASTSpan);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ModuleDeclaration, includingPosition: boolean): boolean;
- }
- class FunctionDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public identifier: Identifier;
- public callSignature: CallSignature;
- public block: Block;
- constructor(modifiers: PullElementFlags[], identifier: Identifier, callSignature: CallSignature, block: Block);
- public kind(): SyntaxKind;
- public structuralEquals(ast: FunctionDeclaration, includingPosition: boolean): boolean;
- }
- class VariableStatement extends AST {
- public modifiers: PullElementFlags[];
- public declaration: VariableDeclaration;
- constructor(modifiers: PullElementFlags[], declaration: VariableDeclaration);
- public kind(): SyntaxKind;
- public structuralEquals(ast: VariableStatement, includingPosition: boolean): boolean;
- }
- class VariableDeclaration extends AST {
- public declarators: ISeparatedSyntaxList2;
- constructor(declarators: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: VariableDeclaration, includingPosition: boolean): boolean;
- }
- class VariableDeclarator extends AST {
- public propertyName: IASTToken;
- public typeAnnotation: TypeAnnotation;
- public equalsValueClause: EqualsValueClause;
- constructor(propertyName: IASTToken, typeAnnotation: TypeAnnotation, equalsValueClause: EqualsValueClause);
- public kind(): SyntaxKind;
- }
- class EqualsValueClause extends AST {
- public value: AST;
- constructor(value: AST);
- public kind(): SyntaxKind;
- }
- class PrefixUnaryExpression extends AST {
- private _nodeType;
- public operand: AST;
- constructor(_nodeType: SyntaxKind, operand: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: PrefixUnaryExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ArrayLiteralExpression extends AST {
- public expressions: ISeparatedSyntaxList2;
- constructor(expressions: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ArrayLiteralExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class OmittedExpression extends AST {
- public kind(): SyntaxKind;
- public structuralEquals(ast: CatchClause, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ParenthesizedExpression extends AST {
- public openParenTrailingComments: Comment[];
- public expression: AST;
- constructor(openParenTrailingComments: Comment[], expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ParenthesizedExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- interface ICallExpression extends IASTSpan {
- expression: AST;
- argumentList: ArgumentList;
- }
- class SimpleArrowFunctionExpression extends AST {
- public identifier: Identifier;
- public block: Block;
- public expression: AST;
- constructor(identifier: Identifier, block: Block, expression: AST);
- public kind(): SyntaxKind;
- public isExpression(): boolean;
- }
- class ParenthesizedArrowFunctionExpression extends AST {
- public callSignature: CallSignature;
- public block: Block;
- public expression: AST;
- constructor(callSignature: CallSignature, block: Block, expression: AST);
- public kind(): SyntaxKind;
- public isExpression(): boolean;
- }
- class QualifiedName extends AST {
- public left: AST;
- public right: Identifier;
- constructor(left: AST, right: Identifier);
- public kind(): SyntaxKind;
- public structuralEquals(ast: QualifiedName, includingPosition: boolean): boolean;
- }
- class ParameterList extends AST {
- public openParenTrailingComments: Comment[];
- public parameters: ISeparatedSyntaxList2;
- constructor(openParenTrailingComments: Comment[], parameters: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- }
- class ConstructorType extends AST {
- public typeParameterList: TypeParameterList;
- public parameterList: ParameterList;
- public type: AST;
- constructor(typeParameterList: TypeParameterList, parameterList: ParameterList, type: AST);
- public kind(): SyntaxKind;
- }
- class FunctionType extends AST {
- public typeParameterList: TypeParameterList;
- public parameterList: ParameterList;
- public type: AST;
- constructor(typeParameterList: TypeParameterList, parameterList: ParameterList, type: AST);
- public kind(): SyntaxKind;
- }
- class ObjectType extends AST {
- public typeMembers: ISeparatedSyntaxList2;
- constructor(typeMembers: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ObjectType, includingPosition: boolean): boolean;
- }
- class ArrayType extends AST {
- public type: AST;
- constructor(type: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ArrayType, includingPosition: boolean): boolean;
- }
- class TypeArgumentList extends AST {
- public typeArguments: ISeparatedSyntaxList2;
- constructor(typeArguments: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- }
- class GenericType extends AST {
- public name: AST;
- public typeArgumentList: TypeArgumentList;
- constructor(name: AST, typeArgumentList: TypeArgumentList);
- public kind(): SyntaxKind;
- public structuralEquals(ast: GenericType, includingPosition: boolean): boolean;
- }
- class TypeQuery extends AST {
- public name: AST;
- constructor(name: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: TypeQuery, includingPosition: boolean): boolean;
- }
- class Block extends AST {
- public statements: ISyntaxList2;
- public closeBraceLeadingComments: Comment[];
- public closeBraceToken: IASTSpan;
- constructor(statements: ISyntaxList2, closeBraceLeadingComments: Comment[], closeBraceToken: IASTSpan);
- public kind(): SyntaxKind;
- public structuralEquals(ast: Block, includingPosition: boolean): boolean;
- }
- class Parameter extends AST {
- public dotDotDotToken: ASTSpan;
- public modifiers: PullElementFlags[];
- public identifier: Identifier;
- public questionToken: ASTSpan;
- public typeAnnotation: TypeAnnotation;
- public equalsValueClause: EqualsValueClause;
- constructor(dotDotDotToken: ASTSpan, modifiers: PullElementFlags[], identifier: Identifier, questionToken: ASTSpan, typeAnnotation: TypeAnnotation, equalsValueClause: EqualsValueClause);
- public kind(): SyntaxKind;
- }
- class MemberAccessExpression extends AST {
- public expression: AST;
- public name: Identifier;
- constructor(expression: AST, name: Identifier);
- public kind(): SyntaxKind;
- public structuralEquals(ast: MemberAccessExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class PostfixUnaryExpression extends AST {
- private _nodeType;
- public operand: AST;
- constructor(_nodeType: SyntaxKind, operand: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: PostfixUnaryExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ElementAccessExpression extends AST {
- public expression: AST;
- public argumentExpression: AST;
- constructor(expression: AST, argumentExpression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ElementAccessExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class InvocationExpression extends AST implements ICallExpression {
- public expression: AST;
- public argumentList: ArgumentList;
- constructor(expression: AST, argumentList: ArgumentList);
- public kind(): SyntaxKind;
- public structuralEquals(ast: InvocationExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ArgumentList extends AST {
- public typeArgumentList: TypeArgumentList;
- public closeParenToken: ASTSpan;
- public arguments: ISeparatedSyntaxList2;
- constructor(typeArgumentList: TypeArgumentList, _arguments: ISeparatedSyntaxList2, closeParenToken: ASTSpan);
- public kind(): SyntaxKind;
- }
- class BinaryExpression extends AST {
- private _nodeType;
- public left: AST;
- public right: AST;
- constructor(_nodeType: SyntaxKind, left: AST, right: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: BinaryExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ConditionalExpression extends AST {
- public condition: AST;
- public whenTrue: AST;
- public whenFalse: AST;
- constructor(condition: AST, whenTrue: AST, whenFalse: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ConditionalExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ConstructSignature extends AST {
- public callSignature: CallSignature;
- constructor(callSignature: CallSignature);
- public kind(): SyntaxKind;
- }
- class MethodSignature extends AST {
- public propertyName: IASTToken;
- public questionToken: ASTSpan;
- public callSignature: CallSignature;
- constructor(propertyName: IASTToken, questionToken: ASTSpan, callSignature: CallSignature);
- public kind(): SyntaxKind;
- }
- class IndexSignature extends AST {
- public parameter: Parameter;
- public typeAnnotation: TypeAnnotation;
- constructor(parameter: Parameter, typeAnnotation: TypeAnnotation);
- public kind(): SyntaxKind;
- }
- class PropertySignature extends AST {
- public propertyName: IASTToken;
- public questionToken: ASTSpan;
- public typeAnnotation: TypeAnnotation;
- constructor(propertyName: IASTToken, questionToken: ASTSpan, typeAnnotation: TypeAnnotation);
- public kind(): SyntaxKind;
- }
- class CallSignature extends AST {
- public typeParameterList: TypeParameterList;
- public parameterList: ParameterList;
- public typeAnnotation: TypeAnnotation;
- constructor(typeParameterList: TypeParameterList, parameterList: ParameterList, typeAnnotation: TypeAnnotation);
- public kind(): SyntaxKind;
- }
- class TypeParameter extends AST {
- public identifier: Identifier;
- public constraint: Constraint;
- constructor(identifier: Identifier, constraint: Constraint);
- public kind(): SyntaxKind;
- public structuralEquals(ast: TypeParameter, includingPosition: boolean): boolean;
- }
- class Constraint extends AST {
- public type: AST;
- constructor(type: AST);
- public kind(): SyntaxKind;
- }
- class ElseClause extends AST {
- public statement: AST;
- constructor(statement: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ElseClause, includingPosition: boolean): boolean;
- }
- class IfStatement extends AST {
- public condition: AST;
- public statement: AST;
- public elseClause: ElseClause;
- constructor(condition: AST, statement: AST, elseClause: ElseClause);
- public kind(): SyntaxKind;
- public structuralEquals(ast: IfStatement, includingPosition: boolean): boolean;
- }
- class ExpressionStatement extends AST {
- public expression: AST;
- constructor(expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ExpressionStatement, includingPosition: boolean): boolean;
- }
- class ConstructorDeclaration extends AST {
- public callSignature: CallSignature;
- public block: Block;
- constructor(callSignature: CallSignature, block: Block);
- public kind(): SyntaxKind;
- }
- class MemberFunctionDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public propertyName: IASTToken;
- public callSignature: CallSignature;
- public block: Block;
- constructor(modifiers: PullElementFlags[], propertyName: IASTToken, callSignature: CallSignature, block: Block);
- public kind(): SyntaxKind;
- }
- class GetAccessor extends AST {
- public modifiers: PullElementFlags[];
- public propertyName: IASTToken;
- public parameterList: ParameterList;
- public typeAnnotation: TypeAnnotation;
- public block: Block;
- constructor(modifiers: PullElementFlags[], propertyName: IASTToken, parameterList: ParameterList, typeAnnotation: TypeAnnotation, block: Block);
- public kind(): SyntaxKind;
- }
- class SetAccessor extends AST {
- public modifiers: PullElementFlags[];
- public propertyName: IASTToken;
- public parameterList: ParameterList;
- public block: Block;
- constructor(modifiers: PullElementFlags[], propertyName: IASTToken, parameterList: ParameterList, block: Block);
- public kind(): SyntaxKind;
- }
- class MemberVariableDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public variableDeclarator: VariableDeclarator;
- constructor(modifiers: PullElementFlags[], variableDeclarator: VariableDeclarator);
- public kind(): SyntaxKind;
- }
- class IndexMemberDeclaration extends AST {
- public indexSignature: IndexSignature;
- constructor(indexSignature: IndexSignature);
- public kind(): SyntaxKind;
- }
- class ThrowStatement extends AST {
- public expression: AST;
- constructor(expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ThrowStatement, includingPosition: boolean): boolean;
- }
- class ReturnStatement extends AST {
- public expression: AST;
- constructor(expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ReturnStatement, includingPosition: boolean): boolean;
- }
- class ObjectCreationExpression extends AST implements ICallExpression {
- public expression: AST;
- public argumentList: ArgumentList;
- constructor(expression: AST, argumentList: ArgumentList);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ObjectCreationExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class SwitchStatement extends AST {
- public expression: AST;
- public closeParenToken: ASTSpan;
- public switchClauses: ISyntaxList2;
- constructor(expression: AST, closeParenToken: ASTSpan, switchClauses: ISyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: SwitchStatement, includingPosition: boolean): boolean;
- }
- class CaseSwitchClause extends AST {
- public expression: AST;
- public statements: ISyntaxList2;
- constructor(expression: AST, statements: ISyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: CaseSwitchClause, includingPosition: boolean): boolean;
- }
- class DefaultSwitchClause extends AST {
- public statements: ISyntaxList2;
- constructor(statements: ISyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: DefaultSwitchClause, includingPosition: boolean): boolean;
- }
- class BreakStatement extends AST {
- public identifier: Identifier;
- constructor(identifier: Identifier);
- public kind(): SyntaxKind;
- public structuralEquals(ast: BreakStatement, includingPosition: boolean): boolean;
- }
- class ContinueStatement extends AST {
- public identifier: Identifier;
- constructor(identifier: Identifier);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ContinueStatement, includingPosition: boolean): boolean;
- }
- class ForStatement extends AST {
- public variableDeclaration: VariableDeclaration;
- public initializer: AST;
- public condition: AST;
- public incrementor: AST;
- public statement: AST;
- constructor(variableDeclaration: VariableDeclaration, initializer: AST, condition: AST, incrementor: AST, statement: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ForStatement, includingPosition: boolean): boolean;
- }
- class ForInStatement extends AST {
- public variableDeclaration: VariableDeclaration;
- public left: AST;
- public expression: AST;
- public statement: AST;
- constructor(variableDeclaration: VariableDeclaration, left: AST, expression: AST, statement: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ForInStatement, includingPosition: boolean): boolean;
- }
- class WhileStatement extends AST {
- public condition: AST;
- public statement: AST;
- constructor(condition: AST, statement: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: WhileStatement, includingPosition: boolean): boolean;
- }
- class WithStatement extends AST {
- public condition: AST;
- public statement: AST;
- constructor(condition: AST, statement: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: WithStatement, includingPosition: boolean): boolean;
- }
- class EnumDeclaration extends AST {
- public modifiers: PullElementFlags[];
- public identifier: Identifier;
- public enumElements: ISeparatedSyntaxList2;
- constructor(modifiers: PullElementFlags[], identifier: Identifier, enumElements: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- }
- class EnumElement extends AST {
- public propertyName: IASTToken;
- public equalsValueClause: EqualsValueClause;
- constructor(propertyName: IASTToken, equalsValueClause: EqualsValueClause);
- public kind(): SyntaxKind;
- }
- class CastExpression extends AST {
- public type: AST;
- public expression: AST;
- constructor(type: AST, expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: CastExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class ObjectLiteralExpression extends AST {
- public propertyAssignments: ISeparatedSyntaxList2;
- constructor(propertyAssignments: ISeparatedSyntaxList2);
- public kind(): SyntaxKind;
- public structuralEquals(ast: ObjectLiteralExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class SimplePropertyAssignment extends AST {
- public propertyName: Identifier;
- public expression: AST;
- constructor(propertyName: Identifier, expression: AST);
- public kind(): SyntaxKind;
- }
- class FunctionPropertyAssignment extends AST {
- public propertyName: Identifier;
- public callSignature: CallSignature;
- public block: Block;
- constructor(propertyName: Identifier, callSignature: CallSignature, block: Block);
- public kind(): SyntaxKind;
- }
- class FunctionExpression extends AST {
- public identifier: Identifier;
- public callSignature: CallSignature;
- public block: Block;
- constructor(identifier: Identifier, callSignature: CallSignature, block: Block);
- public kind(): SyntaxKind;
- public isExpression(): boolean;
- }
- class EmptyStatement extends AST {
- public kind(): SyntaxKind;
- public structuralEquals(ast: CatchClause, includingPosition: boolean): boolean;
- }
- class TryStatement extends AST {
- public block: Block;
- public catchClause: CatchClause;
- public finallyClause: FinallyClause;
- constructor(block: Block, catchClause: CatchClause, finallyClause: FinallyClause);
- public kind(): SyntaxKind;
- public structuralEquals(ast: TryStatement, includingPosition: boolean): boolean;
- }
- class CatchClause extends AST {
- public identifier: Identifier;
- public typeAnnotation: TypeAnnotation;
- public block: Block;
- constructor(identifier: Identifier, typeAnnotation: TypeAnnotation, block: Block);
- public kind(): SyntaxKind;
- public structuralEquals(ast: CatchClause, includingPosition: boolean): boolean;
- }
- class FinallyClause extends AST {
- public block: Block;
- constructor(block: Block);
- public kind(): SyntaxKind;
- public structuralEquals(ast: CatchClause, includingPosition: boolean): boolean;
- }
- class LabeledStatement extends AST {
- public identifier: Identifier;
- public statement: AST;
- constructor(identifier: Identifier, statement: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: LabeledStatement, includingPosition: boolean): boolean;
- }
- class DoStatement extends AST {
- public statement: AST;
- public whileKeyword: ASTSpan;
- public condition: AST;
- constructor(statement: AST, whileKeyword: ASTSpan, condition: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: DoStatement, includingPosition: boolean): boolean;
- }
- class TypeOfExpression extends AST {
- public expression: AST;
- constructor(expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: TypeOfExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class DeleteExpression extends AST {
- public expression: AST;
- constructor(expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: DeleteExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class VoidExpression extends AST {
- public expression: AST;
- constructor(expression: AST);
- public kind(): SyntaxKind;
- public structuralEquals(ast: VoidExpression, includingPosition: boolean): boolean;
- public isExpression(): boolean;
- }
- class DebuggerStatement extends AST {
- public kind(): SyntaxKind;
- }
- class Comment {
- private _trivia;
- public endsLine: boolean;
- public _start: number;
- public _end: number;
- constructor(_trivia: ISyntaxTrivia, endsLine: boolean, _start: number, _end: number);
- public start(): number;
- public end(): number;
- public fullText(): string;
- public kind(): SyntaxKind;
- public structuralEquals(ast: Comment, includingPosition: boolean): boolean;
- }
-}
-declare module TypeScript.Services {
- enum EndOfLineState {
- Start = 0,
- InMultiLineCommentTrivia = 1,
- InSingleQuoteStringLiteral = 2,
- InDoubleQuoteStringLiteral = 3,
- }
- enum TokenClass {
- Punctuation = 0,
- Keyword = 1,
- Operator = 2,
- Comment = 3,
- Whitespace = 4,
- Identifier = 5,
- NumberLiteral = 6,
- StringLiteral = 7,
- RegExpLiteral = 8,
- }
- class Classifier {
- public host: IClassifierHost;
- private scanner;
- private characterWindow;
- private diagnostics;
- constructor(host: IClassifierHost);
- public getClassificationsForLine(text: string, lexState: EndOfLineState): ClassificationResult;
- private processToken(text, offset, token, result);
- private processTriviaList(text, offset, triviaList, result);
- private addResult(text, offset, result, length, kind);
- private classFromKind(kind);
- }
- interface IClassifierHost extends ILogger {
- }
- class ClassificationResult {
- public finalLexState: EndOfLineState;
- public entries: ClassificationInfo[];
- constructor();
- }
- class ClassificationInfo {
- public length: number;
- public classification: TokenClass;
- constructor(length: number, classification: TokenClass);
- }
-}
-declare module TypeScript.Services {
- interface ILanguageServicesDiagnostics {
- log(content: string): void;
- }
-}
-declare module TypeScript.Services {
- interface ILanguageServiceHost extends ILogger, IReferenceResolverHost {
- getCompilationSettings(): CompilationSettings;
- getScriptFileNames(): string[];
- getScriptVersion(fileName: string): number;
- getScriptIsOpen(fileName: string): boolean;
- getScriptByteOrderMark(fileName: string): ByteOrderMark;
- getScriptSnapshot(fileName: string): IScriptSnapshot;
- getDiagnosticsObject(): ILanguageServicesDiagnostics;
- getLocalizedDiagnosticMessages(): any;
- }
- interface ILanguageService {
- refresh(): void;
- cleanupSemanticCache(): void;
- getSyntacticDiagnostics(fileName: string): Diagnostic[];
- getSemanticDiagnostics(fileName: string): Diagnostic[];
- getCompilerOptionsDiagnostics(): Diagnostic[];
- getCompletionsAtPosition(fileName: string, position: number, isMemberCompletion: boolean): CompletionInfo;
- getCompletionEntryDetails(fileName: string, position: number, entryName: string): CompletionEntryDetails;
- getTypeAtPosition(fileName: string, position: number): TypeInfo;
- getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): SpanInfo;
- getBreakpointStatementAtPosition(fileName: string, position: number): SpanInfo;
- getSignatureAtPosition(fileName: string, position: number): SignatureInfo;
- getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
- getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
- getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
- getImplementorsAtPosition(fileName: string, position: number): ReferenceEntry[];
- getNavigateToItems(searchValue: string): NavigateToItem[];
- getScriptLexicalStructure(fileName: string): NavigateToItem[];
- getOutliningRegions(fileName: string): TextSpan[];
- getBraceMatchingAtPosition(fileName: string, position: number): TextSpan[];
- getIndentationAtPosition(fileName: string, position: number, options: EditorOptions): number;
- getFormattingEditsForRange(fileName: string, minChar: number, limChar: number, options: FormatCodeOptions): TextEdit[];
- getFormattingEditsForDocument(fileName: string, minChar: number, limChar: number, options: FormatCodeOptions): TextEdit[];
- getFormattingEditsOnPaste(fileName: string, minChar: number, limChar: number, options: FormatCodeOptions): TextEdit[];
- getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions): TextEdit[];
- getEmitOutput(fileName: string): EmitOutput;
- getSyntaxTree(fileName: string): SyntaxTree;
- }
- function logInternalError(logger: ILogger, err: Error): void;
- class ReferenceEntry {
- public fileName: string;
- public minChar: number;
- public limChar: number;
- public isWriteAccess: boolean;
- constructor(fileName: string, minChar: number, limChar: number, isWriteAccess: boolean);
- }
- class NavigateToItem {
- public name: string;
- public kind: string;
- public kindModifiers: string;
- public matchKind: string;
- public fileName: string;
- public minChar: number;
- public limChar: number;
- public additionalSpans: SpanInfo[];
- public containerName: string;
- public containerKind: string;
- }
- class TextEdit {
- public minChar: number;
- public limChar: number;
- public text: string;
- constructor(minChar: number, limChar: number, text: string);
- static createInsert(pos: number, text: string): TextEdit;
- static createDelete(minChar: number, limChar: number): TextEdit;
- static createReplace(minChar: number, limChar: number, text: string): TextEdit;
- }
- class EditorOptions {
- public IndentSize: number;
- public TabSize: number;
- public NewLineCharacter: string;
- public ConvertTabsToSpaces: boolean;
- static clone(objectToClone: EditorOptions): EditorOptions;
- }
- class FormatCodeOptions extends EditorOptions {
- public InsertSpaceAfterCommaDelimiter: boolean;
- public InsertSpaceAfterSemicolonInForStatements: boolean;
- public InsertSpaceBeforeAndAfterBinaryOperators: boolean;
- public InsertSpaceAfterKeywordsInControlFlowStatements: boolean;
- public InsertSpaceAfterFunctionKeywordForAnonymousFunctions: boolean;
- public InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: boolean;
- public PlaceOpenBraceOnNewLineForFunctions: boolean;
- public PlaceOpenBraceOnNewLineForControlBlocks: boolean;
- static clone(objectToClone: FormatCodeOptions): FormatCodeOptions;
- }
- class DefinitionInfo {
- public fileName: string;
- public minChar: number;
- public limChar: number;
- public kind: string;
- public name: string;
- public containerKind: string;
- public containerName: string;
- constructor(fileName: string, minChar: number, limChar: number, kind: string, name: string, containerKind: string, containerName: string);
- }
- class TypeInfo {
- public memberName: MemberName;
- public docComment: string;
- public fullSymbolName: string;
- public kind: string;
- public minChar: number;
- public limChar: number;
- constructor(memberName: MemberName, docComment: string, fullSymbolName: string, kind: string, minChar: number, limChar: number);
- }
- class SpanInfo {
- public minChar: number;
- public limChar: number;
- public text: string;
- constructor(minChar: number, limChar: number, text?: string);
- }
- class SignatureInfo {
- public actual: ActualSignatureInfo;
- public formal: FormalSignatureItemInfo[];
- public activeFormal: number;
- }
- class FormalSignatureItemInfo {
- public signatureInfo: string;
- public typeParameters: FormalTypeParameterInfo[];
- public parameters: FormalParameterInfo[];
- public docComment: string;
- }
- class FormalTypeParameterInfo {
- public name: string;
- public docComment: string;
- public minChar: number;
- public limChar: number;
- }
- class FormalParameterInfo {
- public name: string;
- public isVariable: boolean;
- public docComment: string;
- public minChar: number;
- public limChar: number;
- }
- class ActualSignatureInfo {
- public parameterMinChar: number;
- public parameterLimChar: number;
- public currentParameterIsTypeParameter: boolean;
- public currentParameter: number;
- }
- class CompletionInfo {
- public maybeInaccurate: boolean;
- public isMemberCompletion: boolean;
- public entries: CompletionEntry[];
- }
- interface CompletionEntry {
- name: string;
- kind: string;
- kindModifiers: string;
- }
- interface CompletionEntryDetails {
- name: string;
- kind: string;
- kindModifiers: string;
- type: string;
- fullSymbolName: string;
- docComment: string;
- }
- class ScriptElementKind {
- static unknown: string;
- static keyword: string;
- static scriptElement: string;
- static moduleElement: string;
- static classElement: string;
- static interfaceElement: string;
- static enumElement: string;
- static variableElement: string;
- static localVariableElement: string;
- static functionElement: string;
- static localFunctionElement: string;
- static memberFunctionElement: string;
- static memberGetAccessorElement: string;
- static memberSetAccessorElement: string;
- static memberVariableElement: string;
- static constructorImplementationElement: string;
- static callSignatureElement: string;
- static indexSignatureElement: string;
- static constructSignatureElement: string;
- static parameterElement: string;
- static typeParameterElement: string;
- static primitiveType: string;
- }
- class ScriptElementKindModifier {
- static none: string;
- static publicMemberModifier: string;
- static privateMemberModifier: string;
- static exportedModifier: string;
- static ambientModifier: string;
- static staticModifier: string;
- }
- class MatchKind {
- static none: string;
- static exact: string;
- static subString: string;
- static prefix: string;
- }
- class DiagnosticCategory {
- static none: string;
- static error: string;
- static warning: string;
- static message: string;
- }
-}
-declare module TypeScript.Services.Formatting {
- interface ITextSnapshot {
- getText(span: TextSpan): string;
- getLineNumberFromPosition(position: number): number;
- getLineFromPosition(position: number): ITextSnapshotLine;
- getLineFromLineNumber(lineNumber: number): ITextSnapshotLine;
- }
- class TextSnapshot implements ITextSnapshot {
- private snapshot;
- private lines;
- constructor(snapshot: ISimpleText);
- public getText(span: TextSpan): string;
- public getLineNumberFromPosition(position: number): number;
- public getLineFromPosition(position: number): ITextSnapshotLine;
- public getLineFromLineNumber(lineNumber: number): ITextSnapshotLine;
- private getLineFromLineNumberWorker(lineNumber);
- }
-}
-declare module TypeScript.Services.Formatting {
- interface ITextSnapshotLine {
- snapshot(): ITextSnapshot;
- start(): SnapshotPoint;
- startPosition(): number;
- end(): SnapshotPoint;
- endPosition(): number;
- endIncludingLineBreak(): SnapshotPoint;
- endIncludingLineBreakPosition(): number;
- length(): number;
- lineNumber(): number;
- getText(): string;
- }
- class TextSnapshotLine implements ITextSnapshotLine {
- private _snapshot;
- private _lineNumber;
- private _start;
- private _end;
- private _lineBreak;
- constructor(_snapshot: ITextSnapshot, _lineNumber: number, _start: number, _end: number, _lineBreak: string);
- public snapshot(): ITextSnapshot;
- public start(): SnapshotPoint;
- public startPosition(): number;
- public end(): SnapshotPoint;
- public endPosition(): number;
- public endIncludingLineBreak(): SnapshotPoint;
- public endIncludingLineBreakPosition(): number;
- public length(): number;
- public lineNumber(): number;
- public getText(): string;
- }
-}
-declare module TypeScript.Services.Formatting {
- class SnapshotPoint {
- public snapshot: ITextSnapshot;
- public position: number;
- constructor(snapshot: ITextSnapshot, position: number);
- public getContainingLine(): ITextSnapshotLine;
- public add(offset: number): SnapshotPoint;
- }
-}
-declare module TypeScript.Services.Formatting {
- class FormattingContext {
- private snapshot;
- public formattingRequestKind: FormattingRequestKind;
- public currentTokenSpan: TokenSpan;
- public nextTokenSpan: TokenSpan;
- public contextNode: IndentationNodeContext;
- public currentTokenParent: IndentationNodeContext;
- public nextTokenParent: IndentationNodeContext;
- private contextNodeAllOnSameLine;
- private nextNodeAllOnSameLine;
- private tokensAreOnSameLine;
- private contextNodeBlockIsOnOneLine;
- private nextNodeBlockIsOnOneLine;
- constructor(snapshot: ITextSnapshot, formattingRequestKind: FormattingRequestKind);
- public updateContext(currentTokenSpan: TokenSpan, currentTokenParent: IndentationNodeContext, nextTokenSpan: TokenSpan, nextTokenParent: IndentationNodeContext, commonParent: IndentationNodeContext): void;
- public ContextNodeAllOnSameLine(): boolean;
- public NextNodeAllOnSameLine(): boolean;
- public TokensAreOnSameLine(): boolean;
- public ContextNodeBlockIsOnOneLine(): boolean;
- public NextNodeBlockIsOnOneLine(): boolean;
- public NodeIsOnOneLine(node: IndentationNodeContext): boolean;
- public BlockIsOnOneLine(node: IndentationNodeContext): boolean;
- }
-}
-declare module TypeScript.Services.Formatting {
- class FormattingManager {
- private syntaxTree;
- private snapshot;
- private rulesProvider;
- private options;
- constructor(syntaxTree: SyntaxTree, snapshot: ITextSnapshot, rulesProvider: RulesProvider, editorOptions: EditorOptions);
- public formatSelection(minChar: number, limChar: number): TextEdit[];
- public formatDocument(minChar: number, limChar: number): TextEdit[];
- public formatOnPaste(minChar: number, limChar: number): TextEdit[];
- public formatOnSemicolon(caretPosition: number): TextEdit[];
- public formatOnClosingCurlyBrace(caretPosition: number): TextEdit[];
- public formatOnEnter(caretPosition: number): TextEdit[];
- private formatSpan(span, formattingRequestKind);
- }
-}
-declare module TypeScript.Services.Formatting {
- enum FormattingRequestKind {
- FormatDocument = 0,
- FormatSelection = 1,
- FormatOnEnter = 2,
- FormatOnSemicolon = 3,
- FormatOnClosingCurlyBrace = 4,
- FormatOnPaste = 5,
- }
-}
-declare module TypeScript.Services.Formatting {
- class Rule {
- public Descriptor: RuleDescriptor;
- public Operation: RuleOperation;
- public Flag: RuleFlags;
- constructor(Descriptor: RuleDescriptor, Operation: RuleOperation, Flag?: RuleFlags);
- public toString(): string;
- }
-}
-declare module TypeScript.Services.Formatting {
- enum RuleAction {
- Ignore = 0,
- Space = 1,
- NewLine = 2,
- Delete = 3,
- }
-}
-declare module TypeScript.Services.Formatting {
- class RuleDescriptor {
- public LeftTokenRange: Shared.TokenRange;
- public RightTokenRange: Shared.TokenRange;
- constructor(LeftTokenRange: Shared.TokenRange, RightTokenRange: Shared.TokenRange);
- public toString(): string;
- static create1(left: SyntaxKind, right: SyntaxKind): RuleDescriptor;
- static create2(left: Shared.TokenRange, right: SyntaxKind): RuleDescriptor;
- static create3(left: SyntaxKind, right: Shared.TokenRange): RuleDescriptor;
- static create4(left: Shared.TokenRange, right: Shared.TokenRange): RuleDescriptor;
- }
-}
-declare module TypeScript.Services.Formatting {
- enum RuleFlags {
- None = 0,
- CanDeleteNewLines = 1,
- }
-}
-declare module TypeScript.Services.Formatting {
- class RuleOperation {
- public Context: RuleOperationContext;
- public Action: RuleAction;
- constructor();
- public toString(): string;
- static create1(action: RuleAction): RuleOperation;
- static create2(context: RuleOperationContext, action: RuleAction): RuleOperation;
- }
-}
-declare module TypeScript.Services.Formatting {
- class RuleOperationContext {
- private customContextChecks;
- constructor(...funcs: {
- (context: FormattingContext): boolean;
- }[]);
- static Any: RuleOperationContext;
- public IsAny(): boolean;
- public InContext(context: FormattingContext): boolean;
- }
-}
-declare module TypeScript.Services.Formatting {
- class Rules {
- public getRuleName(rule: Rule): any;
- [name: string]: any;
- public IgnoreBeforeComment: Rule;
- public IgnoreAfterLineComment: Rule;
- public NoSpaceBeforeSemicolon: Rule;
- public NoSpaceBeforeColon: Rule;
- public NoSpaceBeforeQMark: Rule;
- public SpaceAfterColon: Rule;
- public SpaceAfterQMark: Rule;
- public SpaceAfterSemicolon: Rule;
- public SpaceAfterCloseBrace: Rule;
- public SpaceBetweenCloseBraceAndElse: Rule;
- public SpaceBetweenCloseBraceAndWhile: Rule;
- public NoSpaceAfterCloseBrace: Rule;
- public NoSpaceBeforeDot: Rule;
- public NoSpaceAfterDot: Rule;
- public NoSpaceBeforeOpenBracket: Rule;
- public NoSpaceAfterOpenBracket: Rule;
- public NoSpaceBeforeCloseBracket: Rule;
- public NoSpaceAfterCloseBracket: Rule;
- public SpaceAfterOpenBrace: Rule;
- public SpaceBeforeCloseBrace: Rule;
- public NoSpaceBetweenEmptyBraceBrackets: Rule;
- public NewLineAfterOpenBraceInBlockContext: Rule;
- public NewLineBeforeCloseBraceInBlockContext: Rule;
- public NoSpaceAfterUnaryPrefixOperator: Rule;
- public NoSpaceAfterUnaryPreincrementOperator: Rule;
- public NoSpaceAfterUnaryPredecrementOperator: Rule;
- public NoSpaceBeforeUnaryPostincrementOperator: Rule;
- public NoSpaceBeforeUnaryPostdecrementOperator: Rule;
- public SpaceAfterPostincrementWhenFollowedByAdd: Rule;
- public SpaceAfterAddWhenFollowedByUnaryPlus: Rule;
- public SpaceAfterAddWhenFollowedByPreincrement: Rule;
- public SpaceAfterPostdecrementWhenFollowedBySubtract: Rule;
- public SpaceAfterSubtractWhenFollowedByUnaryMinus: Rule;
- public SpaceAfterSubtractWhenFollowedByPredecrement: Rule;
- public NoSpaceBeforeComma: Rule;
- public SpaceAfterCertainKeywords: Rule;
- public NoSpaceBeforeOpenParenInFuncCall: Rule;
- public SpaceAfterFunctionInFuncDecl: Rule;
- public NoSpaceBeforeOpenParenInFuncDecl: Rule;
- public SpaceAfterVoidOperator: Rule;
- public NoSpaceBetweenReturnAndSemicolon: Rule;
- public SpaceBetweenStatements: Rule;
- public SpaceAfterTryFinally: Rule;
- public SpaceAfterGetSetInMember: Rule;
- public SpaceBeforeBinaryKeywordOperator: Rule;
- public SpaceAfterBinaryKeywordOperator: Rule;
- public NoSpaceAfterConstructor: Rule;
- public NoSpaceAfterModuleImport: Rule;
- public SpaceAfterCertainTypeScriptKeywords: Rule;
- public SpaceBeforeCertainTypeScriptKeywords: Rule;
- public SpaceAfterModuleName: Rule;
- public SpaceAfterArrow: Rule;
- public NoSpaceAfterEllipsis: Rule;
- public NoSpaceAfterOptionalParameters: Rule;
- public NoSpaceBeforeOpenAngularBracket: Rule;
- public NoSpaceBetweenCloseParenAndAngularBracket: Rule;
- public NoSpaceAfterOpenAngularBracket: Rule;
- public NoSpaceBeforeCloseAngularBracket: Rule;
- public NoSpaceAfterCloseAngularBracket: Rule;
- public NoSpaceBetweenEmptyInterfaceBraceBrackets: Rule;
- public HighPriorityCommonRules: Rule[];
- public LowPriorityCommonRules: Rule[];
- public SpaceAfterComma: Rule;
- public NoSpaceAfterComma: Rule;
- public SpaceBeforeBinaryOperator: Rule;
- public SpaceAfterBinaryOperator: Rule;
- public NoSpaceBeforeBinaryOperator: Rule;
- public NoSpaceAfterBinaryOperator: Rule;
- public SpaceAfterKeywordInControl: Rule;
- public NoSpaceAfterKeywordInControl: Rule;
- public FunctionOpenBraceLeftTokenRange: Shared.TokenRange;
- public SpaceBeforeOpenBraceInFunction: Rule;
- public NewLineBeforeOpenBraceInFunction: Rule;
- public TypeScriptOpenBraceLeftTokenRange: Shared.TokenRange;
- public SpaceBeforeOpenBraceInTypeScriptDeclWithBlock: Rule;
- public NewLineBeforeOpenBraceInTypeScriptDeclWithBlock: Rule;
- public ControlOpenBraceLeftTokenRange: Shared.TokenRange;
- public SpaceBeforeOpenBraceInControl: Rule;
- public NewLineBeforeOpenBraceInControl: Rule;
- public SpaceAfterSemicolonInFor: Rule;
- public NoSpaceAfterSemicolonInFor: Rule;
- public SpaceAfterOpenParen: Rule;
- public SpaceBeforeCloseParen: Rule;
- public NoSpaceBetweenParens: Rule;
- public NoSpaceAfterOpenParen: Rule;
- public NoSpaceBeforeCloseParen: Rule;
- public SpaceAfterAnonymousFunctionKeyword: Rule;
- public NoSpaceAfterAnonymousFunctionKeyword: Rule;
- constructor();
- static IsForContext(context: FormattingContext): boolean;
- static IsNotForContext(context: FormattingContext): boolean;
- static IsBinaryOpContext(context: FormattingContext): boolean;
- static IsNotBinaryOpContext(context: FormattingContext): boolean;
- static IsSameLineTokenOrBeforeMultilineBlockContext(context: FormattingContext): boolean;
- static IsBeforeMultilineBlockContext(context: FormattingContext): boolean;
- static IsMultilineBlockContext(context: FormattingContext): boolean;
- static IsSingleLineBlockContext(context: FormattingContext): boolean;
- static IsBlockContext(context: FormattingContext): boolean;
- static IsBeforeBlockContext(context: FormattingContext): boolean;
- static NodeIsBlockContext(node: IndentationNodeContext): boolean;
- static IsFunctionDeclContext(context: FormattingContext): boolean;
- static IsTypeScriptDeclWithBlockContext(context: FormattingContext): boolean;
- static NodeIsTypeScriptDeclWithBlockContext(node: IndentationNodeContext): boolean;
- static IsAfterCodeBlockContext(context: FormattingContext): boolean;
- static IsControlDeclContext(context: FormattingContext): boolean;
- static IsObjectContext(context: FormattingContext): boolean;
- static IsFunctionCallContext(context: FormattingContext): boolean;
- static IsNewContext(context: FormattingContext): boolean;
- static IsFunctionCallOrNewContext(context: FormattingContext): boolean;
- static IsSameLineTokenContext(context: FormattingContext): boolean;
- static IsNotFormatOnEnter(context: FormattingContext): boolean;
- static IsModuleDeclContext(context: FormattingContext): boolean;
- static IsObjectTypeContext(context: FormattingContext): boolean;
- static IsTypeArgumentOrParameter(tokenKind: SyntaxKind, parentKind: SyntaxKind): boolean;
- static IsTypeArgumentOrParameterContext(context: FormattingContext): boolean;
- static IsVoidOpContext(context: FormattingContext): boolean;
- }
-}
-declare module TypeScript.Services.Formatting {
- class RulesMap {
- public map: RulesBucket[];
- public mapRowLength: number;
- constructor();
- static create(rules: Rule[]): RulesMap;
- public Initialize(rules: Rule[]): RulesBucket[];
- public FillRules(rules: Rule[], rulesBucketConstructionStateList: RulesBucketConstructionState[]): void;
- private GetRuleBucketIndex(row, column);
- private FillRule(rule, rulesBucketConstructionStateList);
- public GetRule(context: FormattingContext): Rule;
- }
- enum RulesPosition {
- IgnoreRulesSpecific = 0,
- IgnoreRulesAny,
- ContextRulesSpecific,
- ContextRulesAny,
- NoContextRulesSpecific,
- NoContextRulesAny,
- }
- class RulesBucketConstructionState {
- private rulesInsertionIndexBitmap;
- constructor();
- public GetInsertionIndex(maskPosition: RulesPosition): number;
- public IncreaseInsertionIndex(maskPosition: RulesPosition): void;
- }
- class RulesBucket {
- private rules;
- constructor();
- public Rules(): Rule[];
- public AddRule(rule: Rule, specificTokens: boolean, constructionState: RulesBucketConstructionState[], rulesBucketIndex: number): void;
- }
-}
-declare module TypeScript.Services.Formatting {
- class RulesProvider {
- private logger;
- private globalRules;
- private options;
- private activeRules;
- private rulesMap;
- constructor(logger: ILogger);
- public getRuleName(rule: Rule): string;
- public getRuleByName(name: string): Rule;
- public getRulesMap(): RulesMap;
- public ensureUpToDate(options: FormatCodeOptions): void;
- private createActiveRules(options);
- }
-}
-declare module TypeScript.Services.Formatting {
- class TextEditInfo {
- public position: number;
- public length: number;
- public replaceWith: string;
- constructor(position: number, length: number, replaceWith: string);
- public toString(): string;
- }
-}
-declare module TypeScript.Services.Formatting {
- module Shared {
- interface ITokenAccess {
- GetTokens(): SyntaxKind[];
- Contains(token: SyntaxKind): boolean;
- }
- class TokenRangeAccess implements ITokenAccess {
- private tokens;
- constructor(from: SyntaxKind, to: SyntaxKind, except: SyntaxKind[]);
- public GetTokens(): SyntaxKind[];
- public Contains(token: SyntaxKind): boolean;
- public toString(): string;
- }
- class TokenValuesAccess implements ITokenAccess {
- private tokens;
- constructor(tks: SyntaxKind[]);
- public GetTokens(): SyntaxKind[];
- public Contains(token: SyntaxKind): boolean;
- }
- class TokenSingleValueAccess implements ITokenAccess {
- public token: SyntaxKind;
- constructor(token: SyntaxKind);
- public GetTokens(): SyntaxKind[];
- public Contains(tokenValue: SyntaxKind): boolean;
- public toString(): string;
- }
- class TokenAllAccess implements ITokenAccess {
- public GetTokens(): SyntaxKind[];
- public Contains(tokenValue: SyntaxKind): boolean;
- public toString(): string;
- }
- class TokenRange {
- public tokenAccess: ITokenAccess;
- constructor(tokenAccess: ITokenAccess);
- static FromToken(token: SyntaxKind): TokenRange;
- static FromTokens(tokens: SyntaxKind[]): TokenRange;
- static FromRange(f: SyntaxKind, to: SyntaxKind, except?: SyntaxKind[]): TokenRange;
- static AllTokens(): TokenRange;
- public GetTokens(): SyntaxKind[];
- public Contains(token: SyntaxKind): boolean;
- public toString(): string;
- static Any: TokenRange;
- static AnyIncludingMultilineComments: TokenRange;
- static Keywords: TokenRange;
- static Operators: TokenRange;
- static BinaryOperators: TokenRange;
- static BinaryKeywordOperators: TokenRange;
- static ReservedKeywords: TokenRange;
- static UnaryPrefixOperators: TokenRange;
- static UnaryPrefixExpressions: TokenRange;
- static UnaryPreincrementExpressions: TokenRange;
- static UnaryPostincrementExpressions: TokenRange;
- static UnaryPredecrementExpressions: TokenRange;
- static UnaryPostdecrementExpressions: TokenRange;
- static Comments: TokenRange;
- static TypeNames: TokenRange;
- }
- }
-}
-declare module TypeScript.Services.Formatting {
- class TokenSpan extends TextSpan {
- private _kind;
- constructor(kind: SyntaxKind, start: number, length: number);
- public kind(): SyntaxKind;
- }
-}
-declare module TypeScript.Services.Formatting {
- class IndentationNodeContext {
- private _node;
- private _parent;
- private _fullStart;
- private _indentationAmount;
- private _childIndentationAmountDelta;
- private _depth;
- private _hasSkippedOrMissingTokenChild;
- constructor(parent: IndentationNodeContext, node: SyntaxNode, fullStart: number, indentationAmount: number, childIndentationAmountDelta: number);
- public parent(): IndentationNodeContext;
- public node(): SyntaxNode;
- public fullStart(): number;
- public fullWidth(): number;
- public start(): number;
- public end(): number;
- public indentationAmount(): number;
- public childIndentationAmountDelta(): number;
- public depth(): number;
- public kind(): SyntaxKind;
- public hasSkippedOrMissingTokenChild(): boolean;
- public clone(pool: IndentationNodeContextPool): IndentationNodeContext;
- public update(parent: IndentationNodeContext, node: SyntaxNode, fullStart: number, indentationAmount: number, childIndentationAmountDelta: number): void;
- }
-}
-declare module TypeScript.Services.Formatting {
- class IndentationNodeContextPool {
- private nodes;
- public getNode(parent: IndentationNodeContext, node: SyntaxNode, fullStart: number, indentationLevel: number, childIndentationLevelDelta: number): IndentationNodeContext;
- public releaseNode(node: IndentationNodeContext, recursive?: boolean): void;
- }
-}
-declare module TypeScript.Services.Formatting {
- class IndentationTrackingWalker extends SyntaxWalker {
- public options: FormattingOptions;
- private _position;
- private _parent;
- private _textSpan;
- private _snapshot;
- private _lastTriviaWasNewLine;
- private _indentationNodeContextPool;
- constructor(textSpan: TextSpan, sourceUnit: SourceUnitSyntax, snapshot: ITextSnapshot, indentFirstToken: boolean, options: FormattingOptions);
- public position(): number;
- public parent(): IndentationNodeContext;
- public textSpan(): TextSpan;
- public snapshot(): ITextSnapshot;
- public indentationNodeContextPool(): IndentationNodeContextPool;
- public forceIndentNextToken(tokenStart: number): void;
- public forceSkipIndentingNextToken(tokenStart: number): void;
- public indentToken(token: ISyntaxToken, indentationAmount: number, commentIndentationAmount: number): void;
- public visitTokenInSpan(token: ISyntaxToken): void;
- public visitToken(token: ISyntaxToken): void;
- public visitNode(node: SyntaxNode): void;
- private getTokenIndentationAmount(token);
- private getCommentIndentationAmount(token);
- private getNodeIndentation(node, newLineInsertedByFormatting?);
- private shouldIndentBlockInParent(parent);
- private forceRecomputeIndentationOfParent(tokenStart, newLineAdded);
- }
-}
-declare module TypeScript.Services.Formatting {
- class MultipleTokenIndenter extends IndentationTrackingWalker {
- private _edits;
- constructor(textSpan: TextSpan, sourceUnit: SourceUnitSyntax, snapshot: ITextSnapshot, indentFirstToken: boolean, options: FormattingOptions);
- public indentToken(token: ISyntaxToken, indentationAmount: number, commentIndentationAmount: number): void;
- public edits(): TextEditInfo[];
- public recordEdit(position: number, length: number, replaceWith: string): void;
- private recordIndentationEditsForToken(token, indentationString, commentIndentationString);
- private recordIndentationEditsForSingleLineOrSkippedText(trivia, fullStart, indentationString);
- private recordIndentationEditsForWhitespace(trivia, fullStart, indentationString);
- private recordIndentationEditsForMultiLineComment(trivia, fullStart, indentationString, leadingWhiteSpace, firstLineAlreadyIndented);
- private recordIndentationEditsForSegment(segment, fullStart, indentationColumns, whiteSpaceColumnsInFirstSegment);
- }
-}
-declare module TypeScript.Services.Formatting {
- class SingleTokenIndenter extends IndentationTrackingWalker {
- private indentationAmount;
- private indentationPosition;
- constructor(indentationPosition: number, sourceUnit: SourceUnitSyntax, snapshot: ITextSnapshot, indentFirstToken: boolean, options: FormattingOptions);
- static getIndentationAmount(position: number, sourceUnit: SourceUnitSyntax, snapshot: ITextSnapshot, options: FormattingOptions): number;
- public indentToken(token: ISyntaxToken, indentationAmount: number, commentIndentationAmount: number): void;
- }
-}
-declare module TypeScript.Services.Formatting {
- class Formatter extends MultipleTokenIndenter {
- private previousTokenSpan;
- private previousTokenParent;
- private scriptHasErrors;
- private rulesProvider;
- private formattingRequestKind;
- private formattingContext;
- constructor(textSpan: TextSpan, sourceUnit: SourceUnitSyntax, indentFirstToken: boolean, options: FormattingOptions, snapshot: ITextSnapshot, rulesProvider: RulesProvider, formattingRequestKind: FormattingRequestKind);
- static getEdits(textSpan: TextSpan, sourceUnit: SourceUnitSyntax, options: FormattingOptions, indentFirstToken: boolean, snapshot: ITextSnapshot, rulesProvider: RulesProvider, formattingRequestKind: FormattingRequestKind): TextEditInfo[];
- public visitTokenInSpan(token: ISyntaxToken): void;
- private processToken(token);
- private processTrivia(triviaList, fullStart);
- private findCommonParents(parent1, parent2);
- private formatPair(t1, t1Parent, t2, t2Parent);
- private getLineNumber(span);
- private trimWhitespaceInLineRange(startLine, endLine, token?);
- private trimWhitespace(line, token?);
- private RecordRuleEdits(rule, t1, t2);
- }
-}
-declare var debugObjectHost: any;
-declare module TypeScript.Services {
- interface ICoreServicesHost {
- logger: ILogger;
- }
- class CoreServices {
- public host: ICoreServicesHost;
- constructor(host: ICoreServicesHost);
- public getPreProcessedFileInfo(fileName: string, sourceText: IScriptSnapshot): IPreProcessedFileInfo;
- public getDefaultCompilationSettings(): CompilationSettings;
- public dumpMemory(): string;
- public getMemoryInfo(): any[];
- public collectGarbage(): void;
- }
-}
-declare module TypeScript.Services {
- class SyntaxTreeCache {
- private _host;
- private _hostCache;
- private _currentFileName;
- private _currentFileVersion;
- private _currentFileSyntaxTree;
- private _currentFileScriptSnapshot;
- constructor(_host: ILanguageServiceHost);
- public getCurrentFileSyntaxTree(fileName: string): SyntaxTree;
- private createSyntaxTree(fileName, scriptSnapshot);
- private updateSyntaxTree(fileName, scriptSnapshot, previousSyntaxTree, previousFileVersion);
- private ensureInvariants(fileName, editRange, incrementalTree, oldScriptSnapshot, newScriptSnapshot);
- }
- class LanguageServiceCompiler {
- private host;
- private logger;
- private compiler;
- private hostCache;
- constructor(host: ILanguageServiceHost);
- private synchronizeHostData();
- private synchronizeHostDataWorker();
- private tryUpdateFile(compiler, fileName);
- public getScriptSnapshot(fileName: string): IScriptSnapshot;
- public getCachedHostFileName(fileName: string): string;
- public getCachedTopLevelDeclaration(fileName: string): PullDecl;
- public compilationSettings(): ImmutableCompilationSettings;
- public fileNames(): string[];
- public cleanupSemanticCache(): void;
- public getDocument(fileName: string): Document;
- public getSyntacticDiagnostics(fileName: string): Diagnostic[];
- public getSemanticDiagnostics(fileName: string): Diagnostic[];
- public getCompilerOptionsDiagnostics(resolvePath: (path: string) => string): Diagnostic[];
- public getSymbolInformationFromAST(ast: AST, document: Document): PullSymbolInfo;
- public getCallInformationFromAST(ast: AST, document: Document): PullCallSymbolInfo;
- public getVisibleMemberSymbolsFromAST(ast: AST, document: Document): PullVisibleSymbolsInfo;
- public getVisibleDeclsFromAST(ast: AST, document: Document): PullDecl[];
- public getContextualMembersFromAST(ast: AST, document: Document): PullVisibleSymbolsInfo;
- public pullGetDeclInformation(decl: PullDecl, ast: AST, document: Document): PullSymbolInfo;
- public topLevelDeclaration(fileName: string): PullDecl;
- public getDeclForAST(ast: AST): PullDecl;
- public emit(fileName: string, resolvePath: (path: string) => string): EmitOutput;
- public emitDeclarations(fileName: string, resolvePath: (path: string) => string): EmitOutput;
- public canEmitDeclarations(fileName: string): boolean;
- }
-}
-declare module TypeScript.Services {
- class CompletionHelpers {
- private static getSpan(ast);
- private static symbolDeclarationIntersectsPosition(symbol, fileName, position);
- static filterContextualMembersList(contextualMemberSymbols: PullSymbol[], existingMembers: PullVisibleSymbolsInfo, fileName: string, position: number): PullSymbol[];
- static isCompletionListBlocker(sourceUnit: SourceUnitSyntax, position: number): boolean;
- static getContainingObjectLiteralApplicableForCompletion(sourceUnit: SourceUnitSyntax, position: number): PositionedElement;
- static isIdentifierDefinitionLocation(sourceUnit: SourceUnitSyntax, position: number): boolean;
- static getNonIdentifierCompleteTokenOnLeft(sourceUnit: SourceUnitSyntax, position: number): PositionedToken;
- static isRightOfIllegalDot(sourceUnit: SourceUnitSyntax, position: number): boolean;
- static getValidCompletionEntryDisplayName(displayName: string): string;
- }
-}
-declare module TypeScript.Services {
- class KeywordCompletions {
- private static keywords;
- private static keywordCompletions;
- static getKeywordCompltions(): ResolvedCompletionEntry[];
- }
-}
-declare module TypeScript.Services {
- interface IPartiallyWrittenTypeArgumentListInformation {
- genericIdentifer: PositionedToken;
- lessThanToken: PositionedToken;
- argumentIndex: number;
- }
- class SignatureInfoHelpers {
- static isInPartiallyWrittenTypeArgumentList(syntaxTree: SyntaxTree, position: number): IPartiallyWrittenTypeArgumentListInformation;
- static getSignatureInfoFromSignatureSymbol(symbol: PullSymbol, signatures: PullSignatureSymbol[], enclosingScopeSymbol: PullSymbol, compilerState: LanguageServiceCompiler): FormalSignatureItemInfo[];
- static getSignatureInfoFromGenericSymbol(symbol: PullSymbol, enclosingScopeSymbol: PullSymbol, compilerState: LanguageServiceCompiler): FormalSignatureItemInfo[];
- static getActualSignatureInfoFromCallExpression(ast: ICallExpression, caretPosition: number, typeParameterInformation: IPartiallyWrittenTypeArgumentListInformation): ActualSignatureInfo;
- static getActualSignatureInfoFromPartiallyWritenGenericExpression(caretPosition: number, typeParameterInformation: IPartiallyWrittenTypeArgumentListInformation): ActualSignatureInfo;
- static isSignatureHelpBlocker(sourceUnit: SourceUnitSyntax, position: number): boolean;
- static isTargetOfObjectCreationExpression(positionedToken: PositionedToken): boolean;
- private static moveBackUpTillMatchingTokenKind(token, tokenKind, matchingTokenKind);
- }
-}
-declare module TypeScript.Services {
- interface CachedCompletionEntryDetails extends CompletionEntryDetails {
- isResolved(): boolean;
- }
- class ResolvedCompletionEntry implements CachedCompletionEntryDetails {
- public name: string;
- public kind: string;
- public kindModifiers: string;
- public type: string;
- public fullSymbolName: string;
- public docComment: string;
- constructor(name: string, kind: string, kindModifiers: string, type: string, fullSymbolName: string, docComment: string);
- public isResolved(): boolean;
- }
- class DeclReferenceCompletionEntry implements CachedCompletionEntryDetails {
- public name: string;
- public kind: string;
- public kindModifiers: string;
- public decl: PullDecl;
- public type: string;
- public fullSymbolName: string;
- public docComment: string;
- private hasBeenResolved;
- constructor(name: string, kind: string, kindModifiers: string, decl: PullDecl);
- public isResolved(): boolean;
- public resolve(type: string, fullSymbolName: string, docComments: string): void;
- }
- class CompletionSession {
- public fileName: string;
- public position: number;
- public entries: IdentiferNameHashTable<CachedCompletionEntryDetails>;
- constructor(fileName: string, position: number, entries: IdentiferNameHashTable<CachedCompletionEntryDetails>);
- }
-}
-declare module TypeScript.Services {
- class LanguageService implements ILanguageService {
- public host: ILanguageServiceHost;
- private logger;
- private compiler;
- private _syntaxTreeCache;
- private formattingRulesProvider;
- private activeCompletionSession;
- constructor(host: ILanguageServiceHost);
- public cleanupSemanticCache(): void;
- public refresh(): void;
- private getSymbolInfoAtPosition(fileName, pos, requireName);
- public getReferencesAtPosition(fileName: string, pos: number): ReferenceEntry[];
- private getSymbolScopeAST(symbol, ast);
- public getOccurrencesAtPosition(fileName: string, pos: number): ReferenceEntry[];
- private getSingleNodeReferenceAtPosition(fileName, position);
- public getImplementorsAtPosition(fileName: string, pos: number): ReferenceEntry[];
- public getOverrides(container: PullTypeSymbol, memberSym: PullSymbol): PullTypeSymbol[];
- private getImplementorsInFile(fileName, symbol);
- private getReferencesInFile(fileName, symbol, containingASTOpt);
- private isWriteAccess(current);
- private isLetterOrDigit(char);
- private getPossibleSymbolReferencePositions(fileName, symbolName);
- public getSignatureAtPosition(fileName: string, position: number): SignatureInfo;
- private getTypeParameterSignatureFromPartiallyWrittenExpression(document, position, genericTypeArgumentListInfo);
- public getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
- private addDeclarations(symbolKind, symbolName, containerKind, containerName, declarations, result);
- private addDeclaration(symbolKind, symbolName, containerKind, containerName, declaration, result);
- private tryAddDefinition(symbolKind, symbolName, containerKind, containerName, declarations, result);
- private tryAddSignatures(symbolKind, symbolName, containerKind, containerName, declarations, result);
- private tryAddConstructor(symbolKind, symbolName, containerKind, containerName, declarations, result);
- public getNavigateToItems(searchValue: string): NavigateToItem[];
- private hasAnyUpperCaseCharacter(s);
- private findSearchValueInPullDecl(fileName, declarations, results, searchTerms, parentName?, parentkindName?);
- private getScriptElementKindModifiersFromDecl(decl);
- private isContainerDeclaration(declaration);
- private shouldIncludeDeclarationInNavigationItems(declaration);
- public getSyntacticDiagnostics(fileName: string): Diagnostic[];
- public getSemanticDiagnostics(fileName: string): Diagnostic[];
- private _getHostSpecificDiagnosticWithFileName(diagnostic);
- public getCompilerOptionsDiagnostics(): Diagnostic[];
- private _getHostFileName(fileName);
- public getEmitOutput(fileName: string): EmitOutput;
- private getAllSyntacticDiagnostics();
- private getAllSemanticDiagnostics();
- private containErrors(diagnostics);
- private getFullNameOfSymbol(symbol, enclosingScopeSymbol);
- private getTypeInfoEligiblePath(fileName, position, isConstructorValidPosition);
- public getTypeAtPosition(fileName: string, position: number): TypeInfo;
- public getCompletionsAtPosition(fileName: string, position: number, isMemberCompletion: boolean): CompletionInfo;
- private getCompletionEntriesFromSymbols(symbolInfo, result);
- private getCompletionEntriesFromDecls(decls, result);
- private getResolvedCompletionEntryDetailsFromSymbol(symbol, enclosingScopeSymbol);
- private getCompletionEntriesForKeywords(keywords, result);
- public getCompletionEntryDetails(fileName: string, position: number, entryName: string): CompletionEntryDetails;
- private tryFindDeclFromPreviousCompilerVersion(invalidatedDecl);
- private getModuleOrEnumKind(symbol);
- private mapPullElementKind(kind, symbol?, useConstructorAsClass?, varIsFunction?, functionIsConstructor?);
- private getScriptElementKindModifiers(symbol);
- private getScriptElementKindModifiersFromFlags(flags);
- public getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): SpanInfo;
- public getBreakpointStatementAtPosition(fileName: string, pos: number): SpanInfo;
- public getFormattingEditsForRange(fileName: string, minChar: number, limChar: number, options: FormatCodeOptions): TextEdit[];
- public getFormattingEditsForDocument(fileName: string, minChar: number, limChar: number, options: FormatCodeOptions): TextEdit[];
- public getFormattingEditsOnPaste(fileName: string, minChar: number, limChar: number, options: FormatCodeOptions): TextEdit[];
- public getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions): TextEdit[];
- private getFormattingManager(fileName, options);
- public getOutliningRegions(fileName: string): TextSpan[];
- public getIndentationAtPosition(fileName: string, position: number, editorOptions: EditorOptions): number;
- public getBraceMatchingAtPosition(fileName: string, position: number): TextSpan[];
- public getScriptLexicalStructure(fileName: string): NavigateToItem[];
- public getSyntaxTree(fileName: string): SyntaxTree;
- }
-}
-declare module TypeScript.Services {
- class FindReferenceHelpers {
- static compareSymbolsForLexicalIdentity(firstSymbol: PullSymbol, secondSymbol: PullSymbol): boolean;
- private static checkSymbolsForDeclarationEquality(firstSymbol, secondSymbol);
- private static declarationsAreSameOrParents(firstDecl, secondDecl);
- }
-}
-declare module TypeScript.Services {
- interface IScriptSnapshotShim {
- getText(start: number, end: number): string;
- getLength(): number;
- getLineStartPositions(): string;
- getTextChangeRangeSinceVersion(scriptVersion: number): string;
- }
- interface ILanguageServiceShimHost extends ILogger {
- getCompilationSettings(): string;
- getScriptFileNames(): string;
- getScriptVersion(fileName: string): number;
- getScriptIsOpen(fileName: string): boolean;
- getScriptByteOrderMark(fileName: string): number;
- getScriptSnapshot(fileName: string): IScriptSnapshotShim;
- resolveRelativePath(path: string, directory: string): string;
- fileExists(path: string): boolean;
- directoryExists(path: string): boolean;
- getParentDirectory(path: string): string;
- getDiagnosticsObject(): ILanguageServicesDiagnostics;
- getLocalizedDiagnosticMessages(): string;
- }
- interface IShimFactory {
- registerShim(shim: IShim): void;
- unregisterShim(shim: IShim): void;
- }
- interface IShim {
- dispose(dummy: any): void;
- }
- class ShimBase implements IShim {
- private factory;
- constructor(factory: IShimFactory);
- public dispose(dummy: any): void;
- }
- interface ILanguageServiceShim extends IShim {
- languageService: ILanguageService;
- dispose(dummy: any): void;
- refresh(throwOnError: boolean): void;
- cleanupSemanticCache(): void;
- getSyntacticDiagnostics(fileName: string): string;
- getSemanticDiagnostics(fileName: string): string;
- getCompilerOptionsDiagnostics(): string;
- getCompletionsAtPosition(fileName: string, position: number, isMemberCompletion: boolean): string;
- getCompletionEntryDetails(fileName: string, position: number, entryName: string): string;
- getTypeAtPosition(fileName: string, position: number): string;
- getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): string;
- getBreakpointStatementAtPosition(fileName: string, position: number): string;
- getSignatureAtPosition(fileName: string, position: number): string;
- getDefinitionAtPosition(fileName: string, position: number): string;
- getReferencesAtPosition(fileName: string, position: number): string;
- getOccurrencesAtPosition(fileName: string, position: number): string;
- getImplementorsAtPosition(fileName: string, position: number): string;
- getNavigateToItems(searchValue: string): string;
- getScriptLexicalStructure(fileName: string): string;
- getOutliningRegions(fileName: string): string;
- getBraceMatchingAtPosition(fileName: string, position: number): string;
- getIndentationAtPosition(fileName: string, position: number, options: string): string;
- getFormattingEditsForRange(fileName: string, minChar: number, limChar: number, options: string): string;
- getFormattingEditsForDocument(fileName: string, minChar: number, limChar: number, options: string): string;
- getFormattingEditsOnPaste(fileName: string, minChar: number, limChar: number, options: string): string;
- getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: string): string;
- getEmitOutput(fileName: string): string;
- }
- class LanguageServiceShimHostAdapter implements ILanguageServiceHost {
- private shimHost;
- constructor(shimHost: ILanguageServiceShimHost);
- public information(): boolean;
- public debug(): boolean;
- public warning(): boolean;
- public error(): boolean;
- public fatal(): boolean;
- public log(s: string): void;
- public getCompilationSettings(): CompilationSettings;
- public getScriptFileNames(): string[];
- public getScriptSnapshot(fileName: string): IScriptSnapshot;
- public getScriptVersion(fileName: string): number;
- public getScriptIsOpen(fileName: string): boolean;
- public getScriptByteOrderMark(fileName: string): ByteOrderMark;
- public getDiagnosticsObject(): ILanguageServicesDiagnostics;
- public getLocalizedDiagnosticMessages(): any;
- public resolveRelativePath(path: string, directory: string): string;
- public fileExists(path: string): boolean;
- public directoryExists(path: string): boolean;
- public getParentDirectory(path: string): string;
- }
- function simpleForwardCall(logger: ILogger, actionDescription: string, action: () => any): any;
- function forwardJSONCall(logger: ILogger, actionDescription: string, action: () => any): string;
- class LanguageServiceShim extends ShimBase implements ILanguageServiceShim {
- private host;
- public languageService: ILanguageService;
- private logger;
- constructor(factory: IShimFactory, host: ILanguageServiceShimHost, languageService: ILanguageService);
- public forwardJSONCall(actionDescription: string, action: () => any): string;
- public dispose(dummy: any): void;
- public refresh(throwOnError: boolean): void;
- public cleanupSemanticCache(): void;
- private static realizeDiagnosticCategory(category);
- private static realizeDiagnostic(diagnostic);
- private realizeDiagnosticWithFileName(diagnostic);
- public getSyntacticDiagnostics(fileName: string): string;
- public getSemanticDiagnostics(fileName: string): string;
- public getCompilerOptionsDiagnostics(): string;
- public getTypeAtPosition(fileName: string, position: number): string;
- public getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): string;
- public getBreakpointStatementAtPosition(fileName: string, position: number): string;
- public getSignatureAtPosition(fileName: string, position: number): string;
- public getDefinitionAtPosition(fileName: string, position: number): string;
- public getBraceMatchingAtPosition(fileName: string, position: number): string;
- public getIndentationAtPosition(fileName: string, position: number, options: string): string;
- public getReferencesAtPosition(fileName: string, position: number): string;
- public getOccurrencesAtPosition(fileName: string, position: number): string;
- public getImplementorsAtPosition(fileName: string, position: number): string;
- public getCompletionsAtPosition(fileName: string, position: number, isMemberCompletion: boolean): string;
- public getCompletionEntryDetails(fileName: string, position: number, entryName: string): string;
- public getFormattingEditsForRange(fileName: string, minChar: number, limChar: number, options: string): string;
- public getFormattingEditsForDocument(fileName: string, minChar: number, limChar: number, options: string): string;
- public getFormattingEditsOnPaste(fileName: string, minChar: number, limChar: number, options: string): string;
- public getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: string): string;
- public getNavigateToItems(searchValue: string): string;
- public getScriptLexicalStructure(fileName: string): string;
- public getOutliningRegions(fileName: string): string;
- public getEmitOutput(fileName: string): string;
- private _navigateToItemsToString(items);
- }
- class ClassifierShim extends ShimBase {
- public host: IClassifierHost;
- public classifier: Classifier;
- constructor(factory: IShimFactory, host: IClassifierHost);
- public getClassificationsForLine(text: string, lexState: EndOfLineState): string;
- }
- class CoreServicesShim extends ShimBase {
- public host: ICoreServicesHost;
- public logger: ILogger;
- public services: CoreServices;
- constructor(factory: IShimFactory, host: ICoreServicesHost);
- private forwardJSONCall(actionDescription, action);
- public getPreProcessedFileInfo(fileName: string, sourceText: IScriptSnapshot): string;
- public getDefaultCompilationSettings(): string;
- public dumpMemory(dummy: any): string;
- public getMemoryInfo(dummy: any): string;
- }
-}
-declare module TypeScript.Services {
- class OutliningElementsCollector extends DepthLimitedWalker {
- private static MaximumDepth;
- private inObjectLiteralExpression;
- private elements;
- constructor();
- public visitClassDeclaration(node: ClassDeclarationSyntax): void;
- public visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): void;
- public visitModuleDeclaration(node: ModuleDeclarationSyntax): void;
- public visitEnumDeclaration(node: EnumDeclarationSyntax): void;
- public visitFunctionDeclaration(node: FunctionDeclarationSyntax): void;
- public visitFunctionExpression(node: FunctionExpressionSyntax): void;
- public visitConstructorDeclaration(node: ConstructorDeclarationSyntax): void;
- public visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): void;
- public visitGetAccessor(node: GetAccessorSyntax): void;
- public visitSetAccessor(node: SetAccessorSyntax): void;
- public visitObjectLiteralExpression(node: ObjectLiteralExpressionSyntax): void;
- private addOutlineRange(node, startElement, endElement);
- static collectElements(node: SourceUnitSyntax): TextSpan[];
- }
-}
-declare module TypeScript.Services {
- class Indenter {
- static getIndentation(node: SourceUnitSyntax, soruceText: IScriptSnapshot, position: number, editorOptions: EditorOptions): number;
- private static belongsToBracket(sourceText, token, position);
- private static isInContainerNode(parent, element);
- private static getCustomListIndentation(list, element);
- private static getListItemIndentation(list, elementIndex);
- }
-}
-declare module TypeScript.Services.Breakpoints {
- function getBreakpointLocation(syntaxTree: SyntaxTree, askedPos: number): SpanInfo;
-}
-declare module TypeScript.Services {
- class GetScriptLexicalStructureWalker extends PositionTrackingWalker {
- private fileName;
- private nameStack;
- private kindStack;
- private currentMemberVariableDeclaration;
- private currentVariableStatement;
- private currentInterfaceDeclaration;
- private parentScopes;
- private currentScope;
- private createScope();
- private pushNewContainerScope(containerName, kind);
- private popScope();
- constructor(fileName: string);
- private collectItems(items, scope?);
- static getListsOfAllScriptLexicalStructure(items: NavigateToItem[], fileName: string, unit: SourceUnitSyntax): void;
- private createItem(node, modifiers, kind, name);
- private addAdditionalSpan(node, key);
- private getKindModifiers(modifiers);
- public visitModuleDeclaration(node: ModuleDeclarationSyntax): void;
- private visitModuleDeclarationWorker(node, names, nameIndex);
- private getModuleNames(node);
- private getModuleNamesHelper(name, result);
- public visitClassDeclaration(node: ClassDeclarationSyntax): void;
- public visitInterfaceDeclaration(node: InterfaceDeclarationSyntax): void;
- public visitObjectType(node: ObjectTypeSyntax): void;
- public visitEnumDeclaration(node: EnumDeclarationSyntax): void;
- public visitConstructorDeclaration(node: ConstructorDeclarationSyntax): void;
- public visitMemberFunctionDeclaration(node: MemberFunctionDeclarationSyntax): void;
- public visitGetAccessor(node: GetAccessorSyntax): void;
- public visitSetAccessor(node: SetAccessorSyntax): void;
- public visitMemberVariableDeclaration(node: MemberVariableDeclarationSyntax): void;
- public visitVariableStatement(node: VariableStatementSyntax): void;
- public visitVariableDeclarator(node: VariableDeclaratorSyntax): void;
- public visitIndexSignature(node: IndexSignatureSyntax): void;
- public visitEnumElement(node: EnumElementSyntax): void;
- public visitCallSignature(node: CallSignatureSyntax): void;
- public visitConstructSignature(node: ConstructSignatureSyntax): void;
- public visitMethodSignature(node: MethodSignatureSyntax): void;
- public visitPropertySignature(node: PropertySignatureSyntax): void;
- public visitFunctionDeclaration(node: FunctionDeclarationSyntax): void;
- public visitBlock(node: BlockSyntax): void;
- public visitIfStatement(node: IfStatementSyntax): void;
- public visitExpressionStatement(node: ExpressionStatementSyntax): void;
- public visitThrowStatement(node: ThrowStatementSyntax): void;
- public visitReturnStatement(node: ReturnStatementSyntax): void;
- public visitSwitchStatement(node: SwitchStatementSyntax): void;
- public visitWithStatement(node: WithStatementSyntax): void;
- public visitTryStatement(node: TryStatementSyntax): void;
- public visitLabeledStatement(node: LabeledStatementSyntax): void;
- }
-}
-declare module TypeScript.Services {
- function copyDataObject(dst: any, src: any): any;
- class TypeScriptServicesFactory implements IShimFactory {
- private _shims;
- public createPullLanguageService(host: ILanguageServiceHost): ILanguageService;
- public createLanguageServiceShim(host: ILanguageServiceShimHost): ILanguageServiceShim;
- public createClassifier(host: IClassifierHost): Classifier;
- public createClassifierShim(host: IClassifierHost): ClassifierShim;
- public createCoreServices(host: ICoreServicesHost): CoreServices;
- public createCoreServicesShim(host: ICoreServicesHost): CoreServicesShim;
- public close(): void;
- public registerShim(shim: IShim): void;
- public unregisterShim(shim: IShim): void;
- }
-}
-declare module TypeScript.Services {
- class BraceMatcher {
- static getMatchSpans(syntaxTree: SyntaxTree, position: number): TextSpan[];
- private static getMatchingCloseBrace(currentToken, position, result);
- private static getMatchingOpenBrace(currentToken, position, result);
- private static getMatchingCloseBraceTokenKind(positionedElement);
- private static getMatchingOpenBraceTokenKind(positionedElement);
- }
-}
-
-declare module 'typescript-services' {
- export = TypeScript;
-}
+// Type definitions for TypeScript API v0.4.0
+// Project: http://www.typescriptlang.org/
+// Definitions by: Microsoft TypeScript <http://typescriptlang.org>
+// 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.
+***************************************************************************** */
+
+declare namespace ts {
+ interface Map<T> {
+ [index: string]: T;
+ }
+ interface FileMap<T> {
+ get(fileName: string): T;
+ set(fileName: string, value: T): void;
+ contains(fileName: string): boolean;
+ remove(fileName: string): void;
+ forEachValue(f: (v: T) => void): void;
+ clear(): void;
+ }
+ interface TextRange {
+ pos: number;
+ end: number;
+ }
+ const enum SyntaxKind {
+ Unknown = 0,
+ EndOfFileToken = 1,
+ SingleLineCommentTrivia = 2,
+ MultiLineCommentTrivia = 3,
+ NewLineTrivia = 4,
+ WhitespaceTrivia = 5,
+ ShebangTrivia = 6,
+ ConflictMarkerTrivia = 7,
+ NumericLiteral = 8,
+ StringLiteral = 9,
+ RegularExpressionLiteral = 10,
+ NoSubstitutionTemplateLiteral = 11,
+ TemplateHead = 12,
+ TemplateMiddle = 13,
+ TemplateTail = 14,
+ OpenBraceToken = 15,
+ CloseBraceToken = 16,
+ OpenParenToken = 17,
+ CloseParenToken = 18,
+ OpenBracketToken = 19,
+ CloseBracketToken = 20,
+ DotToken = 21,
+ DotDotDotToken = 22,
+ SemicolonToken = 23,
+ CommaToken = 24,
+ LessThanToken = 25,
+ LessThanSlashToken = 26,
+ GreaterThanToken = 27,
+ LessThanEqualsToken = 28,
+ GreaterThanEqualsToken = 29,
+ EqualsEqualsToken = 30,
+ ExclamationEqualsToken = 31,
+ EqualsEqualsEqualsToken = 32,
+ ExclamationEqualsEqualsToken = 33,
+ EqualsGreaterThanToken = 34,
+ PlusToken = 35,
+ MinusToken = 36,
+ AsteriskToken = 37,
+ SlashToken = 38,
+ PercentToken = 39,
+ PlusPlusToken = 40,
+ MinusMinusToken = 41,
+ LessThanLessThanToken = 42,
+ GreaterThanGreaterThanToken = 43,
+ GreaterThanGreaterThanGreaterThanToken = 44,
+ AmpersandToken = 45,
+ BarToken = 46,
+ CaretToken = 47,
+ ExclamationToken = 48,
+ TildeToken = 49,
+ AmpersandAmpersandToken = 50,
+ BarBarToken = 51,
+ QuestionToken = 52,
+ ColonToken = 53,
+ AtToken = 54,
+ EqualsToken = 55,
+ PlusEqualsToken = 56,
+ MinusEqualsToken = 57,
+ AsteriskEqualsToken = 58,
+ SlashEqualsToken = 59,
+ PercentEqualsToken = 60,
+ LessThanLessThanEqualsToken = 61,
+ GreaterThanGreaterThanEqualsToken = 62,
+ GreaterThanGreaterThanGreaterThanEqualsToken = 63,
+ AmpersandEqualsToken = 64,
+ BarEqualsToken = 65,
+ CaretEqualsToken = 66,
+ Identifier = 67,
+ BreakKeyword = 68,
+ CaseKeyword = 69,
+ CatchKeyword = 70,
+ ClassKeyword = 71,
+ ConstKeyword = 72,
+ ContinueKeyword = 73,
+ DebuggerKeyword = 74,
+ DefaultKeyword = 75,
+ DeleteKeyword = 76,
+ DoKeyword = 77,
+ ElseKeyword = 78,
+ EnumKeyword = 79,
+ ExportKeyword = 80,
+ ExtendsKeyword = 81,
+ FalseKeyword = 82,
+ FinallyKeyword = 83,
+ ForKeyword = 84,
+ FunctionKeyword = 85,
+ IfKeyword = 86,
+ ImportKeyword = 87,
+ InKeyword = 88,
+ InstanceOfKeyword = 89,
+ NewKeyword = 90,
+ NullKeyword = 91,
+ ReturnKeyword = 92,
+ SuperKeyword = 93,
+ SwitchKeyword = 94,
+ ThisKeyword = 95,
+ ThrowKeyword = 96,
+ TrueKeyword = 97,
+ TryKeyword = 98,
+ TypeOfKeyword = 99,
+ VarKeyword = 100,
+ VoidKeyword = 101,
+ WhileKeyword = 102,
+ WithKeyword = 103,
+ ImplementsKeyword = 104,
+ InterfaceKeyword = 105,
+ LetKeyword = 106,
+ PackageKeyword = 107,
+ PrivateKeyword = 108,
+ ProtectedKeyword = 109,
+ PublicKeyword = 110,
+ StaticKeyword = 111,
+ YieldKeyword = 112,
+ AbstractKeyword = 113,
+ AsKeyword = 114,
+ AnyKeyword = 115,
+ AsyncKeyword = 116,
+ AwaitKeyword = 117,
+ BooleanKeyword = 118,
+ ConstructorKeyword = 119,
+ DeclareKeyword = 120,
+ GetKeyword = 121,
+ IsKeyword = 122,
+ ModuleKeyword = 123,
+ NamespaceKeyword = 124,
+ RequireKeyword = 125,
+ NumberKeyword = 126,
+ SetKeyword = 127,
+ StringKeyword = 128,
+ SymbolKeyword = 129,
+ TypeKeyword = 130,
+ FromKeyword = 131,
+ OfKeyword = 132,
+ QualifiedName = 133,
+ ComputedPropertyName = 134,
+ TypeParameter = 135,
+ Parameter = 136,
+ Decorator = 137,
+ PropertySignature = 138,
+ PropertyDeclaration = 139,
+ MethodSignature = 140,
+ MethodDeclaration = 141,
+ Constructor = 142,
+ GetAccessor = 143,
+ SetAccessor = 144,
+ CallSignature = 145,
+ ConstructSignature = 146,
+ IndexSignature = 147,
+ TypePredicate = 148,
+ TypeReference = 149,
+ FunctionType = 150,
+ ConstructorType = 151,
+ TypeQuery = 152,
+ TypeLiteral = 153,
+ ArrayType = 154,
+ TupleType = 155,
+ UnionType = 156,
+ IntersectionType = 157,
+ ParenthesizedType = 158,
+ ObjectBindingPattern = 159,
+ ArrayBindingPattern = 160,
+ BindingElement = 161,
+ ArrayLiteralExpression = 162,
+ ObjectLiteralExpression = 163,
+ PropertyAccessExpression = 164,
+ ElementAccessExpression = 165,
+ CallExpression = 166,
+ NewExpression = 167,
+ TaggedTemplateExpression = 168,
+ TypeAssertionExpression = 169,
+ ParenthesizedExpression = 170,
+ FunctionExpression = 171,
+ ArrowFunction = 172,
+ DeleteExpression = 173,
+ TypeOfExpression = 174,
+ VoidExpression = 175,
+ AwaitExpression = 176,
+ PrefixUnaryExpression = 177,
+ PostfixUnaryExpression = 178,
+ BinaryExpression = 179,
+ ConditionalExpression = 180,
+ TemplateExpression = 181,
+ YieldExpression = 182,
+ SpreadElementExpression = 183,
+ ClassExpression = 184,
+ OmittedExpression = 185,
+ ExpressionWithTypeArguments = 186,
+ AsExpression = 187,
+ TemplateSpan = 188,
+ SemicolonClassElement = 189,
+ Block = 190,
+ VariableStatement = 191,
+ EmptyStatement = 192,
+ ExpressionStatement = 193,
+ IfStatement = 194,
+ DoStatement = 195,
+ WhileStatement = 196,
+ ForStatement = 197,
+ ForInStatement = 198,
+ ForOfStatement = 199,
+ ContinueStatement = 200,
+ BreakStatement = 201,
+ ReturnStatement = 202,
+ WithStatement = 203,
+ SwitchStatement = 204,
+ LabeledStatement = 205,
+ ThrowStatement = 206,
+ TryStatement = 207,
+ DebuggerStatement = 208,
+ VariableDeclaration = 209,
+ VariableDeclarationList = 210,
+ FunctionDeclaration = 211,
+ ClassDeclaration = 212,
+ InterfaceDeclaration = 213,
+ TypeAliasDeclaration = 214,
+ EnumDeclaration = 215,
+ ModuleDeclaration = 216,
+ ModuleBlock = 217,
+ CaseBlock = 218,
+ ImportEqualsDeclaration = 219,
+ ImportDeclaration = 220,
+ ImportClause = 221,
+ NamespaceImport = 222,
+ NamedImports = 223,
+ ImportSpecifier = 224,
+ ExportAssignment = 225,
+ ExportDeclaration = 226,
+ NamedExports = 227,
+ ExportSpecifier = 228,
+ MissingDeclaration = 229,
+ ExternalModuleReference = 230,
+ JsxElement = 231,
+ JsxSelfClosingElement = 232,
+ JsxOpeningElement = 233,
+ JsxText = 234,
+ JsxClosingElement = 235,
+ JsxAttribute = 236,
+ JsxSpreadAttribute = 237,
+ JsxExpression = 238,
+ CaseClause = 239,
+ DefaultClause = 240,
+ HeritageClause = 241,
+ CatchClause = 242,
+ PropertyAssignment = 243,
+ ShorthandPropertyAssignment = 244,
+ EnumMember = 245,
+ SourceFile = 246,
+ JSDocTypeExpression = 247,
+ JSDocAllType = 248,
+ JSDocUnknownType = 249,
+ JSDocArrayType = 250,
+ JSDocUnionType = 251,
+ JSDocTupleType = 252,
+ JSDocNullableType = 253,
+ JSDocNonNullableType = 254,
+ JSDocRecordType = 255,
+ JSDocRecordMember = 256,
+ JSDocTypeReference = 257,
+ JSDocOptionalType = 258,
+ JSDocFunctionType = 259,
+ JSDocVariadicType = 260,
+ JSDocConstructorType = 261,
+ JSDocThisType = 262,
+ JSDocComment = 263,
+ JSDocTag = 264,
+ JSDocParameterTag = 265,
+ JSDocReturnTag = 266,
+ JSDocTypeTag = 267,
+ JSDocTemplateTag = 268,
+ SyntaxList = 269,
+ Count = 270,
+ FirstAssignment = 55,
+ LastAssignment = 66,
+ FirstReservedWord = 68,
+ LastReservedWord = 103,
+ FirstKeyword = 68,
+ LastKeyword = 132,
+ FirstFutureReservedWord = 104,
+ LastFutureReservedWord = 112,
+ FirstTypeNode = 149,
+ LastTypeNode = 158,
+ FirstPunctuation = 15,
+ LastPunctuation = 66,
+ FirstToken = 0,
+ LastToken = 132,
+ FirstTriviaToken = 2,
+ LastTriviaToken = 7,
+ FirstLiteralToken = 8,
+ LastLiteralToken = 11,
+ FirstTemplateToken = 11,
+ LastTemplateToken = 14,
+ FirstBinaryOperator = 25,
+ LastBinaryOperator = 66,
+ FirstNode = 133,
+ }
+ const enum NodeFlags {
+ Export = 1,
+ Ambient = 2,
+ Public = 16,
+ Private = 32,
+ Protected = 64,
+ Static = 128,
+ Abstract = 256,
+ Async = 512,
+ Default = 1024,
+ MultiLine = 2048,
+ Synthetic = 4096,
+ DeclarationFile = 8192,
+ Let = 16384,
+ Const = 32768,
+ OctalLiteral = 65536,
+ Namespace = 131072,
+ ExportContext = 262144,
+ Modifier = 2035,
+ AccessibilityModifier = 112,
+ BlockScoped = 49152,
+ }
+ const enum JsxFlags {
+ None = 0,
+ IntrinsicNamedElement = 1,
+ IntrinsicIndexedElement = 2,
+ ClassElement = 4,
+ UnknownElement = 8,
+ IntrinsicElement = 3,
+ }
+ interface Node extends TextRange {
+ kind: SyntaxKind;
+ flags: NodeFlags;
+ decorators?: NodeArray<Decorator>;
+ modifiers?: ModifiersArray;
+ parent?: Node;
+ }
+ interface NodeArray<T> extends Array<T>, TextRange {
+ hasTrailingComma?: boolean;
+ }
+ interface ModifiersArray extends NodeArray<Node> {
+ flags: number;
+ }
+ interface Identifier extends PrimaryExpression {
+ text: string;
+ originalKeywordKind?: SyntaxKind;
+ }
+ interface QualifiedName extends Node {
+ left: EntityName;
+ right: Identifier;
+ }
+ type EntityName = Identifier | QualifiedName;
+ type DeclarationName = Identifier | LiteralExpression | ComputedPropertyName | BindingPattern;
+ interface Declaration extends Node {
+ _declarationBrand: any;
+ name?: DeclarationName;
+ }
+ interface ComputedPropertyName extends Node {
+ expression: Expression;
+ }
+ interface Decorator extends Node {
+ expression: LeftHandSideExpression;
+ }
+ interface TypeParameterDeclaration extends Declaration {
+ name: Identifier;
+ constraint?: TypeNode;
+ expression?: Expression;
+ }
+ interface SignatureDeclaration extends Declaration {
+ typeParameters?: NodeArray<TypeParameterDeclaration>;
+ parameters: NodeArray<ParameterDeclaration>;
+ type?: TypeNode;
+ }
+ interface VariableDeclaration extends Declaration {
+ parent?: VariableDeclarationList;
+ name: Identifier | BindingPattern;
+ type?: TypeNode;
+ initializer?: Expression;
+ }
+ interface VariableDeclarationList extends Node {
+ declarations: NodeArray<VariableDeclaration>;
+ }
+ interface ParameterDeclaration extends Declaration {
+ dotDotDotToken?: Node;
+ name: Identifier | BindingPattern;
+ questionToken?: Node;
+ type?: TypeNode;
+ initializer?: Expression;
+ }
+ interface BindingElement extends Declaration {
+ propertyName?: Identifier;
+ dotDotDotToken?: Node;
+ name: Identifier | BindingPattern;
+ initializer?: Expression;
+ }
+ interface PropertyDeclaration extends Declaration, ClassElement {
+ name: DeclarationName;
+ questionToken?: Node;
+ type?: TypeNode;
+ initializer?: Expression;
+ }
+ interface ObjectLiteralElement extends Declaration {
+ _objectLiteralBrandBrand: any;
+ }
+ interface PropertyAssignment extends ObjectLiteralElement {
+ _propertyAssignmentBrand: any;
+ name: DeclarationName;
+ questionToken?: Node;
+ initializer: Expression;
+ }
+ interface ShorthandPropertyAssignment extends ObjectLiteralElement {
+ name: Identifier;
+ questionToken?: Node;
+ }
+ interface VariableLikeDeclaration extends Declaration {
+ propertyName?: Identifier;
+ dotDotDotToken?: Node;
+ name: DeclarationName;
+ questionToken?: Node;
+ type?: TypeNode;
+ initializer?: Expression;
+ }
+ interface BindingPattern extends Node {
+ elements: NodeArray<BindingElement>;
+ }
+ /**
+ * Several node kinds share function-like features such as a signature,
+ * a name, and a body. These nodes should extend FunctionLikeDeclaration.
+ * Examples:
+ * - FunctionDeclaration
+ * - MethodDeclaration
+ * - AccessorDeclaration
+ */
+ interface FunctionLikeDeclaration extends SignatureDeclaration {
+ _functionLikeDeclarationBrand: any;
+ asteriskToken?: Node;
+ questionToken?: Node;
+ body?: Block | Expression;
+ }
+ interface FunctionDeclaration extends FunctionLikeDeclaration, Statement {
+ name?: Identifier;
+ body?: Block;
+ }
+ interface MethodDeclaration extends FunctionLikeDeclaration, ClassElement, ObjectLiteralElement {
+ body?: Block;
+ }
+ interface ConstructorDeclaration extends FunctionLikeDeclaration, ClassElement {
+ body?: Block;
+ }
+ interface SemicolonClassElement extends ClassElement {
+ _semicolonClassElementBrand: any;
+ }
+ interface AccessorDeclaration extends FunctionLikeDeclaration, ClassElement, ObjectLiteralElement {
+ _accessorDeclarationBrand: any;
+ body: Block;
+ }
+ interface IndexSignatureDeclaration extends SignatureDeclaration, ClassElement {
+ _indexSignatureDeclarationBrand: any;
+ }
+ interface TypeNode extends Node {
+ _typeNodeBrand: any;
+ }
+ interface FunctionOrConstructorTypeNode extends TypeNode, SignatureDeclaration {
+ _functionOrConstructorTypeNodeBrand: any;
+ }
+ interface TypeReferenceNode extends TypeNode {
+ typeName: EntityName;
+ typeArguments?: NodeArray<TypeNode>;
+ }
+ interface TypePredicateNode extends TypeNode {
+ parameterName: Identifier;
+ type: TypeNode;
+ }
+ interface TypeQueryNode extends TypeNode {
+ exprName: EntityName;
+ }
+ interface TypeLiteralNode extends TypeNode, Declaration {
+ members: NodeArray<Node>;
+ }
+ interface ArrayTypeNode extends TypeNode {
+ elementType: TypeNode;
+ }
+ interface TupleTypeNode extends TypeNode {
+ elementTypes: NodeArray<TypeNode>;
+ }
+ interface UnionOrIntersectionTypeNode extends TypeNode {
+ types: NodeArray<TypeNode>;
+ }
+ interface UnionTypeNode extends UnionOrIntersectionTypeNode {
+ }
+ interface IntersectionTypeNode extends UnionOrIntersectionTypeNode {
+ }
+ interface ParenthesizedTypeNode extends TypeNode {
+ type: TypeNode;
+ }
+ interface StringLiteral extends LiteralExpression, TypeNode {
+ _stringLiteralBrand: any;
+ }
+ interface Expression extends Node {
+ _expressionBrand: any;
+ contextualType?: Type;
+ }
+ interface UnaryExpression extends Expression {
+ _unaryExpressionBrand: any;
+ }
+ interface PrefixUnaryExpression extends UnaryExpression {
+ operator: SyntaxKind;
+ operand: UnaryExpression;
+ }
+ interface PostfixUnaryExpression extends PostfixExpression {
+ operand: LeftHandSideExpression;
+ operator: SyntaxKind;
+ }
+ interface PostfixExpression extends UnaryExpression {
+ _postfixExpressionBrand: any;
+ }
+ interface LeftHandSideExpression extends PostfixExpression {
+ _leftHandSideExpressionBrand: any;
+ }
+ interface MemberExpression extends LeftHandSideExpression {
+ _memberExpressionBrand: any;
+ }
+ interface PrimaryExpression extends MemberExpression {
+ _primaryExpressionBrand: any;
+ }
+ interface DeleteExpression extends UnaryExpression {
+ expression: UnaryExpression;
+ }
+ interface TypeOfExpression extends UnaryExpression {
+ expression: UnaryExpression;
+ }
+ interface VoidExpression extends UnaryExpression {
+ expression: UnaryExpression;
+ }
+ interface AwaitExpression extends UnaryExpression {
+ expression: UnaryExpression;
+ }
+ interface YieldExpression extends Expression {
+ asteriskToken?: Node;
+ expression?: Expression;
+ }
+ interface BinaryExpression extends Expression {
+ left: Expression;
+ operatorToken: Node;
+ right: Expression;
+ }
+ interface ConditionalExpression extends Expression {
+ condition: Expression;
+ questionToken: Node;
+ whenTrue: Expression;
+ colonToken: Node;
+ whenFalse: Expression;
+ }
+ interface FunctionExpression extends PrimaryExpression, FunctionLikeDeclaration {
+ name?: Identifier;
+ body: Block | Expression;
+ }
+ interface ArrowFunction extends Expression, FunctionLikeDeclaration {
+ equalsGreaterThanToken: Node;
+ }
+ interface LiteralExpression extends PrimaryExpression {
+ text: string;
+ isUnterminated?: boolean;
+ hasExtendedUnicodeEscape?: boolean;
+ }
+ interface TemplateExpression extends PrimaryExpression {
+ head: LiteralExpression;
+ templateSpans: NodeArray<TemplateSpan>;
+ }
+ interface TemplateSpan extends Node {
+ expression: Expression;
+ literal: LiteralExpression;
+ }
+ interface ParenthesizedExpression extends PrimaryExpression {
+ expression: Expression;
+ }
+ interface ArrayLiteralExpression extends PrimaryExpression {
+ elements: NodeArray<Expression>;
+ }
+ interface SpreadElementExpression extends Expression {
+ expression: Expression;
+ }
+ interface ObjectLiteralExpression extends PrimaryExpression, Declaration {
+ properties: NodeArray<ObjectLiteralElement>;
+ }
+ interface PropertyAccessExpression extends MemberExpression {
+ expression: LeftHandSideExpression;
+ dotToken: Node;
+ name: Identifier;
+ }
+ interface ElementAccessExpression extends MemberExpression {
+ expression: LeftHandSideExpression;
+ argumentExpression?: Expression;
+ }
+ interface CallExpression extends LeftHandSideExpression {
+ expression: LeftHandSideExpression;
+ typeArguments?: NodeArray<TypeNode>;
+ arguments: NodeArray<Expression>;
+ }
+ interface ExpressionWithTypeArguments extends TypeNode {
+ expression: LeftHandSideExpression;
+ typeArguments?: NodeArray<TypeNode>;
+ }
+ interface NewExpression extends CallExpression, PrimaryExpression {
+ }
+ interface TaggedTemplateExpression extends MemberExpression {
+ tag: LeftHandSideExpression;
+ template: LiteralExpression | TemplateExpression;
+ }
+ type CallLikeExpression = CallExpression | NewExpression | TaggedTemplateExpression | Decorator;
+ interface AsExpression extends Expression {
+ expression: Expression;
+ type: TypeNode;
+ }
+ interface TypeAssertion extends UnaryExpression {
+ type: TypeNode;
+ expression: UnaryExpression;
+ }
+ type AssertionExpression = TypeAssertion | AsExpression;
+ interface JsxElement extends PrimaryExpression {
+ openingElement: JsxOpeningElement;
+ children: NodeArray<JsxChild>;
+ closingElement: JsxClosingElement;
+ }
+ interface JsxOpeningElement extends Expression {
+ _openingElementBrand?: any;
+ tagName: EntityName;
+ attributes: NodeArray<JsxAttribute | JsxSpreadAttribute>;
+ }
+ interface JsxSelfClosingElement extends PrimaryExpression, JsxOpeningElement {
+ _selfClosingElementBrand?: any;
+ }
+ type JsxOpeningLikeElement = JsxSelfClosingElement | JsxOpeningElement;
+ interface JsxAttribute extends Node {
+ name: Identifier;
+ initializer?: Expression;
+ }
+ interface JsxSpreadAttribute extends Node {
+ expression: Expression;
+ }
+ interface JsxClosingElement extends Node {
+ tagName: EntityName;
+ }
+ interface JsxExpression extends Expression {
+ expression?: Expression;
+ }
+ interface JsxText extends Node {
+ _jsxTextExpressionBrand: any;
+ }
+ type JsxChild = JsxText | JsxExpression | JsxElement | JsxSelfClosingElement;
+ interface Statement extends Node {
+ _statementBrand: any;
+ }
+ interface Block extends Statement {
+ statements: NodeArray<Statement>;
+ }
+ interface VariableStatement extends Statement {
+ declarationList: VariableDeclarationList;
+ }
+ interface ExpressionStatement extends Statement {
+ expression: Expression;
+ }
+ interface IfStatement extends Statement {
+ expression: Expression;
+ thenStatement: Statement;
+ elseStatement?: Statement;
+ }
+ interface IterationStatement extends Statement {
+ statement: Statement;
+ }
+ interface DoStatement extends IterationStatement {
+ expression: Expression;
+ }
+ interface WhileStatement extends IterationStatement {
+ expression: Expression;
+ }
+ interface ForStatement extends IterationStatement {
+ initializer?: VariableDeclarationList | Expression;
+ condition?: Expression;
+ incrementor?: Expression;
+ }
+ interface ForInStatement extends IterationStatement {
+ initializer: VariableDeclarationList | Expression;
+ expression: Expression;
+ }
+ interface ForOfStatement extends IterationStatement {
+ initializer: VariableDeclarationList | Expression;
+ expression: Expression;
+ }
+ interface BreakOrContinueStatement extends Statement {
+ label?: Identifier;
+ }
+ interface ReturnStatement extends Statement {
+ expression?: Expression;
+ }
+ interface WithStatement extends Statement {
+ expression: Expression;
+ statement: Statement;
+ }
+ interface SwitchStatement extends Statement {
+ expression: Expression;
+ caseBlock: CaseBlock;
+ }
+ interface CaseBlock extends Node {
+ clauses: NodeArray<CaseOrDefaultClause>;
+ }
+ interface CaseClause extends Node {
+ expression?: Expression;
+ statements: NodeArray<Statement>;
+ }
+ interface DefaultClause extends Node {
+ statements: NodeArray<Statement>;
+ }
+ type CaseOrDefaultClause = CaseClause | DefaultClause;
+ interface LabeledStatement extends Statement {
+ label: Identifier;
+ statement: Statement;
+ }
+ interface ThrowStatement extends Statement {
+ expression: Expression;
+ }
+ interface TryStatement extends Statement {
+ tryBlock: Block;
+ catchClause?: CatchClause;
+ finallyBlock?: Block;
+ }
+ interface CatchClause extends Node {
+ variableDeclaration: VariableDeclaration;
+ block: Block;
+ }
+ interface ClassLikeDeclaration extends Declaration {
+ name?: Identifier;
+ typeParameters?: NodeArray<TypeParameterDeclaration>;
+ heritageClauses?: NodeArray<HeritageClause>;
+ members: NodeArray<ClassElement>;
+ }
+ interface ClassDeclaration extends ClassLikeDeclaration, Statement {
+ }
+ interface ClassExpression extends ClassLikeDeclaration, PrimaryExpression {
+ }
+ interface ClassElement extends Declaration {
+ _classElementBrand: any;
+ }
+ interface InterfaceDeclaration extends Declaration, Statement {
+ name: Identifier;
+ typeParameters?: NodeArray<TypeParameterDeclaration>;
+ heritageClauses?: NodeArray<HeritageClause>;
+ members: NodeArray<Declaration>;
+ }
+ interface HeritageClause extends Node {
+ token: SyntaxKind;
+ types?: NodeArray<ExpressionWithTypeArguments>;
+ }
+ interface TypeAliasDeclaration extends Declaration, Statement {
+ name: Identifier;
+ typeParameters?: NodeArray<TypeParameterDeclaration>;
+ type: TypeNode;
+ }
+ interface EnumMember extends Declaration {
+ name: DeclarationName;
+ initializer?: Expression;
+ }
+ interface EnumDeclaration extends Declaration, Statement {
+ name: Identifier;
+ members: NodeArray<EnumMember>;
+ }
+ interface ModuleDeclaration extends Declaration, Statement {
+ name: Identifier | LiteralExpression;
+ body: ModuleBlock | ModuleDeclaration;
+ }
+ interface ModuleBlock extends Node, Statement {
+ statements: NodeArray<Statement>;
+ }
+ interface ImportEqualsDeclaration extends Declaration, Statement {
+ name: Identifier;
+ moduleReference: EntityName | ExternalModuleReference;
+ }
+ interface ExternalModuleReference extends Node {
+ expression?: Expression;
+ }
+ interface ImportDeclaration extends Statement {
+ importClause?: ImportClause;
+ moduleSpecifier: Expression;
+ }
+ interface ImportClause extends Declaration {
+ name?: Identifier;
+ namedBindings?: NamespaceImport | NamedImports;
+ }
+ interface NamespaceImport extends Declaration {
+ name: Identifier;
+ }
+ interface ExportDeclaration extends Declaration, Statement {
+ exportClause?: NamedExports;
+ moduleSpecifier?: Expression;
+ }
+ interface NamedImportsOrExports extends Node {
+ elements: NodeArray<ImportOrExportSpecifier>;
+ }
+ type NamedImports = NamedImportsOrExports;
+ type NamedExports = NamedImportsOrExports;
+ interface ImportOrExportSpecifier extends Declaration {
+ propertyName?: Identifier;
+ name: Identifier;
+ }
+ type ImportSpecifier = ImportOrExportSpecifier;
+ type ExportSpecifier = ImportOrExportSpecifier;
+ interface ExportAssignment extends Declaration, Statement {
+ isExportEquals?: boolean;
+ expression: Expression;
+ }
+ interface FileReference extends TextRange {
+ fileName: string;
+ }
+ interface CommentRange extends TextRange {
+ hasTrailingNewLine?: boolean;
+ kind: SyntaxKind;
+ }
+ interface JSDocTypeExpression extends Node {
+ type: JSDocType;
+ }
+ interface JSDocType extends TypeNode {
+ _jsDocTypeBrand: any;
+ }
+ interface JSDocAllType extends JSDocType {
+ _JSDocAllTypeBrand: any;
+ }
+ interface JSDocUnknownType extends JSDocType {
+ _JSDocUnknownTypeBrand: any;
+ }
+ interface JSDocArrayType extends JSDocType {
+ elementType: JSDocType;
+ }
+ interface JSDocUnionType extends JSDocType {
+ types: NodeArray<JSDocType>;
+ }
+ interface JSDocTupleType extends JSDocType {
+ types: NodeArray<JSDocType>;
+ }
+ interface JSDocNonNullableType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocNullableType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocRecordType extends JSDocType, TypeLiteralNode {
+ members: NodeArray<JSDocRecordMember>;
+ }
+ interface JSDocTypeReference extends JSDocType {
+ name: EntityName;
+ typeArguments: NodeArray<JSDocType>;
+ }
+ interface JSDocOptionalType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocFunctionType extends JSDocType, SignatureDeclaration {
+ parameters: NodeArray<ParameterDeclaration>;
+ type: JSDocType;
+ }
+ interface JSDocVariadicType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocConstructorType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocThisType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocRecordMember extends PropertyDeclaration {
+ name: Identifier | LiteralExpression;
+ type?: JSDocType;
+ }
+ interface JSDocComment extends Node {
+ tags: NodeArray<JSDocTag>;
+ }
+ interface JSDocTag extends Node {
+ atToken: Node;
+ tagName: Identifier;
+ }
+ interface JSDocTemplateTag extends JSDocTag {
+ typeParameters: NodeArray<TypeParameterDeclaration>;
+ }
+ interface JSDocReturnTag extends JSDocTag {
+ typeExpression: JSDocTypeExpression;
+ }
+ interface JSDocTypeTag extends JSDocTag {
+ typeExpression: JSDocTypeExpression;
+ }
+ interface JSDocParameterTag extends JSDocTag {
+ preParameterName?: Identifier;
+ typeExpression?: JSDocTypeExpression;
+ postParameterName?: Identifier;
+ isBracketed: boolean;
+ }
+ interface SourceFile extends Declaration {
+ statements: NodeArray<Statement>;
+ endOfFileToken: Node;
+ fileName: string;
+ text: string;
+ amdDependencies: {
+ path: string;
+ name: string;
+ }[];
+ moduleName: string;
+ referencedFiles: FileReference[];
+ languageVariant: LanguageVariant;
+ /**
+ * lib.d.ts should have a reference comment like
+ *
+ * /// <reference no-default-lib="true"/>
+ *
+ * If any other file has this comment, it signals not to include lib.d.ts
+ * because this containing file is intended to act as a default library.
+ */
+ hasNoDefaultLib: boolean;
+ languageVersion: ScriptTarget;
+ }
+ interface ScriptReferenceHost {
+ getCompilerOptions(): CompilerOptions;
+ getSourceFile(fileName: string): SourceFile;
+ getCurrentDirectory(): string;
+ }
+ interface ParseConfigHost extends ModuleResolutionHost {
+ readDirectory(rootDir: string, extension: string, exclude: string[]): string[];
+ }
+ interface WriteFileCallback {
+ (fileName: string, data: string, writeByteOrderMark: boolean, onError?: (message: string) => void): void;
+ }
+ class OperationCanceledException {
+ }
+ interface CancellationToken {
+ isCancellationRequested(): boolean;
+ /** @throws OperationCanceledException if isCancellationRequested is true */
+ throwIfCancellationRequested(): void;
+ }
+ interface Program extends ScriptReferenceHost {
+ /**
+ * Get a list of root file names that were passed to a 'createProgram'
+ */
+ getRootFileNames(): string[];
+ /**
+ * Get a list of files in the program
+ */
+ getSourceFiles(): SourceFile[];
+ /**
+ * Emits the JavaScript and declaration files. If targetSourceFile is not specified, then
+ * the JavaScript and declaration files will be produced for all the files in this program.
+ * If targetSourceFile is specified, then only the JavaScript and declaration for that
+ * specific file will be generated.
+ *
+ * If writeFile is not specified then the writeFile callback from the compiler host will be
+ * used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter
+ * will be invoked when writing the JavaScript and declaration files.
+ */
+ emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken): EmitResult;
+ getOptionsDiagnostics(cancellationToken?: CancellationToken): Diagnostic[];
+ getGlobalDiagnostics(cancellationToken?: CancellationToken): Diagnostic[];
+ getSyntacticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ getSemanticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ /**
+ * Gets a type checker that can be used to semantically analyze source fils in the program.
+ */
+ getTypeChecker(): TypeChecker;
+ }
+ interface SourceMapSpan {
+ /** Line number in the .js file. */
+ emittedLine: number;
+ /** Column number in the .js file. */
+ emittedColumn: number;
+ /** Line number in the .ts file. */
+ sourceLine: number;
+ /** Column number in the .ts file. */
+ sourceColumn: number;
+ /** Optional name (index into names array) associated with this span. */
+ nameIndex?: number;
+ /** .ts file (index into sources array) associated with this span */
+ sourceIndex: number;
+ }
+ interface SourceMapData {
+ sourceMapFilePath: string;
+ jsSourceMappingURL: string;
+ sourceMapFile: string;
+ sourceMapSourceRoot: string;
+ sourceMapSources: string[];
+ sourceMapSourcesContent?: string[];
+ inputSourceFileNames: string[];
+ sourceMapNames?: string[];
+ sourceMapMappings: string;
+ sourceMapDecodedMappings: SourceMapSpan[];
+ }
+ /** Return code used by getEmitOutput function to indicate status of the function */
+ enum ExitStatus {
+ Success = 0,
+ DiagnosticsPresent_OutputsSkipped = 1,
+ DiagnosticsPresent_OutputsGenerated = 2,
+ }
+ interface EmitResult {
+ emitSkipped: boolean;
+ diagnostics: Diagnostic[];
+ }
+ interface TypeChecker {
+ getTypeOfSymbolAtLocation(symbol: Symbol, node: Node): Type;
+ getDeclaredTypeOfSymbol(symbol: Symbol): Type;
+ getPropertiesOfType(type: Type): Symbol[];
+ getPropertyOfType(type: Type, propertyName: string): Symbol;
+ getSignaturesOfType(type: Type, kind: SignatureKind): Signature[];
+ getIndexTypeOfType(type: Type, kind: IndexKind): Type;
+ getBaseTypes(type: InterfaceType): ObjectType[];
+ getReturnTypeOfSignature(signature: Signature): Type;
+ getSymbolsInScope(location: Node, meaning: SymbolFlags): Symbol[];
+ getSymbolAtLocation(node: Node): Symbol;
+ getShorthandAssignmentValueSymbol(location: Node): Symbol;
+ getTypeAtLocation(node: Node): Type;
+ typeToString(type: Type, enclosingDeclaration?: Node, flags?: TypeFormatFlags): string;
+ symbolToString(symbol: Symbol, enclosingDeclaration?: Node, meaning?: SymbolFlags): string;
+ getSymbolDisplayBuilder(): SymbolDisplayBuilder;
+ getFullyQualifiedName(symbol: Symbol): string;
+ getAugmentedPropertiesOfType(type: Type): Symbol[];
+ getRootSymbols(symbol: Symbol): Symbol[];
+ getContextualType(node: Expression): Type;
+ getResolvedSignature(node: CallLikeExpression, candidatesOutArray?: Signature[]): Signature;
+ getSignatureFromDeclaration(declaration: SignatureDeclaration): Signature;
+ isImplementationOfOverload(node: FunctionLikeDeclaration): boolean;
+ isUndefinedSymbol(symbol: Symbol): boolean;
+ isArgumentsSymbol(symbol: Symbol): boolean;
+ getConstantValue(node: EnumMember | PropertyAccessExpression | ElementAccessExpression): number;
+ isValidPropertyAccess(node: PropertyAccessExpression | QualifiedName, propertyName: string): boolean;
+ getAliasedSymbol(symbol: Symbol): Symbol;
+ getExportsOfModule(moduleSymbol: Symbol): Symbol[];
+ getJsxElementAttributesType(elementNode: JsxOpeningLikeElement): Type;
+ getJsxIntrinsicTagNames(): Symbol[];
+ isOptionalParameter(node: ParameterDeclaration): boolean;
+ }
+ interface SymbolDisplayBuilder {
+ buildTypeDisplay(type: Type, writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ buildSymbolDisplay(symbol: Symbol, writer: SymbolWriter, enclosingDeclaration?: Node, meaning?: SymbolFlags, flags?: SymbolFormatFlags): void;
+ buildSignatureDisplay(signatures: Signature, writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ buildParameterDisplay(parameter: Symbol, writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ buildTypeParameterDisplay(tp: TypeParameter, writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ buildTypeParameterDisplayFromSymbol(symbol: Symbol, writer: SymbolWriter, enclosingDeclaraiton?: Node, flags?: TypeFormatFlags): void;
+ buildDisplayForParametersAndDelimiters(parameters: Symbol[], writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ buildDisplayForTypeParametersAndDelimiters(typeParameters: TypeParameter[], writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ buildReturnTypeDisplay(signature: Signature, writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
+ }
+ interface SymbolWriter {
+ writeKeyword(text: string): void;
+ writeOperator(text: string): void;
+ writePunctuation(text: string): void;
+ writeSpace(text: string): void;
+ writeStringLiteral(text: string): void;
+ writeParameter(text: string): void;
+ writeSymbol(text: string, symbol: Symbol): void;
+ writeLine(): void;
+ increaseIndent(): void;
+ decreaseIndent(): void;
+ clear(): void;
+ trackSymbol(symbol: Symbol, enclosingDeclaration?: Node, meaning?: SymbolFlags): void;
+ }
+ const enum TypeFormatFlags {
+ None = 0,
+ WriteArrayAsGenericType = 1,
+ UseTypeOfFunction = 2,
+ NoTruncation = 4,
+ WriteArrowStyleSignature = 8,
+ WriteOwnNameForAnyLike = 16,
+ WriteTypeArgumentsOfSignature = 32,
+ InElementType = 64,
+ UseFullyQualifiedType = 128,
+ }
+ const enum SymbolFormatFlags {
+ None = 0,
+ WriteTypeParametersOrArguments = 1,
+ UseOnlyExternalAliasing = 2,
+ }
+ interface TypePredicate {
+ parameterName: string;
+ parameterIndex: number;
+ type: Type;
+ }
+ const enum SymbolFlags {
+ None = 0,
+ FunctionScopedVariable = 1,
+ BlockScopedVariable = 2,
+ Property = 4,
+ EnumMember = 8,
+ Function = 16,
+ Class = 32,
+ Interface = 64,
+ ConstEnum = 128,
+ RegularEnum = 256,
+ ValueModule = 512,
+ NamespaceModule = 1024,
+ TypeLiteral = 2048,
+ ObjectLiteral = 4096,
+ Method = 8192,
+ Constructor = 16384,
+ GetAccessor = 32768,
+ SetAccessor = 65536,
+ Signature = 131072,
+ TypeParameter = 262144,
+ TypeAlias = 524288,
+ ExportValue = 1048576,
+ ExportType = 2097152,
+ ExportNamespace = 4194304,
+ Alias = 8388608,
+ Instantiated = 16777216,
+ Merged = 33554432,
+ Transient = 67108864,
+ Prototype = 134217728,
+ SyntheticProperty = 268435456,
+ Optional = 536870912,
+ ExportStar = 1073741824,
+ Enum = 384,
+ Variable = 3,
+ Value = 107455,
+ Type = 793056,
+ Namespace = 1536,
+ Module = 1536,
+ Accessor = 98304,
+ FunctionScopedVariableExcludes = 107454,
+ BlockScopedVariableExcludes = 107455,
+ ParameterExcludes = 107455,
+ PropertyExcludes = 107455,
+ EnumMemberExcludes = 107455,
+ FunctionExcludes = 106927,
+ ClassExcludes = 899519,
+ InterfaceExcludes = 792960,
+ RegularEnumExcludes = 899327,
+ ConstEnumExcludes = 899967,
+ ValueModuleExcludes = 106639,
+ NamespaceModuleExcludes = 0,
+ MethodExcludes = 99263,
+ GetAccessorExcludes = 41919,
+ SetAccessorExcludes = 74687,
+ TypeParameterExcludes = 530912,
+ TypeAliasExcludes = 793056,
+ AliasExcludes = 8388608,
+ ModuleMember = 8914931,
+ ExportHasLocal = 944,
+ HasExports = 1952,
+ HasMembers = 6240,
+ BlockScoped = 418,
+ PropertyOrAccessor = 98308,
+ Export = 7340032,
+ }
+ interface Symbol {
+ flags: SymbolFlags;
+ name: string;
+ declarations?: Declaration[];
+ valueDeclaration?: Declaration;
+ members?: SymbolTable;
+ exports?: SymbolTable;
+ }
+ interface SymbolTable {
+ [index: string]: Symbol;
+ }
+ const enum TypeFlags {
+ Any = 1,
+ String = 2,
+ Number = 4,
+ Boolean = 8,
+ Void = 16,
+ Undefined = 32,
+ Null = 64,
+ Enum = 128,
+ StringLiteral = 256,
+ TypeParameter = 512,
+ Class = 1024,
+ Interface = 2048,
+ Reference = 4096,
+ Tuple = 8192,
+ Union = 16384,
+ Intersection = 32768,
+ Anonymous = 65536,
+ Instantiated = 131072,
+ ObjectLiteral = 524288,
+ ESSymbol = 16777216,
+ StringLike = 258,
+ NumberLike = 132,
+ ObjectType = 80896,
+ UnionOrIntersection = 49152,
+ StructuredType = 130048,
+ }
+ interface Type {
+ flags: TypeFlags;
+ symbol?: Symbol;
+ }
+ interface StringLiteralType extends Type {
+ text: string;
+ }
+ interface ObjectType extends Type {
+ }
+ interface InterfaceType extends ObjectType {
+ typeParameters: TypeParameter[];
+ outerTypeParameters: TypeParameter[];
+ localTypeParameters: TypeParameter[];
+ }
+ interface InterfaceTypeWithDeclaredMembers extends InterfaceType {
+ declaredProperties: Symbol[];
+ declaredCallSignatures: Signature[];
+ declaredConstructSignatures: Signature[];
+ declaredStringIndexType: Type;
+ declaredNumberIndexType: Type;
+ }
+ interface TypeReference extends ObjectType {
+ target: GenericType;
+ typeArguments: Type[];
+ }
+ interface GenericType extends InterfaceType, TypeReference {
+ }
+ interface TupleType extends ObjectType {
+ elementTypes: Type[];
+ baseArrayType: TypeReference;
+ }
+ interface UnionOrIntersectionType extends Type {
+ types: Type[];
+ }
+ interface UnionType extends UnionOrIntersectionType {
+ }
+ interface IntersectionType extends UnionOrIntersectionType {
+ }
+ interface TypeParameter extends Type {
+ constraint: Type;
+ }
+ const enum SignatureKind {
+ Call = 0,
+ Construct = 1,
+ }
+ interface Signature {
+ declaration: SignatureDeclaration;
+ typeParameters: TypeParameter[];
+ parameters: Symbol[];
+ typePredicate?: TypePredicate;
+ }
+ const enum IndexKind {
+ String = 0,
+ Number = 1,
+ }
+ interface DiagnosticMessage {
+ key: string;
+ category: DiagnosticCategory;
+ code: number;
+ }
+ /**
+ * A linked list of formatted diagnostic messages to be used as part of a multiline message.
+ * It is built from the bottom up, leaving the head to be the "main" diagnostic.
+ * While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage,
+ * the difference is that messages are all preformatted in DMC.
+ */
+ interface DiagnosticMessageChain {
+ messageText: string;
+ category: DiagnosticCategory;
+ code: number;
+ next?: DiagnosticMessageChain;
+ }
+ interface Diagnostic {
+ file: SourceFile;
+ start: number;
+ length: number;
+ messageText: string | DiagnosticMessageChain;
+ category: DiagnosticCategory;
+ code: number;
+ }
+ enum DiagnosticCategory {
+ Warning = 0,
+ Error = 1,
+ Message = 2,
+ }
+ const enum ModuleResolutionKind {
+ Classic = 1,
+ NodeJs = 2,
+ }
+ interface CompilerOptions {
+ allowNonTsExtensions?: boolean;
+ charset?: string;
+ declaration?: boolean;
+ diagnostics?: boolean;
+ emitBOM?: boolean;
+ help?: boolean;
+ init?: boolean;
+ inlineSourceMap?: boolean;
+ inlineSources?: boolean;
+ jsx?: JsxEmit;
+ listFiles?: boolean;
+ locale?: string;
+ mapRoot?: string;
+ module?: ModuleKind;
+ newLine?: NewLineKind;
+ noEmit?: boolean;
+ noEmitHelpers?: boolean;
+ noEmitOnError?: boolean;
+ noErrorTruncation?: boolean;
+ noImplicitAny?: boolean;
+ noLib?: boolean;
+ noResolve?: boolean;
+ out?: string;
+ outFile?: string;
+ outDir?: string;
+ preserveConstEnums?: boolean;
+ project?: string;
+ removeComments?: boolean;
+ rootDir?: string;
+ sourceMap?: boolean;
+ sourceRoot?: string;
+ suppressExcessPropertyErrors?: boolean;
+ suppressImplicitAnyIndexErrors?: boolean;
+ target?: ScriptTarget;
+ version?: boolean;
+ watch?: boolean;
+ isolatedModules?: boolean;
+ experimentalDecorators?: boolean;
+ experimentalAsyncFunctions?: boolean;
+ emitDecoratorMetadata?: boolean;
+ moduleResolution?: ModuleResolutionKind;
+ [option: string]: string | number | boolean;
+ }
+ const enum ModuleKind {
+ None = 0,
+ CommonJS = 1,
+ AMD = 2,
+ UMD = 3,
+ System = 4,
+ }
+ const enum JsxEmit {
+ None = 0,
+ Preserve = 1,
+ React = 2,
+ }
+ const enum NewLineKind {
+ CarriageReturnLineFeed = 0,
+ LineFeed = 1,
+ }
+ interface LineAndCharacter {
+ line: number;
+ character: number;
+ }
+ const enum ScriptTarget {
+ ES3 = 0,
+ ES5 = 1,
+ ES6 = 2,
+ Latest = 2,
+ }
+ const enum LanguageVariant {
+ Standard = 0,
+ JSX = 1,
+ }
+ interface ParsedCommandLine {
+ options: CompilerOptions;
+ fileNames: string[];
+ errors: Diagnostic[];
+ }
+ interface ModuleResolutionHost {
+ fileExists(fileName: string): boolean;
+ readFile(fileName: string): string;
+ }
+ interface ResolvedModule {
+ resolvedFileName: string;
+ isExternalLibraryImport?: boolean;
+ }
+ interface ResolvedModuleWithFailedLookupLocations {
+ resolvedModule: ResolvedModule;
+ failedLookupLocations: string[];
+ }
+ interface CompilerHost extends ModuleResolutionHost {
+ getSourceFile(fileName: string, languageVersion: ScriptTarget, onError?: (message: string) => void): SourceFile;
+ getCancellationToken?(): CancellationToken;
+ getDefaultLibFileName(options: CompilerOptions): string;
+ writeFile: WriteFileCallback;
+ getCurrentDirectory(): string;
+ getCanonicalFileName(fileName: string): string;
+ useCaseSensitiveFileNames(): boolean;
+ getNewLine(): string;
+ resolveModuleNames?(moduleNames: string[], containingFile: string): ResolvedModule[];
+ }
+ interface TextSpan {
+ start: number;
+ length: number;
+ }
+ interface TextChangeRange {
+ span: TextSpan;
+ newLength: number;
+ }
+}
+declare namespace ts {
+ interface System {
+ args: string[];
+ newLine: string;
+ useCaseSensitiveFileNames: boolean;
+ write(s: string): void;
+ readFile(path: string, encoding?: string): string;
+ writeFile(path: string, data: string, writeByteOrderMark?: boolean): void;
+ watchFile?(path: string, callback: (path: string) => void): FileWatcher;
+ resolvePath(path: string): string;
+ fileExists(path: string): boolean;
+ directoryExists(path: string): boolean;
+ createDirectory(path: string): void;
+ getExecutingFilePath(): string;
+ getCurrentDirectory(): string;
+ readDirectory(path: string, extension?: string, exclude?: string[]): string[];
+ getMemoryUsage?(): number;
+ exit(exitCode?: number): void;
+ }
+ interface FileWatcher {
+ close(): void;
+ }
+ var sys: System;
+}
+declare namespace ts {
+ interface ErrorCallback {
+ (message: DiagnosticMessage, length: number): void;
+ }
+ interface Scanner {
+ getStartPos(): number;
+ getToken(): SyntaxKind;
+ getTextPos(): number;
+ getTokenPos(): number;
+ getTokenText(): string;
+ getTokenValue(): string;
+ hasExtendedUnicodeEscape(): boolean;
+ hasPrecedingLineBreak(): boolean;
+ isIdentifier(): boolean;
+ isReservedWord(): boolean;
+ isUnterminated(): boolean;
+ reScanGreaterToken(): SyntaxKind;
+ reScanSlashToken(): SyntaxKind;
+ reScanTemplateToken(): SyntaxKind;
+ scanJsxIdentifier(): SyntaxKind;
+ reScanJsxToken(): SyntaxKind;
+ scanJsxToken(): SyntaxKind;
+ scan(): SyntaxKind;
+ setText(text: string, start?: number, length?: number): void;
+ setOnError(onError: ErrorCallback): void;
+ setScriptTarget(scriptTarget: ScriptTarget): void;
+ setLanguageVariant(variant: LanguageVariant): void;
+ setTextPos(textPos: number): void;
+ lookAhead<T>(callback: () => T): T;
+ tryScan<T>(callback: () => T): T;
+ }
+ function tokenToString(t: SyntaxKind): string;
+ function getPositionOfLineAndCharacter(sourceFile: SourceFile, line: number, character: number): number;
+ function getLineAndCharacterOfPosition(sourceFile: SourceFile, position: number): LineAndCharacter;
+ function isWhiteSpace(ch: number): boolean;
+ function isLineBreak(ch: number): boolean;
+ function couldStartTrivia(text: string, pos: number): boolean;
+ function getLeadingCommentRanges(text: string, pos: number): CommentRange[];
+ function getTrailingCommentRanges(text: string, pos: number): CommentRange[];
+ /** Optionally, get the shebang */
+ function getShebang(text: string): string;
+ function isIdentifierStart(ch: number, languageVersion: ScriptTarget): boolean;
+ function isIdentifierPart(ch: number, languageVersion: ScriptTarget): boolean;
+ function createScanner(languageVersion: ScriptTarget, skipTrivia: boolean, languageVariant?: LanguageVariant, text?: string, onError?: ErrorCallback, start?: number, length?: number): Scanner;
+}
+declare namespace ts {
+ function getDefaultLibFileName(options: CompilerOptions): string;
+ function textSpanEnd(span: TextSpan): number;
+ function textSpanIsEmpty(span: TextSpan): boolean;
+ function textSpanContainsPosition(span: TextSpan, position: number): boolean;
+ function textSpanContainsTextSpan(span: TextSpan, other: TextSpan): boolean;
+ function textSpanOverlapsWith(span: TextSpan, other: TextSpan): boolean;
+ function textSpanOverlap(span1: TextSpan, span2: TextSpan): TextSpan;
+ function textSpanIntersectsWithTextSpan(span: TextSpan, other: TextSpan): boolean;
+ function textSpanIntersectsWith(span: TextSpan, start: number, length: number): boolean;
+ function decodedTextSpanIntersectsWith(start1: number, length1: number, start2: number, length2: number): boolean;
+ function textSpanIntersectsWithPosition(span: TextSpan, position: number): boolean;
+ function textSpanIntersection(span1: TextSpan, span2: TextSpan): TextSpan;
+ function createTextSpan(start: number, length: number): TextSpan;
+ function createTextSpanFromBounds(start: number, end: number): TextSpan;
+ function textChangeRangeNewSpan(range: TextChangeRange): TextSpan;
+ function textChangeRangeIsUnchanged(range: TextChangeRange): boolean;
+ function createTextChangeRange(span: TextSpan, newLength: number): TextChangeRange;
+ let unchangedTextChangeRange: TextChangeRange;
+ /**
+ * Called to merge all the changes that occurred across several versions of a script snapshot
+ * into a single change. i.e. if a user keeps making successive edits to a script we will
+ * have a text change from V1 to V2, V2 to V3, ..., Vn.
+ *
+ * This function will then merge those changes into a single change range valid between V1 and
+ * Vn.
+ */
+ function collapseTextChangeRangesAcrossMultipleVersions(changes: TextChangeRange[]): TextChangeRange;
+ function getTypeParameterOwner(d: Declaration): Declaration;
+}
+declare namespace ts {
+ function getNodeConstructor(kind: SyntaxKind): new () => Node;
+ function createNode(kind: SyntaxKind): Node;
+ function forEachChild<T>(node: Node, cbNode: (node: Node) => T, cbNodeArray?: (nodes: Node[]) => T): T;
+ function createSourceFile(fileName: string, sourceText: string, languageVersion: ScriptTarget, setParentNodes?: boolean): SourceFile;
+ function updateSourceFile(sourceFile: SourceFile, newText: string, textChangeRange: TextChangeRange, aggressiveChecks?: boolean): SourceFile;
+}
+declare namespace ts {
+ const version: string;
+ function findConfigFile(searchPath: string): string;
+ function resolveTripleslashReference(moduleName: string, containingFile: string): string;
+ function resolveModuleName(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost): ResolvedModuleWithFailedLookupLocations;
+ function nodeModuleNameResolver(moduleName: string, containingFile: string, host: ModuleResolutionHost): ResolvedModuleWithFailedLookupLocations;
+ function classicNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost): ResolvedModuleWithFailedLookupLocations;
+ function createCompilerHost(options: CompilerOptions, setParentNodes?: boolean): CompilerHost;
+ function getPreEmitDiagnostics(program: Program, sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ function flattenDiagnosticMessageText(messageText: string | DiagnosticMessageChain, newLine: string): string;
+ function createProgram(rootNames: string[], options: CompilerOptions, host?: CompilerHost, oldProgram?: Program): Program;
+}
+declare namespace ts {
+ function parseCommandLine(commandLine: string[], readFile?: (path: string) => string): ParsedCommandLine;
+ /**
+ * Read tsconfig.json file
+ * @param fileName The path to the config file
+ */
+ function readConfigFile(fileName: string): {
+ config?: any;
+ error?: Diagnostic;
+ };
+ /**
+ * Parse the text of the tsconfig.json file
+ * @param fileName The path to the config file
+ * @param jsonText The text of the config file
+ */
+ function parseConfigFileText(fileName: string, jsonText: string): {
+ config?: any;
+ error?: Diagnostic;
+ };
+ /**
+ * Parse the contents of a config file (tsconfig.json).
+ * @param json The contents of the config file to parse
+ * @param basePath A root directory to resolve relative path entries in the config
+ * file to. e.g. outDir
+ */
+ function parseConfigFile(json: any, host: ParseConfigHost, basePath: string): ParsedCommandLine;
+}
+declare namespace ts {
+ /** The version of the language service API */
+ let servicesVersion: string;
+ interface Node {
+ getSourceFile(): SourceFile;
+ getChildCount(sourceFile?: SourceFile): number;
+ getChildAt(index: number, sourceFile?: SourceFile): Node;
+ getChildren(sourceFile?: SourceFile): Node[];
+ getStart(sourceFile?: SourceFile): number;
+ getFullStart(): number;
+ getEnd(): number;
+ getWidth(sourceFile?: SourceFile): number;
+ getFullWidth(): number;
+ getLeadingTriviaWidth(sourceFile?: SourceFile): number;
+ getFullText(sourceFile?: SourceFile): string;
+ getText(sourceFile?: SourceFile): string;
+ getFirstToken(sourceFile?: SourceFile): Node;
+ getLastToken(sourceFile?: SourceFile): Node;
+ }
+ interface Symbol {
+ getFlags(): SymbolFlags;
+ getName(): string;
+ getDeclarations(): Declaration[];
+ getDocumentationComment(): SymbolDisplayPart[];
+ }
+ interface Type {
+ getFlags(): TypeFlags;
+ getSymbol(): Symbol;
+ getProperties(): Symbol[];
+ getProperty(propertyName: string): Symbol;
+ getApparentProperties(): Symbol[];
+ getCallSignatures(): Signature[];
+ getConstructSignatures(): Signature[];
+ getStringIndexType(): Type;
+ getNumberIndexType(): Type;
+ getBaseTypes(): ObjectType[];
+ }
+ interface Signature {
+ getDeclaration(): SignatureDeclaration;
+ getTypeParameters(): Type[];
+ getParameters(): Symbol[];
+ getReturnType(): Type;
+ getDocumentationComment(): SymbolDisplayPart[];
+ }
+ interface SourceFile {
+ getLineAndCharacterOfPosition(pos: number): LineAndCharacter;
+ getLineStarts(): number[];
+ getPositionOfLineAndCharacter(line: number, character: number): number;
+ update(newText: string, textChangeRange: TextChangeRange): SourceFile;
+ }
+ /**
+ * Represents an immutable snapshot of a script at a specified time.Once acquired, the
+ * snapshot is observably immutable. i.e. the same calls with the same parameters will return
+ * the same values.
+ */
+ interface IScriptSnapshot {
+ /** Gets a portion of the script snapshot specified by [start, end). */
+ getText(start: number, end: number): string;
+ /** Gets the length of this script snapshot. */
+ getLength(): number;
+ /**
+ * Gets the TextChangeRange that describe how the text changed between this text and
+ * an older version. This information is used by the incremental parser to determine
+ * what sections of the script need to be re-parsed. 'undefined' can be returned if the
+ * change range cannot be determined. However, in that case, incremental parsing will
+ * not happen and the entire document will be re - parsed.
+ */
+ getChangeRange(oldSnapshot: IScriptSnapshot): TextChangeRange;
+ /** Releases all resources held by this script snapshot */
+ dispose?(): void;
+ }
+ module ScriptSnapshot {
+ function fromString(text: string): IScriptSnapshot;
+ }
+ interface PreProcessedFileInfo {
+ referencedFiles: FileReference[];
+ importedFiles: FileReference[];
+ ambientExternalModules: string[];
+ isLibFile: boolean;
+ }
+ interface HostCancellationToken {
+ isCancellationRequested(): boolean;
+ }
+ interface LanguageServiceHost {
+ getCompilationSettings(): CompilerOptions;
+ getNewLine?(): string;
+ getProjectVersion?(): string;
+ getScriptFileNames(): string[];
+ getScriptVersion(fileName: string): string;
+ getScriptSnapshot(fileName: string): IScriptSnapshot;
+ getLocalizedDiagnosticMessages?(): any;
+ getCancellationToken?(): HostCancellationToken;
+ getCurrentDirectory(): string;
+ getDefaultLibFileName(options: CompilerOptions): string;
+ log?(s: string): void;
+ trace?(s: string): void;
+ error?(s: string): void;
+ useCaseSensitiveFileNames?(): boolean;
+ resolveModuleNames?(moduleNames: string[], containingFile: string): ResolvedModule[];
+ }
+ interface LanguageService {
+ cleanupSemanticCache(): void;
+ getSyntacticDiagnostics(fileName: string): Diagnostic[];
+ getSemanticDiagnostics(fileName: string): Diagnostic[];
+ getCompilerOptionsDiagnostics(): Diagnostic[];
+ /**
+ * @deprecated Use getEncodedSyntacticClassifications instead.
+ */
+ getSyntacticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
+ /**
+ * @deprecated Use getEncodedSemanticClassifications instead.
+ */
+ getSemanticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
+ getEncodedSyntacticClassifications(fileName: string, span: TextSpan): Classifications;
+ getEncodedSemanticClassifications(fileName: string, span: TextSpan): Classifications;
+ getCompletionsAtPosition(fileName: string, position: number): CompletionInfo;
+ getCompletionEntryDetails(fileName: string, position: number, entryName: string): CompletionEntryDetails;
+ getQuickInfoAtPosition(fileName: string, position: number): QuickInfo;
+ getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): TextSpan;
+ getBreakpointStatementAtPosition(fileName: string, position: number): TextSpan;
+ getSignatureHelpItems(fileName: string, position: number): SignatureHelpItems;
+ getRenameInfo(fileName: string, position: number): RenameInfo;
+ findRenameLocations(fileName: string, position: number, findInStrings: boolean, findInComments: boolean): RenameLocation[];
+ getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
+ getTypeDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
+ getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
+ findReferences(fileName: string, position: number): ReferencedSymbol[];
+ getDocumentHighlights(fileName: string, position: number, filesToSearch: string[]): DocumentHighlights[];
+ /** @deprecated */
+ getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
+ getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
+ getNavigationBarItems(fileName: string): NavigationBarItem[];
+ getOutliningSpans(fileName: string): OutliningSpan[];
+ getTodoComments(fileName: string, descriptors: TodoCommentDescriptor[]): TodoComment[];
+ getBraceMatchingAtPosition(fileName: string, position: number): TextSpan[];
+ getIndentationAtPosition(fileName: string, position: number, options: EditorOptions): number;
+ getFormattingEditsForRange(fileName: string, start: number, end: number, options: FormatCodeOptions): TextChange[];
+ getFormattingEditsForDocument(fileName: string, options: FormatCodeOptions): TextChange[];
+ getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions): TextChange[];
+ getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion;
+ getEmitOutput(fileName: string): EmitOutput;
+ getProgram(): Program;
+ getSourceFile(fileName: string): SourceFile;
+ dispose(): void;
+ }
+ interface Classifications {
+ spans: number[];
+ endOfLineState: EndOfLineState;
+ }
+ interface ClassifiedSpan {
+ textSpan: TextSpan;
+ classificationType: string;
+ }
+ interface NavigationBarItem {
+ text: string;
+ kind: string;
+ kindModifiers: string;
+ spans: TextSpan[];
+ childItems: NavigationBarItem[];
+ indent: number;
+ bolded: boolean;
+ grayed: boolean;
+ }
+ interface TodoCommentDescriptor {
+ text: string;
+ priority: number;
+ }
+ interface TodoComment {
+ descriptor: TodoCommentDescriptor;
+ message: string;
+ position: number;
+ }
+ class TextChange {
+ span: TextSpan;
+ newText: string;
+ }
+ interface TextInsertion {
+ newText: string;
+ /** The position in newText the caret should point to after the insertion. */
+ caretOffset: number;
+ }
+ interface RenameLocation {
+ textSpan: TextSpan;
+ fileName: string;
+ }
+ interface ReferenceEntry {
+ textSpan: TextSpan;
+ fileName: string;
+ isWriteAccess: boolean;
+ }
+ interface DocumentHighlights {
+ fileName: string;
+ highlightSpans: HighlightSpan[];
+ }
+ module HighlightSpanKind {
+ const none: string;
+ const definition: string;
+ const reference: string;
+ const writtenReference: string;
+ }
+ interface HighlightSpan {
+ fileName?: string;
+ textSpan: TextSpan;
+ kind: string;
+ }
+ interface NavigateToItem {
+ name: string;
+ kind: string;
+ kindModifiers: string;
+ matchKind: string;
+ isCaseSensitive: boolean;
+ fileName: string;
+ textSpan: TextSpan;
+ containerName: string;
+ containerKind: string;
+ }
+ interface EditorOptions {
+ IndentSize: number;
+ TabSize: number;
+ NewLineCharacter: string;
+ ConvertTabsToSpaces: boolean;
+ }
+ interface FormatCodeOptions extends EditorOptions {
+ InsertSpaceAfterCommaDelimiter: boolean;
+ InsertSpaceAfterSemicolonInForStatements: boolean;
+ InsertSpaceBeforeAndAfterBinaryOperators: boolean;
+ InsertSpaceAfterKeywordsInControlFlowStatements: boolean;
+ InsertSpaceAfterFunctionKeywordForAnonymousFunctions: boolean;
+ InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: boolean;
+ InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: boolean;
+ PlaceOpenBraceOnNewLineForFunctions: boolean;
+ PlaceOpenBraceOnNewLineForControlBlocks: boolean;
+ [s: string]: boolean | number | string;
+ }
+ interface DefinitionInfo {
+ fileName: string;
+ textSpan: TextSpan;
+ kind: string;
+ name: string;
+ containerKind: string;
+ containerName: string;
+ }
+ interface ReferencedSymbol {
+ definition: DefinitionInfo;
+ references: ReferenceEntry[];
+ }
+ enum SymbolDisplayPartKind {
+ aliasName = 0,
+ className = 1,
+ enumName = 2,
+ fieldName = 3,
+ interfaceName = 4,
+ keyword = 5,
+ lineBreak = 6,
+ numericLiteral = 7,
+ stringLiteral = 8,
+ localName = 9,
+ methodName = 10,
+ moduleName = 11,
+ operator = 12,
+ parameterName = 13,
+ propertyName = 14,
+ punctuation = 15,
+ space = 16,
+ text = 17,
+ typeParameterName = 18,
+ enumMemberName = 19,
+ functionName = 20,
+ regularExpressionLiteral = 21,
+ }
+ interface SymbolDisplayPart {
+ text: string;
+ kind: string;
+ }
+ interface QuickInfo {
+ kind: string;
+ kindModifiers: string;
+ textSpan: TextSpan;
+ displayParts: SymbolDisplayPart[];
+ documentation: SymbolDisplayPart[];
+ }
+ interface RenameInfo {
+ canRename: boolean;
+ localizedErrorMessage: string;
+ displayName: string;
+ fullDisplayName: string;
+ kind: string;
+ kindModifiers: string;
+ triggerSpan: TextSpan;
+ }
+ interface SignatureHelpParameter {
+ name: string;
+ documentation: SymbolDisplayPart[];
+ displayParts: SymbolDisplayPart[];
+ isOptional: boolean;
+ }
+ /**
+ * Represents a single signature to show in signature help.
+ * The id is used for subsequent calls into the language service to ask questions about the
+ * signature help item in the context of any documents that have been updated. i.e. after
+ * an edit has happened, while signature help is still active, the host can ask important
+ * questions like 'what parameter is the user currently contained within?'.
+ */
+ interface SignatureHelpItem {
+ isVariadic: boolean;
+ prefixDisplayParts: SymbolDisplayPart[];
+ suffixDisplayParts: SymbolDisplayPart[];
+ separatorDisplayParts: SymbolDisplayPart[];
+ parameters: SignatureHelpParameter[];
+ documentation: SymbolDisplayPart[];
+ }
+ /**
+ * Represents a set of signature help items, and the preferred item that should be selected.
+ */
+ interface SignatureHelpItems {
+ items: SignatureHelpItem[];
+ applicableSpan: TextSpan;
+ selectedItemIndex: number;
+ argumentIndex: number;
+ argumentCount: number;
+ }
+ interface CompletionInfo {
+ isMemberCompletion: boolean;
+ isNewIdentifierLocation: boolean;
+ entries: CompletionEntry[];
+ }
+ interface CompletionEntry {
+ name: string;
+ kind: string;
+ kindModifiers: string;
+ sortText: string;
+ }
+ interface CompletionEntryDetails {
+ name: string;
+ kind: string;
+ kindModifiers: string;
+ displayParts: SymbolDisplayPart[];
+ documentation: SymbolDisplayPart[];
+ }
+ interface OutliningSpan {
+ /** The span of the document to actually collapse. */
+ textSpan: TextSpan;
+ /** The span of the document to display when the user hovers over the collapsed span. */
+ hintSpan: TextSpan;
+ /** The text to display in the editor for the collapsed region. */
+ bannerText: string;
+ /**
+ * Whether or not this region should be automatically collapsed when
+ * the 'Collapse to Definitions' command is invoked.
+ */
+ autoCollapse: boolean;
+ }
+ interface EmitOutput {
+ outputFiles: OutputFile[];
+ emitSkipped: boolean;
+ }
+ const enum OutputFileType {
+ JavaScript = 0,
+ SourceMap = 1,
+ Declaration = 2,
+ }
+ interface OutputFile {
+ name: string;
+ writeByteOrderMark: boolean;
+ text: string;
+ }
+ const enum EndOfLineState {
+ None = 0,
+ InMultiLineCommentTrivia = 1,
+ InSingleQuoteStringLiteral = 2,
+ InDoubleQuoteStringLiteral = 3,
+ InTemplateHeadOrNoSubstitutionTemplate = 4,
+ InTemplateMiddleOrTail = 5,
+ InTemplateSubstitutionPosition = 6,
+ }
+ enum TokenClass {
+ Punctuation = 0,
+ Keyword = 1,
+ Operator = 2,
+ Comment = 3,
+ Whitespace = 4,
+ Identifier = 5,
+ NumberLiteral = 6,
+ StringLiteral = 7,
+ RegExpLiteral = 8,
+ }
+ interface ClassificationResult {
+ finalLexState: EndOfLineState;
+ entries: ClassificationInfo[];
+ }
+ interface ClassificationInfo {
+ length: number;
+ classification: TokenClass;
+ }
+ interface Classifier {
+ /**
+ * Gives lexical classifications of tokens on a line without any syntactic context.
+ * For instance, a token consisting of the text 'string' can be either an identifier
+ * named 'string' or the keyword 'string', however, because this classifier is not aware,
+ * it relies on certain heuristics to give acceptable results. For classifications where
+ * speed trumps accuracy, this function is preferable; however, for true accuracy, the
+ * syntactic classifier is ideal. In fact, in certain editing scenarios, combining the
+ * lexical, syntactic, and semantic classifiers may issue the best user experience.
+ *
+ * @param text The text of a line to classify.
+ * @param lexState The state of the lexical classifier at the end of the previous line.
+ * @param syntacticClassifierAbsent Whether the client is *not* using a syntactic classifier.
+ * If there is no syntactic classifier (syntacticClassifierAbsent=true),
+ * certain heuristics may be used in its place; however, if there is a
+ * syntactic classifier (syntacticClassifierAbsent=false), certain
+ * classifications which may be incorrectly categorized will be given
+ * back as Identifiers in order to allow the syntactic classifier to
+ * subsume the classification.
+ * @deprecated Use getLexicalClassifications instead.
+ */
+ getClassificationsForLine(text: string, lexState: EndOfLineState, syntacticClassifierAbsent: boolean): ClassificationResult;
+ getEncodedLexicalClassifications(text: string, endOfLineState: EndOfLineState, syntacticClassifierAbsent: boolean): Classifications;
+ }
+ /**
+ * The document registry represents a store of SourceFile objects that can be shared between
+ * multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST)
+ * of files in the context.
+ * SourceFile objects account for most of the memory usage by the language service. Sharing
+ * the same DocumentRegistry instance between different instances of LanguageService allow
+ * for more efficient memory utilization since all projects will share at least the library
+ * file (lib.d.ts).
+ *
+ * A more advanced use of the document registry is to serialize sourceFile objects to disk
+ * and re-hydrate them when needed.
+ *
+ * To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it
+ * to all subsequent createLanguageService calls.
+ */
+ interface DocumentRegistry {
+ /**
+ * Request a stored SourceFile with a given fileName and compilationSettings.
+ * The first call to acquire will call createLanguageServiceSourceFile to generate
+ * the SourceFile if was not found in the registry.
+ *
+ * @param fileName The name of the file requested
+ * @param compilationSettings Some compilation settings like target affects the
+ * shape of a the resulting SourceFile. This allows the DocumentRegistry to store
+ * multiple copies of the same file for different compilation settings.
+ * @parm scriptSnapshot Text of the file. Only used if the file was not found
+ * in the registry and a new one was created.
+ * @parm version Current version of the file. Only used if the file was not found
+ * in the registry and a new one was created.
+ */
+ acquireDocument(fileName: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string): SourceFile;
+ /**
+ * Request an updated version of an already existing SourceFile with a given fileName
+ * and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile
+ * to get an updated SourceFile.
+ *
+ * @param fileName The name of the file requested
+ * @param compilationSettings Some compilation settings like target affects the
+ * shape of a the resulting SourceFile. This allows the DocumentRegistry to store
+ * multiple copies of the same file for different compilation settings.
+ * @param scriptSnapshot Text of the file.
+ * @param version Current version of the file.
+ */
+ updateDocument(fileName: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string): SourceFile;
+ /**
+ * Informs the DocumentRegistry that a file is not needed any longer.
+ *
+ * Note: It is not allowed to call release on a SourceFile that was not acquired from
+ * this registry originally.
+ *
+ * @param fileName The name of the file to be released
+ * @param compilationSettings The compilation settings used to acquire the file
+ */
+ releaseDocument(fileName: string, compilationSettings: CompilerOptions): void;
+ reportStats(): string;
+ }
+ module ScriptElementKind {
+ const unknown: string;
+ const warning: string;
+ const keyword: string;
+ const scriptElement: string;
+ const moduleElement: string;
+ const classElement: string;
+ const localClassElement: string;
+ const interfaceElement: string;
+ const typeElement: string;
+ const enumElement: string;
+ const variableElement: string;
+ const localVariableElement: string;
+ const functionElement: string;
+ const localFunctionElement: string;
+ const memberFunctionElement: string;
+ const memberGetAccessorElement: string;
+ const memberSetAccessorElement: string;
+ const memberVariableElement: string;
+ const constructorImplementationElement: string;
+ const callSignatureElement: string;
+ const indexSignatureElement: string;
+ const constructSignatureElement: string;
+ const parameterElement: string;
+ const typeParameterElement: string;
+ const primitiveType: string;
+ const label: string;
+ const alias: string;
+ const constElement: string;
+ const letElement: string;
+ }
+ module ScriptElementKindModifier {
+ const none: string;
+ const publicMemberModifier: string;
+ const privateMemberModifier: string;
+ const protectedMemberModifier: string;
+ const exportedModifier: string;
+ const ambientModifier: string;
+ const staticModifier: string;
+ const abstractModifier: string;
+ }
+ class ClassificationTypeNames {
+ static comment: string;
+ static identifier: string;
+ static keyword: string;
+ static numericLiteral: string;
+ static operator: string;
+ static stringLiteral: string;
+ static whiteSpace: string;
+ static text: string;
+ static punctuation: string;
+ static className: string;
+ static enumName: string;
+ static interfaceName: string;
+ static moduleName: string;
+ static typeParameterName: string;
+ static typeAliasName: string;
+ static parameterName: string;
+ static docCommentTagName: string;
+ }
+ const enum ClassificationType {
+ comment = 1,
+ identifier = 2,
+ keyword = 3,
+ numericLiteral = 4,
+ operator = 5,
+ stringLiteral = 6,
+ regularExpressionLiteral = 7,
+ whiteSpace = 8,
+ text = 9,
+ punctuation = 10,
+ className = 11,
+ enumName = 12,
+ interfaceName = 13,
+ moduleName = 14,
+ typeParameterName = 15,
+ typeAliasName = 16,
+ parameterName = 17,
+ docCommentTagName = 18,
+ }
+ interface DisplayPartsSymbolWriter extends SymbolWriter {
+ displayParts(): SymbolDisplayPart[];
+ }
+ function displayPartsToString(displayParts: SymbolDisplayPart[]): string;
+ function getDefaultCompilerOptions(): CompilerOptions;
+ interface TranspileOptions {
+ compilerOptions?: CompilerOptions;
+ fileName?: string;
+ reportDiagnostics?: boolean;
+ moduleName?: string;
+ renamedDependencies?: Map<string>;
+ }
+ interface TranspileOutput {
+ outputText: string;
+ diagnostics?: Diagnostic[];
+ sourceMapText?: string;
+ }
+ function transpileModule(input: string, transpileOptions: TranspileOptions): TranspileOutput;
+ function transpile(input: string, compilerOptions?: CompilerOptions, fileName?: string, diagnostics?: Diagnostic[], moduleName?: string): string;
+ function createLanguageServiceSourceFile(fileName: string, scriptSnapshot: IScriptSnapshot, scriptTarget: ScriptTarget, version: string, setNodeParents: boolean): SourceFile;
+ let disableIncrementalParsing: boolean;
+ function updateLanguageServiceSourceFile(sourceFile: SourceFile, scriptSnapshot: IScriptSnapshot, version: string, textChangeRange: TextChangeRange, aggressiveChecks?: boolean): SourceFile;
+ function createGetCanonicalFileName(useCaseSensitivefileNames: boolean): (fileName: string) => string;
+ function createDocumentRegistry(useCaseSensitiveFileNames?: boolean): DocumentRegistry;
+ function preProcessFile(sourceText: string, readImportFiles?: boolean): PreProcessedFileInfo;
+ function createLanguageService(host: LanguageServiceHost, documentRegistry?: DocumentRegistry): LanguageService;
+ function createClassifier(): Classifier;
+ /**
+ * Get the path of the default library files (lib.d.ts) as distributed with the typescript
+ * node package.
+ * The functionality is not supported if the ts module is consumed outside of a node module.
+ */
+ function getDefaultLibFilePath(options: CompilerOptions): string;
+}
diff --git a/typescript/typescript.d.ts b/typescript/typescript.d.ts
index 1139c46489..8078c6de27 100644
--- a/typescript/typescript.d.ts
+++ b/typescript/typescript.d.ts
@@ -22,6 +22,14 @@ declare module "typescript" {
interface Map<T> {
[index: string]: T;
}
+ interface FileMap<T> {
+ get(fileName: string): T;
+ set(fileName: string, value: T): void;
+ contains(fileName: string): boolean;
+ remove(fileName: string): void;
+ forEachValue(f: (v: T) => void): void;
+ clear(): void;
+ }
interface TextRange {
pos: number;
end: number;
@@ -33,230 +41,294 @@ declare module "typescript" {
MultiLineCommentTrivia = 3,
NewLineTrivia = 4,
WhitespaceTrivia = 5,
- NumericLiteral = 6,
- StringLiteral = 7,
- RegularExpressionLiteral = 8,
- NoSubstitutionTemplateLiteral = 9,
- TemplateHead = 10,
- TemplateMiddle = 11,
- TemplateTail = 12,
- OpenBraceToken = 13,
- CloseBraceToken = 14,
- OpenParenToken = 15,
- CloseParenToken = 16,
- OpenBracketToken = 17,
- CloseBracketToken = 18,
- DotToken = 19,
- DotDotDotToken = 20,
- SemicolonToken = 21,
- CommaToken = 22,
- LessThanToken = 23,
- GreaterThanToken = 24,
- LessThanEqualsToken = 25,
- GreaterThanEqualsToken = 26,
- EqualsEqualsToken = 27,
- ExclamationEqualsToken = 28,
- EqualsEqualsEqualsToken = 29,
- ExclamationEqualsEqualsToken = 30,
- EqualsGreaterThanToken = 31,
- PlusToken = 32,
- MinusToken = 33,
- AsteriskToken = 34,
- SlashToken = 35,
- PercentToken = 36,
- PlusPlusToken = 37,
- MinusMinusToken = 38,
- LessThanLessThanToken = 39,
- GreaterThanGreaterThanToken = 40,
- GreaterThanGreaterThanGreaterThanToken = 41,
- AmpersandToken = 42,
- BarToken = 43,
- CaretToken = 44,
- ExclamationToken = 45,
- TildeToken = 46,
- AmpersandAmpersandToken = 47,
- BarBarToken = 48,
- QuestionToken = 49,
- ColonToken = 50,
- EqualsToken = 51,
- PlusEqualsToken = 52,
- MinusEqualsToken = 53,
- AsteriskEqualsToken = 54,
- SlashEqualsToken = 55,
- PercentEqualsToken = 56,
- LessThanLessThanEqualsToken = 57,
- GreaterThanGreaterThanEqualsToken = 58,
- GreaterThanGreaterThanGreaterThanEqualsToken = 59,
- AmpersandEqualsToken = 60,
- BarEqualsToken = 61,
- CaretEqualsToken = 62,
- Identifier = 63,
- BreakKeyword = 64,
- CaseKeyword = 65,
- CatchKeyword = 66,
- ClassKeyword = 67,
- ConstKeyword = 68,
- ContinueKeyword = 69,
- DebuggerKeyword = 70,
- DefaultKeyword = 71,
- DeleteKeyword = 72,
- DoKeyword = 73,
- ElseKeyword = 74,
- EnumKeyword = 75,
- ExportKeyword = 76,
- ExtendsKeyword = 77,
- FalseKeyword = 78,
- FinallyKeyword = 79,
- ForKeyword = 80,
- FunctionKeyword = 81,
- IfKeyword = 82,
- ImportKeyword = 83,
- InKeyword = 84,
- InstanceOfKeyword = 85,
- NewKeyword = 86,
- NullKeyword = 87,
- ReturnKeyword = 88,
- SuperKeyword = 89,
- SwitchKeyword = 90,
- ThisKeyword = 91,
- ThrowKeyword = 92,
- TrueKeyword = 93,
- TryKeyword = 94,
- TypeOfKeyword = 95,
- VarKeyword = 96,
- VoidKeyword = 97,
- WhileKeyword = 98,
- WithKeyword = 99,
- ImplementsKeyword = 100,
- InterfaceKeyword = 101,
- LetKeyword = 102,
- PackageKeyword = 103,
- PrivateKeyword = 104,
- ProtectedKeyword = 105,
- PublicKeyword = 106,
- StaticKeyword = 107,
- YieldKeyword = 108,
- AnyKeyword = 109,
- BooleanKeyword = 110,
- ConstructorKeyword = 111,
- DeclareKeyword = 112,
- GetKeyword = 113,
- ModuleKeyword = 114,
- RequireKeyword = 115,
- NumberKeyword = 116,
- SetKeyword = 117,
- StringKeyword = 118,
- TypeKeyword = 119,
- QualifiedName = 120,
- ComputedPropertyName = 121,
- TypeParameter = 122,
- Parameter = 123,
- Property = 124,
- Method = 125,
- Constructor = 126,
- GetAccessor = 127,
- SetAccessor = 128,
- CallSignature = 129,
- ConstructSignature = 130,
- IndexSignature = 131,
- TypeReference = 132,
- FunctionType = 133,
- ConstructorType = 134,
- TypeQuery = 135,
- TypeLiteral = 136,
- ArrayType = 137,
- TupleType = 138,
- UnionType = 139,
- ParenthesizedType = 140,
- ArrayLiteralExpression = 141,
- ObjectLiteralExpression = 142,
- PropertyAccessExpression = 143,
- ElementAccessExpression = 144,
- CallExpression = 145,
- NewExpression = 146,
- TaggedTemplateExpression = 147,
- TypeAssertionExpression = 148,
- ParenthesizedExpression = 149,
- FunctionExpression = 150,
- ArrowFunction = 151,
- DeleteExpression = 152,
- TypeOfExpression = 153,
- VoidExpression = 154,
- PrefixUnaryExpression = 155,
- PostfixUnaryExpression = 156,
- BinaryExpression = 157,
- ConditionalExpression = 158,
- TemplateExpression = 159,
- YieldExpression = 160,
- OmittedExpression = 161,
- TemplateSpan = 162,
- Block = 163,
- VariableStatement = 164,
- EmptyStatement = 165,
- ExpressionStatement = 166,
- IfStatement = 167,
- DoStatement = 168,
- WhileStatement = 169,
- ForStatement = 170,
- ForInStatement = 171,
- ContinueStatement = 172,
- BreakStatement = 173,
- ReturnStatement = 174,
- WithStatement = 175,
- SwitchStatement = 176,
- LabeledStatement = 177,
- ThrowStatement = 178,
- TryStatement = 179,
- TryBlock = 180,
- FinallyBlock = 181,
- DebuggerStatement = 182,
- VariableDeclaration = 183,
- FunctionDeclaration = 184,
- ClassDeclaration = 185,
- InterfaceDeclaration = 186,
- TypeAliasDeclaration = 187,
- EnumDeclaration = 188,
- ModuleDeclaration = 189,
- ModuleBlock = 190,
- ImportDeclaration = 191,
- ExportAssignment = 192,
- ExternalModuleReference = 193,
- CaseClause = 194,
- DefaultClause = 195,
- HeritageClause = 196,
- CatchClause = 197,
- PropertyAssignment = 198,
- ShorthandPropertyAssignment = 199,
- EnumMember = 200,
- SourceFile = 201,
- Program = 202,
- SyntaxList = 203,
- Count = 204,
- FirstAssignment = 51,
- LastAssignment = 62,
- FirstReservedWord = 64,
- LastReservedWord = 99,
- FirstKeyword = 64,
- LastKeyword = 119,
- FirstFutureReservedWord = 100,
- LastFutureReservedWord = 108,
- FirstTypeNode = 132,
- LastTypeNode = 140,
- FirstPunctuation = 13,
- LastPunctuation = 62,
+ ShebangTrivia = 6,
+ ConflictMarkerTrivia = 7,
+ NumericLiteral = 8,
+ StringLiteral = 9,
+ RegularExpressionLiteral = 10,
+ NoSubstitutionTemplateLiteral = 11,
+ TemplateHead = 12,
+ TemplateMiddle = 13,
+ TemplateTail = 14,
+ OpenBraceToken = 15,
+ CloseBraceToken = 16,
+ OpenParenToken = 17,
+ CloseParenToken = 18,
+ OpenBracketToken = 19,
+ CloseBracketToken = 20,
+ DotToken = 21,
+ DotDotDotToken = 22,
+ SemicolonToken = 23,
+ CommaToken = 24,
+ LessThanToken = 25,
+ LessThanSlashToken = 26,
+ GreaterThanToken = 27,
+ LessThanEqualsToken = 28,
+ GreaterThanEqualsToken = 29,
+ EqualsEqualsToken = 30,
+ ExclamationEqualsToken = 31,
+ EqualsEqualsEqualsToken = 32,
+ ExclamationEqualsEqualsToken = 33,
+ EqualsGreaterThanToken = 34,
+ PlusToken = 35,
+ MinusToken = 36,
+ AsteriskToken = 37,
+ SlashToken = 38,
+ PercentToken = 39,
+ PlusPlusToken = 40,
+ MinusMinusToken = 41,
+ LessThanLessThanToken = 42,
+ GreaterThanGreaterThanToken = 43,
+ GreaterThanGreaterThanGreaterThanToken = 44,
+ AmpersandToken = 45,
+ BarToken = 46,
+ CaretToken = 47,
+ ExclamationToken = 48,
+ TildeToken = 49,
+ AmpersandAmpersandToken = 50,
+ BarBarToken = 51,
+ QuestionToken = 52,
+ ColonToken = 53,
+ AtToken = 54,
+ EqualsToken = 55,
+ PlusEqualsToken = 56,
+ MinusEqualsToken = 57,
+ AsteriskEqualsToken = 58,
+ SlashEqualsToken = 59,
+ PercentEqualsToken = 60,
+ LessThanLessThanEqualsToken = 61,
+ GreaterThanGreaterThanEqualsToken = 62,
+ GreaterThanGreaterThanGreaterThanEqualsToken = 63,
+ AmpersandEqualsToken = 64,
+ BarEqualsToken = 65,
+ CaretEqualsToken = 66,
+ Identifier = 67,
+ BreakKeyword = 68,
+ CaseKeyword = 69,
+ CatchKeyword = 70,
+ ClassKeyword = 71,
+ ConstKeyword = 72,
+ ContinueKeyword = 73,
+ DebuggerKeyword = 74,
+ DefaultKeyword = 75,
+ DeleteKeyword = 76,
+ DoKeyword = 77,
+ ElseKeyword = 78,
+ EnumKeyword = 79,
+ ExportKeyword = 80,
+ ExtendsKeyword = 81,
+ FalseKeyword = 82,
+ FinallyKeyword = 83,
+ ForKeyword = 84,
+ FunctionKeyword = 85,
+ IfKeyword = 86,
+ ImportKeyword = 87,
+ InKeyword = 88,
+ InstanceOfKeyword = 89,
+ NewKeyword = 90,
+ NullKeyword = 91,
+ ReturnKeyword = 92,
+ SuperKeyword = 93,
+ SwitchKeyword = 94,
+ ThisKeyword = 95,
+ ThrowKeyword = 96,
+ TrueKeyword = 97,
+ TryKeyword = 98,
+ TypeOfKeyword = 99,
+ VarKeyword = 100,
+ VoidKeyword = 101,
+ WhileKeyword = 102,
+ WithKeyword = 103,
+ ImplementsKeyword = 104,
+ InterfaceKeyword = 105,
+ LetKeyword = 106,
+ PackageKeyword = 107,
+ PrivateKeyword = 108,
+ ProtectedKeyword = 109,
+ PublicKeyword = 110,
+ StaticKeyword = 111,
+ YieldKeyword = 112,
+ AbstractKeyword = 113,
+ AsKeyword = 114,
+ AnyKeyword = 115,
+ AsyncKeyword = 116,
+ AwaitKeyword = 117,
+ BooleanKeyword = 118,
+ ConstructorKeyword = 119,
+ DeclareKeyword = 120,
+ GetKeyword = 121,
+ IsKeyword = 122,
+ ModuleKeyword = 123,
+ NamespaceKeyword = 124,
+ RequireKeyword = 125,
+ NumberKeyword = 126,
+ SetKeyword = 127,
+ StringKeyword = 128,
+ SymbolKeyword = 129,
+ TypeKeyword = 130,
+ FromKeyword = 131,
+ OfKeyword = 132,
+ QualifiedName = 133,
+ ComputedPropertyName = 134,
+ TypeParameter = 135,
+ Parameter = 136,
+ Decorator = 137,
+ PropertySignature = 138,
+ PropertyDeclaration = 139,
+ MethodSignature = 140,
+ MethodDeclaration = 141,
+ Constructor = 142,
+ GetAccessor = 143,
+ SetAccessor = 144,
+ CallSignature = 145,
+ ConstructSignature = 146,
+ IndexSignature = 147,
+ TypePredicate = 148,
+ TypeReference = 149,
+ FunctionType = 150,
+ ConstructorType = 151,
+ TypeQuery = 152,
+ TypeLiteral = 153,
+ ArrayType = 154,
+ TupleType = 155,
+ UnionType = 156,
+ IntersectionType = 157,
+ ParenthesizedType = 158,
+ ObjectBindingPattern = 159,
+ ArrayBindingPattern = 160,
+ BindingElement = 161,
+ ArrayLiteralExpression = 162,
+ ObjectLiteralExpression = 163,
+ PropertyAccessExpression = 164,
+ ElementAccessExpression = 165,
+ CallExpression = 166,
+ NewExpression = 167,
+ TaggedTemplateExpression = 168,
+ TypeAssertionExpression = 169,
+ ParenthesizedExpression = 170,
+ FunctionExpression = 171,
+ ArrowFunction = 172,
+ DeleteExpression = 173,
+ TypeOfExpression = 174,
+ VoidExpression = 175,
+ AwaitExpression = 176,
+ PrefixUnaryExpression = 177,
+ PostfixUnaryExpression = 178,
+ BinaryExpression = 179,
+ ConditionalExpression = 180,
+ TemplateExpression = 181,
+ YieldExpression = 182,
+ SpreadElementExpression = 183,
+ ClassExpression = 184,
+ OmittedExpression = 185,
+ ExpressionWithTypeArguments = 186,
+ AsExpression = 187,
+ TemplateSpan = 188,
+ SemicolonClassElement = 189,
+ Block = 190,
+ VariableStatement = 191,
+ EmptyStatement = 192,
+ ExpressionStatement = 193,
+ IfStatement = 194,
+ DoStatement = 195,
+ WhileStatement = 196,
+ ForStatement = 197,
+ ForInStatement = 198,
+ ForOfStatement = 199,
+ ContinueStatement = 200,
+ BreakStatement = 201,
+ ReturnStatement = 202,
+ WithStatement = 203,
+ SwitchStatement = 204,
+ LabeledStatement = 205,
+ ThrowStatement = 206,
+ TryStatement = 207,
+ DebuggerStatement = 208,
+ VariableDeclaration = 209,
+ VariableDeclarationList = 210,
+ FunctionDeclaration = 211,
+ ClassDeclaration = 212,
+ InterfaceDeclaration = 213,
+ TypeAliasDeclaration = 214,
+ EnumDeclaration = 215,
+ ModuleDeclaration = 216,
+ ModuleBlock = 217,
+ CaseBlock = 218,
+ ImportEqualsDeclaration = 219,
+ ImportDeclaration = 220,
+ ImportClause = 221,
+ NamespaceImport = 222,
+ NamedImports = 223,
+ ImportSpecifier = 224,
+ ExportAssignment = 225,
+ ExportDeclaration = 226,
+ NamedExports = 227,
+ ExportSpecifier = 228,
+ MissingDeclaration = 229,
+ ExternalModuleReference = 230,
+ JsxElement = 231,
+ JsxSelfClosingElement = 232,
+ JsxOpeningElement = 233,
+ JsxText = 234,
+ JsxClosingElement = 235,
+ JsxAttribute = 236,
+ JsxSpreadAttribute = 237,
+ JsxExpression = 238,
+ CaseClause = 239,
+ DefaultClause = 240,
+ HeritageClause = 241,
+ CatchClause = 242,
+ PropertyAssignment = 243,
+ ShorthandPropertyAssignment = 244,
+ EnumMember = 245,
+ SourceFile = 246,
+ JSDocTypeExpression = 247,
+ JSDocAllType = 248,
+ JSDocUnknownType = 249,
+ JSDocArrayType = 250,
+ JSDocUnionType = 251,
+ JSDocTupleType = 252,
+ JSDocNullableType = 253,
+ JSDocNonNullableType = 254,
+ JSDocRecordType = 255,
+ JSDocRecordMember = 256,
+ JSDocTypeReference = 257,
+ JSDocOptionalType = 258,
+ JSDocFunctionType = 259,
+ JSDocVariadicType = 260,
+ JSDocConstructorType = 261,
+ JSDocThisType = 262,
+ JSDocComment = 263,
+ JSDocTag = 264,
+ JSDocParameterTag = 265,
+ JSDocReturnTag = 266,
+ JSDocTypeTag = 267,
+ JSDocTemplateTag = 268,
+ SyntaxList = 269,
+ Count = 270,
+ FirstAssignment = 55,
+ LastAssignment = 66,
+ FirstReservedWord = 68,
+ LastReservedWord = 103,
+ FirstKeyword = 68,
+ LastKeyword = 132,
+ FirstFutureReservedWord = 104,
+ LastFutureReservedWord = 112,
+ FirstTypeNode = 149,
+ LastTypeNode = 158,
+ FirstPunctuation = 15,
+ LastPunctuation = 66,
FirstToken = 0,
- LastToken = 119,
+ LastToken = 132,
FirstTriviaToken = 2,
- LastTriviaToken = 5,
- FirstLiteralToken = 6,
- LastLiteralToken = 9,
- FirstTemplateToken = 9,
- LastTemplateToken = 12,
- FirstOperator = 21,
- LastOperator = 62,
- FirstBinaryOperator = 23,
- LastBinaryOperator = 62,
- FirstNode = 120,
+ LastTriviaToken = 7,
+ FirstLiteralToken = 8,
+ LastLiteralToken = 11,
+ FirstTemplateToken = 11,
+ LastTemplateToken = 14,
+ FirstBinaryOperator = 25,
+ LastBinaryOperator = 66,
+ FirstNode = 133,
}
const enum NodeFlags {
Export = 1,
@@ -265,35 +337,35 @@ declare module "typescript" {
Private = 32,
Protected = 64,
Static = 128,
- MultiLine = 256,
- Synthetic = 512,
- DeclarationFile = 1024,
- Let = 2048,
- Const = 4096,
- OctalLiteral = 8192,
- Modifier = 243,
+ Abstract = 256,
+ Async = 512,
+ Default = 1024,
+ MultiLine = 2048,
+ Synthetic = 4096,
+ DeclarationFile = 8192,
+ Let = 16384,
+ Const = 32768,
+ OctalLiteral = 65536,
+ Namespace = 131072,
+ ExportContext = 262144,
+ Modifier = 2035,
AccessibilityModifier = 112,
- BlockScoped = 6144,
+ BlockScoped = 49152,
}
- const enum ParserContextFlags {
- StrictMode = 1,
- DisallowIn = 2,
- Yield = 4,
- GeneratorParameter = 8,
- ContainsError = 16,
- HasPropagatedChildContainsErrorFlag = 32,
+ const enum JsxFlags {
+ None = 0,
+ IntrinsicNamedElement = 1,
+ IntrinsicIndexedElement = 2,
+ ClassElement = 4,
+ UnknownElement = 8,
+ IntrinsicElement = 3,
}
interface Node extends TextRange {
kind: SyntaxKind;
flags: NodeFlags;
- parserContextFlags?: ParserContextFlags;
- id?: number;
- parent?: Node;
- symbol?: Symbol;
- locals?: SymbolTable;
- nextContainer?: Node;
- localSymbol?: Symbol;
+ decorators?: NodeArray<Decorator>;
modifiers?: ModifiersArray;
+ parent?: Node;
}
interface NodeArray<T> extends Array<T>, TextRange {
hasTrailingComma?: boolean;
@@ -303,13 +375,14 @@ declare module "typescript" {
}
interface Identifier extends PrimaryExpression {
text: string;
+ originalKeywordKind?: SyntaxKind;
}
interface QualifiedName extends Node {
left: EntityName;
right: Identifier;
}
type EntityName = Identifier | QualifiedName;
- type DeclarationName = Identifier | LiteralExpression | ComputedPropertyName;
+ type DeclarationName = Identifier | LiteralExpression | ComputedPropertyName | BindingPattern;
interface Declaration extends Node {
_declarationBrand: any;
name?: DeclarationName;
@@ -317,6 +390,9 @@ declare module "typescript" {
interface ComputedPropertyName extends Node {
expression: Expression;
}
+ interface Decorator extends Node {
+ expression: LeftHandSideExpression;
+ }
interface TypeParameterDeclaration extends Declaration {
name: Identifier;
constraint?: TypeNode;
@@ -328,45 +404,64 @@ declare module "typescript" {
type?: TypeNode;
}
interface VariableDeclaration extends Declaration {
- name: Identifier;
+ parent?: VariableDeclarationList;
+ name: Identifier | BindingPattern;
type?: TypeNode;
initializer?: Expression;
}
+ interface VariableDeclarationList extends Node {
+ declarations: NodeArray<VariableDeclaration>;
+ }
interface ParameterDeclaration extends Declaration {
dotDotDotToken?: Node;
- name: Identifier;
- questionToken?: Node;
- type?: TypeNode | StringLiteralExpression;
- initializer?: Expression;
- }
- interface PropertyDeclaration extends Declaration, ClassElement {
- _propertyDeclarationBrand: any;
+ name: Identifier | BindingPattern;
+ questionToken?: Node;
+ type?: TypeNode;
+ initializer?: Expression;
+ }
+ interface BindingElement extends Declaration {
+ propertyName?: Identifier;
+ dotDotDotToken?: Node;
+ name: Identifier | BindingPattern;
+ initializer?: Expression;
+ }
+ interface PropertyDeclaration extends Declaration, ClassElement {
+ name: DeclarationName;
questionToken?: Node;
type?: TypeNode;
initializer?: Expression;
}
- type VariableOrParameterDeclaration = VariableDeclaration | ParameterDeclaration;
- type VariableOrParameterOrPropertyDeclaration = VariableOrParameterDeclaration | PropertyDeclaration;
interface ObjectLiteralElement extends Declaration {
_objectLiteralBrandBrand: any;
}
- interface ShorthandPropertyAssignment extends ObjectLiteralElement {
- name: Identifier;
- questionToken?: Node;
- }
interface PropertyAssignment extends ObjectLiteralElement {
_propertyAssignmentBrand: any;
name: DeclarationName;
questionToken?: Node;
initializer: Expression;
}
+ interface ShorthandPropertyAssignment extends ObjectLiteralElement {
+ name: Identifier;
+ questionToken?: Node;
+ }
+ interface VariableLikeDeclaration extends Declaration {
+ propertyName?: Identifier;
+ dotDotDotToken?: Node;
+ name: DeclarationName;
+ questionToken?: Node;
+ type?: TypeNode;
+ initializer?: Expression;
+ }
+ interface BindingPattern extends Node {
+ elements: NodeArray<BindingElement>;
+ }
/**
* Several node kinds share function-like features such as a signature,
* a name, and a body. These nodes should extend FunctionLikeDeclaration.
* Examples:
- * FunctionDeclaration
- * MethodDeclaration
- * AccessorDeclaration
+ * - FunctionDeclaration
+ * - MethodDeclaration
+ * - AccessorDeclaration
*/
interface FunctionLikeDeclaration extends SignatureDeclaration {
_functionLikeDeclarationBrand: any;
@@ -375,7 +470,7 @@ declare module "typescript" {
body?: Block | Expression;
}
interface FunctionDeclaration extends FunctionLikeDeclaration, Statement {
- name: Identifier;
+ name?: Identifier;
body?: Block;
}
interface MethodDeclaration extends FunctionLikeDeclaration, ClassElement, ObjectLiteralElement {
@@ -384,6 +479,9 @@ declare module "typescript" {
interface ConstructorDeclaration extends FunctionLikeDeclaration, ClassElement {
body?: Block;
}
+ interface SemicolonClassElement extends ClassElement {
+ _semicolonClassElementBrand: any;
+ }
interface AccessorDeclaration extends FunctionLikeDeclaration, ClassElement, ObjectLiteralElement {
_accessorDeclarationBrand: any;
body: Block;
@@ -401,6 +499,10 @@ declare module "typescript" {
typeName: EntityName;
typeArguments?: NodeArray<TypeNode>;
}
+ interface TypePredicateNode extends TypeNode {
+ parameterName: Identifier;
+ type: TypeNode;
+ }
interface TypeQueryNode extends TypeNode {
exprName: EntityName;
}
@@ -413,12 +515,19 @@ declare module "typescript" {
interface TupleTypeNode extends TypeNode {
elementTypes: NodeArray<TypeNode>;
}
- interface UnionTypeNode extends TypeNode {
+ interface UnionOrIntersectionTypeNode extends TypeNode {
types: NodeArray<TypeNode>;
}
+ interface UnionTypeNode extends UnionOrIntersectionTypeNode {
+ }
+ interface IntersectionTypeNode extends UnionOrIntersectionTypeNode {
+ }
interface ParenthesizedTypeNode extends TypeNode {
type: TypeNode;
}
+ interface StringLiteral extends LiteralExpression, TypeNode {
+ _stringLiteralBrand: any;
+ }
interface Expression extends Node {
_expressionBrand: any;
contextualType?: Type;
@@ -455,30 +564,36 @@ declare module "typescript" {
interface VoidExpression extends UnaryExpression {
expression: UnaryExpression;
}
+ interface AwaitExpression extends UnaryExpression {
+ expression: UnaryExpression;
+ }
interface YieldExpression extends Expression {
asteriskToken?: Node;
- expression: Expression;
+ expression?: Expression;
}
interface BinaryExpression extends Expression {
left: Expression;
- operator: SyntaxKind;
+ operatorToken: Node;
right: Expression;
}
interface ConditionalExpression extends Expression {
condition: Expression;
+ questionToken: Node;
whenTrue: Expression;
+ colonToken: Node;
whenFalse: Expression;
}
interface FunctionExpression extends PrimaryExpression, FunctionLikeDeclaration {
name?: Identifier;
body: Block | Expression;
}
+ interface ArrowFunction extends Expression, FunctionLikeDeclaration {
+ equalsGreaterThanToken: Node;
+ }
interface LiteralExpression extends PrimaryExpression {
text: string;
isUnterminated?: boolean;
- }
- interface StringLiteralExpression extends LiteralExpression {
- _stringLiteralExpressionBrand: any;
+ hasExtendedUnicodeEscape?: boolean;
}
interface TemplateExpression extends PrimaryExpression {
head: LiteralExpression;
@@ -494,11 +609,15 @@ declare module "typescript" {
interface ArrayLiteralExpression extends PrimaryExpression {
elements: NodeArray<Expression>;
}
+ interface SpreadElementExpression extends Expression {
+ expression: Expression;
+ }
interface ObjectLiteralExpression extends PrimaryExpression, Declaration {
properties: NodeArray<ObjectLiteralElement>;
}
interface PropertyAccessExpression extends MemberExpression {
expression: LeftHandSideExpression;
+ dotToken: Node;
name: Identifier;
}
interface ElementAccessExpression extends MemberExpression {
@@ -510,25 +629,65 @@ declare module "typescript" {
typeArguments?: NodeArray<TypeNode>;
arguments: NodeArray<Expression>;
}
+ interface ExpressionWithTypeArguments extends TypeNode {
+ expression: LeftHandSideExpression;
+ typeArguments?: NodeArray<TypeNode>;
+ }
interface NewExpression extends CallExpression, PrimaryExpression {
}
interface TaggedTemplateExpression extends MemberExpression {
tag: LeftHandSideExpression;
template: LiteralExpression | TemplateExpression;
}
- type CallLikeExpression = CallExpression | NewExpression | TaggedTemplateExpression;
+ type CallLikeExpression = CallExpression | NewExpression | TaggedTemplateExpression | Decorator;
+ interface AsExpression extends Expression {
+ expression: Expression;
+ type: TypeNode;
+ }
interface TypeAssertion extends UnaryExpression {
type: TypeNode;
expression: UnaryExpression;
}
- interface Statement extends Node, ModuleElement {
+ type AssertionExpression = TypeAssertion | AsExpression;
+ interface JsxElement extends PrimaryExpression {
+ openingElement: JsxOpeningElement;
+ children: NodeArray<JsxChild>;
+ closingElement: JsxClosingElement;
+ }
+ interface JsxOpeningElement extends Expression {
+ _openingElementBrand?: any;
+ tagName: EntityName;
+ attributes: NodeArray<JsxAttribute | JsxSpreadAttribute>;
+ }
+ interface JsxSelfClosingElement extends PrimaryExpression, JsxOpeningElement {
+ _selfClosingElementBrand?: any;
+ }
+ type JsxOpeningLikeElement = JsxSelfClosingElement | JsxOpeningElement;
+ interface JsxAttribute extends Node {
+ name: Identifier;
+ initializer?: Expression;
+ }
+ interface JsxSpreadAttribute extends Node {
+ expression: Expression;
+ }
+ interface JsxClosingElement extends Node {
+ tagName: EntityName;
+ }
+ interface JsxExpression extends Expression {
+ expression?: Expression;
+ }
+ interface JsxText extends Node {
+ _jsxTextExpressionBrand: any;
+ }
+ type JsxChild = JsxText | JsxExpression | JsxElement | JsxSelfClosingElement;
+ interface Statement extends Node {
_statementBrand: any;
}
interface Block extends Statement {
statements: NodeArray<Statement>;
}
interface VariableStatement extends Statement {
- declarations: NodeArray<VariableDeclaration>;
+ declarationList: VariableDeclarationList;
}
interface ExpressionStatement extends Statement {
expression: Expression;
@@ -548,14 +707,16 @@ declare module "typescript" {
expression: Expression;
}
interface ForStatement extends IterationStatement {
- declarations?: NodeArray<VariableDeclaration>;
- initializer?: Expression;
+ initializer?: VariableDeclarationList | Expression;
condition?: Expression;
- iterator?: Expression;
+ incrementor?: Expression;
}
interface ForInStatement extends IterationStatement {
- declarations?: NodeArray<VariableDeclaration>;
- variable?: Expression;
+ initializer: VariableDeclarationList | Expression;
+ expression: Expression;
+ }
+ interface ForOfStatement extends IterationStatement {
+ initializer: VariableDeclarationList | Expression;
expression: Expression;
}
interface BreakOrContinueStatement extends Statement {
@@ -570,6 +731,9 @@ declare module "typescript" {
}
interface SwitchStatement extends Statement {
expression: Expression;
+ caseBlock: CaseBlock;
+ }
+ interface CaseBlock extends Node {
clauses: NodeArray<CaseOrDefaultClause>;
}
interface CaseClause extends Node {
@@ -592,24 +756,24 @@ declare module "typescript" {
catchClause?: CatchClause;
finallyBlock?: Block;
}
- interface CatchClause extends Declaration {
- name: Identifier;
- type?: TypeNode;
+ interface CatchClause extends Node {
+ variableDeclaration: VariableDeclaration;
block: Block;
}
- interface ModuleElement extends Node {
- _moduleElementBrand: any;
- }
- interface ClassDeclaration extends Declaration, ModuleElement {
- name: Identifier;
+ interface ClassLikeDeclaration extends Declaration {
+ name?: Identifier;
typeParameters?: NodeArray<TypeParameterDeclaration>;
heritageClauses?: NodeArray<HeritageClause>;
members: NodeArray<ClassElement>;
}
+ interface ClassDeclaration extends ClassLikeDeclaration, Statement {
+ }
+ interface ClassExpression extends ClassLikeDeclaration, PrimaryExpression {
+ }
interface ClassElement extends Declaration {
_classElementBrand: any;
}
- interface InterfaceDeclaration extends Declaration, ModuleElement {
+ interface InterfaceDeclaration extends Declaration, Statement {
name: Identifier;
typeParameters?: NodeArray<TypeParameterDeclaration>;
heritageClauses?: NodeArray<HeritageClause>;
@@ -617,85 +781,231 @@ declare module "typescript" {
}
interface HeritageClause extends Node {
token: SyntaxKind;
- types?: NodeArray<TypeReferenceNode>;
+ types?: NodeArray<ExpressionWithTypeArguments>;
}
- interface TypeAliasDeclaration extends Declaration, ModuleElement {
+ interface TypeAliasDeclaration extends Declaration, Statement {
name: Identifier;
+ typeParameters?: NodeArray<TypeParameterDeclaration>;
type: TypeNode;
}
interface EnumMember extends Declaration {
name: DeclarationName;
initializer?: Expression;
}
- interface EnumDeclaration extends Declaration, ModuleElement {
+ interface EnumDeclaration extends Declaration, Statement {
name: Identifier;
members: NodeArray<EnumMember>;
}
- interface ModuleDeclaration extends Declaration, ModuleElement {
+ interface ModuleDeclaration extends Declaration, Statement {
name: Identifier | LiteralExpression;
body: ModuleBlock | ModuleDeclaration;
}
- interface ModuleBlock extends Node, ModuleElement {
- statements: NodeArray<ModuleElement>;
+ interface ModuleBlock extends Node, Statement {
+ statements: NodeArray<Statement>;
}
- interface ImportDeclaration extends Declaration, ModuleElement {
+ interface ImportEqualsDeclaration extends Declaration, Statement {
name: Identifier;
moduleReference: EntityName | ExternalModuleReference;
}
interface ExternalModuleReference extends Node {
expression?: Expression;
}
- interface ExportAssignment extends Statement, ModuleElement {
- exportName: Identifier;
+ interface ImportDeclaration extends Statement {
+ importClause?: ImportClause;
+ moduleSpecifier: Expression;
+ }
+ interface ImportClause extends Declaration {
+ name?: Identifier;
+ namedBindings?: NamespaceImport | NamedImports;
+ }
+ interface NamespaceImport extends Declaration {
+ name: Identifier;
+ }
+ interface ExportDeclaration extends Declaration, Statement {
+ exportClause?: NamedExports;
+ moduleSpecifier?: Expression;
+ }
+ interface NamedImportsOrExports extends Node {
+ elements: NodeArray<ImportOrExportSpecifier>;
+ }
+ type NamedImports = NamedImportsOrExports;
+ type NamedExports = NamedImportsOrExports;
+ interface ImportOrExportSpecifier extends Declaration {
+ propertyName?: Identifier;
+ name: Identifier;
+ }
+ type ImportSpecifier = ImportOrExportSpecifier;
+ type ExportSpecifier = ImportOrExportSpecifier;
+ interface ExportAssignment extends Declaration, Statement {
+ isExportEquals?: boolean;
+ expression: Expression;
}
interface FileReference extends TextRange {
- filename: string;
+ fileName: string;
}
interface CommentRange extends TextRange {
hasTrailingNewLine?: boolean;
+ kind: SyntaxKind;
+ }
+ interface JSDocTypeExpression extends Node {
+ type: JSDocType;
+ }
+ interface JSDocType extends TypeNode {
+ _jsDocTypeBrand: any;
+ }
+ interface JSDocAllType extends JSDocType {
+ _JSDocAllTypeBrand: any;
+ }
+ interface JSDocUnknownType extends JSDocType {
+ _JSDocUnknownTypeBrand: any;
+ }
+ interface JSDocArrayType extends JSDocType {
+ elementType: JSDocType;
+ }
+ interface JSDocUnionType extends JSDocType {
+ types: NodeArray<JSDocType>;
+ }
+ interface JSDocTupleType extends JSDocType {
+ types: NodeArray<JSDocType>;
+ }
+ interface JSDocNonNullableType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocNullableType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocRecordType extends JSDocType, TypeLiteralNode {
+ members: NodeArray<JSDocRecordMember>;
+ }
+ interface JSDocTypeReference extends JSDocType {
+ name: EntityName;
+ typeArguments: NodeArray<JSDocType>;
+ }
+ interface JSDocOptionalType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocFunctionType extends JSDocType, SignatureDeclaration {
+ parameters: NodeArray<ParameterDeclaration>;
+ type: JSDocType;
+ }
+ interface JSDocVariadicType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocConstructorType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocThisType extends JSDocType {
+ type: JSDocType;
+ }
+ interface JSDocRecordMember extends PropertyDeclaration {
+ name: Identifier | LiteralExpression;
+ type?: JSDocType;
+ }
+ interface JSDocComment extends Node {
+ tags: NodeArray<JSDocTag>;
+ }
+ interface JSDocTag extends Node {
+ atToken: Node;
+ tagName: Identifier;
+ }
+ interface JSDocTemplateTag extends JSDocTag {
+ typeParameters: NodeArray<TypeParameterDeclaration>;
+ }
+ interface JSDocReturnTag extends JSDocTag {
+ typeExpression: JSDocTypeExpression;
+ }
+ interface JSDocTypeTag extends JSDocTag {
+ typeExpression: JSDocTypeExpression;
+ }
+ interface JSDocParameterTag extends JSDocTag {
+ preParameterName?: Identifier;
+ typeExpression?: JSDocTypeExpression;
+ postParameterName?: Identifier;
+ isBracketed: boolean;
}
interface SourceFile extends Declaration {
- statements: NodeArray<ModuleElement>;
+ statements: NodeArray<Statement>;
endOfFileToken: Node;
- filename: string;
+ fileName: string;
text: string;
- getLineAndCharacterFromPosition(position: number): LineAndCharacter;
- getPositionFromLineAndCharacter(line: number, character: number): number;
- getLineStarts(): number[];
- amdDependencies: string[];
- amdModuleName: string;
+ amdDependencies: {
+ path: string;
+ name: string;
+ }[];
+ moduleName: string;
referencedFiles: FileReference[];
- referenceDiagnostics: Diagnostic[];
- parseDiagnostics: Diagnostic[];
- grammarDiagnostics: Diagnostic[];
- getSyntacticDiagnostics(): Diagnostic[];
- semanticDiagnostics: Diagnostic[];
+ languageVariant: LanguageVariant;
+ /**
+ * lib.d.ts should have a reference comment like
+ *
+ * /// <reference no-default-lib="true"/>
+ *
+ * If any other file has this comment, it signals not to include lib.d.ts
+ * because this containing file is intended to act as a default library.
+ */
hasNoDefaultLib: boolean;
- externalModuleIndicator: Node;
- nodeCount: number;
- identifierCount: number;
- symbolCount: number;
- isOpen: boolean;
- version: string;
languageVersion: ScriptTarget;
- identifiers: Map<string>;
}
- interface Program {
- getSourceFile(filename: string): SourceFile;
- getSourceFiles(): SourceFile[];
+ interface ScriptReferenceHost {
getCompilerOptions(): CompilerOptions;
- getCompilerHost(): CompilerHost;
- getDiagnostics(sourceFile?: SourceFile): Diagnostic[];
- getGlobalDiagnostics(): Diagnostic[];
- getTypeChecker(fullTypeCheckMode: boolean): TypeChecker;
- getCommonSourceDirectory(): string;
+ getSourceFile(fileName: string): SourceFile;
+ getCurrentDirectory(): string;
+ }
+ interface ParseConfigHost extends ModuleResolutionHost {
+ readDirectory(rootDir: string, extension: string, exclude: string[]): string[];
+ }
+ interface WriteFileCallback {
+ (fileName: string, data: string, writeByteOrderMark: boolean, onError?: (message: string) => void): void;
+ }
+ class OperationCanceledException {
+ }
+ interface CancellationToken {
+ isCancellationRequested(): boolean;
+ /** @throws OperationCanceledException if isCancellationRequested is true */
+ throwIfCancellationRequested(): void;
+ }
+ interface Program extends ScriptReferenceHost {
+ /**
+ * Get a list of root file names that were passed to a 'createProgram'
+ */
+ getRootFileNames(): string[];
+ /**
+ * Get a list of files in the program
+ */
+ getSourceFiles(): SourceFile[];
+ /**
+ * Emits the JavaScript and declaration files. If targetSourceFile is not specified, then
+ * the JavaScript and declaration files will be produced for all the files in this program.
+ * If targetSourceFile is specified, then only the JavaScript and declaration for that
+ * specific file will be generated.
+ *
+ * If writeFile is not specified then the writeFile callback from the compiler host will be
+ * used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter
+ * will be invoked when writing the JavaScript and declaration files.
+ */
+ emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken): EmitResult;
+ getOptionsDiagnostics(cancellationToken?: CancellationToken): Diagnostic[];
+ getGlobalDiagnostics(cancellationToken?: CancellationToken): Diagnostic[];
+ getSyntacticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ getSemanticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ /**
+ * Gets a type checker that can be used to semantically analyze source fils in the program.
+ */
+ getTypeChecker(): TypeChecker;
}
interface SourceMapSpan {
+ /** Line number in the .js file. */
emittedLine: number;
+ /** Column number in the .js file. */
emittedColumn: number;
+ /** Line number in the .ts file. */
sourceLine: number;
+ /** Column number in the .ts file. */
sourceColumn: number;
+ /** Optional name (index into names array) associated with this span. */
nameIndex?: number;
+ /** .ts file (index into sources array) associated with this span */
sourceIndex: number;
}
interface SourceMapData {
@@ -704,40 +1014,30 @@ declare module "typescript" {
sourceMapFile: string;
sourceMapSourceRoot: string;
sourceMapSources: string[];
+ sourceMapSourcesContent?: string[];
inputSourceFileNames: string[];
sourceMapNames?: string[];
sourceMapMappings: string;
sourceMapDecodedMappings: SourceMapSpan[];
}
- enum EmitReturnStatus {
- Succeeded = 0,
- AllOutputGenerationSkipped = 1,
- JSGeneratedWithSemanticErrors = 2,
- DeclarationGenerationSkipped = 3,
- EmitErrorsEncountered = 4,
- CompilerOptionsErrors = 5,
+ /** Return code used by getEmitOutput function to indicate status of the function */
+ enum ExitStatus {
+ Success = 0,
+ DiagnosticsPresent_OutputsSkipped = 1,
+ DiagnosticsPresent_OutputsGenerated = 2,
}
interface EmitResult {
- emitResultStatus: EmitReturnStatus;
+ emitSkipped: boolean;
diagnostics: Diagnostic[];
- sourceMaps: SourceMapData[];
}
interface TypeChecker {
- getProgram(): Program;
- getDiagnostics(sourceFile?: SourceFile): Diagnostic[];
- getDeclarationDiagnostics(sourceFile: SourceFile): Diagnostic[];
- getGlobalDiagnostics(): Diagnostic[];
- getNodeCount(): number;
- getIdentifierCount(): number;
- getSymbolCount(): number;
- getTypeCount(): number;
- emitFiles(targetSourceFile?: SourceFile): EmitResult;
getTypeOfSymbolAtLocation(symbol: Symbol, node: Node): Type;
getDeclaredTypeOfSymbol(symbol: Symbol): Type;
getPropertiesOfType(type: Type): Symbol[];
getPropertyOfType(type: Type, propertyName: string): Symbol;
getSignaturesOfType(type: Type, kind: SignatureKind): Signature[];
getIndexTypeOfType(type: Type, kind: IndexKind): Type;
+ getBaseTypes(type: InterfaceType): ObjectType[];
getReturnTypeOfSignature(signature: Signature): Type;
getSymbolsInScope(location: Node, meaning: SymbolFlags): Symbol[];
getSymbolAtLocation(node: Node): Symbol;
@@ -755,10 +1055,13 @@ declare module "typescript" {
isImplementationOfOverload(node: FunctionLikeDeclaration): boolean;
isUndefinedSymbol(symbol: Symbol): boolean;
isArgumentsSymbol(symbol: Symbol): boolean;
- isEmitBlocked(sourceFile?: SourceFile): boolean;
- getEnumMemberValue(node: EnumMember): number;
+ getConstantValue(node: EnumMember | PropertyAccessExpression | ElementAccessExpression): number;
isValidPropertyAccess(node: PropertyAccessExpression | QualifiedName, propertyName: string): boolean;
getAliasedSymbol(symbol: Symbol): Symbol;
+ getExportsOfModule(moduleSymbol: Symbol): Symbol[];
+ getJsxElementAttributesType(elementNode: JsxOpeningLikeElement): Type;
+ getJsxIntrinsicTagNames(): Symbol[];
+ isOptionalParameter(node: ParameterDeclaration): boolean;
}
interface SymbolDisplayBuilder {
buildTypeDisplay(type: Type, writer: SymbolWriter, enclosingDeclaration?: Node, flags?: TypeFormatFlags): void;
@@ -794,46 +1097,20 @@ declare module "typescript" {
WriteOwnNameForAnyLike = 16,
WriteTypeArgumentsOfSignature = 32,
InElementType = 64,
+ UseFullyQualifiedType = 128,
}
const enum SymbolFormatFlags {
None = 0,
WriteTypeParametersOrArguments = 1,
UseOnlyExternalAliasing = 2,
}
- const enum SymbolAccessibility {
- Accessible = 0,
- NotAccessible = 1,
- CannotBeNamed = 2,
- }
- interface SymbolVisibilityResult {
- accessibility: SymbolAccessibility;
- aliasesToMakeVisible?: ImportDeclaration[];
- errorSymbolName?: string;
- errorNode?: Node;
- }
- interface SymbolAccessiblityResult extends SymbolVisibilityResult {
- errorModuleName?: string;
- }
- interface EmitResolver {
- getProgram(): Program;
- getLocalNameOfContainer(container: ModuleDeclaration | EnumDeclaration): string;
- getExpressionNamePrefix(node: Identifier): string;
- getExportAssignmentName(node: SourceFile): string;
- isReferencedImportDeclaration(node: ImportDeclaration): boolean;
- isTopLevelValueImportWithEntityName(node: ImportDeclaration): boolean;
- getNodeCheckFlags(node: Node): NodeCheckFlags;
- getEnumMemberValue(node: EnumMember): number;
- hasSemanticErrors(sourceFile?: SourceFile): boolean;
- isDeclarationVisible(node: Declaration): boolean;
- isImplementationOfOverload(node: FunctionLikeDeclaration): boolean;
- writeTypeOfDeclaration(declaration: AccessorDeclaration | VariableOrParameterDeclaration, enclosingDeclaration: Node, flags: TypeFormatFlags, writer: SymbolWriter): void;
- writeReturnTypeOfSignatureDeclaration(signatureDeclaration: SignatureDeclaration, enclosingDeclaration: Node, flags: TypeFormatFlags, writer: SymbolWriter): void;
- isSymbolAccessible(symbol: Symbol, enclosingDeclaration: Node, meaning: SymbolFlags): SymbolAccessiblityResult;
- isEntityNameVisible(entityName: EntityName, enclosingDeclaration: Node): SymbolVisibilityResult;
- getConstantValue(node: PropertyAccessExpression | ElementAccessExpression): number;
- isEmitBlocked(sourceFile?: SourceFile): boolean;
+ interface TypePredicate {
+ parameterName: string;
+ parameterIndex: number;
+ type: Type;
}
const enum SymbolFlags {
+ None = 0,
FunctionScopedVariable = 1,
BlockScopedVariable = 2,
Property = 4,
@@ -851,103 +1128,64 @@ declare module "typescript" {
Constructor = 16384,
GetAccessor = 32768,
SetAccessor = 65536,
- CallSignature = 131072,
- ConstructSignature = 262144,
- IndexSignature = 524288,
- TypeParameter = 1048576,
- TypeAlias = 2097152,
- ExportValue = 4194304,
- ExportType = 8388608,
- ExportNamespace = 16777216,
- Import = 33554432,
- Instantiated = 67108864,
- Merged = 134217728,
- Transient = 268435456,
- Prototype = 536870912,
- UnionProperty = 1073741824,
+ Signature = 131072,
+ TypeParameter = 262144,
+ TypeAlias = 524288,
+ ExportValue = 1048576,
+ ExportType = 2097152,
+ ExportNamespace = 4194304,
+ Alias = 8388608,
+ Instantiated = 16777216,
+ Merged = 33554432,
+ Transient = 67108864,
+ Prototype = 134217728,
+ SyntheticProperty = 268435456,
+ Optional = 536870912,
+ ExportStar = 1073741824,
Enum = 384,
Variable = 3,
Value = 107455,
- Type = 3152352,
+ Type = 793056,
Namespace = 1536,
Module = 1536,
Accessor = 98304,
- Signature = 917504,
FunctionScopedVariableExcludes = 107454,
BlockScopedVariableExcludes = 107455,
ParameterExcludes = 107455,
PropertyExcludes = 107455,
EnumMemberExcludes = 107455,
FunctionExcludes = 106927,
- ClassExcludes = 3258879,
- InterfaceExcludes = 3152288,
- RegularEnumExcludes = 3258623,
- ConstEnumExcludes = 3259263,
+ ClassExcludes = 899519,
+ InterfaceExcludes = 792960,
+ RegularEnumExcludes = 899327,
+ ConstEnumExcludes = 899967,
ValueModuleExcludes = 106639,
NamespaceModuleExcludes = 0,
MethodExcludes = 99263,
GetAccessorExcludes = 41919,
SetAccessorExcludes = 74687,
- TypeParameterExcludes = 2103776,
- TypeAliasExcludes = 3152352,
- ImportExcludes = 33554432,
- ModuleMember = 35653619,
+ TypeParameterExcludes = 530912,
+ TypeAliasExcludes = 793056,
+ AliasExcludes = 8388608,
+ ModuleMember = 8914931,
ExportHasLocal = 944,
- HasLocals = 1041936,
HasExports = 1952,
HasMembers = 6240,
- IsContainer = 1048560,
+ BlockScoped = 418,
PropertyOrAccessor = 98308,
- Export = 29360128,
+ Export = 7340032,
}
interface Symbol {
flags: SymbolFlags;
name: string;
- id?: number;
- mergeId?: number;
declarations?: Declaration[];
- parent?: Symbol;
+ valueDeclaration?: Declaration;
members?: SymbolTable;
exports?: SymbolTable;
- exportSymbol?: Symbol;
- valueDeclaration?: Declaration;
- constEnumOnlyModule?: boolean;
- }
- interface SymbolLinks {
- target?: Symbol;
- type?: Type;
- declaredType?: Type;
- mapper?: TypeMapper;
- referenced?: boolean;
- exportAssignSymbol?: Symbol;
- unionType?: UnionType;
- }
- interface TransientSymbol extends Symbol, SymbolLinks {
}
interface SymbolTable {
[index: string]: Symbol;
}
- const enum NodeCheckFlags {
- TypeChecked = 1,
- LexicalThis = 2,
- CaptureThis = 4,
- EmitExtends = 8,
- SuperInstance = 16,
- SuperStatic = 32,
- ContextChecked = 64,
- EnumValuesComputed = 128,
- }
- interface NodeLinks {
- resolvedType?: Type;
- resolvedSignature?: Signature;
- resolvedSymbol?: Symbol;
- flags?: NodeCheckFlags;
- enumMemberValue?: number;
- isIllegalTypeReferenceInConstraint?: boolean;
- isVisible?: boolean;
- localModuleName?: string;
- assignmentChecks?: Map<boolean>;
- }
const enum TypeFlags {
Any = 1,
String = 2,
@@ -964,21 +1202,21 @@ declare module "typescript" {
Reference = 4096,
Tuple = 8192,
Union = 16384,
- Anonymous = 32768,
- FromSignature = 65536,
- Intrinsic = 127,
+ Intersection = 32768,
+ Anonymous = 65536,
+ Instantiated = 131072,
+ ObjectLiteral = 524288,
+ ESSymbol = 16777216,
StringLike = 258,
NumberLike = 132,
- ObjectType = 48128,
+ ObjectType = 80896,
+ UnionOrIntersection = 49152,
+ StructuredType = 130048,
}
interface Type {
flags: TypeFlags;
- id: number;
symbol?: Symbol;
}
- interface IntrinsicType extends Type {
- intrinsicName: string;
- }
interface StringLiteralType extends Type {
text: string;
}
@@ -986,7 +1224,10 @@ declare module "typescript" {
}
interface InterfaceType extends ObjectType {
typeParameters: TypeParameter[];
- baseTypes: ObjectType[];
+ outerTypeParameters: TypeParameter[];
+ localTypeParameters: TypeParameter[];
+ }
+ interface InterfaceTypeWithDeclaredMembers extends InterfaceType {
declaredProperties: Symbol[];
declaredCallSignatures: Signature[];
declaredConstructSignatures: Signature[];
@@ -998,30 +1239,20 @@ declare module "typescript" {
typeArguments: Type[];
}
interface GenericType extends InterfaceType, TypeReference {
- instantiations: Map<TypeReference>;
- openReferenceTargets: GenericType[];
- openReferenceChecks: Map<boolean>;
}
interface TupleType extends ObjectType {
elementTypes: Type[];
baseArrayType: TypeReference;
}
- interface UnionType extends Type {
+ interface UnionOrIntersectionType extends Type {
types: Type[];
- resolvedProperties: SymbolTable;
}
- interface ResolvedType extends ObjectType, UnionType {
- members: SymbolTable;
- properties: Symbol[];
- callSignatures: Signature[];
- constructSignatures: Signature[];
- stringIndexType: Type;
- numberIndexType: Type;
+ interface UnionType extends UnionOrIntersectionType {
+ }
+ interface IntersectionType extends UnionOrIntersectionType {
}
interface TypeParameter extends Type {
constraint: Type;
- target?: TypeParameter;
- mapper?: TypeMapper;
}
const enum SignatureKind {
Call = 0,
@@ -1031,40 +1262,23 @@ declare module "typescript" {
declaration: SignatureDeclaration;
typeParameters: TypeParameter[];
parameters: Symbol[];
- resolvedReturnType: Type;
- minArgumentCount: number;
- hasRestParameter: boolean;
- hasStringLiterals: boolean;
- target?: Signature;
- mapper?: TypeMapper;
- unionSignatures?: Signature[];
- erasedSignatureCache?: Signature;
- isolatedSignatureType?: ObjectType;
+ typePredicate?: TypePredicate;
}
const enum IndexKind {
String = 0,
Number = 1,
}
- interface TypeMapper {
- (t: Type): Type;
- }
- interface TypeInferences {
- primary: Type[];
- secondary: Type[];
- }
- interface InferenceContext {
- typeParameters: TypeParameter[];
- inferUnionTypes: boolean;
- inferences: TypeInferences[];
- inferredTypes: Type[];
- failedTypeParameterIndex?: number;
- }
interface DiagnosticMessage {
key: string;
category: DiagnosticCategory;
code: number;
- isEarly?: boolean;
}
+ /**
+ * A linked list of formatted diagnostic messages to be used as part of a multiline message.
+ * It is built from the bottom up, leaving the head to be the "main" diagnostic.
+ * While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage,
+ * the difference is that messages are all preformatted in DMC.
+ */
interface DiagnosticMessageChain {
messageText: string;
category: DiagnosticCategory;
@@ -1075,52 +1289,78 @@ declare module "typescript" {
file: SourceFile;
start: number;
length: number;
- messageText: string;
+ messageText: string | DiagnosticMessageChain;
category: DiagnosticCategory;
code: number;
- /**
- * Early error - any error (can be produced at parsing\binding\typechecking step) that blocks emit
- */
- isEarly?: boolean;
}
enum DiagnosticCategory {
Warning = 0,
Error = 1,
Message = 2,
}
+ const enum ModuleResolutionKind {
+ Classic = 1,
+ NodeJs = 2,
+ }
interface CompilerOptions {
allowNonTsExtensions?: boolean;
charset?: string;
- codepage?: number;
declaration?: boolean;
diagnostics?: boolean;
emitBOM?: boolean;
help?: boolean;
+ init?: boolean;
+ inlineSourceMap?: boolean;
+ inlineSources?: boolean;
+ jsx?: JsxEmit;
+ listFiles?: boolean;
locale?: string;
mapRoot?: string;
module?: ModuleKind;
+ newLine?: NewLineKind;
+ noEmit?: boolean;
+ noEmitHelpers?: boolean;
noEmitOnError?: boolean;
noErrorTruncation?: boolean;
noImplicitAny?: boolean;
noLib?: boolean;
- noLibCheck?: boolean;
noResolve?: boolean;
out?: string;
+ outFile?: string;
outDir?: string;
preserveConstEnums?: boolean;
+ project?: string;
removeComments?: boolean;
+ rootDir?: string;
sourceMap?: boolean;
sourceRoot?: string;
+ suppressExcessPropertyErrors?: boolean;
suppressImplicitAnyIndexErrors?: boolean;
target?: ScriptTarget;
version?: boolean;
watch?: boolean;
+ isolatedModules?: boolean;
+ experimentalDecorators?: boolean;
+ experimentalAsyncFunctions?: boolean;
+ emitDecoratorMetadata?: boolean;
+ moduleResolution?: ModuleResolutionKind;
[option: string]: string | number | boolean;
}
const enum ModuleKind {
None = 0,
CommonJS = 1,
AMD = 2,
+ UMD = 3,
+ System = 4,
+ }
+ const enum JsxEmit {
+ None = 0,
+ Preserve = 1,
+ React = 2,
+ }
+ const enum NewLineKind {
+ CarriageReturnLineFeed = 0,
+ LineFeed = 1,
}
interface LineAndCharacter {
line: number;
@@ -1132,164 +1372,74 @@ declare module "typescript" {
ES6 = 2,
Latest = 2,
}
+ const enum LanguageVariant {
+ Standard = 0,
+ JSX = 1,
+ }
interface ParsedCommandLine {
options: CompilerOptions;
- filenames: string[];
+ fileNames: string[];
errors: Diagnostic[];
}
- interface CommandLineOption {
- name: string;
- type: string | Map<number>;
- shortName?: string;
- description?: DiagnosticMessage;
- paramType?: DiagnosticMessage;
- error?: DiagnosticMessage;
+ interface ModuleResolutionHost {
+ fileExists(fileName: string): boolean;
+ readFile(fileName: string): string;
}
- const enum CharacterCodes {
- nullCharacter = 0,
- maxAsciiCharacter = 127,
- lineFeed = 10,
- carriageReturn = 13,
- lineSeparator = 8232,
- paragraphSeparator = 8233,
- nextLine = 133,
- space = 32,
- nonBreakingSpace = 160,
- enQuad = 8192,
- emQuad = 8193,
- enSpace = 8194,
- emSpace = 8195,
- threePerEmSpace = 8196,
- fourPerEmSpace = 8197,
- sixPerEmSpace = 8198,
- figureSpace = 8199,
- punctuationSpace = 8200,
- thinSpace = 8201,
- hairSpace = 8202,
- zeroWidthSpace = 8203,
- narrowNoBreakSpace = 8239,
- ideographicSpace = 12288,
- mathematicalSpace = 8287,
- ogham = 5760,
- _ = 95,
- $ = 36,
- _0 = 48,
- _1 = 49,
- _2 = 50,
- _3 = 51,
- _4 = 52,
- _5 = 53,
- _6 = 54,
- _7 = 55,
- _8 = 56,
- _9 = 57,
- a = 97,
- b = 98,
- c = 99,
- d = 100,
- e = 101,
- f = 102,
- g = 103,
- h = 104,
- i = 105,
- j = 106,
- k = 107,
- l = 108,
- m = 109,
- n = 110,
- o = 111,
- p = 112,
- q = 113,
- r = 114,
- s = 115,
- t = 116,
- u = 117,
- v = 118,
- w = 119,
- x = 120,
- y = 121,
- z = 122,
- A = 65,
- B = 66,
- C = 67,
- D = 68,
- E = 69,
- F = 70,
- G = 71,
- H = 72,
- I = 73,
- J = 74,
- K = 75,
- L = 76,
- M = 77,
- N = 78,
- O = 79,
- P = 80,
- Q = 81,
- R = 82,
- S = 83,
- T = 84,
- U = 85,
- V = 86,
- W = 87,
- X = 88,
- Y = 89,
- Z = 90,
- ampersand = 38,
- asterisk = 42,
- at = 64,
- backslash = 92,
- backtick = 96,
- bar = 124,
- caret = 94,
- closeBrace = 125,
- closeBracket = 93,
- closeParen = 41,
- colon = 58,
- comma = 44,
- dot = 46,
- doubleQuote = 34,
- equals = 61,
- exclamation = 33,
- greaterThan = 62,
- lessThan = 60,
- minus = 45,
- openBrace = 123,
- openBracket = 91,
- openParen = 40,
- percent = 37,
- plus = 43,
- question = 63,
- semicolon = 59,
- singleQuote = 39,
- slash = 47,
- tilde = 126,
- backspace = 8,
- formFeed = 12,
- byteOrderMark = 65279,
- tab = 9,
- verticalTab = 11,
+ interface ResolvedModule {
+ resolvedFileName: string;
+ isExternalLibraryImport?: boolean;
}
- interface CancellationToken {
- isCancellationRequested(): boolean;
+ interface ResolvedModuleWithFailedLookupLocations {
+ resolvedModule: ResolvedModule;
+ failedLookupLocations: string[];
}
- interface CompilerHost {
- getSourceFile(filename: string, languageVersion: ScriptTarget, onError?: (message: string) => void): SourceFile;
- getDefaultLibFilename(options: CompilerOptions): string;
+ interface CompilerHost extends ModuleResolutionHost {
+ getSourceFile(fileName: string, languageVersion: ScriptTarget, onError?: (message: string) => void): SourceFile;
getCancellationToken?(): CancellationToken;
- writeFile(filename: string, data: string, writeByteOrderMark: boolean, onError?: (message: string) => void): void;
+ getDefaultLibFileName(options: CompilerOptions): string;
+ writeFile: WriteFileCallback;
getCurrentDirectory(): string;
getCanonicalFileName(fileName: string): string;
useCaseSensitiveFileNames(): boolean;
getNewLine(): string;
+ resolveModuleNames?(moduleNames: string[], containingFile: string): ResolvedModule[];
+ }
+ interface TextSpan {
+ start: number;
+ length: number;
+ }
+ interface TextChangeRange {
+ span: TextSpan;
+ newLength: number;
}
}
declare module "typescript" {
- interface ErrorCallback {
- (message: DiagnosticMessage): void;
+ interface System {
+ args: string[];
+ newLine: string;
+ useCaseSensitiveFileNames: boolean;
+ write(s: string): void;
+ readFile(path: string, encoding?: string): string;
+ writeFile(path: string, data: string, writeByteOrderMark?: boolean): void;
+ watchFile?(path: string, callback: (path: string) => void): FileWatcher;
+ resolvePath(path: string): string;
+ fileExists(path: string): boolean;
+ directoryExists(path: string): boolean;
+ createDirectory(path: string): void;
+ getExecutingFilePath(): string;
+ getCurrentDirectory(): string;
+ readDirectory(path: string, extension?: string, exclude?: string[]): string[];
+ getMemoryUsage?(): number;
+ exit(exitCode?: number): void;
}
- interface CommentCallback {
- (pos: number, end: number): void;
+ interface FileWatcher {
+ close(): void;
+ }
+ var sys: System;
+}
+declare module "typescript" {
+ interface ErrorCallback {
+ (message: DiagnosticMessage, length: number): void;
}
interface Scanner {
getStartPos(): number;
@@ -1298,6 +1448,7 @@ declare module "typescript" {
getTokenPos(): number;
getTokenText(): string;
getTokenValue(): string;
+ hasExtendedUnicodeEscape(): boolean;
hasPrecedingLineBreak(): boolean;
isIdentifier(): boolean;
isReservedWord(): boolean;
@@ -1305,45 +1456,111 @@ declare module "typescript" {
reScanGreaterToken(): SyntaxKind;
reScanSlashToken(): SyntaxKind;
reScanTemplateToken(): SyntaxKind;
+ scanJsxIdentifier(): SyntaxKind;
+ reScanJsxToken(): SyntaxKind;
+ scanJsxToken(): SyntaxKind;
scan(): SyntaxKind;
- setText(text: string): void;
+ setText(text: string, start?: number, length?: number): void;
+ setOnError(onError: ErrorCallback): void;
+ setScriptTarget(scriptTarget: ScriptTarget): void;
+ setLanguageVariant(variant: LanguageVariant): void;
setTextPos(textPos: number): void;
lookAhead<T>(callback: () => T): T;
tryScan<T>(callback: () => T): T;
}
function tokenToString(t: SyntaxKind): string;
- function computeLineStarts(text: string): number[];
- function getPositionFromLineAndCharacter(lineStarts: number[], line: number, character: number): number;
- function getLineAndCharacterOfPosition(lineStarts: number[], position: number): {
- line: number;
- character: number;
- };
- function positionToLineAndCharacter(text: string, pos: number): {
- line: number;
- character: number;
- };
+ function getPositionOfLineAndCharacter(sourceFile: SourceFile, line: number, character: number): number;
+ function getLineAndCharacterOfPosition(sourceFile: SourceFile, position: number): LineAndCharacter;
function isWhiteSpace(ch: number): boolean;
function isLineBreak(ch: number): boolean;
- function isOctalDigit(ch: number): boolean;
- function skipTrivia(text: string, pos: number, stopAfterLineBreak?: boolean): number;
+ function couldStartTrivia(text: string, pos: number): boolean;
function getLeadingCommentRanges(text: string, pos: number): CommentRange[];
function getTrailingCommentRanges(text: string, pos: number): CommentRange[];
+ /** Optionally, get the shebang */
+ function getShebang(text: string): string;
function isIdentifierStart(ch: number, languageVersion: ScriptTarget): boolean;
function isIdentifierPart(ch: number, languageVersion: ScriptTarget): boolean;
- function createScanner(languageVersion: ScriptTarget, skipTrivia: boolean, text?: string, onError?: ErrorCallback): Scanner;
+ function createScanner(languageVersion: ScriptTarget, skipTrivia: boolean, languageVariant?: LanguageVariant, text?: string, onError?: ErrorCallback, start?: number, length?: number): Scanner;
+}
+declare module "typescript" {
+ function getDefaultLibFileName(options: CompilerOptions): string;
+ function textSpanEnd(span: TextSpan): number;
+ function textSpanIsEmpty(span: TextSpan): boolean;
+ function textSpanContainsPosition(span: TextSpan, position: number): boolean;
+ function textSpanContainsTextSpan(span: TextSpan, other: TextSpan): boolean;
+ function textSpanOverlapsWith(span: TextSpan, other: TextSpan): boolean;
+ function textSpanOverlap(span1: TextSpan, span2: TextSpan): TextSpan;
+ function textSpanIntersectsWithTextSpan(span: TextSpan, other: TextSpan): boolean;
+ function textSpanIntersectsWith(span: TextSpan, start: number, length: number): boolean;
+ function decodedTextSpanIntersectsWith(start1: number, length1: number, start2: number, length2: number): boolean;
+ function textSpanIntersectsWithPosition(span: TextSpan, position: number): boolean;
+ function textSpanIntersection(span1: TextSpan, span2: TextSpan): TextSpan;
+ function createTextSpan(start: number, length: number): TextSpan;
+ function createTextSpanFromBounds(start: number, end: number): TextSpan;
+ function textChangeRangeNewSpan(range: TextChangeRange): TextSpan;
+ function textChangeRangeIsUnchanged(range: TextChangeRange): boolean;
+ function createTextChangeRange(span: TextSpan, newLength: number): TextChangeRange;
+ let unchangedTextChangeRange: TextChangeRange;
+ /**
+ * Called to merge all the changes that occurred across several versions of a script snapshot
+ * into a single change. i.e. if a user keeps making successive edits to a script we will
+ * have a text change from V1 to V2, V2 to V3, ..., Vn.
+ *
+ * This function will then merge those changes into a single change range valid between V1 and
+ * Vn.
+ */
+ function collapseTextChangeRangesAcrossMultipleVersions(changes: TextChangeRange[]): TextChangeRange;
+ function getTypeParameterOwner(d: Declaration): Declaration;
}
declare module "typescript" {
function getNodeConstructor(kind: SyntaxKind): new () => Node;
- function forEachChild<T>(node: Node, cbNode: (node: Node) => T, cbNodes?: (nodes: Node[]) => T): T;
- function createCompilerHost(options: CompilerOptions): CompilerHost;
- function createSourceFile(filename: string, sourceText: string, languageVersion: ScriptTarget, version: string, isOpen?: boolean): SourceFile;
- function createProgram(rootNames: string[], options: CompilerOptions, host: CompilerHost): Program;
+ function createNode(kind: SyntaxKind): Node;
+ function forEachChild<T>(node: Node, cbNode: (node: Node) => T, cbNodeArray?: (nodes: Node[]) => T): T;
+ function createSourceFile(fileName: string, sourceText: string, languageVersion: ScriptTarget, setParentNodes?: boolean): SourceFile;
+ function updateSourceFile(sourceFile: SourceFile, newText: string, textChangeRange: TextChangeRange, aggressiveChecks?: boolean): SourceFile;
}
declare module "typescript" {
- function createTypeChecker(program: Program, fullTypeCheck: boolean): TypeChecker;
+ const version: string;
+ function findConfigFile(searchPath: string): string;
+ function resolveTripleslashReference(moduleName: string, containingFile: string): string;
+ function resolveModuleName(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost): ResolvedModuleWithFailedLookupLocations;
+ function nodeModuleNameResolver(moduleName: string, containingFile: string, host: ModuleResolutionHost): ResolvedModuleWithFailedLookupLocations;
+ function classicNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost): ResolvedModuleWithFailedLookupLocations;
+ function createCompilerHost(options: CompilerOptions, setParentNodes?: boolean): CompilerHost;
+ function getPreEmitDiagnostics(program: Program, sourceFile?: SourceFile, cancellationToken?: CancellationToken): Diagnostic[];
+ function flattenDiagnosticMessageText(messageText: string | DiagnosticMessageChain, newLine: string): string;
+ function createProgram(rootNames: string[], options: CompilerOptions, host?: CompilerHost, oldProgram?: Program): Program;
}
declare module "typescript" {
- var servicesVersion: string;
+ function parseCommandLine(commandLine: string[], readFile?: (path: string) => string): ParsedCommandLine;
+ /**
+ * Read tsconfig.json file
+ * @param fileName The path to the config file
+ */
+ function readConfigFile(fileName: string): {
+ config?: any;
+ error?: Diagnostic;
+ };
+ /**
+ * Parse the text of the tsconfig.json file
+ * @param fileName The path to the config file
+ * @param jsonText The text of the config file
+ */
+ function parseConfigFileText(fileName: string, jsonText: string): {
+ config?: any;
+ error?: Diagnostic;
+ };
+ /**
+ * Parse the contents of a config file (tsconfig.json).
+ * @param json The contents of the config file to parse
+ * @param basePath A root directory to resolve relative path entries in the config
+ * file to. e.g. outDir
+ */
+ function parseConfigFile(json: any, host: ParseConfigHost, basePath: string): ParsedCommandLine;
+}
+declare module "typescript" {
+ /** The version of the language service API */
+ let servicesVersion: string;
interface Node {
getSourceFile(): SourceFile;
getChildCount(sourceFile?: SourceFile): number;
@@ -1376,6 +1593,7 @@ declare module "typescript" {
getConstructSignatures(): Signature[];
getStringIndexType(): Type;
getNumberIndexType(): Type;
+ getBaseTypes(): ObjectType[];
}
interface Signature {
getDeclaration(): SignatureDeclaration;
@@ -1385,9 +1603,10 @@ declare module "typescript" {
getDocumentationComment(): SymbolDisplayPart[];
}
interface SourceFile {
- getScriptSnapshot(): IScriptSnapshot;
- getNamedDeclarations(): Declaration[];
- update(scriptSnapshot: IScriptSnapshot, version: string, isOpen: boolean, textChangeRange: TextChangeRange): SourceFile;
+ getLineAndCharacterOfPosition(pos: number): LineAndCharacter;
+ getLineStarts(): number[];
+ getPositionOfLineAndCharacter(line: number, character: number): number;
+ update(newText: string, textChangeRange: TextChangeRange): SourceFile;
}
/**
* Represents an immutable snapshot of a script at a specified time.Once acquired, the
@@ -1399,12 +1618,6 @@ declare module "typescript" {
getText(start: number, end: number): string;
/** Gets the length of this script snapshot. */
getLength(): number;
- /**
- * This call returns the array containing the start position of every line.
- * i.e."[0, 10, 55]". TODO: consider making this optional. The language service could
- * always determine this (albeit in a more expensive manner).
- */
- getLineStartPositions(): number[];
/**
* Gets the TextChangeRange that describe how the text changed between this text and
* an older version. This information is used by the incremental parser to determine
@@ -1413,6 +1626,8 @@ declare module "typescript" {
* not happen and the entire document will be re - parsed.
*/
getChangeRange(oldSnapshot: IScriptSnapshot): TextChangeRange;
+ /** Releases all resources held by this script snapshot */
+ dispose?(): void;
}
module ScriptSnapshot {
function fromString(text: string): IScriptSnapshot;
@@ -1420,29 +1635,44 @@ declare module "typescript" {
interface PreProcessedFileInfo {
referencedFiles: FileReference[];
importedFiles: FileReference[];
+ ambientExternalModules: string[];
isLibFile: boolean;
}
- interface Logger {
- log(s: string): void;
+ interface HostCancellationToken {
+ isCancellationRequested(): boolean;
}
- interface LanguageServiceHost extends Logger {
+ interface LanguageServiceHost {
getCompilationSettings(): CompilerOptions;
+ getNewLine?(): string;
+ getProjectVersion?(): string;
getScriptFileNames(): string[];
getScriptVersion(fileName: string): string;
- getScriptIsOpen(fileName: string): boolean;
getScriptSnapshot(fileName: string): IScriptSnapshot;
getLocalizedDiagnosticMessages?(): any;
- getCancellationToken?(): CancellationToken;
+ getCancellationToken?(): HostCancellationToken;
getCurrentDirectory(): string;
- getDefaultLibFilename(options: CompilerOptions): string;
+ getDefaultLibFileName(options: CompilerOptions): string;
+ log?(s: string): void;
+ trace?(s: string): void;
+ error?(s: string): void;
+ useCaseSensitiveFileNames?(): boolean;
+ resolveModuleNames?(moduleNames: string[], containingFile: string): ResolvedModule[];
}
interface LanguageService {
cleanupSemanticCache(): void;
getSyntacticDiagnostics(fileName: string): Diagnostic[];
getSemanticDiagnostics(fileName: string): Diagnostic[];
getCompilerOptionsDiagnostics(): Diagnostic[];
+ /**
+ * @deprecated Use getEncodedSyntacticClassifications instead.
+ */
getSyntacticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
+ /**
+ * @deprecated Use getEncodedSemanticClassifications instead.
+ */
getSemanticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
+ getEncodedSyntacticClassifications(fileName: string, span: TextSpan): Classifications;
+ getEncodedSemanticClassifications(fileName: string, span: TextSpan): Classifications;
getCompletionsAtPosition(fileName: string, position: number): CompletionInfo;
getCompletionEntryDetails(fileName: string, position: number, entryName: string): CompletionEntryDetails;
getQuickInfoAtPosition(fileName: string, position: number): QuickInfo;
@@ -1452,9 +1682,13 @@ declare module "typescript" {
getRenameInfo(fileName: string, position: number): RenameInfo;
findRenameLocations(fileName: string, position: number, findInStrings: boolean, findInComments: boolean): RenameLocation[];
getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
+ getTypeDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
+ findReferences(fileName: string, position: number): ReferencedSymbol[];
+ getDocumentHighlights(fileName: string, position: number, filesToSearch: string[]): DocumentHighlights[];
+ /** @deprecated */
getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
- getNavigateToItems(searchValue: string): NavigateToItem[];
+ getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
getNavigationBarItems(fileName: string): NavigationBarItem[];
getOutliningSpans(fileName: string): OutliningSpan[];
getTodoComments(fileName: string, descriptors: TodoCommentDescriptor[]): TodoComment[];
@@ -1463,99 +1697,15 @@ declare module "typescript" {
getFormattingEditsForRange(fileName: string, start: number, end: number, options: FormatCodeOptions): TextChange[];
getFormattingEditsForDocument(fileName: string, options: FormatCodeOptions): TextChange[];
getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions): TextChange[];
+ getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion;
getEmitOutput(fileName: string): EmitOutput;
- getSourceFile(filename: string): SourceFile;
+ getProgram(): Program;
+ getSourceFile(fileName: string): SourceFile;
dispose(): void;
}
- class TextSpan {
- private _start;
- private _length;
- /**
- * Creates a TextSpan instance beginning with the position Start and having the Length
- * specified with length.
- */
- constructor(start: number, length: number);
- toJSON(key: any): any;
- start(): number;
- length(): number;
- end(): number;
- isEmpty(): boolean;
- /**
- * Determines whether the position lies within the span. Returns true if the position is greater than or equal to Start and strictly less
- * than End, otherwise false.
- * @param position The position to check.
- */
- containsPosition(position: number): boolean;
- /**
- * Determines whether span falls completely within this span. Returns true if the specified span falls completely within this span, otherwise false.
- * @param span The span to check.
- */
- containsTextSpan(span: TextSpan): boolean;
- /**
- * Determines whether the given span overlaps this span. Two spans are considered to overlap
- * if they have positions in common and neither is empty. Empty spans do not overlap with any
- * other span. Returns true if the spans overlap, false otherwise.
- * @param span The span to check.
- */
- overlapsWith(span: TextSpan): boolean;
- /**
- * Returns the overlap with the given span, or undefined if there is no overlap.
- * @param span The span to check.
- */
- overlap(span: TextSpan): TextSpan;
- /**
- * Determines whether span intersects this span. Two spans are considered to
- * intersect if they have positions in common or the end of one span
- * coincides with the start of the other span. Returns true if the spans intersect, false otherwise.
- * @param The span to check.
- */
- intersectsWithTextSpan(span: TextSpan): boolean;
- intersectsWith(start: number, length: number): boolean;
- /**
- * Determines whether the given position intersects this span.
- * A position is considered to intersect if it is between the start and
- * end positions (inclusive) of this span. Returns true if the position intersects, false otherwise.
- * @param position The position to check.
- */
- intersectsWithPosition(position: number): boolean;
- /**
- * Returns the intersection with the given span, or undefined if there is no intersection.
- * @param span The span to check.
- */
- intersection(span: TextSpan): TextSpan;
- /**
- * Creates a new TextSpan from the given start and end positions
- * as opposed to a position and length.
- */
- static fromBounds(start: number, end: number): TextSpan;
- }
- class TextChangeRange {
- static unchanged: TextChangeRange;
- private _span;
- private _newLength;
- /**
- * Initializes a new instance of TextChangeRange.
- */
- constructor(span: TextSpan, newLength: number);
- /**
- * The span of text before the edit which is being changed
- */
- span(): TextSpan;
- /**
- * Width of the span after the edit. A 0 here would represent a delete
- */
- newLength(): number;
- newSpan(): TextSpan;
- isUnchanged(): boolean;
- /**
- * Called to merge all the changes that occurred across several versions of a script snapshot
- * into a single change. i.e. if a user keeps making successive edits to a script we will
- * have a text change from V1 to V2, V2 to V3, ..., Vn.
- *
- * This function will then merge those changes into a single change range valid between V1 and
- * Vn.
- */
- static collapseChangesAcrossMultipleVersions(changes: TextChangeRange[]): TextChangeRange;
+ interface Classifications {
+ spans: number[];
+ endOfLineState: EndOfLineState;
}
interface ClassifiedSpan {
textSpan: TextSpan;
@@ -1584,6 +1734,11 @@ declare module "typescript" {
span: TextSpan;
newText: string;
}
+ interface TextInsertion {
+ newText: string;
+ /** The position in newText the caret should point to after the insertion. */
+ caretOffset: number;
+ }
interface RenameLocation {
textSpan: TextSpan;
fileName: string;
@@ -1593,11 +1748,27 @@ declare module "typescript" {
fileName: string;
isWriteAccess: boolean;
}
+ interface DocumentHighlights {
+ fileName: string;
+ highlightSpans: HighlightSpan[];
+ }
+ module HighlightSpanKind {
+ const none: string;
+ const definition: string;
+ const reference: string;
+ const writtenReference: string;
+ }
+ interface HighlightSpan {
+ fileName?: string;
+ textSpan: TextSpan;
+ kind: string;
+ }
interface NavigateToItem {
name: string;
kind: string;
kindModifiers: string;
matchKind: string;
+ isCaseSensitive: boolean;
fileName: string;
textSpan: TextSpan;
containerName: string;
@@ -1616,8 +1787,10 @@ declare module "typescript" {
InsertSpaceAfterKeywordsInControlFlowStatements: boolean;
InsertSpaceAfterFunctionKeywordForAnonymousFunctions: boolean;
InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: boolean;
+ InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: boolean;
PlaceOpenBraceOnNewLineForFunctions: boolean;
PlaceOpenBraceOnNewLineForControlBlocks: boolean;
+ [s: string]: boolean | number | string;
}
interface DefinitionInfo {
fileName: string;
@@ -1627,6 +1800,10 @@ declare module "typescript" {
containerKind: string;
containerName: string;
}
+ interface ReferencedSymbol {
+ definition: DefinitionInfo;
+ references: ReferenceEntry[];
+ }
enum SymbolDisplayPartKind {
aliasName = 0,
className = 1,
@@ -1704,12 +1881,14 @@ declare module "typescript" {
}
interface CompletionInfo {
isMemberCompletion: boolean;
+ isNewIdentifierLocation: boolean;
entries: CompletionEntry[];
}
interface CompletionEntry {
name: string;
kind: string;
kindModifiers: string;
+ sortText: string;
}
interface CompletionEntryDetails {
name: string;
@@ -1733,7 +1912,7 @@ declare module "typescript" {
}
interface EmitOutput {
outputFiles: OutputFile[];
- emitOutputStatus: EmitReturnStatus;
+ emitSkipped: boolean;
}
const enum OutputFileType {
JavaScript = 0,
@@ -1746,10 +1925,13 @@ declare module "typescript" {
text: string;
}
const enum EndOfLineState {
- Start = 0,
+ None = 0,
InMultiLineCommentTrivia = 1,
InSingleQuoteStringLiteral = 2,
InDoubleQuoteStringLiteral = 3,
+ InTemplateHeadOrNoSubstitutionTemplate = 4,
+ InTemplateMiddleOrTail = 5,
+ InTemplateSubstitutionPosition = 6,
}
enum TokenClass {
Punctuation = 0,
@@ -1771,50 +1953,125 @@ declare module "typescript" {
classification: TokenClass;
}
interface Classifier {
- getClassificationsForLine(text: string, lexState: EndOfLineState, classifyKeywordsInGenerics?: boolean): ClassificationResult;
+ /**
+ * Gives lexical classifications of tokens on a line without any syntactic context.
+ * For instance, a token consisting of the text 'string' can be either an identifier
+ * named 'string' or the keyword 'string', however, because this classifier is not aware,
+ * it relies on certain heuristics to give acceptable results. For classifications where
+ * speed trumps accuracy, this function is preferable; however, for true accuracy, the
+ * syntactic classifier is ideal. In fact, in certain editing scenarios, combining the
+ * lexical, syntactic, and semantic classifiers may issue the best user experience.
+ *
+ * @param text The text of a line to classify.
+ * @param lexState The state of the lexical classifier at the end of the previous line.
+ * @param syntacticClassifierAbsent Whether the client is *not* using a syntactic classifier.
+ * If there is no syntactic classifier (syntacticClassifierAbsent=true),
+ * certain heuristics may be used in its place; however, if there is a
+ * syntactic classifier (syntacticClassifierAbsent=false), certain
+ * classifications which may be incorrectly categorized will be given
+ * back as Identifiers in order to allow the syntactic classifier to
+ * subsume the classification.
+ * @deprecated Use getLexicalClassifications instead.
+ */
+ getClassificationsForLine(text: string, lexState: EndOfLineState, syntacticClassifierAbsent: boolean): ClassificationResult;
+ getEncodedLexicalClassifications(text: string, endOfLineState: EndOfLineState, syntacticClassifierAbsent: boolean): Classifications;
}
+ /**
+ * The document registry represents a store of SourceFile objects that can be shared between
+ * multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST)
+ * of files in the context.
+ * SourceFile objects account for most of the memory usage by the language service. Sharing
+ * the same DocumentRegistry instance between different instances of LanguageService allow
+ * for more efficient memory utilization since all projects will share at least the library
+ * file (lib.d.ts).
+ *
+ * A more advanced use of the document registry is to serialize sourceFile objects to disk
+ * and re-hydrate them when needed.
+ *
+ * To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it
+ * to all subsequent createLanguageService calls.
+ */
interface DocumentRegistry {
- acquireDocument(filename: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string, isOpen: boolean): SourceFile;
- updateDocument(sourceFile: SourceFile, filename: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string, isOpen: boolean, textChangeRange: TextChangeRange): SourceFile;
- releaseDocument(filename: string, compilationSettings: CompilerOptions): void;
+ /**
+ * Request a stored SourceFile with a given fileName and compilationSettings.
+ * The first call to acquire will call createLanguageServiceSourceFile to generate
+ * the SourceFile if was not found in the registry.
+ *
+ * @param fileName The name of the file requested
+ * @param compilationSettings Some compilation settings like target affects the
+ * shape of a the resulting SourceFile. This allows the DocumentRegistry to store
+ * multiple copies of the same file for different compilation settings.
+ * @parm scriptSnapshot Text of the file. Only used if the file was not found
+ * in the registry and a new one was created.
+ * @parm version Current version of the file. Only used if the file was not found
+ * in the registry and a new one was created.
+ */
+ acquireDocument(fileName: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string): SourceFile;
+ /**
+ * Request an updated version of an already existing SourceFile with a given fileName
+ * and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile
+ * to get an updated SourceFile.
+ *
+ * @param fileName The name of the file requested
+ * @param compilationSettings Some compilation settings like target affects the
+ * shape of a the resulting SourceFile. This allows the DocumentRegistry to store
+ * multiple copies of the same file for different compilation settings.
+ * @param scriptSnapshot Text of the file.
+ * @param version Current version of the file.
+ */
+ updateDocument(fileName: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string): SourceFile;
+ /**
+ * Informs the DocumentRegistry that a file is not needed any longer.
+ *
+ * Note: It is not allowed to call release on a SourceFile that was not acquired from
+ * this registry originally.
+ *
+ * @param fileName The name of the file to be released
+ * @param compilationSettings The compilation settings used to acquire the file
+ */
+ releaseDocument(fileName: string, compilationSettings: CompilerOptions): void;
+ reportStats(): string;
}
- class ScriptElementKind {
- static unknown: string;
- static keyword: string;
- static scriptElement: string;
- static moduleElement: string;
- static classElement: string;
- static interfaceElement: string;
- static typeElement: string;
- static enumElement: string;
- static variableElement: string;
- static localVariableElement: string;
- static functionElement: string;
- static localFunctionElement: string;
- static memberFunctionElement: string;
- static memberGetAccessorElement: string;
- static memberSetAccessorElement: string;
- static memberVariableElement: string;
- static constructorImplementationElement: string;
- static callSignatureElement: string;
- static indexSignatureElement: string;
- static constructSignatureElement: string;
- static parameterElement: string;
- static typeParameterElement: string;
- static primitiveType: string;
- static label: string;
- static alias: string;
- static constElement: string;
- static letElement: string;
+ module ScriptElementKind {
+ const unknown: string;
+ const warning: string;
+ const keyword: string;
+ const scriptElement: string;
+ const moduleElement: string;
+ const classElement: string;
+ const localClassElement: string;
+ const interfaceElement: string;
+ const typeElement: string;
+ const enumElement: string;
+ const variableElement: string;
+ const localVariableElement: string;
+ const functionElement: string;
+ const localFunctionElement: string;
+ const memberFunctionElement: string;
+ const memberGetAccessorElement: string;
+ const memberSetAccessorElement: string;
+ const memberVariableElement: string;
+ const constructorImplementationElement: string;
+ const callSignatureElement: string;
+ const indexSignatureElement: string;
+ const constructSignatureElement: string;
+ const parameterElement: string;
+ const typeParameterElement: string;
+ const primitiveType: string;
+ const label: string;
+ const alias: string;
+ const constElement: string;
+ const letElement: string;
}
- class ScriptElementKindModifier {
- static none: string;
- static publicMemberModifier: string;
- static privateMemberModifier: string;
- static protectedMemberModifier: string;
- static exportedModifier: string;
- static ambientModifier: string;
- static staticModifier: string;
+ module ScriptElementKindModifier {
+ const none: string;
+ const publicMemberModifier: string;
+ const privateMemberModifier: string;
+ const protectedMemberModifier: string;
+ const exportedModifier: string;
+ const ambientModifier: string;
+ const staticModifier: string;
+ const abstractModifier: string;
}
class ClassificationTypeNames {
static comment: string;
@@ -1831,24 +2088,61 @@ declare module "typescript" {
static interfaceName: string;
static moduleName: string;
static typeParameterName: string;
- static typeAlias: string;
+ static typeAliasName: string;
+ static parameterName: string;
+ static docCommentTagName: string;
+ }
+ const enum ClassificationType {
+ comment = 1,
+ identifier = 2,
+ keyword = 3,
+ numericLiteral = 4,
+ operator = 5,
+ stringLiteral = 6,
+ regularExpressionLiteral = 7,
+ whiteSpace = 8,
+ text = 9,
+ punctuation = 10,
+ className = 11,
+ enumName = 12,
+ interfaceName = 13,
+ moduleName = 14,
+ typeParameterName = 15,
+ typeAliasName = 16,
+ parameterName = 17,
+ docCommentTagName = 18,
}
interface DisplayPartsSymbolWriter extends SymbolWriter {
displayParts(): SymbolDisplayPart[];
}
function displayPartsToString(displayParts: SymbolDisplayPart[]): string;
function getDefaultCompilerOptions(): CompilerOptions;
- class OperationCanceledException {
+ interface TranspileOptions {
+ compilerOptions?: CompilerOptions;
+ fileName?: string;
+ reportDiagnostics?: boolean;
+ moduleName?: string;
+ renamedDependencies?: Map<string>;
}
- class CancellationTokenObject {
- private cancellationToken;
- static None: CancellationTokenObject;
- constructor(cancellationToken: CancellationToken);
- isCancellationRequested(): boolean;
- throwIfCancellationRequested(): void;
+ interface TranspileOutput {
+ outputText: string;
+ diagnostics?: Diagnostic[];
+ sourceMapText?: string;
}
- function createDocumentRegistry(): DocumentRegistry;
+ function transpileModule(input: string, transpileOptions: TranspileOptions): TranspileOutput;
+ function transpile(input: string, compilerOptions?: CompilerOptions, fileName?: string, diagnostics?: Diagnostic[], moduleName?: string): string;
+ function createLanguageServiceSourceFile(fileName: string, scriptSnapshot: IScriptSnapshot, scriptTarget: ScriptTarget, version: string, setNodeParents: boolean): SourceFile;
+ let disableIncrementalParsing: boolean;
+ function updateLanguageServiceSourceFile(sourceFile: SourceFile, scriptSnapshot: IScriptSnapshot, version: string, textChangeRange: TextChangeRange, aggressiveChecks?: boolean): SourceFile;
+ function createGetCanonicalFileName(useCaseSensitivefileNames: boolean): (fileName: string) => string;
+ function createDocumentRegistry(useCaseSensitiveFileNames?: boolean): DocumentRegistry;
function preProcessFile(sourceText: string, readImportFiles?: boolean): PreProcessedFileInfo;
- function createLanguageService(host: LanguageServiceHost, documentRegistry: DocumentRegistry): LanguageService;
- function createClassifier(host: Logger): Classifier;
+ function createLanguageService(host: LanguageServiceHost, documentRegistry?: DocumentRegistry): LanguageService;
+ function createClassifier(): Classifier;
+ /**
+ * Get the path of the default library files (lib.d.ts) as distributed with the typescript
+ * node package.
+ * The functionality is not supported if the ts module is consumed outside of a node module.
+ */
+ function getDefaultLibFilePath(options: CompilerOptions): string;
}
diff --git a/ui-grid/ui-grid.d.ts b/ui-grid/ui-grid.d.ts
index 481326b138..a03c403784 100644
--- a/ui-grid/ui-grid.d.ts
+++ b/ui-grid/ui-grid.d.ts
@@ -483,6 +483,10 @@ declare module uiGrid {
* use gridOptions.appScopeProvider to override the default assignment of $scope.$parent with any reference
*/
appScope?: ng.IScope;
+ /**
+ * returns an array of columns in the grid
+ */
+ columns: Array<IGridColumn>;
/**
* returns the total column footer height
*/
@@ -605,6 +609,13 @@ declare module uiGrid {
* @default false
*/
enableFiltering?: boolean;
+ /**
+ * False by default. When enabled, this adds a settings icon in the top right of the grid,
+ * which floats above the column header. The menu by default gives access to show/hide columns,
+ * but can be customized to show additional actions.
+ * @default false
+ */
+ enableGridMenu?: boolean;
/**
* uiGridConstants.scrollbars.ALWAYS by default. This settings controls the horizontal scrollbar for the grid.
* Supported values: uiGridConstants.scrollbars.ALWAYS, uiGridConstants.scrollbars.NEVER
@@ -718,6 +729,25 @@ declare module uiGrid {
* @default 4
*/
horizontalScrollThreshold?: number;
+ /**
+ * Number of rows from the end of the dataset
+ * at which infinite scroll will trigger a request
+ * for more data
+ * @default 20
+ */
+ infiniteScrollRowsFromEnd?: number;
+ /**
+ * Inform the grid of whether there are rows
+ * to load when scrolling up
+ * @default false
+ */
+ infiniteScrollUp?: boolean;
+ /**
+ * Inform the grid of whether there are rows
+ * to load scrolling down
+ * @default true
+ */
+ infiniteScrollDown?: boolean;
/**
* Defaults to 200
* @default 200
@@ -796,6 +826,12 @@ declare module uiGrid {
* @default 20
*/
virtualizationThreshold?: number;
+ /**
+ * Disables client side filtering. When true, handle the filterChanged event and set data,
+ * defaults to false
+ * @default false
+ */
+ useExternalFiltering?: boolean;
/**
* Default time in milliseconds to throttle scroll events to, defaults to 70ms
* @default 70
@@ -1015,6 +1051,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> {
@@ -1073,6 +1115,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 0000000000..7c794a3533
--- /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 0000000000..76015e346f
--- /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 0000000000..8bc1f7b63a
--- /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 0000000000..f1ddfe9a5a
--- /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 0000000000..b4a4a1487d
--- /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 0000000000..0cb7f2522f
--- /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/vega/vega-tests.ts b/vega/vega-tests.ts
index 401defde08..00aa4122d7 100644
--- a/vega/vega-tests.ts
+++ b/vega/vega-tests.ts
@@ -702,25 +702,25 @@ specs[9] = {
{
"name": "people",
"values": [
- {
+ {
"label": "Washington", "born": -7506057600000, "died": -5366196000000,
- "enter": -5701424400000, "leave": -5453884800000
+ "enter": -5701424400000, "leave": -5453884800000
},
- {
+ {
"label": "Adams", "born": -7389766800000, "died": -4528285200000,
- "enter": -5453884800000, "leave": -5327740800000
+ "enter": -5453884800000, "leave": -5327740800000
},
- {
+ {
"label": "Jefferson", "born": -7154586000000, "died": -4528285200000,
- "enter": -5327740800000, "leave": -5075280000000
+ "enter": -5327740800000, "leave": -5075280000000
},
- {
+ {
"label": "Madison", "born": -6904544400000, "died": -4213184400000,
- "enter": -5075280000000, "leave": -4822819200000
+ "enter": -5075280000000, "leave": -4822819200000
},
- {
+ {
"label": "Monroe", "born": -6679904400000, "died": -4370518800000,
- "enter": -4822819200000, "leave": -4570358400000
+ "enter": -4822819200000, "leave": -4570358400000
}
]
},
@@ -945,9 +945,9 @@ specs[11] = {
}
],
"axes": [
- {
+ {
"type": "y", "scale": "y", "ticks": 4, "orient": "right",
- "grid": true, "layer": "back"
+ "grid": true, "layer": "back"
}
],
"marks": [
@@ -1839,7 +1839,7 @@ specs[20] = {
}
],
"axes": [
- {
+ {
"type": "y", "scale": "y", "ticks": 3, "tickSize": 0,
"orient": "right", "grid": true,
"properties": {
diff --git a/vega/vega.d.ts b/vega/vega.d.ts
index 4fa32052c0..4441cceaeb 100644
--- a/vega/vega.d.ts
+++ b/vega/vega.d.ts
@@ -207,8 +207,8 @@ declare namespace Vega {
* in some cases strict padding is not possible; for example, if the axis
* labels are much larger than the data rectangle.
*/
- padding?: number | string | {
- top: number; left: number; right: number; bottom: number
+ padding?: number | string | {
+ top: number; left: number; right: number; bottom: number
}; // string is "auto" or "strict"
/**
* Definitions of data to visualize.
diff --git a/voximplant-websdk/voximplant-websdk-tests.ts b/voximplant-websdk/voximplant-websdk-tests.ts
new file mode 100644
index 0000000000..2a9363c379
--- /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 0000000000..2e715d7701
--- /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/webcola/webcola-tests.ts b/webcola/webcola-tests.ts
deleted file mode 100644
index 43c7bfe1ea..0000000000
--- a/webcola/webcola-tests.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-/// <reference path="webcola.d.ts"/>
-module WebColaTests {
- var adaptor = new cola.adaptor({
- trigger: function() {
- },
- kick: function() {
- },
- on: function() {
- },
- drag: function() {
- }
- });
-
- adaptor
- .size([100, 100])
- .avoidOverlaps(true)
- .nodes({})
- .links({})
- .handleDisconnected(true)
- .convergenceThreshold(0.001)
- .constraints({})
- .linkDistance(100)
- .flowLayout('y', 0);
-
- adaptor.start(1, 2, 3);
- adaptor.stop();
- adaptor.resume();
-
- cola.colaDragstart({});
- cola.colaDragend({});
-}
diff --git a/webcola/webcola.d.ts b/webcola/webcola.d.ts
index 801455cba5..ba5a4b260e 100644
--- a/webcola/webcola.d.ts
+++ b/webcola/webcola.d.ts
@@ -1,71 +1,1096 @@
-// Type definitions for webcola 3.0.1
+// Type definitions for webcola 3.1.1
// Project: https://github.com/tgdwyer/WebCola
-// Definitions by: Qinfeng Chen <https://github.com/qinfchen>
+// Definitions by: Qinfeng Chen <https://github.com/qinfchen>, Tim Dwyer <https://github.com/tgdwyer>, Noah Chen <https://github.com/nchen63>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
-declare module WebCola{
- interface Adaptor {
- new(options: { [index:number]: any }): Adaptor;
- avoidOverlaps(avodOverLaps: boolean): Adaptor;
- constraints(constraints: any): Adaptor;
- convergenceThreshold(convergenceThreshold: number): Adaptor;
- flowLayout(axis: string, minSeparation: number): Adaptor;
- handleDisconnected(handleDisconnected: boolean): Adaptor;
- links(links: any): Adaptor;
- linkDistance(linkLength: number): Adaptor;
- nodes(nodes: any): Adaptor;
- resume(): void;
- size(dimension: number[]): Adaptor;
- start(
- initialUnconstrainedIterations: number,
- initialUserConstraintIterations: number,
- initialAllConstraintsIterations: number
- ): void;
- stop(): void;
- tick(): any;
+declare module cola {
+ function applyPacking(graphs: Array<any>, w: any, h: any, node_size: any, desired_ratio?: number): void;
+ /**
+ * connected components of graph
+ * returns an array of {}
+ */
+ function separateGraphs(nodes: any, links: any): any[];
+}
+declare module cola.vpsc {
+ class PositionStats {
+ scale: number;
+ AB: number;
+ AD: number;
+ A2: number;
+ constructor(scale: number);
+ addVariable(v: Variable): void;
+ getPosn(): number;
}
-
- interface Cola {
- adaptor: Adaptor;
- colaDragstart(node: { [index: number]: any }): void;
- colaDragend(node: { [index: number]: any }): void;
- start(): void;
- stop(): void;
- }
-
- interface Constraint {
- axis: string;
+ class Constraint {
+ left: Variable;
+ right: Variable;
gap: number;
- left: number;
- right: number;
+ equality: boolean;
+ lm: number;
+ active: boolean;
+ unsatisfiable: boolean;
+ constructor(left: Variable, right: Variable, gap: number, equality?: boolean);
+ slack(): number;
}
-
- interface FlowLayout {
- axis: string;
- minSeparation?: number;
+ class Variable {
+ desiredPosition: number;
+ weight: number;
+ scale: number;
+ offset: number;
+ block: Block;
+ cIn: Constraint[];
+ cOut: Constraint[];
+ constructor(desiredPosition: number, weight?: number, scale?: number);
+ dfdv(): number;
+ position(): number;
+ visitNeighbours(prev: Variable, f: (c: Constraint, next: Variable) => void): void;
}
-
- interface Node {
- height: number;
- id: string;
- size: number;
- width: number;
+ class Block {
+ vars: Variable[];
+ posn: number;
+ ps: PositionStats;
+ blockInd: number;
+ constructor(v: Variable);
+ private addVariable(v);
+ updateWeightedPosition(): void;
+ private compute_lm(v, u, postAction);
+ private populateSplitBlock(v, prev);
+ traverse(visit: (c: Constraint) => any, acc: any[], v?: Variable, prev?: Variable): void;
+ findMinLM(): Constraint;
+ private findMinLMBetween(lv, rv);
+ private findPath(v, prev, to, visit);
+ isActiveDirectedPathBetween(u: Variable, v: Variable): boolean;
+ static split(c: Constraint): Block[];
+ private static createSplitBlock(startVar);
+ splitBetween(vl: Variable, vr: Variable): {
+ constraint: Constraint;
+ lb: Block;
+ rb: Block;
+ };
+ mergeAcross(b: Block, c: Constraint, dist: number): void;
+ cost(): number;
+ }
+ class Blocks {
+ vs: Variable[];
+ private list;
+ constructor(vs: Variable[]);
+ cost(): number;
+ insert(b: Block): void;
+ remove(b: Block): void;
+ merge(c: Constraint): void;
+ forEach(f: (b: Block, i: number) => void): void;
+ updateBlockPositions(): void;
+ split(inactive: Constraint[]): void;
+ }
+ class Solver {
+ vs: Variable[];
+ cs: Constraint[];
+ bs: Blocks;
+ inactive: Constraint[];
+ static LAGRANGIAN_TOLERANCE: number;
+ static ZERO_UPPERBOUND: number;
+ constructor(vs: Variable[], cs: Constraint[]);
+ cost(): number;
+ setStartingPositions(ps: number[]): void;
+ setDesiredPositions(ps: number[]): void;
+ private mostViolated();
+ satisfy(): void;
+ solve(): number;
+ }
+}
+declare module cola.vpsc {
+ class TreeBase {
+ _root: any;
+ size: any;
+ _comparator: any;
+ clear(): void;
+ find(data: any): any;
+ findIter: (data: any) => any;
+ lowerBound(data: any): Iterator;
+ upperBound(data: any): Iterator;
+ min(): any;
+ max(): any;
+ iterator(): Iterator;
+ each(cb: any): void;
+ reach(cb: any): void;
+ _bound(data: any, cmp: any): Iterator;
+ }
+ class Iterator {
+ _tree: any;
+ _ancestors: any;
+ _cursor: any;
+ constructor(tree: any);
+ data(): any;
+ next(): any;
+ prev(): any;
+ _minNode(start: any): void;
+ _maxNode(start: any): void;
+ }
+ class RBTree<T> extends TreeBase {
+ _root: any;
+ _comparator: any;
+ size: any;
+ constructor(comparator: (a: T, b: T) => number);
+ insert(data: any): boolean;
+ remove(data: any): boolean;
+ static is_red(node: any): any;
+ static single_rotate(root: any, dir: any): any;
+ static double_rotate(root: any, dir: any): any;
+ }
+}
+/// <reference path="vpsc.d.ts" />
+/// <reference path="rbtree.d.ts" />
+declare module cola.vpsc {
+ interface Point {
x: number;
y: number;
}
-
- interface Options {
- avoidOverlaps?: boolean;
- convergenceThreshold?: number;
- constraints?: {[key: string]: any}[];
- flowLayout?: FlowLayout;
- handleDisconnected?: boolean;
- linkDistance?: number;
- initialUnconstrainedIterations?: number;
- initialUserConstraintIterations?: number;
- initialAllConstraintsIterations?: number;
- symmetricDiffLinkLengths?: number;
+ interface Leaf {
+ bounds: Rectangle;
+ variable: Variable;
+ }
+ interface Group {
+ bounds: Rectangle;
+ padding: number;
+ stiffness: number;
+ leaves: Leaf[];
+ groups: Group[];
+ minVar: Variable;
+ maxVar: Variable;
+ }
+ function computeGroupBounds(g: Group): Rectangle;
+ class Rectangle {
+ x: number;
+ X: number;
+ y: number;
+ Y: number;
+ constructor(x: number, X: number, y: number, Y: number);
+ static empty(): Rectangle;
+ cx(): number;
+ cy(): number;
+ overlapX(r: Rectangle): number;
+ overlapY(r: Rectangle): number;
+ setXCentre(cx: number): void;
+ setYCentre(cy: number): void;
+ width(): number;
+ height(): number;
+ union(r: Rectangle): Rectangle;
+ /**
+ * return any intersection points between the given line and the sides of this rectangle
+ * @method lineIntersection
+ * @param x1 number first x coord of line
+ * @param y1 number first y coord of line
+ * @param x2 number second x coord of line
+ * @param y2 number second y coord of line
+ * @return any intersection points found
+ */
+ lineIntersections(x1: number, y1: number, x2: number, y2: number): Array<Point>;
+ /**
+ * return any intersection points between a line extending from the centre of this rectangle to the given point,
+ * and the sides of this rectangle
+ * @method lineIntersection
+ * @param x2 number second x coord of line
+ * @param y2 number second y coord of line
+ * @return any intersection points found
+ */
+ rayIntersection(x2: number, y2: number): Point;
+ vertices(): Point[];
+ static lineIntersection(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): Point;
+ inflate(pad: number): Rectangle;
+ }
+ function makeEdgeBetween(source: Rectangle, target: Rectangle, ah: number): {
+ sourceIntersection: Point;
+ targetIntersection: Point;
+ arrowStart: Point;
+ };
+ function makeEdgeTo(s: {
+ x: number;
+ y: number;
+ }, target: Rectangle, ah: number): Point;
+ function generateXConstraints(rs: Rectangle[], vars: Variable[]): Constraint[];
+ function generateYConstraints(rs: Rectangle[], vars: Variable[]): Constraint[];
+ function generateXGroupConstraints(root: Group): Constraint[];
+ function generateYGroupConstraints(root: Group): Constraint[];
+ function removeOverlaps(rs: Rectangle[]): void;
+ interface GraphNode extends Leaf {
+ fixed: boolean;
+ fixedWeight?: number;
+ width: number;
+ height: number;
+ x: number;
+ y: number;
+ px: number;
+ py: number;
+ }
+ class IndexedVariable extends Variable {
+ index: number;
+ constructor(index: number, w: number);
+ }
+ class Projection {
+ private nodes;
+ private groups;
+ private rootGroup;
+ private avoidOverlaps;
+ private xConstraints;
+ private yConstraints;
+ private variables;
+ constructor(nodes: GraphNode[], groups: Group[], rootGroup?: Group, constraints?: any[], avoidOverlaps?: boolean);
+ private createSeparation(c);
+ private makeFeasible(c);
+ private createAlignment(c);
+ private createConstraints(constraints);
+ private setupVariablesAndBounds(x0, y0, desired, getDesired);
+ xProject(x0: number[], y0: number[], x: number[]): void;
+ yProject(x0: number[], y0: number[], y: number[]): void;
+ projectFunctions(): {
+ (x0: number[], y0: number[], r: number[]): void;
+ }[];
+ private project(x0, y0, start, desired, getDesired, cs, generateConstraints, updateNodeBounds, updateGroupBounds);
+ private solve(vs, cs, starting, desired);
+ }
+}
+/// <reference path="vpsc.d.ts" />
+/// <reference path="rectangle.d.ts" />
+declare module cola.geom {
+ class Point {
+ x: number;
+ y: number;
+ }
+ class LineSegment {
+ x1: number;
+ y1: number;
+ x2: number;
+ y2: number;
+ constructor(x1: number, y1: number, x2: number, y2: number);
+ }
+ class PolyPoint extends Point {
+ polyIndex: number;
+ }
+ /** tests if a point is Left|On|Right of an infinite line.
+ * @param points P0, P1, and P2
+ * @return >0 for P2 left of the line through P0 and P1
+ * =0 for P2 on the line
+ * <0 for P2 right of the line
+ */
+ function isLeft(P0: Point, P1: Point, P2: Point): number;
+ /**
+ * returns the convex hull of a set of points using Andrew's monotone chain algorithm
+ * see: http://geomalgorithms.com/a10-_hull-1.html#Monotone%20Chain
+ * @param S array of points
+ * @return the convex hull as an array of points
+ */
+ function ConvexHull(S: Point[]): Point[];
+ function clockwiseRadialSweep(p: Point, P: Point[], f: (p: Point) => void): void;
+ function tangent_PolyPolyC(V: Point[], W: Point[], t1: (a: Point, b: Point[]) => number, t2: (a: Point, b: Point[]) => number, cmp1: (a: Point, b: Point, c: Point) => boolean, cmp2: (a: Point, b: Point, c: Point) => boolean): {
+ t1: number;
+ t2: number;
+ };
+ function LRtangent_PolyPolyC(V: Point[], W: Point[]): {
+ t1: number;
+ t2: number;
+ };
+ function RLtangent_PolyPolyC(V: Point[], W: Point[]): {
+ t1: number;
+ t2: number;
+ };
+ function LLtangent_PolyPolyC(V: Point[], W: Point[]): {
+ t1: number;
+ t2: number;
+ };
+ function RRtangent_PolyPolyC(V: Point[], W: Point[]): {
+ t1: number;
+ t2: number;
+ };
+ class BiTangent {
+ t1: number;
+ t2: number;
+ constructor(t1: number, t2: number);
+ }
+ class BiTangents {
+ rl: BiTangent;
+ lr: BiTangent;
+ ll: BiTangent;
+ rr: BiTangent;
+ }
+ class TVGPoint extends Point {
+ vv: VisibilityVertex;
+ }
+ class VisibilityVertex {
+ id: number;
+ polyid: number;
+ polyvertid: number;
+ p: TVGPoint;
+ constructor(id: number, polyid: number, polyvertid: number, p: TVGPoint);
+ }
+ class VisibilityEdge {
+ source: VisibilityVertex;
+ target: VisibilityVertex;
+ constructor(source: VisibilityVertex, target: VisibilityVertex);
+ length(): number;
+ }
+ class TangentVisibilityGraph {
+ P: TVGPoint[][];
+ V: VisibilityVertex[];
+ E: VisibilityEdge[];
+ constructor(P: TVGPoint[][], g0?: {
+ V: VisibilityVertex[];
+ E: VisibilityEdge[];
+ });
+ addEdgeIfVisible(u: TVGPoint, v: TVGPoint, i1: number, i2: number): void;
+ addPoint(p: TVGPoint, i1: number): VisibilityVertex;
+ private intersectsPolys(l, i1, i2);
+ }
+ function tangents(V: Point[], W: Point[]): BiTangents;
+ function polysOverlap(p: Point[], q: Point[]): boolean;
+}
+/**
+ * @module cola
+ */
+declare module cola {
+ /**
+ * Descent respects a collection of locks over nodes that should not move
+ * @class Locks
+ */
+ class Locks {
+ locks: any;
+ /**
+ * add a lock on the node at index id
+ * @method add
+ * @param id index of node to be locked
+ * @param x required position for node
+ */
+ add(id: number, x: number[]): void;
+ /**
+ * @method clear clear all locks
+ */
+ clear(): void;
+ /**
+ * @isEmpty
+ * @returns false if no locks exist
+ */
+ isEmpty(): boolean;
+ /**
+ * perform an operation on each lock
+ * @apply
+ */
+ apply(f: (id: number, x: number[]) => void): void;
+ }
+ /**
+ * Uses a gradient descent approach to reduce a stress or p-stress goal function over a graph with specified ideal edge lengths or a square matrix of dissimilarities.
+ * The standard stress function over a graph nodes with position vectors x,y,z is (mathematica input):
+ * stress[x_,y_,z_,D_,w_]:=Sum[w[[i,j]] (length[x[[i]],y[[i]],z[[i]],x[[j]],y[[j]],z[[j]]]-d[[i,j]])^2,{i,Length[x]-1},{j,i+1,Length[x]}]
+ * where: D is a square matrix of ideal separations between nodes, w is matrix of weights for those separations
+ * length[x1_, y1_, z1_, x2_, y2_, z2_] = Sqrt[(x1 - x2)^2 + (y1 - y2)^2 + (z1 - z2)^2]
+ * below, we use wij = 1/(Dij^2)
+ *
+ * @class Descent
+ */
+ class Descent {
+ D: number[][];
+ G: number[][];
+ threshold: number;
+ /** Hessian Matrix
+ * @property H {number[][][]}
+ */
+ H: number[][][];
+ /** gradient vector
+ * @property G {number[][]}
+ */
+ g: number[][];
+ /** positions vector
+ * @property x {number[][]}
+ */
+ x: number[][];
+ /**
+ * @property k {number} dimensionality
+ */
+ k: number;
+ /**
+ * number of data-points / nodes / size of vectors/matrices
+ * @property n {number}
+ */
+ n: number;
+ locks: Locks;
+ private static zeroDistance;
+ private minD;
+ private Hd;
+ private a;
+ private b;
+ private c;
+ private d;
+ private e;
+ private ia;
+ private ib;
+ private xtmp;
+ numGridSnapNodes: number;
+ snapGridSize: number;
+ snapStrength: number;
+ scaleSnapByMaxH: boolean;
+ private random;
+ project: {
+ (x0: number[], y0: number[], r: number[]): void;
+ }[];
+ /**
+ * @method constructor
+ * @param x {number[][]} initial coordinates for nodes
+ * @param D {number[][]} matrix of desired distances between pairs of nodes
+ * @param G {number[][]} [default=null] if specified, G is a matrix of weights for goal terms between pairs of nodes.
+ * If G[i][j] > 1 and the separation between nodes i and j is greater than their ideal distance, then there is no contribution for this pair to the goal
+ * If G[i][j] <= 1 then it is used as a weighting on the contribution of the variance between ideal and actual separation between i and j to the goal function
+ */
+ constructor(x: number[][], D: number[][], G?: number[][]);
+ static createSquareMatrix(n: number, f: (i: number, j: number) => number): number[][];
+ private offsetDir();
+ computeDerivatives(x: number[][]): void;
+ private static dotProd(a, b);
+ private static rightMultiply(m, v, r);
+ computeStepSize(d: number[][]): number;
+ reduceStress(): number;
+ private static copy(a, b);
+ private stepAndProject(x0, r, d, stepSize);
+ private static mApply(m, n, f);
+ private matrixApply(f);
+ private computeNextPosition(x0, r);
+ run(iterations: number): number;
+ rungeKutta(): number;
+ private static mid(a, b, m);
+ takeDescentStep(x: number[], d: number[], stepSize: number): void;
+ computeStress(): number;
+ }
+ class PseudoRandom {
+ seed: number;
+ private a;
+ private c;
+ private m;
+ private range;
+ constructor(seed?: number);
+ getNext(): number;
+ getNextBetween(min: number, max: number): number;
+ }
+}
+declare module cola.powergraph {
+ interface LinkAccessor<Link> {
+ getSourceIndex(l: Link): number;
+ getTargetIndex(l: Link): number;
+ getType(l: Link): number;
+ }
+ class PowerEdge {
+ source: any;
+ target: any;
+ type: number;
+ constructor(source: any, target: any, type: number);
+ }
+ class Configuration<Link> {
+ private linkAccessor;
+ modules: Module[];
+ roots: ModuleSet[];
+ R: number;
+ constructor(n: number, edges: Link[], linkAccessor: LinkAccessor<Link>, rootGroup?: any[]);
+ private initModulesFromGroup(group);
+ merge(a: Module, b: Module, k?: number): Module;
+ private rootMerges(k?);
+ greedyMerge(): boolean;
+ private nEdges(a, b);
+ getGroupHierarchy(retargetedEdges: PowerEdge[]): any[];
+ allEdges(): PowerEdge[];
+ static getEdges(modules: ModuleSet, es: PowerEdge[]): void;
+ }
+ class Module {
+ id: number;
+ outgoing: LinkSets;
+ incoming: LinkSets;
+ children: ModuleSet;
+ definition: any;
+ gid: number;
+ constructor(id: number, outgoing?: LinkSets, incoming?: LinkSets, children?: ModuleSet, definition?: any);
+ getEdges(es: PowerEdge[]): void;
+ isLeaf(): boolean;
+ isIsland(): boolean;
+ isPredefined(): boolean;
+ }
+ class ModuleSet {
+ table: any;
+ count(): number;
+ intersection(other: ModuleSet): ModuleSet;
+ intersectionCount(other: ModuleSet): number;
+ contains(id: number): boolean;
+ add(m: Module): void;
+ remove(m: Module): void;
+ forAll(f: (m: Module) => void): void;
+ modules(): Module[];
+ }
+ class LinkSets {
+ sets: any;
+ n: number;
+ count(): number;
+ contains(id: number): boolean;
+ add(linktype: number, m: Module): void;
+ remove(linktype: number, m: Module): void;
+ forAll(f: (ms: ModuleSet, linktype: number) => void): void;
+ forAllModules(f: (m: Module) => void): void;
+ intersection(other: LinkSets): LinkSets;
+ }
+ function getGroups<Link>(nodes: any[], links: Link[], la: LinkAccessor<Link>, rootGroup?: any[]): {
+ groups: any[];
+ powerEdges: PowerEdge[];
+ };
+}
+/**
+ * @module cola
+ */
+declare module cola {
+ interface LinkAccessor<Link> {
+ getSourceIndex(l: Link): number;
+ getTargetIndex(l: Link): number;
+ }
+ interface LinkLengthAccessor<Link> extends LinkAccessor<Link> {
+ setLength(l: Link, value: number): void;
+ }
+ /** modify the specified link lengths based on the symmetric difference of their neighbours
+ * @class symmetricDiffLinkLengths
+ */
+ function symmetricDiffLinkLengths<Link>(links: Link[], la: LinkLengthAccessor<Link>, w?: number): void;
+ /** modify the specified links lengths based on the jaccard difference between their neighbours
+ * @class jaccardLinkLengths
+ */
+ function jaccardLinkLengths<Link>(links: Link[], la: LinkLengthAccessor<Link>, w?: number): void;
+ interface IConstraint {
+ left: number;
+ right: number;
+ gap: number;
+ }
+ interface DirectedEdgeConstraints {
+ axis: string;
+ gap: number;
+ }
+ interface LinkSepAccessor<Link> extends LinkAccessor<Link> {
+ getMinSeparation(l: Link): number;
+ }
+ /** generate separation constraints for all edges unless both their source and sink are in the same strongly connected component
+ * @class generateDirectedEdgeConstraints
+ */
+ function generateDirectedEdgeConstraints<Link>(n: number, links: Link[], axis: string, la: LinkSepAccessor<Link>): IConstraint[];
+ /**
+ * Tarjan's strongly connected components algorithm for directed graphs
+ * returns an array of arrays of node indicies in each of the strongly connected components.
+ * a vertex not in a SCC of two or more nodes is it's own SCC.
+ * adaptation of https://en.wikipedia.org/wiki/Tarjan%27s_strongly_connected_components_algorithm
+ */
+ function stronglyConnectedComponents<Link>(numVertices: number, edges: Link[], la: LinkAccessor<Link>): number[][];
+}
+declare class PairingHeap<T> {
+ elem: T;
+ private subheaps;
+ constructor(elem: T);
+ toString(selector: any): string;
+ forEach(f: any): void;
+ count(): number;
+ min(): T;
+ empty(): boolean;
+ contains(h: PairingHeap<T>): boolean;
+ isHeap(lessThan: (a: T, b: T) => boolean): boolean;
+ insert(obj: T, lessThan: any): PairingHeap<T>;
+ merge(heap2: PairingHeap<T>, lessThan: any): PairingHeap<T>;
+ removeMin(lessThan: (a: T, b: T) => boolean): PairingHeap<T>;
+ mergePairs(lessThan: (a: T, b: T) => boolean): PairingHeap<T>;
+ decreaseKey(subheap: PairingHeap<T>, newValue: T, setHeapNode: (e: T, h: PairingHeap<T>) => void, lessThan: (a: T, b: T) => boolean): PairingHeap<T>;
+}
+/**
+ * @class PriorityQueue a min priority queue backed by a pairing heap
+ */
+declare class PriorityQueue<T> {
+ private lessThan;
+ private root;
+ constructor(lessThan: (a: T, b: T) => boolean);
+ /**
+ * @method top
+ * @return the top element (the min element as defined by lessThan)
+ */
+ top(): T;
+ /**
+ * @method push
+ * put things on the heap
+ */
+ push(...args: T[]): PairingHeap<T>;
+ /**
+ * @method empty
+ * @return true if no more elements in queue
+ */
+ empty(): boolean;
+ /**
+ * @method isHeap check heap condition (for testing)
+ * @return true if queue is in valid state
+ */
+ isHeap(): boolean;
+ /**
+ * @method forEach apply f to each element of the queue
+ * @param f function to apply
+ */
+ forEach(f: any): void;
+ /**
+ * @method pop remove and return the min element from the queue
+ */
+ pop(): T;
+ /**
+ * @method reduceKey reduce the key value of the specified heap node
+ */
+ reduceKey(heapNode: PairingHeap<T>, newKey: T, setHeapNode?: (e: T, h: PairingHeap<T>) => void): void;
+ toString(selector: any): string;
+ /**
+ * @method count
+ * @return number of elements in queue
+ */
+ count(): number;
+}
+/// <reference path="pqueue.d.ts" />
+/**
+ * @module shortestpaths
+ */
+declare module cola.shortestpaths {
+ /**
+ * calculates all-pairs shortest paths or shortest paths from a single node
+ * @class Calculator
+ * @constructor
+ * @param n {number} number of nodes
+ * @param es {Edge[]} array of edges
+ */
+ class Calculator<Link> {
+ n: number;
+ es: Link[];
+ private neighbours;
+ constructor(n: number, es: Link[], getSourceIndex: (l: Link) => number, getTargetIndex: (l: Link) => number, getLength: (l: Link) => number);
+ /**
+ * compute shortest paths for graph over n nodes with edges an array of source/target pairs
+ * edges may optionally have a length attribute. 1 is the default.
+ * Uses Johnson's algorithm.
+ *
+ * @method DistanceMatrix
+ * @return the distance matrix
+ */
+ DistanceMatrix(): number[][];
+ /**
+ * get shortest paths from a specified start node
+ * @method DistancesFromNode
+ * @param start node index
+ * @return array of path lengths
+ */
+ DistancesFromNode(start: number): number[];
+ PathFromNodeToNode(start: number, end: number): number[];
+ PathFromNodeToNodeWithPrevCost(start: number, end: number, prevCost: (u: number, v: number, w: number) => number): number[];
+ private dijkstraNeighbours(start, dest?);
+ }
+}
+/// <reference path="handledisconnected.d.ts" />
+/// <reference path="geom.d.ts" />
+/// <reference path="descent.d.ts" />
+/// <reference path="powergraph.d.ts" />
+/// <reference path="linklengths.d.ts" />
+/// <reference path="shortestpaths.d.ts" />
+/**
+ * @module cola
+ */
+declare module cola {
+ /**
+ * The layout process fires three events:
+ * - start: layout iterations started
+ * - tick: fired once per iteration, listen to this to animate
+ * - end: layout converged, you might like to zoom-to-fit or something at notification of this event
+ */
+ enum EventType {
+ start = 0,
+ tick = 1,
+ end = 2,
+ }
+ interface Event {
+ type: EventType;
+ alpha: number;
+ stress?: number;
+ listener?: () => void;
+ }
+ interface Node {
+ /**
+ * x and y will be computed by layout as the Node's centroid
+ */
+ x: number;
+ /**
+ * x and y will be computed by layout as the Node's centroid
+ */
+ y: number;
+ /**
+ * specify a width and height of the node's bounding box if you turn on avoidOverlaps
+ */
+ width?: number;
+ /**
+ * specify a width and height of the node's bounding box if you turn on avoidOverlaps
+ */
+ height?: any;
+ number: any;
+ }
+ interface Link<NodeType> {
+ source: NodeType;
+ target: NodeType;
+ length?: number;
+ weight?: number;
+ }
+ /**
+ * Main interface to cola layout.
+ * @class Layout
+ */
+ class Layout {
+ private _canvasSize;
+ private _linkDistance;
+ private _defaultNodeSize;
+ private _linkLengthCalculator;
+ private _linkType;
+ private _avoidOverlaps;
+ private _handleDisconnected;
+ private _alpha;
+ private _lastStress;
+ private _running;
+ private _nodes;
+ private _groups;
+ private _rootGroup;
+ private _links;
+ private _constraints;
+ private _distanceMatrix;
+ private _descent;
+ private _directedLinkConstraints;
+ private _threshold;
+ private _visibilityGraph;
+ private _groupCompactness;
+ protected event: any;
+ on(e: EventType | string, listener: (event: Event) => void): Layout;
+ protected trigger(e: Event): void;
+ protected kick(): void;
+ /**
+ * iterate the layout. Returns true when layout converged.
+ */
+ protected tick(): boolean;
+ private updateNodePositions();
+ /**
+ * the list of nodes.
+ * If nodes has not been set, but links has, then we instantiate a nodes list here, of the correct size,
+ * before returning it.
+ * @property nodes {Array}
+ * @default empty list
+ */
+ nodes(): Array<Node>;
+ nodes(v: Array<Node>): Layout;
+ /**
+ * a list of hierarchical groups defined over nodes
+ * @property groups {Array}
+ * @default empty list
+ */
+ groups(): Array<any>;
+ groups(x: Array<any>): Layout;
+ powerGraphGroups(f: Function): Layout;
+ /**
+ * if true, the layout will not permit overlaps of the node bounding boxes (defined by the width and height properties on nodes)
+ * @property avoidOverlaps
+ * @type bool
+ * @default false
+ */
+ avoidOverlaps(): boolean;
+ avoidOverlaps(v: boolean): Layout;
+ /**
+ * if true, the final step of the start method will be to nicely pack connected components of the graph.
+ * works best if start() is called with a reasonable number of iterations specified and
+ * each node has a bounding box (defined by the width and height properties on nodes).
+ * @property handleDisconnected
+ * @type bool
+ * @default true
+ */
+ handleDisconnected(): boolean;
+ handleDisconnected(v: boolean): Layout;
+ /**
+ * causes constraints to be generated such that directed graphs are laid out either from left-to-right or top-to-bottom.
+ * a separation constraint is generated in the selected axis for each edge that is not involved in a cycle (part of a strongly connected component)
+ * @param axis {string} 'x' for left-to-right, 'y' for top-to-bottom
+ * @param minSeparation {number|link=>number} either a number specifying a minimum spacing required across all links or a function to return the minimum spacing for each link
+ */
+ flowLayout(axis: string, minSeparation: number | ((t: any) => number)): Layout;
+ /**
+ * links defined as source, target pairs over nodes
+ * @property links {array}
+ * @default empty list
+ */
+ links(): Array<Link<Node | number>>;
+ links(x: Array<Link<Node | number>>): Layout;
+ /**
+ * list of constraints of various types
+ * @property constraints
+ * @type {array}
+ * @default empty list
+ */
+ constraints(): Array<any>;
+ constraints(c: Array<any>): Layout;
+ /**
+ * Matrix of ideal distances between all pairs of nodes.
+ * If unspecified, the ideal distances for pairs of nodes will be based on the shortest path distance between them.
+ * @property distanceMatrix
+ * @type {Array of Array of Number}
+ * @default null
+ */
+ distanceMatrix(): Array<Array<number>>;
+ distanceMatrix(d: Array<Array<number>>): Layout;
+ /**
+ * Size of the layout canvas dimensions [x,y]. Currently only used to determine the midpoint which is taken as the starting position
+ * for nodes with no preassigned x and y.
+ * @property size
+ * @type {Array of Number}
+ */
+ size(): Array<number>;
+ size(x: Array<number>): Layout;
+ /**
+ * Default size (assume nodes are square so both width and height) to use in packing if node width/height are not specified.
+ * @property defaultNodeSize
+ * @type {Number}
+ */
+ defaultNodeSize(): number;
+ defaultNodeSize(x: number): Layout;
+ /**
+ * The strength of attraction between the group boundaries to each other.
+ * @property defaultNodeSize
+ * @type {Number}
+ */
+ groupCompactness(): number;
+ groupCompactness(x: number): Layout;
+ /**
+ * links have an ideal distance, The automatic layout will compute layout that tries to keep links (AKA edges) as close as possible to this length.
+ */
+ linkDistance(): number;
+ linkDistance(): (t: any) => number;
+ linkDistance(x: number): Layout;
+ linkDistance(x: (t: any) => number): Layout;
+ linkType(f: Function | number): Layout;
+ convergenceThreshold(): number;
+ convergenceThreshold(x: number): Layout;
+ alpha(): number;
+ alpha(x: number): Layout;
+ getLinkLength(link: any): number;
+ static setLinkLength(link: any, length: number): void;
+ getLinkType(link: any): number;
+ linkAccessor: {
+ getSourceIndex: (e: any) => any;
+ getTargetIndex: (e: any) => any;
+ setLength: (link: any, length: number) => void;
+ getType: (l: any) => any;
+ };
+ /**
+ * compute an ideal length for each link based on the graph structure around that link.
+ * you can use this (for example) to create extra space around hub-nodes in dense graphs.
+ * In particular this calculation is based on the "symmetric difference" in the neighbour sets of the source and target:
+ * i.e. if neighbours of source is a and neighbours of target are b then calculation is: sqrt(|a union b| - |a intersection b|)
+ * Actual computation based on inspection of link structure occurs in start(), so links themselves
+ * don't have to have been assigned before invoking this function.
+ * @param {number} [idealLength] the base length for an edge when its source and start have no other common neighbours (e.g. 40)
+ * @param {number} [w] a multiplier for the effect of the length adjustment (e.g. 0.7)
+ */
+ symmetricDiffLinkLengths(idealLength: number, w?: number): Layout;
+ /**
+ * compute an ideal length for each link based on the graph structure around that link.
+ * you can use this (for example) to create extra space around hub-nodes in dense graphs.
+ * In particular this calculation is based on the "symmetric difference" in the neighbour sets of the source and target:
+ * i.e. if neighbours of source is a and neighbours of target are b then calculation is: |a intersection b|/|a union b|
+ * Actual computation based on inspection of link structure occurs in start(), so links themselves
+ * don't have to have been assigned before invoking this function.
+ * @param {number} [idealLength] the base length for an edge when its source and start have no other common neighbours (e.g. 40)
+ * @param {number} [w] a multiplier for the effect of the length adjustment (e.g. 0.7)
+ */
+ jaccardLinkLengths(idealLength: number, w?: number): Layout;
+ /**
+ * start the layout process
+ * @method start
+ * @param {number} [initialUnconstrainedIterations=0] unconstrained initial layout iterations
+ * @param {number} [initialUserConstraintIterations=0] initial layout iterations with user-specified constraints
+ * @param {number} [initialAllConstraintsIterations=0] initial layout iterations with all constraints including non-overlap
+ * @param {number} [gridSnapIterations=0] iterations of "grid snap", which pulls nodes towards grid cell centers - grid of size node[0].width - only really makes sense if all nodes have the same width and height
+ * @param [keepRunning=true] keep iterating asynchronously via the tick method
+ */
+ start(initialUnconstrainedIterations?: number, initialUserConstraintIterations?: number, initialAllConstraintsIterations?: number, gridSnapIterations?: number, keepRunning?: boolean): Layout;
+ private separateOverlappingComponents(width, height);
+ resume(): Layout;
+ stop(): Layout;
+ prepareEdgeRouting(nodeMargin?: number): void;
+ routeEdge(edge: any, draw: any): any[];
+ static getSourceIndex(e: any): any;
+ static getTargetIndex(e: any): any;
+ static linkId(e: any): string;
+ static dragStart(d: any): void;
+ static dragEnd(d: any): void;
+ static mouseOver(d: any): void;
+ static mouseOut(d: any): void;
+ }
+}
+/// <reference path="layout.d.ts" />
+declare module cola {
+ class LayoutAdaptor extends Layout {
+ trigger(e: Event): void;
+ kick(): void;
+ drag(): void;
+ on(eventType: EventType | string, listener: () => void): LayoutAdaptor;
+ dragstart: (d: any) => void;
+ dragStart: (d: any) => void;
+ dragend: (d: any) => void;
+ dragEnd: (d: any) => void;
+ constructor(options: any);
+ }
+ /**
+ * provides an interface for use with any external graph system (e.g. Cytoscape.js):
+ */
+ function adaptor(options: any): LayoutAdaptor;
+}
+declare module cola {
+ function gridify(pgLayout: any, nudgeGap: any, margin: any, groupMargin: any): geom.Point[][][];
+ function powerGraphGridLayout(graph: {
+ nodes: Node[];
+ links: Link<Node>[];
+ }, size: number[], grouppadding: number, margin: number, groupMargin: number): {
+ cola: Layout;
+ powerGraph: any;
+ };
+}
+/// <reference path="layout.d.ts" />
+declare module cola {
+ class D3StyleLayoutAdaptor extends Layout {
+ event: any;
+ trigger(e: Event): void;
+ kick(): void;
+ drag: () => any;
+ constructor();
+ on(eventType: EventType | string, listener: () => void): D3StyleLayoutAdaptor;
+ }
+ /**
+ * provides an interface for use with d3:
+ * - uses the d3 event system to dispatch layout events such as:
+ * o "start" (start layout process)
+ * o "tick" (after each layout iteration)
+ * o "end" (layout converged and complete).
+ * - uses the d3 timer to queue layout iterations.
+ * - sets up d3.behavior.drag to drag nodes
+ * o use `node.call(<the returned instance of Layout>.drag)` to make nodes draggable
+ * returns an instance of the cola.Layout itself with which the user
+ * can interact directly.
+ */
+ function d3adaptor(): D3StyleLayoutAdaptor;
+}
+/// <reference path="rectangle.d.ts" />
+/// <reference path="shortestpaths.d.ts" />
+/// <reference path="geom.d.ts" />
+/// <reference path="vpsc.d.ts" />
+declare module cola {
+ interface NodeAccessor<Node> {
+ getChildren(v: Node): number[];
+ getBounds(v: Node): cola.vpsc.Rectangle;
+ }
+ class NodeWrapper {
+ id: number;
+ rect: cola.vpsc.Rectangle;
+ children: number[];
+ leaf: boolean;
+ parent: NodeWrapper;
+ ports: Vert[];
+ constructor(id: number, rect: cola.vpsc.Rectangle, children: number[]);
+ }
+ class Vert {
+ id: number;
+ x: number;
+ y: number;
+ node: NodeWrapper;
+ line: any;
+ constructor(id: number, x: number, y: number, node?: NodeWrapper, line?: any);
+ }
+ class LongestCommonSubsequence<T> {
+ s: T[];
+ t: T[];
+ length: number;
+ si: number;
+ ti: number;
+ reversed: boolean;
+ constructor(s: T[], t: T[]);
+ private static findMatch<T>(s, t);
+ getSequence(): T[];
+ }
+ interface GridLine {
+ nodes: NodeWrapper[];
+ pos: number;
+ }
+ class GridRouter<Node> {
+ originalnodes: Node[];
+ groupPadding: number;
+ leaves: NodeWrapper[];
+ groups: NodeWrapper[];
+ nodes: NodeWrapper[];
+ cols: GridLine[];
+ rows: GridLine[];
+ root: any;
+ verts: Vert[];
+ edges: any;
+ backToFront: any;
+ obstacles: any;
+ passableEdges: any;
+ private avg(a);
+ private getGridLines(axis);
+ private getDepth(v);
+ private midPoints(a);
+ constructor(originalnodes: Node[], accessor: NodeAccessor<Node>, groupPadding?: number);
+ private findLineage(v);
+ private findAncestorPathBetween(a, b);
+ siblingObstacles(a: any, b: any): any;
+ static getSegmentSets(routes: any, x: any, y: any): any[];
+ static nudgeSegs(x: string, y: string, routes: any, segments: any, leftOf: any, gap: number): void;
+ static nudgeSegments(routes: any, x: string, y: string, leftOf: (e1: number, e2: number) => boolean, gap: number): void;
+ routeEdges<Edge>(edges: Edge[], nudgeGap: number, source: (e: Edge) => number, target: (e: Edge) => number): geom.Point[][][];
+ static unreverseEdges(routes: any, routePaths: any): void;
+ static angleBetween2Lines(line1: geom.Point[], line2: geom.Point[]): number;
+ private static isLeft(a, b, c);
+ private static getOrder(pairs);
+ static orderEdges(edges: any): (l: number, r: number) => boolean;
+ static makeSegments(path: geom.Point[]): geom.Point[][];
+ route(s: number, t: number): geom.Point[];
+ static getRoutePath(route: geom.Point[][], cornerradius: number, arrowwidth: number, arrowheight: number): {
+ routepath: string;
+ arrowpath: string;
+ };
+ }
+}
+/**
+ * Use cola to do a layout in 3D!! Yay.
+ * Pretty simple for the moment.
+ */
+declare module cola {
+ class Link3D {
+ source: number;
+ target: number;
+ length: number;
+ constructor(source: number, target: number);
+ actualLength(x: number[][]): number;
+ }
+ class Node3D implements vpsc.GraphNode {
+ x: number;
+ y: number;
+ z: number;
+ fixed: boolean;
+ width: number;
+ height: number;
+ px: number;
+ py: number;
+ bounds: vpsc.Rectangle;
+ variable: vpsc.Variable;
+ constructor(x?: number, y?: number, z?: number);
+ }
+ class Layout3D {
+ nodes: Node3D[];
+ links: Link3D[];
+ idealLinkLength: number;
+ static dims: string[];
+ static k: number;
+ result: number[][];
+ constraints: any[];
+ constructor(nodes: Node3D[], links: Link3D[], idealLinkLength?: number);
+ linkLength(l: Link3D): number;
+ useJaccardLinkLengths: boolean;
+ descent: cola.Descent;
+ start(iterations?: number): Layout3D;
+ tick(): number;
}
}
-
-declare var cola: WebCola.Cola;
-
diff --git a/webpack/webpack-env.d.ts b/webpack/webpack-env.d.ts
index 01ea6e404c..f67b9c5d6a 100644
--- a/webpack/webpack-env.d.ts
+++ b/webpack/webpack-env.d.ts
@@ -28,7 +28,7 @@ declare namespace __WebpackModuleApi {
*
* 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;
+ ensure: (paths: string[], callback: (require: <T>(path: string) => T) => void, chunkName?: string) => 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.
@@ -100,4 +100,4 @@ declare var __non_webpack_require__: any;
/**
* Equals the config option debug
*/
-declare var DEBUG: boolean;
\ No newline at end of file
+declare var DEBUG: boolean;
diff --git a/when/when-tests.ts b/when/when-tests.ts
index 7cd7e8e45c..267493dd56 100644
--- a/when/when-tests.ts
+++ b/when/when-tests.ts
@@ -116,6 +116,14 @@ when.iterate(function (x) {
console.log(err);
});
+when.unfold(function (x) {
+ return [{foo: 'bar'}, x + 1];
+}, function (x) {
+ return x < 10;
+}, function (y) {
+ delete y.foo;
+}, 0);
+
/* when.promise(resolver) */
promise = when.promise<number>(resolve => resolve(5));
diff --git a/when/when.d.ts b/when/when.d.ts
index 432a76b366..a9166ab62d 100644
--- a/when/when.d.ts
+++ b/when/when.d.ts
@@ -141,6 +141,23 @@ declare module When {
seed: U | Promise<U>): Promise<U>;
+ /**
+ * Similar to when/iterate, when.unfold generates a potentially infinite stream of promises by repeatedly calling
+ * unspool until predicate becomes true. when.unfold allows you to thread additional state information through the iteration.
+ * @memberOf when
+ * @param unspool function that, given a seed, returns a [valueToSendToHandler, newSeed] pair.
+ * May return an array, array of promises, promise for an array, or promise for an array of promises.
+ * @param predicate function that receives the current seed, and should return truthy when the unfold should stop
+ * @param handler function that receives the valueToSendToHandler of the current iteration.
+ * This function can process valueToSendToHandler in whatever way you need.
+ * It may return a promise to delay the next iteration of the unfold.
+ * @param seed initial value provided to the first unspool invocation. May be a promise.
+ */
+ function unfold<T, U>(unspool: (seed: U) => [T | Promise<T>, U | Promise<U>] | Promise<[T | Promise<T>, U | Promise<U>]>,
+ predicate: (value: U) => boolean | Promise<boolean>,
+ handler: (value: T) => Promise<any> | void,
+ seed: U | Promise<U>): Promise<void>;
+
/**
* Creates a {promise, resolver} pair, either or both of which
* may be given out safely to consumers.
diff --git a/winjs/winjs.d.ts b/winjs/winjs.d.ts
index 195ecb66ec..9030196983 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/wolfy87-eventemitter/wolfy87-eventemitter-test.ts b/wolfy87-eventemitter/wolfy87-eventemitter-tests.ts
similarity index 100%
rename from wolfy87-eventemitter/wolfy87-eventemitter-test.ts
rename to wolfy87-eventemitter/wolfy87-eventemitter-tests.ts
diff --git a/xregexp/xregexp-tests.ts b/xregexp/xregexp-tests.ts
index 0a7f24dedd..17e1d6bdfa 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 561c37f574..0bc29f07f6 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;
}
diff --git a/yargs/yargs-tests.ts b/yargs/yargs-tests.ts
index 10b75382b5..f20254990a 100644
--- a/yargs/yargs-tests.ts
+++ b/yargs/yargs-tests.ts
@@ -134,6 +134,49 @@ function Argv$options() {
;
}
+function command() {
+ var argv = yargs
+ .usage('npm <command>')
+ .command('install', 'tis a mighty fine package to install')
+ .command('publish', 'shiver me timbers, should you be sharing all that', yargs => {
+ argv = yargs.option('f', {
+ alias: 'force',
+ description: 'yar, it usually be a bad idea'
+ })
+ .help('help')
+ .argv;
+ })
+ .help('help')
+ .argv;
+}
+
+function completion_sync() {
+ var argv = yargs
+ .completion('completion', (current, argv) => {
+ // 'current' is the current command being completed.
+ // 'argv' is the parsed arguments so far.
+ // simply return an array of completions.
+ return [
+ 'foo',
+ 'bar'
+ ];
+ })
+ .argv;
+}
+
+function completion_async() {
+ var argv = yargs
+ .completion('completion', (current, argv, done) => {
+ setTimeout(function() {
+ done([
+ 'apple',
+ 'banana'
+ ]);
+ }, 500);
+ })
+ .argv;
+}
+
function Argv$help() {
var yargs1 = yargs
.usage("$0 -operand1 number -operand2 number -operation [add|subtract]");
diff --git a/yargs/yargs.d.ts b/yargs/yargs.d.ts
index 0e42090fcd..03b7c05dcd 100644
--- a/yargs/yargs.d.ts
+++ b/yargs/yargs.d.ts
@@ -54,6 +54,12 @@ declare module "yargs" {
usage(options?: { [key: string]: Options }): Argv;
command(command: string, description: string): Argv;
+ command(command: string, description: string, fn: (args: Argv) => void): Argv;
+
+ completion(cmd: string, fn?: SyncCompletionFunction): Argv;
+ completion(cmd: string, description?: string, fn?: SyncCompletionFunction): Argv;
+ completion(cmd: string, fn?: AsyncCompletionFunction): Argv;
+ completion(cmd: string, description?: string, fn?: AsyncCompletionFunction): Argv;
example(command: string, description: string): Argv;
@@ -110,6 +116,9 @@ declare module "yargs" {
desc?: any;
requiresArg?: any;
}
+
+ type SyncCompletionFunction = (current: string, argv: any) => string[];
+ type AsyncCompletionFunction = (current: string, argv: any, done: (completion: string[]) => void) => void;
}
var yargs: yargs.Argv;
diff --git a/yeoman-generator/yeoman-generator.d.ts b/yeoman-generator/yeoman-generator.d.ts
index f6d0dd9814..4ccd98e44a 100644
--- a/yeoman-generator/yeoman-generator.d.ts
+++ b/yeoman-generator/yeoman-generator.d.ts
@@ -5,163 +5,187 @@
/// <reference path="../node/node.d.ts" />
declare module yo {
- export interface IYeomanGenerator {
- argument(name: string, config: IArgumentConfig): void;
- composeWith(namespace: string, options: any, settings?: IComposeSetting): IYeomanGenerator;
- defaultFor(name: string): void;
- destinationRoot(rootPath: string): string;
- determineAppname(): void;
- getCollisionFilter(): (output: any) => void;
- hookFor(name: string, config: IHookConfig): void;
- option(name: string, config: IYeomanGeneratorOption): void;
- rootGeneratorName(): string;
- run(args?: any): void;
- run(args: any, callback?: Function): void;
- runHooks(callback?: Function): void;
- sourceRoot(rootPath: string): string;
- }
+ export interface IYeomanGenerator {
+ argument(name: string, config: IArgumentConfig): void;
+ composeWith(namespace: string, options: any, settings?: IComposeSetting): IYeomanGenerator;
+ defaultFor(name: string): void;
+ destinationRoot(rootPath: string): string;
+ determineAppname(): void;
+ getCollisionFilter(): (output: any) => void;
+ hookFor(name: string, config: IHookConfig): void;
+ option(name: string, config: IYeomanGeneratorOption): void;
+ rootGeneratorName(): string;
+ run(args?: any): void;
+ run(args: any, callback?: Function): void;
+ runHooks(callback?: Function): void;
+ sourceRoot(rootPath: string): string;
- export class YeomanGeneratorBase implements IYeomanGenerator, NodeJS.EventEmitter {
- argument(name: string, config: IArgumentConfig): void;
- composeWith(namespace: string, options: any, settings?: IComposeSetting): IYeomanGenerator;
- defaultFor(name: string): void;
- destinationRoot(rootPath: string): string;
- determineAppname(): void;
- getCollisionFilter(): (output: any) => void;
- hookFor(name: string, config: IHookConfig): void;
- option(name: string, config: IYeomanGeneratorOption): void;
- rootGeneratorName(): string;
- run(args?: any): void;
- run(args: any, callback?: Function): void;
- runHooks(callback?: Function): void;
- sourceRoot(rootPath: string): string;
- addListener(event: string, listener: Function): NodeJS.EventEmitter;
- on(event: string, listener: Function): NodeJS.EventEmitter;
- once(event: string, listener: Function): NodeJS.EventEmitter;
- removeListener(event: string, listener: Function): NodeJS.EventEmitter;
- removeAllListeners(event?: string): NodeJS.EventEmitter;
- setMaxListeners(n: number): void;
- listeners(event: string): Function[];
- emit(event: string, ...args: any[]): boolean;
- }
- export interface IArgumentConfig {
- desc: string;
- required: boolean;
- optional: boolean;
- type: any;
- defaults: any;
- }
+ }
- export interface IComposeSetting {
- local?: string;
- link?: string;
- }
+ export class YeomanGeneratorBase implements IYeomanGenerator, NodeJS.EventEmitter {
+ argument(name: string, config: IArgumentConfig): void;
+ composeWith(namespace: string, options: any, settings?: IComposeSetting): IYeomanGenerator;
+ defaultFor(name: string): void;
+ destinationRoot(rootPath: string): string;
+ determineAppname(): void;
+ getCollisionFilter(): (output: any) => void;
+ hookFor(name: string, config: IHookConfig): void;
+ option(name: string, config?: IYeomanGeneratorOption): void;
+ rootGeneratorName(): string;
+ run(args?: any): void;
+ run(args: any, callback?: Function): void;
+ runHooks(callback?: Function): void;
+ sourceRoot(rootPath: string): string;
+ addListener(event: string, listener: Function): NodeJS.EventEmitter;
+ on(event: string, listener: Function): NodeJS.EventEmitter;
+ once(event: string, listener: Function): NodeJS.EventEmitter;
+ removeListener(event: string, listener: Function): NodeJS.EventEmitter;
+ removeAllListeners(event?: string): NodeJS.EventEmitter;
+ setMaxListeners(n: number): void;
+ listeners(event: string): Function[];
+ emit(event: string, ...args: any[]): boolean;
- export interface IHookConfig {
- as: string;
- args: any;
- options: any;
- }
+ async(): any;
+ prompt(opt?:IPromptOptions, callback?:(answers:any)=>void) :void;
+ log(message: string) : void;
+ npmInstall(packages: string[], options?:any) :void;
- export interface IYeomanGeneratorOption {
- alias: string;
- defaults: any;
- desc: string;
- hide: boolean;
- type: any;
- }
+ appname: string;
+ gruntfile: IGruntFileStatic;
+ }
+ export interface IPromptOptions{
+ type:string;
+ name:string;
+ message:string;
+ default:string;
+ }
+
+ export interface IGruntFileStatic {
+ loadNpmTasks(pluginName: string): void;
+ insertConfig(name:string, config:any):void;
+ registerTask(name:string, tasks:any):void;
+ insertVariable(name:string, value:any):void;
+ prependJavaScript(code:string):void;
+ }
- export interface IQueueProps {
- initializing: () => void;
- prompting?: () => void;
- configuring?: () => void;
- default?: () => void;
- writing: {
- [target: string]: () => void;
- };
- conflicts?: () => void;
- install?: () => void;
- end: () => void;
- }
+ export interface IArgumentConfig {
+ desc: string;
+ required: boolean;
+ optional: boolean;
+ type: any;
+ defaults: any;
+ }
- export interface INamedBase extends IYeomanGenerator {
- }
+ export interface IComposeSetting {
+ local?: string;
+ link?: string;
+ }
- export interface IBase extends INamedBase {
- }
+ export interface IHookConfig {
+ as: string;
+ args: any;
+ options: any;
+ }
- export interface IAssert {
- file(path: string): void;
- file(paths: string[]): void;
- fileContent(file: string, reg: RegExp): void;
+ export interface IYeomanGeneratorOption {
+ alias?: string;
+ defaults?: any;
+ desc?: string;
+ hide?: boolean;
+ type?: any;
+ }
- /** @param {[String, RegExp][]} pairs */
- fileContent(pairs: any[][]): void;
+ export interface IQueueProps {
+ initializing: () => void;
+ prompting?: () => void;
+ configuring?: () => void;
+ default?: () => void;
+ writing: {
+ [target: string]: () => void;
+ };
+ conflicts?: () => void;
+ install?: () => void;
+ end: () => void;
+ }
- /** @param {[String, RegExp][]|String[]} pairs */
- files(pairs: any[]): void;
+ export interface INamedBase extends IYeomanGenerator {
+ }
- /**
- * @param {Object} subject
- * @param {Object|Array} methods
- */
- implement(subject: any, methods: any): void;
- noFile(file: string): void;
- noFileContent(file: string, reg: RegExp): void;
+ export interface IBase extends INamedBase {
+ }
- /** @param {[String, RegExp][]} pairs */
- noFileContent(pairs: any[][]): void;
+ export interface IAssert {
+ file(path: string): void;
+ file(paths: string[]): void;
+ fileContent(file: string, reg: RegExp): void;
- /**
- * @param {Object} subject
- * @param {Object|Array} methods
- */
- noImplement(subject: any, methods: any): void;
+ /** @param {[String, RegExp][]} pairs */
+ fileContent(pairs: any[][]): void;
- textEqual(value: string, expected: string): void;
- }
+ /** @param {[String, RegExp][]|String[]} pairs */
+ files(pairs: any[]): void;
- export interface ITestHelper {
- createDummyGenerator(): IYeomanGenerator;
- createGenerator(name: string, dependencies: any[], args: any, options: any): IYeomanGenerator;
- decorate(context: any, method: string, replacement: Function, options: any): void;
- gruntfile(options: any, done: Function): void;
- mockPrompt(generator: IYeomanGenerator, answers: any): void;
- registerDependencies(dependencies: string[]): void;
- restore(): void;
+ /**
+ * @param {Object} subject
+ * @param {Object|Array} methods
+ */
+ implement(subject: any, methods: any): void;
+ noFile(file: string): void;
+ noFileContent(file: string, reg: RegExp): void;
- /** @param {String|Function} generator */
- run(generator: any): IRunContext;
- }
+ /** @param {[String, RegExp][]} pairs */
+ noFileContent(pairs: any[][]): void;
- export interface IRunContext {
- async(): Function;
- inDir(dirPath: string): IRunContext;
+ /**
+ * @param {Object} subject
+ * @param {Object|Array} methods
+ */
+ noImplement(subject: any, methods: any): void;
- /** @param {String|String[]} args */
- withArguments(args: any): IRunContext;
- withGenerators(dependencies: string[]): IRunContext;
- withOptions(options: any): IRunContext;
- withPrompts(answers: any): IRunContext;
- }
+ textEqual(value: string, expected: string): void;
+ }
- /** @type file file-utils */
- var file: any;
- var assert: IAssert;
- var test: ITestHelper;
- module generators {
+ export interface ITestHelper {
+ createDummyGenerator(): IYeomanGenerator;
+ createGenerator(name: string, dependencies: any[], args: any, options: any): IYeomanGenerator;
+ decorate(context: any, method: string, replacement: Function, options: any): void;
+ gruntfile(options: any, done: Function): void;
+ mockPrompt(generator: IYeomanGenerator, answers: any): void;
+ registerDependencies(dependencies: string[]): void;
+ restore(): void;
- export class NamedBase extends YeomanGeneratorBase implements INamedBase {
- constructor(args: string | string[], options: any);
- }
+ /** @param {String|Function} generator */
+ run(generator: any): IRunContext;
+ }
- export class Base extends NamedBase implements IBase {
- static extend(protoProps: IQueueProps, staticProps?: any): IYeomanGenerator;
- }
- }
+ export interface IRunContext {
+ async(): Function;
+ inDir(dirPath: string): IRunContext;
+
+ /** @param {String|String[]} args */
+ withArguments(args: any): IRunContext;
+ withGenerators(dependencies: string[]): IRunContext;
+ withOptions(options: any): IRunContext;
+ withPrompts(answers: any): IRunContext;
+ }
+
+ /** @type file file-utils */
+ var file: any;
+ var assert: IAssert;
+ var test: ITestHelper;
+ module generators {
+
+ export class NamedBase extends YeomanGeneratorBase implements INamedBase {
+ constructor(args: string | string[], options: any);
+ }
+
+ export class Base extends NamedBase implements IBase {
+ static extend(protoProps: IQueueProps, staticProps?: any): IYeomanGenerator;
+ }
+ }
}
declare module "yeoman-generator" {
- export = yo;
+ export = yo;
}