mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
The type definition for ng.IPromise.then was, in my opinion, incorrect semantically, and breaking on practical examples in my codebase. An `IPromise`' `then` function takes a callback which is called with the value of the promise once it's fulfilled. This could be a number, a string, some object, an array of strings, anything really. Yet the typing in angular.d.ts specified `then` as taking a `successCallback` of type `(response: PromiseCallbackArg) => any`. The definition of `PromiseCallbackArg` seems very permissive at first glance, as it is defined to be an object with a bunch of fields, all optional. Any object, a number, and a string all type check correctly with such a type, but an array of strings, for example, does not (`cPromise` in the provided list of test). Furthermore, it seems to me that the `PromiseCallbackArg` definition was added specifically to support the response type for promises returned by the Angular `$http` service, the `ng.IHttpPromise`. So instead of having an incorrect type on the `ng.IPromise.then` function, I propose we return it to its generic form, and instead override the type of the inherited `then` function in the `ng.IHttpPromise` interface. This would also warrant renaming `PromiseCallbackArg` to `IHttpPromiseCallbackArg`.
141 lines
4.4 KiB
TypeScript
141 lines
4.4 KiB
TypeScript
/// <reference path="angular.d.ts" />
|
|
|
|
// issue: https://github.com/borisyankov/DefinitelyTyped/issues/369
|
|
https://github.com/witoldsz/angular-http-auth/blob/master/src/angular-http-auth.js
|
|
/**
|
|
* @license HTTP Auth Interceptor Module for AngularJS
|
|
* (c) 2012 Witold Szczerba
|
|
* License: MIT
|
|
*/
|
|
angular.module('http-auth-interceptor', [])
|
|
|
|
.provider('authService', function () {
|
|
/**
|
|
* Holds all the requests which failed due to 401 response,
|
|
* so they can be re-requested in future, once login is completed.
|
|
*/
|
|
var buffer = [];
|
|
|
|
/**
|
|
* Required by HTTP interceptor.
|
|
* Function is attached to provider to be invisible for regular users of this service.
|
|
*/
|
|
this.pushToBuffer = function (config: ng.IRequestConfig, deferred: ng.IDeferred) {
|
|
buffer.push({
|
|
config: config,
|
|
deferred: deferred
|
|
});
|
|
}
|
|
|
|
this.$get = ['$rootScope', '$injector', <any>function ($rootScope: ng.IScope, $injector: ng.auto.IInjectorService) {
|
|
var $http: ng.IHttpService; //initialized later because of circular dependency problem
|
|
function retry(config: ng.IRequestConfig, deferred: ng.IDeferred) {
|
|
$http = $http || $injector.get('$http');
|
|
$http(config).then(function (response) {
|
|
deferred.resolve(response);
|
|
});
|
|
}
|
|
function retryAll() {
|
|
for (var i = 0; i < buffer.length; ++i) {
|
|
retry(buffer[i].config, buffer[i].deferred);
|
|
}
|
|
buffer = [];
|
|
}
|
|
|
|
return {
|
|
loginConfirmed: function () {
|
|
$rootScope.$broadcast('event:auth-loginConfirmed');
|
|
retryAll();
|
|
}
|
|
}
|
|
}]
|
|
})
|
|
|
|
/**
|
|
* $http interceptor.
|
|
* On 401 response - it stores the request and broadcasts 'event:angular-auth-loginRequired'.
|
|
*/
|
|
.config(['$httpProvider', 'authServiceProvider', <any>function ($httpProvider: ng.IHttpProvider, authServiceProvider) {
|
|
|
|
var interceptor = ['$rootScope', '$q', <any>function ($rootScope: ng.IScope, $q: ng.IQService) {
|
|
function success(response: ng.IHttpPromiseCallbackArg) {
|
|
return response;
|
|
}
|
|
|
|
function error(response: ng.IHttpPromiseCallbackArg) {
|
|
if (response.status === 401) {
|
|
var deferred = $q.defer();
|
|
authServiceProvider.pushToBuffer(response.config, deferred);
|
|
$rootScope.$broadcast('event:auth-loginRequired');
|
|
return deferred.promise;
|
|
}
|
|
// otherwise
|
|
return $q.reject(response);
|
|
}
|
|
|
|
return function (promise: ng.IHttpPromise) {
|
|
return promise.then(success, error);
|
|
}
|
|
|
|
}];
|
|
$httpProvider.responseInterceptors.push(interceptor);
|
|
}]);
|
|
|
|
|
|
module HttpAndRegularPromiseTests {
|
|
interface Person {
|
|
firstName: string;
|
|
lastName: string;
|
|
}
|
|
|
|
interface ExpectedResponse extends Person {}
|
|
|
|
interface SomeControllerScope extends ng.IScope {
|
|
person: Person;
|
|
theAnswer: number;
|
|
letters: string[];
|
|
}
|
|
|
|
interface OurApiPromiseCallbackArg extends ng.IHttpPromiseCallbackArg {
|
|
data?: ExpectedResponse;
|
|
}
|
|
|
|
var someController: Function = ($scope: SomeControllerScope, $http: ng.IHttpService, $q: ng.IQService) => {
|
|
$http.get("http://somewhere/some/resource")
|
|
.success((data: ExpectedResponse) => {
|
|
$scope.person = data;
|
|
});
|
|
|
|
$http.get("http://somewhere/some/resource")
|
|
.then((response: ng.IHttpPromiseCallbackArg) => {
|
|
// typing lost, so something like
|
|
// var i: number = response.data
|
|
// would type check
|
|
$scope.person = response.data;
|
|
});
|
|
|
|
$http.get("http://somewhere/some/resource")
|
|
.then((response: OurApiPromiseCallbackArg) => {
|
|
// typing lost, so something like
|
|
// var i: number = response.data
|
|
// would NOT type check
|
|
$scope.person = response.data;
|
|
});
|
|
|
|
var aPromise: ng.IPromise = $q.when({firstName: "Jack", lastName: "Sparrow"});
|
|
aPromise.then((person: Person) => {
|
|
$scope.person = person;
|
|
});
|
|
|
|
var bPromise: ng.IPromise = $q.when(42);
|
|
bPromise.then((answer: number) => {
|
|
$scope.theAnswer = answer;
|
|
});
|
|
|
|
var cPromise: ng.IPromise = $q.when(["a", "b", "c"]);
|
|
cPromise.then((letters: string[]) => {
|
|
$scope.letters = letters;
|
|
});
|
|
}
|
|
}
|