X Tutup
Skip to content

Commit b925ff5

Browse files
cexbrayatcexbrayat
committed
refactor(http): rename enums to be singular
ReadyStates -> ReadyState RequestMethods -> RequestMethod ResponseTypes -> ResponseType Fixes angular#5574 BREAKING CHANGE: Before import {ReadyStates, RequestMethods, ResponseTypes} from 'angular2/http'; After import {ReadyState, RequestMethod, ResponseType} from 'angular2/http'; Closes angular#5584
1 parent 654496b commit b925ff5

17 files changed

+100
-100
lines changed

‎modules/angular2/http.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export {Http, Jsonp} from './src/http/http';
3232

3333
export {Headers} from './src/http/headers';
3434

35-
export {ResponseTypes, ReadyStates, RequestMethods} from './src/http/enums';
35+
export {ResponseType, ReadyState, RequestMethod} from './src/http/enums';
3636
export {URLSearchParams} from './src/http/url_search_params';
3737

3838
/**

‎modules/angular2/src/http/backends/jsonp_backend.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import {ConnectionBackend, Connection} from '../interfaces';
2-
import {ReadyStates, RequestMethods, ResponseTypes} from '../enums';
2+
import {ReadyState, RequestMethod, ResponseType} from '../enums';
33
import {Request} from '../static_request';
44
import {Response} from '../static_response';
55
import {ResponseOptions, BaseResponseOptions} from '../base_response_options';
@@ -13,7 +13,7 @@ const JSONP_ERR_NO_CALLBACK = 'JSONP injected script did not invoke callback.';
1313
const JSONP_ERR_WRONG_METHOD = 'JSONP requests must use GET request method.';
1414

1515
export abstract class JSONPConnection implements Connection {
16-
readyState: ReadyStates;
16+
readyState: ReadyState;
1717
request: Request;
1818
response: Observable<Response>;
1919
abstract finished(data?: any): void;
@@ -28,13 +28,13 @@ export class JSONPConnection_ extends JSONPConnection {
2828
constructor(req: Request, private _dom: BrowserJsonp,
2929
private baseResponseOptions?: ResponseOptions) {
3030
super();
31-
if (req.method !== RequestMethods.Get) {
31+
if (req.method !== RequestMethod.Get) {
3232
throw makeTypeError(JSONP_ERR_WRONG_METHOD);
3333
}
3434
this.request = req;
3535
this.response = new Observable(responseObserver => {
3636

37-
this.readyState = ReadyStates.Loading;
37+
this.readyState = ReadyState.Loading;
3838
let id = this._id = _dom.nextRequestID();
3939

4040
_dom.exposeConnection(id, this);
@@ -52,12 +52,12 @@ export class JSONPConnection_ extends JSONPConnection {
5252
let script = this._script = _dom.build(url);
5353

5454
let onLoad = event => {
55-
if (this.readyState === ReadyStates.Cancelled) return;
56-
this.readyState = ReadyStates.Done;
55+
if (this.readyState === ReadyState.Cancelled) return;
56+
this.readyState = ReadyState.Done;
5757
_dom.cleanup(script);
5858
if (!this._finished) {
5959
let responseOptions =
60-
new ResponseOptions({body: JSONP_ERR_NO_CALLBACK, type: ResponseTypes.Error, url});
60+
new ResponseOptions({body: JSONP_ERR_NO_CALLBACK, type: ResponseType.Error, url});
6161
if (isPresent(baseResponseOptions)) {
6262
responseOptions = baseResponseOptions.merge(responseOptions);
6363
}
@@ -75,10 +75,10 @@ export class JSONPConnection_ extends JSONPConnection {
7575
};
7676

7777
let onError = error => {
78-
if (this.readyState === ReadyStates.Cancelled) return;
79-
this.readyState = ReadyStates.Done;
78+
if (this.readyState === ReadyState.Cancelled) return;
79+
this.readyState = ReadyState.Done;
8080
_dom.cleanup(script);
81-
let responseOptions = new ResponseOptions({body: error.message, type: ResponseTypes.Error});
81+
let responseOptions = new ResponseOptions({body: error.message, type: ResponseType.Error});
8282
if (isPresent(baseResponseOptions)) {
8383
responseOptions = baseResponseOptions.merge(responseOptions);
8484
}
@@ -91,7 +91,7 @@ export class JSONPConnection_ extends JSONPConnection {
9191
_dom.send(script);
9292

9393
return () => {
94-
this.readyState = ReadyStates.Cancelled;
94+
this.readyState = ReadyState.Cancelled;
9595
script.removeEventListener('load', onLoad);
9696
script.removeEventListener('error', onError);
9797
if (isPresent(script)) {
@@ -106,7 +106,7 @@ export class JSONPConnection_ extends JSONPConnection {
106106
// Don't leak connections
107107
this._finished = true;
108108
this._dom.removeConnection(this._id);
109-
if (this.readyState === ReadyStates.Cancelled) return;
109+
if (this.readyState === ReadyState.Cancelled) return;
110110
this._responseData = data;
111111
}
112112
}

‎modules/angular2/src/http/backends/mock_backend.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import {Injectable} from 'angular2/core';
22
import {Request} from '../static_request';
33
import {Response} from '../static_response';
4-
import {ReadyStates} from '../enums';
4+
import {ReadyState} from '../enums';
55
import {Connection, ConnectionBackend} from '../interfaces';
66
import {isPresent} from 'angular2/src/facade/lang';
77
import {BaseException, WrappedException} from 'angular2/src/facade/exceptions';
@@ -21,7 +21,7 @@ export class MockConnection implements Connection {
2121
* Describes the state of the connection, based on `XMLHttpRequest.readyState`, but with
2222
* additional states. For example, state 5 indicates an aborted connection.
2323
*/
24-
readyState: ReadyStates;
24+
readyState: ReadyState;
2525

2626
/**
2727
* {@link Request} instance used to create the connection.
@@ -36,7 +36,7 @@ export class MockConnection implements Connection {
3636

3737
constructor(req: Request) {
3838
this.response = new ReplaySubject(1).take(1);
39-
this.readyState = ReadyStates.Open;
39+
this.readyState = ReadyState.Open;
4040
this.request = req;
4141
}
4242

@@ -55,10 +55,10 @@ export class MockConnection implements Connection {
5555
*
5656
*/
5757
mockRespond(res: Response) {
58-
if (this.readyState === ReadyStates.Done || this.readyState === ReadyStates.Cancelled) {
58+
if (this.readyState === ReadyState.Done || this.readyState === ReadyState.Cancelled) {
5959
throw new BaseException('Connection has already been resolved');
6060
}
61-
this.readyState = ReadyStates.Done;
61+
this.readyState = ReadyState.Done;
6262
this.response.next(res);
6363
this.response.complete();
6464
}
@@ -84,7 +84,7 @@ export class MockConnection implements Connection {
8484
*/
8585
mockError(err?: Error) {
8686
// Matches XHR semantics
87-
this.readyState = ReadyStates.Done;
87+
this.readyState = ReadyState.Done;
8888
this.response.error(err);
8989
}
9090
}

‎modules/angular2/src/http/backends/xhr_backend.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import {ConnectionBackend, Connection} from '../interfaces';
2-
import {ReadyStates, RequestMethods, ResponseTypes} from '../enums';
2+
import {ReadyState, RequestMethod, ResponseType} from '../enums';
33
import {Request} from '../static_request';
44
import {Response} from '../static_response';
55
import {Headers} from '../headers';
@@ -24,12 +24,12 @@ export class XHRConnection implements Connection {
2424
* `XMLHttpRequest`.
2525
*/
2626
response: Observable<Response>;
27-
readyState: ReadyStates;
27+
readyState: ReadyState;
2828
constructor(req: Request, browserXHR: BrowserXhr, baseResponseOptions?: ResponseOptions) {
2929
this.request = req;
3030
this.response = new Observable(responseObserver => {
3131
let _xhr: XMLHttpRequest = browserXHR.build();
32-
_xhr.open(RequestMethods[req.method].toUpperCase(), req.url);
32+
_xhr.open(RequestMethod[req.method].toUpperCase(), req.url);
3333
// load event handler
3434
let onLoad = () => {
3535
// responseText is the old-school way of retrieving response (supported by IE8 & 9)
@@ -65,7 +65,7 @@ export class XHRConnection implements Connection {
6565
};
6666
// error event handler
6767
let onError = (err) => {
68-
var responseOptions = new ResponseOptions({body: err, type: ResponseTypes.Error});
68+
var responseOptions = new ResponseOptions({body: err, type: ResponseType.Error});
6969
if (isPresent(baseResponseOptions)) {
7070
responseOptions = baseResponseOptions.merge(responseOptions);
7171
}

‎modules/angular2/src/http/base_request_options.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import {isPresent, isString} from 'angular2/src/facade/lang';
22
import {Headers} from './headers';
3-
import {RequestMethods} from './enums';
3+
import {RequestMethod} from './enums';
44
import {RequestOptionsArgs} from './interfaces';
55
import {Injectable} from 'angular2/core';
66
import {URLSearchParams} from './url_search_params';
@@ -19,23 +19,23 @@ import {normalizeMethodName} from './http_utils';
1919
* ### Example ([live demo](http://plnkr.co/edit/7Wvi3lfLq41aQPKlxB4O?p=preview))
2020
*
2121
* ```typescript
22-
* import {RequestOptions, Request, RequestMethods} from 'angular2/http';
22+
* import {RequestOptions, Request, RequestMethod} from 'angular2/http';
2323
*
2424
* var options = new RequestOptions({
25-
* method: RequestMethods.Post,
25+
* method: RequestMethod.Post,
2626
* url: 'https://google.com'
2727
* });
2828
* var req = new Request(options);
29-
* console.log('req.method:', RequestMethods[req.method]); // Post
29+
* console.log('req.method:', RequestMethod[req.method]); // Post
3030
* console.log('options.url:', options.url); // https://google.com
3131
* ```
3232
*/
3333
export class RequestOptions {
3434
/**
3535
* Http method with which to execute a {@link Request}.
36-
* Acceptable methods are defined in the {@link RequestMethods} enum.
36+
* Acceptable methods are defined in the {@link RequestMethod} enum.
3737
*/
38-
method: RequestMethods | string;
38+
method: RequestMethod | string;
3939
/**
4040
* {@link Headers} to be attached to a {@link Request}.
4141
*/
@@ -75,15 +75,15 @@ export class RequestOptions {
7575
* ### Example ([live demo](http://plnkr.co/edit/6w8XA8YTkDRcPYpdB9dk?p=preview))
7676
*
7777
* ```typescript
78-
* import {RequestOptions, Request, RequestMethods} from 'angular2/http';
78+
* import {RequestOptions, Request, RequestMethod} from 'angular2/http';
7979
*
8080
* var options = new RequestOptions({
81-
* method: RequestMethods.Post
81+
* method: RequestMethod.Post
8282
* });
8383
* var req = new Request(options.merge({
8484
* url: 'https://google.com'
8585
* }));
86-
* console.log('req.method:', RequestMethods[req.method]); // Post
86+
* console.log('req.method:', RequestMethod[req.method]); // Post
8787
* console.log('options.url:', options.url); // null
8888
* console.log('req.url:', req.url); // https://google.com
8989
* ```
@@ -107,7 +107,7 @@ export class RequestOptions {
107107
* Subclass of {@link RequestOptions}, with default values.
108108
*
109109
* Default values:
110-
* * method: {@link RequestMethods RequestMethods.Get}
110+
* * method: {@link RequestMethod RequestMethod.Get}
111111
* * headers: empty {@link Headers} object
112112
*
113113
* This class could be extended and bound to the {@link RequestOptions} class
@@ -134,19 +134,19 @@ export class RequestOptions {
134134
* ### Example ([live demo](http://plnkr.co/edit/oyBoEvNtDhOSfi9YxaVb?p=preview))
135135
*
136136
* ```
137-
* import {BaseRequestOptions, Request, RequestMethods} from 'angular2/http';
137+
* import {BaseRequestOptions, Request, RequestMethod} from 'angular2/http';
138138
*
139139
* var options = new BaseRequestOptions();
140140
* var req = new Request(options.merge({
141-
* method: RequestMethods.Post,
141+
* method: RequestMethod.Post,
142142
* url: 'https://google.com'
143143
* }));
144-
* console.log('req.method:', RequestMethods[req.method]); // Post
144+
* console.log('req.method:', RequestMethod[req.method]); // Post
145145
* console.log('options.url:', options.url); // null
146146
* console.log('req.url:', req.url); // https://google.com
147147
* ```
148148
*/
149149
@Injectable()
150150
export class BaseRequestOptions extends RequestOptions {
151-
constructor() { super({method: RequestMethods.Get, headers: new Headers()}); }
151+
constructor() { super({method: RequestMethod.Get, headers: new Headers()}); }
152152
}

‎modules/angular2/src/http/base_response_options.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import {Injectable} from 'angular2/core';
22
import {isPresent, isJsObject} from 'angular2/src/facade/lang';
33
import {Headers} from './headers';
4-
import {ResponseTypes} from './enums';
4+
import {ResponseType} from './enums';
55
import {ResponseOptionsArgs} from './interfaces';
66

77
/**
@@ -52,7 +52,7 @@ export class ResponseOptions {
5252
/**
5353
* @internal
5454
*/
55-
type: ResponseTypes;
55+
type: ResponseType;
5656
url: string;
5757
constructor({body, status, headers, statusText, type, url}: ResponseOptionsArgs = {}) {
5858
this.body = isPresent(body) ? body : null;
@@ -147,6 +147,6 @@ export class ResponseOptions {
147147
@Injectable()
148148
export class BaseResponseOptions extends ResponseOptions {
149149
constructor() {
150-
super({status: 200, statusText: 'Ok', type: ResponseTypes.Default, headers: new Headers()});
150+
super({status: 200, statusText: 'Ok', type: ResponseType.Default, headers: new Headers()});
151151
}
152152
}

‎modules/angular2/src/http/enums.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import {StringMapWrapper} from 'angular2/src/facade/collection';
33
/**
44
* Supported http methods.
55
*/
6-
export enum RequestMethods {
6+
export enum RequestMethod {
77
Get,
88
Post,
99
Put,
@@ -18,7 +18,7 @@ export enum RequestMethods {
1818
* [States](http://www.w3.org/TR/XMLHttpRequest/#states) from the `XMLHttpRequest` spec, but with an
1919
* additional "CANCELLED" state.
2020
*/
21-
export enum ReadyStates {
21+
export enum ReadyState {
2222
Unsent,
2323
Open,
2424
HeadersReceived,
@@ -31,7 +31,7 @@ export enum ReadyStates {
3131
* Acceptable response types to be associated with a {@link Response}, based on
3232
* [ResponseType](https://fetch.spec.whatwg.org/#responsetype) from the Fetch spec.
3333
*/
34-
export enum ResponseTypes {
34+
export enum ResponseType {
3535
Basic,
3636
Cors,
3737
Default,

‎modules/angular2/src/http/http.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {RequestOptionsArgs, Connection, ConnectionBackend} from './interfaces';
55
import {Request} from './static_request';
66
import {Response} from './static_response';
77
import {BaseRequestOptions, RequestOptions} from './base_request_options';
8-
import {RequestMethods} from './enums';
8+
import {RequestMethod} from './enums';
99
import {Observable} from 'angular2/core';
1010

1111
function httpRequest(backend: ConnectionBackend, request: Request): Observable<Response> {
@@ -103,7 +103,7 @@ export class Http {
103103
if (isString(url)) {
104104
responseObservable = httpRequest(
105105
this._backend,
106-
new Request(mergeOptions(this._defaultOptions, options, RequestMethods.Get, url)));
106+
new Request(mergeOptions(this._defaultOptions, options, RequestMethod.Get, url)));
107107
} else if (url instanceof Request) {
108108
responseObservable = httpRequest(this._backend, url);
109109
} else {
@@ -117,7 +117,7 @@ export class Http {
117117
*/
118118
get(url: string, options?: RequestOptionsArgs): Observable<Response> {
119119
return httpRequest(this._backend, new Request(mergeOptions(this._defaultOptions, options,
120-
RequestMethods.Get, url)));
120+
RequestMethod.Get, url)));
121121
}
122122

123123
/**
@@ -127,7 +127,7 @@ export class Http {
127127
return httpRequest(
128128
this._backend,
129129
new Request(mergeOptions(this._defaultOptions.merge(new RequestOptions({body: body})),
130-
options, RequestMethods.Post, url)));
130+
options, RequestMethod.Post, url)));
131131
}
132132

133133
/**
@@ -137,15 +137,15 @@ export class Http {
137137
return httpRequest(
138138
this._backend,
139139
new Request(mergeOptions(this._defaultOptions.merge(new RequestOptions({body: body})),
140-
options, RequestMethods.Put, url)));
140+
options, RequestMethod.Put, url)));
141141
}
142142

143143
/**
144144
* Performs a request with `delete` http method.
145145
*/
146146
delete (url: string, options?: RequestOptionsArgs): Observable<Response> {
147147
return httpRequest(this._backend, new Request(mergeOptions(this._defaultOptions, options,
148-
RequestMethods.Delete, url)));
148+
RequestMethod.Delete, url)));
149149
}
150150

151151
/**
@@ -155,15 +155,15 @@ export class Http {
155155
return httpRequest(
156156
this._backend,
157157
new Request(mergeOptions(this._defaultOptions.merge(new RequestOptions({body: body})),
158-
options, RequestMethods.Patch, url)));
158+
options, RequestMethod.Patch, url)));
159159
}
160160

161161
/**
162162
* Performs a request with `head` http method.
163163
*/
164164
head(url: string, options?: RequestOptionsArgs): Observable<Response> {
165165
return httpRequest(this._backend, new Request(mergeOptions(this._defaultOptions, options,
166-
RequestMethods.Head, url)));
166+
RequestMethod.Head, url)));
167167
}
168168
}
169169

@@ -182,10 +182,10 @@ export class Jsonp extends Http {
182182
request(url: string | Request, options?: RequestOptionsArgs): Observable<Response> {
183183
var responseObservable: any;
184184
if (isString(url)) {
185-
url = new Request(mergeOptions(this._defaultOptions, options, RequestMethods.Get, url));
185+
url = new Request(mergeOptions(this._defaultOptions, options, RequestMethod.Get, url));
186186
}
187187
if (url instanceof Request) {
188-
if (url.method !== RequestMethods.Get) {
188+
if (url.method !== RequestMethod.Get) {
189189
makeTypeError('JSONP requests must use GET request method.');
190190
}
191191
responseObservable = httpRequest(this._backend, url);

0 commit comments

Comments
 (0)
X Tutup