@angular-wave/angular.ts 0.1.1 → 0.1.2

package/types/directive/aria/aria.d.ts

@@ -1,10 +1,4 @@
 /**
- * @ngdoc provider
- * @name $ariaProvider
- *
- *
- * @description
- *
  * Used for configuring the ARIA attributes injected and managed by ngAria.
  *
  * ```js

package/types/directive/class/class.d.ts

@@ -1,10 +1,4 @@
 /**
- * @ngdoc directive
- * @name ngClass
- * @restrict AC
- * @element ANY
- *
- * @description
  * The `ngClass` directive allows you to dynamically set CSS classes on an HTML element by databinding
  * an expression that represents all classes to be added.
  *
@@ -58,11 +52,6 @@ export const ngClassDirective: (string | (($parse: any) => {
     link(scope: any, element: any, attr: any): void;
 }))[];
 /**
- * @ngdoc directive
- * @name ngClassOdd
- * @restrict AC
- *
- * @description
  * The `ngClassOdd` and `ngClassEven` directives work exactly as
  * {@link ng.directive:ngClass ngClass}, except they work in
  * conjunction with `ngRepeat` and take effect only on odd (even) rows.
@@ -87,11 +76,6 @@ export const ngClassOddDirective: (string | (($parse: any) => {
     link(scope: any, element: any, attr: any): void;
 }))[];
 /**
- * @ngdoc directive
- * @name ngClassEven
- * @restrict AC
- *
- * @description
  * The `ngClassOdd` and `ngClassEven` directives work exactly as
  * {@link ng.directive:ngClass ngClass}, except they work in
  * conjunction with `ngRepeat` and take effect only on odd (even) rows.

package/types/directive/form/form.d.ts

@@ -16,10 +16,6 @@ export class FormController {
     $$element: any;
     $$animate: any;
     /**
-     * @ngdoc method
-     * @name form.FormController#$rollbackViewValue
-     *
-     * @description
      * Rollback all form controls pending updates to the `$modelValue`.
      *
      * Updates may be pending by a debounced event or because the input is waiting for a some future
@@ -28,10 +24,6 @@ export class FormController {
      */
     $rollbackViewValue(): void;
     /**
-     * @ngdoc method
-     * @name form.FormController#$commitViewValue
-     *
-     * @description
      * Commit all form controls pending updates to the `$modelValue`.
      *
      * Updates may be pending by a debounced event or because the input is waiting for a some future
@@ -84,10 +76,6 @@ export class FormController {
      */
     $removeControl(control: any): void;
     /**
-     * @ngdoc method
-     * @name form.FormController#$setDirty
-     *
-     * @description
      * Sets the form to a dirty state.
      *
      * This method can be called to add the 'ng-dirty' class and set the form to a dirty
@@ -95,10 +83,6 @@ export class FormController {
      */
     $setDirty(): void;
     /**
-     * @ngdoc method
-     * @name form.FormController#$setPristine
-     *
-     * @description
      * Sets the form to its pristine state.
      *
      * This method sets the form's `$pristine` state to true, the `$dirty` state to false, removes
@@ -112,10 +96,6 @@ export class FormController {
      */
     $setPristine(): void;
     /**
-     * @ngdoc method
-     * @name form.FormController#$setUntouched
-     *
-     * @description
      * Sets the form to its untouched state.
      *
      * This method can be called to remove the 'ng-touched' class and set the form controls to their
@@ -126,10 +106,6 @@ export class FormController {
      */
     $setUntouched(): void;
     /**
-     * @ngdoc method
-     * @name form.FormController#$setSubmitted
-     *
-     * @description
      * Sets the form to its `$submitted` state. This will also set `$submitted` on all child and
      * parent forms of the form.
      */

package/types/directive/model/model.d.ts

@@ -4,10 +4,13 @@ export function ngModelDirective($rootScope: any): {
     controller: typeof NgModelController;
     priority: number;
     compile: (element: any) => {
-        pre: (scope: any, element: any, attr: any, ctrls: any) => void;
-        post: (scope: any, element: any, attr: any, ctrls: any) => void;
+        pre: (scope: any, _element: any, attr: any, ctrls: any) => void;
+        post: (scope: any, element: any, _attr: any, ctrls: any) => void;
     };
 };
+export namespace ngModelDirective {
+    let $inject: string[];
+}
 export const ngModelMinErr: (arg0: string, ...arg1: any[]) => Error;
 /**
  *
@@ -130,10 +133,6 @@ export class NgModelController {
     $setValidity(validationErrorKey: any, state: any): void;
     $$initGetterSetters(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$render
-     *
-     * @description
      * Called when the view needs to be updated. It is expected that the user of the ng-model
      * directive will implement this method.
      *
@@ -151,10 +150,6 @@ export class NgModelController {
      */
     $render(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$isEmpty
-     *
-     * @description
      * This is called when we need to determine if the value of an input is empty.
      *
      * For instance, the required directive does this to work out if the input has data or not.
@@ -171,10 +166,6 @@ export class NgModelController {
     $isEmpty(value: any): boolean;
     $$updateEmptyClasses(value: any): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$setPristine
-     *
-     * @description
      * Sets the control to its pristine state.
      *
      * This method can be called to remove the `ng-dirty` class and set the control to its pristine
@@ -183,10 +174,6 @@ export class NgModelController {
      */
     $setPristine(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$setDirty
-     *
-     * @description
      * Sets the control to its dirty state.
      *
      * This method can be called to remove the `ng-pristine` class and set the control to its dirty
@@ -195,10 +182,6 @@ export class NgModelController {
      */
     $setDirty(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$setUntouched
-     *
-     * @description
      * Sets the control to its untouched state.
      *
      * This method can be called to remove the `ng-touched` class and set the control to its
@@ -208,10 +191,6 @@ export class NgModelController {
      */
     $setUntouched(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$setTouched
-     *
-     * @description
      * Sets the control to its touched state.
      *
      * This method can be called to remove the `ng-untouched` class and set the control to its
@@ -220,10 +199,6 @@ export class NgModelController {
      */
     $setTouched(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$rollbackViewValue
-     *
-     * @description
      * Cancel an update and reset the input element's value to prevent an update to the `$modelValue`,
      * which may be caused by a pending debounced event or because the input is waiting for some
      * future event.
@@ -310,10 +285,6 @@ export class NgModelController {
      */
     $rollbackViewValue(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$validate
-     *
-     * @description
      * Runs each of the registered validators (first synchronous validators and then
      * asynchronous validators).
      * If the validity changes to invalid, the model will be set to `undefined`,
@@ -335,10 +306,6 @@ export class NgModelController {
     $$parseAndValidate(): void;
     $$writeModelToScope(): void;
     /**
-     * @ngdoc method
-     * @name ngModel.NgModelController#$setViewValue
-     *
-     * @description
      * Update the view value.
      *
      * This method should be called when a control wants to change the view value; typically,
@@ -388,11 +355,6 @@ export class NgModelController {
     $setViewValue(value: any, trigger: string): void;
     $$debounceViewValueCommit(trigger: any): void;
     /**
-     * @ngdoc method
-     *
-     * @name ngModel.NgModelController#$overrideModelOptions
-     *
-     * @description
      *
      * Override the current model options settings programmatically.
      *
@@ -418,12 +380,6 @@ export class NgModelController {
      */
     $overrideModelOptions(options: any): void;
     /**
-     * @ngdoc method
-     *
-     * @name  ngModel.NgModelController#$processModelValue
-  
-     * @description
-     *
      * Runs the model -> view pipeline on the current
      * {@link ngModel.NgModelController#$modelValue $modelValue}.
      *

package/types/directive/script/script.d.ts

@@ -1,18 +1,3 @@
-/**
- * @ngdoc directive
- * @name script
- * @restrict E
- *
- * @description
- * Load the content of a `<script>` element into {@link ng.$templateCache `$templateCache`}, so that the
- * template can be used by {@link ng.directive:ngInclude `ngInclude`},
- * {@link ngRoute.directive:ngView `ngView`}, or {@link guide/directive directives}. The type of the
- * `<script>` element must be specified as `text/ng-template`, and a cache name for the template must be
- * assigned through the element's `id`, which can then be used as a directive's `templateUrl`.
- *
- * @param {string} type Must be set to `'text/ng-template'`.
- * @param {string} id Cache name of the template.
- */
 export const scriptDirective: (string | (($templateCache: any) => {
     restrict: string;
     terminal: boolean;

package/types/directive/validators/validators.d.ts

@@ -1,13 +1,9 @@
 /**
- * @ngdoc directive
- * @name ngRequiredf
- * @restrict A
  *
  * @param {String} ngRequired AngularJS expression. If it evaluates to `true`, it sets the
  *                                `required` attribute to the element and adds the `required`
  *                                {@link ngModel.NgModelController#$validators `validator`}.
  *
- * @description
  *
  * ngRequired adds the required {@link ngModel.NgModelController#$validators `validator`} to {@link ngModel `ngModel`}.
  * It is most often used for {@link input `input`} and {@link select `select`} controls, but can also be
@@ -31,10 +27,6 @@ export const requiredDirective: (string | (($parse: any) => {
     link(scope: any, elm: any, attr: any, ctrl: any): void;
 }))[];
 /**
- * @ngdoc directive
- * @name ngPattern
- * @restrict A
- *
  * @param {String|RegExp} ngPattern AngularJS expression that must evaluate to a `RegExp` or a `String`
  *                                      parsable into a `RegExp`, or a `RegExp` literal. See above for
  *                                      more details.
@@ -79,10 +71,6 @@ export const patternDirective: (string | (($parse: any) => {
     compile: (tElm: any, tAttr: any) => (scope: any, elm: any, attr: any, ctrl: any) => void;
 }))[];
 /**
- * @ngdoc directive
- * @name ngMaxlength
- * @restrict A
- *
  * @param {String} ngMaxlength AngularJS expression that must evaluate to a `Number` or `String`
  *                                 parsable into a `Number`. Used as value for the `maxlength`
  *                                 {@link ngModel.NgModelController#$validators validator}.
@@ -118,9 +106,6 @@ export const maxlengthDirective: (string | (($parse: any) => {
     link(scope: any, elm: any, attr: any, ctrl: any): void;
 }))[];
 /**
- * @ngdoc directive
- * @name ngMinlength
- * @restrict A
  *
  * @param {string} ngMinlength AngularJS expression that must evaluate to a `Number` or `String`
  *                                 parsable into a `Number`. Used as value for the `minlength`

package/types/services/browser.d.ts

@@ -77,9 +77,6 @@ export class Browser {
      */
     state: () => object;
     /**
-     * @name $browser#onUrlChange
-     *
-     * @description
      * Register callback function that will be called, when url changes.
      *
      * It's only called when the url is changed from outside of AngularJS:
@@ -111,9 +108,6 @@ export class Browser {
      */
     $$checkUrlChange: () => void;
     /**
-     * @name $browser#baseHref
-     *
-     * @description
      * Returns current <base href>
      * (always relative - without domain)
      *
@@ -121,13 +115,11 @@ export class Browser {
      */
     baseHref: () => string;
     /**
-     * @name $browser#defer
      * @param {function():any} fn A function, who's execution should be deferred.
      * @param {number=} [delay=0] Number of milliseconds to defer the function execution.
      * @param {string=} [taskType=DEFAULT_TASK_TYPE] The type of task that is deferred.
      * @returns {number} DeferId that can be used to cancel the task via `$browser.cancel()`.
      *
-     * @description
      * Executes a fn asynchronously via `setTimeout(fn, delay)`.
      *
      * Unlike when calling `setTimeout` directly, in test this function is mocked and instead of using

package/types/services/cache-factory.d.ts

@@ -3,20 +3,12 @@ export class CacheFactoryProvider {
     $get: () => {
         (cacheId: string, options?: object | undefined): object;
         /**
-         * @ngdoc method
-         * @name $cacheFactory#info
-         *
-         * @description
          * Get information about all the caches that have been created
          *
          * @returns {Object} - key-value map of `cacheId` to the result of calling `cache#info`
          */
         info(): any;
         /**
-         * @ngdoc method
-         * @name $cacheFactory#get
-         *
-         * @description
          * Get access to a cache object by the `cacheId` used when it was created.
          *
          * @param {string} cacheId Name or id of a cache to access.

package/types/services/http/http.d.ts

@@ -59,11 +59,6 @@ export class $HttpParamSerializerJQLikeProvider {
 }
 export function defaultHttpResponseTransform(data: any, headers: any): any;
 /**
- * @ngdoc provider
- * @name $httpProvider
- *
- *
- * @description
  * Use `$httpProvider` to change the default behavior of the {@link ng.$http $http} service.
  */
 export function $HttpProvider(): void;
@@ -84,10 +79,6 @@ export class $HttpProvider {
         paramSerializer: string;
     };
     /**
-     * @ngdoc method
-     * @name $httpProvider#useApplyAsync
-     * @description
-     *
      * Configure $http service to combine processing of multiple http responses received at around
      * the same time via {@link ng.$rootScope.Scope#$applyAsync $rootScope.$applyAsync}. This can result in
      * significant performance improvement for bigger applications that make many HTTP requests
@@ -109,10 +100,6 @@ export class $HttpProvider {
         (requestConfig: any): any;
         pendingRequests: any[];
         /**
-         * @ngdoc property
-         * @name $http#defaults
-         *
-         * @description
          * Runtime equivalent of the `$httpProvider.defaults` property. Allows configuration of
          * default headers, withCredentials as well as request and response transformations.
          *

package/types/services/http-backend/http-backend.d.ts

@@ -1,8 +1,4 @@
 /**
-
- *
- *
- * @description
  * HTTP backend used by the {@link ng.$http service} that delegates to
  * XMLHttpRequest object and deals with browser incompatibilities.
  *

package/types/services/log.d.ts

@@ -1,8 +1,30 @@
+export type LogService = {
+    /**
+     * - Log a debug messages
+     */
+    debug: LogCall;
+    /**
+     * - Log a error message
+     */
+    error: LogCall;
+    /**
+     * - Log a info message
+     */
+    info: LogCall;
+    /**
+     * - Log a general message
+     */
+    log: LogCall;
+    /**
+     * - Log a warning message
+     */
+    warn: LogCall;
+};
 /**
  * @typedef {(...args: any[]) => void} LogCall
  */
 /**
- * @typedef {Object} angular.LogService
+ * @typedef {Object} LogService
  * @property {LogCall} debug - Log a debug messages
  * @property {LogCall} error - Log a error message
  * @property {LogCall} info - Log a info message
@@ -10,57 +32,28 @@
  * @property {LogCall} warn - Log a warning message
  */
 /**
- * @type {angular.LogService}
+ * @type {LogService}
  */
-export let LogService: angular.LogService;
+export let LogService: LogService;
 /**
- * @typedef {import('../types').ServiceProvider} angular.LogProvider
+ * @typedef {import('../types').ServiceProvider} LogProvider
  * @property {function(): boolean} debugEnabled - Function to get the current debug state.
  * @property {function(boolean): angular.LogProvider} debugEnabled - Function to enable or disable debug.
  */
 /**
- * @name $logProvider
- * @type {angular.LogProvider}
- *
- * @description
+ * @type {LogProvider}
  * Use the `$logProvider` to configure how the application logs messages
  */
 export class $LogProvider {
     debug: boolean;
     /**
-     * @name $logProvider#debugEnabled
-     * @description
      * @param {boolean=} flag enable or disable debug level messages
      * @returns {*} current value if used as getter or itself (chaining) if used as setter
      */
     debugEnabled(flag?: boolean | undefined): any;
     formatError(arg: any): any;
     consoleLog(type: any): (...args: any[]) => any;
-    $get(): angular.LogService;
+    $get(): LogService;
 }
 export type LogCall = (...args: any[]) => void;
-export namespace angular {
-    type LogService = {
-        /**
-         * - Log a debug messages
-         */
-        debug: LogCall;
-        /**
-         * - Log a error message
-         */
-        error: LogCall;
-        /**
-         * - Log a info message
-         */
-        info: LogCall;
-        /**
-         * - Log a general message
-         */
-        log: LogCall;
-        /**
-         * - Log a warning message
-         */
-        warn: LogCall;
-    };
-    type LogProvider = import("../types").ServiceProvider;
-}
+export type LogProvider = import("../types").ServiceProvider;

package/types/types.d.ts

@@ -6,10 +6,77 @@ export type Annotated = {
 export type AnnotatedFunction = Function & Annotated & Array<any>;
 export type ComponentOptions = any;
 export type ControllerConstructor = Function;
-export type OnChangesObject = any;
-export type ChangesObject = any;
+/**
+ * Object representing changes in one-way bound properties.
+ * Keys are the names of the bound properties that have changed, and values are instances of IChangesObject.
+ */
+export type OnChangesObject = {
+    /**
+     * - Represents a changed property.
+     */
+    property: ChangesObject;
+};
+/**
+ * Object representing changes in a property.
+ */
+export type ChangesObject = {
+    /**
+     * - Current value of the property.
+     */
+    currentValue: any;
+    /**
+     * - Previous value of the property.
+     */
+    previousValue: any;
+    /**
+     * - Function to check if it's the first change of the property.
+     */
+    isFirstChange: () => boolean;
+};
+/**
+ * Interface representing the lifecycle hooks for AngularJS directive controllers.
+ */
 export type Controller = {
+    /**
+     * *
+     */
     name: string;
+    /**
+     * Called on each controller after all the controllers on an element have been constructed and had their bindings
+     * initialized (and before the pre & post linking functions for the directives on this element). This is a good
+     * place to put initialization code for your controller.
+     */
+    $onInit?: () => void;
+    /**
+     * Called on each turn of the digest cycle. Provides an opportunity to detect and act on changes.
+     * Any actions that you wish to take in response to the changes that you detect must be invoked from this hook;
+     * implementing this has no effect on when `$onChanges` is called. For example, this hook could be useful if you wish
+     * to perform a deep equality check, or to check a `Date` object, changes to which would not be detected by Angular's
+     * change detector and thus not trigger `$onChanges`. This hook is invoked with no arguments; if detecting changes,
+     * you must store the previous value(s) for comparison to the current values.
+     */
+    $doCheck?: () => void;
+    /**
+     * Called whenever one-way bindings are updated. The onChangesObj is a hash whose keys are the names of the bound
+     * properties that have changed, and the values are an {@link IChangesObject} object  of the form
+     * { currentValue, previousValue, isFirstChange() }. Use this hook to trigger updates within a component such as
+     * cloning the bound value to prevent accidental mutation of the outer value.
+     */
+    $onChanges?: (arg0: OnChangesObject) => void;
+    /**
+     * Called on a controller when its containing scope is destroyed. Use this hook for releasing external resources,
+     * watches and event handlers.
+     */
+    $onDestroy?: () => void;
+    /**
+     * Called after this controller's element and its children have been linked. Similar to the post-link function this
+     * hook can be used to set up DOM event handlers and do direct DOM manipulation. Note that child elements that contain
+     * templateUrl directives will not have been compiled and linked since they are waiting for their template to load
+     * asynchronously and their own compilation and linking has been suspended until that occurs. This hook can be considered
+     * analogous to the ngAfterViewInit and ngAfterContentInit hooks in Angular 2. Since the compilation process is rather
+     * different in Angular 1 there is no direct mapping and care should be taken when upgrading.
+     */
+    $postLink?: () => void;
 };
 export type Attributes = {
     [x: string]: any;
@@ -163,7 +230,67 @@ export type ServiceProviderFactory = Function;
  * Interface for a service provider.
  */
 export type ServiceProvider = any | Function;
-export type Module = any;
+/**
+ * AngularJS module interface for registering components, services, providers, etc.
+ */
+export type Module = {
+    /**
+     *   Use this method to register a component.
+     */
+    component: (arg0: string, arg1: ComponentOptions) => Module;
+    /**
+     *   Use this method to register work which needs to be performed on module loading.
+     */
+    config: (arg0: Function) => Module;
+    /**
+     *   Register a constant service with the $injector.
+     */
+    constant: (arg0: string, arg1: any) => Module;
+    /**
+     *   Register a controller with the $controller service.
+     */
+    controller: (arg0: string, arg1: Injectable<ControllerConstructor>) => Module;
+    /**
+     *   Register a directive with the compiler.
+     */
+    directive: (arg0: string, arg1: Injectable<DirectiveFactory>) => Module;
+    /**
+     *   Register a service factory with the $injector.
+     */
+    factory: (arg0: string, arg1: Injectable<Function>) => Module;
+    /**
+     *   Register a filter service.
+     */
+    filter: (arg0: string, arg1: Injectable<FilterFactory>) => Module;
+    /**
+     *   Register a provider service factory.
+     */
+    provider: (arg0: string, arg1: ServiceProviderFactory) => Module;
+    /**
+     *   Register code to be run during module loading.
+     */
+    run: (arg0: Injectable<Function>) => Module;
+    /**
+     *   Register a service constructor.
+     */
+    service: (arg0: string, arg1: Injectable<Function>) => Module;
+    /**
+     *   Register a value service with the $injector.
+     */
+    value: (arg0: string, arg1: any) => Module;
+    /**
+     *   Register a service decorator with the $injector.
+     */
+    decorator: (arg0: string, arg1: Injectable<Function>) => Module;
+    /**
+     *   The name of the AngularJS module.
+     */
+    name: string;
+    /**
+     *   Array of module names that this module depends on.
+     */
+    requires: string[];
+};
 export type FormController = {
     /**
      * - True if the form has not been modified.