Documentataion cleanup
This commit is contained in:
parent
3f6d28e0ee
commit
b00cf9e4bd
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
|
/**
|
||||||
|
* @class HttpException
|
||||||
|
*/
|
||||||
export class HttpException extends Typertext.BaseException<HttpResponseStatus> {
|
export class HttpException extends Typertext.BaseException<HttpResponseStatus> {
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
|
/**
|
||||||
|
* @interface HttpHeaderData
|
||||||
|
*/
|
||||||
export interface HttpHeaderData {
|
export interface HttpHeaderData {
|
||||||
[index:string]:string
|
[index:string]:string
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
|
/**
|
||||||
|
* TODO figure out the proper annotations for enums
|
||||||
|
*/
|
||||||
export enum HttpMethod {
|
export enum HttpMethod {
|
||||||
GET,
|
GET,
|
||||||
POST
|
POST
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
|
/**
|
||||||
|
* @interface HttpPostData
|
||||||
|
*/
|
||||||
export interface HttpPostData {
|
export interface HttpPostData {
|
||||||
[index:string]:string
|
[index:string]:string
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
export enum HttpProtocol {
|
export enum HttpProtocol {
|
||||||
http,
|
http,
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
|
/**
|
||||||
|
* @interface HttpQueryString
|
||||||
|
*/
|
||||||
export interface HttpQueryString {
|
export interface HttpQueryString {
|
||||||
[index:string]:string
|
[index:string]:string
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
|
/**
|
||||||
|
* @interface HttpResponseHandler
|
||||||
|
*/
|
||||||
export interface HttpResponseHandler extends Typertext.GenericResponseHandler<HttpResponse> {
|
export interface HttpResponseHandler extends Typertext.GenericResponseHandler<HttpResponse> {
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,3 +1,7 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Http
|
||||||
|
*/
|
||||||
module Typertext.Http {
|
module Typertext.Http {
|
||||||
export enum HttpResponseStatus {
|
export enum HttpResponseStatus {
|
||||||
success,
|
success,
|
||||||
|
|
|
@ -13,14 +13,9 @@ module Typertext.Http {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A common interface for building a URL into something that can easily be decomposed for a client
|
|
||||||
*
|
*
|
||||||
* @param protocol
|
* @param protocol
|
||||||
* @returns {number}
|
* @returns {number}
|
||||||
*
|
|
||||||
* @author Kegan Myers <kegan@keganmyers.com>
|
|
||||||
* @version 0.3.0
|
|
||||||
* @constructor
|
|
||||||
*/
|
*/
|
||||||
public static DefaultPort(protocol:HttpProtocol) {
|
public static DefaultPort(protocol:HttpProtocol) {
|
||||||
return ((protocol == HttpProtocol.http) ? 80 : 443)
|
return ((protocol == HttpProtocol.http) ? 80 : 443)
|
||||||
|
@ -122,6 +117,7 @@ module Typertext.Http {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* A common interface for building a URL into something that can easily be decomposed for a client
|
||||||
*
|
*
|
||||||
* @param {string} domain
|
* @param {string} domain
|
||||||
* @param {HttpProtocol} protocol
|
* @param {HttpProtocol} protocol
|
||||||
|
@ -129,6 +125,7 @@ module Typertext.Http {
|
||||||
* @param {HttpQueryString} queryString
|
* @param {HttpQueryString} queryString
|
||||||
* @param {number} port
|
* @param {number} port
|
||||||
*
|
*
|
||||||
|
* @class HttpUrl
|
||||||
* @author Kegan Myers <kegan@keganmyers.com>
|
* @author Kegan Myers <kegan@keganmyers.com>
|
||||||
* @version 0.3.0
|
* @version 0.3.0
|
||||||
* @constructor
|
* @constructor
|
||||||
|
|
|
@ -10,6 +10,7 @@ module Typertext.Json {
|
||||||
* @param {string} message
|
* @param {string} message
|
||||||
* @param {number} code
|
* @param {number} code
|
||||||
*
|
*
|
||||||
|
* @class JsonException
|
||||||
* @author Kegan Myers <kegan@keganmyers.com>
|
* @author Kegan Myers <kegan@keganmyers.com>
|
||||||
* @version 0.3.0
|
* @version 0.3.0
|
||||||
* @constructor
|
* @constructor
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Json
|
||||||
|
*/
|
||||||
module Typertext.Json {
|
module Typertext.Json {
|
||||||
|
/**
|
||||||
|
* @interface JsonObject
|
||||||
|
*/
|
||||||
export interface JsonObject {
|
export interface JsonObject {
|
||||||
[index:string]:any
|
[index:string]:any
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
|
/**
|
||||||
|
* @namespace Typertext
|
||||||
|
* @module Json
|
||||||
|
*/
|
||||||
module Typertext.Json {
|
module Typertext.Json {
|
||||||
|
/**
|
||||||
|
* @interface JsonResponseHandler
|
||||||
|
*/
|
||||||
export interface JsonResponseHandler extends Typertext.GenericResponseHandler<JsonResponse> {
|
export interface JsonResponseHandler extends Typertext.GenericResponseHandler<JsonResponse> {
|
||||||
}
|
}
|
||||||
}
|
}
|
Reference in a new issue