b3d98cba77
The BaseRequestOptions class is responsible for declaring default values, while the RequestOptions class is merely responsible for setting values based on values provided in the constructor.
122 lines
3.2 KiB
TypeScript
122 lines
3.2 KiB
TypeScript
import {ResponseTypes} from './enums';
|
|
import {
|
|
BaseException,
|
|
CONST_EXPR,
|
|
isJsObject,
|
|
isString,
|
|
isPresent,
|
|
Json
|
|
} from 'angular2/src/facade/lang';
|
|
import {Headers} from './headers';
|
|
import {ResponseOptions} from './base_response_options';
|
|
|
|
/**
|
|
* 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').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.
|
|
*/
|
|
export class Response {
|
|
/**
|
|
* 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;
|
|
// TODO: Support ArrayBuffer, JSON, FormData, Blob
|
|
private _body: string | Object;
|
|
constructor(responseOptions: ResponseOptions) {
|
|
this._body = responseOptions.body;
|
|
this.status = responseOptions.status;
|
|
this.statusText = responseOptions.statusText;
|
|
this.headers = responseOptions.headers;
|
|
this.type = responseOptions.type;
|
|
this.url = responseOptions.url;
|
|
}
|
|
|
|
/**
|
|
* Not yet implemented
|
|
*/
|
|
// TODO: Blob return type
|
|
blob(): any { throw new BaseException('"blob()" method not implemented on Response superclass'); }
|
|
|
|
/**
|
|
* Attempts to return body as parsed `JSON` object, or raises an exception.
|
|
*/
|
|
json(): Object {
|
|
var jsonResponse;
|
|
if (isJsObject(this._body)) {
|
|
jsonResponse = this._body;
|
|
} else if (isString(this._body)) {
|
|
jsonResponse = Json.parse(<string>this._body);
|
|
}
|
|
return jsonResponse;
|
|
}
|
|
|
|
/**
|
|
* Returns the body as a string, presuming `toString()` can be called on the response body.
|
|
*/
|
|
text(): string { return this._body.toString(); }
|
|
|
|
/**
|
|
* Not yet implemented
|
|
*/
|
|
// TODO: ArrayBuffer return type
|
|
arrayBuffer(): any {
|
|
throw new BaseException('"arrayBuffer()" method not implemented on Response superclass');
|
|
}
|
|
}
|