terribleplan/Typertext
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Document GenericRequest

Browse source
This commit is contained in:
Kegan Myers 2014-02-28 10:32:43 -06:00
parent cb0d8861ae
commit a8d7020bee
1 changed files with 38 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
lib/Typertext/GenericRequest.ts
View file

@ -1,16 +1,53 @@
//TODO comment everything
/**
* @module Typertext
* @submodule Http
* @submodule Json
*/
module Typertext {
import HttpMethod = Typertext.Http.HttpMethod;
import HttpPostData = Typertext.Http.HttpPostData;
import HttpResponseHandler = Typertext.Http.HttpResponseHandler;
import HttpUrl = Typertext.Http.HttpUrl;
/**
* A class to simplify passing both the status and data of a completed proxy request
*
* @interface GenericRequest
* @uses Typertext.Http.HttpMethod
* @uses Typertext.Http.HttpPostData
* @uses Typertext.Http.HttpUrl
*
* @author Kegan Myers <kegan@keganmyers.com>
* @version 0.2.1
*/
export interface GenericRequest<T extends GenericResponseHandler<GenericResponse<any>>> {
/**
* A convenience method which will simply use the RawRequest method with a GET
*
* @param {HttpUrl} request
* @param {GenericResponseHandler} callback
*/
Get(request:HttpUrl, callback:T):void;
/**
* A convenience method which will simply use the RawRequest method with a GET
*
* @param {HttpUrl} request
* @param {HttpPostData} postData
* @param {GenericResponseHandler} callback
*/
Post(request:HttpUrl, postData:HttpPostData, callback:T):void;
/**
* A method which calls the server and passes returned data to an optionally specified callback
*
* @param {HttpMethid} method
* @param {HttpUrl} request
* @param {HttpPostData} postData
* @param {GenericResponseHandler} callback
*/
RawRequest(method:HttpMethod, request:HttpUrl, postData?:HttpPostData, callback?:T):void;
}
}