Files
angular-docs-cn/modules/@angular/http/src/interfaces.ts
T

59 lines
1.7 KiB
TypeScript
Raw Normal View History

2015-12-03 22:44:14 +01:00
import {ReadyState, RequestMethod, ResponseType} from './enums';
2015-04-28 23:07:55 -07:00
import {Headers} from './headers';
import {Request} from './static_request';
2015-09-25 13:23:05 +03:00
import {URLSearchParams} from './url_search_params';
/**
* 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}.
*/
export abstract class ConnectionBackend { abstract createConnection(request: any): Connection; }
/**
* Abstract class from which real connections are derived.
*/
export abstract class Connection {
2015-12-03 22:44:14 +01:00
readyState: ReadyState;
request: Request;
2015-10-01 16:04:20 -07:00
response: any; // TODO: generic of <Response>;
}
2015-04-28 23:07:55 -07:00
2016-05-27 20:15:40 -07:00
/** An XSRFStrategy configures XSRF protection (e.g. via headers) on an HTTP request. */
export abstract class XSRFStrategy {
abstract configureRequest(req: Request): void;
}
/**
* Interface for options to construct a RequestOptions, based on
* [RequestInit](https://fetch.spec.whatwg.org/#requestinit) from the Fetch spec.
*/
export interface RequestOptionsArgs {
url?: string;
method?: string | RequestMethod;
search?: string | URLSearchParams;
2015-04-28 23:07:55 -07:00
headers?: Headers;
body?: any;
2016-02-24 22:57:35 +01:00
withCredentials?: boolean;
2015-04-28 23:07:55 -07:00
}
/**
* Required structure when constructing new Request();
*/
export interface RequestArgs extends RequestOptionsArgs { url: string; }
/**
* Interface for options to construct a Response, based on
* [ResponseInit](https://fetch.spec.whatwg.org/#responseinit) from the Fetch spec.
*/
2015-09-06 22:14:19 -07:00
export type ResponseOptionsArgs = {
// TODO: Support Blob, ArrayBuffer, JSON
body?: string | Object | FormData;
status?: number;
statusText?: string;
headers?: Headers;
2015-12-03 22:44:14 +01:00
type?: ResponseType;
2015-04-28 23:07:55 -07:00
url?: string;
}